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
8syntax = "proto2";
9import "google/protobuf/descriptor.proto";
10
11option java_package = "fi.kapsi.koti.jpa.nanopb";
12
13enum FieldType {
14    FT_DEFAULT = 0; // Automatically decide field type, generate static field if possible.
15    FT_CALLBACK = 1; // Always generate a callback field.
16    FT_POINTER = 4; // Always generate a dynamically allocated field.
17    FT_STATIC = 2; // Generate a static field or raise an exception if not possible.
18    FT_IGNORE = 3; // Ignore the field completely.
19}
20
21enum IntSize {
22    IS_DEFAULT = 0; // Default, 32/64bit based on type in .proto
23    IS_8 = 8;
24    IS_16 = 16;
25    IS_32 = 32;
26    IS_64 = 64;
27}
28
29// This is the inner options message, which basically defines options for
30// a field. When it is used in message or file scope, it applies to all
31// fields.
32message NanoPBOptions {
33  // Allocated size for 'bytes' and 'string' fields.
34  optional int32 max_size = 1;
35
36  // Allocated number of entries in arrays ('repeated' fields)
37  optional int32 max_count = 2;
38
39  // Size of integer fields. Can save some memory if you don't need
40  // full 32 bits for the value.
41  optional IntSize int_size = 7 [default = IS_DEFAULT];
42
43  // Force type of field (callback or static allocation)
44  optional FieldType type = 3 [default = FT_DEFAULT];
45
46  // Use long names for enums, i.e. EnumName_EnumValue.
47  optional bool long_names = 4 [default = true];
48
49  // Add 'packed' attribute to generated structs.
50  // Note: this cannot be used on CPUs that break on unaligned
51  // accesses to variables.
52  optional bool packed_struct = 5 [default = false];
53
54  // Skip this message
55  optional bool skip_message = 6 [default = false];
56
57  // Generate oneof fields as normal optional fields instead of union.
58  optional bool no_unions = 8 [default = false];
59
60  // integer type tag for a message
61  optional uint32 msgid = 9;
62}
63
64// Extensions to protoc 'Descriptor' type in order to define options
65// inside a .proto file.
66//
67// Protocol Buffers extension number registry
68// --------------------------------
69// Project:  Nanopb
70// Contact:  Petteri Aimonen <jpa@kapsi.fi>
71// Web site: http://kapsi.fi/~jpa/nanopb
72// Extensions: 1010 (all types)
73// --------------------------------
74
75extend google.protobuf.FileOptions {
76    optional NanoPBOptions nanopb_fileopt = 1010;
77}
78
79extend google.protobuf.MessageOptions {
80    optional NanoPBOptions nanopb_msgopt = 1010;
81}
82
83extend google.protobuf.EnumOptions {
84    optional NanoPBOptions nanopb_enumopt = 1010;
85}
86
87extend google.protobuf.FieldOptions {
88    optional NanoPBOptions nanopb = 1010;
89}
90