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
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.6"/>
<title>LibOFX: file_preproc.cpp File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">LibOFX
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.6 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</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>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('file__preproc_8cpp.html','');});
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#func-members">Functions</a> |
<a href="#var-members">Variables</a> </div>
<div class="headertitle">
<div class="title">file_preproc.cpp File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>File type detection, etc.
<a href="#details">More...</a></p>
<p><a href="file__preproc_8cpp_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a01e232aea6806e09e048c98c94a49b66"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="file__preproc_8cpp.html#a01e232aea6806e09e048c98c94a49b66">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#a954c5e33f48105c5d932d4842e7736de">LibofxFileFormat</a> file_format)</td></tr>
<tr class="memdesc:a01e232aea6806e09e048c98c94a49b66"><td class="mdescLeft"> </td><td class="mdescRight">get_file_format_description returns a string description of a LibofxFileType. <a href="#a01e232aea6806e09e048c98c94a49b66">More...</a><br/></td></tr>
<tr class="separator:a01e232aea6806e09e048c98c94a49b66"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3bf84ecbf6ca512ea73d204c64972dbc"><td class="memItemLeft" align="right" valign="top">enum <a class="el" href="inc_2libofx_8h.html#a954c5e33f48105c5d932d4842e7736de">LibofxFileFormat</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="file__preproc_8cpp.html#a3bf84ecbf6ca512ea73d204c64972dbc">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 class="memdesc:a3bf84ecbf6ca512ea73d204c64972dbc"><td class="mdescLeft"> </td><td class="mdescRight">libofx_get_file_type returns a proper enum from a file type string. <a href="#a3bf84ecbf6ca512ea73d204c64972dbc">More...</a><br/></td></tr>
<tr class="separator:a3bf84ecbf6ca512ea73d204c64972dbc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7d14db73e2f828250874b6311c3d85ed"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="file__preproc_8cpp.html#a7d14db73e2f828250874b6311c3d85ed">libofx_proc_file</a> (LibofxContextPtr p_libofx_context, const char *p_filename, <a class="el" href="inc_2libofx_8h.html#a954c5e33f48105c5d932d4842e7736de">LibofxFileFormat</a> p_file_type)</td></tr>
<tr class="memdesc:a7d14db73e2f828250874b6311c3d85ed"><td class="mdescLeft"> </td><td class="mdescRight">libofx_proc_file is the entry point of the library. <a href="#a7d14db73e2f828250874b6311c3d85ed">More...</a><br/></td></tr>
<tr class="separator:a7d14db73e2f828250874b6311c3d85ed"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a34e14069654b16390599d24154b1f8d0"><td class="memItemLeft" align="right" valign="top">enum <a class="el" href="inc_2libofx_8h.html#a954c5e33f48105c5d932d4842e7736de">LibofxFileFormat</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="file__preproc_8cpp.html#a34e14069654b16390599d24154b1f8d0">libofx_detect_file_type</a> (const char *p_filename)</td></tr>
<tr class="memdesc:a34e14069654b16390599d24154b1f8d0"><td class="mdescLeft"> </td><td class="mdescRight">libofx_detect_file_type tries to analyze a file to determine it's format. <a href="#a34e14069654b16390599d24154b1f8d0">More...</a><br/></td></tr>
<tr class="separator:a34e14069654b16390599d24154b1f8d0"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="var-members"></a>
Variables</h2></td></tr>
<tr class="memitem:a3a4f15870bd5573d14fceb17c65162ee"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3a4f15870bd5573d14fceb17c65162ee"></a>
const unsigned int </td><td class="memItemRight" valign="bottom"><b>READ_BUFFER_SIZE</b> = 1024</td></tr>
<tr class="separator:a3a4f15870bd5573d14fceb17c65162ee"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>File type detection, etc. </p>
<p>Implements AutoDetection of file type, and handoff to specific parsers. </p>
<p>Definition in file <a class="el" href="file__preproc_8cpp_source.html">file_preproc.cpp</a>.</p>
</div><h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="a34e14069654b16390599d24154b1f8d0"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="inc_2libofx_8h.html#a954c5e33f48105c5d932d4842e7736de">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></td>
</tr>
</table>
</div><div class="memdoc">
<p>libofx_detect_file_type tries to analyze a file to determine it's format. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">p_filename</td><td>File name of the file to process </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Detected file format, UNKNOWN if unsuccessfull. </dd></dl>
<p>Definition at line <a class="el" href="file__preproc_8cpp_source.html#l00102">102</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>
<a class="anchor" id="a01e232aea6806e09e048c98c94a49b66"></a>
<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#a954c5e33f48105c5d932d4842e7736de">LibofxFileFormat</a> </td>
<td class="paramname"><em>file_format</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>get_file_format_description returns a string description of a LibofxFileType. </p>
<p>The file format list in which the format should be looked up, usually LibofxImportFormatList or LibofxExportFormatList</p>
<p>The file format which should match one of the formats in the list.</p>
<dl class="section return"><dt>Returns</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>
<p>Referenced by <a class="el" href="file__preproc_8cpp_source.html#l00067">libofx_proc_file()</a>.</p>
</div>
</div>
<a class="anchor" id="a3bf84ecbf6ca512ea73d204c64972dbc"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="inc_2libofx_8h.html#a954c5e33f48105c5d932d4842e7736de">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>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>libofx_get_file_type returns a proper enum from a file type string. </p>
<p>The file format list in which the format string should be found, usually LibofxImportFormatList or LibofxExportFormatList</p>
<p>The string which contain the file format matching one of the format_name of the list.</p>
<dl class="section return"><dt>Returns</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>
<a class="anchor" id="a7d14db73e2f828250874b6311c3d85ed"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int libofx_proc_file </td>
<td>(</td>
<td class="paramtype">LibofxContextPtr </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#a954c5e33f48105c5d932d4842e7736de">LibofxFileFormat</a> </td>
<td class="paramname"><em>ftype</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>libofx_proc_file is the entry point of the library. </p>
<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>
<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>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_92da12de3a7e435e6ac7f35fe8c95afc.html">lib</a></li><li class="navelem"><a class="el" href="file__preproc_8cpp.html">file_preproc.cpp</a></li>
<li class="footer">Generated on Fri Sep 12 2014 15:59:20 for LibOFX by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 </li>
</ul>
</div>
</body>
</html>
|
