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
|
/*
* libjingle
* Copyright 2010, Google Inc.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
* 3. The name of the author may not be used to endorse or promote products
* derived from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
* MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
* EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
* OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
* WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
* OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
* ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#ifndef TALK_P2P_BASE_PARSING_H_
#define TALK_P2P_BASE_PARSING_H_
#include <string>
#include <vector>
#include "talk/base/basictypes.h"
#include "talk/base/stringencode.h"
#include "talk/xmllite/xmlelement.h" // Needed to delete ParseError.extra.
namespace cricket {
typedef std::vector<buzz::XmlElement*> XmlElements;
// We decided "bool Parse(in, out*, error*)" is generally the best
// parse signature. "out Parse(in)" doesn't allow for errors.
// "error* Parse(in, out*)" doesn't allow flexible memory management.
// The error type for parsing.
struct ParseError {
public:
// explains the error
std::string text;
// provide details about what wasn't parsable
const buzz::XmlElement* extra;
ParseError() : extra(NULL) {}
~ParseError() {
delete extra;
}
void SetText(const std::string& text) {
this->text = text;
}
};
// The error type for writing.
struct WriteError {
std::string text;
void SetText(const std::string& text) {
this->text = text;
}
};
// Convenience method for returning a message when parsing fails.
bool BadParse(const std::string& text, ParseError* err);
// Convenience method for returning a message when writing fails.
bool BadWrite(const std::string& text, WriteError* error);
// helper XML functions
std::string GetXmlAttr(const buzz::XmlElement* elem,
const buzz::QName& name,
const std::string& def);
std::string GetXmlAttr(const buzz::XmlElement* elem,
const buzz::QName& name,
const char* def);
// Return true if the value is "true" or "1".
bool GetXmlAttr(const buzz::XmlElement* elem,
const buzz::QName& name, bool def);
int GetXmlAttr(const buzz::XmlElement* elem,
const buzz::QName& name, int def);
template <class T>
bool GetXmlAttr(const buzz::XmlElement* elem,
const buzz::QName& name,
T* val_out) {
if (!elem->HasAttr(name)) {
return false;
}
std::string unparsed = elem->Attr(name);
return talk_base::FromString(unparsed, val_out);
}
template <class T>
bool GetXmlAttr(const buzz::XmlElement* elem,
const buzz::QName& name,
const T& def,
T* val_out) {
if (!elem->HasAttr(name)) {
*val_out = def;
return true;
}
return GetXmlAttr(elem, name, val_out);
}
template <class T>
bool AddXmlAttr(buzz::XmlElement* elem,
const buzz::QName& name, const T& val) {
std::string buf;
if (!talk_base::ToString(val, &buf)) {
return false;
}
elem->AddAttr(name, buf);
return true;
}
template <class T>
bool SetXmlBody(buzz::XmlElement* elem, const T& val) {
std::string buf;
if (!talk_base::ToString(val, &buf)) {
return false;
}
elem->SetBodyText(buf);
return true;
}
const buzz::XmlElement* GetXmlChild(const buzz::XmlElement* parent,
const std::string& name);
bool RequireXmlChild(const buzz::XmlElement* parent,
const std::string& name,
const buzz::XmlElement** child,
ParseError* error);
bool RequireXmlAttr(const buzz::XmlElement* elem,
const buzz::QName& name,
std::string* value,
ParseError* error);
void AddXmlAttrIfNonEmpty(buzz::XmlElement* elem,
const buzz::QName name,
const std::string& value);
void AddXmlChildren(buzz::XmlElement* parent,
const std::vector<buzz::XmlElement*>& children);
void CopyXmlChildren(const buzz::XmlElement* source, buzz::XmlElement* dest);
std::vector<buzz::XmlElement*> CopyOfXmlChildren(const buzz::XmlElement* elem);
} // namespace cricket
#endif // TALK_P2P_BASE_PARSING_H_
|
