2013-07-10 02:45:36 +02:00
|
|
|
/*
|
|
|
|
* 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.
|
|
|
|
*/
|
|
|
|
|
2014-10-28 23:20:11 +01:00
|
|
|
#ifndef WEBRTC_P2P_BASE_PARSING_H_
|
|
|
|
#define WEBRTC_P2P_BASE_PARSING_H_
|
2013-07-10 02:45:36 +02:00
|
|
|
|
|
|
|
#include <string>
|
|
|
|
#include <vector>
|
2014-09-03 18:49:04 +02:00
|
|
|
#include "webrtc/libjingle/xmllite/xmlelement.h" // Needed to delete ParseError.extra.
|
2014-07-29 19:36:52 +02:00
|
|
|
#include "webrtc/base/basictypes.h"
|
|
|
|
#include "webrtc/base/stringencode.h"
|
2013-07-10 02:45:36 +02:00
|
|
|
|
|
|
|
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);
|
2014-07-29 19:36:52 +02:00
|
|
|
return rtc::FromString(unparsed, val_out);
|
2013-07-10 02:45:36 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
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;
|
2014-07-29 19:36:52 +02:00
|
|
|
if (!rtc::ToString(val, &buf)) {
|
2013-07-10 02:45:36 +02:00
|
|
|
return false;
|
|
|
|
}
|
|
|
|
elem->AddAttr(name, buf);
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
|
|
|
|
template <class T>
|
|
|
|
bool SetXmlBody(buzz::XmlElement* elem, const T& val) {
|
|
|
|
std::string buf;
|
2014-07-29 19:36:52 +02:00
|
|
|
if (!rtc::ToString(val, &buf)) {
|
2013-07-10 02:45:36 +02:00
|
|
|
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
|
|
|
|
|
2014-10-28 23:20:11 +01:00
|
|
|
#endif // WEBRTC_P2P_BASE_PARSING_H_
|