reference_guides/latest/debug_8hpp_source.html

#pragma once

#include <cstdint>

#include <cstdlib>

#include "../add_last_arg_to_command.hpp"

#include "../core_export.hpp"

#include "../environment.hpp"

#include "../static.hpp"

#include "../string.hpp"

#include "assert_dialog_result.hpp"

#include "debugger.hpp"

#include "stack_trace.hpp"

#include "trace_listener_collection.hpp"


namespace xtd {

  namespace forms {

    class assert_dialog;

  }


  namespace diagnostics {

    class trace;


    class core_export_ debug static_ {

    public:


      using listener_collection = xtd::diagnostics::trace_listener_collection;


      static bool auto_flush() noexcept;

      static void auto_flush(bool auto_flush) noexcept;


      static uint32 indent_level() noexcept;

      static void indent_level(uint32 indent_level) noexcept;


      static uint32 indent_size() noexcept;

      static void indent_size(uint32 indent_size) noexcept;


      static listener_collection& listeners() noexcept;

      static void listeners(const listener_collection& listeners) noexcept;


      [[deprecated("Replaced by xtd::diagnostics::default_trace_listener::assert_ui_enabled - Will be removed in version 0.4.0.")]]

      static bool show_assert_dialog() noexcept;

      [[deprecated("Replaced by xtd::diagnostics::default_trace_listener::assert_ui_enabled - Will be removed in version 0.4.0.")]]

      static void show_assert_dialog(bool show_assert_dialog) noexcept;


      static bool use_global_lock() noexcept;

      static void use_global_lock(bool use_global_lock) noexcept;


      static void cassert(bool condition, const xtd::diagnostics::stack_frame& stack_frame = xtd::diagnostics::stack_frame::current());

      static void cassert(bool condition, const xtd::string& message, const xtd::diagnostics::stack_frame& stack_frame = xtd::diagnostics::stack_frame::current());

      static void cassert(bool condition, const xtd::string& message, const xtd::string& detail_message, const xtd::diagnostics::stack_frame& stack_frame = xtd::diagnostics::stack_frame::current());


      static void fail(const xtd::string& message) {

        #if !defined(NDEBUG) || defined(DEBUG) || defined(TRACE)

        fail__(message);

        #endif

      }

      static void fail(const xtd::string& message) {…}


      static void fail(const xtd::string& message, const xtd::string& detail_message) {

        #if !defined(NDEBUG) || defined(DEBUG) || defined(TRACE)

        fail__(message, detail_message);

        #endif

      }

      static void fail(const xtd::string& message, const xtd::string& detail_message) {…}


      static void flush() {

        #if !defined(NDEBUG) || defined(DEBUG) || defined(TRACE)

        flush_();

        #endif

      }

      static void flush() {…}


      static void indent() noexcept;


      static void print(const xtd::string& message) {

        #if !defined(NDEBUG) || defined(DEBUG) || defined(TRACE)

        write_line_(message);

        #endif

      }

      static void print(const xtd::string& message) {…}


      template<class ...args_t>


      static void print(const xtd::string& format, args_t&& ... args) {

        #if !defined(NDEBUG) || defined(DEBUG) || defined(TRACE)

        write_line_(xtd::string::format(format, args...));

        #endif

      }

      static void print(const xtd::string& format, args_t&& ... args) {…}


      template<class ...args_t>

      static void print(const char* format, args_t&& ... args) {

        #if !defined(NDEBUG) || defined(DEBUG) || defined(TRACE)

        write_line_(xtd::string::format(format, args...));

        #endif

      }


      static void trace_error(const xtd::string& message) {

        #if !defined(NDEBUG) || defined(DEBUG) || defined(TRACE)

        trace_event_(trace_event_type::error, message);

        #endif

      }

      static void trace_error(const xtd::string& message) {…}


      template<class ...objects_t>


      static void trace_error(const xtd::string& message, const objects_t& ... args) {

        #if !defined(NDEBUG) || defined(DEBUG) || defined(TRACE)

        trace_event_(trace_event_type::error, xtd::string::format(message, args...));

        #endif

      }

      static void trace_error(const xtd::string& message, const objects_t& ... args) {…}


      static void trace_information(const xtd::string& message) {

        #if !defined(NDEBUG) || defined(DEBUG) || defined(TRACE)

        trace_event_(trace_event_type::information, message);

        #endif

      }

      static void trace_information(const xtd::string& message) {…}


      template<class ...objects_t>


      static void trace_information(const xtd::string& message, const objects_t& ... args) {

        #if !defined(NDEBUG) || defined(DEBUG) || defined(TRACE)

        trace_event_(trace_event_type::information, xtd::string::format(message, args...));

        #endif

      }

      static void trace_information(const xtd::string& message, const objects_t& ... args) {…}


      static void trace_warning(const xtd::string& message) {

        #if !defined(NDEBUG) || defined(DEBUG) || defined(TRACE)

        trace_event_(trace_event_type::warning, message);

        #endif

      }

      static void trace_warning(const xtd::string& message) {…}


      template<class ...objects_t>


      static void trace_warning(const xtd::string& message, const objects_t& ... args) {

        #if !defined(NDEBUG) || defined(DEBUG) || defined(TRACE)

        trace_event_(trace_event_type::warning, xtd::string::format(message, args...));

        #endif

      }

      static void trace_warning(const xtd::string& message, const objects_t& ... args) {…}


      static void unindent() noexcept;


      static void write(const xtd::string& message) {

        #if !defined(NDEBUG) || defined(DEBUG) || defined(TRACE)

        write_(message);

        #endif

      }

      static void write(const xtd::string& message) {…}


      template<class object_t>


      static void write(const object_t& message) {

        #if !defined(NDEBUG) || defined(DEBUG) || defined(TRACE)

        write_(xtd::string::format("{}", message));

        #endif

      }

      static void write(const object_t& message) {…}


      template<class object_t>


      static void write(const object_t& message, const xtd::string& category) {

        #if !defined(NDEBUG) || defined(DEBUG) || defined(TRACE)

        write_(xtd::string::format("{}", message), category);

        #endif

      }

      static void write(const object_t& message, const xtd::string& category) {…}


      template<class ...args_t>


      static void write(const xtd::string& format, args_t&& ... args) {

        #if !defined(NDEBUG) || defined(DEBUG) || defined(TRACE)

        write_(string::format(format, args...));

        #endif

      }

      static void write(const xtd::string& format, args_t&& ... args) {…}


      template<class ...args_t>

      static void write(const char* format, args_t&& ... args) {

        #if !defined(NDEBUG) || defined(DEBUG) || defined(TRACE)

        write_(string::format(format, args...));

        #endif

      }


      static void write_if(bool condition, const xtd::string& message) {

        #if !defined(NDEBUG) || defined(DEBUG) || defined(TRACE)

        if (condition) write_(message);

        #endif

      }

      static void write_if(bool condition, const xtd::string& message) {…}

      template<class object_t>


      static void write_if(bool condition, const object_t& message) {

        #if !defined(NDEBUG) || defined(DEBUG) || defined(TRACE)

        if (condition) write_(xtd::string::format("{}", message));

        #endif

      }

      static void write_if(bool condition, const object_t& message) {…}


      template<class object_t>


      static void write_if(bool condition, const object_t& message, const xtd::string& category) {

        #if !defined(NDEBUG) || defined(DEBUG) || defined(TRACE)

        if (condition) write_(xtd::string::format("{}", message), category);

        #endif

      }

      static void write_if(bool condition, const object_t& message, const xtd::string& category) {…}


      static void write_line() {

        #if !defined(NDEBUG) || defined(DEBUG) || defined(TRACE)

        write_line_("");

        #endif

      }

      static void write_line() {…}


      static void write_line(const xtd::string& message) {

        #if !defined(NDEBUG) || defined(DEBUG) || defined(TRACE)

        write_line_(message);

        #endif

      }

      static void write_line(const xtd::string& message) {…}


      template<class object_t>


      static void write_line(const object_t& message) {

        #if !defined(NDEBUG) || defined(DEBUG) || defined(TRACE)

        write_line_(xtd::string::format("{}", message));

        #endif

      }

      static void write_line(const object_t& message) {…}


      template<class object_t>


      static void write_line(const object_t& message, const xtd::string& category) {

        #if !defined(NDEBUG) || defined(DEBUG) || defined(TRACE)

        write_line_(xtd::string::format("{}", message), category);

        #endif

      }

      static void write_line(const object_t& message, const xtd::string& category) {…}


      template<class ...args_t>


      static void write_line(const xtd::string& format, args_t&& ... args) {

        #if !defined(NDEBUG) || defined(DEBUG) || defined(TRACE)

        write_line_(string::format(format, args...));

        #endif

      }

      static void write_line(const xtd::string& format, args_t&& ... args) {…}


      template<class ...args_t>

      static void write_line(const char* format, args_t&& ... args) {

        #if !defined(NDEBUG) || defined(DEBUG) || defined(TRACE)

        write_line_(string::format(format, args...));

        #endif

      }


      static void write_line_if(bool condition, const xtd::string& message) {

        #if !defined(NDEBUG) || defined(DEBUG) || defined(TRACE)

        if (condition) write_line_(message);

        #endif

      }

      static void write_line_if(bool condition, const xtd::string& message) {…}


      template<class object_t>


      static void write_line_if(bool condition, const object_t& message) {

        #if !defined(NDEBUG) || defined(DEBUG) || defined(TRACE)

        if (condition) write_line_(message);

        #endif

      }

      static void write_line_if(bool condition, const object_t& message) {…}


      template<class object_t>


      static void write_line_if(bool condition, const object_t& message, const xtd::string& category) {

        #if !defined(NDEBUG) || defined(DEBUG) || defined(TRACE)

        if (condition) write_line_(message, category);

        #endif

      }

      static void write_line_if(bool condition, const object_t& message, const xtd::string& category) {…}


      static inline bool __should_aborted__(bool condition, const xtd::diagnostics::stack_frame& stack_frame = xtd::diagnostics::stack_frame::current()) {return __should_aborted__(condition, xtd::string::empty_string, stack_frame);}

      static inline bool __should_aborted__(bool condition, const xtd::string& message, const xtd::diagnostics::stack_frame& stack_frame = xtd::diagnostics::stack_frame::current()) {return __should_aborted__(condition, message, xtd::string::empty_string, stack_frame);}

      static inline bool __should_aborted__(bool condition, const xtd::string& message, const xtd::string& detail_message, const xtd::diagnostics::stack_frame& stack_frame = xtd::diagnostics::stack_frame::current()) {

        #if !defined(NDEBUG) || defined(DEBUG) || defined(TRACE)

        auto result = xtd::diagnostics::debug::assert_dialog(condition, message, detail_message, stack_frame);

        if (result == xtd::diagnostics::assert_dialog_result::abort) xtd::environment::exit(EXIT_FAILURE);

        if (result == xtd::diagnostics::assert_dialog_result::retry) return true;

        #endif

        return false;

      }


    private:

      friend trace;

      friend xtd::forms::assert_dialog;

      static xtd::diagnostics::assert_dialog_result assert_dialog(bool condition, const xtd::string& message, const xtd::string& detail_message, const xtd::diagnostics::stack_frame& stack_frame);

      static xtd::string assert_dialog_caption();

      static bool internal_show_assert_dialog() noexcept;

      static void fail__(const xtd::string& message);

      static void fail__(const xtd::string& message, const xtd::string& detail_message);

      static void flush_();

      static void trace_event_(trace_event_type trace_event_type, const xtd::string& message);

      static void write_(const xtd::string& message);

      static void write_(const xtd::string& message, const xtd::string& category);

      static void write_line_(const xtd::string& message);

      static void write_line_(const xtd::string& message, const xtd::string& category);


      inline static bool auto_flush_ = false;

      inline static uint32 indent_level_ = 0;

      inline static uint32 indent_size_ = 4;

      static listener_collection& listeners_;

      static xtd::string source_name_;

    };

    class core_export_ debug static_ {…};

  }

}

add_last_arg_to_command.hpp
Contains add_last_arg_to_command_ macro.

assert_dialog_result.hpp
Contains xtd::diagnostics::assert_dialog_result enum class.

xtd::diagnostics::debug
Provides a set of methods and properties that help you debug the execution of your code....
Definition debug.hpp:59

xtd::diagnostics::debug::write
static void write(const xtd::string &message)
Writes a message to the trace listeners in the listeners collection.
Definition debug.hpp:276

xtd::diagnostics::debug::write_if
static void write_if(bool condition, const object_t &message, const xtd::string &category)
Writes a category name and message to the trace listeners in the Listeners collection if a condition ...
Definition debug.hpp:351

xtd::diagnostics::debug::trace_information
static void trace_information(const xtd::string &message, const objects_t &... args)
Writes an informational message to the trace listeners in the listeners collection using the specifie...
Definition debug.hpp:244

xtd::diagnostics::debug::cassert
static void cassert(bool condition, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
Checks for a condition; if the condition is false, displays a message box that shows the call stack.

xtd::diagnostics::debug::indent
static void indent() noexcept
Increases the current indent_level by one.

xtd::diagnostics::debug::write_line
static void write_line()
Writes a line terminator to the trace listeners in the listeners collection.
Definition debug.hpp:361

xtd::diagnostics::debug::fail
static void fail(const xtd::string &message)
Emits the specified error message.
Definition debug.hpp:159

xtd::diagnostics::debug::write
static void write(const object_t &message, const xtd::string &category)
Writes a category name and message to the trace listeners in the listeners collection.
Definition debug.hpp:298

xtd::diagnostics::debug::print
static void print(const xtd::string &message)
Writes a message followed by a line terminator to the trace listeners in the listeners collection.
Definition debug.hpp:188

xtd::diagnostics::debug::write_line_if
static void write_line_if(bool condition, const object_t &message)
Writes a message followed by a line terminator to the trace listeners in the Listeners collection if ...
Definition debug.hpp:432

xtd::diagnostics::debug::write_line
static void write_line(const object_t &message)
Writes a message followed by a line terminator to the trace listeners in the listeners collection.
Definition debug.hpp:380

xtd::diagnostics::debug::listeners
static listener_collection & listeners() noexcept
Gets the collection of listeners that is monitoring the trace output.

xtd::diagnostics::debug::write
static void write(const xtd::string &format, args_t &&... args)
Writes a formatted string to the trace listeners in the listeners collection.
Definition debug.hpp:309

xtd::diagnostics::debug::listener_collection
xtd::diagnostics::trace_listener_collection listener_collection
Represents a collection of xtd::diagnostics::trace_listener.
Definition debug.hpp:65

xtd::diagnostics::debug::auto_flush
static bool auto_flush() noexcept
Gets whether xtd::diagnostics::debug::flush should be called on the xtd::diagnostics::debug::Listener...

xtd::diagnostics::debug::indent_level
static uint32 indent_level() noexcept
Gets the indent level.

xtd::diagnostics::debug::trace_error
static void trace_error(const xtd::string &message, const objects_t &... args)
Writes an error message to the trace listeners in the listeners collection using the specified array ...
Definition debug.hpp:225

xtd::diagnostics::debug::write_line_if
static void write_line_if(bool condition, const object_t &message, const xtd::string &category)
Writes a category name and message followed by a line terminator to the trace listeners in the Listen...
Definition debug.hpp:444

xtd::diagnostics::debug::fail
static void fail(const xtd::string &message, const xtd::string &detail_message)
Emits an error message and a detailed error message.
Definition debug.hpp:169

xtd::diagnostics::debug::write_line
static void write_line(const xtd::string &message)
Writes a message followed by a line terminator to the trace listeners in the listeners collection.
Definition debug.hpp:370

xtd::diagnostics::debug::write_if
static void write_if(bool condition, const object_t &message)
Writes a message to the trace listeners in the Listeners collection if a condition is true.
Definition debug.hpp:339

xtd::diagnostics::debug::print
static void print(const xtd::string &format, args_t &&... args)
Writes a formatted string followed by a line terminator to the trace listeners in the listeners colle...
Definition debug.hpp:198

xtd::diagnostics::debug::trace_error
static void trace_error(const xtd::string &message)
Writes an error message to the trace listeners in the Listeners collection using the specified messag...
Definition debug.hpp:215

xtd::diagnostics::debug::trace_warning
static void trace_warning(const xtd::string &message)
Writes a warning message to the trace listeners in the listeners collection using the specified messa...
Definition debug.hpp:253

xtd::diagnostics::debug::write
static void write(const object_t &message)
Writes a message to the trace listeners in the listeners collection.
Definition debug.hpp:286

xtd::diagnostics::debug::flush
static void flush()
Flushes the output buffer and causes buffered data to write to the listeners collection.
Definition debug.hpp:176

xtd::diagnostics::debug::indent_size
static uint32 indent_size() noexcept
Gets the number of spaces in an indent.

xtd::diagnostics::debug::use_global_lock
static bool use_global_lock() noexcept
Gets a value indicating whether the global lock should be used.

xtd::diagnostics::debug::write_line
static void write_line(const xtd::string &format, args_t &&... args)
Writes a formatted string followed by a line terminator to the trace listeners in the listeners colle...
Definition debug.hpp:402

xtd::diagnostics::debug::unindent
static void unindent() noexcept
Decreases the current indent_level by one.

xtd::diagnostics::debug::trace_information
static void trace_information(const xtd::string &message)
Writes an informational message to the trace listeners in the listeners collection using the specifie...
Definition debug.hpp:234

xtd::diagnostics::debug::write_line
static void write_line(const object_t &message, const xtd::string &category)
Writes a category name and message followed by a line terminator to the trace listeners in the listen...
Definition debug.hpp:392

xtd::diagnostics::debug::show_assert_dialog
static bool show_assert_dialog() noexcept
Gets a value indicating whether the assert dialog should be show.

xtd::diagnostics::debug::trace_warning
static void trace_warning(const xtd::string &message, const objects_t &... args)
Writes a warning message to the trace listeners in the listeners collection using the specified array...
Definition debug.hpp:263

xtd::diagnostics::debug::write_if
static void write_if(bool condition, const xtd::string &message)
Writes a message to the trace listeners in the Listeners collection if a condition is true.
Definition debug.hpp:328

xtd::diagnostics::debug::write_line_if
static void write_line_if(bool condition, const xtd::string &message)
Writes a message followed by a line terminator to the trace listeners in the Listeners collection if ...
Definition debug.hpp:421

xtd::diagnostics::stack_frame
Provides information about a xtd::diagnostics::stack_frame, which represents a function call on the c...
Definition stack_frame.hpp:48

xtd::diagnostics::stack_frame::current
static stack_frame current(const xtd::diagnostics::source_location &value=xtd::diagnostics::source_location::current()) noexcept
Crates a new xtd::diagnostics::stack_frame object corresponding to the location of the call site.

xtd::diagnostics::trace_listener_collection
Represents a collection of xtd::diagnostics::trace_listener.
Definition trace_listener_collection.hpp:29

xtd::diagnostics::trace
Provides a set of methods and properties that help you debug the execution of your code....
Definition trace.hpp:40

xtd::environment::exit
static void exit()
Terminates this process and returns an exit code to the operating system.

xtd::forms::assert_dialog
Represents a common dialog box that displays assert dialog.
Definition assert_dialog.hpp:35

core_export.hpp
Contains core_export_ keyword.

debugger.hpp
Contains xtd::diagnostics::debugger class.

environment.hpp
Contains xtd::environment class.

xtd::format
xtd::string format(const xtd::string &fmt, args_t &&... args)
Writes the text representation of the specified arguments list, to string using the specified format ...
Definition format.hpp:20

static_
#define static_
This keyword is use to represent a static object. A static object can't be instantiated (constructors...
Definition static.hpp:37

core_export_
#define core_export_
Define shared library export.
Definition core_export.hpp:13

xtd::string
xtd::basic_string< char > string
Represents text as a sequence of UTF-8 code units.
Definition __string_definitions.hpp:43

xtd::uint32
uint32_t uint32
Represents a 32-bit unsigned integer.
Definition uint32.hpp:23

xtd::diagnostics::assert_dialog_result
assert_dialog_result
Specifies identifiers to indicate the return value of an assert dialog box.
Definition assert_dialog_result.hpp:25

xtd::diagnostics::assert_dialog_result::retry
@ retry
The assert dialog return value is Retry (usually sent from a button labeled Retry).
Definition assert_dialog_result.hpp:29

xtd::diagnostics::assert_dialog_result::abort
@ abort
The assert dialog return value is Abort (usually sent from a button labeled Abort).
Definition assert_dialog_result.hpp:27

xtd::diagnostics::trace_event_type::warning
@ warning
Warning Noncritical problem.
Definition trace_event_type.hpp:31

xtd::diagnostics::trace_event_type::information
@ information
Informational message.
Definition trace_event_type.hpp:33

xtd::diagnostics::trace_event_type::error
@ error
Recoverable error.
Definition trace_event_type.hpp:29

xtd::diagnostics
The xtd::diagnostics namespace provides classes that allow you to interact with system processes,...
Definition assert_dialog_result.hpp:10

xtd::forms
The xtd::forms namespace contains classes for creating Windows-based applications that take full adva...
Definition texts.hpp:219

xtd
The xtd namespace contains all fundamental classes to access Hardware, Os, System,...
Definition abstract_object.hpp:8

xtd::print
void print(FILE *file, arg_t &&value)
Writes the text representation of the specified value to the file output stream.
Definition print.hpp:19

stack_trace.hpp
Contains xtd::diagnostics::stack_trace class.

static.hpp
Contains xtd::static_object class.

string.hpp
Contains xtd::string alias.

trace_listener_collection.hpp
Contains xtd::diagnostics::trace_listener_collection class.