Chris@63: // Copyright (c) 2013-2014 Sandstorm Development Group, Inc. and contributors Chris@63: // Licensed under the MIT License: Chris@63: // Chris@63: // Permission is hereby granted, free of charge, to any person obtaining a copy Chris@63: // of this software and associated documentation files (the "Software"), to deal Chris@63: // in the Software without restriction, including without limitation the rights Chris@63: // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell Chris@63: // copies of the Software, and to permit persons to whom the Software is Chris@63: // furnished to do so, subject to the following conditions: Chris@63: // Chris@63: // The above copyright notice and this permission notice shall be included in Chris@63: // all copies or substantial portions of the Software. Chris@63: // Chris@63: // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR Chris@63: // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, Chris@63: // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE Chris@63: // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER Chris@63: // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, Chris@63: // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN Chris@63: // THE SOFTWARE. Chris@63: Chris@63: #ifndef CAPNP_ANY_H_ Chris@63: #define CAPNP_ANY_H_ Chris@63: Chris@63: #if defined(__GNUC__) && !defined(CAPNP_HEADER_WARNINGS) Chris@63: #pragma GCC system_header Chris@63: #endif Chris@63: Chris@63: #include "layout.h" Chris@63: #include "pointer-helpers.h" Chris@63: #include "orphan.h" Chris@63: #include "list.h" Chris@63: Chris@63: namespace capnp { Chris@63: Chris@63: class StructSchema; Chris@63: class ListSchema; Chris@63: class InterfaceSchema; Chris@63: class Orphanage; Chris@63: class ClientHook; Chris@63: class PipelineHook; Chris@63: struct PipelineOp; Chris@63: struct AnyPointer; Chris@63: Chris@63: struct AnyList { Chris@63: AnyList() = delete; Chris@63: Chris@63: class Reader; Chris@63: class Builder; Chris@63: }; Chris@63: Chris@63: struct AnyStruct { Chris@63: AnyStruct() = delete; Chris@63: Chris@63: class Reader; Chris@63: class Builder; Chris@63: class Pipeline; Chris@63: }; Chris@63: Chris@63: template<> Chris@63: struct List { Chris@63: List() = delete; Chris@63: Chris@63: class Reader; Chris@63: class Builder; Chris@63: }; Chris@63: Chris@63: namespace _ { // private Chris@63: template <> struct Kind_ { static constexpr Kind kind = Kind::OTHER; }; Chris@63: template <> struct Kind_ { static constexpr Kind kind = Kind::OTHER; }; Chris@63: template <> struct Kind_ { static constexpr Kind kind = Kind::OTHER; }; Chris@63: } // namespace _ (private) Chris@63: Chris@63: // ======================================================================================= Chris@63: // AnyPointer! Chris@63: Chris@63: enum class Equality { Chris@63: NOT_EQUAL, Chris@63: EQUAL, Chris@63: UNKNOWN_CONTAINS_CAPS Chris@63: }; Chris@63: Chris@63: kj::StringPtr KJ_STRINGIFY(Equality res); Chris@63: Chris@63: struct AnyPointer { Chris@63: // Reader/Builder for the `AnyPointer` field type, i.e. a pointer that can point to an arbitrary Chris@63: // object. Chris@63: Chris@63: AnyPointer() = delete; Chris@63: Chris@63: class Reader { Chris@63: public: Chris@63: typedef AnyPointer Reads; Chris@63: Chris@63: Reader() = default; Chris@63: inline Reader(_::PointerReader reader): reader(reader) {} Chris@63: Chris@63: inline MessageSize targetSize() const; Chris@63: // Get the total size of the target object and all its children. Chris@63: Chris@63: inline PointerType getPointerType() const; Chris@63: Chris@63: inline bool isNull() const { return getPointerType() == PointerType::NULL_; } Chris@63: inline bool isStruct() const { return getPointerType() == PointerType::STRUCT; } Chris@63: inline bool isList() const { return getPointerType() == PointerType::LIST; } Chris@63: inline bool isCapability() const { return getPointerType() == PointerType::CAPABILITY; } Chris@63: Chris@63: Equality equals(AnyPointer::Reader right); Chris@63: bool operator==(AnyPointer::Reader right); Chris@63: inline bool operator!=(AnyPointer::Reader right) { Chris@63: return !(*this == right); Chris@63: } Chris@63: Chris@63: template Chris@63: inline ReaderFor getAs() const; Chris@63: // Valid for T = any generated struct type, interface type, List, Text, or Data. Chris@63: Chris@63: template Chris@63: inline ReaderFor getAs(StructSchema schema) const; Chris@63: // Only valid for T = DynamicStruct. Requires `#include `. Chris@63: Chris@63: template Chris@63: inline ReaderFor getAs(ListSchema schema) const; Chris@63: // Only valid for T = DynamicList. Requires `#include `. Chris@63: Chris@63: template Chris@63: inline ReaderFor getAs(InterfaceSchema schema) const; Chris@63: // Only valid for T = DynamicCapability. Requires `#include `. Chris@63: Chris@63: #if !CAPNP_LITE Chris@63: kj::Own getPipelinedCap(kj::ArrayPtr ops) const; Chris@63: // Used by RPC system to implement pipelining. Applications generally shouldn't use this Chris@63: // directly. Chris@63: #endif // !CAPNP_LITE Chris@63: Chris@63: private: Chris@63: _::PointerReader reader; Chris@63: friend struct AnyPointer; Chris@63: friend class Orphanage; Chris@63: friend class CapReaderContext; Chris@63: friend struct _::PointerHelpers; Chris@63: }; Chris@63: Chris@63: class Builder { Chris@63: public: Chris@63: typedef AnyPointer Builds; Chris@63: Chris@63: Builder() = delete; Chris@63: inline Builder(decltype(nullptr)) {} Chris@63: inline Builder(_::PointerBuilder builder): builder(builder) {} Chris@63: Chris@63: inline MessageSize targetSize() const; Chris@63: // Get the total size of the target object and all its children. Chris@63: Chris@63: inline PointerType getPointerType(); Chris@63: Chris@63: inline bool isNull() { return getPointerType() == PointerType::NULL_; } Chris@63: inline bool isStruct() { return getPointerType() == PointerType::STRUCT; } Chris@63: inline bool isList() { return getPointerType() == PointerType::LIST; } Chris@63: inline bool isCapability() { return getPointerType() == PointerType::CAPABILITY; } Chris@63: Chris@63: inline Equality equals(AnyPointer::Reader right) { Chris@63: return asReader().equals(right); Chris@63: } Chris@63: inline bool operator==(AnyPointer::Reader right) { Chris@63: return asReader() == right; Chris@63: } Chris@63: inline bool operator!=(AnyPointer::Reader right) { Chris@63: return !(*this == right); Chris@63: } Chris@63: Chris@63: inline void clear(); Chris@63: // Set to null. Chris@63: Chris@63: template Chris@63: inline BuilderFor getAs(); Chris@63: // Valid for T = any generated struct type, List, Text, or Data. Chris@63: Chris@63: template Chris@63: inline BuilderFor getAs(StructSchema schema); Chris@63: // Only valid for T = DynamicStruct. Requires `#include `. Chris@63: Chris@63: template Chris@63: inline BuilderFor getAs(ListSchema schema); Chris@63: // Only valid for T = DynamicList. Requires `#include `. Chris@63: Chris@63: template Chris@63: inline BuilderFor getAs(InterfaceSchema schema); Chris@63: // Only valid for T = DynamicCapability. Requires `#include `. Chris@63: Chris@63: template Chris@63: inline BuilderFor initAs(); Chris@63: // Valid for T = any generated struct type. Chris@63: Chris@63: template Chris@63: inline BuilderFor initAs(uint elementCount); Chris@63: // Valid for T = List, Text, or Data. Chris@63: Chris@63: template Chris@63: inline BuilderFor initAs(StructSchema schema); Chris@63: // Only valid for T = DynamicStruct. Requires `#include `. Chris@63: Chris@63: template Chris@63: inline BuilderFor initAs(ListSchema schema, uint elementCount); Chris@63: // Only valid for T = DynamicList. Requires `#include `. Chris@63: Chris@63: inline AnyList::Builder initAsAnyList(ElementSize elementSize, uint elementCount); Chris@63: // Note: Does not accept INLINE_COMPOSITE for elementSize. Chris@63: Chris@63: inline List::Builder initAsListOfAnyStruct( Chris@63: uint16_t dataWordCount, uint16_t pointerCount, uint elementCount); Chris@63: Chris@63: inline AnyStruct::Builder initAsAnyStruct(uint16_t dataWordCount, uint16_t pointerCount); Chris@63: Chris@63: template Chris@63: inline void setAs(ReaderFor value); Chris@63: // Valid for ReaderType = T::Reader for T = any generated struct type, List, Text, Data, Chris@63: // DynamicStruct, or DynamicList (the dynamic types require `#include `). Chris@63: Chris@63: template Chris@63: inline void setAs(std::initializer_list>> list); Chris@63: // Valid for T = List. Chris@63: Chris@63: template Chris@63: inline void setCanonicalAs(ReaderFor value); Chris@63: Chris@63: inline void set(Reader value) { builder.copyFrom(value.reader); } Chris@63: // Set to a copy of another AnyPointer. Chris@63: Chris@63: inline void setCanonical(Reader value) { builder.copyFrom(value.reader, true); } Chris@63: Chris@63: template Chris@63: inline void adopt(Orphan&& orphan); Chris@63: // Valid for T = any generated struct type, List, Text, Data, DynamicList, DynamicStruct, Chris@63: // or DynamicValue (the dynamic types require `#include `). Chris@63: Chris@63: template Chris@63: inline Orphan disownAs(); Chris@63: // Valid for T = any generated struct type, List, Text, Data. Chris@63: Chris@63: template Chris@63: inline Orphan disownAs(StructSchema schema); Chris@63: // Only valid for T = DynamicStruct. Requires `#include `. Chris@63: Chris@63: template Chris@63: inline Orphan disownAs(ListSchema schema); Chris@63: // Only valid for T = DynamicList. Requires `#include `. Chris@63: Chris@63: template Chris@63: inline Orphan disownAs(InterfaceSchema schema); Chris@63: // Only valid for T = DynamicCapability. Requires `#include `. Chris@63: Chris@63: inline Orphan disown(); Chris@63: // Disown without a type. Chris@63: Chris@63: inline Reader asReader() const { return Reader(builder.asReader()); } Chris@63: inline operator Reader() const { return Reader(builder.asReader()); } Chris@63: Chris@63: private: Chris@63: _::PointerBuilder builder; Chris@63: friend class Orphanage; Chris@63: friend class CapBuilderContext; Chris@63: friend struct _::PointerHelpers; Chris@63: }; Chris@63: Chris@63: #if !CAPNP_LITE Chris@63: class Pipeline { Chris@63: public: Chris@63: typedef AnyPointer Pipelines; Chris@63: Chris@63: inline Pipeline(decltype(nullptr)) {} Chris@63: inline explicit Pipeline(kj::Own&& hook): hook(kj::mv(hook)) {} Chris@63: Chris@63: Pipeline noop(); Chris@63: // Just make a copy. Chris@63: Chris@63: Pipeline getPointerField(uint16_t pointerIndex); Chris@63: // Deprecated. In the future, we should use .asAnyStruct.getPointerField. Chris@63: Chris@63: inline AnyStruct::Pipeline asAnyStruct(); Chris@63: Chris@63: kj::Own asCap(); Chris@63: // Expect that the result is a capability and construct a pipelined version of it now. Chris@63: Chris@63: inline kj::Own releasePipelineHook() { return kj::mv(hook); } Chris@63: // For use by RPC implementations. Chris@63: Chris@63: template ) == Kind::INTERFACE>> Chris@63: inline operator T() { return T(asCap()); } Chris@63: Chris@63: private: Chris@63: kj::Own hook; Chris@63: kj::Array ops; Chris@63: Chris@63: inline Pipeline(kj::Own&& hook, kj::Array&& ops) Chris@63: : hook(kj::mv(hook)), ops(kj::mv(ops)) {} Chris@63: Chris@63: friend class LocalClient; Chris@63: friend class PipelineHook; Chris@63: friend class AnyStruct::Pipeline; Chris@63: }; Chris@63: #endif // !CAPNP_LITE Chris@63: }; Chris@63: Chris@63: template <> Chris@63: class Orphan { Chris@63: // An orphaned object of unknown type. Chris@63: Chris@63: public: Chris@63: Orphan() = default; Chris@63: KJ_DISALLOW_COPY(Orphan); Chris@63: Orphan(Orphan&&) = default; Chris@63: inline Orphan(_::OrphanBuilder&& builder) Chris@63: : builder(kj::mv(builder)) {} Chris@63: Chris@63: Orphan& operator=(Orphan&&) = default; Chris@63: Chris@63: template Chris@63: inline Orphan(Orphan&& other): builder(kj::mv(other.builder)) {} Chris@63: template Chris@63: inline Orphan& operator=(Orphan&& other) { builder = kj::mv(other.builder); return *this; } Chris@63: // Cast from typed orphan. Chris@63: Chris@63: // It's not possible to get an AnyPointer::{Reader,Builder} directly since there is no Chris@63: // underlying pointer (the pointer would normally live in the parent, but this object is Chris@63: // orphaned). It is possible, however, to request typed readers/builders. Chris@63: Chris@63: template Chris@63: inline BuilderFor getAs(); Chris@63: template Chris@63: inline BuilderFor getAs(StructSchema schema); Chris@63: template Chris@63: inline BuilderFor getAs(ListSchema schema); Chris@63: template Chris@63: inline typename T::Client getAs(InterfaceSchema schema); Chris@63: template Chris@63: inline ReaderFor getAsReader() const; Chris@63: template Chris@63: inline ReaderFor getAsReader(StructSchema schema) const; Chris@63: template Chris@63: inline ReaderFor getAsReader(ListSchema schema) const; Chris@63: template Chris@63: inline typename T::Client getAsReader(InterfaceSchema schema) const; Chris@63: Chris@63: template Chris@63: inline Orphan releaseAs(); Chris@63: template Chris@63: inline Orphan releaseAs(StructSchema schema); Chris@63: template Chris@63: inline Orphan releaseAs(ListSchema schema); Chris@63: template Chris@63: inline Orphan releaseAs(InterfaceSchema schema); Chris@63: // Down-cast the orphan to a specific type. Chris@63: Chris@63: inline bool operator==(decltype(nullptr)) const { return builder == nullptr; } Chris@63: inline bool operator!=(decltype(nullptr)) const { return builder != nullptr; } Chris@63: Chris@63: private: Chris@63: _::OrphanBuilder builder; Chris@63: Chris@63: template Chris@63: friend struct _::PointerHelpers; Chris@63: friend class Orphanage; Chris@63: template Chris@63: friend class Orphan; Chris@63: friend class AnyPointer::Builder; Chris@63: }; Chris@63: Chris@63: template struct AnyTypeFor_; Chris@63: template <> struct AnyTypeFor_ { typedef AnyStruct Type; }; Chris@63: template <> struct AnyTypeFor_ { typedef AnyList Type; }; Chris@63: Chris@63: template Chris@63: using AnyTypeFor = typename AnyTypeFor_::Type; Chris@63: Chris@63: template Chris@63: inline ReaderFor>> toAny(T&& value) { Chris@63: return ReaderFor>>( Chris@63: _::PointerHelpers>::getInternalReader(value)); Chris@63: } Chris@63: template Chris@63: inline BuilderFor>> toAny(T&& value) { Chris@63: return BuilderFor>>( Chris@63: _::PointerHelpers>::getInternalBuilder(kj::mv(value))); Chris@63: } Chris@63: Chris@63: template <> Chris@63: struct List { Chris@63: // Note: This cannot be used for a list of structs, since such lists are not encoded as pointer Chris@63: // lists! Use List. Chris@63: Chris@63: List() = delete; Chris@63: Chris@63: class Reader { Chris@63: public: Chris@63: typedef List Reads; Chris@63: Chris@63: inline Reader(): reader(ElementSize::POINTER) {} Chris@63: inline explicit Reader(_::ListReader reader): reader(reader) {} Chris@63: Chris@63: inline uint size() const { return unbound(reader.size() / ELEMENTS); } Chris@63: inline AnyPointer::Reader operator[](uint index) const { Chris@63: KJ_IREQUIRE(index < size()); Chris@63: return AnyPointer::Reader(reader.getPointerElement(bounded(index) * ELEMENTS)); Chris@63: } Chris@63: Chris@63: typedef _::IndexingIterator Iterator; Chris@63: inline Iterator begin() const { return Iterator(this, 0); } Chris@63: inline Iterator end() const { return Iterator(this, size()); } Chris@63: Chris@63: private: Chris@63: _::ListReader reader; Chris@63: template Chris@63: friend struct _::PointerHelpers; Chris@63: template Chris@63: friend struct List; Chris@63: friend class Orphanage; Chris@63: template Chris@63: friend struct ToDynamic_; Chris@63: }; Chris@63: Chris@63: class Builder { Chris@63: public: Chris@63: typedef List Builds; Chris@63: Chris@63: Builder() = delete; Chris@63: inline Builder(decltype(nullptr)): builder(ElementSize::POINTER) {} Chris@63: inline explicit Builder(_::ListBuilder builder): builder(builder) {} Chris@63: Chris@63: inline operator Reader() const { return Reader(builder.asReader()); } Chris@63: inline Reader asReader() const { return Reader(builder.asReader()); } Chris@63: Chris@63: inline uint size() const { return unbound(builder.size() / ELEMENTS); } Chris@63: inline AnyPointer::Builder operator[](uint index) { Chris@63: KJ_IREQUIRE(index < size()); Chris@63: return AnyPointer::Builder(builder.getPointerElement(bounded(index) * ELEMENTS)); Chris@63: } Chris@63: Chris@63: typedef _::IndexingIterator Iterator; Chris@63: inline Iterator begin() { return Iterator(this, 0); } Chris@63: inline Iterator end() { return Iterator(this, size()); } Chris@63: Chris@63: private: Chris@63: _::ListBuilder builder; Chris@63: template Chris@63: friend struct _::PointerHelpers; Chris@63: friend class Orphanage; Chris@63: template Chris@63: friend struct ToDynamic_; Chris@63: }; Chris@63: }; Chris@63: Chris@63: class AnyStruct::Reader { Chris@63: public: Chris@63: typedef AnyStruct Reads; Chris@63: Chris@63: Reader() = default; Chris@63: inline Reader(_::StructReader reader): _reader(reader) {} Chris@63: Chris@63: template ) == Kind::STRUCT>> Chris@63: inline Reader(T&& value) Chris@63: : _reader(_::PointerHelpers>::getInternalReader(kj::fwd(value))) {} Chris@63: Chris@63: kj::ArrayPtr getDataSection() { Chris@63: return _reader.getDataSectionAsBlob(); Chris@63: } Chris@63: List::Reader getPointerSection() { Chris@63: return List::Reader(_reader.getPointerSectionAsList()); Chris@63: } Chris@63: Chris@63: kj::Array canonicalize() { Chris@63: return _reader.canonicalize(); Chris@63: } Chris@63: Chris@63: Equality equals(AnyStruct::Reader right); Chris@63: bool operator==(AnyStruct::Reader right); Chris@63: inline bool operator!=(AnyStruct::Reader right) { Chris@63: return !(*this == right); Chris@63: } Chris@63: Chris@63: template Chris@63: ReaderFor as() const { Chris@63: // T must be a struct type. Chris@63: return typename T::Reader(_reader); Chris@63: } Chris@63: private: Chris@63: _::StructReader _reader; Chris@63: Chris@63: template Chris@63: friend struct _::PointerHelpers; Chris@63: friend class Orphanage; Chris@63: }; Chris@63: Chris@63: class AnyStruct::Builder { Chris@63: public: Chris@63: typedef AnyStruct Builds; Chris@63: Chris@63: inline Builder(decltype(nullptr)) {} Chris@63: inline Builder(_::StructBuilder builder): _builder(builder) {} Chris@63: Chris@63: #if !_MSC_VER // TODO(msvc): MSVC ICEs on this. Try restoring when compiler improves. Chris@63: template ) == Kind::STRUCT>> Chris@63: inline Builder(T&& value) Chris@63: : _builder(_::PointerHelpers>::getInternalBuilder(kj::fwd(value))) {} Chris@63: #endif Chris@63: Chris@63: inline kj::ArrayPtr getDataSection() { Chris@63: return _builder.getDataSectionAsBlob(); Chris@63: } Chris@63: List::Builder getPointerSection() { Chris@63: return List::Builder(_builder.getPointerSectionAsList()); Chris@63: } Chris@63: Chris@63: inline Equality equals(AnyStruct::Reader right) { Chris@63: return asReader().equals(right); Chris@63: } Chris@63: inline bool operator==(AnyStruct::Reader right) { Chris@63: return asReader() == right; Chris@63: } Chris@63: inline bool operator!=(AnyStruct::Reader right) { Chris@63: return !(*this == right); Chris@63: } Chris@63: Chris@63: inline operator Reader() const { return Reader(_builder.asReader()); } Chris@63: inline Reader asReader() const { return Reader(_builder.asReader()); } Chris@63: Chris@63: template Chris@63: BuilderFor as() { Chris@63: // T must be a struct type. Chris@63: return typename T::Builder(_builder); Chris@63: } Chris@63: private: Chris@63: _::StructBuilder _builder; Chris@63: friend class Orphanage; Chris@63: friend class CapBuilderContext; Chris@63: }; Chris@63: Chris@63: #if !CAPNP_LITE Chris@63: class AnyStruct::Pipeline { Chris@63: public: Chris@63: inline Pipeline(decltype(nullptr)): typeless(nullptr) {} Chris@63: inline explicit Pipeline(AnyPointer::Pipeline&& typeless) Chris@63: : typeless(kj::mv(typeless)) {} Chris@63: Chris@63: inline AnyPointer::Pipeline getPointerField(uint16_t pointerIndex) { Chris@63: // Return a new Promise representing a sub-object of the result. `pointerIndex` is the index Chris@63: // of the sub-object within the pointer section of the result (the result must be a struct). Chris@63: // Chris@63: // TODO(perf): On GCC 4.8 / Clang 3.3, use rvalue qualifiers to avoid the need for copies. Chris@63: // Also make `ops` into a Vector to optimize this. Chris@63: return typeless.getPointerField(pointerIndex); Chris@63: } Chris@63: Chris@63: private: Chris@63: AnyPointer::Pipeline typeless; Chris@63: }; Chris@63: #endif // !CAPNP_LITE Chris@63: Chris@63: class List::Reader { Chris@63: public: Chris@63: typedef List Reads; Chris@63: Chris@63: inline Reader(): reader(ElementSize::INLINE_COMPOSITE) {} Chris@63: inline explicit Reader(_::ListReader reader): reader(reader) {} Chris@63: Chris@63: inline uint size() const { return unbound(reader.size() / ELEMENTS); } Chris@63: inline AnyStruct::Reader operator[](uint index) const { Chris@63: KJ_IREQUIRE(index < size()); Chris@63: return AnyStruct::Reader(reader.getStructElement(bounded(index) * ELEMENTS)); Chris@63: } Chris@63: Chris@63: typedef _::IndexingIterator Iterator; Chris@63: inline Iterator begin() const { return Iterator(this, 0); } Chris@63: inline Iterator end() const { return Iterator(this, size()); } Chris@63: Chris@63: private: Chris@63: _::ListReader reader; Chris@63: template Chris@63: friend struct _::PointerHelpers; Chris@63: template Chris@63: friend struct List; Chris@63: friend class Orphanage; Chris@63: template Chris@63: friend struct ToDynamic_; Chris@63: }; Chris@63: Chris@63: class List::Builder { Chris@63: public: Chris@63: typedef List Builds; Chris@63: Chris@63: Builder() = delete; Chris@63: inline Builder(decltype(nullptr)): builder(ElementSize::INLINE_COMPOSITE) {} Chris@63: inline explicit Builder(_::ListBuilder builder): builder(builder) {} Chris@63: Chris@63: inline operator Reader() const { return Reader(builder.asReader()); } Chris@63: inline Reader asReader() const { return Reader(builder.asReader()); } Chris@63: Chris@63: inline uint size() const { return unbound(builder.size() / ELEMENTS); } Chris@63: inline AnyStruct::Builder operator[](uint index) { Chris@63: KJ_IREQUIRE(index < size()); Chris@63: return AnyStruct::Builder(builder.getStructElement(bounded(index) * ELEMENTS)); Chris@63: } Chris@63: Chris@63: typedef _::IndexingIterator Iterator; Chris@63: inline Iterator begin() { return Iterator(this, 0); } Chris@63: inline Iterator end() { return Iterator(this, size()); } Chris@63: Chris@63: private: Chris@63: _::ListBuilder builder; Chris@63: template Chris@63: friend struct _::PointerHelpers; Chris@63: friend class Orphanage; Chris@63: template Chris@63: friend struct ToDynamic_; Chris@63: }; Chris@63: Chris@63: class AnyList::Reader { Chris@63: public: Chris@63: typedef AnyList Reads; Chris@63: Chris@63: inline Reader(): _reader(ElementSize::VOID) {} Chris@63: inline Reader(_::ListReader reader): _reader(reader) {} Chris@63: Chris@63: #if !_MSC_VER // TODO(msvc): MSVC ICEs on this. Try restoring when compiler improves. Chris@63: template ) == Kind::LIST>> Chris@63: inline Reader(T&& value) Chris@63: : _reader(_::PointerHelpers>::getInternalReader(kj::fwd(value))) {} Chris@63: #endif Chris@63: Chris@63: inline ElementSize getElementSize() { return _reader.getElementSize(); } Chris@63: inline uint size() { return unbound(_reader.size() / ELEMENTS); } Chris@63: Chris@63: inline kj::ArrayPtr getRawBytes() { return _reader.asRawBytes(); } Chris@63: Chris@63: Equality equals(AnyList::Reader right); Chris@63: bool operator==(AnyList::Reader right); Chris@63: inline bool operator!=(AnyList::Reader right) { Chris@63: return !(*this == right); Chris@63: } Chris@63: Chris@63: template ReaderFor as() { Chris@63: // T must be List. Chris@63: return ReaderFor(_reader); Chris@63: } Chris@63: private: Chris@63: _::ListReader _reader; Chris@63: Chris@63: template Chris@63: friend struct _::PointerHelpers; Chris@63: friend class Orphanage; Chris@63: }; Chris@63: Chris@63: class AnyList::Builder { Chris@63: public: Chris@63: typedef AnyList Builds; Chris@63: Chris@63: inline Builder(decltype(nullptr)): _builder(ElementSize::VOID) {} Chris@63: inline Builder(_::ListBuilder builder): _builder(builder) {} Chris@63: Chris@63: #if !_MSC_VER // TODO(msvc): MSVC ICEs on this. Try restoring when compiler improves. Chris@63: template ) == Kind::LIST>> Chris@63: inline Builder(T&& value) Chris@63: : _builder(_::PointerHelpers>::getInternalBuilder(kj::fwd(value))) {} Chris@63: #endif Chris@63: Chris@63: inline ElementSize getElementSize() { return _builder.getElementSize(); } Chris@63: inline uint size() { return unbound(_builder.size() / ELEMENTS); } Chris@63: Chris@63: Equality equals(AnyList::Reader right); Chris@63: inline bool operator==(AnyList::Reader right) { Chris@63: return asReader() == right; Chris@63: } Chris@63: inline bool operator!=(AnyList::Reader right) { Chris@63: return !(*this == right); Chris@63: } Chris@63: Chris@63: template BuilderFor as() { Chris@63: // T must be List. Chris@63: return BuilderFor(_builder); Chris@63: } Chris@63: Chris@63: inline operator Reader() const { return Reader(_builder.asReader()); } Chris@63: inline Reader asReader() const { return Reader(_builder.asReader()); } Chris@63: Chris@63: private: Chris@63: _::ListBuilder _builder; Chris@63: Chris@63: friend class Orphanage; Chris@63: }; Chris@63: Chris@63: // ======================================================================================= Chris@63: // Pipeline helpers Chris@63: // Chris@63: // These relate to capabilities, but we don't declare them in capability.h because generated code Chris@63: // for structs needs to know about these, even in files that contain no interfaces. Chris@63: Chris@63: #if !CAPNP_LITE Chris@63: Chris@63: struct PipelineOp { Chris@63: // Corresponds to rpc.capnp's PromisedAnswer.Op. Chris@63: Chris@63: enum Type { Chris@63: NOOP, // for convenience Chris@63: Chris@63: GET_POINTER_FIELD Chris@63: Chris@63: // There may be other types in the future... Chris@63: }; Chris@63: Chris@63: Type type; Chris@63: union { Chris@63: uint16_t pointerIndex; // for GET_POINTER_FIELD Chris@63: }; Chris@63: }; Chris@63: Chris@63: class PipelineHook { Chris@63: // Represents a currently-running call, and implements pipelined requests on its result. Chris@63: Chris@63: public: Chris@63: virtual kj::Own addRef() = 0; Chris@63: // Increment this object's reference count. Chris@63: Chris@63: virtual kj::Own getPipelinedCap(kj::ArrayPtr ops) = 0; Chris@63: // Extract a promised Capability from the results. Chris@63: Chris@63: virtual kj::Own getPipelinedCap(kj::Array&& ops); Chris@63: // Version of getPipelinedCap() passing the array by move. May avoid a copy in some cases. Chris@63: // Default implementation just calls the other version. Chris@63: Chris@63: template > Chris@63: static inline kj::Own from(Pipeline&& pipeline); Chris@63: Chris@63: private: Chris@63: template struct FromImpl; Chris@63: }; Chris@63: Chris@63: #endif // !CAPNP_LITE Chris@63: Chris@63: // ======================================================================================= Chris@63: // Inline implementation details Chris@63: Chris@63: inline MessageSize AnyPointer::Reader::targetSize() const { Chris@63: return reader.targetSize().asPublic(); Chris@63: } Chris@63: Chris@63: inline PointerType AnyPointer::Reader::getPointerType() const { Chris@63: return reader.getPointerType(); Chris@63: } Chris@63: Chris@63: template Chris@63: inline ReaderFor AnyPointer::Reader::getAs() const { Chris@63: return _::PointerHelpers::get(reader); Chris@63: } Chris@63: Chris@63: inline MessageSize AnyPointer::Builder::targetSize() const { Chris@63: return asReader().targetSize(); Chris@63: } Chris@63: Chris@63: inline PointerType AnyPointer::Builder::getPointerType() { Chris@63: return builder.getPointerType(); Chris@63: } Chris@63: Chris@63: inline void AnyPointer::Builder::clear() { Chris@63: return builder.clear(); Chris@63: } Chris@63: Chris@63: template Chris@63: inline BuilderFor AnyPointer::Builder::getAs() { Chris@63: return _::PointerHelpers::get(builder); Chris@63: } Chris@63: Chris@63: template Chris@63: inline BuilderFor AnyPointer::Builder::initAs() { Chris@63: return _::PointerHelpers::init(builder); Chris@63: } Chris@63: Chris@63: template Chris@63: inline BuilderFor AnyPointer::Builder::initAs(uint elementCount) { Chris@63: return _::PointerHelpers::init(builder, elementCount); Chris@63: } Chris@63: Chris@63: inline AnyList::Builder AnyPointer::Builder::initAsAnyList( Chris@63: ElementSize elementSize, uint elementCount) { Chris@63: return AnyList::Builder(builder.initList(elementSize, bounded(elementCount) * ELEMENTS)); Chris@63: } Chris@63: Chris@63: inline List::Builder AnyPointer::Builder::initAsListOfAnyStruct( Chris@63: uint16_t dataWordCount, uint16_t pointerCount, uint elementCount) { Chris@63: return List::Builder(builder.initStructList(bounded(elementCount) * ELEMENTS, Chris@63: _::StructSize(bounded(dataWordCount) * WORDS, Chris@63: bounded(pointerCount) * POINTERS))); Chris@63: } Chris@63: Chris@63: inline AnyStruct::Builder AnyPointer::Builder::initAsAnyStruct( Chris@63: uint16_t dataWordCount, uint16_t pointerCount) { Chris@63: return AnyStruct::Builder(builder.initStruct( Chris@63: _::StructSize(bounded(dataWordCount) * WORDS, Chris@63: bounded(pointerCount) * POINTERS))); Chris@63: } Chris@63: Chris@63: template Chris@63: inline void AnyPointer::Builder::setAs(ReaderFor value) { Chris@63: return _::PointerHelpers::set(builder, value); Chris@63: } Chris@63: Chris@63: template Chris@63: inline void AnyPointer::Builder::setCanonicalAs(ReaderFor value) { Chris@63: return _::PointerHelpers::setCanonical(builder, value); Chris@63: } Chris@63: Chris@63: template Chris@63: inline void AnyPointer::Builder::setAs( Chris@63: std::initializer_list>> list) { Chris@63: return _::PointerHelpers::set(builder, list); Chris@63: } Chris@63: Chris@63: template Chris@63: inline void AnyPointer::Builder::adopt(Orphan&& orphan) { Chris@63: _::PointerHelpers::adopt(builder, kj::mv(orphan)); Chris@63: } Chris@63: Chris@63: template Chris@63: inline Orphan AnyPointer::Builder::disownAs() { Chris@63: return _::PointerHelpers::disown(builder); Chris@63: } Chris@63: Chris@63: inline Orphan AnyPointer::Builder::disown() { Chris@63: return Orphan(builder.disown()); Chris@63: } Chris@63: Chris@63: template <> struct ReaderFor_ { typedef AnyPointer::Reader Type; }; Chris@63: template <> struct BuilderFor_ { typedef AnyPointer::Builder Type; }; Chris@63: template <> struct ReaderFor_ { typedef AnyStruct::Reader Type; }; Chris@63: template <> struct BuilderFor_ { typedef AnyStruct::Builder Type; }; Chris@63: Chris@63: template <> Chris@63: struct Orphanage::GetInnerReader { Chris@63: static inline _::PointerReader apply(const AnyPointer::Reader& t) { Chris@63: return t.reader; Chris@63: } Chris@63: }; Chris@63: Chris@63: template <> Chris@63: struct Orphanage::GetInnerBuilder { Chris@63: static inline _::PointerBuilder apply(AnyPointer::Builder& t) { Chris@63: return t.builder; Chris@63: } Chris@63: }; Chris@63: Chris@63: template <> Chris@63: struct Orphanage::GetInnerReader { Chris@63: static inline _::StructReader apply(const AnyStruct::Reader& t) { Chris@63: return t._reader; Chris@63: } Chris@63: }; Chris@63: Chris@63: template <> Chris@63: struct Orphanage::GetInnerBuilder { Chris@63: static inline _::StructBuilder apply(AnyStruct::Builder& t) { Chris@63: return t._builder; Chris@63: } Chris@63: }; Chris@63: Chris@63: template <> Chris@63: struct Orphanage::GetInnerReader { Chris@63: static inline _::ListReader apply(const AnyList::Reader& t) { Chris@63: return t._reader; Chris@63: } Chris@63: }; Chris@63: Chris@63: template <> Chris@63: struct Orphanage::GetInnerBuilder { Chris@63: static inline _::ListBuilder apply(AnyList::Builder& t) { Chris@63: return t._builder; Chris@63: } Chris@63: }; Chris@63: Chris@63: template Chris@63: inline BuilderFor Orphan::getAs() { Chris@63: return _::OrphanGetImpl::apply(builder); Chris@63: } Chris@63: template Chris@63: inline ReaderFor Orphan::getAsReader() const { Chris@63: return _::OrphanGetImpl::applyReader(builder); Chris@63: } Chris@63: template Chris@63: inline Orphan Orphan::releaseAs() { Chris@63: return Orphan(kj::mv(builder)); Chris@63: } Chris@63: Chris@63: // Using AnyPointer as the template type should work... Chris@63: Chris@63: template <> Chris@63: inline typename AnyPointer::Reader AnyPointer::Reader::getAs() const { Chris@63: return *this; Chris@63: } Chris@63: template <> Chris@63: inline typename AnyPointer::Builder AnyPointer::Builder::getAs() { Chris@63: return *this; Chris@63: } Chris@63: template <> Chris@63: inline typename AnyPointer::Builder AnyPointer::Builder::initAs() { Chris@63: clear(); Chris@63: return *this; Chris@63: } Chris@63: template <> Chris@63: inline void AnyPointer::Builder::setAs(AnyPointer::Reader value) { Chris@63: return builder.copyFrom(value.reader); Chris@63: } Chris@63: template <> Chris@63: inline void AnyPointer::Builder::adopt(Orphan&& orphan) { Chris@63: builder.adopt(kj::mv(orphan.builder)); Chris@63: } Chris@63: template <> Chris@63: inline Orphan AnyPointer::Builder::disownAs() { Chris@63: return Orphan(builder.disown()); Chris@63: } Chris@63: template <> Chris@63: inline Orphan Orphan::releaseAs() { Chris@63: return kj::mv(*this); Chris@63: } Chris@63: Chris@63: namespace _ { // private Chris@63: Chris@63: // Specialize PointerHelpers for AnyPointer. Chris@63: Chris@63: template <> Chris@63: struct PointerHelpers { Chris@63: static inline AnyPointer::Reader get(PointerReader reader, Chris@63: const void* defaultValue = nullptr, Chris@63: uint defaultBytes = 0) { Chris@63: return AnyPointer::Reader(reader); Chris@63: } Chris@63: static inline AnyPointer::Builder get(PointerBuilder builder, Chris@63: const void* defaultValue = nullptr, Chris@63: uint defaultBytes = 0) { Chris@63: return AnyPointer::Builder(builder); Chris@63: } Chris@63: static inline void set(PointerBuilder builder, AnyPointer::Reader value) { Chris@63: AnyPointer::Builder(builder).set(value); Chris@63: } Chris@63: static inline void adopt(PointerBuilder builder, Orphan&& value) { Chris@63: builder.adopt(kj::mv(value.builder)); Chris@63: } Chris@63: static inline Orphan disown(PointerBuilder builder) { Chris@63: return Orphan(builder.disown()); Chris@63: } Chris@63: static inline _::PointerReader getInternalReader(const AnyPointer::Reader& reader) { Chris@63: return reader.reader; Chris@63: } Chris@63: static inline _::PointerBuilder getInternalBuilder(AnyPointer::Builder&& builder) { Chris@63: return builder.builder; Chris@63: } Chris@63: }; Chris@63: Chris@63: template <> Chris@63: struct PointerHelpers { Chris@63: static inline AnyStruct::Reader get( Chris@63: PointerReader reader, const word* defaultValue = nullptr) { Chris@63: return AnyStruct::Reader(reader.getStruct(defaultValue)); Chris@63: } Chris@63: static inline AnyStruct::Builder get( Chris@63: PointerBuilder builder, const word* defaultValue = nullptr) { Chris@63: // TODO(someday): Allow specifying the size somehow? Chris@63: return AnyStruct::Builder(builder.getStruct( Chris@63: _::StructSize(ZERO * WORDS, ZERO * POINTERS), defaultValue)); Chris@63: } Chris@63: static inline void set(PointerBuilder builder, AnyStruct::Reader value) { Chris@63: builder.setStruct(value._reader); Chris@63: } Chris@63: static inline AnyStruct::Builder init( Chris@63: PointerBuilder builder, uint16_t dataWordCount, uint16_t pointerCount) { Chris@63: return AnyStruct::Builder(builder.initStruct( Chris@63: StructSize(bounded(dataWordCount) * WORDS, Chris@63: bounded(pointerCount) * POINTERS))); Chris@63: } Chris@63: Chris@63: static void adopt(PointerBuilder builder, Orphan&& value) { Chris@63: builder.adopt(kj::mv(value.builder)); Chris@63: } Chris@63: static Orphan disown(PointerBuilder builder) { Chris@63: return Orphan(builder.disown()); Chris@63: } Chris@63: }; Chris@63: Chris@63: template <> Chris@63: struct PointerHelpers { Chris@63: static inline AnyList::Reader get( Chris@63: PointerReader reader, const word* defaultValue = nullptr) { Chris@63: return AnyList::Reader(reader.getListAnySize(defaultValue)); Chris@63: } Chris@63: static inline AnyList::Builder get( Chris@63: PointerBuilder builder, const word* defaultValue = nullptr) { Chris@63: return AnyList::Builder(builder.getListAnySize(defaultValue)); Chris@63: } Chris@63: static inline void set(PointerBuilder builder, AnyList::Reader value) { Chris@63: builder.setList(value._reader); Chris@63: } Chris@63: static inline AnyList::Builder init( Chris@63: PointerBuilder builder, ElementSize elementSize, uint elementCount) { Chris@63: return AnyList::Builder(builder.initList( Chris@63: elementSize, bounded(elementCount) * ELEMENTS)); Chris@63: } Chris@63: static inline AnyList::Builder init( Chris@63: PointerBuilder builder, uint16_t dataWordCount, uint16_t pointerCount, uint elementCount) { Chris@63: return AnyList::Builder(builder.initStructList( Chris@63: bounded(elementCount) * ELEMENTS, Chris@63: StructSize(bounded(dataWordCount) * WORDS, Chris@63: bounded(pointerCount) * POINTERS))); Chris@63: } Chris@63: Chris@63: static void adopt(PointerBuilder builder, Orphan&& value) { Chris@63: builder.adopt(kj::mv(value.builder)); Chris@63: } Chris@63: static Orphan disown(PointerBuilder builder) { Chris@63: return Orphan(builder.disown()); Chris@63: } Chris@63: }; Chris@63: Chris@63: template <> Chris@63: struct OrphanGetImpl { Chris@63: static inline AnyStruct::Builder apply(_::OrphanBuilder& builder) { Chris@63: return AnyStruct::Builder(builder.asStruct(_::StructSize(ZERO * WORDS, ZERO * POINTERS))); Chris@63: } Chris@63: static inline AnyStruct::Reader applyReader(const _::OrphanBuilder& builder) { Chris@63: return AnyStruct::Reader(builder.asStructReader(_::StructSize(ZERO * WORDS, ZERO * POINTERS))); Chris@63: } Chris@63: static inline void truncateListOf(_::OrphanBuilder& builder, ElementCount size) { Chris@63: builder.truncate(size, _::StructSize(ZERO * WORDS, ZERO * POINTERS)); Chris@63: } Chris@63: }; Chris@63: Chris@63: template <> Chris@63: struct OrphanGetImpl { Chris@63: static inline AnyList::Builder apply(_::OrphanBuilder& builder) { Chris@63: return AnyList::Builder(builder.asListAnySize()); Chris@63: } Chris@63: static inline AnyList::Reader applyReader(const _::OrphanBuilder& builder) { Chris@63: return AnyList::Reader(builder.asListReaderAnySize()); Chris@63: } Chris@63: static inline void truncateListOf(_::OrphanBuilder& builder, ElementCount size) { Chris@63: builder.truncate(size, ElementSize::POINTER); Chris@63: } Chris@63: }; Chris@63: Chris@63: } // namespace _ (private) Chris@63: Chris@63: #if !CAPNP_LITE Chris@63: Chris@63: template Chris@63: struct PipelineHook::FromImpl { Chris@63: static inline kj::Own apply(typename T::Pipeline&& pipeline) { Chris@63: return from(kj::mv(pipeline._typeless)); Chris@63: } Chris@63: }; Chris@63: Chris@63: template <> Chris@63: struct PipelineHook::FromImpl { Chris@63: static inline kj::Own apply(AnyPointer::Pipeline&& pipeline) { Chris@63: return kj::mv(pipeline.hook); Chris@63: } Chris@63: }; Chris@63: Chris@63: template Chris@63: inline kj::Own PipelineHook::from(Pipeline&& pipeline) { Chris@63: return FromImpl::apply(kj::fwd(pipeline)); Chris@63: } Chris@63: Chris@63: #endif // !CAPNP_LITE Chris@63: Chris@63: } // namespace capnp Chris@63: Chris@63: #endif // CAPNP_ANY_H_