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: #ifndef CAPNP_ANY_H_ cannam@49: #define CAPNP_ANY_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 "layout.h" cannam@49: #include "pointer-helpers.h" cannam@49: #include "orphan.h" cannam@49: #include "list.h" cannam@49: cannam@49: namespace capnp { cannam@49: cannam@49: class StructSchema; cannam@49: class ListSchema; cannam@49: class InterfaceSchema; cannam@49: class Orphanage; cannam@49: class ClientHook; cannam@49: class PipelineHook; cannam@49: struct PipelineOp; cannam@49: struct AnyPointer; cannam@49: cannam@49: struct AnyList { cannam@49: AnyList() = delete; cannam@49: cannam@49: class Reader; cannam@49: class Builder; cannam@49: }; cannam@49: cannam@49: struct AnyStruct { cannam@49: AnyStruct() = delete; cannam@49: cannam@49: class Reader; cannam@49: class Builder; cannam@49: class Pipeline; cannam@49: }; cannam@49: cannam@49: template<> cannam@49: struct List { cannam@49: List() = delete; cannam@49: cannam@49: class Reader; cannam@49: class Builder; cannam@49: }; cannam@49: cannam@49: namespace _ { // private 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: } // namespace _ (private) cannam@49: cannam@49: // ======================================================================================= cannam@49: // AnyPointer! cannam@49: cannam@49: enum class Equality { cannam@49: NOT_EQUAL, cannam@49: EQUAL, cannam@49: UNKNOWN_CONTAINS_CAPS cannam@49: }; cannam@49: cannam@49: kj::StringPtr KJ_STRINGIFY(Equality res); cannam@49: cannam@49: struct AnyPointer { cannam@49: // Reader/Builder for the `AnyPointer` field type, i.e. a pointer that can point to an arbitrary cannam@49: // object. cannam@49: cannam@49: AnyPointer() = delete; cannam@49: cannam@49: class Reader { cannam@49: public: cannam@49: typedef AnyPointer Reads; cannam@49: cannam@49: Reader() = default; cannam@49: inline Reader(_::PointerReader reader): reader(reader) {} cannam@49: cannam@49: inline MessageSize targetSize() const; cannam@49: // Get the total size of the target object and all its children. cannam@49: cannam@49: inline PointerType getPointerType() const; cannam@49: cannam@49: inline bool isNull() const { return getPointerType() == PointerType::NULL_; } cannam@49: inline bool isStruct() const { return getPointerType() == PointerType::STRUCT; } cannam@49: inline bool isList() const { return getPointerType() == PointerType::LIST; } cannam@49: inline bool isCapability() const { return getPointerType() == PointerType::CAPABILITY; } cannam@49: cannam@49: Equality equals(AnyPointer::Reader right); cannam@49: bool operator==(AnyPointer::Reader right); cannam@49: inline bool operator!=(AnyPointer::Reader right) { cannam@49: return !(*this == right); cannam@49: } cannam@49: cannam@49: template cannam@49: inline ReaderFor getAs() const; cannam@49: // Valid for T = any generated struct type, interface type, List, Text, or Data. cannam@49: cannam@49: template cannam@49: inline ReaderFor getAs(StructSchema schema) const; cannam@49: // Only valid for T = DynamicStruct. Requires `#include `. cannam@49: cannam@49: template cannam@49: inline ReaderFor getAs(ListSchema schema) const; cannam@49: // Only valid for T = DynamicList. Requires `#include `. cannam@49: cannam@49: template cannam@49: inline ReaderFor getAs(InterfaceSchema schema) const; cannam@49: // Only valid for T = DynamicCapability. Requires `#include `. cannam@49: cannam@49: #if !CAPNP_LITE cannam@49: kj::Own getPipelinedCap(kj::ArrayPtr ops) const; cannam@49: // Used by RPC system to implement pipelining. Applications generally shouldn't use this cannam@49: // directly. cannam@49: #endif // !CAPNP_LITE cannam@49: cannam@49: private: cannam@49: _::PointerReader reader; cannam@49: friend struct AnyPointer; cannam@49: friend class Orphanage; cannam@49: friend class CapReaderContext; cannam@49: friend struct _::PointerHelpers; cannam@49: }; cannam@49: cannam@49: class Builder { cannam@49: public: cannam@49: typedef AnyPointer Builds; cannam@49: cannam@49: Builder() = delete; cannam@49: inline Builder(decltype(nullptr)) {} cannam@49: inline Builder(_::PointerBuilder builder): builder(builder) {} cannam@49: cannam@49: inline MessageSize targetSize() const; cannam@49: // Get the total size of the target object and all its children. cannam@49: cannam@49: inline PointerType getPointerType(); cannam@49: cannam@49: inline bool isNull() { return getPointerType() == PointerType::NULL_; } cannam@49: inline bool isStruct() { return getPointerType() == PointerType::STRUCT; } cannam@49: inline bool isList() { return getPointerType() == PointerType::LIST; } cannam@49: inline bool isCapability() { return getPointerType() == PointerType::CAPABILITY; } cannam@49: cannam@49: inline Equality equals(AnyPointer::Reader right) { cannam@49: return asReader().equals(right); cannam@49: } cannam@49: inline bool operator==(AnyPointer::Reader right) { cannam@49: return asReader() == right; cannam@49: } cannam@49: inline bool operator!=(AnyPointer::Reader right) { cannam@49: return !(*this == right); cannam@49: } cannam@49: cannam@49: inline void clear(); cannam@49: // Set to null. cannam@49: cannam@49: template cannam@49: inline BuilderFor getAs(); cannam@49: // Valid for T = any generated struct type, List, Text, or Data. cannam@49: cannam@49: template cannam@49: inline BuilderFor getAs(StructSchema schema); cannam@49: // Only valid for T = DynamicStruct. Requires `#include `. cannam@49: cannam@49: template cannam@49: inline BuilderFor getAs(ListSchema schema); cannam@49: // Only valid for T = DynamicList. Requires `#include `. cannam@49: cannam@49: template cannam@49: inline BuilderFor getAs(InterfaceSchema schema); cannam@49: // Only valid for T = DynamicCapability. Requires `#include `. cannam@49: cannam@49: template cannam@49: inline BuilderFor initAs(); cannam@49: // Valid for T = any generated struct type. cannam@49: cannam@49: template cannam@49: inline BuilderFor initAs(uint elementCount); cannam@49: // Valid for T = List, Text, or Data. cannam@49: cannam@49: template cannam@49: inline BuilderFor initAs(StructSchema schema); cannam@49: // Only valid for T = DynamicStruct. Requires `#include `. cannam@49: cannam@49: template cannam@49: inline BuilderFor initAs(ListSchema schema, uint elementCount); cannam@49: // Only valid for T = DynamicList. Requires `#include `. cannam@49: cannam@49: inline AnyList::Builder initAsAnyList(ElementSize elementSize, uint elementCount); cannam@49: // Note: Does not accept INLINE_COMPOSITE for elementSize. cannam@49: cannam@49: inline List::Builder initAsListOfAnyStruct( cannam@49: uint dataWordCount, uint pointerCount, uint elementCount); cannam@49: cannam@49: inline AnyStruct::Builder initAsAnyStruct(uint dataWordCount, uint pointerCount); cannam@49: cannam@49: template cannam@49: inline void setAs(ReaderFor value); cannam@49: // Valid for ReaderType = T::Reader for T = any generated struct type, List, Text, Data, cannam@49: // DynamicStruct, or DynamicList (the dynamic types require `#include `). cannam@49: cannam@49: template cannam@49: inline void setAs(std::initializer_list>> list); cannam@49: // Valid for T = List. cannam@49: cannam@49: template cannam@49: inline void setCanonicalAs(ReaderFor value); cannam@49: cannam@49: inline void set(Reader value) { builder.copyFrom(value.reader); } cannam@49: // Set to a copy of another AnyPointer. cannam@49: cannam@49: inline void setCanonical(Reader value) { builder.copyFrom(value.reader, true); } cannam@49: cannam@49: template cannam@49: inline void adopt(Orphan&& orphan); cannam@49: // Valid for T = any generated struct type, List, Text, Data, DynamicList, DynamicStruct, cannam@49: // or DynamicValue (the dynamic types require `#include `). cannam@49: cannam@49: template cannam@49: inline Orphan disownAs(); cannam@49: // Valid for T = any generated struct type, List, Text, Data. cannam@49: cannam@49: template cannam@49: inline Orphan disownAs(StructSchema schema); cannam@49: // Only valid for T = DynamicStruct. Requires `#include `. cannam@49: cannam@49: template cannam@49: inline Orphan disownAs(ListSchema schema); cannam@49: // Only valid for T = DynamicList. Requires `#include `. cannam@49: cannam@49: template cannam@49: inline Orphan disownAs(InterfaceSchema schema); cannam@49: // Only valid for T = DynamicCapability. Requires `#include `. cannam@49: cannam@49: inline Orphan disown(); cannam@49: // Disown without a type. cannam@49: cannam@49: inline Reader asReader() const { return Reader(builder.asReader()); } cannam@49: inline operator Reader() const { return Reader(builder.asReader()); } cannam@49: cannam@49: private: cannam@49: _::PointerBuilder builder; cannam@49: friend class Orphanage; cannam@49: friend class CapBuilderContext; cannam@49: friend struct _::PointerHelpers; cannam@49: }; cannam@49: cannam@49: #if !CAPNP_LITE cannam@49: class Pipeline { cannam@49: public: cannam@49: typedef AnyPointer Pipelines; cannam@49: cannam@49: inline Pipeline(decltype(nullptr)) {} cannam@49: inline explicit Pipeline(kj::Own&& hook): hook(kj::mv(hook)) {} cannam@49: cannam@49: Pipeline noop(); cannam@49: // Just make a copy. cannam@49: cannam@49: Pipeline getPointerField(uint16_t pointerIndex); cannam@49: // Deprecated. In the future, we should use .asAnyStruct.getPointerField. cannam@49: cannam@49: inline AnyStruct::Pipeline asAnyStruct(); cannam@49: cannam@49: kj::Own asCap(); cannam@49: // Expect that the result is a capability and construct a pipelined version of it now. cannam@49: cannam@49: inline kj::Own releasePipelineHook() { return kj::mv(hook); } cannam@49: // For use by RPC implementations. cannam@49: cannam@49: template ) == Kind::INTERFACE>> cannam@49: inline operator T() { return T(asCap()); } cannam@49: cannam@49: private: cannam@49: kj::Own hook; cannam@49: kj::Array ops; cannam@49: cannam@49: inline Pipeline(kj::Own&& hook, kj::Array&& ops) cannam@49: : hook(kj::mv(hook)), ops(kj::mv(ops)) {} cannam@49: cannam@49: friend class LocalClient; cannam@49: friend class PipelineHook; cannam@49: friend class AnyStruct::Pipeline; cannam@49: }; cannam@49: #endif // !CAPNP_LITE cannam@49: }; cannam@49: cannam@49: template <> cannam@49: class Orphan { cannam@49: // An orphaned object of unknown type. cannam@49: cannam@49: public: cannam@49: Orphan() = default; cannam@49: KJ_DISALLOW_COPY(Orphan); cannam@49: Orphan(Orphan&&) = default; cannam@49: inline Orphan(_::OrphanBuilder&& builder) cannam@49: : builder(kj::mv(builder)) {} cannam@49: cannam@49: Orphan& operator=(Orphan&&) = default; cannam@49: cannam@49: template cannam@49: inline Orphan(Orphan&& other): builder(kj::mv(other.builder)) {} cannam@49: template cannam@49: inline Orphan& operator=(Orphan&& other) { builder = kj::mv(other.builder); return *this; } cannam@49: // Cast from typed orphan. cannam@49: cannam@49: // It's not possible to get an AnyPointer::{Reader,Builder} directly since there is no cannam@49: // underlying pointer (the pointer would normally live in the parent, but this object is cannam@49: // orphaned). It is possible, however, to request typed readers/builders. cannam@49: cannam@49: template cannam@49: inline BuilderFor getAs(); cannam@49: template cannam@49: inline BuilderFor getAs(StructSchema schema); cannam@49: template cannam@49: inline BuilderFor getAs(ListSchema schema); cannam@49: template cannam@49: inline typename T::Client getAs(InterfaceSchema schema); cannam@49: template cannam@49: inline ReaderFor getAsReader() const; cannam@49: template cannam@49: inline ReaderFor getAsReader(StructSchema schema) const; cannam@49: template cannam@49: inline ReaderFor getAsReader(ListSchema schema) const; cannam@49: template cannam@49: inline typename T::Client getAsReader(InterfaceSchema schema) const; cannam@49: cannam@49: template cannam@49: inline Orphan releaseAs(); cannam@49: template cannam@49: inline Orphan releaseAs(StructSchema schema); cannam@49: template cannam@49: inline Orphan releaseAs(ListSchema schema); cannam@49: template cannam@49: inline Orphan releaseAs(InterfaceSchema schema); cannam@49: // Down-cast the orphan to a specific type. 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: _::OrphanBuilder builder; cannam@49: cannam@49: template cannam@49: friend struct _::PointerHelpers; cannam@49: friend class Orphanage; cannam@49: template cannam@49: friend class Orphan; cannam@49: friend class AnyPointer::Builder; cannam@49: }; cannam@49: cannam@49: template struct AnyTypeFor_; cannam@49: template <> struct AnyTypeFor_ { typedef AnyStruct Type; }; cannam@49: template <> struct AnyTypeFor_ { typedef AnyList Type; }; cannam@49: cannam@49: template cannam@49: using AnyTypeFor = typename AnyTypeFor_::Type; cannam@49: cannam@49: template cannam@49: inline ReaderFor>> toAny(T&& value) { cannam@49: return ReaderFor>>( cannam@49: _::PointerHelpers>::getInternalReader(value)); cannam@49: } cannam@49: template cannam@49: inline BuilderFor>> toAny(T&& value) { cannam@49: return BuilderFor>>( cannam@49: _::PointerHelpers>::getInternalBuilder(kj::mv(value))); cannam@49: } cannam@49: cannam@49: template <> cannam@49: struct List { cannam@49: // Note: This cannot be used for a list of structs, since such lists are not encoded as pointer cannam@49: // lists! Use List. cannam@49: cannam@49: List() = delete; cannam@49: cannam@49: class Reader { cannam@49: public: cannam@49: typedef List Reads; cannam@49: cannam@49: inline Reader(): reader(ElementSize::POINTER) {} cannam@49: inline explicit Reader(_::ListReader reader): reader(reader) {} cannam@49: cannam@49: inline uint size() const { return reader.size() / ELEMENTS; } cannam@49: inline AnyPointer::Reader operator[](uint index) const { cannam@49: KJ_IREQUIRE(index < size()); cannam@49: return AnyPointer::Reader(reader.getPointerElement(index * ELEMENTS)); cannam@49: } 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: _::ListReader reader; cannam@49: template cannam@49: friend struct _::PointerHelpers; cannam@49: template cannam@49: friend struct List; cannam@49: friend class Orphanage; cannam@49: template cannam@49: friend struct ToDynamic_; cannam@49: }; cannam@49: cannam@49: class Builder { cannam@49: public: cannam@49: typedef List Builds; cannam@49: cannam@49: Builder() = delete; cannam@49: inline Builder(decltype(nullptr)): builder(ElementSize::POINTER) {} cannam@49: inline explicit Builder(_::ListBuilder builder): builder(builder) {} cannam@49: cannam@49: inline operator Reader() const { return Reader(builder.asReader()); } cannam@49: inline Reader asReader() const { return Reader(builder.asReader()); } cannam@49: cannam@49: inline uint size() const { return builder.size() / ELEMENTS; } cannam@49: inline AnyPointer::Builder operator[](uint index) { cannam@49: KJ_IREQUIRE(index < size()); cannam@49: return AnyPointer::Builder(builder.getPointerElement(index * ELEMENTS)); cannam@49: } 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: private: cannam@49: _::ListBuilder builder; cannam@49: template cannam@49: friend struct _::PointerHelpers; cannam@49: friend class Orphanage; cannam@49: template cannam@49: friend struct ToDynamic_; cannam@49: }; cannam@49: }; cannam@49: cannam@49: class AnyStruct::Reader { cannam@49: public: cannam@49: typedef AnyStruct Reads; cannam@49: cannam@49: Reader() = default; cannam@49: inline Reader(_::StructReader reader): _reader(reader) {} cannam@49: cannam@49: template ) == Kind::STRUCT>> cannam@49: inline Reader(T&& value) cannam@49: : _reader(_::PointerHelpers>::getInternalReader(kj::fwd(value))) {} cannam@49: cannam@49: kj::ArrayPtr getDataSection() { cannam@49: return _reader.getDataSectionAsBlob(); cannam@49: } cannam@49: List::Reader getPointerSection() { cannam@49: return List::Reader(_reader.getPointerSectionAsList()); cannam@49: } cannam@49: cannam@49: kj::Array canonicalize() { cannam@49: return _reader.canonicalize(); cannam@49: } cannam@49: cannam@49: Equality equals(AnyStruct::Reader right); cannam@49: bool operator==(AnyStruct::Reader right); cannam@49: inline bool operator!=(AnyStruct::Reader right) { cannam@49: return !(*this == right); cannam@49: } cannam@49: cannam@49: template cannam@49: ReaderFor as() const { cannam@49: // T must be a struct type. cannam@49: return typename T::Reader(_reader); cannam@49: } cannam@49: private: cannam@49: _::StructReader _reader; cannam@49: cannam@49: template cannam@49: friend struct _::PointerHelpers; cannam@49: friend class Orphanage; cannam@49: }; cannam@49: cannam@49: class AnyStruct::Builder { cannam@49: public: cannam@49: typedef AnyStruct Builds; cannam@49: cannam@49: inline Builder(decltype(nullptr)) {} cannam@49: inline Builder(_::StructBuilder builder): _builder(builder) {} cannam@49: cannam@49: #if !_MSC_VER // TODO(msvc): MSVC ICEs on this. Try restoring when compiler improves. cannam@49: template ) == Kind::STRUCT>> cannam@49: inline Builder(T&& value) cannam@49: : _builder(_::PointerHelpers>::getInternalBuilder(kj::fwd(value))) {} cannam@49: #endif cannam@49: cannam@49: inline kj::ArrayPtr getDataSection() { cannam@49: return _builder.getDataSectionAsBlob(); cannam@49: } cannam@49: List::Builder getPointerSection() { cannam@49: return List::Builder(_builder.getPointerSectionAsList()); cannam@49: } cannam@49: cannam@49: inline Equality equals(AnyStruct::Reader right) { cannam@49: return asReader().equals(right); cannam@49: } cannam@49: inline bool operator==(AnyStruct::Reader right) { cannam@49: return asReader() == right; cannam@49: } cannam@49: inline bool operator!=(AnyStruct::Reader right) { cannam@49: return !(*this == right); cannam@49: } cannam@49: cannam@49: inline operator Reader() const { return Reader(_builder.asReader()); } cannam@49: inline Reader asReader() const { return Reader(_builder.asReader()); } cannam@49: cannam@49: template cannam@49: BuilderFor as() { cannam@49: // T must be a struct type. cannam@49: return typename T::Builder(_builder); cannam@49: } cannam@49: private: cannam@49: _::StructBuilder _builder; cannam@49: friend class Orphanage; cannam@49: friend class CapBuilderContext; cannam@49: }; cannam@49: cannam@49: #if !CAPNP_LITE cannam@49: class AnyStruct::Pipeline { cannam@49: public: cannam@49: inline Pipeline(decltype(nullptr)): typeless(nullptr) {} cannam@49: inline explicit Pipeline(AnyPointer::Pipeline&& typeless) cannam@49: : typeless(kj::mv(typeless)) {} cannam@49: cannam@49: inline AnyPointer::Pipeline getPointerField(uint16_t pointerIndex) { cannam@49: // Return a new Promise representing a sub-object of the result. `pointerIndex` is the index cannam@49: // of the sub-object within the pointer section of the result (the result must be a struct). cannam@49: // cannam@49: // TODO(perf): On GCC 4.8 / Clang 3.3, use rvalue qualifiers to avoid the need for copies. cannam@49: // Also make `ops` into a Vector to optimize this. cannam@49: return typeless.getPointerField(pointerIndex); cannam@49: } cannam@49: cannam@49: private: cannam@49: AnyPointer::Pipeline typeless; cannam@49: }; cannam@49: #endif // !CAPNP_LITE cannam@49: cannam@49: class List::Reader { cannam@49: public: cannam@49: typedef List Reads; cannam@49: cannam@49: inline Reader(): reader(ElementSize::INLINE_COMPOSITE) {} cannam@49: inline explicit Reader(_::ListReader reader): reader(reader) {} cannam@49: cannam@49: inline uint size() const { return reader.size() / ELEMENTS; } cannam@49: inline AnyStruct::Reader operator[](uint index) const { cannam@49: KJ_IREQUIRE(index < size()); cannam@49: return AnyStruct::Reader(reader.getStructElement(index * ELEMENTS)); cannam@49: } 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: _::ListReader reader; cannam@49: template cannam@49: friend struct _::PointerHelpers; cannam@49: template cannam@49: friend struct List; cannam@49: friend class Orphanage; cannam@49: template cannam@49: friend struct ToDynamic_; cannam@49: }; cannam@49: cannam@49: class List::Builder { cannam@49: public: cannam@49: typedef List Builds; cannam@49: cannam@49: Builder() = delete; cannam@49: inline Builder(decltype(nullptr)): builder(ElementSize::INLINE_COMPOSITE) {} cannam@49: inline explicit Builder(_::ListBuilder builder): builder(builder) {} cannam@49: cannam@49: inline operator Reader() const { return Reader(builder.asReader()); } cannam@49: inline Reader asReader() const { return Reader(builder.asReader()); } cannam@49: cannam@49: inline uint size() const { return builder.size() / ELEMENTS; } cannam@49: inline AnyStruct::Builder operator[](uint index) { cannam@49: KJ_IREQUIRE(index < size()); cannam@49: return AnyStruct::Builder(builder.getStructElement(index * ELEMENTS)); cannam@49: } 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: private: cannam@49: _::ListBuilder builder; cannam@49: template cannam@49: friend struct _::PointerHelpers; cannam@49: friend class Orphanage; cannam@49: template cannam@49: friend struct ToDynamic_; cannam@49: }; cannam@49: cannam@49: class AnyList::Reader { cannam@49: public: cannam@49: typedef AnyList Reads; cannam@49: cannam@49: inline Reader(): _reader(ElementSize::VOID) {} cannam@49: inline Reader(_::ListReader reader): _reader(reader) {} cannam@49: cannam@49: #if !_MSC_VER // TODO(msvc): MSVC ICEs on this. Try restoring when compiler improves. cannam@49: template ) == Kind::LIST>> cannam@49: inline Reader(T&& value) cannam@49: : _reader(_::PointerHelpers>::getInternalReader(kj::fwd(value))) {} cannam@49: #endif cannam@49: cannam@49: inline ElementSize getElementSize() { return _reader.getElementSize(); } cannam@49: inline uint size() { return _reader.size() / ELEMENTS; } cannam@49: cannam@49: inline kj::ArrayPtr getRawBytes() { return _reader.asRawBytes(); } cannam@49: cannam@49: Equality equals(AnyList::Reader right); cannam@49: bool operator==(AnyList::Reader right); cannam@49: inline bool operator!=(AnyList::Reader right) { cannam@49: return !(*this == right); cannam@49: } cannam@49: cannam@49: template ReaderFor as() { cannam@49: // T must be List. cannam@49: return ReaderFor(_reader); cannam@49: } cannam@49: private: cannam@49: _::ListReader _reader; cannam@49: cannam@49: template cannam@49: friend struct _::PointerHelpers; cannam@49: friend class Orphanage; cannam@49: }; cannam@49: cannam@49: class AnyList::Builder { cannam@49: public: cannam@49: typedef AnyList Builds; cannam@49: cannam@49: inline Builder(decltype(nullptr)): _builder(ElementSize::VOID) {} cannam@49: inline Builder(_::ListBuilder builder): _builder(builder) {} cannam@49: cannam@49: #if !_MSC_VER // TODO(msvc): MSVC ICEs on this. Try restoring when compiler improves. cannam@49: template ) == Kind::LIST>> cannam@49: inline Builder(T&& value) cannam@49: : _builder(_::PointerHelpers>::getInternalBuilder(kj::fwd(value))) {} cannam@49: #endif cannam@49: cannam@49: inline ElementSize getElementSize() { return _builder.getElementSize(); } cannam@49: inline uint size() { return _builder.size() / ELEMENTS; } cannam@49: cannam@49: Equality equals(AnyList::Reader right); cannam@49: inline bool operator==(AnyList::Reader right) { cannam@49: return asReader() == right; cannam@49: } cannam@49: inline bool operator!=(AnyList::Reader right) { cannam@49: return !(*this == right); cannam@49: } cannam@49: cannam@49: template BuilderFor as() { cannam@49: // T must be List. cannam@49: return BuilderFor(_builder); cannam@49: } cannam@49: cannam@49: inline operator Reader() const { return Reader(_builder.asReader()); } cannam@49: inline Reader asReader() const { return Reader(_builder.asReader()); } cannam@49: cannam@49: private: cannam@49: _::ListBuilder _builder; cannam@49: cannam@49: friend class Orphanage; cannam@49: }; cannam@49: cannam@49: // ======================================================================================= cannam@49: // Pipeline helpers cannam@49: // cannam@49: // These relate to capabilities, but we don't declare them in capability.h because generated code cannam@49: // for structs needs to know about these, even in files that contain no interfaces. cannam@49: cannam@49: #if !CAPNP_LITE cannam@49: cannam@49: struct PipelineOp { cannam@49: // Corresponds to rpc.capnp's PromisedAnswer.Op. cannam@49: cannam@49: enum Type { cannam@49: NOOP, // for convenience cannam@49: cannam@49: GET_POINTER_FIELD cannam@49: cannam@49: // There may be other types in the future... cannam@49: }; cannam@49: cannam@49: Type type; cannam@49: union { cannam@49: uint16_t pointerIndex; // for GET_POINTER_FIELD cannam@49: }; cannam@49: }; cannam@49: cannam@49: class PipelineHook { cannam@49: // Represents a currently-running call, and implements pipelined requests on its result. cannam@49: cannam@49: public: cannam@49: virtual kj::Own addRef() = 0; cannam@49: // Increment this object's reference count. cannam@49: cannam@49: virtual kj::Own getPipelinedCap(kj::ArrayPtr ops) = 0; cannam@49: // Extract a promised Capability from the results. cannam@49: cannam@49: virtual kj::Own getPipelinedCap(kj::Array&& ops); cannam@49: // Version of getPipelinedCap() passing the array by move. May avoid a copy in some cases. cannam@49: // Default implementation just calls the other version. cannam@49: cannam@49: template > cannam@49: static inline kj::Own from(Pipeline&& pipeline); cannam@49: cannam@49: private: cannam@49: template struct FromImpl; cannam@49: }; cannam@49: cannam@49: #endif // !CAPNP_LITE cannam@49: cannam@49: // ======================================================================================= cannam@49: // Inline implementation details cannam@49: cannam@49: inline MessageSize AnyPointer::Reader::targetSize() const { cannam@49: return reader.targetSize().asPublic(); cannam@49: } cannam@49: cannam@49: inline PointerType AnyPointer::Reader::getPointerType() const { cannam@49: return reader.getPointerType(); cannam@49: } cannam@49: cannam@49: template cannam@49: inline ReaderFor AnyPointer::Reader::getAs() const { cannam@49: return _::PointerHelpers::get(reader); cannam@49: } cannam@49: cannam@49: inline MessageSize AnyPointer::Builder::targetSize() const { cannam@49: return asReader().targetSize(); cannam@49: } cannam@49: cannam@49: inline PointerType AnyPointer::Builder::getPointerType() { cannam@49: return builder.getPointerType(); cannam@49: } cannam@49: cannam@49: inline void AnyPointer::Builder::clear() { cannam@49: return builder.clear(); cannam@49: } cannam@49: cannam@49: template cannam@49: inline BuilderFor AnyPointer::Builder::getAs() { cannam@49: return _::PointerHelpers::get(builder); cannam@49: } cannam@49: cannam@49: template cannam@49: inline BuilderFor AnyPointer::Builder::initAs() { cannam@49: return _::PointerHelpers::init(builder); cannam@49: } cannam@49: cannam@49: template cannam@49: inline BuilderFor AnyPointer::Builder::initAs(uint elementCount) { cannam@49: return _::PointerHelpers::init(builder, elementCount); cannam@49: } cannam@49: cannam@49: inline AnyList::Builder AnyPointer::Builder::initAsAnyList( cannam@49: ElementSize elementSize, uint elementCount) { cannam@49: return AnyList::Builder(builder.initList(elementSize, elementCount * ELEMENTS)); cannam@49: } cannam@49: cannam@49: inline List::Builder AnyPointer::Builder::initAsListOfAnyStruct( cannam@49: uint dataWordCount, uint pointerCount, uint elementCount) { cannam@49: return List::Builder(builder.initStructList(elementCount * ELEMENTS, cannam@49: _::StructSize(dataWordCount * WORDS, pointerCount * POINTERS))); cannam@49: } cannam@49: cannam@49: inline AnyStruct::Builder AnyPointer::Builder::initAsAnyStruct(uint dataWordCount, uint pointerCount) { cannam@49: return AnyStruct::Builder(builder.initStruct( cannam@49: _::StructSize(dataWordCount * WORDS, pointerCount * POINTERS))); cannam@49: } cannam@49: cannam@49: template cannam@49: inline void AnyPointer::Builder::setAs(ReaderFor value) { cannam@49: return _::PointerHelpers::set(builder, value); cannam@49: } cannam@49: cannam@49: template cannam@49: inline void AnyPointer::Builder::setCanonicalAs(ReaderFor value) { cannam@49: return _::PointerHelpers::setCanonical(builder, value); cannam@49: } cannam@49: cannam@49: template cannam@49: inline void AnyPointer::Builder::setAs( cannam@49: std::initializer_list>> list) { cannam@49: return _::PointerHelpers::set(builder, list); cannam@49: } cannam@49: cannam@49: template cannam@49: inline void AnyPointer::Builder::adopt(Orphan&& orphan) { cannam@49: _::PointerHelpers::adopt(builder, kj::mv(orphan)); cannam@49: } cannam@49: cannam@49: template cannam@49: inline Orphan AnyPointer::Builder::disownAs() { cannam@49: return _::PointerHelpers::disown(builder); cannam@49: } cannam@49: cannam@49: inline Orphan AnyPointer::Builder::disown() { cannam@49: return Orphan(builder.disown()); cannam@49: } cannam@49: cannam@49: template <> struct ReaderFor_ { typedef AnyPointer::Reader Type; }; cannam@49: template <> struct BuilderFor_ { typedef AnyPointer::Builder Type; }; cannam@49: template <> struct ReaderFor_ { typedef AnyStruct::Reader Type; }; cannam@49: template <> struct BuilderFor_ { typedef AnyStruct::Builder Type; }; cannam@49: cannam@49: template <> cannam@49: struct Orphanage::GetInnerReader { cannam@49: static inline _::PointerReader apply(const AnyPointer::Reader& t) { cannam@49: return t.reader; cannam@49: } cannam@49: }; cannam@49: cannam@49: template <> cannam@49: struct Orphanage::GetInnerBuilder { cannam@49: static inline _::PointerBuilder apply(AnyPointer::Builder& t) { cannam@49: return t.builder; cannam@49: } cannam@49: }; cannam@49: cannam@49: template <> cannam@49: struct Orphanage::GetInnerReader { cannam@49: static inline _::StructReader apply(const AnyStruct::Reader& t) { cannam@49: return t._reader; cannam@49: } cannam@49: }; cannam@49: cannam@49: template <> cannam@49: struct Orphanage::GetInnerBuilder { cannam@49: static inline _::StructBuilder apply(AnyStruct::Builder& t) { cannam@49: return t._builder; cannam@49: } cannam@49: }; cannam@49: cannam@49: template <> cannam@49: struct Orphanage::GetInnerReader { cannam@49: static inline _::ListReader apply(const AnyList::Reader& t) { cannam@49: return t._reader; cannam@49: } cannam@49: }; cannam@49: cannam@49: template <> cannam@49: struct Orphanage::GetInnerBuilder { cannam@49: static inline _::ListBuilder apply(AnyList::Builder& t) { cannam@49: return t._builder; cannam@49: } cannam@49: }; cannam@49: cannam@49: template cannam@49: inline BuilderFor Orphan::getAs() { cannam@49: return _::OrphanGetImpl::apply(builder); cannam@49: } cannam@49: template cannam@49: inline ReaderFor Orphan::getAsReader() const { cannam@49: return _::OrphanGetImpl::applyReader(builder); cannam@49: } cannam@49: template cannam@49: inline Orphan Orphan::releaseAs() { cannam@49: return Orphan(kj::mv(builder)); cannam@49: } cannam@49: cannam@49: // Using AnyPointer as the template type should work... cannam@49: cannam@49: template <> cannam@49: inline typename AnyPointer::Reader AnyPointer::Reader::getAs() const { cannam@49: return *this; cannam@49: } cannam@49: template <> cannam@49: inline typename AnyPointer::Builder AnyPointer::Builder::getAs() { cannam@49: return *this; cannam@49: } cannam@49: template <> cannam@49: inline typename AnyPointer::Builder AnyPointer::Builder::initAs() { cannam@49: clear(); cannam@49: return *this; cannam@49: } cannam@49: template <> cannam@49: inline void AnyPointer::Builder::setAs(AnyPointer::Reader value) { cannam@49: return builder.copyFrom(value.reader); cannam@49: } cannam@49: template <> cannam@49: inline void AnyPointer::Builder::adopt(Orphan&& orphan) { cannam@49: builder.adopt(kj::mv(orphan.builder)); cannam@49: } cannam@49: template <> cannam@49: inline Orphan AnyPointer::Builder::disownAs() { cannam@49: return Orphan(builder.disown()); cannam@49: } cannam@49: template <> cannam@49: inline Orphan Orphan::releaseAs() { cannam@49: return kj::mv(*this); cannam@49: } cannam@49: cannam@49: namespace _ { // private cannam@49: cannam@49: // Specialize PointerHelpers for AnyPointer. cannam@49: cannam@49: template <> cannam@49: struct PointerHelpers { cannam@49: static inline AnyPointer::Reader get(PointerReader reader, cannam@49: const void* defaultValue = nullptr, cannam@49: uint defaultBytes = 0) { cannam@49: return AnyPointer::Reader(reader); cannam@49: } cannam@49: static inline AnyPointer::Builder get(PointerBuilder builder, cannam@49: const void* defaultValue = nullptr, cannam@49: uint defaultBytes = 0) { cannam@49: return AnyPointer::Builder(builder); cannam@49: } cannam@49: static inline void set(PointerBuilder builder, AnyPointer::Reader value) { cannam@49: AnyPointer::Builder(builder).set(value); cannam@49: } 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) { cannam@49: return Orphan(builder.disown()); cannam@49: } cannam@49: static inline _::PointerReader getInternalReader(const AnyPointer::Reader& reader) { cannam@49: return reader.reader; cannam@49: } cannam@49: static inline _::PointerBuilder getInternalBuilder(AnyPointer::Builder&& builder) { cannam@49: return builder.builder; cannam@49: } cannam@49: }; cannam@49: cannam@49: template <> cannam@49: struct PointerHelpers { cannam@49: static inline AnyStruct::Reader get( cannam@49: PointerReader reader, const word* defaultValue = nullptr) { cannam@49: return AnyStruct::Reader(reader.getStruct(defaultValue)); cannam@49: } cannam@49: static inline AnyStruct::Builder get( cannam@49: PointerBuilder builder, const word* defaultValue = nullptr) { cannam@49: // TODO(someday): Allow specifying the size somehow? cannam@49: return AnyStruct::Builder(builder.getStruct( cannam@49: _::StructSize(0 * WORDS, 0 * POINTERS), defaultValue)); cannam@49: } cannam@49: static inline void set(PointerBuilder builder, AnyStruct::Reader value) { cannam@49: builder.setStruct(value._reader); cannam@49: } cannam@49: static inline AnyStruct::Builder init( cannam@49: PointerBuilder builder, uint dataWordCount, uint pointerCount) { cannam@49: return AnyStruct::Builder(builder.initStruct( cannam@49: StructSize(dataWordCount * WORDS, pointerCount * POINTERS))); cannam@49: } cannam@49: cannam@49: // TODO(soon): implement these cannam@49: static void adopt(PointerBuilder builder, Orphan&& value); cannam@49: static Orphan disown(PointerBuilder builder); cannam@49: }; cannam@49: cannam@49: template <> cannam@49: struct PointerHelpers { cannam@49: static inline AnyList::Reader get( cannam@49: PointerReader reader, const word* defaultValue = nullptr) { cannam@49: return AnyList::Reader(reader.getListAnySize(defaultValue)); cannam@49: } cannam@49: static inline AnyList::Builder get( cannam@49: PointerBuilder builder, const word* defaultValue = nullptr) { cannam@49: return AnyList::Builder(builder.getListAnySize(defaultValue)); cannam@49: } cannam@49: static inline void set(PointerBuilder builder, AnyList::Reader value) { cannam@49: builder.setList(value._reader); cannam@49: } cannam@49: static inline AnyList::Builder init( cannam@49: PointerBuilder builder, ElementSize elementSize, uint elementCount) { cannam@49: return AnyList::Builder(builder.initList(elementSize, elementCount * ELEMENTS)); cannam@49: } cannam@49: static inline AnyList::Builder init( cannam@49: PointerBuilder builder, uint dataWordCount, uint pointerCount, uint elementCount) { cannam@49: return AnyList::Builder(builder.initStructList( cannam@49: elementCount * ELEMENTS, StructSize(dataWordCount * WORDS, pointerCount * POINTERS))); cannam@49: } cannam@49: cannam@49: // TODO(soon): implement these cannam@49: static void adopt(PointerBuilder builder, Orphan&& value); cannam@49: static Orphan disown(PointerBuilder builder); cannam@49: }; cannam@49: cannam@49: template <> cannam@49: struct OrphanGetImpl { cannam@49: static inline AnyStruct::Builder apply(_::OrphanBuilder& builder) { cannam@49: return AnyStruct::Builder(builder.asStruct(_::StructSize(0 * WORDS, 0 * POINTERS))); cannam@49: } cannam@49: static inline AnyStruct::Reader applyReader(const _::OrphanBuilder& builder) { cannam@49: return AnyStruct::Reader(builder.asStructReader(_::StructSize(0 * WORDS, 0 * POINTERS))); cannam@49: } cannam@49: static inline void truncateListOf(_::OrphanBuilder& builder, ElementCount size) { cannam@49: builder.truncate(size, _::StructSize(0 * WORDS, 0 * POINTERS)); cannam@49: } cannam@49: }; cannam@49: cannam@49: } // namespace _ (private) cannam@49: cannam@49: #if !CAPNP_LITE cannam@49: cannam@49: template cannam@49: struct PipelineHook::FromImpl { cannam@49: static inline kj::Own apply(typename T::Pipeline&& pipeline) { cannam@49: return from(kj::mv(pipeline._typeless)); cannam@49: } cannam@49: }; cannam@49: cannam@49: template <> cannam@49: struct PipelineHook::FromImpl { cannam@49: static inline kj::Own apply(AnyPointer::Pipeline&& pipeline) { cannam@49: return kj::mv(pipeline.hook); cannam@49: } cannam@49: }; cannam@49: cannam@49: template cannam@49: inline kj::Own PipelineHook::from(Pipeline&& pipeline) { cannam@49: return FromImpl::apply(kj::fwd(pipeline)); cannam@49: } cannam@49: cannam@49: #endif // !CAPNP_LITE cannam@49: cannam@49: } // namespace capnp cannam@49: cannam@49: #endif // CAPNP_ANY_H_