cannam@148: // Copyright (c) 2013-2014 Sandstorm Development Group, Inc. and contributors
cannam@148: // Licensed under the MIT License:
cannam@148: //
cannam@148: // Permission is hereby granted, free of charge, to any person obtaining a copy
cannam@148: // of this software and associated documentation files (the "Software"), to deal
cannam@148: // in the Software without restriction, including without limitation the rights
cannam@148: // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
cannam@148: // copies of the Software, and to permit persons to whom the Software is
cannam@148: // furnished to do so, subject to the following conditions:
cannam@148: //
cannam@148: // The above copyright notice and this permission notice shall be included in
cannam@148: // all copies or substantial portions of the Software.
cannam@148: //
cannam@148: // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
cannam@148: // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
cannam@148: // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
cannam@148: // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
cannam@148: // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
cannam@148: // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
cannam@148: // THE SOFTWARE.
cannam@148: 
cannam@148: // This file is included from all generated headers.
cannam@148: 
cannam@148: #ifndef CAPNP_GENERATED_HEADER_SUPPORT_H_
cannam@148: #define CAPNP_GENERATED_HEADER_SUPPORT_H_
cannam@148: 
cannam@148: #if defined(__GNUC__) && !defined(CAPNP_HEADER_WARNINGS)
cannam@148: #pragma GCC system_header
cannam@148: #endif
cannam@148: 
cannam@148: #include "raw-schema.h"
cannam@148: #include "layout.h"
cannam@148: #include "list.h"
cannam@148: #include "orphan.h"
cannam@148: #include "pointer-helpers.h"
cannam@148: #include "any.h"
cannam@148: #include <kj/string.h>
cannam@148: #include <kj/string-tree.h>
cannam@148: 
cannam@148: namespace capnp {
cannam@148: 
cannam@148: class MessageBuilder;  // So that it can be declared a friend.
cannam@148: 
cannam@148: template <typename T, Kind k = CAPNP_KIND(T)>
cannam@148: struct ToDynamic_;   // Defined in dynamic.h, needs to be declared as everyone's friend.
cannam@148: 
cannam@148: struct DynamicStruct;  // So that it can be declared a friend.
cannam@148: 
cannam@148: struct Capability;  // To declare brandBindingFor<Capability>()
cannam@148: 
cannam@148: namespace _ {  // private
cannam@148: 
cannam@148: #if !CAPNP_LITE
cannam@148: 
cannam@148: template <typename T, typename CapnpPrivate = typename T::_capnpPrivate, bool = false>
cannam@148: inline const RawSchema& rawSchema() {
cannam@148:   return *CapnpPrivate::schema;
cannam@148: }
cannam@148: template <typename T, uint64_t id = schemas::EnumInfo<T>::typeId>
cannam@148: inline const RawSchema& rawSchema() {
cannam@148:   return *schemas::EnumInfo<T>::schema;
cannam@148: }
cannam@148: 
cannam@148: template <typename T, typename CapnpPrivate = typename T::_capnpPrivate>
cannam@148: inline const RawBrandedSchema& rawBrandedSchema() {
cannam@148:   return *CapnpPrivate::brand();
cannam@148: }
cannam@148: template <typename T, uint64_t id = schemas::EnumInfo<T>::typeId>
cannam@148: inline const RawBrandedSchema& rawBrandedSchema() {
cannam@148:   return schemas::EnumInfo<T>::schema->defaultBrand;
cannam@148: }
cannam@148: 
cannam@148: template <typename TypeTag, typename... Params>
cannam@148: struct ChooseBrand;
cannam@148: // If all of `Params` are `AnyPointer`, return the type's default brand. Otherwise, return a
cannam@148: // specific brand instance. TypeTag is the _capnpPrivate struct for the type in question.
cannam@148: 
cannam@148: template <typename TypeTag>
cannam@148: struct ChooseBrand<TypeTag> {
cannam@148:   // All params were AnyPointer. No specific brand needed.
cannam@148:   static constexpr _::RawBrandedSchema const* brand() { return &TypeTag::schema->defaultBrand; }
cannam@148: };
cannam@148: 
cannam@148: template <typename TypeTag, typename... Rest>
cannam@148: struct ChooseBrand<TypeTag, AnyPointer, Rest...>: public ChooseBrand<TypeTag, Rest...> {};
cannam@148: // The first parameter is AnyPointer, so recurse to check the rest.
cannam@148: 
cannam@148: template <typename TypeTag, typename First, typename... Rest>
cannam@148: struct ChooseBrand<TypeTag, First, Rest...> {
cannam@148:   // At least one parameter is not AnyPointer, so use the specificBrand constant.
cannam@148:   static constexpr _::RawBrandedSchema const* brand() { return &TypeTag::specificBrand; }
cannam@148: };
cannam@148: 
cannam@148: template <typename T, Kind k = kind<T>()>
cannam@148: struct BrandBindingFor_;
cannam@148: 
cannam@148: #define HANDLE_TYPE(Type, which) \
cannam@148:   template <> \
cannam@148:   struct BrandBindingFor_<Type, Kind::PRIMITIVE> { \
cannam@148:     static constexpr RawBrandedSchema::Binding get(uint16_t listDepth) { \
cannam@148:       return { which, listDepth, nullptr }; \
cannam@148:     } \
cannam@148:   }
cannam@148: HANDLE_TYPE(Void, 0);
cannam@148: HANDLE_TYPE(bool, 1);
cannam@148: HANDLE_TYPE(int8_t, 2);
cannam@148: HANDLE_TYPE(int16_t, 3);
cannam@148: HANDLE_TYPE(int32_t, 4);
cannam@148: HANDLE_TYPE(int64_t, 5);
cannam@148: HANDLE_TYPE(uint8_t, 6);
cannam@148: HANDLE_TYPE(uint16_t, 7);
cannam@148: HANDLE_TYPE(uint32_t, 8);
cannam@148: HANDLE_TYPE(uint64_t, 9);
cannam@148: HANDLE_TYPE(float, 10);
cannam@148: HANDLE_TYPE(double, 11);
cannam@148: #undef HANDLE_TYPE
cannam@148: 
cannam@148: template <>
cannam@148: struct BrandBindingFor_<Text, Kind::BLOB> {
cannam@148:   static constexpr RawBrandedSchema::Binding get(uint16_t listDepth) {
cannam@148:     return { 12, listDepth, nullptr };
cannam@148:   }
cannam@148: };
cannam@148: 
cannam@148: template <>
cannam@148: struct BrandBindingFor_<Data, Kind::BLOB> {
cannam@148:   static constexpr RawBrandedSchema::Binding get(uint16_t listDepth) {
cannam@148:     return { 13, listDepth, nullptr };
cannam@148:   }
cannam@148: };
cannam@148: 
cannam@148: template <typename T>
cannam@148: struct BrandBindingFor_<List<T>, Kind::LIST> {
cannam@148:   static constexpr RawBrandedSchema::Binding get(uint16_t listDepth) {
cannam@148:     return BrandBindingFor_<T>::get(listDepth + 1);
cannam@148:   }
cannam@148: };
cannam@148: 
cannam@148: template <typename T>
cannam@148: struct BrandBindingFor_<T, Kind::ENUM> {
cannam@148:   static constexpr RawBrandedSchema::Binding get(uint16_t listDepth) {
cannam@148:     return { 15, listDepth, nullptr };
cannam@148:   }
cannam@148: };
cannam@148: 
cannam@148: template <typename T>
cannam@148: struct BrandBindingFor_<T, Kind::STRUCT> {
cannam@148:   static constexpr RawBrandedSchema::Binding get(uint16_t listDepth) {
cannam@148:     return { 16, listDepth, T::_capnpPrivate::brand() };
cannam@148:   }
cannam@148: };
cannam@148: 
cannam@148: template <typename T>
cannam@148: struct BrandBindingFor_<T, Kind::INTERFACE> {
cannam@148:   static constexpr RawBrandedSchema::Binding get(uint16_t listDepth) {
cannam@148:     return { 17, listDepth, T::_capnpPrivate::brand() };
cannam@148:   }
cannam@148: };
cannam@148: 
cannam@148: template <>
cannam@148: struct BrandBindingFor_<AnyPointer, Kind::OTHER> {
cannam@148:   static constexpr RawBrandedSchema::Binding get(uint16_t listDepth) {
cannam@148:     return { 18, listDepth, 0, 0 };
cannam@148:   }
cannam@148: };
cannam@148: 
cannam@148: template <>
cannam@148: struct BrandBindingFor_<AnyStruct, Kind::OTHER> {
cannam@148:   static constexpr RawBrandedSchema::Binding get(uint16_t listDepth) {
cannam@148:     return { 18, listDepth, 0, 1 };
cannam@148:   }
cannam@148: };
cannam@148: 
cannam@148: template <>
cannam@148: struct BrandBindingFor_<AnyList, Kind::OTHER> {
cannam@148:   static constexpr RawBrandedSchema::Binding get(uint16_t listDepth) {
cannam@148:     return { 18, listDepth, 0, 2 };
cannam@148:   }
cannam@148: };
cannam@148: 
cannam@148: template <>
cannam@148: struct BrandBindingFor_<Capability, Kind::OTHER> {
cannam@148:   static constexpr RawBrandedSchema::Binding get(uint16_t listDepth) {
cannam@148:     return { 18, listDepth, 0, 3 };
cannam@148:   }
cannam@148: };
cannam@148: 
cannam@148: template <typename T>
cannam@148: constexpr RawBrandedSchema::Binding brandBindingFor() {
cannam@148:   return BrandBindingFor_<T>::get(0);
cannam@148: }
cannam@148: 
cannam@148: kj::StringTree structString(StructReader reader, const RawBrandedSchema& schema);
cannam@148: kj::String enumString(uint16_t value, const RawBrandedSchema& schema);
cannam@148: // Declared here so that we can declare inline stringify methods on generated types.
cannam@148: // Defined in stringify.c++, which depends on dynamic.c++, which is allowed not to be linked in.
cannam@148: 
cannam@148: template <typename T>
cannam@148: inline kj::StringTree structString(StructReader reader) {
cannam@148:   return structString(reader, rawBrandedSchema<T>());
cannam@148: }
cannam@148: template <typename T>
cannam@148: inline kj::String enumString(T value) {
cannam@148:   return enumString(static_cast<uint16_t>(value), rawBrandedSchema<T>());
cannam@148: }
cannam@148: 
cannam@148: #endif  // !CAPNP_LITE
cannam@148: 
cannam@148: // TODO(cleanup):  Unify ConstStruct and ConstList.
cannam@148: template <typename T>
cannam@148: class ConstStruct {
cannam@148: public:
cannam@148:   ConstStruct() = delete;
cannam@148:   KJ_DISALLOW_COPY(ConstStruct);
cannam@148:   inline explicit constexpr ConstStruct(const word* ptr): ptr(ptr) {}
cannam@148: 
cannam@148:   inline typename T::Reader get() const {
cannam@148:     return AnyPointer::Reader(PointerReader::getRootUnchecked(ptr)).getAs<T>();
cannam@148:   }
cannam@148: 
cannam@148:   inline operator typename T::Reader() const { return get(); }
cannam@148:   inline typename T::Reader operator*() const { return get(); }
cannam@148:   inline TemporaryPointer<typename T::Reader> operator->() const { return get(); }
cannam@148: 
cannam@148: private:
cannam@148:   const word* ptr;
cannam@148: };
cannam@148: 
cannam@148: template <typename T>
cannam@148: class ConstList {
cannam@148: public:
cannam@148:   ConstList() = delete;
cannam@148:   KJ_DISALLOW_COPY(ConstList);
cannam@148:   inline explicit constexpr ConstList(const word* ptr): ptr(ptr) {}
cannam@148: 
cannam@148:   inline typename List<T>::Reader get() const {
cannam@148:     return AnyPointer::Reader(PointerReader::getRootUnchecked(ptr)).getAs<List<T>>();
cannam@148:   }
cannam@148: 
cannam@148:   inline operator typename List<T>::Reader() const { return get(); }
cannam@148:   inline typename List<T>::Reader operator*() const { return get(); }
cannam@148:   inline TemporaryPointer<typename List<T>::Reader> operator->() const { return get(); }
cannam@148: 
cannam@148: private:
cannam@148:   const word* ptr;
cannam@148: };
cannam@148: 
cannam@148: template <size_t size>
cannam@148: class ConstText {
cannam@148: public:
cannam@148:   ConstText() = delete;
cannam@148:   KJ_DISALLOW_COPY(ConstText);
cannam@148:   inline explicit constexpr ConstText(const word* ptr): ptr(ptr) {}
cannam@148: 
cannam@148:   inline Text::Reader get() const {
cannam@148:     return Text::Reader(reinterpret_cast<const char*>(ptr), size);
cannam@148:   }
cannam@148: 
cannam@148:   inline operator Text::Reader() const { return get(); }
cannam@148:   inline Text::Reader operator*() const { return get(); }
cannam@148:   inline TemporaryPointer<Text::Reader> operator->() const { return get(); }
cannam@148: 
cannam@148:   inline kj::StringPtr toString() const {
cannam@148:     return get();
cannam@148:   }
cannam@148: 
cannam@148: private:
cannam@148:   const word* ptr;
cannam@148: };
cannam@148: 
cannam@148: template <size_t size>
cannam@148: inline kj::StringPtr KJ_STRINGIFY(const ConstText<size>& s) {
cannam@148:   return s.get();
cannam@148: }
cannam@148: 
cannam@148: template <size_t size>
cannam@148: class ConstData {
cannam@148: public:
cannam@148:   ConstData() = delete;
cannam@148:   KJ_DISALLOW_COPY(ConstData);
cannam@148:   inline explicit constexpr ConstData(const word* ptr): ptr(ptr) {}
cannam@148: 
cannam@148:   inline Data::Reader get() const {
cannam@148:     return Data::Reader(reinterpret_cast<const byte*>(ptr), size);
cannam@148:   }
cannam@148: 
cannam@148:   inline operator Data::Reader() const { return get(); }
cannam@148:   inline Data::Reader operator*() const { return get(); }
cannam@148:   inline TemporaryPointer<Data::Reader> operator->() const { return get(); }
cannam@148: 
cannam@148: private:
cannam@148:   const word* ptr;
cannam@148: };
cannam@148: 
cannam@148: template <size_t size>
cannam@148: inline auto KJ_STRINGIFY(const ConstData<size>& s) -> decltype(kj::toCharSequence(s.get())) {
cannam@148:   return kj::toCharSequence(s.get());
cannam@148: }
cannam@148: 
cannam@148: }  // namespace _ (private)
cannam@148: 
cannam@148: template <typename T, typename CapnpPrivate = typename T::_capnpPrivate>
cannam@148: inline constexpr uint64_t typeId() { return CapnpPrivate::typeId; }
cannam@148: template <typename T, uint64_t id = schemas::EnumInfo<T>::typeId>
cannam@148: inline constexpr uint64_t typeId() { return id; }
cannam@148: // typeId<MyType>() returns the type ID as defined in the schema.  Works with structs, enums, and
cannam@148: // interfaces.
cannam@148: 
cannam@148: template <typename T>
cannam@148: inline constexpr uint sizeInWords() {
cannam@148:   // Return the size, in words, of a Struct type, if allocated free-standing (not in a list).
cannam@148:   // May be useful for pre-computing space needed in order to precisely allocate messages.
cannam@148: 
cannam@148:   return unbound((upgradeBound<uint>(_::structSize<T>().data) +
cannam@148:       _::structSize<T>().pointers * WORDS_PER_POINTER) / WORDS);
cannam@148: }
cannam@148: 
cannam@148: }  // namespace capnp
cannam@148: 
cannam@148: #if _MSC_VER
cannam@148: // MSVC doesn't understand floating-point constexpr yet.
cannam@148: //
cannam@148: // TODO(msvc): Remove this hack when MSVC is fixed.
cannam@148: #define CAPNP_NON_INT_CONSTEXPR_DECL_INIT(value)
cannam@148: #define CAPNP_NON_INT_CONSTEXPR_DEF_INIT(value) = value
cannam@148: #else
cannam@148: #define CAPNP_NON_INT_CONSTEXPR_DECL_INIT(value) = value
cannam@148: #define CAPNP_NON_INT_CONSTEXPR_DEF_INIT(value)
cannam@148: #endif
cannam@148: 
cannam@148: #if _MSC_VER
cannam@148: // TODO(msvc): A little hack to allow MSVC to use C++14 return type deduction in cases where the
cannam@148: // explicit type exposes bugs in the compiler.
cannam@148: #define CAPNP_AUTO_IF_MSVC(...) auto
cannam@148: #else
cannam@148: #define CAPNP_AUTO_IF_MSVC(...) __VA_ARGS__
cannam@148: #endif
cannam@148: 
cannam@148: #if CAPNP_LITE
cannam@148: 
cannam@148: #define CAPNP_DECLARE_SCHEMA(id) \
cannam@148:     extern ::capnp::word const* const bp_##id
cannam@148: 
cannam@148: #define CAPNP_DECLARE_ENUM(type, id) \
cannam@148:     inline ::kj::String KJ_STRINGIFY(type##_##id value) { \
cannam@148:       return ::kj::str(static_cast<uint16_t>(value)); \
cannam@148:     } \
cannam@148:     template <> struct EnumInfo<type##_##id> { \
cannam@148:       struct IsEnum; \
cannam@148:       static constexpr uint64_t typeId = 0x##id; \
cannam@148:       static inline ::capnp::word const* encodedSchema() { return bp_##id; } \
cannam@148:     }
cannam@148: 
cannam@148: #if _MSC_VER
cannam@148: // TODO(msvc): MSVC dosen't expect constexprs to have definitions.
cannam@148: #define CAPNP_DEFINE_ENUM(type, id)
cannam@148: #else
cannam@148: #define CAPNP_DEFINE_ENUM(type, id) \
cannam@148:     constexpr uint64_t EnumInfo<type>::typeId
cannam@148: #endif
cannam@148: 
cannam@148: #define CAPNP_DECLARE_STRUCT_HEADER(id, dataWordSize_, pointerCount_) \
cannam@148:       struct IsStruct; \
cannam@148:       static constexpr uint64_t typeId = 0x##id; \
cannam@148:       static constexpr uint16_t dataWordSize = dataWordSize_; \
cannam@148:       static constexpr uint16_t pointerCount = pointerCount_; \
cannam@148:       static inline ::capnp::word const* encodedSchema() { return ::capnp::schemas::bp_##id; }
cannam@148: 
cannam@148: #else  // CAPNP_LITE
cannam@148: 
cannam@148: #define CAPNP_DECLARE_SCHEMA(id) \
cannam@148:     extern ::capnp::word const* const bp_##id; \
cannam@148:     extern const ::capnp::_::RawSchema s_##id
cannam@148: 
cannam@148: #define CAPNP_DECLARE_ENUM(type, id) \
cannam@148:     inline ::kj::String KJ_STRINGIFY(type##_##id value) { \
cannam@148:       return ::capnp::_::enumString(value); \
cannam@148:     } \
cannam@148:     template <> struct EnumInfo<type##_##id> { \
cannam@148:       struct IsEnum; \
cannam@148:       static constexpr uint64_t typeId = 0x##id; \
cannam@148:       static inline ::capnp::word const* encodedSchema() { return bp_##id; } \
cannam@148:       static constexpr ::capnp::_::RawSchema const* schema = &s_##id; \
cannam@148:     }
cannam@148: #define CAPNP_DEFINE_ENUM(type, id) \
cannam@148:     constexpr uint64_t EnumInfo<type>::typeId; \
cannam@148:     constexpr ::capnp::_::RawSchema const* EnumInfo<type>::schema
cannam@148: 
cannam@148: #define CAPNP_DECLARE_STRUCT_HEADER(id, dataWordSize_, pointerCount_) \
cannam@148:       struct IsStruct; \
cannam@148:       static constexpr uint64_t typeId = 0x##id; \
cannam@148:       static constexpr ::capnp::Kind kind = ::capnp::Kind::STRUCT; \
cannam@148:       static constexpr uint16_t dataWordSize = dataWordSize_; \
cannam@148:       static constexpr uint16_t pointerCount = pointerCount_; \
cannam@148:       static inline ::capnp::word const* encodedSchema() { return ::capnp::schemas::bp_##id; } \
cannam@148:       static constexpr ::capnp::_::RawSchema const* schema = &::capnp::schemas::s_##id;
cannam@148: 
cannam@148: #define CAPNP_DECLARE_INTERFACE_HEADER(id) \
cannam@148:       struct IsInterface; \
cannam@148:       static constexpr uint64_t typeId = 0x##id; \
cannam@148:       static constexpr ::capnp::Kind kind = ::capnp::Kind::INTERFACE; \
cannam@148:       static inline ::capnp::word const* encodedSchema() { return ::capnp::schemas::bp_##id; } \
cannam@148:       static constexpr ::capnp::_::RawSchema const* schema = &::capnp::schemas::s_##id;
cannam@148: 
cannam@148: #endif  // CAPNP_LITE, else
cannam@148: 
cannam@148: #endif  // CAPNP_GENERATED_HEADER_SUPPORT_H_