1/****h* PawnLibs/log
2 * Description
3 *   Interfaces for printing log messages. They accept format string similar to
4 *   the C language with format specifiers - subsequences beginning with %. A
5 *   format specifier follows this prototype:
6 *    %[flags][width][.precision]specifier
7 *   Specifiers:
8 *   * c - single character
9 *   * d - integer number
10 *   * f,r - floating point number
11 *   * q,r - fixed point number
12 *   * s - string
13 *   * x - hex value
14 *   * % - % character
15 *   Flags:
16 *   * - - Left-justify within the given field width; Right justification is the
17 *         default
18 *   * + - Forces to preceed the result with a plus or minus sign (+ or -) even
19 *         for positive numbers. By default, only negative numbers are preceded
20 *         with a - sign.
21 *   * 0 - Left-pads the number with zeroes (0) instead of spaces when padding
22 *         is specified
23 *   Width - minimum number of characters to be printed. If the value to be
24 *   printed is shorter than this number, the result is padded with blank
25 *   spaces. The value is not truncated even if the result is larger.
26 *   Precision - this is the number of digits to be printed after the decimal
27 *   point.
28 *   The additional arguments following format are formatted and inserted in the
29 *   resulting string replacing their respective specifiers
30 *   TBD: check specification
31 *
32 *   Log output contains module number, severity level, application name and
33 *   timestamp. They saved on flash in a ring buffer - older messages will be
34 *   overridden.
35 *
36 *   Log filters - currently hardcoded, platform does not provide to configure
37 *   filters, TBD: describe default filters and how to configure them
38 *
39 *   View logs - only python scripts are available, SDK support TBD: describe
40 *   log dump, BT in real time, buffering nature, synchronization between
41 *   modules
42 ******/
43 
44/****n* PawnLibs/log/LOG_a
45 * Summary
46 *   Print an assert log message and stop application execution.
47 * Synopsis
48 */
49native LOG_a(const format[], {Float,Fixed,_}:...);
50/*
51 * Inputs
52 *   * format - format string
53 *   * ... - variable values to insert in the resulting string
54 ******/
55 
56/****n* PawnLibs/log/LOG_e
57 * Summary
58 *   Print an error log message.
59 * Synopsis
60 */
61native LOG_e(const format[], {Float,Fixed,_}:...);
62/*
63 * Inputs
64 *   * format - format string
65 *   * ... - variable values to insert in the resulting string
66 ******/
67 
68/****n* PawnLibs/log/LOG_w
69 * Summary
70 *   Print a warning log message.
71 * Synopsis
72 */
73native LOG_w(const format[], {Float,Fixed,_}:...);
74/*
75 * Inputs
76 *   * format - format string
77 *   * ... - variable values to insert in the resulting string
78 ******/
79 
80/****n* PawnLibs/log/LOG_i
81 * Summary
82 *   Print an information log message.
83 * Synopsis
84 */
85native LOG_i(const format[], {Float,Fixed,_}:...);
86/*
87 * Inputs
88 *   * format - format string
89 *   * ... - variable values to insert in the resulting string
90 ******/
91 
92/****n* PawnLibs/log/LOG_d
93 * Summary
94 *   Print a debug log message.
95 * Synopsis
96 */
97native LOG_d(const format[], {Float,Fixed,_}:...);
98/*
99 * Inputs
100 *   * format - format string
101 *   * ... - variable values to insert in the resulting string
102 ******/
103 
104/****n* PawnLibs/log/LOG_v
105 * Summary
106 *   Print a verbose log message.
107 * Synopsis
108 */
109native LOG_v(const format[], {Float,Fixed,_}:...);
110/*
111 * Inputs
112 *   * format - format string
113 *   * ... - variable values to insert in the resulting string
114 ******/
115 
116