generator/nanopb.proto

   1 // Custom options for defining:
   2 // - Maximum size of string/bytes
   3 // - Maximum number of elements in array
   4 //
   5 // These are used by nanopb to generate statically allocable structures
   6 // for memory-limited environments.
   7
   8 import "google/protobuf/descriptor.proto";
   9
  10 option java_package = "fi.kapsi.koti.jpa.nanopb";
  11
  12 enum FieldType {
  13     FT_DEFAULT = 0; // Automatically decide field type, generate static field if possible.
  14     FT_CALLBACK = 1; // Always generate a callback field.
  15     FT_STATIC = 2; // Generate a static field or raise an exception if not possible.
  16     FT_IGNORE = 3; // Ignore the field completely.
  17 }
  18
  19 // This is the inner options message, which basically defines options for
  20 // a field. When it is used in message or file scope, it applies to all
  21 // fields.
  22 message NanoPBOptions {
  23   // Allocated size for 'bytes' and 'string' fields.
  24   optional int32 max_size = 1;
  25
  26   // Allocated number of entries in arrays ('repeated' fields)
  27   optional int32 max_count = 2;
  28
  29   // Force type of field (callback or static allocation)
  30   optional FieldType type = 3 [default = FT_DEFAULT];
  31
  32   // Use long names for enums, i.e. EnumName_EnumValue.
  33   optional bool long_names = 4 [default = true];
  34
  35   // Add 'packed' attribute to generated structs.
  36   // Note: this cannot be used on CPUs that break on unaligned
  37   // accesses to variables.
  38   optional bool packed_struct = 5 [default = false];
  39 }
  40
  41 // Extensions to protoc 'Descriptor' type in order to define options
  42 // inside a .proto file.
  43 //
  44 // Protocol Buffers extension number registry
  45 // --------------------------------
  46 // Project:  Nanopb
  47 // Contact:  Petteri Aimonen <jpa@kapsi.fi>
  48 // Web site: http://kapsi.fi/~jpa/nanopb
  49 // Extensions: 1010 (all types)
  50 // --------------------------------
  51
  52 extend google.protobuf.FileOptions {
  53     optional NanoPBOptions nanopb_fileopt = 1010;
  54 }
  55
  56 extend google.protobuf.MessageOptions {
  57     optional NanoPBOptions nanopb_msgopt = 1010;
  58 }
  59
  60 extend google.protobuf.EnumOptions {
  61     optional NanoPBOptions nanopb_enumopt = 1010;
  62 }
  63
  64 extend google.protobuf.FieldOptions {
  65     optional NanoPBOptions nanopb = 1010;
  66 }
  67
  68