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