cannam@49: // Copyright (c) 2013-2014 Sandstorm Development Group, Inc. and contributors cannam@49: // Licensed under the MIT License: cannam@49: // cannam@49: // Permission is hereby granted, free of charge, to any person obtaining a copy cannam@49: // of this software and associated documentation files (the "Software"), to deal cannam@49: // in the Software without restriction, including without limitation the rights cannam@49: // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell cannam@49: // copies of the Software, and to permit persons to whom the Software is cannam@49: // furnished to do so, subject to the following conditions: cannam@49: // cannam@49: // The above copyright notice and this permission notice shall be included in cannam@49: // all copies or substantial portions of the Software. cannam@49: // cannam@49: // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR cannam@49: // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, cannam@49: // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE cannam@49: // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER cannam@49: // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, cannam@49: // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN cannam@49: // THE SOFTWARE. cannam@49: cannam@49: // This file defines classes that can be used to manipulate messages based on schemas that are not cannam@49: // known until runtime. This is also useful for writing generic code that uses schemas to handle cannam@49: // arbitrary types in a generic way. cannam@49: // cannam@49: // Each of the classes defined here has a to() template method which converts an instance back to a cannam@49: // native type. This method will throw an exception if the requested type does not match the cannam@49: // schema. To convert native types to dynamic, use DynamicFactory. cannam@49: // cannam@49: // As always, underlying data is validated lazily, so you have to actually traverse the whole cannam@49: // message if you want to validate all content. cannam@49: cannam@49: #ifndef CAPNP_DYNAMIC_H_ cannam@49: #define CAPNP_DYNAMIC_H_ cannam@49: cannam@49: #if defined(__GNUC__) && !defined(CAPNP_HEADER_WARNINGS) cannam@49: #pragma GCC system_header cannam@49: #endif cannam@49: cannam@49: #include "schema.h" cannam@49: #include "layout.h" cannam@49: #include "message.h" cannam@49: #include "any.h" cannam@49: #include "capability.h" cannam@49: cannam@49: namespace capnp { cannam@49: cannam@49: class MessageReader; cannam@49: class MessageBuilder; cannam@49: cannam@49: struct DynamicValue { cannam@49: DynamicValue() = delete; cannam@49: cannam@49: enum Type { cannam@49: UNKNOWN, cannam@49: // Means that the value has unknown type and content because it comes from a newer version of cannam@49: // the schema, or from a newer version of Cap'n Proto that has new features that this version cannam@49: // doesn't understand. cannam@49: cannam@49: VOID, cannam@49: BOOL, cannam@49: INT, cannam@49: UINT, cannam@49: FLOAT, cannam@49: TEXT, cannam@49: DATA, cannam@49: LIST, cannam@49: ENUM, cannam@49: STRUCT, cannam@49: CAPABILITY, cannam@49: ANY_POINTER cannam@49: }; cannam@49: cannam@49: class Reader; cannam@49: class Builder; cannam@49: class Pipeline; cannam@49: }; cannam@49: class DynamicEnum; cannam@49: struct DynamicStruct { cannam@49: DynamicStruct() = delete; cannam@49: class Reader; cannam@49: class Builder; cannam@49: class Pipeline; cannam@49: }; cannam@49: struct DynamicList { cannam@49: DynamicList() = delete; cannam@49: class Reader; cannam@49: class Builder; cannam@49: }; cannam@49: struct DynamicCapability { cannam@49: DynamicCapability() = delete; cannam@49: class Client; cannam@49: class Server; cannam@49: }; cannam@49: template <> class Orphan; cannam@49: cannam@49: template struct DynamicTypeFor_; cannam@49: template <> struct DynamicTypeFor_ { typedef DynamicEnum Type; }; cannam@49: template <> struct DynamicTypeFor_ { typedef DynamicStruct Type; }; cannam@49: template <> struct DynamicTypeFor_ { typedef DynamicList Type; }; cannam@49: template <> struct DynamicTypeFor_ { typedef DynamicCapability Type; }; cannam@49: cannam@49: template cannam@49: using DynamicTypeFor = typename DynamicTypeFor_()>::Type; cannam@49: cannam@49: template cannam@49: ReaderFor>> toDynamic(T&& value); cannam@49: template cannam@49: BuilderFor>> toDynamic(T&& value); cannam@49: template cannam@49: DynamicTypeFor> toDynamic(T&& value); cannam@49: template cannam@49: typename DynamicTypeFor>::Client toDynamic(kj::Own&& value); cannam@49: cannam@49: namespace _ { // private cannam@49: cannam@49: template <> struct Kind_ { static constexpr Kind kind = Kind::OTHER; }; cannam@49: template <> struct Kind_ { static constexpr Kind kind = Kind::OTHER; }; cannam@49: template <> struct Kind_ { static constexpr Kind kind = Kind::OTHER; }; cannam@49: template <> struct Kind_ { static constexpr Kind kind = Kind::OTHER; }; cannam@49: template <> struct Kind_ { static constexpr Kind kind = Kind::OTHER; }; cannam@49: cannam@49: } // namespace _ (private) cannam@49: cannam@49: template <> inline constexpr Style style() { return Style::POINTER; } cannam@49: template <> inline constexpr Style style() { return Style::PRIMITIVE; } cannam@49: template <> inline constexpr Style style() { return Style::STRUCT; } cannam@49: template <> inline constexpr Style style() { return Style::POINTER; } cannam@49: template <> inline constexpr Style style() { return Style::CAPABILITY; } cannam@49: cannam@49: // ------------------------------------------------------------------- cannam@49: cannam@49: class DynamicEnum { cannam@49: public: cannam@49: DynamicEnum() = default; cannam@49: inline DynamicEnum(EnumSchema::Enumerant enumerant) cannam@49: : schema(enumerant.getContainingEnum()), value(enumerant.getOrdinal()) {} cannam@49: inline DynamicEnum(EnumSchema schema, uint16_t value) cannam@49: : schema(schema), value(value) {} cannam@49: cannam@49: template () == Kind::ENUM>> cannam@49: inline DynamicEnum(T&& value): DynamicEnum(toDynamic(value)) {} cannam@49: cannam@49: template cannam@49: inline T as() const { return static_cast(asImpl(typeId())); } cannam@49: // Cast to a native enum type. cannam@49: cannam@49: inline EnumSchema getSchema() const { return schema; } cannam@49: cannam@49: kj::Maybe getEnumerant() const; cannam@49: // Get which enumerant this enum value represents. Returns nullptr if the numeric value does not cannam@49: // correspond to any enumerant in the schema -- this can happen if the data was built using a cannam@49: // newer schema that has more values defined. cannam@49: cannam@49: inline uint16_t getRaw() const { return value; } cannam@49: // Returns the raw underlying enum value. cannam@49: cannam@49: private: cannam@49: EnumSchema schema; cannam@49: uint16_t value; cannam@49: cannam@49: uint16_t asImpl(uint64_t requestedTypeId) const; cannam@49: cannam@49: friend struct DynamicStruct; cannam@49: friend struct DynamicList; cannam@49: friend struct DynamicValue; cannam@49: template cannam@49: friend DynamicTypeFor> toDynamic(T&& value); cannam@49: }; cannam@49: cannam@49: // ------------------------------------------------------------------- cannam@49: cannam@49: class DynamicStruct::Reader { cannam@49: public: cannam@49: typedef DynamicStruct Reads; cannam@49: cannam@49: Reader() = default; cannam@49: cannam@49: template >() == Kind::STRUCT>> cannam@49: inline Reader(T&& value): Reader(toDynamic(value)) {} cannam@49: cannam@49: inline MessageSize totalSize() const { return reader.totalSize().asPublic(); } cannam@49: cannam@49: template cannam@49: typename T::Reader as() const; cannam@49: // Convert the dynamic struct to its compiled-in type. cannam@49: cannam@49: inline StructSchema getSchema() const { return schema; } cannam@49: cannam@49: DynamicValue::Reader get(StructSchema::Field field) const; cannam@49: // Read the given field value. cannam@49: cannam@49: bool has(StructSchema::Field field) const; cannam@49: // Tests whether the given field is set to its default value. For pointer values, this does cannam@49: // not actually traverse the value comparing it with the default, but simply returns true if the cannam@49: // pointer is non-null. For members of unions, has() returns false if the union member is not cannam@49: // active, but does not necessarily return true if the member is active (depends on the field's cannam@49: // value). cannam@49: cannam@49: kj::Maybe which() const; cannam@49: // If the struct contains an (unnamed) union, and the currently-active field within that union cannam@49: // is known, this returns that field. Otherwise, it returns null. In other words, this returns cannam@49: // null if there is no union present _or_ if the union's discriminant is set to an unrecognized cannam@49: // value. This could happen in particular when receiving a message from a sender who has a cannam@49: // newer version of the protocol and is using a field of the union that you don't know about yet. cannam@49: cannam@49: DynamicValue::Reader get(kj::StringPtr name) const; cannam@49: bool has(kj::StringPtr name) const; cannam@49: // Shortcuts to access fields by name. These throw exceptions if no such field exists. cannam@49: cannam@49: private: cannam@49: StructSchema schema; cannam@49: _::StructReader reader; cannam@49: cannam@49: inline Reader(StructSchema schema, _::StructReader reader) cannam@49: : schema(schema), reader(reader) {} cannam@49: cannam@49: bool isSetInUnion(StructSchema::Field field) const; cannam@49: void verifySetInUnion(StructSchema::Field field) const; cannam@49: static DynamicValue::Reader getImpl(_::StructReader reader, StructSchema::Field field); cannam@49: cannam@49: template cannam@49: friend struct _::PointerHelpers; cannam@49: friend class DynamicStruct::Builder; cannam@49: friend struct DynamicList; cannam@49: friend class MessageReader; cannam@49: friend class MessageBuilder; cannam@49: template cannam@49: friend struct ::capnp::ToDynamic_; cannam@49: friend kj::StringTree _::structString( cannam@49: _::StructReader reader, const _::RawBrandedSchema& schema); cannam@49: friend class Orphanage; cannam@49: friend class Orphan; cannam@49: friend class Orphan; cannam@49: friend class Orphan; cannam@49: }; cannam@49: cannam@49: class DynamicStruct::Builder { cannam@49: public: cannam@49: typedef DynamicStruct Builds; cannam@49: cannam@49: Builder() = default; cannam@49: inline Builder(decltype(nullptr)) {} cannam@49: cannam@49: template >() == Kind::STRUCT>> cannam@49: inline Builder(T&& value): Builder(toDynamic(value)) {} cannam@49: cannam@49: inline MessageSize totalSize() const { return asReader().totalSize(); } cannam@49: cannam@49: template cannam@49: typename T::Builder as(); cannam@49: // Cast to a particular struct type. cannam@49: cannam@49: inline StructSchema getSchema() const { return schema; } cannam@49: cannam@49: DynamicValue::Builder get(StructSchema::Field field); cannam@49: // Read the given field value. cannam@49: cannam@49: inline bool has(StructSchema::Field field) { return asReader().has(field); } cannam@49: // Tests whether the given field is set to its default value. For pointer values, this does cannam@49: // not actually traverse the value comparing it with the default, but simply returns true if the cannam@49: // pointer is non-null. For members of unions, has() returns whether the field is currently cannam@49: // active and the union as a whole is non-default -- so, the only time has() will return false cannam@49: // for an active union field is if it is the default active field and it has its default value. cannam@49: cannam@49: kj::Maybe which(); cannam@49: // If the struct contains an (unnamed) union, and the currently-active field within that union cannam@49: // is known, this returns that field. Otherwise, it returns null. In other words, this returns cannam@49: // null if there is no union present _or_ if the union's discriminant is set to an unrecognized cannam@49: // value. This could happen in particular when receiving a message from a sender who has a cannam@49: // newer version of the protocol and is using a field of the union that you don't know about yet. cannam@49: cannam@49: void set(StructSchema::Field field, const DynamicValue::Reader& value); cannam@49: // Set the given field value. cannam@49: cannam@49: DynamicValue::Builder init(StructSchema::Field field); cannam@49: DynamicValue::Builder init(StructSchema::Field field, uint size); cannam@49: // Init a struct, list, or blob field. cannam@49: cannam@49: void adopt(StructSchema::Field field, Orphan&& orphan); cannam@49: Orphan disown(StructSchema::Field field); cannam@49: // Adopt/disown. This works even for non-pointer fields: adopt() becomes equivalent to set() cannam@49: // and disown() becomes like get() followed by clear(). cannam@49: cannam@49: void clear(StructSchema::Field field); cannam@49: // Clear a field, setting it to its default value. For pointer fields, this actually makes the cannam@49: // field null. cannam@49: cannam@49: DynamicValue::Builder get(kj::StringPtr name); cannam@49: bool has(kj::StringPtr name); cannam@49: void set(kj::StringPtr name, const DynamicValue::Reader& value); cannam@49: void set(kj::StringPtr name, std::initializer_list value); cannam@49: DynamicValue::Builder init(kj::StringPtr name); cannam@49: DynamicValue::Builder init(kj::StringPtr name, uint size); cannam@49: void adopt(kj::StringPtr name, Orphan&& orphan); cannam@49: Orphan disown(kj::StringPtr name); cannam@49: void clear(kj::StringPtr name); cannam@49: // Shortcuts to access fields by name. These throw exceptions if no such field exists. cannam@49: cannam@49: Reader asReader() const; cannam@49: cannam@49: private: cannam@49: StructSchema schema; cannam@49: _::StructBuilder builder; cannam@49: cannam@49: inline Builder(StructSchema schema, _::StructBuilder builder) cannam@49: : schema(schema), builder(builder) {} cannam@49: cannam@49: bool isSetInUnion(StructSchema::Field field); cannam@49: void verifySetInUnion(StructSchema::Field field); cannam@49: void setInUnion(StructSchema::Field field); cannam@49: cannam@49: template cannam@49: friend struct _::PointerHelpers; cannam@49: friend struct DynamicList; cannam@49: friend class MessageReader; cannam@49: friend class MessageBuilder; cannam@49: template cannam@49: friend struct ::capnp::ToDynamic_; cannam@49: friend class Orphanage; cannam@49: friend class Orphan; cannam@49: friend class Orphan; cannam@49: friend class Orphan; cannam@49: }; cannam@49: cannam@49: class DynamicStruct::Pipeline { cannam@49: public: cannam@49: typedef DynamicStruct Pipelines; cannam@49: cannam@49: inline Pipeline(decltype(nullptr)): typeless(nullptr) {} cannam@49: cannam@49: template cannam@49: typename T::Pipeline releaseAs(); cannam@49: // Convert the dynamic pipeline to its compiled-in type. cannam@49: cannam@49: inline StructSchema getSchema() { return schema; } cannam@49: cannam@49: DynamicValue::Pipeline get(StructSchema::Field field); cannam@49: // Read the given field value. cannam@49: cannam@49: DynamicValue::Pipeline get(kj::StringPtr name); cannam@49: // Get by string name. cannam@49: cannam@49: private: cannam@49: StructSchema schema; cannam@49: AnyPointer::Pipeline typeless; cannam@49: cannam@49: inline explicit Pipeline(StructSchema schema, AnyPointer::Pipeline&& typeless) cannam@49: : schema(schema), typeless(kj::mv(typeless)) {} cannam@49: cannam@49: friend class Request; cannam@49: }; cannam@49: cannam@49: // ------------------------------------------------------------------- cannam@49: cannam@49: class DynamicList::Reader { cannam@49: public: cannam@49: typedef DynamicList Reads; cannam@49: cannam@49: inline Reader(): reader(ElementSize::VOID) {} cannam@49: cannam@49: template >() == Kind::LIST>> cannam@49: inline Reader(T&& value): Reader(toDynamic(value)) {} cannam@49: cannam@49: template cannam@49: typename T::Reader as() const; cannam@49: // Try to convert to any List, Data, or Text. Throws an exception if the underlying data cannam@49: // can't possibly represent the requested type. cannam@49: cannam@49: inline ListSchema getSchema() const { return schema; } cannam@49: cannam@49: inline uint size() const { return reader.size() / ELEMENTS; } cannam@49: DynamicValue::Reader operator[](uint index) const; cannam@49: cannam@49: typedef _::IndexingIterator Iterator; cannam@49: inline Iterator begin() const { return Iterator(this, 0); } cannam@49: inline Iterator end() const { return Iterator(this, size()); } cannam@49: cannam@49: private: cannam@49: ListSchema schema; cannam@49: _::ListReader reader; cannam@49: cannam@49: Reader(ListSchema schema, _::ListReader reader): schema(schema), reader(reader) {} cannam@49: cannam@49: template cannam@49: friend struct _::PointerHelpers; cannam@49: friend struct DynamicStruct; cannam@49: friend class DynamicList::Builder; cannam@49: template cannam@49: friend struct ::capnp::ToDynamic_; cannam@49: friend class Orphanage; cannam@49: friend class Orphan; cannam@49: friend class Orphan; cannam@49: friend class Orphan; cannam@49: }; cannam@49: cannam@49: class DynamicList::Builder { cannam@49: public: cannam@49: typedef DynamicList Builds; cannam@49: cannam@49: inline Builder(): builder(ElementSize::VOID) {} cannam@49: inline Builder(decltype(nullptr)): builder(ElementSize::VOID) {} cannam@49: cannam@49: template >() == Kind::LIST>> cannam@49: inline Builder(T&& value): Builder(toDynamic(value)) {} cannam@49: cannam@49: template cannam@49: typename T::Builder as(); cannam@49: // Try to convert to any List, Data, or Text. Throws an exception if the underlying data cannam@49: // can't possibly represent the requested type. cannam@49: cannam@49: inline ListSchema getSchema() const { return schema; } cannam@49: cannam@49: inline uint size() const { return builder.size() / ELEMENTS; } cannam@49: DynamicValue::Builder operator[](uint index); cannam@49: void set(uint index, const DynamicValue::Reader& value); cannam@49: DynamicValue::Builder init(uint index, uint size); cannam@49: void adopt(uint index, Orphan&& orphan); cannam@49: Orphan disown(uint index); cannam@49: cannam@49: typedef _::IndexingIterator Iterator; cannam@49: inline Iterator begin() { return Iterator(this, 0); } cannam@49: inline Iterator end() { return Iterator(this, size()); } cannam@49: cannam@49: void copyFrom(std::initializer_list value); cannam@49: cannam@49: Reader asReader() const; cannam@49: cannam@49: private: cannam@49: ListSchema schema; cannam@49: _::ListBuilder builder; cannam@49: cannam@49: Builder(ListSchema schema, _::ListBuilder builder): schema(schema), builder(builder) {} cannam@49: cannam@49: template cannam@49: friend struct _::PointerHelpers; cannam@49: friend struct DynamicStruct; cannam@49: template cannam@49: friend struct ::capnp::ToDynamic_; cannam@49: friend class Orphanage; cannam@49: template cannam@49: friend struct _::OrphanGetImpl; cannam@49: friend class Orphan; cannam@49: friend class Orphan; cannam@49: friend class Orphan; cannam@49: }; cannam@49: cannam@49: // ------------------------------------------------------------------- cannam@49: cannam@49: class DynamicCapability::Client: public Capability::Client { cannam@49: public: cannam@49: typedef DynamicCapability Calls; cannam@49: typedef DynamicCapability Reads; cannam@49: cannam@49: Client() = default; cannam@49: cannam@49: template >() == Kind::INTERFACE>> cannam@49: inline Client(T&& client); cannam@49: cannam@49: template ()>> cannam@49: inline Client(kj::Own&& server); cannam@49: cannam@49: template () == Kind::INTERFACE>> cannam@49: typename T::Client as(); cannam@49: template () == Kind::INTERFACE>> cannam@49: typename T::Client releaseAs(); cannam@49: // Convert to any client type. cannam@49: cannam@49: Client upcast(InterfaceSchema requestedSchema); cannam@49: // Upcast to a superclass. Throws an exception if `schema` is not a superclass. cannam@49: cannam@49: inline InterfaceSchema getSchema() { return schema; } cannam@49: cannam@49: Request newRequest( cannam@49: InterfaceSchema::Method method, kj::Maybe sizeHint = nullptr); cannam@49: Request newRequest( cannam@49: kj::StringPtr methodName, kj::Maybe sizeHint = nullptr); cannam@49: cannam@49: private: cannam@49: InterfaceSchema schema; cannam@49: cannam@49: Client(InterfaceSchema schema, kj::Own&& hook) cannam@49: : Capability::Client(kj::mv(hook)), schema(schema) {} cannam@49: cannam@49: template cannam@49: inline Client(InterfaceSchema schema, kj::Own&& server); cannam@49: cannam@49: friend struct Capability; cannam@49: friend struct DynamicStruct; cannam@49: friend struct DynamicList; cannam@49: friend struct DynamicValue; cannam@49: friend class Orphan; cannam@49: friend class Orphan; cannam@49: friend class Orphan; cannam@49: template cannam@49: friend struct _::PointerHelpers; cannam@49: }; cannam@49: cannam@49: class DynamicCapability::Server: public Capability::Server { cannam@49: public: cannam@49: typedef DynamicCapability Serves; cannam@49: cannam@49: Server(InterfaceSchema schema): schema(schema) {} cannam@49: cannam@49: virtual kj::Promise call(InterfaceSchema::Method method, cannam@49: CallContext context) = 0; cannam@49: cannam@49: kj::Promise dispatchCall(uint64_t interfaceId, uint16_t methodId, cannam@49: CallContext context) override final; cannam@49: cannam@49: inline InterfaceSchema getSchema() const { return schema; } cannam@49: cannam@49: private: cannam@49: InterfaceSchema schema; cannam@49: }; cannam@49: cannam@49: template <> cannam@49: class Request: public DynamicStruct::Builder { cannam@49: // Specialization of `Request` for DynamicStruct. cannam@49: cannam@49: public: cannam@49: inline Request(DynamicStruct::Builder builder, kj::Own&& hook, cannam@49: StructSchema resultSchema) cannam@49: : DynamicStruct::Builder(builder), hook(kj::mv(hook)), resultSchema(resultSchema) {} cannam@49: cannam@49: RemotePromise send(); cannam@49: // Send the call and return a promise for the results. cannam@49: cannam@49: private: cannam@49: kj::Own hook; cannam@49: StructSchema resultSchema; cannam@49: cannam@49: friend class Capability::Client; cannam@49: friend struct DynamicCapability; cannam@49: template cannam@49: friend class CallContext; cannam@49: friend class RequestHook; cannam@49: }; cannam@49: cannam@49: template <> cannam@49: class CallContext: public kj::DisallowConstCopy { cannam@49: // Wrapper around CallContextHook with a specific return type. cannam@49: // cannam@49: // Methods of this class may only be called from within the server's event loop, not from other cannam@49: // threads. cannam@49: cannam@49: public: cannam@49: explicit CallContext(CallContextHook& hook, StructSchema paramType, StructSchema resultType); cannam@49: cannam@49: DynamicStruct::Reader getParams(); cannam@49: void releaseParams(); cannam@49: DynamicStruct::Builder getResults(kj::Maybe sizeHint = nullptr); cannam@49: DynamicStruct::Builder initResults(kj::Maybe sizeHint = nullptr); cannam@49: void setResults(DynamicStruct::Reader value); cannam@49: void adoptResults(Orphan&& value); cannam@49: Orphanage getResultsOrphanage(kj::Maybe sizeHint = nullptr); cannam@49: template cannam@49: kj::Promise tailCall(Request&& tailRequest); cannam@49: void allowCancellation(); cannam@49: cannam@49: private: cannam@49: CallContextHook* hook; cannam@49: StructSchema paramType; cannam@49: StructSchema resultType; cannam@49: cannam@49: friend class DynamicCapability::Server; cannam@49: }; cannam@49: cannam@49: // ------------------------------------------------------------------- cannam@49: cannam@49: // Make sure ReaderFor and BuilderFor work for DynamicEnum, DynamicStruct, and cannam@49: // DynamicList, so that we can define DynamicValue::as(). cannam@49: cannam@49: template <> struct ReaderFor_ { typedef DynamicEnum Type; }; cannam@49: template <> struct BuilderFor_ { typedef DynamicEnum Type; }; cannam@49: template <> struct ReaderFor_ { typedef DynamicStruct::Reader Type; }; cannam@49: template <> struct BuilderFor_ { typedef DynamicStruct::Builder Type; }; cannam@49: template <> struct ReaderFor_ { typedef DynamicList::Reader Type; }; cannam@49: template <> struct BuilderFor_ { typedef DynamicList::Builder Type; }; cannam@49: template <> struct ReaderFor_ { typedef DynamicCapability::Client Type; }; cannam@49: template <> struct BuilderFor_ { typedef DynamicCapability::Client Type; }; cannam@49: template <> struct PipelineFor_ { typedef DynamicCapability::Client Type; }; cannam@49: cannam@49: class DynamicValue::Reader { cannam@49: public: cannam@49: typedef DynamicValue Reads; cannam@49: cannam@49: inline Reader(decltype(nullptr) n = nullptr); // UNKNOWN cannam@49: inline Reader(Void value); cannam@49: inline Reader(bool value); cannam@49: inline Reader(char value); cannam@49: inline Reader(signed char value); cannam@49: inline Reader(short value); cannam@49: inline Reader(int value); cannam@49: inline Reader(long value); cannam@49: inline Reader(long long value); cannam@49: inline Reader(unsigned char value); cannam@49: inline Reader(unsigned short value); cannam@49: inline Reader(unsigned int value); cannam@49: inline Reader(unsigned long value); cannam@49: inline Reader(unsigned long long value); cannam@49: inline Reader(float value); cannam@49: inline Reader(double value); cannam@49: inline Reader(const char* value); // Text cannam@49: inline Reader(const Text::Reader& value); cannam@49: inline Reader(const Data::Reader& value); cannam@49: inline Reader(const DynamicList::Reader& value); cannam@49: inline Reader(DynamicEnum value); cannam@49: inline Reader(const DynamicStruct::Reader& value); cannam@49: inline Reader(const AnyPointer::Reader& value); cannam@49: inline Reader(DynamicCapability::Client& value); cannam@49: inline Reader(DynamicCapability::Client&& value); cannam@49: template ()>> cannam@49: inline Reader(kj::Own&& value); cannam@49: Reader(ConstSchema constant); cannam@49: cannam@49: template ()))> cannam@49: inline Reader(T&& value): Reader(toDynamic(kj::mv(value))) {} cannam@49: cannam@49: Reader(const Reader& other); cannam@49: Reader(Reader&& other) noexcept; cannam@49: ~Reader() noexcept(false); cannam@49: Reader& operator=(const Reader& other); cannam@49: Reader& operator=(Reader&& other); cannam@49: // Unfortunately, we cannot use the implicit definitions of these since DynamicCapability is not cannam@49: // trivially copyable. cannam@49: cannam@49: template cannam@49: inline ReaderFor as() const { return AsImpl::apply(*this); } cannam@49: // Use to interpret the value as some Cap'n Proto type. Allowed types are: cannam@49: // - Void, bool, [u]int{8,16,32,64}_t, float, double, any enum: Returns the raw value. cannam@49: // - Text, Data, AnyPointer, any struct type: Returns the corresponding Reader. cannam@49: // - List for any T listed above: Returns List::Reader. cannam@49: // - DynamicEnum: Returns the corresponding type. cannam@49: // - DynamicStruct, DynamicList: Returns the corresponding Reader. cannam@49: // - Any capability type, including DynamicCapability: Returns the corresponding Client. cannam@49: // (TODO(perf): On GCC 4.8 / Clang 3.3, provide rvalue-qualified version that avoids cannam@49: // refcounting.) cannam@49: // cannam@49: // DynamicValue allows various implicit conversions, mostly just to make the interface friendlier. cannam@49: // - Any integer can be converted to any other integer type so long as the actual value is within cannam@49: // the new type's range. cannam@49: // - Floating-point types can be converted to integers as long as no information would be lost cannam@49: // in the conversion. cannam@49: // - Integers can be converted to floating points. This may lose information, but won't throw. cannam@49: // - Float32/Float64 can be converted between each other. Converting Float64 -> Float32 may lose cannam@49: // information, but won't throw. cannam@49: // - Text can be converted to an enum, if the Text matches one of the enumerant names (but not cannam@49: // vice-versa). cannam@49: // - Capabilities can be upcast (cast to a supertype), but not downcast. cannam@49: // cannam@49: // Any other conversion attempt will throw an exception. cannam@49: cannam@49: inline Type getType() const { return type; } cannam@49: // Get the type of this value. cannam@49: cannam@49: private: cannam@49: Type type; cannam@49: cannam@49: union { cannam@49: Void voidValue; cannam@49: bool boolValue; cannam@49: int64_t intValue; cannam@49: uint64_t uintValue; cannam@49: double floatValue; cannam@49: Text::Reader textValue; cannam@49: Data::Reader dataValue; cannam@49: DynamicList::Reader listValue; cannam@49: DynamicEnum enumValue; cannam@49: DynamicStruct::Reader structValue; cannam@49: AnyPointer::Reader anyPointerValue; cannam@49: cannam@49: mutable DynamicCapability::Client capabilityValue; cannam@49: // Declared mutable because `Client`s normally cannot be const. cannam@49: cannam@49: // Warning: Copy/move constructors assume all these types are trivially copyable except cannam@49: // Capability. cannam@49: }; cannam@49: cannam@49: template ()> struct AsImpl; cannam@49: // Implementation backing the as() method. Needs to be a struct to allow partial cannam@49: // specialization. Has a method apply() which does the work. cannam@49: cannam@49: friend class Orphanage; // to speed up newOrphanCopy(DynamicValue::Reader) cannam@49: }; cannam@49: cannam@49: class DynamicValue::Builder { cannam@49: public: cannam@49: typedef DynamicValue Builds; cannam@49: cannam@49: inline Builder(decltype(nullptr) n = nullptr); // UNKNOWN cannam@49: inline Builder(Void value); cannam@49: inline Builder(bool value); cannam@49: inline Builder(char value); cannam@49: inline Builder(signed char value); cannam@49: inline Builder(short value); cannam@49: inline Builder(int value); cannam@49: inline Builder(long value); cannam@49: inline Builder(long long value); cannam@49: inline Builder(unsigned char value); cannam@49: inline Builder(unsigned short value); cannam@49: inline Builder(unsigned int value); cannam@49: inline Builder(unsigned long value); cannam@49: inline Builder(unsigned long long value); cannam@49: inline Builder(float value); cannam@49: inline Builder(double value); cannam@49: inline Builder(Text::Builder value); cannam@49: inline Builder(Data::Builder value); cannam@49: inline Builder(DynamicList::Builder value); cannam@49: inline Builder(DynamicEnum value); cannam@49: inline Builder(DynamicStruct::Builder value); cannam@49: inline Builder(AnyPointer::Builder value); cannam@49: inline Builder(DynamicCapability::Client& value); cannam@49: inline Builder(DynamicCapability::Client&& value); cannam@49: cannam@49: template ()))> cannam@49: inline Builder(T value): Builder(toDynamic(value)) {} cannam@49: cannam@49: Builder(Builder& other); cannam@49: Builder(Builder&& other) noexcept; cannam@49: ~Builder() noexcept(false); cannam@49: Builder& operator=(Builder& other); cannam@49: Builder& operator=(Builder&& other); cannam@49: // Unfortunately, we cannot use the implicit definitions of these since DynamicCapability is not cannam@49: // trivially copyable. cannam@49: cannam@49: template cannam@49: inline BuilderFor as() { return AsImpl::apply(*this); } cannam@49: // See DynamicValue::Reader::as(). cannam@49: cannam@49: inline Type getType() { return type; } cannam@49: // Get the type of this value. cannam@49: cannam@49: Reader asReader() const; cannam@49: cannam@49: private: cannam@49: Type type; cannam@49: cannam@49: union { cannam@49: Void voidValue; cannam@49: bool boolValue; cannam@49: int64_t intValue; cannam@49: uint64_t uintValue; cannam@49: double floatValue; cannam@49: Text::Builder textValue; cannam@49: Data::Builder dataValue; cannam@49: DynamicList::Builder listValue; cannam@49: DynamicEnum enumValue; cannam@49: DynamicStruct::Builder structValue; cannam@49: AnyPointer::Builder anyPointerValue; cannam@49: cannam@49: mutable DynamicCapability::Client capabilityValue; cannam@49: // Declared mutable because `Client`s normally cannot be const. cannam@49: }; cannam@49: cannam@49: template ()> struct AsImpl; cannam@49: // Implementation backing the as() method. Needs to be a struct to allow partial cannam@49: // specialization. Has a method apply() which does the work. cannam@49: cannam@49: friend class Orphan; cannam@49: }; cannam@49: cannam@49: class DynamicValue::Pipeline { cannam@49: public: cannam@49: typedef DynamicValue Pipelines; cannam@49: cannam@49: inline Pipeline(decltype(nullptr) n = nullptr); cannam@49: inline Pipeline(DynamicStruct::Pipeline&& value); cannam@49: inline Pipeline(DynamicCapability::Client&& value); cannam@49: cannam@49: Pipeline(Pipeline&& other) noexcept; cannam@49: Pipeline& operator=(Pipeline&& other); cannam@49: ~Pipeline() noexcept(false); cannam@49: cannam@49: template cannam@49: inline PipelineFor releaseAs() { return AsImpl::apply(*this); } cannam@49: cannam@49: inline Type getType() { return type; } cannam@49: // Get the type of this value. cannam@49: cannam@49: private: cannam@49: Type type; cannam@49: union { cannam@49: DynamicStruct::Pipeline structValue; cannam@49: DynamicCapability::Client capabilityValue; cannam@49: }; cannam@49: cannam@49: template ()> struct AsImpl; cannam@49: // Implementation backing the releaseAs() method. Needs to be a struct to allow partial cannam@49: // specialization. Has a method apply() which does the work. cannam@49: }; cannam@49: cannam@49: kj::StringTree KJ_STRINGIFY(const DynamicValue::Reader& value); cannam@49: kj::StringTree KJ_STRINGIFY(const DynamicValue::Builder& value); cannam@49: kj::StringTree KJ_STRINGIFY(DynamicEnum value); cannam@49: kj::StringTree KJ_STRINGIFY(const DynamicStruct::Reader& value); cannam@49: kj::StringTree KJ_STRINGIFY(const DynamicStruct::Builder& value); cannam@49: kj::StringTree KJ_STRINGIFY(const DynamicList::Reader& value); cannam@49: kj::StringTree KJ_STRINGIFY(const DynamicList::Builder& value); cannam@49: cannam@49: // ------------------------------------------------------------------- cannam@49: // Orphan <-> Dynamic glue cannam@49: cannam@49: template <> cannam@49: class Orphan { cannam@49: public: cannam@49: Orphan() = default; cannam@49: KJ_DISALLOW_COPY(Orphan); cannam@49: Orphan(Orphan&&) = default; cannam@49: Orphan& operator=(Orphan&&) = default; cannam@49: cannam@49: template () == Kind::STRUCT>> cannam@49: inline Orphan(Orphan&& other): schema(Schema::from()), builder(kj::mv(other.builder)) {} cannam@49: cannam@49: DynamicStruct::Builder get(); cannam@49: DynamicStruct::Reader getReader() const; cannam@49: cannam@49: template cannam@49: Orphan releaseAs(); cannam@49: // Like DynamicStruct::Builder::as(), but coerces the Orphan type. Since Orphans are move-only, cannam@49: // the original Orphan is no longer valid after this call; ownership is cannam@49: // transferred to the returned Orphan. cannam@49: cannam@49: inline bool operator==(decltype(nullptr)) const { return builder == nullptr; } cannam@49: inline bool operator!=(decltype(nullptr)) const { return builder != nullptr; } cannam@49: cannam@49: private: cannam@49: StructSchema schema; cannam@49: _::OrphanBuilder builder; cannam@49: cannam@49: inline Orphan(StructSchema schema, _::OrphanBuilder&& builder) cannam@49: : schema(schema), builder(kj::mv(builder)) {} cannam@49: cannam@49: template cannam@49: friend struct _::PointerHelpers; cannam@49: friend struct DynamicList; cannam@49: friend class Orphanage; cannam@49: friend class Orphan; cannam@49: friend class Orphan; cannam@49: friend class MessageBuilder; cannam@49: }; cannam@49: cannam@49: template <> cannam@49: class Orphan { cannam@49: public: cannam@49: Orphan() = default; cannam@49: KJ_DISALLOW_COPY(Orphan); cannam@49: Orphan(Orphan&&) = default; cannam@49: Orphan& operator=(Orphan&&) = default; cannam@49: cannam@49: template () == Kind::LIST>> cannam@49: inline Orphan(Orphan&& other): schema(Schema::from()), builder(kj::mv(other.builder)) {} cannam@49: cannam@49: DynamicList::Builder get(); cannam@49: DynamicList::Reader getReader() const; cannam@49: cannam@49: template cannam@49: Orphan releaseAs(); cannam@49: // Like DynamicList::Builder::as(), but coerces the Orphan type. Since Orphans are move-only, cannam@49: // the original Orphan is no longer valid after this call; ownership is cannam@49: // transferred to the returned Orphan. cannam@49: cannam@49: // TODO(someday): Support truncate(). cannam@49: cannam@49: inline bool operator==(decltype(nullptr)) const { return builder == nullptr; } cannam@49: inline bool operator!=(decltype(nullptr)) const { return builder != nullptr; } cannam@49: cannam@49: private: cannam@49: ListSchema schema; cannam@49: _::OrphanBuilder builder; cannam@49: cannam@49: inline Orphan(ListSchema schema, _::OrphanBuilder&& builder) cannam@49: : schema(schema), builder(kj::mv(builder)) {} cannam@49: cannam@49: template cannam@49: friend struct _::PointerHelpers; cannam@49: friend struct DynamicList; cannam@49: friend class Orphanage; cannam@49: friend class Orphan; cannam@49: friend class Orphan; cannam@49: }; cannam@49: cannam@49: template <> cannam@49: class Orphan { cannam@49: public: cannam@49: Orphan() = default; cannam@49: KJ_DISALLOW_COPY(Orphan); cannam@49: Orphan(Orphan&&) = default; cannam@49: Orphan& operator=(Orphan&&) = default; cannam@49: cannam@49: template () == Kind::INTERFACE>> cannam@49: inline Orphan(Orphan&& other): schema(Schema::from()), builder(kj::mv(other.builder)) {} cannam@49: cannam@49: DynamicCapability::Client get(); cannam@49: DynamicCapability::Client getReader() const; cannam@49: cannam@49: template cannam@49: Orphan releaseAs(); cannam@49: // Like DynamicCapability::Client::as(), but coerces the Orphan type. Since Orphans are move-only, cannam@49: // the original Orphan is no longer valid after this call; ownership is cannam@49: // transferred to the returned Orphan. cannam@49: cannam@49: inline bool operator==(decltype(nullptr)) const { return builder == nullptr; } cannam@49: inline bool operator!=(decltype(nullptr)) const { return builder != nullptr; } cannam@49: cannam@49: private: cannam@49: InterfaceSchema schema; cannam@49: _::OrphanBuilder builder; cannam@49: cannam@49: inline Orphan(InterfaceSchema schema, _::OrphanBuilder&& builder) cannam@49: : schema(schema), builder(kj::mv(builder)) {} cannam@49: cannam@49: template cannam@49: friend struct _::PointerHelpers; cannam@49: friend struct DynamicList; cannam@49: friend class Orphanage; cannam@49: friend class Orphan; cannam@49: friend class Orphan; cannam@49: }; cannam@49: cannam@49: template <> cannam@49: class Orphan { cannam@49: public: cannam@49: inline Orphan(decltype(nullptr) n = nullptr): type(DynamicValue::UNKNOWN) {} cannam@49: inline Orphan(Void value); cannam@49: inline Orphan(bool value); cannam@49: inline Orphan(char value); cannam@49: inline Orphan(signed char value); cannam@49: inline Orphan(short value); cannam@49: inline Orphan(int value); cannam@49: inline Orphan(long value); cannam@49: inline Orphan(long long value); cannam@49: inline Orphan(unsigned char value); cannam@49: inline Orphan(unsigned short value); cannam@49: inline Orphan(unsigned int value); cannam@49: inline Orphan(unsigned long value); cannam@49: inline Orphan(unsigned long long value); cannam@49: inline Orphan(float value); cannam@49: inline Orphan(double value); cannam@49: inline Orphan(DynamicEnum value); cannam@49: Orphan(Orphan&&) = default; cannam@49: template cannam@49: Orphan(Orphan&&); cannam@49: Orphan(Orphan&&); cannam@49: Orphan(void*) = delete; // So Orphan(bool) doesn't accept pointers. cannam@49: KJ_DISALLOW_COPY(Orphan); cannam@49: cannam@49: Orphan& operator=(Orphan&&) = default; cannam@49: cannam@49: inline DynamicValue::Type getType() { return type; } cannam@49: cannam@49: DynamicValue::Builder get(); cannam@49: DynamicValue::Reader getReader() const; cannam@49: cannam@49: template cannam@49: Orphan releaseAs(); cannam@49: // Like DynamicValue::Builder::as(), but coerces the Orphan type. Since Orphans are move-only, cannam@49: // the original Orphan is no longer valid after this call; ownership is cannam@49: // transferred to the returned Orphan. cannam@49: cannam@49: private: cannam@49: DynamicValue::Type type; cannam@49: union { cannam@49: Void voidValue; cannam@49: bool boolValue; cannam@49: int64_t intValue; cannam@49: uint64_t uintValue; cannam@49: double floatValue; cannam@49: DynamicEnum enumValue; cannam@49: StructSchema structSchema; cannam@49: ListSchema listSchema; cannam@49: InterfaceSchema interfaceSchema; cannam@49: }; cannam@49: cannam@49: _::OrphanBuilder builder; cannam@49: // Only used if `type` is a pointer type. cannam@49: cannam@49: Orphan(DynamicValue::Builder value, _::OrphanBuilder&& builder); cannam@49: Orphan(DynamicValue::Type type, _::OrphanBuilder&& builder) cannam@49: : type(type), builder(kj::mv(builder)) {} cannam@49: Orphan(StructSchema structSchema, _::OrphanBuilder&& builder) cannam@49: : type(DynamicValue::STRUCT), structSchema(structSchema), builder(kj::mv(builder)) {} cannam@49: Orphan(ListSchema listSchema, _::OrphanBuilder&& builder) cannam@49: : type(DynamicValue::LIST), listSchema(listSchema), builder(kj::mv(builder)) {} cannam@49: cannam@49: template cannam@49: friend struct _::PointerHelpers; cannam@49: friend struct DynamicStruct; cannam@49: friend struct DynamicList; cannam@49: friend struct AnyPointer; cannam@49: friend class Orphanage; cannam@49: }; cannam@49: cannam@49: template cannam@49: inline Orphan::Orphan(Orphan&& other) cannam@49: : Orphan(other.get(), kj::mv(other.builder)) {} cannam@49: cannam@49: inline Orphan::Orphan(Orphan&& other) cannam@49: : type(DynamicValue::ANY_POINTER), builder(kj::mv(other.builder)) {} cannam@49: cannam@49: template cannam@49: Orphan Orphan::releaseAs() { cannam@49: get().as(); // type check cannam@49: return Orphan(kj::mv(builder)); cannam@49: } cannam@49: cannam@49: template cannam@49: Orphan Orphan::releaseAs() { cannam@49: get().as(); // type check cannam@49: return Orphan(kj::mv(builder)); cannam@49: } cannam@49: cannam@49: template cannam@49: Orphan Orphan::releaseAs() { cannam@49: get().as(); // type check cannam@49: return Orphan(kj::mv(builder)); cannam@49: } cannam@49: cannam@49: template cannam@49: Orphan Orphan::releaseAs() { cannam@49: get().as(); // type check cannam@49: type = DynamicValue::UNKNOWN; cannam@49: return Orphan(kj::mv(builder)); cannam@49: } cannam@49: cannam@49: template <> cannam@49: Orphan Orphan::releaseAs(); cannam@49: template <> cannam@49: Orphan Orphan::releaseAs(); cannam@49: template <> cannam@49: Orphan Orphan::releaseAs(); cannam@49: template <> cannam@49: Orphan Orphan::releaseAs(); cannam@49: cannam@49: template <> cannam@49: struct Orphanage::GetInnerBuilder { cannam@49: static inline _::StructBuilder apply(DynamicStruct::Builder& t) { cannam@49: return t.builder; cannam@49: } cannam@49: }; cannam@49: cannam@49: template <> cannam@49: struct Orphanage::GetInnerBuilder { cannam@49: static inline _::ListBuilder apply(DynamicList::Builder& t) { cannam@49: return t.builder; cannam@49: } cannam@49: }; cannam@49: cannam@49: template <> cannam@49: inline Orphan Orphanage::newOrphanCopy( cannam@49: DynamicStruct::Reader copyFrom) const { cannam@49: return Orphan( cannam@49: copyFrom.getSchema(), _::OrphanBuilder::copy(arena, capTable, copyFrom.reader)); cannam@49: } cannam@49: cannam@49: template <> cannam@49: inline Orphan Orphanage::newOrphanCopy( cannam@49: DynamicList::Reader copyFrom) const { cannam@49: return Orphan(copyFrom.getSchema(), cannam@49: _::OrphanBuilder::copy(arena, capTable, copyFrom.reader)); cannam@49: } cannam@49: cannam@49: template <> cannam@49: inline Orphan Orphanage::newOrphanCopy( cannam@49: DynamicCapability::Client copyFrom) const { cannam@49: return Orphan( cannam@49: copyFrom.getSchema(), _::OrphanBuilder::copy(arena, capTable, copyFrom.hook->addRef())); cannam@49: } cannam@49: cannam@49: template <> cannam@49: Orphan Orphanage::newOrphanCopy( cannam@49: DynamicValue::Reader copyFrom) const; cannam@49: cannam@49: namespace _ { // private cannam@49: cannam@49: template <> cannam@49: struct PointerHelpers { cannam@49: // getDynamic() is used when an AnyPointer's get() accessor is passed arguments, because for cannam@49: // non-dynamic types PointerHelpers::get() takes a default value as the third argument, and we cannam@49: // don't want people to accidentally be able to provide their own default value. cannam@49: static DynamicStruct::Reader getDynamic(PointerReader reader, StructSchema schema); cannam@49: static DynamicStruct::Builder getDynamic(PointerBuilder builder, StructSchema schema); cannam@49: static void set(PointerBuilder builder, const DynamicStruct::Reader& value); cannam@49: static DynamicStruct::Builder init(PointerBuilder builder, StructSchema schema); cannam@49: static inline void adopt(PointerBuilder builder, Orphan&& value) { cannam@49: builder.adopt(kj::mv(value.builder)); cannam@49: } cannam@49: static inline Orphan disown(PointerBuilder builder, StructSchema schema) { cannam@49: return Orphan(schema, builder.disown()); cannam@49: } cannam@49: }; cannam@49: cannam@49: template <> cannam@49: struct PointerHelpers { cannam@49: // getDynamic() is used when an AnyPointer's get() accessor is passed arguments, because for cannam@49: // non-dynamic types PointerHelpers::get() takes a default value as the third argument, and we cannam@49: // don't want people to accidentally be able to provide their own default value. cannam@49: static DynamicList::Reader getDynamic(PointerReader reader, ListSchema schema); cannam@49: static DynamicList::Builder getDynamic(PointerBuilder builder, ListSchema schema); cannam@49: static void set(PointerBuilder builder, const DynamicList::Reader& value); cannam@49: static DynamicList::Builder init(PointerBuilder builder, ListSchema schema, uint size); cannam@49: static inline void adopt(PointerBuilder builder, Orphan&& value) { cannam@49: builder.adopt(kj::mv(value.builder)); cannam@49: } cannam@49: static inline Orphan disown(PointerBuilder builder, ListSchema schema) { cannam@49: return Orphan(schema, builder.disown()); cannam@49: } cannam@49: }; cannam@49: cannam@49: template <> cannam@49: struct PointerHelpers { cannam@49: // getDynamic() is used when an AnyPointer's get() accessor is passed arguments, because for cannam@49: // non-dynamic types PointerHelpers::get() takes a default value as the third argument, and we cannam@49: // don't want people to accidentally be able to provide their own default value. cannam@49: static DynamicCapability::Client getDynamic(PointerReader reader, InterfaceSchema schema); cannam@49: static DynamicCapability::Client getDynamic(PointerBuilder builder, InterfaceSchema schema); cannam@49: static void set(PointerBuilder builder, DynamicCapability::Client& value); cannam@49: static void set(PointerBuilder builder, DynamicCapability::Client&& value); cannam@49: static inline void adopt(PointerBuilder builder, Orphan&& value) { cannam@49: builder.adopt(kj::mv(value.builder)); cannam@49: } cannam@49: static inline Orphan disown(PointerBuilder builder, InterfaceSchema schema) { cannam@49: return Orphan(schema, builder.disown()); cannam@49: } cannam@49: }; cannam@49: cannam@49: } // namespace _ (private) cannam@49: cannam@49: template cannam@49: inline ReaderFor AnyPointer::Reader::getAs(StructSchema schema) const { cannam@49: return _::PointerHelpers::getDynamic(reader, schema); cannam@49: } cannam@49: template cannam@49: inline ReaderFor AnyPointer::Reader::getAs(ListSchema schema) const { cannam@49: return _::PointerHelpers::getDynamic(reader, schema); cannam@49: } cannam@49: template cannam@49: inline ReaderFor AnyPointer::Reader::getAs(InterfaceSchema schema) const { cannam@49: return _::PointerHelpers::getDynamic(reader, schema); cannam@49: } cannam@49: template cannam@49: inline BuilderFor AnyPointer::Builder::getAs(StructSchema schema) { cannam@49: return _::PointerHelpers::getDynamic(builder, schema); cannam@49: } cannam@49: template cannam@49: inline BuilderFor AnyPointer::Builder::getAs(ListSchema schema) { cannam@49: return _::PointerHelpers::getDynamic(builder, schema); cannam@49: } cannam@49: template cannam@49: inline BuilderFor AnyPointer::Builder::getAs(InterfaceSchema schema) { cannam@49: return _::PointerHelpers::getDynamic(builder, schema); cannam@49: } cannam@49: template cannam@49: inline BuilderFor AnyPointer::Builder::initAs(StructSchema schema) { cannam@49: return _::PointerHelpers::init(builder, schema); cannam@49: } cannam@49: template cannam@49: inline BuilderFor AnyPointer::Builder::initAs(ListSchema schema, uint elementCount) { cannam@49: return _::PointerHelpers::init(builder, schema, elementCount); cannam@49: } cannam@49: template <> cannam@49: inline void AnyPointer::Builder::setAs(DynamicStruct::Reader value) { cannam@49: return _::PointerHelpers::set(builder, value); cannam@49: } cannam@49: template <> cannam@49: inline void AnyPointer::Builder::setAs(DynamicList::Reader value) { cannam@49: return _::PointerHelpers::set(builder, value); cannam@49: } cannam@49: template <> cannam@49: inline void AnyPointer::Builder::setAs(DynamicCapability::Client value) { cannam@49: return _::PointerHelpers::set(builder, kj::mv(value)); cannam@49: } cannam@49: template <> cannam@49: void AnyPointer::Builder::adopt(Orphan&& orphan); cannam@49: template cannam@49: inline Orphan AnyPointer::Builder::disownAs(StructSchema schema) { cannam@49: return _::PointerHelpers::disown(builder, schema); cannam@49: } cannam@49: template cannam@49: inline Orphan AnyPointer::Builder::disownAs(ListSchema schema) { cannam@49: return _::PointerHelpers::disown(builder, schema); cannam@49: } cannam@49: template cannam@49: inline Orphan AnyPointer::Builder::disownAs(InterfaceSchema schema) { cannam@49: return _::PointerHelpers::disown(builder, schema); cannam@49: } cannam@49: cannam@49: template <> cannam@49: DynamicStruct::Builder Orphan::getAs(StructSchema schema); cannam@49: template <> cannam@49: DynamicList::Builder Orphan::getAs(ListSchema schema); cannam@49: template <> cannam@49: DynamicCapability::Client Orphan::getAs(InterfaceSchema schema); cannam@49: template <> cannam@49: DynamicStruct::Reader Orphan::getAsReader(StructSchema schema) const; cannam@49: template <> cannam@49: DynamicList::Reader Orphan::getAsReader(ListSchema schema) const; cannam@49: template <> cannam@49: DynamicCapability::Client Orphan::getAsReader( cannam@49: InterfaceSchema schema) const; cannam@49: template <> cannam@49: Orphan Orphan::releaseAs(StructSchema schema); cannam@49: template <> cannam@49: Orphan Orphan::releaseAs(ListSchema schema); cannam@49: template <> cannam@49: Orphan Orphan::releaseAs( cannam@49: InterfaceSchema schema); cannam@49: cannam@49: // ======================================================================================= cannam@49: // Inline implementation details. cannam@49: cannam@49: template cannam@49: struct ToDynamic_ { cannam@49: static inline DynamicStruct::Reader apply(const typename T::Reader& value) { cannam@49: return DynamicStruct::Reader(Schema::from(), value._reader); cannam@49: } cannam@49: static inline DynamicStruct::Builder apply(typename T::Builder& value) { cannam@49: return DynamicStruct::Builder(Schema::from(), value._builder); cannam@49: } cannam@49: }; cannam@49: cannam@49: template cannam@49: struct ToDynamic_ { cannam@49: static inline DynamicList::Reader apply(const typename T::Reader& value) { cannam@49: return DynamicList::Reader(Schema::from(), value.reader); cannam@49: } cannam@49: static inline DynamicList::Builder apply(typename T::Builder& value) { cannam@49: return DynamicList::Builder(Schema::from(), value.builder); cannam@49: } cannam@49: }; cannam@49: cannam@49: template cannam@49: struct ToDynamic_ { cannam@49: static inline DynamicCapability::Client apply(typename T::Client value) { cannam@49: return DynamicCapability::Client(kj::mv(value)); cannam@49: } cannam@49: static inline DynamicCapability::Client apply(typename T::Client&& value) { cannam@49: return DynamicCapability::Client(kj::mv(value)); cannam@49: } cannam@49: }; cannam@49: cannam@49: template cannam@49: ReaderFor>> toDynamic(T&& value) { cannam@49: return ToDynamic_>::apply(value); cannam@49: } cannam@49: template cannam@49: BuilderFor>> toDynamic(T&& value) { cannam@49: return ToDynamic_>::apply(value); cannam@49: } cannam@49: template cannam@49: DynamicTypeFor> toDynamic(T&& value) { cannam@49: return DynamicEnum(Schema::from>(), static_cast(value)); cannam@49: } cannam@49: template cannam@49: typename DynamicTypeFor>::Client toDynamic(kj::Own&& value) { cannam@49: return typename FromServer::Client(kj::mv(value)); cannam@49: } cannam@49: cannam@49: inline DynamicValue::Reader::Reader(std::nullptr_t n): type(UNKNOWN) {} cannam@49: inline DynamicValue::Builder::Builder(std::nullptr_t n): type(UNKNOWN) {} cannam@49: cannam@49: #define CAPNP_DECLARE_DYNAMIC_VALUE_CONSTRUCTOR(cppType, typeTag, fieldName) \ cannam@49: inline DynamicValue::Reader::Reader(cppType value) \ cannam@49: : type(typeTag), fieldName##Value(value) {} \ cannam@49: inline DynamicValue::Builder::Builder(cppType value) \ cannam@49: : type(typeTag), fieldName##Value(value) {} \ cannam@49: inline Orphan::Orphan(cppType value) \ cannam@49: : type(DynamicValue::typeTag), fieldName##Value(value) {} cannam@49: cannam@49: CAPNP_DECLARE_DYNAMIC_VALUE_CONSTRUCTOR(Void, VOID, void); cannam@49: CAPNP_DECLARE_DYNAMIC_VALUE_CONSTRUCTOR(bool, BOOL, bool); cannam@49: CAPNP_DECLARE_DYNAMIC_VALUE_CONSTRUCTOR(char, INT, int); cannam@49: CAPNP_DECLARE_DYNAMIC_VALUE_CONSTRUCTOR(signed char, INT, int); cannam@49: CAPNP_DECLARE_DYNAMIC_VALUE_CONSTRUCTOR(short, INT, int); cannam@49: CAPNP_DECLARE_DYNAMIC_VALUE_CONSTRUCTOR(int, INT, int); cannam@49: CAPNP_DECLARE_DYNAMIC_VALUE_CONSTRUCTOR(long, INT, int); cannam@49: CAPNP_DECLARE_DYNAMIC_VALUE_CONSTRUCTOR(long long, INT, int); cannam@49: CAPNP_DECLARE_DYNAMIC_VALUE_CONSTRUCTOR(unsigned char, UINT, uint); cannam@49: CAPNP_DECLARE_DYNAMIC_VALUE_CONSTRUCTOR(unsigned short, UINT, uint); cannam@49: CAPNP_DECLARE_DYNAMIC_VALUE_CONSTRUCTOR(unsigned int, UINT, uint); cannam@49: CAPNP_DECLARE_DYNAMIC_VALUE_CONSTRUCTOR(unsigned long, UINT, uint); cannam@49: CAPNP_DECLARE_DYNAMIC_VALUE_CONSTRUCTOR(unsigned long long, UINT, uint); cannam@49: CAPNP_DECLARE_DYNAMIC_VALUE_CONSTRUCTOR(float, FLOAT, float); cannam@49: CAPNP_DECLARE_DYNAMIC_VALUE_CONSTRUCTOR(double, FLOAT, float); cannam@49: CAPNP_DECLARE_DYNAMIC_VALUE_CONSTRUCTOR(DynamicEnum, ENUM, enum); cannam@49: #undef CAPNP_DECLARE_DYNAMIC_VALUE_CONSTRUCTOR cannam@49: cannam@49: #define CAPNP_DECLARE_DYNAMIC_VALUE_CONSTRUCTOR(cppType, typeTag, fieldName) \ cannam@49: inline DynamicValue::Reader::Reader(const cppType::Reader& value) \ cannam@49: : type(typeTag), fieldName##Value(value) {} \ cannam@49: inline DynamicValue::Builder::Builder(cppType::Builder value) \ cannam@49: : type(typeTag), fieldName##Value(value) {} cannam@49: cannam@49: CAPNP_DECLARE_DYNAMIC_VALUE_CONSTRUCTOR(Text, TEXT, text); cannam@49: CAPNP_DECLARE_DYNAMIC_VALUE_CONSTRUCTOR(Data, DATA, data); cannam@49: CAPNP_DECLARE_DYNAMIC_VALUE_CONSTRUCTOR(DynamicList, LIST, list); cannam@49: CAPNP_DECLARE_DYNAMIC_VALUE_CONSTRUCTOR(DynamicStruct, STRUCT, struct); cannam@49: CAPNP_DECLARE_DYNAMIC_VALUE_CONSTRUCTOR(AnyPointer, ANY_POINTER, anyPointer); cannam@49: cannam@49: #undef CAPNP_DECLARE_DYNAMIC_VALUE_CONSTRUCTOR cannam@49: cannam@49: inline DynamicValue::Reader::Reader(DynamicCapability::Client& value) cannam@49: : type(CAPABILITY), capabilityValue(value) {} cannam@49: inline DynamicValue::Reader::Reader(DynamicCapability::Client&& value) cannam@49: : type(CAPABILITY), capabilityValue(kj::mv(value)) {} cannam@49: template cannam@49: inline DynamicValue::Reader::Reader(kj::Own&& value) cannam@49: : type(CAPABILITY), capabilityValue(kj::mv(value)) {} cannam@49: inline DynamicValue::Builder::Builder(DynamicCapability::Client& value) cannam@49: : type(CAPABILITY), capabilityValue(value) {} cannam@49: inline DynamicValue::Builder::Builder(DynamicCapability::Client&& value) cannam@49: : type(CAPABILITY), capabilityValue(kj::mv(value)) {} cannam@49: cannam@49: inline DynamicValue::Reader::Reader(const char* value): Reader(Text::Reader(value)) {} cannam@49: cannam@49: #define CAPNP_DECLARE_TYPE(discrim, typeName) \ cannam@49: template <> \ cannam@49: struct DynamicValue::Reader::AsImpl { \ cannam@49: static ReaderFor apply(const Reader& reader); \ cannam@49: }; \ cannam@49: template <> \ cannam@49: struct DynamicValue::Builder::AsImpl { \ cannam@49: static BuilderFor apply(Builder& builder); \ cannam@49: }; cannam@49: cannam@49: //CAPNP_DECLARE_TYPE(VOID, Void) cannam@49: CAPNP_DECLARE_TYPE(BOOL, bool) cannam@49: CAPNP_DECLARE_TYPE(INT8, int8_t) cannam@49: CAPNP_DECLARE_TYPE(INT16, int16_t) cannam@49: CAPNP_DECLARE_TYPE(INT32, int32_t) cannam@49: CAPNP_DECLARE_TYPE(INT64, int64_t) cannam@49: CAPNP_DECLARE_TYPE(UINT8, uint8_t) cannam@49: CAPNP_DECLARE_TYPE(UINT16, uint16_t) cannam@49: CAPNP_DECLARE_TYPE(UINT32, uint32_t) cannam@49: CAPNP_DECLARE_TYPE(UINT64, uint64_t) cannam@49: CAPNP_DECLARE_TYPE(FLOAT32, float) cannam@49: CAPNP_DECLARE_TYPE(FLOAT64, double) cannam@49: cannam@49: CAPNP_DECLARE_TYPE(TEXT, Text) cannam@49: CAPNP_DECLARE_TYPE(DATA, Data) cannam@49: CAPNP_DECLARE_TYPE(LIST, DynamicList) cannam@49: CAPNP_DECLARE_TYPE(STRUCT, DynamicStruct) cannam@49: CAPNP_DECLARE_TYPE(INTERFACE, DynamicCapability) cannam@49: CAPNP_DECLARE_TYPE(ENUM, DynamicEnum) cannam@49: CAPNP_DECLARE_TYPE(ANY_POINTER, AnyPointer) cannam@49: #undef CAPNP_DECLARE_TYPE cannam@49: cannam@49: // CAPNP_DECLARE_TYPE(Void) causes gcc 4.7 to segfault. If I do it manually and remove the cannam@49: // ReaderFor<> and BuilderFor<> wrappers, it works. cannam@49: template <> cannam@49: struct DynamicValue::Reader::AsImpl { cannam@49: static Void apply(const Reader& reader); cannam@49: }; cannam@49: template <> cannam@49: struct DynamicValue::Builder::AsImpl { cannam@49: static Void apply(Builder& builder); cannam@49: }; cannam@49: cannam@49: template cannam@49: struct DynamicValue::Reader::AsImpl { cannam@49: static T apply(const Reader& reader) { cannam@49: return reader.as().as(); cannam@49: } cannam@49: }; cannam@49: template cannam@49: struct DynamicValue::Builder::AsImpl { cannam@49: static T apply(Builder& builder) { cannam@49: return builder.as().as(); cannam@49: } cannam@49: }; cannam@49: cannam@49: template cannam@49: struct DynamicValue::Reader::AsImpl { cannam@49: static typename T::Reader apply(const Reader& reader) { cannam@49: return reader.as().as(); cannam@49: } cannam@49: }; cannam@49: template cannam@49: struct DynamicValue::Builder::AsImpl { cannam@49: static typename T::Builder apply(Builder& builder) { cannam@49: return builder.as().as(); cannam@49: } cannam@49: }; cannam@49: cannam@49: template cannam@49: struct DynamicValue::Reader::AsImpl { cannam@49: static typename T::Reader apply(const Reader& reader) { cannam@49: return reader.as().as(); cannam@49: } cannam@49: }; cannam@49: template cannam@49: struct DynamicValue::Builder::AsImpl { cannam@49: static typename T::Builder apply(Builder& builder) { cannam@49: return builder.as().as(); cannam@49: } cannam@49: }; cannam@49: cannam@49: template cannam@49: struct DynamicValue::Reader::AsImpl { cannam@49: static typename T::Client apply(const Reader& reader) { cannam@49: return reader.as().as(); cannam@49: } cannam@49: }; cannam@49: template cannam@49: struct DynamicValue::Builder::AsImpl { cannam@49: static typename T::Client apply(Builder& builder) { cannam@49: return builder.as().as(); cannam@49: } cannam@49: }; cannam@49: cannam@49: inline DynamicValue::Pipeline::Pipeline(std::nullptr_t n): type(UNKNOWN) {} cannam@49: inline DynamicValue::Pipeline::Pipeline(DynamicStruct::Pipeline&& value) cannam@49: : type(STRUCT), structValue(kj::mv(value)) {} cannam@49: inline DynamicValue::Pipeline::Pipeline(DynamicCapability::Client&& value) cannam@49: : type(CAPABILITY), capabilityValue(kj::mv(value)) {} cannam@49: cannam@49: template cannam@49: struct DynamicValue::Pipeline::AsImpl { cannam@49: static typename T::Pipeline apply(Pipeline& pipeline) { cannam@49: return pipeline.releaseAs().releaseAs(); cannam@49: } cannam@49: }; cannam@49: template cannam@49: struct DynamicValue::Pipeline::AsImpl { cannam@49: static typename T::Client apply(Pipeline& pipeline) { cannam@49: return pipeline.releaseAs().releaseAs(); cannam@49: } cannam@49: }; cannam@49: template <> cannam@49: struct DynamicValue::Pipeline::AsImpl { cannam@49: static PipelineFor apply(Pipeline& pipeline); cannam@49: }; cannam@49: template <> cannam@49: struct DynamicValue::Pipeline::AsImpl { cannam@49: static PipelineFor apply(Pipeline& pipeline); cannam@49: }; cannam@49: cannam@49: // ------------------------------------------------------------------- cannam@49: cannam@49: template cannam@49: typename T::Reader DynamicStruct::Reader::as() const { cannam@49: static_assert(kind() == Kind::STRUCT, cannam@49: "DynamicStruct::Reader::as() can only convert to struct types."); cannam@49: schema.requireUsableAs(); cannam@49: return typename T::Reader(reader); cannam@49: } cannam@49: cannam@49: template cannam@49: typename T::Builder DynamicStruct::Builder::as() { cannam@49: static_assert(kind() == Kind::STRUCT, cannam@49: "DynamicStruct::Builder::as() can only convert to struct types."); cannam@49: schema.requireUsableAs(); cannam@49: return typename T::Builder(builder); cannam@49: } cannam@49: cannam@49: template <> cannam@49: inline DynamicStruct::Reader DynamicStruct::Reader::as() const { cannam@49: return *this; cannam@49: } cannam@49: template <> cannam@49: inline DynamicStruct::Builder DynamicStruct::Builder::as() { cannam@49: return *this; cannam@49: } cannam@49: cannam@49: inline DynamicStruct::Reader DynamicStruct::Builder::asReader() const { cannam@49: return DynamicStruct::Reader(schema, builder.asReader()); cannam@49: } cannam@49: cannam@49: template <> cannam@49: inline AnyStruct::Reader DynamicStruct::Reader::as() const { cannam@49: return AnyStruct::Reader(reader); cannam@49: } cannam@49: cannam@49: template <> cannam@49: inline AnyStruct::Builder DynamicStruct::Builder::as() { cannam@49: return AnyStruct::Builder(builder); cannam@49: } cannam@49: cannam@49: template cannam@49: typename T::Pipeline DynamicStruct::Pipeline::releaseAs() { cannam@49: static_assert(kind() == Kind::STRUCT, cannam@49: "DynamicStruct::Pipeline::releaseAs() can only convert to struct types."); cannam@49: schema.requireUsableAs(); cannam@49: return typename T::Pipeline(kj::mv(typeless)); cannam@49: } cannam@49: cannam@49: // ------------------------------------------------------------------- cannam@49: cannam@49: template cannam@49: typename T::Reader DynamicList::Reader::as() const { cannam@49: static_assert(kind() == Kind::LIST, cannam@49: "DynamicStruct::Reader::as() can only convert to list types."); cannam@49: schema.requireUsableAs(); cannam@49: return typename T::Reader(reader); cannam@49: } cannam@49: template cannam@49: typename T::Builder DynamicList::Builder::as() { cannam@49: static_assert(kind() == Kind::LIST, cannam@49: "DynamicStruct::Builder::as() can only convert to list types."); cannam@49: schema.requireUsableAs(); cannam@49: return typename T::Builder(builder); cannam@49: } cannam@49: cannam@49: template <> cannam@49: inline DynamicList::Reader DynamicList::Reader::as() const { cannam@49: return *this; cannam@49: } cannam@49: template <> cannam@49: inline DynamicList::Builder DynamicList::Builder::as() { cannam@49: return *this; cannam@49: } cannam@49: cannam@49: // ------------------------------------------------------------------- cannam@49: cannam@49: template cannam@49: inline DynamicCapability::Client::Client(T&& client) cannam@49: : Capability::Client(kj::mv(client)), schema(Schema::from>()) {} cannam@49: cannam@49: template cannam@49: inline DynamicCapability::Client::Client(kj::Own&& server) cannam@49: : Client(server->getSchema(), kj::mv(server)) {} cannam@49: template cannam@49: inline DynamicCapability::Client::Client(InterfaceSchema schema, kj::Own&& server) cannam@49: : Capability::Client(kj::mv(server)), schema(schema) {} cannam@49: cannam@49: template cannam@49: typename T::Client DynamicCapability::Client::as() { cannam@49: static_assert(kind() == Kind::INTERFACE, cannam@49: "DynamicCapability::Client::as() can only convert to interface types."); cannam@49: schema.requireUsableAs(); cannam@49: return typename T::Client(hook->addRef()); cannam@49: } cannam@49: cannam@49: template cannam@49: typename T::Client DynamicCapability::Client::releaseAs() { cannam@49: static_assert(kind() == Kind::INTERFACE, cannam@49: "DynamicCapability::Client::as() can only convert to interface types."); cannam@49: schema.requireUsableAs(); cannam@49: return typename T::Client(kj::mv(hook)); cannam@49: } cannam@49: cannam@49: inline CallContext::CallContext( cannam@49: CallContextHook& hook, StructSchema paramType, StructSchema resultType) cannam@49: : hook(&hook), paramType(paramType), resultType(resultType) {} cannam@49: inline DynamicStruct::Reader CallContext::getParams() { cannam@49: return hook->getParams().getAs(paramType); cannam@49: } cannam@49: inline void CallContext::releaseParams() { cannam@49: hook->releaseParams(); cannam@49: } cannam@49: inline DynamicStruct::Builder CallContext::getResults( cannam@49: kj::Maybe sizeHint) { cannam@49: return hook->getResults(sizeHint).getAs(resultType); cannam@49: } cannam@49: inline DynamicStruct::Builder CallContext::initResults( cannam@49: kj::Maybe sizeHint) { cannam@49: return hook->getResults(sizeHint).initAs(resultType); cannam@49: } cannam@49: inline void CallContext::setResults(DynamicStruct::Reader value) { cannam@49: hook->getResults(value.totalSize()).setAs(value); cannam@49: } cannam@49: inline void CallContext::adoptResults(Orphan&& value) { cannam@49: hook->getResults(MessageSize { 0, 0 }).adopt(kj::mv(value)); cannam@49: } cannam@49: inline Orphanage CallContext::getResultsOrphanage( cannam@49: kj::Maybe sizeHint) { cannam@49: return Orphanage::getForMessageContaining(hook->getResults(sizeHint)); cannam@49: } cannam@49: template cannam@49: inline kj::Promise CallContext::tailCall( cannam@49: Request&& tailRequest) { cannam@49: return hook->tailCall(kj::mv(tailRequest.hook)); cannam@49: } cannam@49: inline void CallContext::allowCancellation() { cannam@49: hook->allowCancellation(); cannam@49: } cannam@49: cannam@49: template <> cannam@49: inline DynamicCapability::Client Capability::Client::castAs( cannam@49: InterfaceSchema schema) { cannam@49: return DynamicCapability::Client(schema, hook->addRef()); cannam@49: } cannam@49: cannam@49: // ------------------------------------------------------------------- cannam@49: cannam@49: template cannam@49: ReaderFor ConstSchema::as() const { cannam@49: return DynamicValue::Reader(*this).as(); cannam@49: } cannam@49: cannam@49: } // namespace capnp cannam@49: cannam@49: #endif // CAPNP_DYNAMIC_H_