/usr/share/doc/libuclmmbase1-dev/uclmmbase-debug.html

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN""http://www.w3.org/TR/html4/loose.dtd">
<HTML
><HEAD
><TITLE
>Debug</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.79"><LINK
REL="HOME"
TITLE="UCL Common Library Reference"
HREF="book1.html"><LINK
REL="UP"
TITLE="Overview"
HREF="uclmmbase.html"><LINK
REL="PREVIOUS"
TITLE="RTP"
HREF="uclmmbase-rtp.html"><LINK
REL="NEXT"
TITLE="Memory"
HREF="uclmmbase-memory.html"><STYLE
TYPE="text/css"
>.synopsis, .classsynopsis {
    background: #eeeeee;
    border: solid 1px #aaaaaa;
    padding: 0.5em;
}
.programlisting {
    background: #eeeeff;
    border: solid 1px #aaaaff;
    padding: 0.5em;
}
.variablelist {
    padding: 4px;
    margin-left: 3em;
}
.navigation {
    background: #ffeeee;
    border: solid 1px #ffaaaa;
    margin-top: 0.5em;
    margin-bottom: 0.5em;
}
.navigation a {
    color: #770000;
}
.navigation a:visited {
    color: #550000;
}
.navigation .title {
    font-size: 200%;
}</STYLE
></HEAD
><BODY
CLASS="REFENTRY"
BGCOLOR="#FFFFFF"
TEXT="#000000"
LINK="#0000FF"
VLINK="#840084"
ALINK="#0000FF"
><TABLE
WIDTH="100%"
CLASS="navigation"
SUMMARY="Navigation header"
CELLPADDING="2"
CELLSPACING="2"
><TR
VALIGN="middle"
><TD
><A
ACCESSKEY="p"
HREF="uclmmbase-rtp.html"
><IMG
SRC="left.png"
WIDTH="24"
HEIGHT="24"
BORDER="0"
ALT="Prev"></A
></TD
><TD
><A
ACCESSKEY="u"
HREF="uclmmbase.html"
><IMG
SRC="up.png"
WIDTH="24"
HEIGHT="24"
BORDER="0"
ALT="Up"></A
></TD
><TD
><A
ACCESSKEY="h"
HREF="book1.html"
><IMG
SRC="home.png"
WIDTH="24"
HEIGHT="24"
BORDER="0"
ALT="Home"></A
></TD
><TH
WIDTH="100%"
align="center"
>UCL Common Library Reference</TH
><TD
><A
ACCESSKEY="n"
HREF="uclmmbase-memory.html"
><IMG
SRC="right.png"
WIDTH="24"
HEIGHT="24"
BORDER="0"
ALT="Next"></A
></TD
></TR
></TABLE
><H1
><A
NAME="UCLMMBASE-DEBUG"
></A
>Debug</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN2247"
></A
><H2
>Name</H2
>Debug&nbsp;--&nbsp;Functions for outputing diagnostics.</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="UCLMMBASE-DEBUG.SYNOPSIS"
></A
><H2
>Synopsis</H2
><PRE
CLASS="SYNOPSIS"
>#include &lt;debug.h&gt;

#define             <A
HREF="uclmmbase-debug.html#UNUSED:CAPS"
>UNUSED</A
>                              (x)
#define             <A
HREF="uclmmbase-debug.html#DEBUG-MSG"
>debug_msg</A
>
<GTKDOCLINK
HREF="VOID"
><SPAN
CLASS="RETURNVALUE"
>void</SPAN
></GTKDOCLINK
>                <A
HREF="uclmmbase-debug.html#DEBUG-DUMP"
>debug_dump</A
>                          (<CODE
CLASS="PARAMETER"
><GTKDOCLINK
HREF="VOID"
><SPAN
CLASS="TYPE"
>void</SPAN
></GTKDOCLINK
> *lp</CODE
>,
                                                         <CODE
CLASS="PARAMETER"
>long <GTKDOCLINK
HREF="LEN"
><SPAN
CLASS="TYPE"
>len</SPAN
></GTKDOCLINK
> Param2</CODE
>);
<GTKDOCLINK
HREF="VOID"
><SPAN
CLASS="RETURNVALUE"
>void</SPAN
></GTKDOCLINK
>                <A
HREF="uclmmbase-debug.html#DEBUG-SET-CORE-DIR"
>debug_set_core_dir</A
>                  (<CODE
CLASS="PARAMETER"
>const <GTKDOCLINK
HREF="CHAR"
><SPAN
CLASS="TYPE"
>char</SPAN
></GTKDOCLINK
> *argv0</CODE
>);</PRE
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="UCLMMBASE-DEBUG.DESCRIPTION"
></A
><H2
>Description</H2
><P
>These functions relate to outputing diagnostic messages and
information.</P
><P
>Use of these functions requires DEBUG to be defined at compilation
time.  On Unix systems, the <TT
CLASS="FILENAME"
>configure</TT
> script has
a command-line option <CODE
CLASS="OPTION"
>--enable-debug</CODE
>.  On Win32 a
debug configuration exists.</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="UCLMMBASE-DEBUG.DETAILS"
></A
><H2
>Details</H2
><DIV
CLASS="REFSECT2"
><A
NAME="UNUSED:CAPS"
></A
><H3
>UNUSED()</H3
><PRE
CLASS="PROGRAMLISTING"
>#define UNUSED(x) (x=x)</PRE
><P
>Available for use to prevent compiler warnings when a function
argument is not used.  Sometimes this is unavoidable because function
has to conform to an interface.</P
><P
></P
><TABLE
CLASS="variablelist"
BORDER="0"
CELLSPACING="0"
CELLPADDING="4"
><TBODY
><TR
><TD
ALIGN="LEFT"
VALIGN="TOP"
><A
NAME="AEN2285"><SPAN
STYLE="white-space: nowrap"
><CODE
CLASS="PARAMETER"
>x</CODE
> :</SPAN
></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
><P
>unused function argument that generates compiler warning.</P
></TD
></TR
></TBODY
></TABLE
></DIV
><HR><DIV
CLASS="REFSECT2"
><A
NAME="DEBUG-MSG"
></A
><H3
>debug_msg</H3
><PRE
CLASS="PROGRAMLISTING"
>#define debug_msg _dprintf("[pid/%d +%d %s] ", getpid(), __LINE__, __FILE__), _dprintf</PRE
><P
>When DEBUG is defined this will write a formatted message to the
platform defined error stream.  The format of the message has the same
semantics as standard C library call <CODE
CLASS="FUNCTION"
><GTKDOCLINK
HREF="PRINTF"
><CODE
CLASS="FUNCTION"
>printf()</CODE
></GTKDOCLINK
></CODE
>.  The error
message displayed is prepended by the process id, the file and the
line number, where <A
HREF="uclmmbase-debug.html#DEBUG-MSG"
><CODE
CLASS="FUNCTION"
>debug_msg()</CODE
></A
> was called.
On Unix the message is rendered on the standard error stream.  On
Win32 a debug message is created using the Win32 API function
<CODE
CLASS="FUNCTION"
><GTKDOCLINK
HREF="OUTPUTDEBUGSTRING"
><CODE
CLASS="FUNCTION"
>OutputDebugString()</CODE
></GTKDOCLINK
></CODE
>.</P
></DIV
><HR><DIV
CLASS="REFSECT2"
><A
NAME="DEBUG-DUMP"
></A
><H3
>debug_dump ()</H3
><PRE
CLASS="PROGRAMLISTING"
><GTKDOCLINK
HREF="VOID"
><SPAN
CLASS="RETURNVALUE"
>void</SPAN
></GTKDOCLINK
>                debug_dump                          (<CODE
CLASS="PARAMETER"
><GTKDOCLINK
HREF="VOID"
><SPAN
CLASS="TYPE"
>void</SPAN
></GTKDOCLINK
> *lp</CODE
>,
                                                         <CODE
CLASS="PARAMETER"
>long <GTKDOCLINK
HREF="LEN"
><SPAN
CLASS="TYPE"
>len</SPAN
></GTKDOCLINK
> Param2</CODE
>);</PRE
><P
>Writes a dump of a memory region to stdout.  The dump contains a
hexadecimal and an ascii representation of the memory region.</P
><P
></P
><TABLE
CLASS="variablelist"
BORDER="0"
CELLSPACING="0"
CELLPADDING="4"
><TBODY
><TR
><TD
ALIGN="LEFT"
VALIGN="TOP"
><A
NAME="AEN2319"><SPAN
STYLE="white-space: nowrap"
><CODE
CLASS="PARAMETER"
>lp</CODE
> :</SPAN
></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
><P
>pointer to memory region.</P
></TD
></TR
></TBODY
></TABLE
></DIV
><HR><DIV
CLASS="REFSECT2"
><A
NAME="DEBUG-SET-CORE-DIR"
></A
><H3
>debug_set_core_dir ()</H3
><PRE
CLASS="PROGRAMLISTING"
><GTKDOCLINK
HREF="VOID"
><SPAN
CLASS="RETURNVALUE"
>void</SPAN
></GTKDOCLINK
>                debug_set_core_dir                  (<CODE
CLASS="PARAMETER"
>const <GTKDOCLINK
HREF="CHAR"
><SPAN
CLASS="TYPE"
>char</SPAN
></GTKDOCLINK
> *argv0</CODE
>);</PRE
><P
>Creates a directory with the application name and makes it the
current working directory.  </P
><P
>This function exists because some unix variants use the name 'core'
for core dump files.  When an application uses multiple processes,
this can be problematic if the failure of one process leads to the
failure of another because the dependent process 'core' file will
overwrite the core of the failing process.</P
><P
></P
><TABLE
CLASS="variablelist"
BORDER="0"
CELLSPACING="0"
CELLPADDING="4"
><TBODY
><TR
><TD
ALIGN="LEFT"
VALIGN="TOP"
><A
NAME="AEN2337"><SPAN
STYLE="white-space: nowrap"
><CODE
CLASS="PARAMETER"
>argv0</CODE
> :</SPAN
></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
><P
>the application path (usually argv[0] in <GTKDOCLINK
HREF="MAIN"
><CODE
CLASS="FUNCTION"
>main()</CODE
></GTKDOCLINK
>).</P
></TD
></TR
></TBODY
></TABLE
></DIV
></DIV
><TABLE
CLASS="navigation"
WIDTH="100%"
SUMMARY="Navigation footer"
CELLPADDING="2"
CELLSPACING="2"
><TR
VALIGN="middle"
><TD
ALIGN="left"
><A
ACCESSKEY="p"
HREF="uclmmbase-rtp.html"
><B
>&lt;&lt;&lt;&nbsp;RTP</B
></A
></TD
><TD
ALIGN="right"
><A
ACCESSKEY="n"
HREF="uclmmbase-memory.html"
><B
>Memory&nbsp;&gt;&gt;&gt;</B
></A
></TD
></TR
></TABLE
></BODY
></HTML
>
libuclmmbase1-dev 1.2.16.0-1ubuntu1 / usr / share / doc / libuclmmbase1-dev / uclmmbase-debug.html
