option_extensions.proto

// Copyright 2010-2023:
//   GobySoft, LLC (2013-)
//   Massachusetts Institute of Technology (2007-2014)
//   Community contributors (see AUTHORS file)
// File authors:
//   Toby Schneider <toby@gobysoft.org>
//   Chris Murphy <cmurphy@aphysci.com>
//
//
// This file is part of the Dynamic Compact Control Language Library
// ("DCCL").
//
// DCCL is free software: you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as published by
// the Free Software Foundation, either version 2.1 of the License, or
// (at your option) any later version.
//
// DCCL is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with DCCL.  If not, see <http://www.gnu.org/licenses/>.
syntax = "proto2";
 
import "google/protobuf/descriptor.proto";
 
// Email from liujisi@google.com on 10.02.2012: Feel free to use 1012 for all
// types of options.
//--------------------------------
// Project:  Dynamic Compact Control Language
// Contact:  Toby Schneider <tes@mit.edu>
// Web site: https://launchpad.net/dccl
// Extensions: 1012 (all types)
//--------------------------------
package dccl;
 
extend .google.protobuf.FieldOptions
{
    optional DCCLFieldOptions field = 1012;
}
 
extend .google.protobuf.MessageOptions
{
    optional DCCLMessageOptions msg = 1012;
}
 
message DCCLFieldOptions
{
    // what encoder / decoder should we use?
    optional string codec = 1 [default = "dccl.default2"];
    // leave this field out of DCCL transmissions (has_field() will be false on
    // receipt)
    optional bool omit = 2 [default = false];
    // set true for fields in the header (will *not* be encrypte)d
    optional bool in_head = 3 [default = false];
 
    // double, float
    optional int32 precision = 4 [default = 0];  // Deprecated
    optional double resolution = 12 [default = 1];
    // int, double, float
    optional double min = 5;
    optional double max = 6;
 
    // time ("1 day" can encode times 12h before or after the receiver's time)
    optional uint32 num_days = 7 [default = 1];
 
    // static
    optional string static_value = 8 [default = ""];
 
    // string, bytes
    optional uint32 max_length = 9;
    optional uint32 min_length = 14 [default = 0];
 
    // any `repeated` field
    optional uint32 max_repeat = 10;
    optional uint32 min_repeat = 13 [default = 0];
 
    // enum
    optional bool packed_enum = 11 [default = true];
 
    optional string description = 20;
 
    message Units
    {
        // units
        optional string base_dimensions = 1;
        optional string derived_dimensions = 2;
        optional string system = 3 [default = "si"];
        optional bool relative_temperature = 4 [default = false];
        optional string unit = 5;
        optional string prefix = 6;
        message CustomUnit
        {
            required string unit = 1;
            optional string header = 2;
        }
        optional CustomUnit custom = 7;
    }
    optional Units units = 30;
 
    // runtime contents-based conditionals
    message Conditions
    {
        optional string required_if = 1;
        optional string omit_if = 2;
        optional string only_if = 3;
        optional string min = 10;
        optional string max = 11;
    }
 
    optional Conditions dynamic_conditions = 40;
 
    // ccl = 1000
    // arithmetic = 1001
    extensions 1000 to max;
}
 
message DCCLMessageOptions
{
    optional int32 id = 1;
    optional uint32 max_bytes = 2;
 
    optional string codec = 3;
 
    optional string codec_group = 4;
    optional int32 codec_version = 5;
 
    optional bool omit_id = 10 [default = false];
 
    optional string unit_system = 30 [default = "si"];
 
    // runtime contents-based conditionals
    message Conditions
    {
        optional string max_bytes = 1;
    }
 
    optional Conditions dynamic_conditions = 40;
}