1 <!DOCTYPE HTML PUBLIC
"-//W3C//DTD HTML 4.0 Transitional//EN">
4 <meta http-equiv=
"Content-Type" content=
"text/html;charset=iso-8859-1">
5 <title>File Index
</title>
6 <link href=
"doxygen.css" rel=
"stylesheet" type=
"text/css">
9 <!-- Generated by Doxygen 1.3.4 -->
10 <div class=
"qindex"><a class=
"qindex" href=
"main.html">Main
Page
</a> |
<a class=
"qindex" href=
"classes.html">Alphabetical
List
</a> |
<a class=
"qindex" href=
"annotated.html">Data
Structures
</a> |
<a class=
"qindex" href=
"files.html">File
List
</a> |
<a class=
"qindex" href=
"functions.html">Data
Fields
</a> |
<a class=
"qindex" href=
"globals.html">Globals
</a></div>
11 <h1>dmxlog.h File Reference
</h1>
13 <a href=
"dmxlog_8h-source.html">Go to the source code of this file.
</a><table border=
0 cellpadding=
0 cellspacing=
0>
15 <tr><td colspan=
2><br><h2>Enumerations
</h2></td></tr>
16 <tr><td class=
"memItemLeft" nowrap align=right valign=top
>enum
</td><td class=
"memItemRight" valign=bottom
><a class=
"el" href=
"dmxlog_8h.html#a18">dmxLogLevel
</a> {
<br>
17 <a class=
"el" href=
"dmxlog_8h.html#a18a0">dmxDebug
</a>,
18 <a class=
"el" href=
"dmxlog_8h.html#a18a1">dmxInfo
</a>,
19 <a class=
"el" href=
"dmxlog_8h.html#a18a2">dmxWarning
</a>,
20 <a class=
"el" href=
"dmxlog_8h.html#a18a3">dmxError
</a>,
22 <a class=
"el" href=
"dmxlog_8h.html#a18a4">dmxFatal
</a>
26 <tr><td colspan=
2><br><h2>Functions
</h2></td></tr>
27 <tr><td class=
"memItemLeft" nowrap align=right valign=top
><a class=
"el" href=
"dmxlog_8h.html#a18">dmxLogLevel
</a> </td><td class=
"memItemRight" valign=bottom
><a class=
"el" href=
"dmxlog_8h.html#a5">dmxSetLogLevel
</a> (
<a class=
"el" href=
"dmxlog_8h.html#a18">dmxLogLevel
</a> newLevel)
</td></tr>
29 <tr><td class=
"memItemLeft" nowrap align=right valign=top
><a class=
"el" href=
"dmxlog_8h.html#a18">dmxLogLevel
</a> </td><td class=
"memItemRight" valign=bottom
><a class=
"el" href=
"dmxlog_8h.html#a6">dmxGetLogLevel
</a> (void)
</td></tr>
31 <tr><td class=
"memItemLeft" nowrap align=right valign=top
>void
</td><td class=
"memItemRight" valign=bottom
><a class=
"el" href=
"dmxlog_8h.html#a7">dmxLog
</a> (
<a class=
"el" href=
"dmxlog_8h.html#a18">dmxLogLevel
</a> logLevel, const char *format,...)
</td></tr>
33 <tr><td class=
"memItemLeft" nowrap align=right valign=top
>void
</td><td class=
"memItemRight" valign=bottom
><a class=
"el" href=
"dmxlog_8h.html#a8">dmxLogCont
</a> (
<a class=
"el" href=
"dmxlog_8h.html#a18">dmxLogLevel
</a> logLevel, const char *format,...)
</td></tr>
35 <tr><td class=
"memItemLeft" nowrap align=right valign=top
>const char *
</td><td class=
"memItemRight" valign=bottom
><a class=
"el" href=
"dmxlog_8h.html#a9">dmxEventName
</a> (int type)
</td></tr>
37 <tr><td class=
"memItemLeft" nowrap align=right valign=top
>void
</td><td class=
"memItemRight" valign=bottom
><a class=
"el" href=
"dmxlog_8h.html#a10">dmxLogOutput
</a> (
<a class=
"el" href=
"struct__DMXScreenInfo.html">DMXScreenInfo
</a> *dmxScreen, const char *format,...)
</td></tr>
39 <tr><td class=
"memItemLeft" nowrap align=right valign=top
>void
</td><td class=
"memItemRight" valign=bottom
><a class=
"el" href=
"dmxlog_8h.html#a11">dmxLogOutputCont
</a> (
<a class=
"el" href=
"struct__DMXScreenInfo.html">DMXScreenInfo
</a> *dmxScreen, const char *format,...)
</td></tr>
41 <tr><td class=
"memItemLeft" nowrap align=right valign=top
>void
</td><td class=
"memItemRight" valign=bottom
><a class=
"el" href=
"dmxlog_8h.html#a12">dmxLogOutputWarning
</a> (
<a class=
"el" href=
"struct__DMXScreenInfo.html">DMXScreenInfo
</a> *dmxScreen, const char *format,...)
</td></tr>
43 <tr><td class=
"memItemLeft" nowrap align=right valign=top
>void
</td><td class=
"memItemRight" valign=bottom
><a class=
"el" href=
"dmxlog_8h.html#a13">dmxLogInput
</a> (
<a class=
"el" href=
"struct__DMXInputInfo.html">DMXInputInfo
</a> *dmxInput, const char *format,...)
</td></tr>
45 <tr><td class=
"memItemLeft" nowrap align=right valign=top
>void
</td><td class=
"memItemRight" valign=bottom
><a class=
"el" href=
"dmxlog_8h.html#a14">dmxLogInputCont
</a> (
<a class=
"el" href=
"struct__DMXInputInfo.html">DMXInputInfo
</a> *dmxInput, const char *format,...)
</td></tr>
47 <tr><td class=
"memItemLeft" nowrap align=right valign=top
>void
</td><td class=
"memItemRight" valign=bottom
><a class=
"el" href=
"dmxlog_8h.html#a15">dmxLogArgs
</a> (
<a class=
"el" href=
"dmxlog_8h.html#a18">dmxLogLevel
</a> logLevel, int argc, char **argv)
</td></tr>
49 <tr><td class=
"memItemLeft" nowrap align=right valign=top
>void
</td><td class=
"memItemRight" valign=bottom
><a class=
"el" href=
"dmxlog_8h.html#a16">dmxLogVisual
</a> (
<a class=
"el" href=
"struct__DMXScreenInfo.html">DMXScreenInfo
</a> *dmxScreen, XVisualInfo *vi, int defaultVisual)
</td></tr>
51 <tr><td class=
"memItemLeft" nowrap align=right valign=top
>const char *
</td><td class=
"memItemRight" valign=bottom
><a class=
"el" href=
"dmxlog_8h.html#a17">dmxXInputEventName
</a> (int type)
</td></tr>
54 <hr><a name=
"_details"></a><h2>Detailed Description
</h2>
55 This header is included by all files that need to use the DMX logging facilities.
<hr><h2>Enumeration Type Documentation
</h2>
56 <a class=
"anchor" name=
"a18" doxytag=
"dmxlog.h::dmxLogLevel" ></a><p>
57 <table class=
"mdTable" width=
"100%" cellpadding=
"2" cellspacing=
"0">
60 <table cellpadding=
"0" cellspacing=
"0" border=
"0">
62 <td class=
"md" nowrap
valign=
"top"> enum
<a class=
"el" href=
"dmxlog_8h.html#a18">dmxLogLevel
</a>
67 <table cellspacing=
5 cellpadding=
0 border=
0>
75 Logging levels -- output is tunable with
<a class=
"el" href=
"dmxlog_8h.html#a5">dmxSetLogLevel
</a>.
<dl compact
><dt><b>Enumeration values:
</b></dt><dd>
76 <table border=
0 cellspacing=
2 cellpadding=
0>
77 <tr><td valign=top
><em><a class=
"anchor" name=
"a18a0" doxytag=
"dmxDebug" ></a>dmxDebug
</em> </td><td>
78 Usually verbose debugging info
</td></tr>
79 <tr><td valign=top
><em><a class=
"anchor" name=
"a18a1" doxytag=
"dmxInfo" ></a>dmxInfo
</em> </td><td>
80 Non-warning information
</td></tr>
81 <tr><td valign=top
><em><a class=
"anchor" name=
"a18a2" doxytag=
"dmxWarning" ></a>dmxWarning
</em> </td><td>
82 A warning that may indicate DMX will not function as the user intends.
</td></tr>
83 <tr><td valign=top
><em><a class=
"anchor" name=
"a18a3" doxytag=
"dmxError" ></a>dmxError
</em> </td><td>
84 A non-fatal error that probably indicates DMX will not function as desired.
</td></tr>
85 <tr><td valign=top
><em><a class=
"anchor" name=
"a18a4" doxytag=
"dmxFatal" ></a>dmxFatal
</em> </td><td>
86 A fatal error that will cause DMX to shut down.
</td></tr>
92 <hr><h2>Function Documentation
</h2>
93 <a class=
"anchor" name=
"a9" doxytag=
"dmxlog.h::dmxEventName" ></a><p>
94 <table class=
"mdTable" width=
"100%" cellpadding=
"2" cellspacing=
"0">
97 <table cellpadding=
"0" cellspacing=
"0" border=
"0">
99 <td class=
"md" nowrap
valign=
"top"> const char* dmxEventName
</td>
100 <td class=
"md" valign=
"top">(
</td>
101 <td class=
"md" nowrap
valign=
"top">int
</td>
102 <td class=
"mdname1" valign=
"top" nowrap
> <em>type
</em> </td>
103 <td class=
"md" valign=
"top"> )
</td>
104 <td class=
"md" nowrap
></td>
111 <table cellspacing=
5 cellpadding=
0 border=
0>
119 Translate an event
<em>type
</em> into a human-readable string.
</td>
122 <a class=
"anchor" name=
"a6" doxytag=
"dmxlog.h::dmxGetLogLevel" ></a><p>
123 <table class=
"mdTable" width=
"100%" cellpadding=
"2" cellspacing=
"0">
126 <table cellpadding=
"0" cellspacing=
"0" border=
"0">
128 <td class=
"md" nowrap
valign=
"top"> <a class=
"el" href=
"dmxlog_8h.html#a18">dmxLogLevel
</a> dmxGetLogLevel
</td>
129 <td class=
"md" valign=
"top">(
</td>
130 <td class=
"md" nowrap
valign=
"top">void
</td>
131 <td class=
"mdname1" valign=
"top" nowrap
> </td>
132 <td class=
"md" valign=
"top"> )
</td>
133 <td class=
"md" nowrap
></td>
140 <table cellspacing=
5 cellpadding=
0 border=
0>
148 Returns the log level set by
<a class=
"el" href=
"dmxlog_8h.html#a18">dmxLogLevel
</a>.
</td>
151 <a class=
"anchor" name=
"a7" doxytag=
"dmxlog.h::dmxLog" ></a><p>
152 <table class=
"mdTable" width=
"100%" cellpadding=
"2" cellspacing=
"0">
155 <table cellpadding=
"0" cellspacing=
"0" border=
"0">
157 <td class=
"md" nowrap
valign=
"top"> void dmxLog
</td>
158 <td class=
"md" valign=
"top">(
</td>
159 <td class=
"md" nowrap
valign=
"top"><a class=
"el" href=
"dmxlog_8h.html#a18">dmxLogLevel
</a> </td>
160 <td class=
"mdname" nowrap
> <em>logLevel
</em>,
</td>
165 <td class=
"md" nowrap
>const char *
</td>
166 <td class=
"mdname" nowrap
> <em>format
</em>,
</td>
171 <td class=
"md" nowrap
>...
</td>
172 <td class=
"mdname" nowrap
></td>
176 <td class=
"md">)
</td>
177 <td class=
"md" colspan=
"2"></td>
184 <table cellspacing=
5 cellpadding=
0 border=
0>
192 Log the specified message at the specified
<em>logLevel
</em>.
<em>format
</em> can be a printf-like format expression.
</td>
195 <a class=
"anchor" name=
"a15" doxytag=
"dmxlog.h::dmxLogArgs" ></a><p>
196 <table class=
"mdTable" width=
"100%" cellpadding=
"2" cellspacing=
"0">
199 <table cellpadding=
"0" cellspacing=
"0" border=
"0">
201 <td class=
"md" nowrap
valign=
"top"> void dmxLogArgs
</td>
202 <td class=
"md" valign=
"top">(
</td>
203 <td class=
"md" nowrap
valign=
"top"><a class=
"el" href=
"dmxlog_8h.html#a18">dmxLogLevel
</a> </td>
204 <td class=
"mdname" nowrap
> <em>logLevel
</em>,
</td>
209 <td class=
"md" nowrap
>int
</td>
210 <td class=
"mdname" nowrap
> <em>argc
</em>,
</td>
215 <td class=
"md" nowrap
>char **
</td>
216 <td class=
"mdname" nowrap
> <em>argv
</em></td>
220 <td class=
"md">)
</td>
221 <td class=
"md" colspan=
"2"></td>
228 <table cellspacing=
5 cellpadding=
0 border=
0>
236 Print
<em>argc
</em> messages, each describing an element in
<em>argv
</em>. This is maingly for debugging purposes.
</td>
239 <a class=
"anchor" name=
"a8" doxytag=
"dmxlog.h::dmxLogCont" ></a><p>
240 <table class=
"mdTable" width=
"100%" cellpadding=
"2" cellspacing=
"0">
243 <table cellpadding=
"0" cellspacing=
"0" border=
"0">
245 <td class=
"md" nowrap
valign=
"top"> void dmxLogCont
</td>
246 <td class=
"md" valign=
"top">(
</td>
247 <td class=
"md" nowrap
valign=
"top"><a class=
"el" href=
"dmxlog_8h.html#a18">dmxLogLevel
</a> </td>
248 <td class=
"mdname" nowrap
> <em>logLevel
</em>,
</td>
253 <td class=
"md" nowrap
>const char *
</td>
254 <td class=
"mdname" nowrap
> <em>format
</em>,
</td>
259 <td class=
"md" nowrap
>...
</td>
260 <td class=
"mdname" nowrap
></td>
264 <td class=
"md">)
</td>
265 <td class=
"md" colspan=
"2"></td>
272 <table cellspacing=
5 cellpadding=
0 border=
0>
280 Continue a log message without printing the message prefix.
</td>
283 <a class=
"anchor" name=
"a13" doxytag=
"dmxlog.h::dmxLogInput" ></a><p>
284 <table class=
"mdTable" width=
"100%" cellpadding=
"2" cellspacing=
"0">
287 <table cellpadding=
"0" cellspacing=
"0" border=
"0">
289 <td class=
"md" nowrap
valign=
"top"> void dmxLogInput
</td>
290 <td class=
"md" valign=
"top">(
</td>
291 <td class=
"md" nowrap
valign=
"top"><a class=
"el" href=
"struct__DMXInputInfo.html">DMXInputInfo
</a> *
</td>
292 <td class=
"mdname" nowrap
> <em>dmxInput
</em>,
</td>
297 <td class=
"md" nowrap
>const char *
</td>
298 <td class=
"mdname" nowrap
> <em>format
</em>,
</td>
303 <td class=
"md" nowrap
>...
</td>
304 <td class=
"mdname" nowrap
></td>
308 <td class=
"md">)
</td>
309 <td class=
"md" colspan=
"2"></td>
316 <table cellspacing=
5 cellpadding=
0 border=
0>
324 Log an informational message (at level
<a class=
"el" href=
"dmxlog_8h.html#a18a1">dmxInfo
</a>) related to input. The message prefix will contain information from
<em>dmxInput
</em>.
</td>
327 <a class=
"anchor" name=
"a14" doxytag=
"dmxlog.h::dmxLogInputCont" ></a><p>
328 <table class=
"mdTable" width=
"100%" cellpadding=
"2" cellspacing=
"0">
331 <table cellpadding=
"0" cellspacing=
"0" border=
"0">
333 <td class=
"md" nowrap
valign=
"top"> void dmxLogInputCont
</td>
334 <td class=
"md" valign=
"top">(
</td>
335 <td class=
"md" nowrap
valign=
"top"><a class=
"el" href=
"struct__DMXInputInfo.html">DMXInputInfo
</a> *
</td>
336 <td class=
"mdname" nowrap
> <em>dmxInput
</em>,
</td>
341 <td class=
"md" nowrap
>const char *
</td>
342 <td class=
"mdname" nowrap
> <em>format
</em>,
</td>
347 <td class=
"md" nowrap
>...
</td>
348 <td class=
"mdname" nowrap
></td>
352 <td class=
"md">)
</td>
353 <td class=
"md" colspan=
"2"></td>
360 <table cellspacing=
5 cellpadding=
0 border=
0>
368 Continue a message related to input without printing the message prefix.
</td>
371 <a class=
"anchor" name=
"a10" doxytag=
"dmxlog.h::dmxLogOutput" ></a><p>
372 <table class=
"mdTable" width=
"100%" cellpadding=
"2" cellspacing=
"0">
375 <table cellpadding=
"0" cellspacing=
"0" border=
"0">
377 <td class=
"md" nowrap
valign=
"top"> void dmxLogOutput
</td>
378 <td class=
"md" valign=
"top">(
</td>
379 <td class=
"md" nowrap
valign=
"top"><a class=
"el" href=
"struct__DMXScreenInfo.html">DMXScreenInfo
</a> *
</td>
380 <td class=
"mdname" nowrap
> <em>dmxScreen
</em>,
</td>
385 <td class=
"md" nowrap
>const char *
</td>
386 <td class=
"mdname" nowrap
> <em>format
</em>,
</td>
391 <td class=
"md" nowrap
>...
</td>
392 <td class=
"mdname" nowrap
></td>
396 <td class=
"md">)
</td>
397 <td class=
"md" colspan=
"2"></td>
404 <table cellspacing=
5 cellpadding=
0 border=
0>
412 Log an informational message (at level
<a class=
"el" href=
"dmxlog_8h.html#a18a1">dmxInfo
</a>) related to ouput. The message prefix will contain backend information from
<em>dmxScreen
</em>.
</td>
415 <a class=
"anchor" name=
"a11" doxytag=
"dmxlog.h::dmxLogOutputCont" ></a><p>
416 <table class=
"mdTable" width=
"100%" cellpadding=
"2" cellspacing=
"0">
419 <table cellpadding=
"0" cellspacing=
"0" border=
"0">
421 <td class=
"md" nowrap
valign=
"top"> void dmxLogOutputCont
</td>
422 <td class=
"md" valign=
"top">(
</td>
423 <td class=
"md" nowrap
valign=
"top"><a class=
"el" href=
"struct__DMXScreenInfo.html">DMXScreenInfo
</a> *
</td>
424 <td class=
"mdname" nowrap
> <em>dmxScreen
</em>,
</td>
429 <td class=
"md" nowrap
>const char *
</td>
430 <td class=
"mdname" nowrap
> <em>format
</em>,
</td>
435 <td class=
"md" nowrap
>...
</td>
436 <td class=
"mdname" nowrap
></td>
440 <td class=
"md">)
</td>
441 <td class=
"md" colspan=
"2"></td>
448 <table cellspacing=
5 cellpadding=
0 border=
0>
456 Continue a message related to output without printing the message prefix.
</td>
459 <a class=
"anchor" name=
"a12" doxytag=
"dmxlog.h::dmxLogOutputWarning" ></a><p>
460 <table class=
"mdTable" width=
"100%" cellpadding=
"2" cellspacing=
"0">
463 <table cellpadding=
"0" cellspacing=
"0" border=
"0">
465 <td class=
"md" nowrap
valign=
"top"> void dmxLogOutputWarning
</td>
466 <td class=
"md" valign=
"top">(
</td>
467 <td class=
"md" nowrap
valign=
"top"><a class=
"el" href=
"struct__DMXScreenInfo.html">DMXScreenInfo
</a> *
</td>
468 <td class=
"mdname" nowrap
> <em>dmxScreen
</em>,
</td>
473 <td class=
"md" nowrap
>const char *
</td>
474 <td class=
"mdname" nowrap
> <em>format
</em>,
</td>
479 <td class=
"md" nowrap
>...
</td>
480 <td class=
"mdname" nowrap
></td>
484 <td class=
"md">)
</td>
485 <td class=
"md" colspan=
"2"></td>
492 <table cellspacing=
5 cellpadding=
0 border=
0>
500 Log a warning message (at level
<a class=
"el" href=
"dmxlog_8h.html#a18a2">dmxWarning
</a>) related to output. The message prefix will contain backend information from
<em>dmxScreen
</em>.
</td>
503 <a class=
"anchor" name=
"a16" doxytag=
"dmxlog.h::dmxLogVisual" ></a><p>
504 <table class=
"mdTable" width=
"100%" cellpadding=
"2" cellspacing=
"0">
507 <table cellpadding=
"0" cellspacing=
"0" border=
"0">
509 <td class=
"md" nowrap
valign=
"top"> void dmxLogVisual
</td>
510 <td class=
"md" valign=
"top">(
</td>
511 <td class=
"md" nowrap
valign=
"top"><a class=
"el" href=
"struct__DMXScreenInfo.html">DMXScreenInfo
</a> *
</td>
512 <td class=
"mdname" nowrap
> <em>dmxScreen
</em>,
</td>
517 <td class=
"md" nowrap
>XVisualInfo *
</td>
518 <td class=
"mdname" nowrap
> <em>vi
</em>,
</td>
523 <td class=
"md" nowrap
>int
</td>
524 <td class=
"mdname" nowrap
> <em>defaultVisual
</em></td>
528 <td class=
"md">)
</td>
529 <td class=
"md" colspan=
"2"></td>
536 <table cellspacing=
5 cellpadding=
0 border=
0>
544 Print messages at level
<a class=
"el" href=
"dmxlog_8h.html#a18a1">dmxInfo
</a> describing the visuals in
<em>vi
</em>.
</td>
547 <a class=
"anchor" name=
"a5" doxytag=
"dmxlog.h::dmxSetLogLevel" ></a><p>
548 <table class=
"mdTable" width=
"100%" cellpadding=
"2" cellspacing=
"0">
551 <table cellpadding=
"0" cellspacing=
"0" border=
"0">
553 <td class=
"md" nowrap
valign=
"top"> <a class=
"el" href=
"dmxlog_8h.html#a18">dmxLogLevel
</a> dmxSetLogLevel
</td>
554 <td class=
"md" valign=
"top">(
</td>
555 <td class=
"md" nowrap
valign=
"top"><a class=
"el" href=
"dmxlog_8h.html#a18">dmxLogLevel
</a> </td>
556 <td class=
"mdname1" valign=
"top" nowrap
> <em>newLevel
</em> </td>
557 <td class=
"md" valign=
"top"> )
</td>
558 <td class=
"md" nowrap
></td>
565 <table cellspacing=
5 cellpadding=
0 border=
0>
573 Set the default level for logging to
<a class=
"el" href=
"dmxlog_8h.html#a18">dmxLogLevel
</a>. Returns the previous log level.
</td>
576 <a class=
"anchor" name=
"a17" doxytag=
"dmxlog.h::dmxXInputEventName" ></a><p>
577 <table class=
"mdTable" width=
"100%" cellpadding=
"2" cellspacing=
"0">
580 <table cellpadding=
"0" cellspacing=
"0" border=
"0">
582 <td class=
"md" nowrap
valign=
"top"> const char* dmxXInputEventName
</td>
583 <td class=
"md" valign=
"top">(
</td>
584 <td class=
"md" nowrap
valign=
"top">int
</td>
585 <td class=
"mdname1" valign=
"top" nowrap
> <em>type
</em> </td>
586 <td class=
"md" valign=
"top"> )
</td>
587 <td class=
"md" nowrap
></td>
594 <table cellspacing=
5 cellpadding=
0 border=
0>
602 Translate a (normalized) XInput event
<em>type
</em> into a human-readable string.
</td>
608 Generated June
29,
2004 for
<a
609 href=
"http://dmx.sourceforge.net">Distributed Multihead X
</a> by
610 <a href=
"http://www.doxygen.org/index.html">doxygen
</a>