← 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/fx-0_89_80_2lib_2ofx__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/fx-0_89_80_2lib_2ofx__preproc_8hh.html
 
1
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
 
2
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
 
3
<title>LibOFX: ofx_preproc.hh File Reference</title>
 
4
<link href="doxygen.css" rel="stylesheet" type="text/css">
 
5
<link href="tabs.css" rel="stylesheet" type="text/css">
 
6
</head><body>
 
7
<!-- Generated by Doxygen 1.5.3 -->
 
8
<div class="tabs">
 
9
  <ul>
 
10
    <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
 
11
    <li><a href="namespaces.html"><span>Namespaces</span></a></li>
 
12
    <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
 
13
    <li class="current"><a href="files.html"><span>Files</span></a></li>
 
14
  </ul>
 
15
</div>
 
16
<h1>ofx_preproc.hh File Reference</h1><hr><a name="_details"></a><h2>Detailed Description</h2>
 
17
Preprocessing of the OFX files before parsing. 
 
18
<p>
 
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. 
 
20
<p>Definition in file <a class="el" href="fx-0_89_80_2lib_2ofx__preproc_8hh-source.html">fx-0.9.0/lib/ofx_preproc.hh</a>.</p>
 
21
 
 
22
<p>
 
23
 
 
24
<p>
 
25
<a href="fx-0_89_80_2lib_2ofx__preproc_8hh-source.html">Go to the source code of this file.</a><table border="0" cellpadding="0" cellspacing="0">
 
26
<tr><td></td></tr>
 
27
<tr><td colspan="2"><br><h2>Defines</h2></td></tr>
 
28
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d9e6681d8259d0d224f7c775eb25487c"></a><!-- doxytag: member="fx-0.9.0/lib/ofx_preproc.hh::OPENSPDCL_FILENAME" ref="d9e6681d8259d0d224f7c775eb25487c" args="" -->
 
29
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="fx-0_89_80_2lib_2ofx__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="fx-0.9.0/lib/ofx_preproc.hh::OFX160DTD_FILENAME" ref="9048e71566173bdc4719830bf28bec3b" args="" -->
 
32
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="fx-0_89_80_2lib_2ofx__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="fx-0.9.0/lib/ofx_preproc.hh::OFCDTD_FILENAME" ref="db19c9e865a6e5d4ae16c68b36b1734c" args="" -->
 
35
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="fx-0_89_80_2lib_2ofx__preproc_8hh.html#db19c9e865a6e5d4ae16c68b36b1734c">OFCDTD_FILENAME</a>&nbsp;&nbsp;&nbsp;&quot;ofc.dtd&quot;</td></tr>
 
36
 
 
37
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
 
38
<tr><td class="memItemLeft" nowrap align="right" valign="top">string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="fx-0_89_80_2lib_2ofx__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="fx-0_89_80_2lib_2ofx__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="fx-0_89_80_2lib_2ofx__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>
 
47
</table>
 
48
<hr><h2>Function Documentation</h2>
 
49
<a class="anchor" name="a45231657cddffcb50db295076956183"></a><!-- doxytag: member="fx-0.9.0/lib/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>
 
69
        </tr>
 
70
      </table>
 
71
</div>
 
72
<div class="memdoc">
 
73
 
 
74
<p>
 
75
Find the appropriate DTD for the file version. 
 
76
<p>
 
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>
 
78
Please note that currently the function will ALWAYS look for version 160, since OpenSP can't parse the 201 DTD correctly 
 
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="fx-0.9.0/lib/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>
 
103
        </tr>
 
104
      </table>
 
105
</div>
 
106
<div class="memdoc">
 
107
 
 
108
<p>
 
109
ofx_proc_file process an ofx or ofc file. 
 
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>
 
113
Takes care of comment striping, dtd locating, etc. 
 
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="fx-0.9.0/lib/ofx_preproc.hh::sanitize_proprietary_tags" ref="cdbd49c3c11946411dd76016609bd333" args="(string input_string)" -->
 
119
<div class="memitem">
 
120
<div class="memproto">
 
121
      <table class="memname">
 
122
        <tr>
 
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>
 
129
        </tr>
 
130
      </table>
 
131
</div>
 
132
<div class="memdoc">
 
133
 
 
134
<p>
 
135
Removes proprietary tags and comments. 
 
136
<p>
 
137
This function will strip all the OFX proprietary tags and SGML comments from the SGML string passed to it 
 
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;
 
143
<a href="http://www.doxygen.org/index.html">
 
144
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.3 </small></address>
 
145
</body>
 
146
</html>