compile.proto

// This file is part of arduino-cli.
//
// Copyright 2020 ARDUINO SA (http://www.arduino.cc/)
//
// This software is released under the GNU General Public License version 3,
// which covers the main part of arduino-cli.
// The terms of this license can be found at:
// https://www.gnu.org/licenses/gpl-3.0.en.html
//
// You can be released from the requirements of the above licenses by purchasing
// a commercial license. Buying such a license is mandatory if you want to
// modify or otherwise use the software for commercial activities involving the
// Arduino software without disclosing the source code of your own applications.
// To purchase a commercial license, send an email to license@arduino.cc.

syntax = "proto3";

package cc.arduino.cli.commands;

option go_package = "github.com/arduino/arduino-cli/rpc/commands";

import "commands/common.proto";
import "commands/lib.proto";

message CompileReq {
  Instance instance = 1;  // Arduino Core Service instance from the `Init` response.
  string fqbn = 2;   // Fully Qualified Board Name, e.g.: `arduino:avr:uno`. If this field is not defined, the FQBN of the board attached to the sketch via the `BoardAttach` method is used.
  string sketchPath = 3;  // The path where the sketch is stored.
  bool showProperties = 4;  // Show all build preferences used instead of compiling.
  bool preprocess = 5;      // Print preprocessed code to stdout instead of compiling.
  string buildCachePath = 6;    // Builds of 'core.a' are saved into this path to be cached and reused.
  string buildPath = 7;         // Path to use to store the files used for the compilation. If omitted, a directory will be created in the operating system's default temporary path.
  repeated string buildProperties = 8; // List of custom build properties separated by commas.
  string warnings = 9;   // Used to tell gcc which warning level to use. The level names are: "none", "default", "more" and "all".
  bool verbose = 10;     // Turns on verbose mode.
  bool quiet = 11;             // Suppresses almost every output.
  string vidPid = 12;   // VID/PID specific build properties.
  int32 jobs = 14;   // The max number of concurrent compiler instances to run (as `make -jx`). If jobs is set to 0, it will use the number of available CPUs as the maximum.
  repeated string libraries = 15; // List of custom libraries paths separated by commas.
  bool optimizeForDebug = 16; // Optimize compile output for debug, not for release.
  string export_dir = 18; // Optional: save the build artifacts in this directory, the directory must exist.
  bool clean = 19; // Optional: cleanup the build folder and do not use any previously cached build
  bool export_binaries = 20; // When set to `true` the compiled binary will be copied to the export directory.
  bool create_compilation_database_only = 21; // When set to `true` only the compilation database will be produced and no actual build will be performed.
  map<string, string> source_override = 22; // This map (source file -> new content) let the builder use the provided content instead of reading the corresponding file on disk. This is useful for IDE that have unsaved changes in memory. The path must be relative to the sketch directory. Only files from the sketch are allowed.
}

message CompileResp {
  bytes out_stream = 1; // The output of the compilation process.
  bytes err_stream = 2; // The error output of the compilation process.
  string build_path = 3; // The compiler build path
  repeated Library used_libraries = 4; // The libraries used in the build
  repeated ExecutableSectionSize executable_sections_size = 5; // The size of the executable split by sections
}

message ExecutableSectionSize {
  string name = 1;
  int64 size = 2;
  int64 maxSize = 3;
}