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
|
//=============================================================================
// File: group.h
// Contents: Declarations for DwGroup
// 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_GROUP_H
#define DW_GROUP_H
#ifndef DW_CONFIG_H
#include <mimelib/config.h>
#endif
#ifndef DW_STRING_H
#include <mimelib/string.h>
#endif
#ifndef DW_MAILBOX_H
#include <mimelib/mailbox.h>
#endif
#ifndef DW_MBOXLIST_H
#include <mimelib/mboxlist.h>
#endif
#ifndef DW_ADDRESS_H
#include <mimelib/address.h>
#endif
//=============================================================================
//+ Name DwGroup -- Class representing an RFC-822 address group
//+ Description
//. {\tt DwGroup} represents a {\it group} as described in RFC-822. A group
//. contains a group name and a (possibly empty) list of {\it mailboxes}.
//. In MIME++, a {\tt DwGroup} object contains a string for the group name
//. and a {\tt DwMailboxList} object for the list of mailboxes.
//.
//. In the tree (broken-down) representation of message, a {\tt DwGroup}
//. object may be only an intermediate node, having both a tqparent and a single
//. child node. Its tqparent node must be a {\tt DwField} or a
//. {\tt DwAddressList}. Its child is a {\tt DwMailboxList}.
//.
//. A {\tt DwGroup} is a {\tt DwAddress}, and therefore it can be included
//. in a list of {\tt DwAddress} objects. To get the next {\tt DwAddress}
//. object in a list, use the inherited member function
//. {\tt DwAddress::Next()}.
//=============================================================================
// Last updated 1997-08-24
//+ Noentry ~DwGroup _PrintDebugInfo
class DW_EXPORT DwGroup : public DwAddress {
public:
DwGroup();
DwGroup(const DwGroup& aGroup);
DwGroup(const DwString& aStr, DwMessageComponent* aParent=0);
//. The first constructor is the default constructor, which sets the
//. {\tt DwGroup} 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 aGroup}.
//. The tqparent of the new {\tt DwGroup} object is set to {\tt NULL}.
//.
//. The third constructor copies {\tt aStr} to the {\tt DwGroup}
//. 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 DwField} or {\tt DwAddressList}.
virtual ~DwGroup();
const DwGroup& operator = (const DwGroup& aGroup);
//. This is the assignment operator, which performs a deep copy of
//. {\tt aGroup}. The tqparent node of the {\tt DwGroup} object
//. is not changed.
virtual void Parse();
//. This virtual function, inherited from {\tt DwMessageComponent},
//. executes the parse method for {\tt DwGroup} objects. The parse
//. method creates or updates the broken-down representation from the
//. string representation. For {\tt DwGroup} objects, the parse method
//. parses the string representation to extract the group name and to
//. create a {\tt DwMailboxList} object from the list of mailboxes. This
//. member function also calls the {\tt Parse()} member function of
//. the {\tt DwMailboxList} object it creates.
//.
//. You should call this member function after you set or modify the
//. string representation, and before you access the group name or the
//. mailbox list.
//.
//. This function clears the is-modified flag.
virtual void Assemble();
//. This virtual function, inherited from {\tt DwMessageComponent},
//. executes the assemble method for {\tt DwGroup} objects. The
//. assemble method creates or updates the string representation from
//. the broken-down representation. That is, the assemble method
//. builds the string representation from its group name and mailbox
//. list. Before it builds the string representation, this function
//. calls the {\tt Assemble()} member function of its contained
//. {\tt DwMailboxList} object.
//.
//. You should call this member function after you set or modify either
//. the group name or the contained {\tt DwMailboxList} object, and
//. before you retrieve the string representation.
//.
//. This function clears the is-modified flag.
virtual DwMessageComponent* Clone() const;
//. This virtual function, inherited from {\tt DwMessageComponent},
//. creates a new {\tt DwGroup} on the free store that has the same
//. value as this {\tt DwGroup} object. The basic idea is that of
//. a virtual copy constructor.
const DwString& GroupName() const;
//. Returns the name of the group.
const DwString& Phrase() const;
//. Returns the name of the phrase part of a group as described in
//. RFC-822. The phrase is the same as the group name.
void SetGroupName(const DwString& aName);
//. Sets the name of the group.
void SetPhrase(const DwString& aPhrase);
//. Sets the name of the phrase part of a group as described in RFC-822.
//. The phrase is the same as the group name.
DwMailboxList& MailboxList() const;
//. Provides access to the list of mailboxes that is part of a group as
//. described in RFC-822.
static DwGroup* NewGroup(const DwString& aStr,
DwMessageComponent* aParent);
//. Creates a new {\tt DwGroup} object on the free store.
//. If the static data member {\tt sNewGroup} is {\tt NULL},
//. this member function will create a new {\tt DwGroup}
//. and return it. Otherwise, {\tt NewGroup()} will call
//. the user-supplied function pointed to by {\tt sNewGroup},
//. which is assumed to return an object from a class derived from
//. {\tt DwGroup}, and return that object.
//+ Var sNewGroup
static DwGroup* (*sNewGroup)(const DwString&, DwMessageComponent*);
//. If {\tt sNewGroup} is not {\tt NULL}, it is assumed to point to a
//. user-supplied function that returns an object from a class derived from
//. {\tt DwGroup}.
protected:
DwMailboxList* mMailboxList;
//. Points to the {\tt DwMailboxList} object.
private:
DwString mGroupName;
static const char* const sClassName;
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
|
