1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>LibOFX: file_preproc.cpp File Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.3 -->
<div class="tabs">
<ul>
<li><a href="main.html"><span>Main Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<h1>file_preproc.cpp File Reference</h1><hr><a name="_details"></a><h2>Detailed Description</h2>
File type detection, etc.
<p>
Implements AutoDetection of file type, and handoff to specific parsers.
<p>Definition in file <a class="el" href="file__preproc_8cpp-source.html">file_preproc.cpp</a>.</p>
<p>
<p>
<a href="file__preproc_8cpp-source.html">Go to the source code of this file.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="file__preproc_8cpp.html#01e232aea6806e09e048c98c94a49b66">libofx_get_file_format_description</a> (const struct <a class="el" href="structLibofxFileFormatInfo.html">LibofxFileFormatInfo</a> format_list[], enum <a class="el" href="inc_2libofx_8h.html#954c5e33f48105c5d932d4842e7736de">LibofxFileFormat</a> file_format)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">get_file_format_description returns a string description of a LibofxFileType. <a href="#01e232aea6806e09e048c98c94a49b66"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">enum <a class="el" href="inc_2libofx_8h.html#954c5e33f48105c5d932d4842e7736de">LibofxFileFormat</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="file__preproc_8cpp.html#3bf84ecbf6ca512ea73d204c64972dbc">libofx_get_file_format_from_str</a> (const struct <a class="el" href="structLibofxFileFormatInfo.html">LibofxFileFormatInfo</a> format_list[], const char *file_type_string)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">libofx_get_file_type returns a proper enum from a file type string. <a href="#3bf84ecbf6ca512ea73d204c64972dbc"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">CFCT int </td><td class="memItemRight" valign="bottom"><a class="el" href="file__preproc_8cpp.html#29b78b5f31a8c75206a8e2b4d665099f">libofx_proc_file</a> (<a class="el" href="libofx-0_89_80_2inc_2libofx_8h.html#cb05196108aab07092d1b4931577b87c">LibofxContextPtr</a> p_libofx_context, const char *p_filename, <a class="el" href="inc_2libofx_8h.html#954c5e33f48105c5d932d4842e7736de">LibofxFileFormat</a> p_file_type)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">libofx_proc_file is the entry point of the library. <a href="#29b78b5f31a8c75206a8e2b4d665099f"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">enum <a class="el" href="inc_2libofx_8h.html#954c5e33f48105c5d932d4842e7736de">LibofxFileFormat</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="file__preproc_8cpp.html#34e14069654b16390599d24154b1f8d0">libofx_detect_file_type</a> (const char *p_filename)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">libofx_detect_file_type tries to analyze a file to determine it's format. <a href="#34e14069654b16390599d24154b1f8d0"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Variables</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3a4f15870bd5573d14fceb17c65162ee"></a><!-- doxytag: member="file_preproc.cpp::READ_BUFFER_SIZE" ref="3a4f15870bd5573d14fceb17c65162ee" args="" -->
const unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="file__preproc_8cpp.html#3a4f15870bd5573d14fceb17c65162ee">READ_BUFFER_SIZE</a> = 1024</td></tr>
</table>
<hr><h2>Function Documentation</h2>
<a class="anchor" name="34e14069654b16390599d24154b1f8d0"></a><!-- doxytag: member="file_preproc.cpp::libofx_detect_file_type" ref="34e14069654b16390599d24154b1f8d0" args="(const char *p_filename)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="inc_2libofx_8h.html#954c5e33f48105c5d932d4842e7736de">LibofxFileFormat</a> libofx_detect_file_type </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>p_filename</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
libofx_detect_file_type tries to analyze a file to determine it's format.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>p_filename</em> </td><td>File name of the file to process </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Detected file format, UNKNOWN if unsuccessfull. </dd></dl>
<p>Definition at line <a class="el" href="file__preproc_8cpp-source.html#l00099">99</a> of file <a class="el" href="file__preproc_8cpp-source.html">file_preproc.cpp</a>.</p>
<p>Referenced by <a class="el" href="file__preproc_8cpp-source.html#l00067">libofx_proc_file()</a>.</p>
</div>
</div><p>
<a class="anchor" name="01e232aea6806e09e048c98c94a49b66"></a><!-- doxytag: member="file_preproc.cpp::libofx_get_file_format_description" ref="01e232aea6806e09e048c98c94a49b66" args="(const struct LibofxFileFormatInfo format_list[], enum LibofxFileFormat file_format)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* libofx_get_file_format_description </td>
<td>(</td>
<td class="paramtype">const struct <a class="el" href="structLibofxFileFormatInfo.html">LibofxFileFormatInfo</a> </td>
<td class="paramname"> <em>format_list</em>[], </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">enum <a class="el" href="inc_2libofx_8h.html#954c5e33f48105c5d932d4842e7736de">LibofxFileFormat</a> </td>
<td class="paramname"> <em>file_format</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
get_file_format_description returns a string description of a LibofxFileType.
<p>
The file format list in which the format should be looked up, usually LibofxImportFormatList or LibofxExportFormatList The file format which should match one of the formats in the list. <dl class="return" compact><dt><b>Returns:</b></dt><dd>null terminated string suitable for debugging output or user communication. </dd></dl>
<p>Definition at line <a class="el" href="file__preproc_8cpp-source.html#l00037">37</a> of file <a class="el" href="file__preproc_8cpp-source.html">file_preproc.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="3bf84ecbf6ca512ea73d204c64972dbc"></a><!-- doxytag: member="file_preproc.cpp::libofx_get_file_format_from_str" ref="3bf84ecbf6ca512ea73d204c64972dbc" args="(const struct LibofxFileFormatInfo format_list[], const char *file_type_string)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="inc_2libofx_8h.html#954c5e33f48105c5d932d4842e7736de">LibofxFileFormat</a> libofx_get_file_format_from_str </td>
<td>(</td>
<td class="paramtype">const struct <a class="el" href="structLibofxFileFormatInfo.html">LibofxFileFormatInfo</a> </td>
<td class="paramname"> <em>format_list</em>[], </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>file_type_string</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
libofx_get_file_type returns a proper enum from a file type string.
<p>
The file format list in which the format string should be found, usually LibofxImportFormatList or LibofxExportFormatList The string which contain the file format matching one of the format_name of the list. <dl class="return" compact><dt><b>Returns:</b></dt><dd>the file format, or UNKNOWN if the format wasn't recognised. </dd></dl>
<p>Definition at line <a class="el" href="file__preproc_8cpp-source.html#l00054">54</a> of file <a class="el" href="file__preproc_8cpp-source.html">file_preproc.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="29b78b5f31a8c75206a8e2b4d665099f"></a><!-- doxytag: member="file_preproc.cpp::libofx_proc_file" ref="29b78b5f31a8c75206a8e2b4d665099f" args="(LibofxContextPtr p_libofx_context, const char *p_filename, LibofxFileFormat p_file_type)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CFCT int libofx_proc_file </td>
<td>(</td>
<td class="paramtype"><a class="el" href="libofx-0_89_80_2inc_2libofx_8h.html#cb05196108aab07092d1b4931577b87c">LibofxContextPtr</a> </td>
<td class="paramname"> <em>libofx_context</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>p_filename</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">enum <a class="el" href="inc_2libofx_8h.html#954c5e33f48105c5d932d4842e7736de">LibofxFileFormat</a> </td>
<td class="paramname"> <em>ftype</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
libofx_proc_file is the entry point of the library.
<p>
libofx_proc_file must be called by the client, with a list of 1 or more OFX files to be parsed in command line format.
<p>Definition at line <a class="el" href="file__preproc_8cpp-source.html#l00067">67</a> of file <a class="el" href="file__preproc_8cpp-source.html">file_preproc.cpp</a>.</p>
</div>
</div><p>
<hr size="1"><address style="text-align: right;"><small>Generated on Mon Nov 19 20:27:59 2007 for LibOFX by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.3 </small></address>
</body>
</html>
|
