1// Protocol Buffers - Google's data interchange format  2// Copyright 2023 Google Inc.  All rights reserved.  3//  4// Use of this source code is governed by a BSD-style  5// license that can be found in the LICENSE file or at  6// https://developers.google.com/open-source/licenses/bsd  7  8syntax = "proto2";  9 10package pb; 11 12import "google/protobuf/descriptor.proto"; 13 14option go_package = "google.golang.org/protobuf/types/gofeaturespb"; 15 16extend google.protobuf.FeatureSet { 17  optional GoFeatures go = 1002; 18} 19 20message GoFeatures { 21  // Whether or not to generate the deprecated UnmarshalJSON method for enums. 22  // Can only be true for proto using the Open Struct api. 23  optional bool legacy_unmarshal_json_enum = 1 [ 24    retention = RETENTION_RUNTIME, 25    targets = TARGET_TYPE_ENUM, 26    targets = TARGET_TYPE_FILE, 27    feature_support = { 28      edition_introduced: EDITION_2023, 29      edition_deprecated: EDITION_2023, 30      deprecation_warning: "The legacy UnmarshalJSON API is deprecated and " 31                           "will be removed in a future edition.", 32    }, 33    edition_defaults = { edition: EDITION_LEGACY, value: "true" }, 34    edition_defaults = { edition: EDITION_PROTO3, value: "false" } 35  ]; 36 37  enum APILevel { 38    // API_LEVEL_UNSPECIFIED results in selecting the OPEN API, 39    // but needs to be a separate value to distinguish between 40    // an explicitly set api level or a missing api level. 41    API_LEVEL_UNSPECIFIED = 0; 42    API_OPEN = 1; 43    API_HYBRID = 2; 44    API_OPAQUE = 3; 45  } 46 47  // One of OPEN, HYBRID or OPAQUE. 48  optional APILevel api_level = 2 [ 49    retention = RETENTION_RUNTIME, 50    targets = TARGET_TYPE_MESSAGE, 51    targets = TARGET_TYPE_FILE, 52    feature_support = { 53      edition_introduced: EDITION_2023, 54    }, 55    edition_defaults = { 56      edition: EDITION_LEGACY, 57      value: "API_LEVEL_UNSPECIFIED" 58    }, 59    edition_defaults = { edition: EDITION_2024, value: "API_OPAQUE" } 60  ]; 61 62  enum StripEnumPrefix { 63    STRIP_ENUM_PREFIX_UNSPECIFIED = 0; 64    STRIP_ENUM_PREFIX_KEEP = 1; 65    STRIP_ENUM_PREFIX_GENERATE_BOTH = 2; 66    STRIP_ENUM_PREFIX_STRIP = 3; 67  } 68 69  optional StripEnumPrefix strip_enum_prefix = 3 [ 70    retention = RETENTION_RUNTIME, 71    targets = TARGET_TYPE_ENUM, 72    targets = TARGET_TYPE_ENUM_ENTRY, 73    targets = TARGET_TYPE_FILE, 74    feature_support = { 75      edition_introduced: EDITION_2024, 76    }, 77    // TODO: change the default to STRIP_ENUM_PREFIX_STRIP for edition 2025. 78    edition_defaults = { 79      edition: EDITION_LEGACY, 80      value: "STRIP_ENUM_PREFIX_KEEP" 81    } 82  ]; 83 84  // Wrap the OptimizeMode enum in a message for scoping: 85  // This way, users can type shorter names (SPEED, CODE_SIZE). 86  message OptimizeModeFeature { 87    // The name of this enum matches OptimizeMode in descriptor.proto. 88    enum OptimizeMode { 89      // OPTIMIZE_MODE_UNSPECIFIED results in falling back to the default 90      // (optimize for code size), but needs to be a separate value to distinguish 91      // between an explicitly set optimize mode or a missing optimize mode. 92      OPTIMIZE_MODE_UNSPECIFIED = 0; 93      SPEED = 1; 94      CODE_SIZE = 2; 95      // There is no enum entry for LITE_RUNTIME (descriptor.proto), 96      // because Go Protobuf does not have the concept of a lite runtime. 97    } 98  } 99100  optional OptimizeModeFeature.OptimizeMode optimize_mode = 4 [101    retention = RETENTION_RUNTIME,102    targets = TARGET_TYPE_MESSAGE,103    targets = TARGET_TYPE_FILE,104    feature_support = {105      edition_introduced: EDITION_2024,106    },107    edition_defaults = {108      edition: EDITION_LEGACY,109      value: "OPTIMIZE_MODE_UNSPECIFIED"110    }111  ];112}