mirror of
https://github.com/Xahau/xahaud.git
synced 2025-12-06 17:27:52 +00:00
This introduces functions get and set, and a family of specialized structs called STExchange. These interfaces allow efficient and seamless interchange between serialized object fields and user defined types, especially variable length objects. A new base class template TypedField is mixed into existing SField declarations to encode information on the field, allowing template metaprograms to both customize interchange based on the type and detect misuse at compile-time. New types AnyPublicKey and AnySecretKey are introduced. These are intended to replace the corresponding functionality in the deprecated class RippleAddress. Specializations of STExchange for these types are provided to allow interchange. New free functions verify and sign allow signature verification and signature generation for serialized objects. * Add Buffer and Slice primitives * Add TypedField and modify some SField * Add STExchange and specializations for STBlob and STInteger * Improve STBlob and STInteger to support STExchange * Expose raw data in RippleAddress and Serializer
203 lines
4.7 KiB
C++
203 lines
4.7 KiB
C++
//------------------------------------------------------------------------------
|
|
/*
|
|
This file is part of rippled: https://github.com/ripple/rippled
|
|
Copyright (c) 2012, 2013 Ripple Labs Inc.
|
|
|
|
Permission to use, copy, modify, and/or distribute this software for any
|
|
purpose with or without fee is hereby granted, provided that the above
|
|
copyright notice and this permission notice appear in all copies.
|
|
|
|
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
|
|
WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
|
|
MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
|
|
ANY SPECIAL , DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
|
|
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
|
|
ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
|
|
OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
|
|
*/
|
|
//==============================================================================
|
|
|
|
#ifndef RIPPLE_PROTOCOL_STEXCHANGE_H_INCLUDED
|
|
#define RIPPLE_PROTOCOL_STEXCHANGE_H_INCLUDED
|
|
|
|
#include <ripple/basics/Buffer.h>
|
|
#include <ripple/basics/Slice.h>
|
|
#include <ripple/protocol/SField.h>
|
|
#include <ripple/protocol/STBlob.h>
|
|
#include <ripple/protocol/STInteger.h>
|
|
#include <ripple/protocol/STObject.h>
|
|
#include <ripple/basics/Blob.h>
|
|
#include <boost/optional.hpp>
|
|
#include <beast/cxx14/memory.h> // <memory>
|
|
#include <stdexcept>
|
|
#include <type_traits>
|
|
#include <utility>
|
|
|
|
namespace ripple {
|
|
|
|
/** Convert between serialized type U and C++ type T. */
|
|
template <class U, class T>
|
|
struct STExchange;
|
|
|
|
|
|
template <class U, class T>
|
|
struct STExchange<STInteger<U>, T>
|
|
{
|
|
using value_type = U;
|
|
|
|
static
|
|
void
|
|
get (boost::optional<T>& t,
|
|
STInteger<U> const& u)
|
|
{
|
|
t = u.getValue();
|
|
}
|
|
|
|
static
|
|
std::unique_ptr<STInteger<U>>
|
|
set (SField const& f, T const& t)
|
|
{
|
|
return std::make_unique<
|
|
STInteger<U>>(f, t);
|
|
}
|
|
};
|
|
|
|
template <>
|
|
struct STExchange<STBlob, Slice>
|
|
{
|
|
using value_type = Slice;
|
|
|
|
static
|
|
void
|
|
get (boost::optional<value_type>& t,
|
|
STBlob const& u)
|
|
{
|
|
t = boost::in_place(u.data(), u.size());
|
|
}
|
|
|
|
static
|
|
std::unique_ptr<STBlob>
|
|
set (TypedField<STBlob> const& f,
|
|
Slice const& t)
|
|
{
|
|
return std::make_unique<STBlob>(
|
|
f, t.data(), t.size());
|
|
}
|
|
};
|
|
|
|
template <>
|
|
struct STExchange<STBlob, Buffer>
|
|
{
|
|
using value_type = Buffer;
|
|
|
|
static
|
|
void
|
|
get (boost::optional<Buffer>& t,
|
|
STBlob const& u)
|
|
{
|
|
t = boost::in_place(
|
|
u.data(), u.size());
|
|
}
|
|
|
|
static
|
|
std::unique_ptr<STBlob>
|
|
set (TypedField<STBlob> const& f,
|
|
Buffer const& t)
|
|
{
|
|
return std::make_unique<STBlob>(
|
|
f, t.data(), t.size());
|
|
}
|
|
|
|
static
|
|
std::unique_ptr<STBlob>
|
|
set (TypedField<STBlob> const& f,
|
|
Buffer&& t)
|
|
{
|
|
return std::make_unique<STBlob>(
|
|
f, std::move(t));
|
|
}
|
|
};
|
|
|
|
//------------------------------------------------------------------------------
|
|
|
|
/** Return the value of a field in an STObject as a given type. */
|
|
/** @{ */
|
|
template <class T, class U>
|
|
boost::optional<T>
|
|
get (STObject const& st,
|
|
TypedField<U> const& f)
|
|
{
|
|
boost::optional<T> t;
|
|
STBase const* const b =
|
|
st.peekAtPField(f);
|
|
if (! b)
|
|
return t;
|
|
auto const id = b->getSType();
|
|
if (id == STI_NOTPRESENT)
|
|
return t;
|
|
auto const u =
|
|
dynamic_cast<U const*>(b);
|
|
// This should never happen
|
|
if (! u)
|
|
throw std::runtime_error (
|
|
"Wrong field type");
|
|
STExchange<U, T>::get(t, *u);
|
|
return t;
|
|
}
|
|
|
|
template <class U>
|
|
boost::optional<typename STExchange<
|
|
U, typename U::value_type>::value_type>
|
|
get (STObject const& st,
|
|
TypedField<U> const& f)
|
|
{
|
|
return get<typename U::value_type>(st, f);
|
|
}
|
|
/** @} */
|
|
|
|
/** Set a field value in an STObject. */
|
|
template <class U, class T>
|
|
void
|
|
set (STObject& st,
|
|
TypedField<U> const& f, T&& t)
|
|
{
|
|
st.set(STExchange<U,
|
|
typename std::decay<T>::type>::set(
|
|
f, std::forward<T>(t)));
|
|
}
|
|
|
|
/** Set a blob field using an init function. */
|
|
template <class Init>
|
|
void
|
|
set (STObject& st,
|
|
TypedField<STBlob> const& f,
|
|
std::size_t size, Init&& init)
|
|
{
|
|
st.set(std::make_unique<STBlob>(
|
|
f, size, init));
|
|
}
|
|
|
|
/** Set a blob field from data. */
|
|
template <class = void>
|
|
void
|
|
set (STObject& st,
|
|
TypedField<STBlob> const& f,
|
|
void const* data, std::size_t size)
|
|
{
|
|
st.set(std::make_unique<STBlob>(
|
|
f, data, size));
|
|
}
|
|
|
|
/** Remove a field in an STObject. */
|
|
template <class U>
|
|
void
|
|
erase (STObject& st,
|
|
TypedField<U> const& f)
|
|
{
|
|
st.makeFieldAbsent(f);
|
|
}
|
|
|
|
} // ripple
|
|
|
|
#endif
|