descriptor.h 5.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166
  1. #pragma once
  2. #include <google/protobuf/descriptor.h>
  3. #include <google/protobuf/dynamic_message.h>
  4. #include <google/protobuf/descriptor.pb.h>
  5. #include <library/cpp/protobuf/dynamic_prototype/dynamic_prototype.h>
  6. #include <util/generic/ptr.h>
  7. enum EProtoFormat {
  8. PF_PROTOBIN = 0,
  9. PF_PROTOTEXT = 1,
  10. PF_JSON = 2,
  11. };
  12. enum class EEnumFormat {
  13. Number = 0,
  14. Name = 1,
  15. FullName = 2,
  16. };
  17. enum class ERecursionTraits {
  18. //! Падать, если на входе имеется рекурсивно определённый тип.
  19. Fail = 0,
  20. //! Игнорировать все поля с рекурсивно определённым типом.
  21. Ignore = 1,
  22. //! Возвращать поля с рекурсивным типом в виде сериализованной строки
  23. Bytes = 2,
  24. };
  25. struct TProtoTypeConfig {
  26. //! Имя сообщения.
  27. TString MessageName;
  28. //! Сериализованные метаданные.
  29. TString Metadata;
  30. //! Количество байт, которые надо отступить
  31. //! от начала каждого блока данных.
  32. ui32 SkipBytes = 0;
  33. //! Формат сериализации proto-сообщений.
  34. EProtoFormat ProtoFormat = PF_PROTOBIN;
  35. //! Формат представление значений Enum.
  36. EEnumFormat EnumFormat = EEnumFormat::Number;
  37. //! Способ интерпретации рекурсивно определённых типов.
  38. ERecursionTraits Recursion = ERecursionTraits::Fail;
  39. //! Выдать бинарными строками, если SERIALIZATION_PROTOBUF.
  40. //! Если SERIALIZATION_YT, то для рекурсивных структур поведение зависит от Recursion.
  41. bool YtMode = false;
  42. //! Заворачивать ли списочные типы в Optional.
  43. bool OptionalLists = false;
  44. //! Заполнять ли пустые Optional типы дефолтным значением (только для proto3).
  45. bool SyntaxAware = false;
  46. //! Использовать ли детерминированную сериализацию
  47. bool Deterministic = false;
  48. };
  49. struct TProtoTypeConfigOptions {
  50. //! Количество байт, которые надо отступить
  51. //! от начала каждого блока данных.
  52. ui32 SkipBytes = 0;
  53. //! Формат сериализации proto-сообщений.
  54. EProtoFormat ProtoFormat = PF_PROTOBIN;
  55. //! Формат представление значений Enum.
  56. EEnumFormat EnumFormat = EEnumFormat::Number;
  57. //! Способ интерпретации рекурсивно определённых типов.
  58. ERecursionTraits Recursion = ERecursionTraits::Fail;
  59. //! Выдать бинарными строками, если SERIALIZATION_PROTOBUF.
  60. //! Если SERIALIZATION_YT, то для рекурсивных структур поведение зависит от Recursion.
  61. bool YtMode = false;
  62. //! Заворачивать ли списочные типы в Optional.
  63. bool OptionalLists = false;
  64. //! Заполнять ли пустые Optional типы дефолтным значением (только для proto3).
  65. bool SyntaxAware = false;
  66. //! Использовать ли детерминированную сериализацию
  67. bool Deterministic = false;
  68. TProtoTypeConfigOptions& SetProtoFormat(EProtoFormat value) {
  69. ProtoFormat = value;
  70. return *this;
  71. }
  72. TProtoTypeConfigOptions& SetSkipBytes(ui32 value) {
  73. SkipBytes = value;
  74. return *this;
  75. }
  76. TProtoTypeConfigOptions& SetEnumFormat(EEnumFormat value) {
  77. EnumFormat = value;
  78. return *this;
  79. }
  80. TProtoTypeConfigOptions& SetRecursionTraits(ERecursionTraits value) {
  81. Recursion = value;
  82. return *this;
  83. }
  84. TProtoTypeConfigOptions& SetYtMode(bool value) {
  85. YtMode = value;
  86. return *this;
  87. }
  88. TProtoTypeConfigOptions& SetOptionalLists(bool value) {
  89. OptionalLists = value;
  90. return *this;
  91. }
  92. TProtoTypeConfigOptions& SetSyntaxAware(bool value) {
  93. SyntaxAware = value;
  94. return *this;
  95. }
  96. };
  97. TString GenerateProtobufTypeConfig(
  98. const NProtoBuf::Descriptor* descriptor,
  99. const TProtoTypeConfigOptions& options = TProtoTypeConfigOptions());
  100. template <typename T>
  101. inline TString GenerateProtobufTypeConfig(
  102. const TProtoTypeConfigOptions& options = TProtoTypeConfigOptions()) {
  103. return GenerateProtobufTypeConfig(T::descriptor(), options);
  104. }
  105. TProtoTypeConfig ParseTypeConfig(const TStringBuf& config);
  106. using TDynamicInfoRef = TIntrusivePtr<class TDynamicInfo>;
  107. class TDynamicInfo: public TSimpleRefCount<TDynamicInfo> {
  108. public:
  109. TDynamicInfo(TDynamicPrototypePtr);
  110. ~TDynamicInfo();
  111. static TDynamicInfoRef Create(const TStringBuf& typeConfig);
  112. const NProtoBuf::Descriptor* Descriptor() const;
  113. //! Текущий формат представление значений Enum.
  114. EEnumFormat GetEnumFormat() const;
  115. //! Текущий способ интерпретации рекурсивно определённых типов.
  116. ERecursionTraits GetRecursionTraits() const;
  117. bool GetYtMode() const;
  118. bool GetOptionalLists() const;
  119. bool GetSyntaxAware() const;
  120. TAutoPtr<NProtoBuf::Message> MakeProto();
  121. //! \param data сериализованное protobuf-сообщение.
  122. TAutoPtr<NProtoBuf::Message> Parse(const TStringBuf& data);
  123. //! \param proto protobuf-сообщение.
  124. TString Serialize(const NProtoBuf::Message& proto);
  125. private:
  126. TDynamicPrototypePtr DynamicPrototype;
  127. EEnumFormat EnumFormat_;
  128. EProtoFormat ProtoFormat_;
  129. ERecursionTraits Recursion_;
  130. bool YtMode_;
  131. ui32 SkipBytes_;
  132. bool OptionalLists_;
  133. bool SyntaxAware_;
  134. bool Deterministic_;
  135. };