Print done when done.

1 files changed, 592 insertions, 0 deletions

diff --git a/indra/llcommon/llsdserialize.h b/indra/llcommon/llsdserialize.h
new file mode 100644
index 0000000000..bc6817c732
--- /dev/null
+++ b/indra/llcommon/llsdserialize.h
@@ -0,0 +1,592 @@
+/** 
+ * @file llsdserialize.h
+ * @author Phoenix
+ * @date 2006-02-26
+ * @brief Declaration of parsers and formatters for LLSD
+ *
+ * Copyright (c) 2006-$CurrentYear$, Linden Research, Inc.
+ * $License$
+ */
+
+#ifndef LL_LLSDSERIALIZE_H
+#define LL_LLSDSERIALIZE_H
+
+#include <iosfwd>
+#include "llsd.h"
+#include "llmemory.h"
+
+/** 
+ * @class LLSDParser
+ * @brief Abstract base class for simple LLSD parsers.
+ */
+class LLSDParser : public LLRefCount
+{
+protected:
+	/** 
+	 * @brief Destructor
+	 */
+	virtual ~LLSDParser();
+
+public:
+	/** 
+	 * @brief Constructor
+	 */
+	LLSDParser();
+
+	/** 
+	 * @brief Call this method to parse a stream for LLSD.
+	 *
+	 * This method parses the istream for a structured data. This
+	 * method assumes that the istream is a complete llsd object --
+	 * for example an opened and closed map with an arbitrary nesting
+	 * of elements. This method will return after reading one data
+	 * object, allowing continued reading from the stream by the
+	 * caller.
+	 * @param istr The input stream.
+	 * @param data[out] The newly parse structured data.
+	 * @return Returns The number of LLSD objects parsed into data.
+	 */
+	virtual S32 parse(std::istream& istr, LLSD& data) const = 0;
+
+protected:
+
+};
+
+/** 
+ * @class LLSDNotationParser
+ * @brief Parser which handles the original notation format for LLSD.
+ */
+class LLSDNotationParser : public LLSDParser
+{
+protected:
+	/** 
+	 * @brief Destructor
+	 */
+	virtual ~LLSDNotationParser();
+
+public:
+	/** 
+	 * @brief Constructor
+	 */
+	LLSDNotationParser() {}
+
+	/** 
+	 * @brief Call this method to parse a stream for LLSD.
+	 *
+	 * This method parses the istream for a structured data. This
+	 * method assumes that the istream is a complete llsd object --
+	 * for example an opened and closed map with an arbitrary nesting
+	 * of elements. This method will return after reading one data
+	 * object, allowing continued reading from the stream by the
+	 * caller.
+	 * @param istr The input stream.
+	 * @param data[out] The newly parse structured data. Undefined on failure.
+	 * @return Returns the number of LLSD objects parsed into
+	 * data. Returns -1 on parse failure.
+	 */
+	virtual S32 parse(std::istream& istr, LLSD& data) const;
+
+	/** 
+	 * @brief Simple notation parse.
+	 *
+	 * This simplified parser cannot not distinguish between a failed
+	 * parse and a parse which yields a single undefined LLSD. You can
+	 * use this if error checking will be implicit in the use of the
+	 * results of the parse.
+	 * @param istr The input stream.
+	 * @return Returns the parsed LLSD object.
+	 */
+	static LLSD parse(std::istream& istr);
+
+private:
+	/** 
+	 * @brief Parse a map from the istream
+	 *
+	 * @param istr The input stream.
+	 * @param map The map to add the parsed data.
+	 * @return Returns The number of LLSD objects parsed into data.
+	 */
+	S32 parseMap(std::istream& istr, LLSD& map) const;
+
+	/** 
+	 * @brief Parse an array from the istream.
+	 *
+	 * @param istr The input stream.
+	 * @param array The array to append the parsed data.
+	 * @return Returns The number of LLSD objects parsed into data.
+	 */
+	S32 parseArray(std::istream& istr, LLSD& array) const;
+
+	/** 
+	 * @brief Parse a string from the istream and assign it to data.
+	 *
+	 * @param istr The input stream.
+	 * @param data[out] The data to assign.
+	 */
+	void parseString(std::istream& istr, LLSD& data) const;
+
+	/** 
+	 * @brief Parse binary data from the stream.
+	 *
+	 * @param istr The input stream.
+	 * @param data[out] The data to assign.
+	 */
+	void parseBinary(std::istream& istr, LLSD& data) const;
+};
+
+/** 
+ * @class LLSDXMLParser
+ * @brief Parser which handles XML format LLSD.
+ */
+class LLSDXMLParser : public LLSDParser
+{
+protected:
+	/** 
+	 * @brief Destructor
+	 */
+	virtual ~LLSDXMLParser();
+
+public:
+	/** 
+	 * @brief Constructor
+	 */
+	LLSDXMLParser();
+
+	/** 
+	 * @brief Call this method to parse a stream for LLSD.
+	 *
+	 * This method parses the istream for a structured data. This
+	 * method assumes that the istream is a complete llsd object --
+	 * for example an opened and closed map with an arbitrary nesting
+	 * of elements. This method will return after reading one data
+	 * object, allowing continued reading from the stream by the
+	 * caller.
+	 * @param istr The input stream.
+	 * @param data[out] The newly parse structured data.
+	 * @return Returns the number of LLSD objects parsed into data.
+	 */
+	virtual S32 parse(std::istream& istr, LLSD& data) const;
+
+private:
+	class Impl;
+	Impl& impl;
+
+	void parsePart(const char *buf, int len);
+	friend class LLSDSerialize;
+};
+
+/** 
+ * @class LLSDBinaryParser
+ * @brief Parser which handles binary formatted LLSD.
+ */
+class LLSDBinaryParser : public LLSDParser
+{
+protected:
+	/** 
+	 * @brief Destructor
+	 */
+	virtual ~LLSDBinaryParser();
+
+public:
+	/** 
+	 * @brief Constructor
+	 */
+	LLSDBinaryParser();
+
+	/** 
+	 * @brief Call this method to parse a stream for LLSD.
+	 *
+	 * This method parses the istream for a structured data. This
+	 * method assumes that the istream is a complete llsd object --
+	 * for example an opened and closed map with an arbitrary nesting
+	 * of elements. This method will return after reading one data
+	 * object, allowing continued reading from the stream by the
+	 * caller.
+	 * @param istr The input stream.
+	 * @param data[out] The newly parse structured data.
+	 * @return Returns the number of LLSD objects parsed into data.
+	 */
+	virtual S32 parse(std::istream& istr, LLSD& data) const;
+
+	/** 
+	 * @brief Simple notation parse.
+	 *
+	 * This simplified parser cannot not distinguish between a failed
+	 * parse and a parse which yields a single undefined LLSD. You can
+	 * use this if error checking will be implicit in the use of the
+	 * results of the parse.
+	 * @param istr The input stream.
+	 * @return Returns the parsed LLSD object.
+	 */
+	static LLSD parse(std::istream& istr);
+
+private:
+	/** 
+	 * @brief Parse a map from the istream
+	 *
+	 * @param istr The input stream.
+	 * @param map The map to add the parsed data.
+	 * @return Returns The number of LLSD objects parsed into data.
+	 */
+	S32 parseMap(std::istream& istr, LLSD& map) const;
+
+	/** 
+	 * @brief Parse an array from the istream.
+	 *
+	 * @param istr The input stream.
+	 * @param array The array to append the parsed data.
+	 * @return Returns The number of LLSD objects parsed into data.
+	 */
+	S32 parseArray(std::istream& istr, LLSD& array) const;
+
+	/** 
+	 * @brief Parse a string from the istream and assign it to data.
+	 *
+	 * @param istr The input stream.
+	 * @param value[out] The string to assign.
+	 */
+	void parseString(std::istream& istr, std::string& value) const;
+};
+
+
+/** 
+ * @class LLSDFormatter
+ * @brief Abstract base class for formatting LLSD.
+ */
+class LLSDFormatter : public LLRefCount
+{
+protected:
+	/** 
+	 * @brief Destructor
+	 */
+	virtual ~LLSDFormatter();
+
+public:
+	/**
+	 * Options for output
+	 */
+	enum e_formatter_options_type
+	{
+		OPTIONS_NONE = 0,
+		OPTIONS_PRETTY = 1
+	} EFormatterOptions;
+
+	/** 
+	 * @brief Constructor
+	 */
+	LLSDFormatter();
+
+	/** 
+	 * @brief Set the boolean serialization format.
+	 *
+	 * @param alpha Serializes boolean as alpha if true.
+	 */
+	void boolalpha(bool alpha);
+
+	/** 
+	 * @brief Set the real format
+	 *
+	 * By default, the formatter will use default double serialization
+	 * which is frequently frustrating for many applications. You can
+	 * set the precision on the stream independently, but that still
+	 * might not work depending on the value.
+	 * EXAMPLES:<br>
+	 * %.2f<br>
+	 * @param format A format string which follows the printf format
+	 * rules. Specify an empty string to return to default formatting.
+	 */
+	void realFormat(const std::string& format);
+
+	/** 
+	 * @brief Call this method to format an LLSD to a stream.
+	 *
+	 * @param data The data to write.
+	 * @param ostr The destination stream for the data.
+	 * @return Returns The number of LLSD objects fomatted out
+	 */
+	virtual S32 format(const LLSD& data, std::ostream& ostr, U32 options = LLSDFormatter::OPTIONS_NONE) const = 0;
+
+protected:
+	/** 
+	 * @brief Helper method which appropriately obeys the real format.
+	 *
+	 * @param real The real value to format.
+	 * @param ostr The destination stream for the data.
+	 */
+	void formatReal(LLSD::Real real, std::ostream& ostr) const;
+
+protected:
+	bool mBoolAlpha;
+	std::string mRealFormat;
+};
+
+
+/** 
+ * @class LLSDNotationFormatter
+ * @brief Formatter which outputs the original notation format for LLSD.
+ */
+class LLSDNotationFormatter : public LLSDFormatter
+{
+protected:
+	/** 
+	 * @brief Destructor
+	 */
+	virtual ~LLSDNotationFormatter();
+
+public:
+	/** 
+	 * @brief Constructor
+	 */
+	LLSDNotationFormatter();
+
+	/** 
+	 * @brief Helper static method to return a notation escaped string
+	 *
+	 * This method will return the notation escaped string, but not
+	 * the surrounding serialization identifiers such as a double or
+	 * single quote. It will be up to the caller to embed those as
+	 * appropriate.
+	 * @param in The raw, unescaped string.
+	 * @return Returns an escaped string appropriate for serialization.
+	 */
+	static std::string escapeString(const std::string& in);
+
+	/** 
+	 * @brief Call this method to format an LLSD to a stream.
+	 *
+	 * @param data The data to write.
+	 * @param ostr The destination stream for the data.
+	 * @return Returns The number of LLSD objects fomatted out
+	 */
+	virtual S32 format(const LLSD& data, std::ostream& ostr, U32 options = LLSDFormatter::OPTIONS_NONE) const;
+};
+
+
+/** 
+ * @class LLSDXMLFormatter
+ * @brief Formatter which outputs the LLSD as XML.
+ */
+class LLSDXMLFormatter : public LLSDFormatter
+{
+protected:
+	/** 
+	 * @brief Destructor
+	 */
+	virtual ~LLSDXMLFormatter();
+
+public:
+	/** 
+	 * @brief Constructor
+	 */
+	LLSDXMLFormatter();
+
+	/** 
+	 * @brief Helper static method to return an xml escaped string
+	 *
+	 * @param in A valid UTF-8 string.
+	 * @return Returns an escaped string appropriate for serialization.
+	 */
+	static std::string escapeString(const std::string& in);
+
+	/** 
+	 * @brief Call this method to format an LLSD to a stream.
+	 *
+	 * @param data The data to write.
+	 * @param ostr The destination stream for the data.
+	 * @return Returns The number of LLSD objects fomatted out
+	 */
+	virtual S32 format(const LLSD& data, std::ostream& ostr, U32 options = LLSDFormatter::OPTIONS_NONE) const;
+
+protected:
+
+	/** 
+	 * @brief Implementation to format the data. This is called recursively.
+	 *
+	 * @param data The data to write.
+	 * @param ostr The destination stream for the data.
+	 * @return Returns The number of LLSD objects fomatted out
+	 */
+	S32 format_impl(const LLSD& data, std::ostream& ostr, U32 options, U32 level) const;
+};
+
+
+/** 
+ * @class LLSDBinaryFormatter
+ * @brief Formatter which outputs the LLSD as a binary notation format.
+ *
+ * The binary format is a compact and efficient representation of
+ * structured data useful for when transmitting over a small data pipe
+ * or when transmission frequency is very high.<br>
+ *
+ * The normal boolalpha and real format commands are ignored.<br>
+ *
+ * All integers are transmitted in network byte order. The format is:<br>
+ * Undefined: '!'<br>
+ * Boolean: character '1' for true character '0' for false<br>
+ * Integer: 'i' + 4 bytes network byte order<br>
+ * Real: 'r' + 8 bytes IEEE double<br>
+ * UUID: 'u' + 16 byte unsigned integer<br>
+ * String: 's' + 4 byte integer size + string<br>
+ * Date: 'd' + 8 byte IEEE double for seconds since epoch<br>
+ * URI: 'l' + 4 byte integer size + string uri<br>
+ * Binary: 'b' + 4 byte integer size + binary data<br>
+ * Array: '[' + 4 byte integer size  + all values + ']'<br>
+ * Map: '{' + 4 byte integer size  every(key + value) + '}'<br>
+ *  map keys are serialized as 'k' + 4 byte integer size + string
+ */
+class LLSDBinaryFormatter : public LLSDFormatter
+{
+protected:
+	/** 
+	 * @brief Destructor
+	 */
+	virtual ~LLSDBinaryFormatter();
+
+public:
+	/** 
+	 * @brief Constructor
+	 */
+	LLSDBinaryFormatter();
+
+	/** 
+	 * @brief Call this method to format an LLSD to a stream.
+	 *
+	 * @param data The data to write.
+	 * @param ostr The destination stream for the data.
+	 * @return Returns The number of LLSD objects fomatted out
+	 */
+	virtual S32 format(const LLSD& data, std::ostream& ostr, U32 options = LLSDFormatter::OPTIONS_NONE) const;
+
+protected:
+	/** 
+	 * @brief Helper method to serialize strings
+	 *
+	 * This method serializes a network byte order size and the raw
+	 * string contents.
+	 * @param string The string to write.
+	 * @param ostr The destination stream for the data.
+	 */
+	void formatString(const std::string& string, std::ostream& ostr) const;
+};
+
+
+/** 
+ * @class LLSDNotationStreamFormatter
+ * @brief Formatter which is specialized for use on streams which
+ * outputs the original notation format for LLSD.
+ *
+ * This class is useful for doing inline stream operations. For example:
+ *
+ * <code>
+ *  LLSD sd;<br>
+ *  sd["foo"] = "bar";<br>
+ *  std::stringstream params;<br>
+ *	params << "[{'version':i1}," << LLSDOStreamer<LLSDNotationFormatter>(sd)
+ *    << "]";
+ *  </code>
+ */
+template <class Formatter>
+class LLSDOStreamer : public Formatter
+{
+public:
+	/** 
+	 * @brief Constructor
+	 */
+	LLSDOStreamer(const LLSD& data, U32 options = LLSDFormatter::OPTIONS_NONE) :
+		mSD(data), mOptions(options) {}
+
+	/**
+	 * @brief Stream operator.
+	 *
+	 * Use this inline during construction during a stream operation.
+	 * @param str The destination stream for serialized output.
+	 * @param The formatter which will output it's LLSD.
+	 * @return Returns the stream passed in after streaming mSD.
+	 */
+	friend std::ostream& operator<<(
+		std::ostream& str,
+		const LLSDOStreamer<Formatter>& formatter)
+	{
+		formatter.format(formatter.mSD, str, formatter.mOptions);
+		return str;
+	}
+
+protected:
+	LLSD mSD;
+	U32 mOptions;
+};
+
+typedef LLSDOStreamer<LLSDNotationFormatter>	LLSDNotationStreamer;
+typedef LLSDOStreamer<LLSDXMLFormatter>			LLSDXMLStreamer;
+
+/** 
+ * @class LLSDSerialize
+ * @Serializer / deserializer for the various LLSD formats
+ */
+class LLSDSerialize
+{
+public:
+	enum ELLSD_Serialize
+	{
+		LLSD_BINARY, LLSD_XML
+	};
+
+	/*
+	 * Generic in/outs
+	 */
+	static void serialize(const LLSD& sd, std::ostream& str, ELLSD_Serialize,
+		U32 options = LLSDFormatter::OPTIONS_NONE);
+	static bool deserialize(LLSD& sd, std::istream& str);
+
+	/*
+	 * Notation Methods
+	 */
+	static S32 toNotation(const LLSD& sd, std::ostream& str)
+	{
+		LLPointer<LLSDNotationFormatter> f = new LLSDNotationFormatter;
+		return f->format(sd, str, LLSDFormatter::OPTIONS_NONE);
+	}
+	static S32 fromNotation(LLSD& sd, std::istream& str)
+	{
+		LLPointer<LLSDNotationParser> p = new LLSDNotationParser;
+		return p->parse(str, sd);
+	}
+	
+	/*
+	 * XML Methods
+	 */
+	static S32 toXML(const LLSD& sd, std::ostream& str)
+	{
+		LLPointer<LLSDXMLFormatter> f = new LLSDXMLFormatter;
+		return f->format(sd, str, LLSDFormatter::OPTIONS_NONE);
+	}
+	static S32 toPrettyXML(const LLSD& sd, std::ostream& str)
+	{
+		LLPointer<LLSDXMLFormatter> f = new LLSDXMLFormatter;
+		return f->format(sd, str, LLSDFormatter::OPTIONS_PRETTY);
+	}
+	static S32 fromXML(LLSD& sd, std::istream& str)
+	{
+		LLPointer<LLSDXMLParser> p = new LLSDXMLParser;
+		return p->parse(str, sd);
+	}
+
+	/*
+	 * Binary Methods
+	 */
+	static S32 toBinary(const LLSD& sd, std::ostream& str)
+	{
+		LLPointer<LLSDBinaryFormatter> f = new LLSDBinaryFormatter;
+		return f->format(sd, str, LLSDFormatter::OPTIONS_NONE);
+	}
+	static S32 fromBinary(LLSD& sd, std::istream& str)
+	{
+		LLPointer<LLSDBinaryParser> p = new LLSDBinaryParser;
+		return p->parse(str, sd);
+	}
+private:
+	static const char *LLSDBinaryHeader;
+	static const char *LLSDXMLHeader;
+};
+
+#endif // LL_LLSDSERIALIZE_H