From 532c94145b6605361513682601f1d8e9f97a2497 Mon Sep 17 00:00:00 2001 From: Richard Geary Date: Fri, 23 Jan 2015 12:35:03 -0500 Subject: [PATCH] Add support for outputting dependency manifest files, used by ninja and make Use --manifest-file=somefile.d to output the dependency manifest. This file will contain a list of files which were read by protoc as part of creating the output files. It doesn't include the plugin inputs if plugins are used, that could be a later extension. The manifest file is in the format : . The manifest file format only allows you to specify one output file, which isn't a problem as it's used to detect input changes in order to detect when to rerun the protoc command. The output file used in the manifest is the manifest filename itself; to use this in ninja you should declare the manifest file as the first output as well as the depfile input. --- .../compiler/command_line_interface.cc | 83 ++++++++++++ .../compiler/command_line_interface.h | 9 ++ test-driver | 127 ++++++++++++++++++ 3 files changed, 219 insertions(+) create mode 100755 test-driver diff --git a/src/google/protobuf/compiler/command_line_interface.cc b/src/google/protobuf/compiler/command_line_interface.cc index 13250702c7..649aa42d77 100644 --- a/src/google/protobuf/compiler/command_line_interface.cc +++ b/src/google/protobuf/compiler/command_line_interface.cc @@ -46,6 +46,7 @@ #endif #include #include +#include #include #include @@ -725,6 +726,12 @@ int CommandLineInterface::Run(int argc, const char* const argv[]) { } } + if (!manifest_name_.empty()) { + if (!GenerateDependencyManifestFile(parsed_files, &source_tree)) { + return 1; + } + } + if (mode_ == MODE_ENCODE || mode_ == MODE_DECODE) { if (codec_type_.empty()) { // HACK: Define an EmptyMessage type to use for decoding. @@ -775,6 +782,7 @@ void CommandLineInterface::Clear() { output_directives_.clear(); codec_type_.clear(); descriptor_set_name_.clear(); + manifest_name_.clear(); mode_ = MODE_COMPILE; print_mode_ = PRINT_NONE; @@ -1012,6 +1020,22 @@ CommandLineInterface::InterpretArgument(const string& name, } descriptor_set_name_ = value; + } else if (name == "--manifest-file") { + if (!manifest_name_.empty()) { + cerr << name << " may only be passed once." << endl; + return PARSE_ARGUMENT_FAIL; + } + if (value.empty()) { + cerr << name << " requires a non-empty value." << endl; + return PARSE_ARGUMENT_FAIL; + } + if (mode_ != MODE_COMPILE) { + cerr << "Cannot use --encode or --decode and generate a manifest at the " + "same time." << endl; + return PARSE_ARGUMENT_FAIL; + } + manifest_name_ = value; + } else if (name == "--include_imports") { if (imports_in_descriptor_set_) { cerr << name << " may only be passed once." << endl; @@ -1206,6 +1230,9 @@ void CommandLineInterface::PrintHelpText() { " include information about the original\n" " location of each decl in the source file as\n" " well as surrounding comments.\n" +" --manifest_file=FILE Write a dependency output file in the format\n" +" expected by make. This writes the transitive\n" +" set of input file paths to FILE\n" " --error_format=FORMAT Set the format in which to print errors.\n" " FORMAT may be 'gcc' (the default) or 'msvs'\n" " (Microsoft Visual Studio format).\n" @@ -1282,6 +1309,62 @@ bool CommandLineInterface::GenerateOutput( return true; } +bool CommandLineInterface::GenerateDependencyManifestFile( + const vector parsed_files, + DiskSourceTree * source_tree) { + FileDescriptorSet file_set; + + set already_seen; + for (int i = 0; i < parsed_files.size(); i++) { + GetTransitiveDependencies(parsed_files[i], + false, + &already_seen, file_set.mutable_file()); + } + + int fd; + do { + fd = open(manifest_name_.c_str(), + O_WRONLY | O_CREAT | O_TRUNC | O_BINARY, 0666); + } while (fd < 0 && errno == EINTR); + + if (fd < 0) { + perror(manifest_name_.c_str()); + return false; + } + + stringstream ss; + string output_filename = manifest_name_; + if (output_filename.compare(0, 2, "./") == 0) { + output_filename = output_filename.substr(2); + } + ss << output_filename << ": "; + for (set::const_iterator it = already_seen.begin(); it != already_seen.end(); ++it ) { + string virtual_file = (*it)->name(); + string disk_file; + if (source_tree && source_tree->VirtualFileToDiskFile(virtual_file, &disk_file) ) { + ss << " " << disk_file << " \\" << endl; + } else { + cerr << "Unable to identify path for file " << virtual_file << endl; + return false; + } + } + + string manifest_contents = ss.str(); + if ( write(fd, manifest_contents.c_str(), manifest_contents.size()) != manifest_contents.size() ) { + cerr << "Error when writing to " << manifest_name_ << endl; + return false; + } + + int rv = ::close(fd); + if ( rv != 0 ) { + cerr << manifest_name_ << ": " << strerror(rv) << endl; + return false; + } + + return true; +} + + bool CommandLineInterface::GeneratePluginOutput( const vector& parsed_files, const string& plugin_name, diff --git a/src/google/protobuf/compiler/command_line_interface.h b/src/google/protobuf/compiler/command_line_interface.h index 74a0adb4cd..59d57fbf49 100644 --- a/src/google/protobuf/compiler/command_line_interface.h +++ b/src/google/protobuf/compiler/command_line_interface.h @@ -247,6 +247,11 @@ class LIBPROTOC_EXPORT CommandLineInterface { // Implements the --descriptor_set_out option. bool WriteDescriptorSet(const vector parsed_files); + // Implements the --manifest-file option + bool GenerateDependencyManifestFile( + const vector parsed_files, + DiskSourceTree * source_tree); + // Get all transitive dependencies of the given file (including the file // itself), adding them to the given list of FileDescriptorProtos. The // protos will be ordered such that every file is listed before any file that @@ -353,6 +358,10 @@ class LIBPROTOC_EXPORT CommandLineInterface { // FileDescriptorSet should be written. Otherwise, empty. string descriptor_set_name_; + // If --manifest_file was given, this is the filename to which the input + // file should be written. Otherwise, empty. + string manifest_name_; + // True if --include_imports was given, meaning that we should // write all transitive dependencies to the DescriptorSet. Otherwise, only // the .proto files listed on the command-line are added. diff --git a/test-driver b/test-driver new file mode 100755 index 0000000000..32bf39e837 --- /dev/null +++ b/test-driver @@ -0,0 +1,127 @@ +#! /bin/sh +# test-driver - basic testsuite driver script. + +scriptversion=2012-06-27.10; # UTC + +# Copyright (C) 2011-2013 Free Software Foundation, Inc. +# +# This program is free software; you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation; either version 2, or (at your option) +# any later version. +# +# This program 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 General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see . + +# As a special exception to the GNU General Public License, if you +# distribute this file as part of a program that contains a +# configuration script generated by Autoconf, you may include it under +# the same distribution terms that you use for the rest of that program. + +# This file is maintained in Automake, please report +# bugs to or send patches to +# . + +# Make unconditional expansion of undefined variables an error. This +# helps a lot in preventing typo-related bugs. +set -u + +usage_error () +{ + echo "$0: $*" >&2 + print_usage >&2 + exit 2 +} + +print_usage () +{ + cat <$log_file 2>&1 +estatus=$? +if test $enable_hard_errors = no && test $estatus -eq 99; then + estatus=1 +fi + +case $estatus:$expect_failure in + 0:yes) col=$red res=XPASS recheck=yes gcopy=yes;; + 0:*) col=$grn res=PASS recheck=no gcopy=no;; + 77:*) col=$blu res=SKIP recheck=no gcopy=yes;; + 99:*) col=$mgn res=ERROR recheck=yes gcopy=yes;; + *:yes) col=$lgn res=XFAIL recheck=no gcopy=yes;; + *:*) col=$red res=FAIL recheck=yes gcopy=yes;; +esac + +# Report outcome to console. +echo "${col}${res}${std}: $test_name" + +# Register the test result, and other relevant metadata. +echo ":test-result: $res" > $trs_file +echo ":global-test-result: $res" >> $trs_file +echo ":recheck: $recheck" >> $trs_file +echo ":copy-in-global-log: $gcopy" >> $trs_file + +# Local Variables: +# mode: shell-script +# sh-indentation: 2 +# eval: (add-hook 'write-file-hooks 'time-stamp) +# time-stamp-start: "scriptversion=" +# time-stamp-format: "%:y-%02m-%02d.%02H" +# time-stamp-time-zone: "UTC" +# time-stamp-end: "; # UTC" +# End: