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_POINTER_HELPERS_H_
cannam@49: #define CAPNP_POINTER_HELPERS_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 "list.h"
cannam@49: 
cannam@49: namespace capnp {
cannam@49: namespace _ {  // private
cannam@49: 
cannam@49: // PointerHelpers is a template class that assists in wrapping/unwrapping the low-level types in
cannam@49: // layout.h with the high-level public API and generated types.  This way, the code generator
cannam@49: // and other templates do not have to specialize on each kind of pointer.
cannam@49: 
cannam@49: template <typename T>
cannam@49: struct PointerHelpers<T, Kind::STRUCT> {
cannam@49:   static inline typename T::Reader get(PointerReader reader, const word* defaultValue = nullptr) {
cannam@49:     return typename T::Reader(reader.getStruct(defaultValue));
cannam@49:   }
cannam@49:   static inline typename T::Builder get(PointerBuilder builder,
cannam@49:                                         const word* defaultValue = nullptr) {
cannam@49:     return typename T::Builder(builder.getStruct(structSize<T>(), defaultValue));
cannam@49:   }
cannam@49:   static inline void set(PointerBuilder builder, typename T::Reader value) {
cannam@49:     builder.setStruct(value._reader);
cannam@49:   }
cannam@49:   static inline void setCanonical(PointerBuilder builder, typename T::Reader value) {
cannam@49:     builder.setStruct(value._reader, true);
cannam@49:   }
cannam@49:   static inline typename T::Builder init(PointerBuilder builder) {
cannam@49:     return typename T::Builder(builder.initStruct(structSize<T>()));
cannam@49:   }
cannam@49:   static inline void adopt(PointerBuilder builder, Orphan<T>&& value) {
cannam@49:     builder.adopt(kj::mv(value.builder));
cannam@49:   }
cannam@49:   static inline Orphan<T> disown(PointerBuilder builder) {
cannam@49:     return Orphan<T>(builder.disown());
cannam@49:   }
cannam@49:   static inline _::StructReader getInternalReader(const typename T::Reader& reader) {
cannam@49:     return reader._reader;
cannam@49:   }
cannam@49:   static inline _::StructBuilder getInternalBuilder(typename T::Builder&& builder) {
cannam@49:     return builder._builder;
cannam@49:   }
cannam@49: };
cannam@49: 
cannam@49: template <typename T>
cannam@49: struct PointerHelpers<List<T>, Kind::LIST> {
cannam@49:   static inline typename List<T>::Reader get(PointerReader reader,
cannam@49:                                              const word* defaultValue = nullptr) {
cannam@49:     return typename List<T>::Reader(List<T>::getFromPointer(reader, defaultValue));
cannam@49:   }
cannam@49:   static inline typename List<T>::Builder get(PointerBuilder builder,
cannam@49:                                               const word* defaultValue = nullptr) {
cannam@49:     return typename List<T>::Builder(List<T>::getFromPointer(builder, defaultValue));
cannam@49:   }
cannam@49:   static inline void set(PointerBuilder builder, typename List<T>::Reader value) {
cannam@49:     builder.setList(value.reader);
cannam@49:   }
cannam@49:   static inline void setCanonical(PointerBuilder builder, typename List<T>::Reader value) {
cannam@49:     builder.setList(value.reader, true);
cannam@49:   }
cannam@49:   static void set(PointerBuilder builder, kj::ArrayPtr<const ReaderFor<T>> value) {
cannam@49:     auto l = init(builder, value.size());
cannam@49:     uint i = 0;
cannam@49:     for (auto& element: value) {
cannam@49:       l.set(i++, element);
cannam@49:     }
cannam@49:   }
cannam@49:   static inline typename List<T>::Builder init(PointerBuilder builder, uint size) {
cannam@49:     return typename List<T>::Builder(List<T>::initPointer(builder, size));
cannam@49:   }
cannam@49:   static inline void adopt(PointerBuilder builder, Orphan<List<T>>&& value) {
cannam@49:     builder.adopt(kj::mv(value.builder));
cannam@49:   }
cannam@49:   static inline Orphan<List<T>> disown(PointerBuilder builder) {
cannam@49:     return Orphan<List<T>>(builder.disown());
cannam@49:   }
cannam@49:   static inline _::ListReader getInternalReader(const typename List<T>::Reader& reader) {
cannam@49:     return reader.reader;
cannam@49:   }
cannam@49:   static inline _::ListBuilder getInternalBuilder(typename List<T>::Builder&& builder) {
cannam@49:     return builder.builder;
cannam@49:   }
cannam@49: };
cannam@49: 
cannam@49: template <typename T>
cannam@49: struct PointerHelpers<T, Kind::BLOB> {
cannam@49:   static inline typename T::Reader get(PointerReader reader,
cannam@49:                                        const void* defaultValue = nullptr,
cannam@49:                                        uint defaultBytes = 0) {
cannam@49:     return reader.getBlob<T>(defaultValue, defaultBytes * BYTES);
cannam@49:   }
cannam@49:   static inline typename T::Builder get(PointerBuilder builder,
cannam@49:                                         const void* defaultValue = nullptr,
cannam@49:                                         uint defaultBytes = 0) {
cannam@49:     return builder.getBlob<T>(defaultValue, defaultBytes * BYTES);
cannam@49:   }
cannam@49:   static inline void set(PointerBuilder builder, typename T::Reader value) {
cannam@49:     builder.setBlob<T>(value);
cannam@49:   }
cannam@49:   static inline void setCanonical(PointerBuilder builder, typename T::Reader value) {
cannam@49:     builder.setBlob<T>(value);
cannam@49:   }
cannam@49:   static inline typename T::Builder init(PointerBuilder builder, uint size) {
cannam@49:     return builder.initBlob<T>(size * BYTES);
cannam@49:   }
cannam@49:   static inline void adopt(PointerBuilder builder, Orphan<T>&& value) {
cannam@49:     builder.adopt(kj::mv(value.builder));
cannam@49:   }
cannam@49:   static inline Orphan<T> disown(PointerBuilder builder) {
cannam@49:     return Orphan<T>(builder.disown());
cannam@49:   }
cannam@49: };
cannam@49: 
cannam@49: struct UncheckedMessage {
cannam@49:   typedef const word* Reader;
cannam@49: };
cannam@49: 
cannam@49: template <> struct Kind_<UncheckedMessage> { static constexpr Kind kind = Kind::OTHER; };
cannam@49: 
cannam@49: template <>
cannam@49: struct PointerHelpers<UncheckedMessage> {
cannam@49:   // Reads an AnyPointer field as an unchecked message pointer.  Requires that the containing
cannam@49:   // message is itself unchecked.  This hack is currently private.  It is used to locate default
cannam@49:   // values within encoded schemas.
cannam@49: 
cannam@49:   static inline const word* get(PointerReader reader) {
cannam@49:     return reader.getUnchecked();
cannam@49:   }
cannam@49: };
cannam@49: 
cannam@49: }  // namespace _ (private)
cannam@49: }  // namespace capnp
cannam@49: 
cannam@49: #endif  // CAPNP_POINTER_HELPERS_H_