/thirdparty/breakpad/third_party/protobuf/protobuf/src/google/protobuf/compiler/code_generator.h

  1// Protocol Buffers - Google's data interchange format
  2// Copyright 2008 Google Inc.  All rights reserved.
  3// http://code.google.com/p/protobuf/
  4//
  5// Redistribution and use in source and binary forms, with or without
  6// modification, are permitted provided that the following conditions are
  7// met:
  8//
  9//     * Redistributions of source code must retain the above copyright
 10// notice, this list of conditions and the following disclaimer.
 11//     * Redistributions in binary form must reproduce the above
 12// copyright notice, this list of conditions and the following disclaimer
 13// in the documentation and/or other materials provided with the
 14// distribution.
 15//     * Neither the name of Google Inc. nor the names of its
 16// contributors may be used to endorse or promote products derived from
 17// this software without specific prior written permission.
 18//
 19// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 20// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 21// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 22// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 23// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 24// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 25// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 26// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 27// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 28// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 29// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 30
 31// Author: kenton@google.com (Kenton Varda)
 32//  Based on original Protocol Buffers design by
 33//  Sanjay Ghemawat, Jeff Dean, and others.
 34//
 35// Defines the abstract interface implemented by each of the language-specific
 36// code generators.
 37
 38#ifndef GOOGLE_PROTOBUF_COMPILER_CODE_GENERATOR_H__
 39#define GOOGLE_PROTOBUF_COMPILER_CODE_GENERATOR_H__
 40
 41#include <google/protobuf/stubs/common.h>
 42#include <string>
 43#include <vector>
 44#include <utility>
 45
 46namespace google {
 47namespace protobuf {
 48
 49namespace io { class ZeroCopyOutputStream; }
 50class FileDescriptor;
 51
 52namespace compiler {
 53
 54// Defined in this file.
 55class CodeGenerator;
 56class GeneratorContext;
 57
 58// The abstract interface to a class which generates code implementing a
 59// particular proto file in a particular language.  A number of these may
 60// be registered with CommandLineInterface to support various languages.
 61class LIBPROTOC_EXPORT CodeGenerator {
 62 public:
 63  inline CodeGenerator() {}
 64  virtual ~CodeGenerator();
 65
 66  // Generates code for the given proto file, generating one or more files in
 67  // the given output directory.
 68  //
 69  // A parameter to be passed to the generator can be specified on the
 70  // command line.  This is intended to be used by Java and similar languages
 71  // to specify which specific class from the proto file is to be generated,
 72  // though it could have other uses as well.  It is empty if no parameter was
 73  // given.
 74  //
 75  // Returns true if successful.  Otherwise, sets *error to a description of
 76  // the problem (e.g. "invalid parameter") and returns false.
 77  virtual bool Generate(const FileDescriptor* file,
 78                        const string& parameter,
 79                        GeneratorContext* generator_context,
 80                        string* error) const = 0;
 81
 82 private:
 83  GOOGLE_DISALLOW_EVIL_CONSTRUCTORS(CodeGenerator);
 84};
 85
 86// CodeGenerators generate one or more files in a given directory.  This
 87// abstract interface represents the directory to which the CodeGenerator is
 88// to write and other information about the context in which the Generator
 89// runs.
 90class LIBPROTOC_EXPORT GeneratorContext {
 91 public:
 92  inline GeneratorContext() {}
 93  virtual ~GeneratorContext();
 94
 95  // Opens the given file, truncating it if it exists, and returns a
 96  // ZeroCopyOutputStream that writes to the file.  The caller takes ownership
 97  // of the returned object.  This method never fails (a dummy stream will be
 98  // returned instead).
 99  //
100  // The filename given should be relative to the root of the source tree.
101  // E.g. the C++ generator, when generating code for "foo/bar.proto", will
102  // generate the files "foo/bar.pb.h" and "foo/bar.pb.cc"; note that
103  // "foo/" is included in these filenames.  The filename is not allowed to
104  // contain "." or ".." components.
105  virtual io::ZeroCopyOutputStream* Open(const string& filename) = 0;
106
107  // Creates a ZeroCopyOutputStream which will insert code into the given file
108  // at the given insertion point.  See plugin.proto (plugin.pb.h) for more
109  // information on insertion points.  The default implementation
110  // assert-fails -- it exists only for backwards-compatibility.
111  //
112  // WARNING:  This feature is currently EXPERIMENTAL and is subject to change.
113  virtual io::ZeroCopyOutputStream* OpenForInsert(
114      const string& filename, const string& insertion_point);
115
116  // Returns a vector of FileDescriptors for all the files being compiled
117  // in this run.  Useful for languages, such as Go, that treat files
118  // differently when compiled as a set rather than individually.
119  virtual void ListParsedFiles(vector<const FileDescriptor*>* output);
120
121 private:
122  GOOGLE_DISALLOW_EVIL_CONSTRUCTORS(GeneratorContext);
123};
124
125// The type GeneratorContext was once called OutputDirectory. This typedef
126// provides backward compatibility.
127typedef GeneratorContext OutputDirectory;
128
129// Several code generators treat the parameter argument as holding a
130// list of options separated by commas.  This helper function parses
131// a set of comma-delimited name/value pairs: e.g.,
132//   "foo=bar,baz,qux=corge"
133// parses to the pairs:
134//   ("foo", "bar"), ("baz", ""), ("qux", "corge")
135extern void ParseGeneratorParameter(const string&,
136            vector<pair<string, string> >*);
137
138}  // namespace compiler
139}  // namespace protobuf
140
141}  // namespace google
142#endif  // GOOGLE_PROTOBUF_COMPILER_CODE_GENERATOR_H__