← Back to branch summary

~mterry/ubuntu/natty/libofx/libofx.new-upstream-benoit-sru

« back to all changes in this revision

Viewing changes to doc/html/ofx__preproc_8hh.html

  • Committer: Bazaar Package Importer
  • Author(s): Saïvann Carignan
  • Date: 2008-02-06 17:25:16 UTC
  • mto: (3.1.2 lenny)
  • mto: This revision was merged to the branch mainline in revision 11.
  • Revision ID: james.westby@ubuntu.com-20080206172516-bnzxb29igye8um9h
Tags: upstream-0.9.0
Import upstream version 0.9.0

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/html/ofx__preproc_8hh.html
1
1
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2
 
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
 
2
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
3
3
<title>LibOFX: ofx_preproc.hh File Reference</title>
4
4
<link href="doxygen.css" rel="stylesheet" type="text/css">
5
5
<link href="tabs.css" rel="stylesheet" type="text/css">
6
6
</head><body>
7
 
<!-- Generated by Doxygen 1.4.6 -->
 
7
<!-- Generated by Doxygen 1.5.3 -->
8
8
<div class="tabs">
9
9
  <ul>
10
10
    <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
11
11
    <li><a href="namespaces.html"><span>Namespaces</span></a></li>
12
12
    <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
13
 
    <li id="current"><a href="files.html"><span>Files</span></a></li>
14
 
  </ul></div>
15
 
<div class="tabs">
16
 
  <ul>
17
 
    <li><a href="files.html"><span>File&nbsp;List</span></a></li>
18
 
    <li><a href="globals.html"><span>Globals</span></a></li>
19
 
  </ul></div>
 
13
    <li class="current"><a href="files.html"><span>Files</span></a></li>
 
14
  </ul>
 
15
</div>
20
16
<h1>ofx_preproc.hh File Reference</h1><hr><a name="_details"></a><h2>Detailed Description</h2>
21
17
Preprocessing of the OFX files before parsing. 
22
18
<p>
23
19
Implements the pre-treatement of the OFX file prior to parsing: OFX header striping, OFX proprietary tags and SGML comment striping, locating the appropriate DTD. 
24
 
<p>
25
 
Definition in file <a class="el" href="ofx__preproc_8hh-source.html">ofx_preproc.hh</a>.
 
20
<p>Definition in file <a class="el" href="ofx__preproc_8hh-source.html">ofx_preproc.hh</a>.</p>
 
21
 
26
22
<p>
27
23
 
28
24
<p>
29
25
<a href="ofx__preproc_8hh-source.html">Go to the source code of this file.</a><table border="0" cellpadding="0" cellspacing="0">
30
26
<tr><td></td></tr>
31
27
<tr><td colspan="2"><br><h2>Defines</h2></td></tr>
32
 
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5672c78b4764323c0a9f2b19887d9431"></a><!-- doxytag: member="ofx_preproc.hh::OPENSPDCL_FILENAME" ref="5672c78b4764323c0a9f2b19887d9431" args="" -->
33
 
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="ofx__preproc_8hh.html#5672c78b4764323c0a9f2b19887d9431">OPENSPDCL_FILENAME</a>&nbsp;&nbsp;&nbsp;&quot;opensp.dcl&quot;</td></tr>
34
 
 
35
 
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e8845df1e079aa24b66aa0f5360b2893"></a><!-- doxytag: member="ofx_preproc.hh::OFX160DTD_FILENAME" ref="e8845df1e079aa24b66aa0f5360b2893" args="" -->
36
 
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="ofx__preproc_8hh.html#e8845df1e079aa24b66aa0f5360b2893">OFX160DTD_FILENAME</a>&nbsp;&nbsp;&nbsp;&quot;ofx160.dtd&quot;</td></tr>
37
 
 
38
 
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="148e2bcd13df8fdbaf41d797c48b7755"></a><!-- doxytag: member="ofx_preproc.hh::OFCDTD_FILENAME" ref="148e2bcd13df8fdbaf41d797c48b7755" args="" -->
39
 
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="ofx__preproc_8hh.html#148e2bcd13df8fdbaf41d797c48b7755">OFCDTD_FILENAME</a>&nbsp;&nbsp;&nbsp;&quot;ofc.dtd&quot;</td></tr>
 
28
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d9e6681d8259d0d224f7c775eb25487c"></a><!-- doxytag: member="ofx_preproc.hh::OPENSPDCL_FILENAME" ref="d9e6681d8259d0d224f7c775eb25487c" args="" -->
 
29
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="ofx__preproc_8hh.html#d9e6681d8259d0d224f7c775eb25487c">OPENSPDCL_FILENAME</a>&nbsp;&nbsp;&nbsp;&quot;opensp.dcl&quot;</td></tr>
 
30
 
 
31
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9048e71566173bdc4719830bf28bec3b"></a><!-- doxytag: member="ofx_preproc.hh::OFX160DTD_FILENAME" ref="9048e71566173bdc4719830bf28bec3b" args="" -->
 
32
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="ofx__preproc_8hh.html#9048e71566173bdc4719830bf28bec3b">OFX160DTD_FILENAME</a>&nbsp;&nbsp;&nbsp;&quot;ofx160.dtd&quot;</td></tr>
 
33
 
 
34
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="db19c9e865a6e5d4ae16c68b36b1734c"></a><!-- doxytag: member="ofx_preproc.hh::OFCDTD_FILENAME" ref="db19c9e865a6e5d4ae16c68b36b1734c" args="" -->
 
35
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="ofx__preproc_8hh.html#db19c9e865a6e5d4ae16c68b36b1734c">OFCDTD_FILENAME</a>&nbsp;&nbsp;&nbsp;&quot;ofc.dtd&quot;</td></tr>
40
36
 
41
37
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
42
 
<tr><td class="memItemLeft" nowrap align="right" valign="top">string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="ofx__preproc_8hh.html#1081ea6fa992f51998090e4c24d6cc64">sanitize_proprietary_tags</a> (string input_string)</td></tr>
43
 
 
44
 
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Removes proprietary tags and comments.  <a href="#1081ea6fa992f51998090e4c24d6cc64"></a><br></td></tr>
45
 
<tr><td class="memItemLeft" nowrap align="right" valign="top">string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="ofx__preproc_8hh.html#5efb55f65bf1d51e4863c6cc1c10439c">find_dtd</a> (string dtd_filename)</td></tr>
46
 
 
47
 
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Find the appropriate DTD for the file version.  <a href="#5efb55f65bf1d51e4863c6cc1c10439c"></a><br></td></tr>
48
 
<tr><td class="memItemLeft" nowrap align="right" valign="top">CFCT int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="ofx__preproc_8hh.html#878483503b673b330380995e1da3a7ea">ofx_proc_file</a> (<a class="el" href="libofx-0_88_82_2inc_2libofx_8h.html#15e5ea23015b0e379679d9e8db1057c0">LibofxContextPtr</a> libofx_context, const char *)</td></tr>
49
 
 
50
 
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">ofx_proc_file process an ofx or ofc file.  <a href="#878483503b673b330380995e1da3a7ea"></a><br></td></tr>
 
38
<tr><td class="memItemLeft" nowrap align="right" valign="top">string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="ofx__preproc_8hh.html#cdbd49c3c11946411dd76016609bd333">sanitize_proprietary_tags</a> (string input_string)</td></tr>
 
39
 
 
40
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Removes proprietary tags and comments.  <a href="#cdbd49c3c11946411dd76016609bd333"></a><br></td></tr>
 
41
<tr><td class="memItemLeft" nowrap align="right" valign="top">string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="ofx__preproc_8hh.html#a45231657cddffcb50db295076956183">find_dtd</a> (<a class="el" href="libofx-0_89_80_2inc_2libofx_8h.html#cb05196108aab07092d1b4931577b87c">LibofxContextPtr</a> ctx, string dtd_filename)</td></tr>
 
42
 
 
43
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Find the appropriate DTD for the file version.  <a href="#a45231657cddffcb50db295076956183"></a><br></td></tr>
 
44
<tr><td class="memItemLeft" nowrap align="right" valign="top">CFCT int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="ofx__preproc_8hh.html#962fcc61a6192bd63ac3fb234fd07cc4">ofx_proc_file</a> (<a class="el" href="libofx-0_89_80_2inc_2libofx_8h.html#cb05196108aab07092d1b4931577b87c">LibofxContextPtr</a> libofx_context, const char *)</td></tr>
 
45
 
 
46
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">ofx_proc_file process an ofx or ofc file.  <a href="#962fcc61a6192bd63ac3fb234fd07cc4"></a><br></td></tr>
51
47
</table>
52
48
<hr><h2>Function Documentation</h2>
53
 
<a class="anchor" name="5efb55f65bf1d51e4863c6cc1c10439c"></a><!-- doxytag: member="ofx_preproc.hh::find_dtd" ref="5efb55f65bf1d51e4863c6cc1c10439c" args="(string dtd_filename)" --><p>
54
 
<table class="mdTable" cellpadding="2" cellspacing="0">
55
 
  <tr>
56
 
    <td class="mdRow">
57
 
      <table cellpadding="0" cellspacing="0" border="0">
58
 
        <tr>
59
 
          <td class="md" nowrap valign="top">string find_dtd           </td>
60
 
          <td class="md" valign="top">(&nbsp;</td>
61
 
          <td class="md" nowrap valign="top">string&nbsp;</td>
62
 
          <td class="mdname1" valign="top" nowrap> <em>dtd_filename</em>          </td>
63
 
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
64
 
          <td class="md" nowrap></td>
 
49
<a class="anchor" name="a45231657cddffcb50db295076956183"></a><!-- doxytag: member="ofx_preproc.hh::find_dtd" ref="a45231657cddffcb50db295076956183" args="(LibofxContextPtr ctx, string dtd_filename)" -->
 
50
<div class="memitem">
 
51
<div class="memproto">
 
52
      <table class="memname">
 
53
        <tr>
 
54
          <td class="memname">string find_dtd           </td>
 
55
          <td>(</td>
 
56
          <td class="paramtype"><a class="el" href="libofx-0_89_80_2inc_2libofx_8h.html#cb05196108aab07092d1b4931577b87c">LibofxContextPtr</a>&nbsp;</td>
 
57
          <td class="paramname"> <em>ctx</em>, </td>
 
58
        </tr>
 
59
        <tr>
 
60
          <td class="paramkey"></td>
 
61
          <td></td>
 
62
          <td class="paramtype">string&nbsp;</td>
 
63
          <td class="paramname"> <em>dtd_filename</em></td><td>&nbsp;</td>
 
64
        </tr>
 
65
        <tr>
 
66
          <td></td>
 
67
          <td>)</td>
 
68
          <td></td><td></td><td width="100%"></td>
65
69
        </tr>
66
70
      </table>
67
 
    </td>
68
 
  </tr>
69
 
</table>
70
 
<table cellspacing="5" cellpadding="0" border="0">
71
 
  <tr>
72
 
    <td>
73
 
      &nbsp;
74
 
    </td>
75
 
    <td>
 
71
</div>
 
72
<div class="memdoc">
76
73
 
77
74
<p>
78
75
Find the appropriate DTD for the file version. 
79
76
<p>
80
77
This function will try to find a DTD matching the requested_version and return the full path of the DTD found (or an empty string if unsuccessfull)<p>
81
78
Please note that currently the function will ALWAYS look for version 160, since OpenSP can't parse the 201 DTD correctly 
82
 
<p>
83
 
Definition at line <a class="el" href="ofx__preproc_8cpp-source.html#l00434">434</a> of file <a class="el" href="ofx__preproc_8cpp-source.html">ofx_preproc.cpp</a>.    </td>
84
 
  </tr>
85
 
</table>
86
 
<a class="anchor" name="878483503b673b330380995e1da3a7ea"></a><!-- doxytag: member="ofx_preproc.hh::ofx_proc_file" ref="878483503b673b330380995e1da3a7ea" args="(LibofxContextPtr libofx_context, const char *)" --><p>
87
 
<table class="mdTable" cellpadding="2" cellspacing="0">
88
 
  <tr>
89
 
    <td class="mdRow">
90
 
      <table cellpadding="0" cellspacing="0" border="0">
91
 
        <tr>
92
 
          <td class="md" nowrap valign="top">CFCT int ofx_proc_file           </td>
93
 
          <td class="md" valign="top">(&nbsp;</td>
94
 
          <td class="md" nowrap valign="top"><a class="el" href="libofx-0_88_82_2inc_2libofx_8h.html#15e5ea23015b0e379679d9e8db1057c0">LibofxContextPtr</a>&nbsp;</td>
95
 
          <td class="mdname" nowrap> <em>ctx</em>, </td>
96
 
        </tr>
97
 
        <tr>
98
 
          <td class="md" nowrap align="right"></td>
99
 
          <td class="md"></td>
100
 
          <td class="md" nowrap>const char *&nbsp;</td>
101
 
          <td class="mdname" nowrap> <em>p_filename</em></td>
102
 
        </tr>
103
 
        <tr>
104
 
          <td class="md"></td>
105
 
          <td class="md">)&nbsp;</td>
106
 
          <td class="md" colspan="2"></td>
 
79
<p>Definition at line <a class="el" href="ofx__preproc_8cpp-source.html#l00514">514</a> of file <a class="el" href="ofx__preproc_8cpp-source.html">ofx_preproc.cpp</a>.</p>
 
80
 
 
81
</div>
 
82
</div><p>
 
83
<a class="anchor" name="962fcc61a6192bd63ac3fb234fd07cc4"></a><!-- doxytag: member="ofx_preproc.hh::ofx_proc_file" ref="962fcc61a6192bd63ac3fb234fd07cc4" args="(LibofxContextPtr libofx_context, const char *)" -->
 
84
<div class="memitem">
 
85
<div class="memproto">
 
86
      <table class="memname">
 
87
        <tr>
 
88
          <td class="memname">CFCT int ofx_proc_file           </td>
 
89
          <td>(</td>
 
90
          <td class="paramtype"><a class="el" href="libofx-0_89_80_2inc_2libofx_8h.html#cb05196108aab07092d1b4931577b87c">LibofxContextPtr</a>&nbsp;</td>
 
91
          <td class="paramname"> <em>ctx</em>, </td>
 
92
        </tr>
 
93
        <tr>
 
94
          <td class="paramkey"></td>
 
95
          <td></td>
 
96
          <td class="paramtype">const char *&nbsp;</td>
 
97
          <td class="paramname"> <em>p_filename</em></td><td>&nbsp;</td>
 
98
        </tr>
 
99
        <tr>
 
100
          <td></td>
 
101
          <td>)</td>
 
102
          <td></td><td></td><td width="100%"></td>
107
103
        </tr>
108
104
      </table>
109
 
    </td>
110
 
  </tr>
111
 
</table>
112
 
<table cellspacing="5" cellpadding="0" border="0">
113
 
  <tr>
114
 
    <td>
115
 
      &nbsp;
116
 
    </td>
117
 
    <td>
 
105
</div>
 
106
<div class="memdoc">
118
107
 
119
108
<p>
120
109
ofx_proc_file process an ofx or ofc file. 
121
110
<p>
 
111
libofx_proc_file must be called with a list of 1 or more OFX files to be parsed in command line format.<p>
 
112
ofx_proc_file process an ofx or ofc file.<p>
122
113
Takes care of comment striping, dtd locating, etc. 
123
 
<p>
124
 
Definition at line <a class="el" href="ofx__preproc_8cpp-source.html#l00058">58</a> of file <a class="el" href="ofx__preproc_8cpp-source.html">ofx_preproc.cpp</a>.    </td>
125
 
  </tr>
126
 
</table>
127
 
<a class="anchor" name="1081ea6fa992f51998090e4c24d6cc64"></a><!-- doxytag: member="ofx_preproc.hh::sanitize_proprietary_tags" ref="1081ea6fa992f51998090e4c24d6cc64" args="(string input_string)" --><p>
128
 
<table class="mdTable" cellpadding="2" cellspacing="0">
129
 
  <tr>
130
 
    <td class="mdRow">
131
 
      <table cellpadding="0" cellspacing="0" border="0">
 
114
<p>Definition at line <a class="el" href="ofx__preproc_8cpp-source.html#l00070">70</a> of file <a class="el" href="ofx__preproc_8cpp-source.html">ofx_preproc.cpp</a>.</p>
 
115
 
 
116
</div>
 
117
</div><p>
 
118
<a class="anchor" name="cdbd49c3c11946411dd76016609bd333"></a><!-- doxytag: member="ofx_preproc.hh::sanitize_proprietary_tags" ref="cdbd49c3c11946411dd76016609bd333" args="(string input_string)" -->
 
119
<div class="memitem">
 
120
<div class="memproto">
 
121
      <table class="memname">
132
122
        <tr>
133
 
          <td class="md" nowrap valign="top">string sanitize_proprietary_tags           </td>
134
 
          <td class="md" valign="top">(&nbsp;</td>
135
 
          <td class="md" nowrap valign="top">string&nbsp;</td>
136
 
          <td class="mdname1" valign="top" nowrap> <em>input_string</em>          </td>
137
 
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
138
 
          <td class="md" nowrap></td>
 
123
          <td class="memname">string sanitize_proprietary_tags           </td>
 
124
          <td>(</td>
 
125
          <td class="paramtype">string&nbsp;</td>
 
126
          <td class="paramname"> <em>input_string</em>          </td>
 
127
          <td>&nbsp;)&nbsp;</td>
 
128
          <td width="100%"></td>
139
129
        </tr>
140
130
      </table>
141
 
    </td>
142
 
  </tr>
143
 
</table>
144
 
<table cellspacing="5" cellpadding="0" border="0">
145
 
  <tr>
146
 
    <td>
147
 
      &nbsp;
148
 
    </td>
149
 
    <td>
 
131
</div>
 
132
<div class="memdoc">
150
133
 
151
134
<p>
152
135
Removes proprietary tags and comments. 
153
136
<p>
154
137
This function will strip all the OFX proprietary tags and SGML comments from the SGML string passed to it 
155
 
<p>
156
 
Definition at line <a class="el" href="ofx__preproc_8cpp-source.html#l00331">331</a> of file <a class="el" href="ofx__preproc_8cpp-source.html">ofx_preproc.cpp</a>.    </td>
157
 
  </tr>
158
 
</table>
159
 
<hr size="1"><address style="align: right;"><small>Generated on Fri Aug 25 13:25:22 2006 for LibOFX by&nbsp;
 
138
<p>Definition at line <a class="el" href="ofx__preproc_8cpp-source.html#l00411">411</a> of file <a class="el" href="ofx__preproc_8cpp-source.html">ofx_preproc.cpp</a>.</p>
 
139
 
 
140
</div>
 
141
</div><p>
 
142
<hr size="1"><address style="text-align: right;"><small>Generated on Mon Nov 19 20:28:00 2007 for LibOFX by&nbsp;
160
143
<a href="http://www.doxygen.org/index.html">
161
 
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6 </small></address>
 
144
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.3 </small></address>
162
145
</body>
163
146
</html>