cannam@134: // Copyright (c) 2013-2014 Sandstorm Development Group, Inc. and contributors cannam@134: // Licensed under the MIT License: cannam@134: // cannam@134: // Permission is hereby granted, free of charge, to any person obtaining a copy cannam@134: // of this software and associated documentation files (the "Software"), to deal cannam@134: // in the Software without restriction, including without limitation the rights cannam@134: // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell cannam@134: // copies of the Software, and to permit persons to whom the Software is cannam@134: // furnished to do so, subject to the following conditions: cannam@134: // cannam@134: // The above copyright notice and this permission notice shall be included in cannam@134: // all copies or substantial portions of the Software. cannam@134: // cannam@134: // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR cannam@134: // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, cannam@134: // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE cannam@134: // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER cannam@134: // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, cannam@134: // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN cannam@134: // THE SOFTWARE. cannam@134: cannam@134: #ifndef CAPNP_LIST_H_ cannam@134: #define CAPNP_LIST_H_ cannam@134: cannam@134: #if defined(__GNUC__) && !defined(CAPNP_HEADER_WARNINGS) cannam@134: #pragma GCC system_header cannam@134: #endif cannam@134: cannam@134: #include "layout.h" cannam@134: #include "orphan.h" cannam@134: #include cannam@134: #ifdef KJ_STD_COMPAT cannam@134: #include cannam@134: #endif // KJ_STD_COMPAT cannam@134: cannam@134: namespace capnp { cannam@134: namespace _ { // private cannam@134: cannam@134: template cannam@134: class TemporaryPointer { cannam@134: // This class is a little hack which lets us define operator->() in cases where it needs to cannam@134: // return a pointer to a temporary value. We instead construct a TemporaryPointer and return that cannam@134: // (by value). The compiler then invokes operator->() on the TemporaryPointer, which itself is cannam@134: // able to return a real pointer to its member. cannam@134: cannam@134: public: cannam@134: TemporaryPointer(T&& value): value(kj::mv(value)) {} cannam@134: TemporaryPointer(const T& value): value(value) {} cannam@134: cannam@134: inline T* operator->() { return &value; } cannam@134: private: cannam@134: T value; cannam@134: }; cannam@134: cannam@134: template cannam@134: class IndexingIterator { cannam@134: public: cannam@134: IndexingIterator() = default; cannam@134: cannam@134: inline Element operator*() const { return (*container)[index]; } cannam@134: inline TemporaryPointer operator->() const { cannam@134: return TemporaryPointer((*container)[index]); cannam@134: } cannam@134: inline Element operator[]( int off) const { return (*container)[index]; } cannam@134: inline Element operator[](uint off) const { return (*container)[index]; } cannam@134: cannam@134: inline IndexingIterator& operator++() { ++index; return *this; } cannam@134: inline IndexingIterator operator++(int) { IndexingIterator other = *this; ++index; return other; } cannam@134: inline IndexingIterator& operator--() { --index; return *this; } cannam@134: inline IndexingIterator operator--(int) { IndexingIterator other = *this; --index; return other; } cannam@134: cannam@134: inline IndexingIterator operator+(uint amount) const { return IndexingIterator(container, index + amount); } cannam@134: inline IndexingIterator operator-(uint amount) const { return IndexingIterator(container, index - amount); } cannam@134: inline IndexingIterator operator+( int amount) const { return IndexingIterator(container, index + amount); } cannam@134: inline IndexingIterator operator-( int amount) const { return IndexingIterator(container, index - amount); } cannam@134: cannam@134: inline int operator-(const IndexingIterator& other) const { return index - other.index; } cannam@134: cannam@134: inline IndexingIterator& operator+=(uint amount) { index += amount; return *this; } cannam@134: inline IndexingIterator& operator-=(uint amount) { index -= amount; return *this; } cannam@134: inline IndexingIterator& operator+=( int amount) { index += amount; return *this; } cannam@134: inline IndexingIterator& operator-=( int amount) { index -= amount; return *this; } cannam@134: cannam@134: // STL says comparing iterators of different containers is not allowed, so we only compare cannam@134: // indices here. cannam@134: inline bool operator==(const IndexingIterator& other) const { return index == other.index; } cannam@134: inline bool operator!=(const IndexingIterator& other) const { return index != other.index; } cannam@134: inline bool operator<=(const IndexingIterator& other) const { return index <= other.index; } cannam@134: inline bool operator>=(const IndexingIterator& other) const { return index >= other.index; } cannam@134: inline bool operator< (const IndexingIterator& other) const { return index < other.index; } cannam@134: inline bool operator> (const IndexingIterator& other) const { return index > other.index; } cannam@134: cannam@134: private: cannam@134: Container* container; cannam@134: uint index; cannam@134: cannam@134: friend Container; cannam@134: inline IndexingIterator(Container* container, uint index) cannam@134: : container(container), index(index) {} cannam@134: }; cannam@134: cannam@134: } // namespace _ (private) cannam@134: cannam@134: template cannam@134: struct List { cannam@134: // List of primitives. cannam@134: cannam@134: List() = delete; cannam@134: cannam@134: class Reader { cannam@134: public: cannam@134: typedef List Reads; cannam@134: cannam@134: inline Reader(): reader(_::elementSizeForType()) {} cannam@134: inline explicit Reader(_::ListReader reader): reader(reader) {} cannam@134: cannam@134: inline uint size() const { return reader.size() / ELEMENTS; } cannam@134: inline T operator[](uint index) const { cannam@134: KJ_IREQUIRE(index < size()); cannam@134: return reader.template getDataElement(index * ELEMENTS); cannam@134: } cannam@134: cannam@134: typedef _::IndexingIterator Iterator; cannam@134: inline Iterator begin() const { return Iterator(this, 0); } cannam@134: inline Iterator end() const { return Iterator(this, size()); } cannam@134: cannam@134: private: cannam@134: _::ListReader reader; cannam@134: template cannam@134: friend struct _::PointerHelpers; cannam@134: template cannam@134: friend struct List; cannam@134: friend class Orphanage; cannam@134: template cannam@134: friend struct ToDynamic_; cannam@134: }; cannam@134: cannam@134: class Builder { cannam@134: public: cannam@134: typedef List Builds; cannam@134: cannam@134: inline Builder(): builder(_::elementSizeForType()) {} cannam@134: inline Builder(decltype(nullptr)) {} cannam@134: inline explicit Builder(_::ListBuilder builder): builder(builder) {} cannam@134: cannam@134: inline operator Reader() const { return Reader(builder.asReader()); } cannam@134: inline Reader asReader() const { return Reader(builder.asReader()); } cannam@134: cannam@134: inline uint size() const { return builder.size() / ELEMENTS; } cannam@134: inline T operator[](uint index) { cannam@134: KJ_IREQUIRE(index < size()); cannam@134: return builder.template getDataElement(index * ELEMENTS); cannam@134: } cannam@134: inline void set(uint index, T value) { cannam@134: // Alas, it is not possible to make operator[] return a reference to which you can assign, cannam@134: // since the encoded representation does not necessarily match the compiler's representation cannam@134: // of the type. We can't even return a clever class that implements operator T() and cannam@134: // operator=() because it will lead to surprising behavior when using type inference (e.g. cannam@134: // calling a template function with inferred argument types, or using "auto" or "decltype"). cannam@134: cannam@134: builder.template setDataElement(index * ELEMENTS, value); cannam@134: } cannam@134: cannam@134: typedef _::IndexingIterator Iterator; cannam@134: inline Iterator begin() { return Iterator(this, 0); } cannam@134: inline Iterator end() { return Iterator(this, size()); } cannam@134: cannam@134: private: cannam@134: _::ListBuilder builder; cannam@134: template cannam@134: friend struct _::PointerHelpers; cannam@134: friend class Orphanage; cannam@134: template cannam@134: friend struct ToDynamic_; cannam@134: }; cannam@134: cannam@134: class Pipeline {}; cannam@134: cannam@134: private: cannam@134: inline static _::ListBuilder initPointer(_::PointerBuilder builder, uint size) { cannam@134: return builder.initList(_::elementSizeForType(), size * ELEMENTS); cannam@134: } cannam@134: inline static _::ListBuilder getFromPointer(_::PointerBuilder builder, const word* defaultValue) { cannam@134: return builder.getList(_::elementSizeForType(), defaultValue); cannam@134: } cannam@134: inline static _::ListReader getFromPointer( cannam@134: const _::PointerReader& reader, const word* defaultValue) { cannam@134: return reader.getList(_::elementSizeForType(), defaultValue); cannam@134: } cannam@134: cannam@134: template cannam@134: friend struct List; cannam@134: template cannam@134: friend struct _::PointerHelpers; cannam@134: }; cannam@134: cannam@134: template cannam@134: struct List: public List {}; cannam@134: cannam@134: template cannam@134: struct List { cannam@134: // List of structs. cannam@134: cannam@134: List() = delete; cannam@134: cannam@134: class Reader { cannam@134: public: cannam@134: typedef List Reads; cannam@134: cannam@134: inline Reader(): reader(ElementSize::INLINE_COMPOSITE) {} cannam@134: inline explicit Reader(_::ListReader reader): reader(reader) {} cannam@134: cannam@134: inline uint size() const { return reader.size() / ELEMENTS; } cannam@134: inline typename T::Reader operator[](uint index) const { cannam@134: KJ_IREQUIRE(index < size()); cannam@134: return typename T::Reader(reader.getStructElement(index * ELEMENTS)); cannam@134: } cannam@134: cannam@134: typedef _::IndexingIterator Iterator; cannam@134: inline Iterator begin() const { return Iterator(this, 0); } cannam@134: inline Iterator end() const { return Iterator(this, size()); } cannam@134: cannam@134: private: cannam@134: _::ListReader reader; cannam@134: template cannam@134: friend struct _::PointerHelpers; cannam@134: template cannam@134: friend struct List; cannam@134: friend class Orphanage; cannam@134: template cannam@134: friend struct ToDynamic_; cannam@134: }; cannam@134: cannam@134: class Builder { cannam@134: public: cannam@134: typedef List Builds; cannam@134: cannam@134: inline Builder(): builder(ElementSize::INLINE_COMPOSITE) {} cannam@134: inline Builder(decltype(nullptr)) {} cannam@134: inline explicit Builder(_::ListBuilder builder): builder(builder) {} cannam@134: cannam@134: inline operator Reader() const { return Reader(builder.asReader()); } cannam@134: inline Reader asReader() const { return Reader(builder.asReader()); } cannam@134: cannam@134: inline uint size() const { return builder.size() / ELEMENTS; } cannam@134: inline typename T::Builder operator[](uint index) { cannam@134: KJ_IREQUIRE(index < size()); cannam@134: return typename T::Builder(builder.getStructElement(index * ELEMENTS)); cannam@134: } cannam@134: cannam@134: inline void adoptWithCaveats(uint index, Orphan&& orphan) { cannam@134: // Mostly behaves like you'd expect `adopt` to behave, but with two caveats originating from cannam@134: // the fact that structs in a struct list are allocated inline rather than by pointer: cannam@134: // * This actually performs a shallow copy, effectively adopting each of the orphan's cannam@134: // children rather than adopting the orphan itself. The orphan ends up being discarded, cannam@134: // possibly wasting space in the message object. cannam@134: // * If the orphan is larger than the target struct -- say, because the orphan was built cannam@134: // using a newer version of the schema that has additional fields -- it will be truncated, cannam@134: // losing data. cannam@134: cannam@134: KJ_IREQUIRE(index < size()); cannam@134: cannam@134: // We pass a zero-valued StructSize to asStruct() because we do not want the struct to be cannam@134: // expanded under any circumstances. We're just going to throw it away anyway, and cannam@134: // transferContentFrom() already carefully compares the struct sizes before transferring. cannam@134: builder.getStructElement(index * ELEMENTS).transferContentFrom( cannam@134: orphan.builder.asStruct(_::StructSize(0 * WORDS, 0 * POINTERS))); cannam@134: } cannam@134: inline void setWithCaveats(uint index, const typename T::Reader& reader) { cannam@134: // Mostly behaves like you'd expect `set` to behave, but with a caveat originating from cannam@134: // the fact that structs in a struct list are allocated inline rather than by pointer: cannam@134: // If the source struct is larger than the target struct -- say, because the source was built cannam@134: // using a newer version of the schema that has additional fields -- it will be truncated, cannam@134: // losing data. cannam@134: // cannam@134: // Note: If you are trying to concatenate some lists, use Orphanage::newOrphanConcat() to cannam@134: // do it without losing any data in case the source lists come from a newer version of the cannam@134: // protocol. (Plus, it's easier to use anyhow.) cannam@134: cannam@134: KJ_IREQUIRE(index < size()); cannam@134: builder.getStructElement(index * ELEMENTS).copyContentFrom(reader._reader); cannam@134: } cannam@134: cannam@134: // There are no init(), set(), adopt(), or disown() methods for lists of structs because the cannam@134: // elements of the list are inlined and are initialized when the list is initialized. This cannam@134: // means that init() would be redundant, and set() would risk data loss if the input struct cannam@134: // were from a newer version of the protocol. cannam@134: cannam@134: typedef _::IndexingIterator Iterator; cannam@134: inline Iterator begin() { return Iterator(this, 0); } cannam@134: inline Iterator end() { return Iterator(this, size()); } cannam@134: cannam@134: private: cannam@134: _::ListBuilder builder; cannam@134: template cannam@134: friend struct _::PointerHelpers; cannam@134: friend class Orphanage; cannam@134: template cannam@134: friend struct ToDynamic_; cannam@134: }; cannam@134: cannam@134: class Pipeline {}; cannam@134: cannam@134: private: cannam@134: inline static _::ListBuilder initPointer(_::PointerBuilder builder, uint size) { cannam@134: return builder.initStructList(size * ELEMENTS, _::structSize()); cannam@134: } cannam@134: inline static _::ListBuilder getFromPointer(_::PointerBuilder builder, const word* defaultValue) { cannam@134: return builder.getStructList(_::structSize(), defaultValue); cannam@134: } cannam@134: inline static _::ListReader getFromPointer( cannam@134: const _::PointerReader& reader, const word* defaultValue) { cannam@134: return reader.getList(ElementSize::INLINE_COMPOSITE, defaultValue); cannam@134: } cannam@134: cannam@134: template cannam@134: friend struct List; cannam@134: template cannam@134: friend struct _::PointerHelpers; cannam@134: }; cannam@134: cannam@134: template cannam@134: struct List, Kind::LIST> { cannam@134: // List of lists. cannam@134: cannam@134: List() = delete; cannam@134: cannam@134: class Reader { cannam@134: public: cannam@134: typedef List> Reads; cannam@134: cannam@134: inline Reader(): reader(ElementSize::POINTER) {} cannam@134: inline explicit Reader(_::ListReader reader): reader(reader) {} cannam@134: cannam@134: inline uint size() const { return reader.size() / ELEMENTS; } cannam@134: inline typename List::Reader operator[](uint index) const { cannam@134: KJ_IREQUIRE(index < size()); cannam@134: return typename List::Reader( cannam@134: _::PointerHelpers>::get(reader.getPointerElement(index * ELEMENTS))); cannam@134: } cannam@134: cannam@134: typedef _::IndexingIterator::Reader> Iterator; cannam@134: inline Iterator begin() const { return Iterator(this, 0); } cannam@134: inline Iterator end() const { return Iterator(this, size()); } cannam@134: cannam@134: private: cannam@134: _::ListReader reader; cannam@134: template cannam@134: friend struct _::PointerHelpers; cannam@134: template cannam@134: friend struct List; cannam@134: friend class Orphanage; cannam@134: template cannam@134: friend struct ToDynamic_; cannam@134: }; cannam@134: cannam@134: class Builder { cannam@134: public: cannam@134: typedef List> Builds; cannam@134: cannam@134: inline Builder(): builder(ElementSize::POINTER) {} cannam@134: inline Builder(decltype(nullptr)) {} cannam@134: inline explicit Builder(_::ListBuilder builder): builder(builder) {} cannam@134: cannam@134: inline operator Reader() const { return Reader(builder.asReader()); } cannam@134: inline Reader asReader() const { return Reader(builder.asReader()); } cannam@134: cannam@134: inline uint size() const { return builder.size() / ELEMENTS; } cannam@134: inline typename List::Builder operator[](uint index) { cannam@134: KJ_IREQUIRE(index < size()); cannam@134: return typename List::Builder( cannam@134: _::PointerHelpers>::get(builder.getPointerElement(index * ELEMENTS))); cannam@134: } cannam@134: inline typename List::Builder init(uint index, uint size) { cannam@134: KJ_IREQUIRE(index < this->size()); cannam@134: return typename List::Builder( cannam@134: _::PointerHelpers>::init(builder.getPointerElement(index * ELEMENTS), size)); cannam@134: } cannam@134: inline void set(uint index, typename List::Reader value) { cannam@134: KJ_IREQUIRE(index < size()); cannam@134: builder.getPointerElement(index * ELEMENTS).setList(value.reader); cannam@134: } cannam@134: void set(uint index, std::initializer_list> value) { cannam@134: KJ_IREQUIRE(index < size()); cannam@134: auto l = init(index, value.size()); cannam@134: uint i = 0; cannam@134: for (auto& element: value) { cannam@134: l.set(i++, element); cannam@134: } cannam@134: } cannam@134: inline void adopt(uint index, Orphan&& value) { cannam@134: KJ_IREQUIRE(index < size()); cannam@134: builder.getPointerElement(index * ELEMENTS).adopt(kj::mv(value.builder)); cannam@134: } cannam@134: inline Orphan disown(uint index) { cannam@134: KJ_IREQUIRE(index < size()); cannam@134: return Orphan(builder.getPointerElement(index * ELEMENTS).disown()); cannam@134: } cannam@134: cannam@134: typedef _::IndexingIterator::Builder> Iterator; cannam@134: inline Iterator begin() { return Iterator(this, 0); } cannam@134: inline Iterator end() { return Iterator(this, size()); } cannam@134: cannam@134: private: cannam@134: _::ListBuilder builder; cannam@134: template cannam@134: friend struct _::PointerHelpers; cannam@134: friend class Orphanage; cannam@134: template cannam@134: friend struct ToDynamic_; cannam@134: }; cannam@134: cannam@134: class Pipeline {}; cannam@134: cannam@134: private: cannam@134: inline static _::ListBuilder initPointer(_::PointerBuilder builder, uint size) { cannam@134: return builder.initList(ElementSize::POINTER, size * ELEMENTS); cannam@134: } cannam@134: inline static _::ListBuilder getFromPointer(_::PointerBuilder builder, const word* defaultValue) { cannam@134: return builder.getList(ElementSize::POINTER, defaultValue); cannam@134: } cannam@134: inline static _::ListReader getFromPointer( cannam@134: const _::PointerReader& reader, const word* defaultValue) { cannam@134: return reader.getList(ElementSize::POINTER, defaultValue); cannam@134: } cannam@134: cannam@134: template cannam@134: friend struct List; cannam@134: template cannam@134: friend struct _::PointerHelpers; cannam@134: }; cannam@134: cannam@134: template cannam@134: struct List { cannam@134: List() = delete; cannam@134: cannam@134: class Reader { cannam@134: public: cannam@134: typedef List Reads; cannam@134: cannam@134: inline Reader(): reader(ElementSize::POINTER) {} cannam@134: inline explicit Reader(_::ListReader reader): reader(reader) {} cannam@134: cannam@134: inline uint size() const { return reader.size() / ELEMENTS; } cannam@134: inline typename T::Reader operator[](uint index) const { cannam@134: KJ_IREQUIRE(index < size()); cannam@134: return reader.getPointerElement(index * ELEMENTS).template getBlob(nullptr, 0 * BYTES); cannam@134: } cannam@134: cannam@134: typedef _::IndexingIterator Iterator; cannam@134: inline Iterator begin() const { return Iterator(this, 0); } cannam@134: inline Iterator end() const { return Iterator(this, size()); } cannam@134: cannam@134: private: cannam@134: _::ListReader reader; cannam@134: template cannam@134: friend struct _::PointerHelpers; cannam@134: template cannam@134: friend struct List; cannam@134: friend class Orphanage; cannam@134: template cannam@134: friend struct ToDynamic_; cannam@134: }; cannam@134: cannam@134: class Builder { cannam@134: public: cannam@134: typedef List Builds; cannam@134: cannam@134: inline Builder(): builder(ElementSize::POINTER) {} cannam@134: inline Builder(decltype(nullptr)) {} cannam@134: inline explicit Builder(_::ListBuilder builder): builder(builder) {} cannam@134: cannam@134: inline operator Reader() const { return Reader(builder.asReader()); } cannam@134: inline Reader asReader() const { return Reader(builder.asReader()); } cannam@134: cannam@134: inline uint size() const { return builder.size() / ELEMENTS; } cannam@134: inline typename T::Builder operator[](uint index) { cannam@134: KJ_IREQUIRE(index < size()); cannam@134: return builder.getPointerElement(index * ELEMENTS).template getBlob(nullptr, 0 * BYTES); cannam@134: } cannam@134: inline void set(uint index, typename T::Reader value) { cannam@134: KJ_IREQUIRE(index < size()); cannam@134: builder.getPointerElement(index * ELEMENTS).template setBlob(value); cannam@134: } cannam@134: inline typename T::Builder init(uint index, uint size) { cannam@134: KJ_IREQUIRE(index < this->size()); cannam@134: return builder.getPointerElement(index * ELEMENTS).template initBlob(size * BYTES); cannam@134: } cannam@134: inline void adopt(uint index, Orphan&& value) { cannam@134: KJ_IREQUIRE(index < size()); cannam@134: builder.getPointerElement(index * ELEMENTS).adopt(kj::mv(value.builder)); cannam@134: } cannam@134: inline Orphan disown(uint index) { cannam@134: KJ_IREQUIRE(index < size()); cannam@134: return Orphan(builder.getPointerElement(index * ELEMENTS).disown()); cannam@134: } cannam@134: cannam@134: typedef _::IndexingIterator Iterator; cannam@134: inline Iterator begin() { return Iterator(this, 0); } cannam@134: inline Iterator end() { return Iterator(this, size()); } cannam@134: cannam@134: private: cannam@134: _::ListBuilder builder; cannam@134: template cannam@134: friend struct _::PointerHelpers; cannam@134: friend class Orphanage; cannam@134: template cannam@134: friend struct ToDynamic_; cannam@134: }; cannam@134: cannam@134: class Pipeline {}; cannam@134: cannam@134: private: cannam@134: inline static _::ListBuilder initPointer(_::PointerBuilder builder, uint size) { cannam@134: return builder.initList(ElementSize::POINTER, size * ELEMENTS); cannam@134: } cannam@134: inline static _::ListBuilder getFromPointer(_::PointerBuilder builder, const word* defaultValue) { cannam@134: return builder.getList(ElementSize::POINTER, defaultValue); cannam@134: } cannam@134: inline static _::ListReader getFromPointer( cannam@134: const _::PointerReader& reader, const word* defaultValue) { cannam@134: return reader.getList(ElementSize::POINTER, defaultValue); cannam@134: } cannam@134: cannam@134: template cannam@134: friend struct List; cannam@134: template cannam@134: friend struct _::PointerHelpers; cannam@134: }; cannam@134: cannam@134: } // namespace capnp cannam@134: cannam@134: #ifdef KJ_STD_COMPAT cannam@134: namespace std { cannam@134: cannam@134: template cannam@134: struct iterator_traits> cannam@134: : public std::iterator {}; cannam@134: cannam@134: } // namespace std cannam@134: #endif // KJ_STD_COMPAT cannam@134: cannam@134: #endif // CAPNP_LIST_H_