blob: c2baff434e861e3f899a181ec0d2c218eccb7f2c [file] [log] [blame]
#!/usr/bin/env python3.11
# Copyright 2012 Google Inc. All Rights Reserved.
A simple wrapper for protoc.
Script for //third_party/protobuf/proto_library.gni .
- Inserts #include for extra header automatically.
- Prevents bad proto names.
from __future__ import print_function
import argparse
import os
import os.path
import re
import subprocess
import sys
import tempfile
PROTOC_INCLUDE_POINT = "// @@protoc_insertion_point(includes)"
def FormatGeneratorOptions(options):
if not options:
return ""
if options.endswith(":"):
return options
return options + ":"
def VerifyProtoNames(protos):
for filename in protos:
if "-" in filename:
raise RuntimeError("Proto file names must not contain hyphens "
"(see for more information).")
def StripProtoExtension(filename):
if not filename.endswith(".proto"):
raise RuntimeError("Invalid proto filename extension: "
"{0} .".format(filename))
return filename.rsplit(".", 1)[0]
def WriteIncludes(headers, include):
for filename in headers:
include_point_found = False
contents = []
with open(filename) as f:
for line in f:
stripped_line = line.strip()
if stripped_line == PROTOC_INCLUDE_POINT:
if include_point_found:
raise RuntimeError("Multiple include points found.")
include_point_found = True
extra_statement = "#include \"{0}\"".format(include)
if not include_point_found:
raise RuntimeError("Include point not found in header: "
"{0} .".format(filename))
with open(filename, "w") as f:
for line in contents:
print(line, file=f)
def WriteDepfile(depfile, out_list, dep_list):
os.makedirs(os.path.dirname(depfile), exist_ok=True)
with open(depfile, 'w') as f:
print("{0}: {1}".format(" ".join(out_list), " ".join(dep_list)), file=f)
def WritePluginDepfile(depfile, outputs, dependencies):
with open(outputs) as f:
outs = [line.strip() for line in f]
with open(dependencies) as f:
deps = [line.strip() for line in f]
WriteDepfile(depfile, outs, deps)
def WriteProtocDepfile(depfile, outputs, deps_list):
with open(outputs) as f:
outs = [line.strip() for line in f]
WriteDepfile(depfile, outs, deps_list)
def ExtractImports(proto, proto_dir, import_dirs):
filename = os.path.join(proto_dir, proto)
imports = set()
with open(filename) as f:
# Search the file for import.
for line in f:
match = re.match(r'^\s*import(?:\s+public)?\s+"([^"]+)"\s*;\s*$', line)
if match:
imported = match[1]
# Check import directories to find the imported file.
for candidate_dir in [proto_dir] + import_dirs:
candidate_path = os.path.join(candidate_dir, imported)
if os.path.exists(candidate_path):
# Transitively check imports.
imports.update(ExtractImports(imported, candidate_dir, import_dirs))
return imports
def main(argv):
parser = argparse.ArgumentParser()
help="Relative path to compiler.")
help="Base directory with source protos.")
help="Output directory for standard C++ generator.")
help="Output directory for standard Python generator.")
help="Output directory for custom generator plugin.")
help="Output location for the protoc depfile.")
help="File containing a list of files to be generated.")
help="Relative path to custom generator plugin.")
help="Output location for the plugin depfile.")
help="File containing plugin deps not set as other input.")
help="File containing a list of files that will be generated.")
help="Custom generator plugin options.")
help="Standard C++ generator options.")
help="Name of include to insert into generated headers.")
parser.add_argument("--import-dir", action="append", default=[],
help="Extra import directory for protos, can be repeated."
help="Passed through to protoc as --descriptor_set_out")
parser.add_argument("protos", nargs="+",
help="Input protobuf definition file(s).")
options = parser.parse_args()
proto_dir = os.path.relpath(options.proto_in_dir)
protoc_cmd = [os.path.realpath(options.protoc)]
protos = options.protos
headers = []
if options.descriptor_set_out:
protoc_cmd += ["--descriptor_set_out", options.descriptor_set_out]
if options.py_out_dir:
protoc_cmd += ["--python_out", options.py_out_dir]
if options.cc_out_dir:
cc_out_dir = options.cc_out_dir
cc_options = FormatGeneratorOptions(options.cc_options)
protoc_cmd += ["--cpp_out", cc_options + cc_out_dir]
for filename in protos:
stripped_name = StripProtoExtension(filename)
headers.append(os.path.join(cc_out_dir, stripped_name + ".pb.h"))
if options.plugin_out_dir:
plugin_options = FormatGeneratorOptions(options.plugin_options)
protoc_cmd += [
"--plugin", "protoc-gen-plugin=" + os.path.relpath(options.plugin),
"--plugin_out", plugin_options + options.plugin_out_dir
if options.plugin_depfile:
if not options.plugin_depfile_deps or not options.plugin_depfile_outputs:
raise RuntimeError("If plugin depfile is supplied, then the plugin "
"depfile deps and outputs must be set.")
depfile = options.plugin_depfile
dep_info = options.plugin_depfile_deps
outputs = options.plugin_depfile_outputs
WritePluginDepfile(depfile, outputs, dep_info)
if options.depfile:
if not options.depfile_outputs:
raise RuntimeError("If depfile is supplied, depfile outputs must also"
"be supplied.")
depfile = options.depfile
outputs = options.depfile_outputs
deps = set()
for proto in protos:
deps.update(ExtractImports(proto, proto_dir, options.import_dir))
WriteProtocDepfile(depfile, outputs, deps)
protoc_cmd += ["--proto_path", proto_dir]
for path in options.import_dir:
protoc_cmd += ["--proto_path", path]
protoc_cmd += [os.path.join(proto_dir, name) for name in protos]
ret =
if ret != 0:
raise RuntimeError("Protoc has returned non-zero status: "
"{0} .".format(ret))
if options.include:
WriteIncludes(headers, options.include)
if __name__ == "__main__":
except RuntimeError as e:
print(e, file=sys.stderr)