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
|
//=============================================================================
// File: entity.h
// Contents: Declarations for DwEntity
// Maintainer: Doug Sauder <dwsauder@fwb.gulf.net>
// WWW: http://www.fwb.gulf.net/~dwsauder/mimepp.html
//
// Copyright (c) 1996, 1997 Douglas W. Sauder
// All rights reserved.
//
// IN NO EVENT SHALL DOUGLAS W. SAUDER BE LIABLE TO ANY PARTY FOR DIRECT,
// INDIRECT, SPECIAL, INCIDENTAL, OR CONSETQUENTIAL DAMAGES ARISING OUT OF
// THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF DOUGLAS W. SAUDER
// HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// DOUGLAS W. SAUDER SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING, BUT
// NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
// PARTICULAR PURPOSE. THE SOFTWARE PROVIDED HEREUNDER IS ON AN "AS IS"
// BASIS, AND DOUGLAS W. SAUDER HAS NO OBLIGATION TO PROVIDE MAINTENANCE,
// SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
//
//=============================================================================
#ifndef DW_ENTITY_H
#define DW_ENTITY_H
#ifndef DW_CONFIG_H
#include <mimelib/config.h>
#endif
#ifndef DW_STRING_H
#include <mimelib/string.h>
#endif
#ifndef DW_MSGCMP_H
#include <mimelib/msgcmp.h>
#endif
class DwHeaders;
class DwBody;
//=============================================================================
//+ Name DwEntity -- Abstract class representing a MIME entity
//+ Description
//. RFC-2045 defines an {\it entity} as either a {\it message} or a
//. {\it body part}, both of which have a collection of headers and
//. a {\it body}. In MIME++, an entity is represented by the class
//. {\tt DwEntity}, which contains both a {\tt DwHeaders} object and
//. a {\tt DwBody} object.
//.
//. In the tree (broken-down) representation of message, a {\tt DwEntity}
//. object may be either a root node, having child nodes but no tqparent
//. node, or an intermediate node, having both a tqparent node and child nodes.
//. A {\tt DwEntity} object that is a root node must also be a {\tt DwMessage}
//. object. If a {\tt DwEntity} object is an intermediate node, its tqparent
//. must be a {\tt DwBody} object. The child nodes of a {\tt DwEntity}
//. object are the {\tt DwHeaders} and {\tt DwBody} objects it tqcontains.
//.
//. Since {\tt DwEntity} is an abstract base class, you cannot create
//. instances of it directly. {\tt DwEntity} has two derived classes,
//. {\tt DwMessage} and {\tt DwBodyPart}, which are concrete classes.
//.
//. To access the contained {\tt DwHeaders} object, use the member function
//. {\tt Headers()}. To access the contained {\tt DwBody} object, use the
//. member function {\tt Body()}.
//=============================================================================
// Last updated 1997-08-23
//+ Noentry ~DwEntity mHeaders mBody _PrintDebugInfo
class DW_EXPORT DwEntity : public DwMessageComponent {
public:
DwEntity();
DwEntity(const DwEntity& aEntity);
DwEntity(const DwString& aStr, DwMessageComponent* aParent=0);
//. The first constructor is the default constructor, which sets the
//. {\tt DwEntity} object's string representation to the empty string
//. and sets its tqparent to {\tt NULL}.
//.
//. The second constructor is the copy constructor, which performs
//. a deep copy of {\tt aEntity}.
//. The tqparent of the new {\tt DwEntity} object is set to {\tt NULL}.
//.
//. The third constructor copies {\tt aStr} to the {\tt DwEntity}
//. object's string representation and sets {\tt aParent} as its tqparent.
//. The virtual member function {\tt Parse()} should be called immediately
//. after this constructor in order to parse the string representation.
//. Unless it is {\tt NULL}, {\tt aParent} should point to an object of
//. a class derived from {\tt DwBody}.
virtual ~DwEntity();
const DwEntity& operator = (const DwEntity& aEntity);
//. This is the assignment operator, which performs a deep copy of
//. {\tt aEntity}. The tqparent node of the {\tt DwEntity} object
//. is not changed.
virtual void Parse();
//. This virtual function, inherited from {\tt DwMessageComponent},
//. executes the parse method for {\tt DwEntity} objects. The parse
//. method creates or updates the broken-down representation from the
//. string representation. For {\tt DwEntity} objects, the parse
//. method parses the string representation and sets the values of
//. the {\tt DwHeaders} and {\tt DwBody} objects it tqcontains. This
//. member function also calls the {\tt Parse()} member functions
//. of the contained {\tt DwHeaders} and {\tt DwBody} objects.
//.
//. You should call this member function after you set or modify the
//. string representation, and before you access either the contained
//. headers or body.
//.
//. This function clears the is-modified flag.
virtual void Assemble(DwHeaders& aHeaders, DwBody& aBody);
// Assemble *without* first assembling the Header and the Body.
virtual void Assemble();
//. This virtual function, inherited from {\tt DwMessageComponent},
//. executes the assemble method for {\tt DwEntity} objects. The
//. assemble method creates or updates the string representation from
//. the broken-down representation. In more concrete terms, the
//. assemble method builds the string representation from the string
//. representations of the contained {\tt DwHeaders} and {\tt DwBody}
//. objects. This member function calls the {\tt Assemble()} member
//. functions of its {\tt DwHeaders} and {\tt DwBody} objects.
//.
//. You should call this member function after you modify either the
//. contained headers or body, and before you retrieve the string
//. representation.
//.
//. This function clears the is-modified flag.
bool hasHeaders() const { return 0 != mHeaders; }
DwHeaders& Headers() const;
//. This function returns the {\tt DwHeaders} object contained by
//. this object.
DwBody& Body() const;
//. This function returns the {\tt DwBody} object contained by this object.
int BodySize() const;
//. Get the size of the Body
void SetBodySize( int size ) { mBodySize = size; }
//. Explicitly set the size of the Body
//. This is needed if the body is empty but you know the size and others
//. should be able to access it
protected:
DwHeaders* mHeaders;
DwBody* mBody;
private:
static const char* const sClassName;
int mBodySize; // normally mBody->AsString().length()
public:
virtual void PrintDebugInfo(std::ostream& aStrm, int aDepth=0) const;
//. This virtual function, inherited from {\tt DwMessageComponent},
//. prints debugging information about this object to {\tt aStrm}.
//. It will also call {\tt PrintDebugInfo()} for any of its child
//. components down to a level of {\tt aDepth}.
//.
//. This member function is available only in the debug version of
//. the library.
virtual void CheckInvariants() const;
//. Aborts if one of the invariants of the object fails. Use this
//. member function to track down bugs.
//.
//. This member function is available only in the debug version of
//. the library.
protected:
void _PrintDebugInfo(std::ostream& aStrm) const;
};
#endif
|
