<!DOCTYPE LINUXDOC SYSTEM>

<!-- This SGML file generated by cxref. -->
<!-- cxref program (c) Andrew M. Bishop 1995,96,97,98. -->

<article>

<title>Cross reference for warn-raw.c of cxref.
<author>cxref

<sect>File warn-raw.c
<bf>RCS Header: /home/amb/cxref/RCS/warn-raw.c 1.26 1999/01/24 16:53:50 amb Exp </bf>
<p>

  C Cross Referencing &amp; Documentation tool. Version 1.5.
<newline>
  Writes the raw information and / or warnings out.
<p>

<sect1>Included Files

<p>
<itemize>
<item><tt>#include &lt;stdlib.h&gt;</tt>
</itemize>
<itemize>
<item><tt>#include &lt;stdio.h&gt;</tt>
</itemize>
<itemize>
<item><tt>#include &lt;string.h&gt;</tt>
</itemize>
<itemize>
<item><tt>#include &quot;datatype.h&quot;</tt>
</itemize>
<itemize>
<item><tt>#include &quot;cxref.h&quot;</tt>
<itemize>
<item><tt>#include &quot;datatype.h&quot;</tt>
</itemize>
</itemize>
<itemize>
<item><tt>#include &quot;memory.h&quot;</tt>
</itemize>

<sect1>External Variables

<p>
<bf>option_warn</bf><newline>
 Output option. 
<p>
<tt>extern int option_warn</tt><newline>
<descrip>
<tag>Defined in:</tag>
<itemize>
<item>option_warn</itemize>
</descrip>
<p>
<bf>option_raw</bf><newline>
 Output option. 
<p>
<tt>extern int option_raw</tt><newline>
<descrip>
<tag>Defined in:</tag>
<itemize>
<item>option_raw</itemize>
</descrip>
<p>
<bf>option_xref</bf><newline>
 Output option. 
<p>
<tt>extern int option_xref</tt><newline>
<descrip>
<tag>Defined in:</tag>
<itemize>
<item>option_xref</itemize>
</descrip>
<p>
<bf>option_index</bf><newline>
 Output option. 
<p>
<tt>extern int option_index</tt><newline>
<descrip>
<tag>Defined in:</tag>
<itemize>
<item>option_index</itemize>
</descrip>

<sect1>Local Variables

<p>
<bf>filename</bf><newline>
 The name of the current file. 
<p>
<tt>static char* filename</tt><newline>
<descrip>
<tag>Used in:</tag>
<itemize>
<item>WriteWarnRawDefine()
<item>WriteWarnRawFile()
<item>WriteWarnRawFilePart()
<item>WriteWarnRawFunction()
<item>WriteWarnRawInclude()
<item>WriteWarnRawTypedef()
<item>WriteWarnRawVariable()
</itemize>
</descrip>

<sect1>Global Function CopyOrSkip()

<p>  Decide if to copy or skip the next line.
<p>
<tt>int CopyOrSkip ( char* string, char* type, int* copy, int* skip )</tt><newline>
<descrip>
<tag><tt>int CopyOrSkip</tt></tag>
Returns the number of characters to skip.
<tag><tt>char* string</tt></tag>
The string that starts the next line.
<tag><tt>char* type</tt></tag>
The type of file we are outputing.
<tag><tt>int* copy</tt></tag>
Returns true if we are to copy the line verbatim.
<tag><tt>int* skip</tt></tag>
Returns true if we are to skip the line.
</descrip>
<descrip>
<tag>Prototyped in:</tag>
<itemize>
<item>cxref.h
</itemize>
<tag>Calls:</tag>
<itemize>
<item>strncmp()
</itemize>
<tag>Called by:</tag>
<itemize>
<item>html()  :  html.c
<item>latex()  :  latex.c
<item>rtf()  :  rtf.c
<item>sgml()  :  sgml.c
</itemize>
</descrip>

<sect1>Global Function WriteWarnRawAppendix()

<p>  Write out a raw version of the appendix.
<p>
<tt>void WriteWarnRawAppendix ( StringList files, StringList2 funcs, StringList2 vars, StringList2 types )</tt><newline>
<descrip>
<tag><tt>StringList files</tt></tag>
The list of files to write.
<tag><tt>StringList2 funcs</tt></tag>
The list of functions to write.
<tag><tt>StringList2 vars</tt></tag>
The list of variables to write.
<tag><tt>StringList2 types</tt></tag>
The list of types to write.
</descrip>
<descrip>
<tag>Prototyped in:</tag>
<itemize>
<item>cxref.h
</itemize>
<tag>Calls:</tag>
<itemize>
<item>printf()
</itemize>
<tag>Called by:</tag>
<itemize>
<item>main()  :  cxref.c
</itemize>
<tag>References Variables:</tag>
<itemize>
<item>option_index  :  cxref.c
<item>option_warn  :  cxref.c
</itemize>
</descrip>

<sect1>Global Function WriteWarnRawFile()

<p>  Write the raw / warning output for a complete File structure and all components.
<p>
<tt>void WriteWarnRawFile ( File file )</tt><newline>
<descrip>
<tag><tt>File file</tt></tag>
The File structure to output.
</descrip>
 The file structure is broken into its components and they are each written out. 
<p>
<descrip>
<tag>Prototyped in:</tag>
<itemize>
<item>cxref.h
</itemize>
<tag>Calls:</tag>
<itemize>
<item>WriteWarnRawDefine()  :  warn-raw.c
<item>WriteWarnRawFilePart()  :  warn-raw.c
<item>WriteWarnRawFunction()  :  warn-raw.c
<item>WriteWarnRawInclude()  :  warn-raw.c
<item>WriteWarnRawTypedef()  :  warn-raw.c
<item>WriteWarnRawVariable()  :  warn-raw.c
<item>printf()
</itemize>
<tag>Called by:</tag>
<itemize>
<item>main()  :  cxref.c
</itemize>
<tag>References Variables:</tag>
<itemize>
<item>filename  :  warn-raw.c
<item>option_raw  :  cxref.c
</itemize>
</descrip>

<sect1>Local Function WriteWarnRawDefine()

<p>  Write a Define structure out.
<p>
<tt>static void WriteWarnRawDefine ( Define def )</tt><newline>
<descrip>
<tag><tt>Define def</tt></tag>
The Define structure to output.
</descrip>
<descrip>
<tag>Prototyped in:</tag>
<itemize>
<item>warn-raw.c
</itemize>
<tag>Calls:</tag>
<itemize>
<item>printf()
</itemize>
<tag>Called by:</tag>
<itemize>
<item>WriteWarnRawFile()  :  warn-raw.c
</itemize>
<tag>References Variables:</tag>
<itemize>
<item>filename  :  warn-raw.c
<item>option_raw  :  cxref.c
<item>option_warn  :  cxref.c
</itemize>
</descrip>

<sect1>Local Function WriteWarnRawFilePart()

<p>  Write a File structure out.
<p>
<tt>static void WriteWarnRawFilePart ( File file )</tt><newline>
<descrip>
<tag><tt>File file</tt></tag>
The File structure to output.
</descrip>
<descrip>
<tag>Prototyped in:</tag>
<itemize>
<item>warn-raw.c
</itemize>
<tag>Calls:</tag>
<itemize>
<item>printf(), strcmp(), strlen()
</itemize>
<tag>Called by:</tag>
<itemize>
<item>WriteWarnRawFile()  :  warn-raw.c
</itemize>
<tag>References Variables:</tag>
<itemize>
<item>filename  :  warn-raw.c
<item>option_raw  :  cxref.c
<item>option_warn  :  cxref.c
<item>option_xref  :  cxref.c
</itemize>
</descrip>

<sect1>Local Function WriteWarnRawFunction()

<p>  Write a Function structure out.
<p>
<tt>static void WriteWarnRawFunction ( Function func )</tt><newline>
<descrip>
<tag><tt>Function func</tt></tag>
The Function structure to output.
</descrip>
<descrip>
<tag>Prototyped in:</tag>
<itemize>
<item>warn-raw.c
</itemize>
<tag>Calls:</tag>
<itemize>
<item>printf(), strcmp(), strncmp()
</itemize>
<tag>Called by:</tag>
<itemize>
<item>WriteWarnRawFile()  :  warn-raw.c
</itemize>
<tag>References Variables:</tag>
<itemize>
<item>filename  :  warn-raw.c
<item>option_raw  :  cxref.c
<item>option_warn  :  cxref.c
<item>option_xref  :  cxref.c
</itemize>
</descrip>

<sect1>Local Function WriteWarnRawInclude()

<p>  Write an Include structure out.
<p>
<tt>static void WriteWarnRawInclude ( Include inc )</tt><newline>
<descrip>
<tag><tt>Include inc</tt></tag>
The Include structure to output.
</descrip>
<descrip>
<tag>Prototyped in:</tag>
<itemize>
<item>warn-raw.c
</itemize>
<tag>Calls:</tag>
<itemize>
<item>WriteWarnRawSubInclude()  :  warn-raw.c
<item>printf()
</itemize>
<tag>Called by:</tag>
<itemize>
<item>WriteWarnRawFile()  :  warn-raw.c
</itemize>
<tag>References Variables:</tag>
<itemize>
<item>filename  :  warn-raw.c
<item>option_raw  :  cxref.c
<item>option_warn  :  cxref.c
</itemize>
</descrip>

<sect1>Local Function WriteWarnRawStructUnion()

<p>  Write a structure / union / enum out.
<p>
<tt>static void WriteWarnRawStructUnion ( StructUnion su, int depth, StructUnion base )</tt><newline>
<descrip>
<tag><tt>StructUnion su</tt></tag>
The structure / union / enum to write.
<tag><tt>int depth</tt></tag>
The depth within the structure.
<tag><tt>StructUnion base</tt></tag>
The base struct union that this one is part of.
</descrip>
<descrip>
<tag>Prototyped in:</tag>
<itemize>
<item>warn-raw.c
</itemize>
<tag>Calls:</tag>
<itemize>
<item>WriteWarnRawStructUnion()  :  warn-raw.c
<item>printf(), strstr()
</itemize>
<tag>Called by:</tag>
<itemize>
<item>WriteWarnRawStructUnion()  :  warn-raw.c
<item>WriteWarnRawTypedef()  :  warn-raw.c
</itemize>
<tag>References Variables:</tag>
<itemize>
<item>option_raw  :  cxref.c
<item>option_warn  :  cxref.c
</itemize>
</descrip>

<sect1>Local Function WriteWarnRawSubInclude()

<p>  Write an Sub-Include structure out.
<p>
<tt>static void WriteWarnRawSubInclude ( Include inc, int depth )</tt><newline>
<descrip>
<tag><tt>Include inc</tt></tag>
The Include structure to output.
<tag><tt>int depth</tt></tag>
The depth of the include hierarchy.
</descrip>
<descrip>
<tag>Prototyped in:</tag>
<itemize>
<item>warn-raw.c
</itemize>
<tag>Calls:</tag>
<itemize>
<item>WriteWarnRawSubInclude()  :  warn-raw.c
<item>printf()
</itemize>
<tag>Called by:</tag>
<itemize>
<item>WriteWarnRawInclude()  :  warn-raw.c
<item>WriteWarnRawSubInclude()  :  warn-raw.c
</itemize>
</descrip>

<sect1>Local Function WriteWarnRawTypedef()

<p>  Write a Typedef structure out.
<p>
<tt>static void WriteWarnRawTypedef ( Typedef type )</tt><newline>
<descrip>
<tag><tt>Typedef type</tt></tag>
The Typedef structure to output.
</descrip>
<descrip>
<tag>Prototyped in:</tag>
<itemize>
<item>warn-raw.c
</itemize>
<tag>Calls:</tag>
<itemize>
<item>WriteWarnRawStructUnion()  :  warn-raw.c
<item>printf()
</itemize>
<tag>Called by:</tag>
<itemize>
<item>WriteWarnRawFile()  :  warn-raw.c
</itemize>
<tag>References Variables:</tag>
<itemize>
<item>filename  :  warn-raw.c
<item>option_raw  :  cxref.c
<item>option_warn  :  cxref.c
</itemize>
</descrip>

<sect1>Local Function WriteWarnRawVariable()

<p>  Write a Variable structure out.
<p>
<tt>static void WriteWarnRawVariable ( Variable var )</tt><newline>
<descrip>
<tag><tt>Variable var</tt></tag>
The Variable structure to output.
</descrip>
<descrip>
<tag>Prototyped in:</tag>
<itemize>
<item>warn-raw.c
</itemize>
<tag>Calls:</tag>
<itemize>
<item>printf(), strcmp()
</itemize>
<tag>Called by:</tag>
<itemize>
<item>WriteWarnRawFile()  :  warn-raw.c
</itemize>
<tag>References Variables:</tag>
<itemize>
<item>filename  :  warn-raw.c
<item>option_raw  :  cxref.c
<item>option_warn  :  cxref.c
<item>option_xref  :  cxref.c
</itemize>
</descrip>

</article>
