Deprecate Descriptor Label. As an alternative, add helper methods for checking whether a field is required or repeated.

This is for PHP and Ruby.

PiperOrigin-RevId: 743308499

Author: protobuf-github-bot

php/ext/google/protobuf/def.c

@@ -390,13 +390,37 @@ PHP_METHOD(FieldDescriptor, getNumber) {
 /*
  * FieldDescriptor::getLabel()
  *
+ * DEPRECATED: Use isRequired() or isRepeated() instead.
+ *
  * Returns the label of this field as an integer.
  */
 PHP_METHOD(FieldDescriptor, getLabel) {
+  zend_error(E_USER_WARNING,
+             "getLabel is deprecated. Use isRequired or isRepeated instead.\n");
   FieldDescriptor* intern = (FieldDescriptor*)Z_OBJ_P(getThis());
   RETURN_LONG(upb_FieldDef_Label(intern->fielddef));
 }
 
+/*
+ * FieldDescriptor::isRequired()
+ *
+ * Returns true if this field is a required field.
+ */
+PHP_METHOD(FieldDescriptor, isRequired) {
+  FieldDescriptor* intern = (FieldDescriptor*)Z_OBJ_P(getThis());
+  RETURN_BOOL(upb_FieldDef_IsRequired(intern->fielddef));
+}
+
+/*
+ * FieldDescriptor::isRepeated()
+ *
+ * Returns true if this field is a repeated field.
+ */
+PHP_METHOD(FieldDescriptor, isRepeated) {
+  FieldDescriptor* intern = (FieldDescriptor*)Z_OBJ_P(getThis());
+  RETURN_BOOL(upb_FieldDef_IsRepeated(intern->fielddef));
+}
+
 /*
  * FieldDescriptor::getType()
  *
@@ -500,6 +524,8 @@ static zend_function_entry FieldDescriptor_methods[] = {
   PHP_ME(FieldDescriptor, getName,   arginfo_void, ZEND_ACC_PUBLIC)
   PHP_ME(FieldDescriptor, getNumber, arginfo_void, ZEND_ACC_PUBLIC)
   PHP_ME(FieldDescriptor, getLabel,  arginfo_void, ZEND_ACC_PUBLIC)
+  PHP_ME(FieldDescriptor, isRequired, arginfo_void, ZEND_ACC_PUBLIC)
+  PHP_ME(FieldDescriptor, isRepeated, arginfo_void, ZEND_ACC_PUBLIC)
   PHP_ME(FieldDescriptor, getType,   arginfo_void, ZEND_ACC_PUBLIC)
   PHP_ME(FieldDescriptor, isMap,     arginfo_void, ZEND_ACC_PUBLIC)
   PHP_ME(FieldDescriptor, getEnumType, arginfo_void, ZEND_ACC_PUBLIC)

php/src/Google/Protobuf/FieldDescriptor.php

@@ -44,13 +44,31 @@ public function getNumber()
     }
 
     /**
+     * @deprecated Use isRepeated() or isRequired() instead.
+     *
      * @return int
      */
     public function getLabel()
     {
         return $this->internal_desc->getLabel();
     }
 
+    /**
+     * @return boolean
+     */
+    public function isRequired()
+    {
+        return $this->internal_desc->isRequired();
+    }
+
+    /**
+     * @return boolean
+     */
+    public function isRepeated()
+    {
+        return $this->internal_desc->isRepeated();
+    }
+
     /**
      * @return int
      */

php/src/Google/Protobuf/Internal/FieldDescriptor.php

@@ -104,6 +104,11 @@ public function getLabel()
         return $this->label;
     }
 
+    public function isRequired()
+    {
+        return $this->label === GPBLabel::REQUIRED;
+    }
+
     public function isRepeated()
     {
         return $this->label === GPBLabel::REPEATED;

php/src/Google/Protobuf/Internal/Message.php

@@ -16,7 +16,6 @@
 use Google\Protobuf\Internal\CodedInputStream;
 use Google\Protobuf\Internal\CodedOutputStream;
 use Google\Protobuf\Internal\DescriptorPool;
-use Google\Protobuf\Internal\GPBLabel;
 use Google\Protobuf\Internal\GPBType;
 use Google\Protobuf\Internal\GPBWire;
 use Google\Protobuf\Internal\MapEntry;
@@ -105,7 +104,7 @@ private function initWithGeneratedPool()
                         $this->$setter($map_field);
                         break;
                 }
-            } else if ($field->getLabel() === GPBLabel::REPEATED) {
+            } else if ($field->isRepeated()) {
                 switch ($field->getType()) {
                     case GPBType::MESSAGE:
                     case GPBType::GROUP:
@@ -129,7 +128,7 @@ private function initWithGeneratedPool()
                 $oneof = $this->desc->getOneofDecl()[$field->getOneofIndex()];
                 $oneof_name = $oneof->getName();
                 $this->$oneof_name = new OneofField($oneof);
-            } else if ($field->getLabel() === GPBLabel::OPTIONAL &&
+            } else if (!$field->isRequired() && !$field->isRepeated() &&
                        PHP_INT_SIZE == 4) {
                 switch ($field->getType()) {
                     case GPBType::INT64:
@@ -557,7 +556,7 @@ public function clear()
                         $this->$setter($map_field);
                         break;
                 }
-            } else if ($field->getLabel() === GPBLabel::REPEATED) {
+            } else if ($field->isRepeated()) {
                 switch ($field->getType()) {
                     case GPBType::MESSAGE:
                     case GPBType::GROUP:
@@ -581,7 +580,7 @@ public function clear()
                 $oneof = $this->desc->getOneofDecl()[$field->getOneofIndex()];
                 $oneof_name = $oneof->getName();
                 $this->$oneof_name = new OneofField($oneof);
-            } else if ($field->getLabel() === GPBLabel::OPTIONAL) {
+            } else if (!$field->isRequired() && !$field->isRepeated()) {
                 switch ($field->getType()) {
                     case GPBType::DOUBLE   :
                     case GPBType::FLOAT    :
@@ -652,13 +651,13 @@ public function discardUnknownFields()
                 foreach ($map as $key => $value) {
                     $value->discardUnknownFields();
                 }
-            } else if ($field->getLabel() === GPBLabel::REPEATED) {
+            } else if ($field->isRepeated()) {
                 $getter = $field->getGetter();
                 $arr = $this->$getter();
                 foreach ($arr as $sub) {
                     $sub->discardUnknownFields();
                 }
-            } else if ($field->getLabel() === GPBLabel::OPTIONAL) {
+            } else if (!$field->isRequired() && !$field->isRepeated()) {
                 $getter = $field->getGetter();
                 $sub = $this->$getter();
                 if (!is_null($sub)) {
@@ -706,7 +705,7 @@ public function mergeFrom($msg)
                         }
                     }
                 }
-            } else if ($field->getLabel() === GPBLabel::REPEATED) {
+            } else if ($field->isRepeated()) {
                 if (count($msg->$getter()) != 0) {
                     foreach ($msg->$getter() as $tmp) {
                         if ($field->getType() == GPBType::MESSAGE) {
@@ -719,7 +718,7 @@ public function mergeFrom($msg)
                         }
                     }
                 }
-            } else if ($field->getLabel() === GPBLabel::OPTIONAL) {
+            } else if (!$field->isRequired() && !$field->isRepeated()) {
                 if($msg->$getter() !== $this->defaultValue($field)) {
                     $tmp = $msg->$getter();
                     if ($field->getType() == GPBType::MESSAGE) {

php/tests/DescriptorsTest.php

@@ -142,15 +142,17 @@ public function testFieldDescriptor()
         $fieldDesc = $fieldDescMap[1];
         $this->assertSame('optional_int32', $fieldDesc->getName());
         $this->assertSame(1, $fieldDesc->getNumber());
-        $this->assertSame(self::GPBLABEL_OPTIONAL, $fieldDesc->getLabel());
+        $this->assertFalse($fieldDesc->isRequired());
+        $this->assertFalse($fieldDesc->isRepeated());
         $this->assertSame(self::GPBTYPE_INT32, $fieldDesc->getType());
         $this->assertFalse($fieldDesc->isMap());
 
         // Optional enum field
         $fieldDesc = $fieldDescMap[16];
         $this->assertSame('optional_enum', $fieldDesc->getName());
         $this->assertSame(16, $fieldDesc->getNumber());
-        $this->assertSame(self::GPBLABEL_OPTIONAL, $fieldDesc->getLabel());
+        $this->assertFalse($fieldDesc->isRequired());
+        $this->assertFalse($fieldDesc->isRepeated());
         $this->assertSame(self::GPBTYPE_ENUM, $fieldDesc->getType());
         $this->assertInstanceOf('\Google\Protobuf\EnumDescriptor', $fieldDesc->getEnumType());
         $this->assertFalse($fieldDesc->isMap());
@@ -159,7 +161,8 @@ public function testFieldDescriptor()
         $fieldDesc = $fieldDescMap[17];
         $this->assertSame('optional_message', $fieldDesc->getName());
         $this->assertSame(17, $fieldDesc->getNumber());
-        $this->assertSame(self::GPBLABEL_OPTIONAL, $fieldDesc->getLabel());
+        $this->assertFalse($fieldDesc->isRequired());
+        $this->assertFalse($fieldDesc->isRepeated());
         $this->assertSame(self::GPBTYPE_MESSAGE, $fieldDesc->getType());
         $this->assertInstanceOf('\Google\Protobuf\Descriptor', $fieldDesc->getMessageType());
         $this->assertFalse($fieldDesc->isMap());
@@ -168,15 +171,15 @@ public function testFieldDescriptor()
         $fieldDesc = $fieldDescMap[31];
         $this->assertSame('repeated_int32', $fieldDesc->getName());
         $this->assertSame(31, $fieldDesc->getNumber());
-        $this->assertSame(self::GPBLABEL_REPEATED, $fieldDesc->getLabel());
+        $this->assertTrue($fieldDesc->isRepeated());
         $this->assertSame(self::GPBTYPE_INT32, $fieldDesc->getType());
         $this->assertFalse($fieldDesc->isMap());
 
         // Repeated message field
         $fieldDesc = $fieldDescMap[47];
         $this->assertSame('repeated_message', $fieldDesc->getName());
         $this->assertSame(47, $fieldDesc->getNumber());
-        $this->assertSame(self::GPBLABEL_REPEATED, $fieldDesc->getLabel());
+        $this->assertTrue($fieldDesc->isRepeated());
         $this->assertSame(self::GPBTYPE_MESSAGE, $fieldDesc->getType());
         $this->assertInstanceOf('\Google\Protobuf\Descriptor', $fieldDesc->getMessageType());
         $this->assertFalse($fieldDesc->isMap());
@@ -187,7 +190,8 @@ public function testFieldDescriptor()
         $fieldDesc = $fieldDescMap[51];
         $this->assertSame('oneof_int32', $fieldDesc->getName());
         $this->assertSame(51, $fieldDesc->getNumber());
-        $this->assertSame(self::GPBLABEL_OPTIONAL, $fieldDesc->getLabel());
+        $this->assertFalse($fieldDesc->isRequired());
+        $this->assertFalse($fieldDesc->isRepeated());
         $this->assertSame(self::GPBTYPE_INT32, $fieldDesc->getType());
         $this->assertFalse($fieldDesc->isMap());
         $this->assertSame($fieldDesc->getContainingOneof(), $fieldDesc->getRealContainingOneof());
@@ -200,7 +204,8 @@ public function testFieldDescriptor()
         $fieldDesc = $fieldDescMap[52];
         $this->assertSame('proto3_optional_int32', $fieldDesc->getName());
         $this->assertSame(52, $fieldDesc->getNumber());
-        $this->assertSame(self::GPBLABEL_OPTIONAL, $fieldDesc->getLabel());
+        $this->assertFalse($fieldDesc->isRequired());
+        $this->assertFalse($fieldDesc->isRepeated());
         $this->assertSame(self::GPBTYPE_INT32, $fieldDesc->getType());
         $this->assertFalse($fieldDesc->isMap());
         $this->assertNull($fieldDesc->getRealContainingOneof());
@@ -210,7 +215,7 @@ public function testFieldDescriptor()
         $fieldDesc = $fieldDescMap[71];
         $this->assertSame('map_int32_enum', $fieldDesc->getName());
         $this->assertSame(71, $fieldDesc->getNumber());
-        $this->assertSame(self::GPBLABEL_REPEATED, $fieldDesc->getLabel());
+        $this->assertTrue($fieldDesc->isRepeated());
         $this->assertSame(self::GPBTYPE_MESSAGE, $fieldDesc->getType());
         $this->assertTrue($fieldDesc->isMap());
         $mapDesc = $fieldDesc->getMessageType();

ruby/ext/google/protobuf_c/defs.c

@@ -798,6 +798,28 @@ static VALUE FieldDescriptor_has_presence(VALUE _self) {
   return upb_FieldDef_HasPresence(self->fielddef) ? Qtrue : Qfalse;
 }
 
+/*
+ * call-seq:
+ *     FieldDescriptor.required? => bool
+ *
+ * Returns whether this is a required field.
+ */
+static VALUE FieldDescriptor_is_required(VALUE _self) {
+  FieldDescriptor* self = ruby_to_FieldDescriptor(_self);
+  return upb_FieldDef_IsRequired(self->fielddef) ? Qtrue : Qfalse;
+}
+
+/*
+ * call-seq:
+ *     FieldDescriptor.repeated? => bool
+ *
+ * Returns whether this is a repeated field.
+ */
+static VALUE FieldDescriptor_is_repeated(VALUE _self) {
+  FieldDescriptor* self = ruby_to_FieldDescriptor(_self);
+  return upb_FieldDef_IsRepeated(self->fielddef) ? Qtrue : Qfalse;
+}
+
 /*
  * call-seq:
  *     FieldDescriptor.is_packed? => bool
@@ -823,6 +845,8 @@ static VALUE FieldDescriptor_json_name(VALUE _self) {
 }
 
 /*
+ * DEPRECATED: Use repeated? or required? instead.
+ *
  * call-seq:
  *     FieldDescriptor.label => label
  *
@@ -1038,6 +1062,8 @@ static void FieldDescriptor_register(VALUE module) {
   rb_define_method(klass, "type", FieldDescriptor__type, 0);
   rb_define_method(klass, "default", FieldDescriptor_default, 0);
   rb_define_method(klass, "has_presence?", FieldDescriptor_has_presence, 0);
+  rb_define_method(klass, "required?", FieldDescriptor_is_required, 0);
+  rb_define_method(klass, "repeated?", FieldDescriptor_is_repeated, 0);
   rb_define_method(klass, "is_packed?", FieldDescriptor_is_packed, 0);
   rb_define_method(klass, "json_name", FieldDescriptor_json_name, 0);
   rb_define_method(klass, "label", FieldDescriptor_label, 0);

ruby/ext/google/protobuf_c/message.c

@@ -398,7 +398,7 @@ static VALUE Message_field_accessor(VALUE _self, const upb_FieldDef* f,
       upb_MessageValue msgval =
           upb_Message_GetFieldByDef(Message_Get(_self, NULL), f);
 
-      if (upb_FieldDef_Label(f) == kUpb_Label_Repeated) {
+      if (upb_FieldDef_IsRepeated(f)) {
         // Map repeated fields to a new type with ints
         VALUE arr = rb_ary_new();
         size_t i, n = upb_Array_Size(msgval.array_val);
@@ -592,7 +592,7 @@ static void Message_InitFieldFromValue(upb_Message* msg, const upb_FieldDef* f,
   if (upb_FieldDef_IsMap(f)) {
     upb_Map* map = upb_Message_Mutable(msg, f, arena).map;
     Map_InitFromValue(map, f, val, arena);
-  } else if (upb_FieldDef_Label(f) == kUpb_Label_Repeated) {
+  } else if (upb_FieldDef_IsRepeated(f)) {
     upb_Array* arr = upb_Message_Mutable(msg, f, arena).array;
     RepeatedField_InitFromValue(arr, f, val, arena);
   } else if (upb_FieldDef_IsSubMessage(f)) {

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

@@ -67,6 +67,7 @@ def type
         @type ||= Google::Protobuf::FFI.get_type(self)
       end
 
+      # DEPRECATED: Use required? or repeated? instead.
       def label
         @label ||= Google::Protobuf::FFI.get_label(self)
       end
@@ -197,6 +198,10 @@ def map?
         @map ||= Google::Protobuf::FFI.is_map self
       end
 
+      def required?
+        @required ||= Google::Protobuf::FFI.is_required self
+      end
+
       def repeated?
         @repeated ||= Google::Protobuf::FFI.is_repeated self
       end
@@ -325,6 +330,7 @@ class FFI
       attach_function :get_has_presence,           :upb_FieldDef_HasPresence,           [FieldDescriptor], :bool
       attach_function :get_is_packed,              :upb_FieldDef_IsPacked,              [FieldDescriptor], :bool
       attach_function :is_map,                     :upb_FieldDef_IsMap,                 [FieldDescriptor], :bool
+      attach_function :is_required,                :upb_FieldDef_IsRequired,            [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

upb/reflection/field_def.h

@@ -52,7 +52,7 @@ bool upb_FieldDef_IsOptional(const upb_FieldDef* f);
 UPB_API bool upb_FieldDef_IsPacked(const upb_FieldDef* f);
 bool upb_FieldDef_IsPrimitive(const upb_FieldDef* f);
 UPB_API bool upb_FieldDef_IsRepeated(const upb_FieldDef* f);
-bool upb_FieldDef_IsRequired(const upb_FieldDef* f);
+UPB_API bool upb_FieldDef_IsRequired(const upb_FieldDef* f);
 bool upb_FieldDef_IsString(const upb_FieldDef* f);
 UPB_API bool upb_FieldDef_IsSubMessage(const upb_FieldDef* f);
 UPB_API const char* upb_FieldDef_JsonName(const upb_FieldDef* f);