google-protobuf 3.24.4-x86_64-linux → 3.25.0.rc.1-x86_64-linux

data/lib/google/protobuf/ffi/enum_descriptor.rb

@@ -0,0 +1,161 @@
+# Protocol Buffers - Google's data interchange format
+# Copyright 2022 Google Inc.  All rights reserved.
+#
+# Use of this source code is governed by a BSD-style
+# license that can be found in the LICENSE file or at
+# https://developers.google.com/open-source/licenses/bsd
+
+module Google
+  module Protobuf
+    class EnumDescriptor
+      attr :descriptor_pool, :enum_def
+      include Enumerable
+
+      # FFI Interface methods and setup
+      extend ::FFI::DataConverter
+      native_type ::FFI::Type::POINTER
+
+      class << self
+        prepend Google::Protobuf::Internal::TypeSafety
+        include Google::Protobuf::Internal::PointerHelper
+
+        # @param value [Arena] Arena to convert to an FFI native type
+        # @param _ [Object] Unused
+        def to_native(value, _)
+          value.instance_variable_get(:@enum_def) || ::FFI::Pointer::NULL
+        end
+
+        ##
+        # @param enum_def [::FFI::Pointer] EnumDef pointer to be wrapped
+        # @param _ [Object] Unused
+        def from_native(enum_def, _)
+          return nil if enum_def.nil? or enum_def.null?
+          file_def = Google::Protobuf::FFI.get_message_file_def enum_def
+          descriptor_from_file_def(file_def, enum_def)
+        end
+      end
+
+      def self.new(*arguments, &block)
+        raise "Descriptor objects may not be created from Ruby."
+      end
+
+      def file_descriptor
+        @descriptor_pool.send(:get_file_descriptor, Google::Protobuf::FFI.get_enum_file_descriptor(self))
+      end
+
+      def name
+        Google::Protobuf::FFI.get_enum_fullname(self)
+      end
+
+      def to_s
+        inspect
+      end
+
+      def inspect
+        "#{self.class.name}: #{name}"
+      end
+
+      def lookup_name(name)
+        self.class.send(:lookup_name, self, name)
+      end
+
+      def lookup_value(number)
+        self.class.send(:lookup_value, self, number)
+      end
+
+      def each &block
+        n = Google::Protobuf::FFI.enum_value_count(self)
+        0.upto(n - 1) do |i|
+          enum_value = Google::Protobuf::FFI.enum_value_by_index(self, i)
+          yield(Google::Protobuf::FFI.enum_name(enum_value).to_sym, Google::Protobuf::FFI.enum_number(enum_value))
+        end
+        nil
+      end
+
+      def enummodule
+        if @module.nil?
+          @module = build_enum_module
+        end
+        @module
+      end
+
+      private
+
+      def initialize(enum_def, descriptor_pool)
+        @descriptor_pool = descriptor_pool
+        @enum_def = enum_def
+        @module = nil
+      end
+
+      def self.private_constructor(enum_def, descriptor_pool)
+        instance = allocate
+        instance.send(:initialize, enum_def, descriptor_pool)
+        instance
+      end
+
+      def self.lookup_value(enum_def, number)
+        enum_value = Google::Protobuf::FFI.enum_value_by_number(enum_def, number)
+        if enum_value.null?
+          nil
+        else
+          Google::Protobuf::FFI.enum_name(enum_value).to_sym
+        end
+      end
+
+      def self.lookup_name(enum_def, name)
+        enum_value = Google::Protobuf::FFI.enum_value_by_name(enum_def, name.to_s, name.size)
+        if enum_value.null?
+          nil
+        else
+          Google::Protobuf::FFI.enum_number(enum_value)
+        end
+      end
+
+      def build_enum_module
+        descriptor = self
+        dynamic_module = Module.new do
+          @descriptor = descriptor
+
+          class << self
+            attr_accessor :descriptor
+          end
+
+          def self.lookup(number)
+            descriptor.lookup_value number
+          end
+
+          def self.resolve(name)
+            descriptor.lookup_name name
+          end
+        end
+
+        self.each do |name, value|
+          if name[0] < 'A' || name[0] > 'Z'
+            if name[0] >= 'a' and name[0] <= 'z'
+              name = name[0].upcase + name[1..-1] # auto capitalize
+            else
+              warn(
+                "Enum value '#{name}' does not start with an uppercase letter " +
+                  "as is required for Ruby constants.")
+              next
+            end
+          end
+          dynamic_module.const_set(name.to_sym, value)
+        end
+        dynamic_module
+      end
+    end
+
+    class FFI
+      # EnumDescriptor
+      attach_function :get_enum_file_descriptor,  :upb_EnumDef_File,                   [EnumDescriptor], :FileDef
+      attach_function :enum_value_by_name,        :upb_EnumDef_FindValueByNameWithSize,[EnumDescriptor, :string, :size_t], :EnumValueDef
+      attach_function :enum_value_by_number,      :upb_EnumDef_FindValueByNumber,      [EnumDescriptor, :int], :EnumValueDef
+      attach_function :get_enum_fullname,         :upb_EnumDef_FullName,               [EnumDescriptor], :string
+      attach_function :enum_value_by_index,       :upb_EnumDef_Value,                  [EnumDescriptor, :int], :EnumValueDef
+      attach_function :enum_value_count,          :upb_EnumDef_ValueCount,             [EnumDescriptor], :int
+      attach_function :enum_name,                 :upb_EnumValueDef_Name,              [:EnumValueDef], :string
+      attach_function :enum_number,               :upb_EnumValueDef_Number,            [:EnumValueDef], :int
+    end
+  end
+end

data/lib/google/protobuf/ffi/ffi.rb

@@ -0,0 +1,213 @@
+# Protocol Buffers - Google's data interchange format
+# Copyright 2022 Google Inc.  All rights reserved.
+#
+# Use of this source code is governed by a BSD-style
+# license that can be found in the LICENSE file or at
+# https://developers.google.com/open-source/licenses/bsd
+
+module Google
+  module Protobuf
+    class FFI
+      extend ::FFI::Library
+      # Workaround for Bazel's use of symlinks + JRuby's __FILE__ and `caller`
+      # that resolves them.
+      if ENV['BAZEL'] == 'true'
+        ffi_lib ::FFI::Compiler::Loader.find 'protobuf_c_ffi', ENV['PWD']
+      else
+        ffi_lib ::FFI::Compiler::Loader.find 'protobuf_c_ffi'
+      end
+
+      ## Map
+      Upb_Map_Begin = -1
+
+      ## Encoding Status
+      Upb_Status_MaxMessage = 127
+      Upb_Encode_Deterministic = 1
+      Upb_Encode_SkipUnknown = 2
+
+      ## JSON Encoding options
+      # When set, emits 0/default values.  TODO: proto3 only?
+      Upb_JsonEncode_EmitDefaults = 1
+      # When set, use normal (snake_case) field names instead of JSON (camelCase) names.
+      Upb_JsonEncode_UseProtoNames = 2
+      # When set, emits enums as their integer values instead of as their names.
+      Upb_JsonEncode_FormatEnumsAsIntegers = 4
+
+      ## JSON Decoding options
+      Upb_JsonDecode_IgnoreUnknown = 1
+
+      typedef :pointer, :Array
+      typedef :pointer, :DefPool
+      typedef :pointer, :EnumValueDef
+      typedef :pointer, :ExtensionRegistry
+      typedef :pointer, :FieldDefPointer
+      typedef :pointer, :FileDef
+      typedef :pointer, :FileDescriptorProto
+      typedef :pointer, :Map
+      typedef :pointer, :Message    # Instances of a message
+      typedef :pointer, :OneofDefPointer
+      typedef :pointer, :binary_string
+      if ::FFI::Platform::ARCH == "aarch64"
+        typedef :u_int8_t, :uint8_t
+        typedef :u_int16_t, :uint16_t
+        typedef :u_int32_t, :uint32_t
+        typedef :u_int64_t, :uint64_t
+      end
+
+      FieldType = enum(
+        :double, 1,
+        :float,
+        :int64,
+        :uint64,
+        :int32,
+        :fixed64,
+        :fixed32,
+        :bool,
+        :string,
+        :group,
+        :message,
+        :bytes,
+        :uint32,
+        :enum,
+        :sfixed32,
+        :sfixed64,
+        :sint32,
+        :sint64
+      )
+
+      CType = enum(
+        :bool, 1,
+        :float,
+        :int32,
+        :uint32,
+        :enum,
+        :message,
+        :double,
+        :int64,
+        :uint64,
+        :string,
+        :bytes
+      )
+
+      Label = enum(
+        :optional, 1,
+        :required,
+        :repeated
+      )
+
+      Syntax = enum(
+        :Proto2, 2,
+        :Proto3
+      )
+
+      # All the different kind of well known type messages. For simplicity of check,
+      # number wrappers and string wrappers are grouped together. Make sure the
+      # order and merber of these groups are not changed.
+
+      WellKnown = enum(
+        :Unspecified,
+        :Any,
+        :FieldMask,
+        :Duration,
+        :Timestamp,
+        # number wrappers
+        :DoubleValue,
+        :FloatValue,
+        :Int64Value,
+        :UInt64Value,
+        :Int32Value,
+        :UInt32Value,
+        # string wrappers
+        :StringValue,
+        :BytesValue,
+        :BoolValue,
+        :Value,
+        :ListValue,
+        :Struct
+      )
+
+      DecodeStatus = enum(
+        :Ok,
+        :Malformed,         # Wire format was corrupt
+        :OutOfMemory,       # Arena alloc failed
+        :BadUtf8,           # String field had bad UTF-8
+        :MaxDepthExceeded,  # Exceeded UPB_DECODE_MAXDEPTH
+
+        # CheckRequired failed, but the parse otherwise succeeded.
+        :MissingRequired,
+      )
+
+      EncodeStatus = enum(
+        :Ok,
+        :OutOfMemory,       # Arena alloc failed
+        :MaxDepthExceeded,  # Exceeded UPB_DECODE_MAXDEPTH
+
+        # CheckRequired failed, but the parse otherwise succeeded.
+        :MissingRequired,
+      )
+
+      class StringView < ::FFI::Struct
+        layout :data, :pointer,
+               :size, :size_t
+      end
+
+      class MiniTable < ::FFI::Struct
+        layout :subs, :pointer,
+               :fields, :pointer,
+               :size, :uint16_t,
+               :field_count, :uint16_t,
+               :ext, :uint8_t,  # upb_ExtMode, declared as uint8_t so sizeof(ext) == 1
+               :dense_below, :uint8_t,
+               :table_mask, :uint8_t,
+               :required_count, :uint8_t  # Required fields have the lowest hasbits.
+        # To statically initialize the tables of variable length, we need a flexible
+        # array member, and we need to compile in gnu99 mode (constant initialization
+        # of flexible array members is a GNU extension, not in C99 unfortunately. */
+        #       _upb_FastTable_Entry fasttable[];
+      end
+
+      class Status < ::FFI::Struct
+        layout :ok, :bool,
+               :msg, [:char, Upb_Status_MaxMessage]
+
+        def initialize
+          super
+          FFI.clear self
+        end
+      end
+
+      class MessageValue < ::FFI::Union
+        layout :bool_val, :bool,
+               :float_val, :float,
+               :double_val, :double,
+               :int32_val, :int32_t,
+               :int64_val, :int64_t,
+               :uint32_val, :uint32_t,
+               :uint64_val,:uint64_t,
+               :map_val, :pointer,
+               :msg_val, :pointer,
+               :array_val,:pointer,
+               :str_val, StringView
+      end
+
+      class MutableMessageValue < ::FFI::Union
+        layout :map, :Map,
+               :msg, :Message,
+               :array, :Array
+      end
+
+      # Status
+      attach_function :clear,                 :upb_Status_Clear, [Status.by_ref], :void
+      attach_function :error_message,         :upb_Status_ErrorMessage, [Status.by_ref], :string
+
+      # Generic
+      attach_function :memcmp, [:pointer, :pointer, :size_t], :int
+      attach_function :memcpy, [:pointer, :pointer, :size_t], :int
+
+      # Alternatives to pre-processor macros
+      def self.decode_max_depth(i)
+        i << 16
+      end
+    end
+  end
+end

data/lib/google/protobuf/ffi/field_descriptor.rb

@@ -0,0 +1,309 @@
+# Protocol Buffers - Google's data interchange format
+# Copyright 2022 Google Inc.  All rights reserved.
+#
+# Use of this source code is governed by a BSD-style
+# license that can be found in the LICENSE file or at
+# https://developers.google.com/open-source/licenses/bsd
+
+module Google
+  module Protobuf
+    class FieldDescriptor
+      attr :field_def, :descriptor_pool
+
+      include Google::Protobuf::Internal::Convert
+
+      # FFI Interface methods and setup
+      extend ::FFI::DataConverter
+      native_type ::FFI::Type::POINTER
+
+      class << self
+        prepend Google::Protobuf::Internal::TypeSafety
+        include Google::Protobuf::Internal::PointerHelper
+
+        # @param value [FieldDescriptor] FieldDescriptor to convert to an FFI native type
+        # @param _ [Object] Unused
+        def to_native(value, _)
+          field_def_ptr = value.instance_variable_get(:@field_def)
+          warn "Underlying field_def was nil!" if field_def_ptr.nil?
+          raise "Underlying field_def was null!" if !field_def_ptr.nil? and field_def_ptr.null?
+          field_def_ptr
+        end
+
+        ##
+        # @param field_def [::FFI::Pointer] FieldDef pointer to be wrapped
+        # @param _ [Object] Unused
+        def from_native(field_def, _ = nil)
+          return nil if field_def.nil? or field_def.null?
+          file_def = Google::Protobuf::FFI.file_def_by_raw_field_def(field_def)
+          descriptor_from_file_def(file_def, field_def)
+        end
+      end
+
+      def self.new(*arguments, &block)
+        raise "Descriptor objects may not be created from Ruby."
+      end
+
+      def to_s
+        inspect
+      end
+
+      def inspect
+        "#{self.class.name}: #{name}"
+      end
+
+      def name
+        @name ||= Google::Protobuf::FFI.get_full_name(self)
+      end
+
+      def json_name
+        @json_name ||= Google::Protobuf::FFI.get_json_name(self)
+      end
+
+      def number
+        @number ||= Google::Protobuf::FFI.get_number(self)
+      end
+
+      def type
+        @type ||= Google::Protobuf::FFI.get_type(self)
+      end
+
+      def label
+        @label ||= Google::Protobuf::FFI::Label[Google::Protobuf::FFI.get_label(self)]
+      end
+
+      def default
+        return nil if Google::Protobuf::FFI.is_sub_message(self)
+        if Google::Protobuf::FFI.is_repeated(self)
+          message_value = Google::Protobuf::FFI::MessageValue.new
+        else
+          message_value = Google::Protobuf::FFI.get_default(self)
+        end
+        enum_def = Google::Protobuf::FFI.get_subtype_as_enum(self)
+        if enum_def.null?
+          convert_upb_to_ruby message_value, c_type
+        else
+          convert_upb_to_ruby message_value, c_type, enum_def
+        end
+      end
+
+      def submsg_name
+        if defined? @submsg_name
+          @submsg_name
+        else
+          @submsg_name = case c_type
+            when :enum
+              Google::Protobuf::FFI.get_enum_fullname Google::Protobuf::FFI.get_subtype_as_enum self
+            when :message
+              Google::Protobuf::FFI.get_message_fullname Google::Protobuf::FFI.get_subtype_as_message self
+            else
+              nil
+            end
+        end
+      end
+
+      ##
+      # Tests if this field has been set on the argument message.
+      #
+      # @param msg [Google::Protobuf::Message]
+      # @return [Object] Value of the field on this message.
+      # @raise [TypeError] If the field is not defined on this message.
+      def get(msg)
+        if msg.class.descriptor == Google::Protobuf::FFI.get_containing_message_def(self)
+          msg.send :get_field, self
+        else
+          raise TypeError.new "get method called on wrong message type"
+        end
+      end
+
+      def subtype
+        if defined? @subtype
+          @subtype
+        else
+          @subtype = case c_type
+            when :enum
+              Google::Protobuf::FFI.get_subtype_as_enum(self)
+            when :message
+              Google::Protobuf::FFI.get_subtype_as_message(self)
+            else
+              nil
+            end
+        end
+      end
+
+      ##
+      # Tests if this field has been set on the argument message.
+      #
+      # @param msg [Google::Protobuf::Message]
+      # @return [Boolean] True iff message has this field set
+      # @raise [TypeError] If this field does not exist on the message
+      # @raise [ArgumentError] If this field does not track presence
+      def has?(msg)
+        if msg.class.descriptor != Google::Protobuf::FFI.get_containing_message_def(self)
+          raise TypeError.new "has method called on wrong message type"
+        end
+        unless has_presence?
+          raise ArgumentError.new "does not track presence"
+        end
+
+        Google::Protobuf::FFI.get_message_has msg.instance_variable_get(:@msg), self
+      end
+
+      ##
+      # Tests if this field tracks presence.
+      #
+      # @return [Boolean] True iff this field tracks presence
+      def has_presence?
+        @has_presence ||= Google::Protobuf::FFI.get_has_presence(self)
+      end
+
+      # @param msg [Google::Protobuf::Message]
+      def clear(msg)
+        if msg.class.descriptor != Google::Protobuf::FFI.get_containing_message_def(self)
+          raise TypeError.new "clear method called on wrong message type"
+        end
+        Google::Protobuf::FFI.clear_message_field msg.instance_variable_get(:@msg), self
+        nil
+      end
+
+      ##
+      # call-seq:
+      #     FieldDescriptor.set(message, value)
+      #
+      # Sets the value corresponding to this field to the given value on the given
+      # message. Raises an exception if message is of the wrong type. Performs the
+      # ordinary type-checks for field setting.
+      #
+      # @param msg [Google::Protobuf::Message]
+      # @param value [Object]
+      def set(msg, value)
+        if msg.class.descriptor != Google::Protobuf::FFI.get_containing_message_def(self)
+          raise TypeError.new "set method called on wrong message type"
+        end
+        unless set_value_on_message value, msg.instance_variable_get(:@msg), msg.instance_variable_get(:@arena)
+          raise RuntimeError.new "allocation failed"
+        end
+        nil
+      end
+
+      def map?
+        @map ||= Google::Protobuf::FFI.is_map self
+      end
+
+      def repeated?
+        @repeated ||= Google::Protobuf::FFI.is_repeated self
+      end
+
+      def sub_message?
+        @sub_message ||= Google::Protobuf::FFI.is_sub_message self
+      end
+
+      def wrapper?
+        if defined? @wrapper
+          @wrapper
+        else
+          message_descriptor = Google::Protobuf::FFI.get_subtype_as_message(self)
+          @wrapper = message_descriptor.nil? ? false : message_descriptor.send(:wrapper?)
+        end
+      end
+
+      private
+
+      def initialize(field_def, descriptor_pool)
+        @field_def = field_def
+        @descriptor_pool = descriptor_pool
+      end
+
+      def self.private_constructor(field_def, descriptor_pool)
+        instance = allocate
+        instance.send(:initialize, field_def, descriptor_pool)
+        instance
+      end
+
+      # TODO Can this be added to the public API?
+      def real_containing_oneof
+        @real_containing_oneof ||= Google::Protobuf::FFI.real_containing_oneof self
+      end
+
+      # Implementation details below are subject to breaking changes without
+      # warning and are intended for use only within the gem.
+
+      ##
+      # Sets the field this FieldDescriptor represents to the given value on the given message.
+      # @param value [Object] Value to be set
+      # @param msg [::FFI::Pointer] Pointer the the upb_Message
+      # @param arena [Arena] Arena of the message that owns msg
+      def set_value_on_message(value, msg, arena, wrap: false)
+        message_to_alter = msg
+        field_def_to_set = self
+        if map?
+          raise TypeError.new "Expected map" unless value.is_a? Google::Protobuf::Map
+          message_descriptor = subtype
+
+          key_field_def = Google::Protobuf::FFI.get_field_by_number(message_descriptor, 1)
+          key_field_type = Google::Protobuf::FFI.get_type(key_field_def)
+          raise TypeError.new "Map key type does not match field's key type" unless key_field_type == value.send(:key_type)
+
+          value_field_def = Google::Protobuf::FFI.get_field_by_number(message_descriptor, 2)
+          value_field_type = Google::Protobuf::FFI.get_type(value_field_def)
+          raise TypeError.new "Map value type does not match field's value type" unless value_field_type == value.send(:value_type)
+
+          raise TypeError.new "Map value type has wrong message/enum class" unless value_field_def.subtype == value.send(:descriptor)
+
+          arena.fuse(value.send(:arena))
+          message_value = Google::Protobuf::FFI::MessageValue.new
+          message_value[:map_val] = value.send(:map_ptr)
+        elsif repeated?
+          raise TypeError.new "Expected repeated field array" unless value.is_a? RepeatedField
+          raise TypeError.new "Repeated field array has wrong message/enum class" unless value.send(:type) == type
+          arena.fuse(value.send(:arena))
+          message_value = Google::Protobuf::FFI::MessageValue.new
+          message_value[:array_val] = value.send(:array)
+        else
+          if value.nil? and (sub_message? or !real_containing_oneof.nil?)
+            Google::Protobuf::FFI.clear_message_field message_to_alter, field_def_to_set
+            return true
+          end
+          if wrap
+            value_field_def = Google::Protobuf::FFI.get_field_by_number subtype, 1
+            type_for_conversion = Google::Protobuf::FFI.get_c_type(value_field_def)
+            raise RuntimeError.new "Not expecting to get a msg or enum when unwrapping" if [:enum, :message].include? type_for_conversion
+            message_value = convert_ruby_to_upb(value, arena, type_for_conversion, nil)
+            message_to_alter = Google::Protobuf::FFI.get_mutable_message(msg, self, arena)[:msg]
+            field_def_to_set = value_field_def
+          else
+            message_value = convert_ruby_to_upb(value, arena, c_type, subtype)
+          end
+        end
+        Google::Protobuf::FFI.set_message_field message_to_alter, field_def_to_set, message_value, arena
+      end
+
+      def c_type
+        @c_type ||= Google::Protobuf::FFI.get_c_type(self)
+      end
+    end
+
+    class FFI
+      # MessageDef
+      attach_function :get_field_by_index,   :upb_MessageDef_Field,                  [Descriptor, :int], FieldDescriptor
+      attach_function :get_field_by_name,    :upb_MessageDef_FindFieldByNameWithSize,[Descriptor, :string, :size_t], FieldDescriptor
+      attach_function :get_field_by_number,  :upb_MessageDef_FindFieldByNumber,      [Descriptor, :uint32_t], FieldDescriptor
+
+      # FieldDescriptor
+      attach_function :get_containing_message_def, :upb_FieldDef_ContainingType,     [FieldDescriptor], Descriptor
+      attach_function :get_c_type,                 :upb_FieldDef_CType,              [FieldDescriptor], CType
+      attach_function :get_default,                :upb_FieldDef_Default,            [FieldDescriptor], MessageValue.by_value
+      attach_function :get_subtype_as_enum,        :upb_FieldDef_EnumSubDef,         [FieldDescriptor], EnumDescriptor
+      attach_function :get_has_presence,           :upb_FieldDef_HasPresence,        [FieldDescriptor], :bool
+      attach_function :is_map,                     :upb_FieldDef_IsMap,              [FieldDescriptor], :bool
+      attach_function :is_repeated,                :upb_FieldDef_IsRepeated,         [FieldDescriptor], :bool
+      attach_function :is_sub_message,             :upb_FieldDef_IsSubMessage,       [FieldDescriptor], :bool
+      attach_function :get_json_name,              :upb_FieldDef_JsonName,           [FieldDescriptor], :string
+      attach_function :get_label,                  :upb_FieldDef_Label,              [FieldDescriptor], Label
+      attach_function :get_subtype_as_message,     :upb_FieldDef_MessageSubDef,      [FieldDescriptor], Descriptor
+      attach_function :get_full_name,              :upb_FieldDef_Name,               [FieldDescriptor], :string
+      attach_function :get_number,                 :upb_FieldDef_Number,             [FieldDescriptor], :uint32_t
+      attach_function :get_type,                   :upb_FieldDef_Type,               [FieldDescriptor], FieldType
+      attach_function :file_def_by_raw_field_def,  :upb_FieldDef_File,               [:pointer], :FileDef
+    end
+  end
+end