llsdutil.h
上传用户:king477883
上传日期:2021-03-01
资源大小:9553k
文件大小:6k
- /**
- * @file llsdutil.h
- * @author Phoenix
- * @date 2006-05-24
- * @brief Utility classes, functions, etc, for using structured data.
- *
- * $LicenseInfo:firstyear=2006&license=viewergpl$
- *
- * Copyright (c) 2006-2010, Linden Research, Inc.
- *
- * Second Life Viewer Source Code
- * The source code in this file ("Source Code") is provided by Linden Lab
- * to you under the terms of the GNU General Public License, version 2.0
- * ("GPL"), unless you have obtained a separate licensing agreement
- * ("Other License"), formally executed by you and Linden Lab. Terms of
- * the GPL can be found in doc/GPL-license.txt in this distribution, or
- * online at http://secondlifegrid.net/programs/open_source/licensing/gplv2
- *
- * There are special exceptions to the terms and conditions of the GPL as
- * it is applied to this Source Code. View the full text of the exception
- * in the file doc/FLOSS-exception.txt in this software distribution, or
- * online at
- * http://secondlifegrid.net/programs/open_source/licensing/flossexception
- *
- * By copying, modifying or distributing this software, you acknowledge
- * that you have read and understood your obligations described above,
- * and agree to abide by those obligations.
- *
- * ALL LINDEN LAB SOURCE CODE IS PROVIDED "AS IS." LINDEN LAB MAKES NO
- * WARRANTIES, EXPRESS, IMPLIED OR OTHERWISE, REGARDING ITS ACCURACY,
- * COMPLETENESS OR PERFORMANCE.
- * $/LicenseInfo$
- */
- #ifndef LL_LLSDUTIL_H
- #define LL_LLSDUTIL_H
- class LLSD;
- // U32
- LL_COMMON_API LLSD ll_sd_from_U32(const U32);
- LL_COMMON_API U32 ll_U32_from_sd(const LLSD& sd);
- // U64
- LL_COMMON_API LLSD ll_sd_from_U64(const U64);
- LL_COMMON_API U64 ll_U64_from_sd(const LLSD& sd);
- // IP Address
- LL_COMMON_API LLSD ll_sd_from_ipaddr(const U32);
- LL_COMMON_API U32 ll_ipaddr_from_sd(const LLSD& sd);
- // Binary to string
- LL_COMMON_API LLSD ll_string_from_binary(const LLSD& sd);
- //String to binary
- LL_COMMON_API LLSD ll_binary_from_string(const LLSD& sd);
- // Serializes sd to static buffer and returns pointer, useful for gdb debugging.
- LL_COMMON_API char* ll_print_sd(const LLSD& sd);
- // Serializes sd to static buffer and returns pointer, using "pretty printing" mode.
- LL_COMMON_API char* ll_pretty_print_sd_ptr(const LLSD* sd);
- LL_COMMON_API char* ll_pretty_print_sd(const LLSD& sd);
- //compares the structure of an LLSD to a template LLSD and stores the
- //"valid" values in a 3rd LLSD. Default values
- //are pulled from the template. Extra keys/values in the test
- //are ignored in the resultant LLSD. Ordering of arrays matters
- //Returns false if the test is of same type but values differ in type
- //Otherwise, returns true
- LL_COMMON_API BOOL compare_llsd_with_template(
- const LLSD& llsd_to_test,
- const LLSD& template_llsd,
- LLSD& resultant_llsd);
- /**
- * Recursively determine whether a given LLSD data block "matches" another
- * LLSD prototype. The returned string is empty() on success, non-empty() on
- * mismatch.
- *
- * This function tests structure (types) rather than data values. It is
- * intended for when a consumer expects an LLSD block with a particular
- * structure, and must succinctly detect whether the arriving block is
- * well-formed. For instance, a test of the form:
- * @code
- * if (! (data.has("request") && data.has("target") && data.has("modifier") ...))
- * @endcode
- * could instead be expressed by initializing a prototype LLSD map with the
- * required keys and writing:
- * @code
- * if (! llsd_matches(prototype, data).empty())
- * @endcode
- *
- * A non-empty return value is an error-message fragment intended to indicate
- * to (English-speaking) developers where in the prototype structure the
- * mismatch occurred.
- *
- * * If a slot in the prototype isUndefined(), then anything is valid at that
- * place in the real object. (Passing prototype == LLSD() matches anything
- * at all.)
- * * An array in the prototype must match a data array at least that large.
- * (Additional entries in the data array are ignored.) Every isDefined()
- * entry in the prototype array must match the corresponding entry in the
- * data array.
- * * A map in the prototype must match a map in the data. Every key in the
- * prototype map must match a corresponding key in the data map. (Additional
- * keys in the data map are ignored.) Every isDefined() value in the
- * prototype map must match the corresponding key's value in the data map.
- * * Scalar values in the prototype are tested for @em type rather than value.
- * For instance, a String in the prototype matches any String at all. In
- * effect, storing an Integer at a particular place in the prototype asserts
- * that the caller intends to apply asInteger() to the corresponding slot in
- * the data.
- * * A String in the prototype matches String, Boolean, Integer, Real, UUID,
- * Date and URI, because asString() applied to any of these produces a
- * meaningful result.
- * * Similarly, a Boolean, Integer or Real in the prototype can match any of
- * Boolean, Integer or Real in the data -- or even String.
- * * UUID matches UUID or String.
- * * Date matches Date or String.
- * * URI matches URI or String.
- * * Binary in the prototype matches only Binary in the data.
- *
- * @TODO: when a Boolean, Integer or Real in the prototype matches a String in
- * the data, we should examine the String @em value to ensure it can be
- * meaningfully converted to the requested type. The same goes for UUID, Date
- * and URI.
- */
- LL_COMMON_API std::string llsd_matches(const LLSD& prototype, const LLSD& data, const std::string& pfx="");
- /// Deep equality
- LL_COMMON_API bool llsd_equals(const LLSD& lhs, const LLSD& rhs);
- // Simple function to copy data out of input & output iterators if
- // there is no need for casting.
- template<typename Input> LLSD llsd_copy_array(Input iter, Input end)
- {
- LLSD dest;
- for (; iter != end; ++iter)
- {
- dest.append(*iter);
- }
- return dest;
- }
- #endif // LL_LLSDUTIL_H