src/google/protobuf/compiler/python/pyi_generator.h

// Protocol Buffers - Google's data interchange format
// Copyright 2008 Google Inc.  All rights reserved.
// https://developers.google.com/protocol-buffers/
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
//     * Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//     * Redistributions in binary form must reproduce the above
// copyright notice, this list of conditions and the following disclaimer
// in the documentation and/or other materials provided with the
// distribution.
//     * Neither the name of Google Inc. nor the names of its
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

// Author: jieluo@google.com (Jie Luo)
//
// Generates Python stub (.pyi) for a given .proto file.

#ifndef GOOGLE_PROTOBUF_COMPILER_PYTHON_PYI_GENERATOR_H__
#define GOOGLE_PROTOBUF_COMPILER_PYTHON_PYI_GENERATOR_H__

#include <map>
#include <set>
#include <string>

#include <google/protobuf/stubs/mutex.h>
#include <google/protobuf/compiler/code_generator.h>

// Must be included last.
#include <google/protobuf/port_def.inc>

namespace google {
namespace protobuf {
class Descriptor;
class EnumDescriptor;
class FieldDescriptor;
class MethodDescriptor;
class ServiceDescriptor;

namespace io {
class Printer;
}

namespace compiler {
namespace python {

class PROTOC_EXPORT PyiGenerator : public google::protobuf::compiler::CodeGenerator {
 public:
  PyiGenerator();
  ~PyiGenerator() override;

  // CodeGenerator methods.
  uint64_t GetSupportedFeatures() const override {
    // Code generators must explicitly support proto3 optional.
    return CodeGenerator::FEATURE_PROTO3_OPTIONAL;
  }
  bool Generate(const FileDescriptor* file, const std::string& parameter,
                GeneratorContext* generator_context,
                std::string* error) const override;

 private:
  void PrintImportForDescriptor(const FileDescriptor& desc,
                                std::map<std::string, std::string>* import_map,
                                std::set<std::string>* seen_aliases) const;
  void PrintImports(std::map<std::string, std::string>* item_map,
                    std::map<std::string, std::string>* import_map) const;
  void PrintEnum(const EnumDescriptor& enum_descriptor) const;
  void AddEnumValue(const EnumDescriptor& enum_descriptor,
                    std::map<std::string, std::string>* item_map,
                    const std::map<std::string, std::string>& import_map) const;
  void PrintTopLevelEnums() const;
  template <typename DescriptorT>
  void AddExtensions(const DescriptorT& descriptor,
                     std::map<std::string, std::string>* item_map) const;
  void PrintMessages(
      const std::map<std::string, std::string>& import_map) const;
  void PrintMessage(const Descriptor& message_descriptor, bool is_nested,
                    const std::map<std::string, std::string>& import_map) const;
  void PrintServices() const;
  void PrintItemMap(const std::map<std::string, std::string>& item_map) const;
  std::string GetFieldType(
      const FieldDescriptor& field_des, const Descriptor& containing_des,
      const std::map<std::string, std::string>& import_map) const;
  template <typename DescriptorT>
  std::string ModuleLevelName(
      const DescriptorT& descriptor,
      const std::map<std::string, std::string>& import_map) const;

  // Very coarse-grained lock to ensure that Generate() is reentrant.
  // Guards file_ and printer_.
  mutable Mutex mutex_;
  mutable const FileDescriptor* file_;  // Set in Generate().  Under mutex_.
  mutable io::Printer* printer_;        // Set in Generate().  Under mutex_.
  GOOGLE_DISALLOW_EVIL_CONSTRUCTORS(PyiGenerator);
};

}  // namespace python
}  // namespace compiler
}  // namespace protobuf
}  // namespace google

#include <google/protobuf/port_undef.inc>

#endif  // GOOGLE_PROTOBUF_COMPILER_PYTHON_PYI_GENERATOR_H__