#pragma once #include "port.h" #include #include #include #include #include #include #include #include #include enum class SerializeFormat { Json, MessagePack }; class Reader { public: virtual ~Reader() {} virtual SerializeFormat Format() const = 0; virtual bool IsBool() = 0; virtual bool IsNull() = 0; virtual bool IsArray() = 0; virtual bool IsInt() = 0; virtual bool IsInt64() = 0; virtual bool IsUint64() = 0; virtual bool IsDouble() = 0; virtual bool IsString() = 0; virtual void GetNull() = 0; virtual bool GetBool() = 0; virtual int GetInt() = 0; virtual uint32_t GetUint32() = 0; virtual int64_t GetInt64() = 0; virtual uint64_t GetUint64() = 0; virtual double GetDouble() = 0; virtual std::string GetString() = 0; virtual bool HasMember(const char* x) = 0; virtual std::unique_ptr operator[](const char* x) = 0; virtual void IterArray(std::function fn) = 0; virtual void DoMember(const char* name, std::function fn) = 0; }; class Writer { public: virtual ~Writer() {} virtual SerializeFormat Format() const = 0; virtual void Null() = 0; virtual void Bool(bool x) = 0; virtual void Int(int x) = 0; virtual void Uint32(uint32_t x) = 0; virtual void Int64(int64_t x) = 0; virtual void Uint64(uint64_t x) = 0; virtual void Double(double x) = 0; virtual void String(const char* x) = 0; virtual void String(const char* x, size_t len) = 0; virtual void StartArray(size_t) = 0; virtual void EndArray() = 0; virtual void StartObject() = 0; virtual void EndObject() = 0; virtual void Key(const char* name) = 0; }; struct IndexFile; #define REFLECT_MEMBER_START() \ if (!ReflectMemberStart(visitor, value)) \ return #define REFLECT_MEMBER_START1(value) \ if (!ReflectMemberStart(visitor, value)) \ return #define REFLECT_MEMBER_END() ReflectMemberEnd(visitor, value); #define REFLECT_MEMBER_END1(value) ReflectMemberEnd(visitor, value); #define REFLECT_MEMBER(name) ReflectMember(visitor, #name, value.name) #define REFLECT_MEMBER2(name, value) ReflectMember(visitor, name, value) #define MAKE_REFLECT_TYPE_PROXY(type_name) \ MAKE_REFLECT_TYPE_PROXY2(type_name, std::underlying_type::type) #define MAKE_REFLECT_TYPE_PROXY2(type, as_type) \ ATTRIBUTE_UNUSED inline void Reflect(Reader& visitor, type& value) { \ as_type value0; \ ::Reflect(visitor, value0); \ value = static_cast(value0); \ } \ ATTRIBUTE_UNUSED inline void Reflect(Writer& visitor, type& value) { \ auto value0 = static_cast(value); \ ::Reflect(visitor, value0); \ } #define _MAPPABLE_REFLECT_MEMBER(name) REFLECT_MEMBER(name); #define MAKE_REFLECT_EMPTY_STRUCT(type, ...) \ template \ void Reflect(TVisitor& visitor, type& value) { \ REFLECT_MEMBER_START(); \ REFLECT_MEMBER_END(); \ } #define MAKE_REFLECT_STRUCT(type, ...) \ template \ void Reflect(TVisitor& visitor, type& value) { \ REFLECT_MEMBER_START(); \ MACRO_MAP(_MAPPABLE_REFLECT_MEMBER, __VA_ARGS__) \ REFLECT_MEMBER_END(); \ } // clang-format off // Config has many fields, we need to support at least its number of fields. #define NUM_VA_ARGS_IMPL(_1,_2,_3,_4,_5,_6,_7,_8,_9,_10,_11,_12,_13,_14,_15,_16,_17,_18,_19,_20,_21,_22,_23,_24,_25,_26,_27,_28,_29,_30,N,...) N #define NUM_VA_ARGS(...) NUM_VA_ARGS_IMPL(__VA_ARGS__,30,29,28,27,26,25,24,23,22,21,20,19,18,17,16,15,14,13,12,11,10,9,8,7,6,5,4,3,2,1) // clang-format on #define _MAPPABLE_REFLECT_ARRAY(name) Reflect(visitor, value.name); // Reflects the struct so it is serialized as an array instead of an object. // This currently only supports writers. #define MAKE_REFLECT_STRUCT_WRITER_AS_ARRAY(type, ...) \ inline void Reflect(Writer& visitor, type& value) { \ visitor.StartArray(NUM_VA_ARGS(__VA_ARGS__)); \ MACRO_MAP(_MAPPABLE_REFLECT_ARRAY, __VA_ARGS__) \ visitor.EndArray(); \ } // API: /* template void Reflect(TVisitor& visitor, T& value) { static_assert(false, "Missing implementation"); } template void DefaultReflectMemberStart(TVisitor& visitor) { static_assert(false, "Missing implementation"); } template bool ReflectMemberStart(TVisitor& visitor, T& value) { static_assert(false, "Missing implementation"); return true; } template void ReflectMemberEnd(TVisitor& visitor, T& value) { static_assert(false, "Missing implementation"); } */ //// Elementary types void Reflect(Reader& visitor, uint8_t& value); void Reflect(Writer& visitor, uint8_t& value); void Reflect(Reader& visitor, int16_t& value); void Reflect(Writer& visitor, int16_t& value); void Reflect(Reader& visitor, int& value); void Reflect(Writer& visitor, int& value); void Reflect(Reader& visitor, unsigned& value); void Reflect(Writer& visitor, unsigned& value); void Reflect(Reader& visitor, long& value); void Reflect(Writer& visitor, long& value); void Reflect(Reader& visitor, unsigned long& value); void Reflect(Writer& visitor, unsigned long& value); void Reflect(Reader& visitor, long long& value); void Reflect(Writer& visitor, long long& value); void Reflect(Reader& visitor, unsigned long long& value); void Reflect(Writer& visitor, unsigned long long& value); void Reflect(Reader& visitor, double& value); void Reflect(Writer& visitor, double& value); void Reflect(Reader& visitor, bool& value); void Reflect(Writer& visitor, bool& value); void Reflect(Reader& visitor, std::string& value); void Reflect(Writer& visitor, std::string& value); void Reflect(Reader& visitor, std::string_view& view); void Reflect(Writer& visitor, std::string_view& view); // std::monostate is used to represent JSON null void Reflect(Reader& visitor, std::monostate&); void Reflect(Writer& visitor, std::monostate&); void Reflect(Reader& visitor, SerializeFormat& value); void Reflect(Writer& visitor, SerializeFormat& value); //// Type constructors // ReflectMember optional is used to represent TypeScript optional properties // (in `key: value` context). // Reflect optional is used for a different purpose, whether an object is // nullable (possibly in `value` context). For the nullable semantics, // std::variant is recommended. template void Reflect(Reader& visitor, optional& value) { if (visitor.IsNull()) { visitor.GetNull(); return; } T real_value; Reflect(visitor, real_value); value = real_value; } template void Reflect(Writer& visitor, optional& value) { if (value) Reflect(visitor, *value); else visitor.Null(); } template void ReflectMember(Writer& visitor, const char* name, optional& value) { // For TypeScript optional property key?: value in the spec, // We omit both key and value if value is std::nullopt (null) for JsonWriter // to reduce output. But keep it for other serialization formats. if (value || visitor.Format() != SerializeFormat::Json) { visitor.Key(name); Reflect(visitor, value); } } // Backport C++17 std::disjunction namespace { template struct disjunction : std::conditional>::type {}; template struct disjunction : B0 {}; } // namespace // Helper struct to reflect std::variant template struct ReflectVariant { // If T appears in Ts..., we should set the value of std::variant to // what we get from Reader. template typename std::enable_if...>::value, void>::type ReflectTag(Reader& visitor, std::variant& value) { T a; Reflect(visitor, a); value = a; } // This SFINAE overload is used to prevent compile error. value = a; is not // allowed if T does not appear in Ts... template typename std::enable_if...>::value, void>::type ReflectTag(Reader&, std::variant&) {} void operator()(Reader& visitor, std::variant& value) { // Based on tag dispatch, call different ReflectTag helper. if (visitor.IsNull()) ReflectTag(visitor, value); // It is possible that IsInt64() && IsInt(). We don't call ReflectTag // if int is not in Ts... else if (disjunction...>::value && visitor.IsInt()) ReflectTag(visitor, value); else if (visitor.IsInt64()) ReflectTag(visitor, value); else if (visitor.IsString()) ReflectTag(visitor, value); else assert(0); } // Check which type the variant contains and call corresponding Reflect. void operator()(Writer& visitor, std::variant& value) { if (value.index() == N - 1) Reflect(visitor, std::get(value)); else ReflectVariant()(visitor, value); } }; // Writer reflection on std::variant recurses. This is induction basis. template struct ReflectVariant<0, Ts...> { void operator()(Writer& visitor, std::variant& value) {} }; // std::variant template void Reflect(TVisitor& visitor, std::variant& value) { ReflectVariant()(visitor, value); } // std::vector template void Reflect(Reader& visitor, std::vector& values) { visitor.IterArray([&](Reader& entry) { T entry_value; Reflect(entry, entry_value); values.push_back(entry_value); }); } template void Reflect(Writer& visitor, std::vector& values) { visitor.StartArray(values.size()); for (auto& value : values) Reflect(visitor, value); visitor.EndArray(); } // ReflectMember inline void DefaultReflectMemberStart(Writer& visitor) { visitor.StartObject(); } inline void DefaultReflectMemberStart(Reader& visitor) {} template bool ReflectMemberStart(Reader& visitor, T& value) { return true; } template bool ReflectMemberStart(Writer& visitor, T& value) { visitor.StartObject(); return true; } template void ReflectMemberEnd(Reader& visitor, T& value) {} template void ReflectMemberEnd(Writer& visitor, T& value) { visitor.EndObject(); } template void ReflectMember(Reader& visitor, const char* name, T& value) { visitor.DoMember(name, [&](Reader& child) { Reflect(child, value); }); } template void ReflectMember(Writer& visitor, const char* name, T& value) { visitor.Key(name); Reflect(visitor, value); } void ReflectMember(Writer& visitor, const char* name, std::string& value); // API std::string Serialize(SerializeFormat format, IndexFile& file); std::unique_ptr Deserialize(SerializeFormat format, const std::string& path, const std::string& serialized_index_content, const std::string& file_content, optional expected_version); void SetTestOutputMode();