annotate foosdk/sdk/foobar2000/SDK/console.h @ 1:20d02a178406 default tip

*: check in everything else yay
author Paper <paper@tflc.us>
date Mon, 05 Jan 2026 02:15:46 -0500
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
1 #pragma once
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
2
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
3
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
4 //! Namespace with functions for sending text to console. All functions are fully multi-thread safe, though they must not be called during dll initialization or deinitialization (e.g. static object constructors or destructors) when service system is not available.
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
5 namespace console
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
6 {
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
7 void info(const char * p_message);
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
8 void error(const char * p_message);
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
9 void warning(const char * p_message);
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
10 void info_location(const playable_location & src);
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
11 void info_location(const metadb_handle_ptr & src);
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
12 void print_location(const playable_location & src);
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
13 void print_location(const metadb_handle_ptr & src);
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
14
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
15 void print(const char*);
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
16 void printf(const char*,...);
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
17 void printfv(const char*,va_list p_arglist);
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
18
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
19 //! New console print method, based on pfc::print(). \n
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
20 //! Example: console::print("foo", "bar", 2000) \ n
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
21 //! See also: FB2K_console_print(...)
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
22 template<typename ... args_t> void print(args_t && ... args) {print(pfc::format(std::forward<args_t>(args) ... ).c_str()); }
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
23
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
24 class lineWriter {
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
25 public:
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
26 const lineWriter & operator<<( const char * msg ) const {print(msg);return *this;}
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
27 };
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
28
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
29 //! Usage: console::formatter() << "blah " << somenumber << " asdf" << somestring;
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
30 class formatter : public pfc::string_formatter {
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
31 public:
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
32 ~formatter() {if (!is_empty()) console::print(get_ptr());}
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
33 };
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
34 #define FB2K_console_formatter() ::console::formatter()._formatter()
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
35 #define FB2K_console_formatter1() ::console::lineWriter()
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
36
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
37 //! New console print macro, based on pfc::print(). \n
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
38 //! Example: FB2K_console_print("foo", "bar", 2000) \n
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
39 //! Note that this macro is convenient for conditionally enabling logging in specific modules - \n
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
40 //! instead of putting console formatter lines on #ifdef, #define MY_CONSOLE_LOG(...) FB2K_console_print(__VA_ARGS__) if enabled, or #define to blank if not.
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
41 #define FB2K_console_print(...) ::console::print(__VA_ARGS__)
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
42
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
43 void complain(const char * what, const char * msg);
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
44 void complain(const char * what, std::exception const & e);
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
45
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
46 class timer_scope {
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
47 public:
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
48 timer_scope(const char * name) : m_name(name) {m_timer.start();}
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
49 ~timer_scope() {
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
50 try {
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
51 FB2K_console_formatter() << m_name << ": " << pfc::format_time_ex(m_timer.query(), 6);
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
52 } catch(...) {}
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
53 }
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
54 private:
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
55 pfc::hires_timer m_timer;
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
56 const char * const m_name;
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
57 };
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
58 };
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
59
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
60 //! Interface receiving console output. Do not call directly; use console namespace functions instead.
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
61 class NOVTABLE console_receiver : public service_base {
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
62 public:
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
63 virtual void print(const char * p_message,t_size p_message_length) = 0;
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
64
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
65 FB2K_MAKE_SERVICE_INTERFACE_ENTRYPOINT(console_receiver);
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
66 };
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
67
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
68
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
69
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
70