tools/distrib/python/grpcio_tools/grpc_tools/main.cc

// Copyright 2016 gRPC authors.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

#include <google/protobuf/compiler/command_line_interface.h>
#include <google/protobuf/compiler/command_line_interface.h>
#include <google/protobuf/compiler/python/python_generator.h>

#include "src/compiler/python_generator.h"

#include "grpc_tools/main.h"

#include <google/protobuf/compiler/code_generator.h>
#include <google/protobuf/io/zero_copy_stream_impl_lite.h>
#include <google/protobuf/compiler/importer.h>
#include <google/protobuf/descriptor.h>

// TODO: Clang format.
#include <algorithm>
#include <vector>
#include <map>
#include <string>
#include <tuple>

// TODO: Remove.
#include <iostream>

int protoc_main(int argc, char* argv[]) {
  google::protobuf::compiler::CommandLineInterface cli;
  cli.AllowPlugins("protoc-");

  // Proto2 Python
  google::protobuf::compiler::python::Generator py_generator;
  cli.RegisterGenerator("--python_out", &py_generator,
                        "Generate Python source file.");

  // gRPC Python
  grpc_python_generator::GeneratorConfiguration grpc_py_config;
  grpc_python_generator::PythonGrpcGenerator grpc_py_generator(grpc_py_config);
  cli.RegisterGenerator("--grpc_python_out", &grpc_py_generator,
                        "Generate Python source file.");

  return cli.Run(argc, argv);
}

// TODO: Figure out what Google best practices are for internal namespace like
// this.
namespace detail {

// TODO: Consider deduping between this and command_line_interface.cc.
// TODO: Separate declarations and definitions.
class GeneratorContextImpl : public ::google::protobuf::compiler::GeneratorContext {
public:
  GeneratorContextImpl(const std::vector<const ::google::protobuf::FileDescriptor*>& parsed_files,
                       std::vector<std::pair<std::string, std::string>>* files_out) :
    files_(files_out),
    parsed_files_(parsed_files) {}

  ::google::protobuf::io::ZeroCopyOutputStream* Open(const std::string& filename) {
    files_->emplace_back(filename, "");
    return new ::google::protobuf::io::StringOutputStream(&(files_->back().second));
  }

  // NOTE: Equivalent to Open, since all files start out empty.
  ::google::protobuf::io::ZeroCopyOutputStream* OpenForAppend(const std::string& filename) {
    return Open(filename);
  }

  // NOTE: Equivalent to Open, since all files start out empty.
  ::google::protobuf::io::ZeroCopyOutputStream* OpenForInsert(
      const std::string& filename, const std::string& insertion_point) {
    return Open(filename);
  }

  void ListParsedFiles(std::vector<const ::google::protobuf::FileDescriptor*>* output) {
    *output = parsed_files_;
  }

private:
  std::vector<std::pair<std::string, std::string>>* files_;
  const std::vector<const ::google::protobuf::FileDescriptor*>& parsed_files_;
};

// TODO: Write a bunch of tests for exception propagation.
class ErrorCollectorImpl : public ::google::protobuf::compiler::MultiFileErrorCollector {
 public:
  ErrorCollectorImpl(std::vector<ProtocError>* errors,
                     std::vector<ProtocWarning>* warnings) :
                     errors_(errors),
                     warnings_(warnings) {}

  void AddError(const std::string& filename, int line, int column,
                const std::string& message) {
    errors_->emplace_back(filename, line, column, message);
  }

  void AddWarning(const std::string& filename, int line, int column,
                  const std::string& message) {
    warnings_->emplace_back(filename, line, column, message);
  }

private:
  std::vector<ProtocError>* errors_;
  std::vector<ProtocWarning>* warnings_;
};

} // end namespace detail

static void calculate_transitive_closure(const ::google::protobuf::FileDescriptor* descriptor,
                                        std::vector<const ::google::protobuf::FileDescriptor*>* transitive_closure)
{
  for (int i = 0; i < descriptor->dependency_count(); ++i) {
    const ::google::protobuf::FileDescriptor* dependency = descriptor->dependency(i);
    // NOTE: Probably want an O(1) lookup method for very large transitive
    // closures.
    if (std::find(transitive_closure->begin(), transitive_closure->end(), dependency) == transitive_closure->end()) {
      calculate_transitive_closure(dependency, transitive_closure);
    }
  }
  transitive_closure->push_back(descriptor);
}

// TODO: Handle multiple include paths.
static int generate_code(::google::protobuf::compiler::CodeGenerator* code_generator,
                         char* protobuf_path,
                         char* include_path,
                         std::vector<std::pair<std::string, std::string>>* files_out,
                         std::vector<ProtocError>* errors,
                         std::vector<ProtocWarning>* warnings)
{
  std::unique_ptr<detail::ErrorCollectorImpl> error_collector(new detail::ErrorCollectorImpl(errors, warnings));
  std::unique_ptr<::google::protobuf::compiler::DiskSourceTree> source_tree(new ::google::protobuf::compiler::DiskSourceTree());
  source_tree->MapPath("", include_path);
  ::google::protobuf::compiler::Importer importer(source_tree.get(), error_collector.get());
  const ::google::protobuf::FileDescriptor* parsed_file = importer.Import(protobuf_path);
  if (parsed_file == nullptr) {
    return 1;
  }
  // TODO: Figure out if the dependency list is flat or recursive.
  // TODO: Ensure there's a topological ordering here.
  std::vector<const ::google::protobuf::FileDescriptor*> transitive_closure;
  calculate_transitive_closure(parsed_file, &transitive_closure);
  detail::GeneratorContextImpl generator_context(transitive_closure, files_out);
  std::string error;
  for (const auto descriptor : transitive_closure) {
    code_generator->Generate(descriptor, "", &generator_context, &error);
  }
  return 0;
}

int protoc_get_protos(char* protobuf_path,
                     char* include_path,
                     std::vector<std::pair<std::string, std::string>>* files_out,
                     std::vector<ProtocError>* errors,
                     std::vector<ProtocWarning>* warnings)
{
  ::google::protobuf::compiler::python::Generator python_generator;
  return generate_code(&python_generator, protobuf_path, include_path, files_out, errors, warnings);
}

int protoc_get_services(char* protobuf_path,
                     char* include_path,
                     std::vector<std::pair<std::string, std::string>>* files_out,
                     std::vector<ProtocError>* errors,
                     std::vector<ProtocWarning>* warnings)
{
  grpc_python_generator::GeneratorConfiguration grpc_py_config;
  grpc_python_generator::PythonGrpcGenerator grpc_py_generator(grpc_py_config);
  return generate_code(&grpc_py_generator, protobuf_path, include_path, files_out, errors, warnings);
}