xtd 0.2.0
debug.hpp
Go to the documentation of this file.
1
4#pragma once
5#include <cstdint>
6#include <cstdlib>
7#include "../add_last_arg_to_command.hpp"
8#include "../core_export.hpp"
9#include "../environment.hpp"
10#include "../static.hpp"
11#include "../string.hpp"
12#include "assert_dialog_result.hpp"
13#include "debugger.hpp"
14#include "stack_trace.hpp"
15#include "trace_listener_collection.hpp"
16
18namespace xtd {
20 namespace forms {
21 class assert_dialog;
22 }
24
26 namespace diagnostics {
28 class trace;
59 class core_export_ debug static_ {
60 public:
62
65 using listener_collection = xtd::diagnostics::trace_listener_collection;
67
69
75 static bool auto_flush() noexcept;
80 static void auto_flush(bool auto_flush) noexcept;
81
85 static uint32 indent_level() noexcept;
89 static void indent_level(uint32 indent_level) noexcept;
90
94 static uint32 indent_size() noexcept;
98 static void indent_size(uint32 indent_size) noexcept;
99
104 static listener_collection& listeners() noexcept;
109 static void listeners(const listener_collection& listeners) noexcept;
110
116 [[deprecated("Replaced by xtd::diagnostics::default_trace_listener::assert_ui_enabled - Will be removed in version 0.4.0.")]]
117 static bool show_assert_dialog() noexcept;
123 [[deprecated("Replaced by xtd::diagnostics::default_trace_listener::assert_ui_enabled - Will be removed in version 0.4.0.")]]
124 static void show_assert_dialog(bool show_assert_dialog) noexcept;
125
129 static bool use_global_lock() noexcept;
133 static void use_global_lock(bool use_global_lock) noexcept;
135
137
142 static void cassert(bool condition, const xtd::diagnostics::stack_frame& stack_frame = xtd::diagnostics::stack_frame::current());
147 static void cassert(bool condition, const xtd::string& message, const xtd::diagnostics::stack_frame& stack_frame = xtd::diagnostics::stack_frame::current());
153 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());
154
159 static void fail(const xtd::string& message) {
160 #if !defined(NDEBUG) || defined(DEBUG) || defined(TRACE)
161 fail__(message);
162 #endif
163 }
164
169 static void fail(const xtd::string& message, const xtd::string& detail_message) {
170 #if !defined(NDEBUG) || defined(DEBUG) || defined(TRACE)
171 fail__(message, detail_message);
172 #endif
173 }
174
176 static void flush() {
177 #if !defined(NDEBUG) || defined(DEBUG) || defined(TRACE)
178 flush_();
179 #endif
180 }
181
183 static void indent() noexcept;
184
188 static void print(const xtd::string& message) {
189 #if !defined(NDEBUG) || defined(DEBUG) || defined(TRACE)
190 write_line_(message);
191 #endif
192 }
193
197 template<class ...args_t>
198 static void print(const xtd::string& format, args_t&& ... args) {
199 #if !defined(NDEBUG) || defined(DEBUG) || defined(TRACE)
200 write_line_(xtd::string::format(format, args...));
201 #endif
202 }
203
204 template<class ...args_t>
205 static void print(const char* format, args_t&& ... args) {
206 #if !defined(NDEBUG) || defined(DEBUG) || defined(TRACE)
207 write_line_(xtd::string::format(format, args...));
208 #endif
209 }
211
215 static void trace_error(const xtd::string& message) {
216 #if !defined(NDEBUG) || defined(DEBUG) || defined(TRACE)
217 trace_event_(trace_event_type::error, message);
218 #endif
219 }
220
224 template<class ...objects_t>
225 static void trace_error(const xtd::string& message, const objects_t& ... args) {
226 #if !defined(NDEBUG) || defined(DEBUG) || defined(TRACE)
227 trace_event_(trace_event_type::error, xtd::string::format(message, args...));
228 #endif
229 }
230
234 static void trace_information(const xtd::string& message) {
235 #if !defined(NDEBUG) || defined(DEBUG) || defined(TRACE)
236 trace_event_(trace_event_type::information, message);
237 #endif
238 }
239
243 template<class ...objects_t>
244 static void trace_information(const xtd::string& message, const objects_t& ... args) {
245 #if !defined(NDEBUG) || defined(DEBUG) || defined(TRACE)
246 trace_event_(trace_event_type::information, xtd::string::format(message, args...));
247 #endif
248 }
249
253 static void trace_warning(const xtd::string& message) {
254 #if !defined(NDEBUG) || defined(DEBUG) || defined(TRACE)
255 trace_event_(trace_event_type::warning, message);
256 #endif
257 }
258
262 template<class ...objects_t>
263 static void trace_warning(const xtd::string& message, const objects_t& ... args) {
264 #if !defined(NDEBUG) || defined(DEBUG) || defined(TRACE)
265 trace_event_(trace_event_type::warning, xtd::string::format(message, args...));
266 #endif
267 }
268
270 static void unindent() noexcept;
271
276 static void write(const xtd::string& message) {
277 #if !defined(NDEBUG) || defined(DEBUG) || defined(TRACE)
278 write_(message);
279 #endif
280 }
281
285 template<class object_t>
286 static void write(const object_t& message) {
287 #if !defined(NDEBUG) || defined(DEBUG) || defined(TRACE)
288 write_(xtd::string::format("{}", message));
289 #endif
290 }
291
297 template<class object_t>
298 static void write(const object_t& message, const xtd::string& category) {
299 #if !defined(NDEBUG) || defined(DEBUG) || defined(TRACE)
300 write_(xtd::string::format("{}", message), category);
301 #endif
302 }
303
308 template<class ...args_t>
309 static void write(const xtd::string& format, args_t&& ... args) {
310 #if !defined(NDEBUG) || defined(DEBUG) || defined(TRACE)
311 write_(string::format(format, args...));
312 #endif
313 }
314
315 template<class ...args_t>
316 static void write(const char* format, args_t&& ... args) {
317 #if !defined(NDEBUG) || defined(DEBUG) || defined(TRACE)
318 write_(string::format(format, args...));
319 #endif
320 }
322
328 static void write_if(bool condition, const xtd::string& message) {
329 #if !defined(NDEBUG) || defined(DEBUG) || defined(TRACE)
330 if (condition) write_(message);
331 #endif
332 }
333 template<class object_t>
339 static void write_if(bool condition, const object_t& message) {
340 #if !defined(NDEBUG) || defined(DEBUG) || defined(TRACE)
341 if (condition) write_(xtd::string::format("{}", message));
342 #endif
343 }
344
350 template<class object_t>
351 static void write_if(bool condition, const object_t& message, const xtd::string& category) {
352 #if !defined(NDEBUG) || defined(DEBUG) || defined(TRACE)
353 if (condition) write_(xtd::string::format("{}", message), category);
354 #endif
355 }
356
361 static void write_line() {
362 #if !defined(NDEBUG) || defined(DEBUG) || defined(TRACE)
363 write_line_("");
364 #endif
365 }
366
370 static void write_line(const xtd::string& message) {
371 #if !defined(NDEBUG) || defined(DEBUG) || defined(TRACE)
372 write_line_(message);
373 #endif
374 }
375
379 template<class object_t>
380 static void write_line(const object_t& message) {
381 #if !defined(NDEBUG) || defined(DEBUG) || defined(TRACE)
382 write_line_(xtd::string::format("{}", message));
383 #endif
384 }
385
391 template<class object_t>
392 static void write_line(const object_t& message, const xtd::string& category) {
393 #if !defined(NDEBUG) || defined(DEBUG) || defined(TRACE)
394 write_line_(xtd::string::format("{}", message), category);
395 #endif
396 }
397
401 template<class ...args_t>
402 static void write_line(const xtd::string& format, args_t&& ... args) {
403 #if !defined(NDEBUG) || defined(DEBUG) || defined(TRACE)
404 write_line_(string::format(format, args...));
405 #endif
406 }
407
408 template<class ...args_t>
409 static void write_line(const char* format, args_t&& ... args) {
410 #if !defined(NDEBUG) || defined(DEBUG) || defined(TRACE)
411 write_line_(string::format(format, args...));
412 #endif
413 }
415
421 static void write_line_if(bool condition, const xtd::string& message) {
422 #if !defined(NDEBUG) || defined(DEBUG) || defined(TRACE)
423 if (condition) write_line_(message);
424 #endif
425 }
426
431 template<class object_t>
432 static void write_line_if(bool condition, const object_t& message) {
433 #if !defined(NDEBUG) || defined(DEBUG) || defined(TRACE)
434 if (condition) write_line_(message);
435 #endif
436 }
437
443 template<class object_t>
444 static void write_line_if(bool condition, const object_t& message, const xtd::string& category) {
445 #if !defined(NDEBUG) || defined(DEBUG) || defined(TRACE)
446 if (condition) write_line_(message, category);
447 #endif
448 }
449
451 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);}
452 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);}
453 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()) {
454 #if !defined(NDEBUG) || defined(DEBUG) || defined(TRACE)
455 auto result = xtd::diagnostics::debug::assert_dialog(condition, message, detail_message, stack_frame);
456 if (result == xtd::diagnostics::assert_dialog_result::abort) xtd::environment::exit(EXIT_FAILURE);
457 if (result == xtd::diagnostics::assert_dialog_result::retry) return true;
458 #endif
459 return false;
460 }
463
464 private:
465 friend trace;
466 friend xtd::forms::assert_dialog;
467 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);
468 static xtd::string assert_dialog_caption();
469 static bool internal_show_assert_dialog() noexcept;
470 static void fail__(const xtd::string& message);
471 static void fail__(const xtd::string& message, const xtd::string& detail_message);
472 static void flush_();
473 static void trace_event_(trace_event_type trace_event_type, const xtd::string& message);
474 static void write_(const xtd::string& message);
475 static void write_(const xtd::string& message, const xtd::string& category);
476 static void write_line_(const xtd::string& message);
477 static void write_line_(const xtd::string& message, const xtd::string& category);
478
479 inline static bool auto_flush_ = false;
480 inline static uint32 indent_level_ = 0;
481 inline static uint32 indent_size_ = 4;
482 static listener_collection& listeners_;
483 static xtd::string source_name_;
484 };
485 }
486}
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.
Generated on Thu Jul 3 2025 09:05:40 for xtd by Gammasoft. All rights reserved.