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