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
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>XML-Security-C: XSECCanon.hpp Source File</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.4.2 -->
<div class="qindex"><a class="qindex" href="index.html">Main Page</a> | <a class="qindex" href="modules.html">Modules</a> | <a class="qindex" href="hierarchy.html">Class Hierarchy</a> | <a class="qindex" href="annotated.html">Class List</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="functions.html">Class Members</a> | <a class="qindex" href="globals.html">File Members</a> | <a class="qindex" href="pages.html">Related Pages</a></div>
<div class="nav">
<a class="el" href="dir_000000.html">src</a> / <a class="el" href="dir_000013.html">canon</a></div>
<h1>XSECCanon.hpp</h1><a href="XSECCanon_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment">00001 <span class="comment">/*</span>
00002 <span class="comment"> * Copyright 2002-2005 The Apache Software Foundation.</span>
00003 <span class="comment"> *</span>
00004 <span class="comment"> * Licensed under the Apache License, Version 2.0 (the "License");</span>
00005 <span class="comment"> * you may not use this file except in compliance with the License.</span>
00006 <span class="comment"> * You may obtain a copy of the License at</span>
00007 <span class="comment"> *</span>
00008 <span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span>
00009 <span class="comment"> *</span>
00010 <span class="comment"> * Unless required by applicable law or agreed to in writing, software</span>
00011 <span class="comment"> * distributed under the License is distributed on an "AS IS" BASIS,</span>
00012 <span class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span>
00013 <span class="comment"> * See the License for the specific language governing permissions and</span>
00014 <span class="comment"> * limitations under the License.</span>
00015 <span class="comment"> */</span>
00016
00017 <span class="comment">/*</span>
00018 <span class="comment"> * XSEC</span>
00019 <span class="comment"> *</span>
00020 <span class="comment"> * XSECCanon := Base (abstract) class for canonicalisation objects</span>
00021 <span class="comment"> *</span>
00022 <span class="comment"> *</span>
00023 <span class="comment"> * Author(s): Berin Lautenbach</span>
00024 <span class="comment"> *</span>
00025 <span class="comment"> * $Id: XSECCanon.hpp,v 1.7 2005/02/03 13:09:31 milan Exp $</span>
00026 <span class="comment"> */</span>
00027
00028 <span class="comment">// XSEC includes</span>
00029 <span class="preprocessor">#include <xsec/framework/XSECDefs.hpp></span>
00030 <span class="preprocessor">#include <xsec/utils/XSECSafeBuffer.hpp></span>
00031
00032 <a class="code" href="XSECDefs_8hpp.html#a5">XSEC_DECLARE_XERCES_CLASS</a>(DOMNode);
00033 <a class="code" href="XSECDefs_8hpp.html#a5">XSEC_DECLARE_XERCES_CLASS</a>(DOMDocument);
00034
00035 <span class="comment">// --------------------------------------------------------------------------------</span>
00036 <span class="comment">// Defines</span>
00037 <span class="comment">// --------------------------------------------------------------------------------</span>
00038
<a name="l00039"></a><a class="code" href="XSECCanon_8hpp.html#a0">00039</a> <span class="preprocessor">#define XSECCANNON_BUFFER_START_SIZE 8192 </span><span class="comment">/* Default size for the outBuffer */</span>
00040
00041
00042 <span class="comment">// --------------------------------------------------------------------------------</span>
00043 <span class="comment">// XSECCanon Virtual Class definition</span>
00044 <span class="comment">// --------------------------------------------------------------------------------</span>
00045
00046 <span class="comment">// Most of the interface work is done within this class. However the actual</span>
00047 <span class="comment">// processing is done via the processNextNode virtual function that must be</span>
00048 <span class="comment">// implemented by all children classes.</span>
00049
<a name="l00050"></a><a class="code" href="classXSECCanon.html">00050</a> <span class="keyword">class </span><a class="code" href="XSECDefs_8hpp.html#a8">CANON_EXPORT</a> <a class="code" href="classXSECCanon.html">XSECCanon</a> {
00051
00052 <span class="keyword">protected</span>:
00053
00054 <span class="comment">// Data structures</span>
00055
<a name="l00056"></a><a class="code" href="classXSECCanon.html#p0">00056</a> <a class="code" href="XSECDefs_8hpp.html#a0">XERCES_CPP_NAMESPACE_QUALIFIER</a> DOMDocument * mp_doc; <span class="comment">// Xerces DOM Node that defines the document</span>
<a name="l00057"></a><a class="code" href="classXSECCanon.html#p1">00057</a> <a class="code" href="XSECDefs_8hpp.html#a0">XERCES_CPP_NAMESPACE_QUALIFIER</a> DOMNode * mp_startNode, <span class="comment">// Node to start processing from</span>
00058 *mp_nextNode; <span class="comment">// Next Node to be processeed</span>
<a name="l00059"></a><a class="code" href="classXSECCanon.html#p3">00059</a> <a class="code" href="classsafeBuffer.html">safeBuffer</a> m_buffer; <span class="comment">// Buffer holding parsed output</span>
<a name="l00060"></a><a class="code" href="classXSECCanon.html#p5">00060</a> <span class="keywordtype">int</span> m_bufferLength, <span class="comment">// Length of input currently in buffer</span>
00061 m_bufferPoint; <span class="comment">// Next "character" to copy out</span>
<a name="l00062"></a><a class="code" href="classXSECCanon.html#p6">00062</a> <span class="keywordtype">bool</span> m_allNodesDone; <span class="comment">// Have we completed?</span>
00063
00064
00065 <span class="keyword">public</span>:
00066
00067 <span class="comment">// Constructors</span>
00068
00069 <a class="code" href="classXSECCanon.html">XSECCanon</a>();
00070 <a class="code" href="classXSECCanon.html">XSECCanon</a>(<a class="code" href="XSECDefs_8hpp.html#a0">XERCES_CPP_NAMESPACE_QUALIFIER</a> DOMDocument *newDoc);
00071 <a class="code" href="classXSECCanon.html">XSECCanon</a>(
00072 <a class="code" href="XSECDefs_8hpp.html#a0">XERCES_CPP_NAMESPACE_QUALIFIER</a> DOMDocument *newDoc,
00073 <a class="code" href="XSECDefs_8hpp.html#a0">XERCES_CPP_NAMESPACE_QUALIFIER</a> DOMNode *newStartNode);
00074
00075 <span class="comment">// Destructors</span>
00076
00077 <span class="keyword">virtual</span> ~<a class="code" href="classXSECCanon.html">XSECCanon</a>();
00078
00079 <span class="comment">// Public Methods</span>
00080
00081 <span class="comment">// outputBuffer is used by all canonicalisers to output the next numBytes bytes of</span>
00082 <span class="comment">// canonicalised XML to the nominated buffer</span>
00083
00084 <span class="keywordtype">int</span> outputBuffer(<span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *outBuffer, <span class="keywordtype">int</span> numBytes);
00085
00086 <span class="comment">// setStartNode sets the starting point for the output if it is a sub-document </span>
00087 <span class="comment">// that needs canonicalisation and we want to re-start</span>
00088
00089 <span class="keywordtype">bool</span> setStartNode(<a class="code" href="XSECDefs_8hpp.html#a0">XERCES_CPP_NAMESPACE_QUALIFIER</a> DOMNode *newStartNode);
00090
00091 <span class="keyword">protected</span>:
00092
00093 <span class="comment">// processNextNode is the pure virtual function that must be implemented by all canons</span>
00094
00095 <span class="keyword">virtual</span> <span class="keywordtype">int</span> processNextNode() = 0;
00096
00097 };
00098
</pre></div><hr size="1"><address style="align: right;"><small>Generated on Sun Jul 3 17:37:28 2005 for XML-Security-C by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.2 </small></address>
</body>
</html>
|
