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// 33// Front-end for protoc code generator plugins written in C++. 34// 35// To implement a protoc plugin in C++, simply write an implementation of 36// CodeGenerator, then create a main() function like: 37// int main(int argc, char* argv[]) { 38// MyCodeGenerator generator; 39// return google::protobuf::compiler::PluginMain(argc, argv, &generator); 40// } 41// You must link your plugin against libprotobuf and libprotoc. 42// 43// To get protoc to use the plugin, do one of the following: 44// * Place the plugin binary somewhere in the PATH and give it the name 45// "protoc-gen-NAME" (replacing "NAME" with the name of your plugin). If you 46// then invoke protoc with the parameter --NAME_out=OUT_DIR (again, replace 47// "NAME" with your plugin's name), protoc will invoke your plugin to generate 48// the output, which will be placed in OUT_DIR. 49// * Place the plugin binary anywhere, with any name, and pass the --plugin 50// parameter to protoc to direct it to your plugin like so: 51// protoc --plugin=protoc-gen-NAME=path/to/mybinary --NAME_out=OUT_DIR 52// On Windows, make sure to include the .exe suffix: 53// protoc --plugin=protoc-gen-NAME=path/to/mybinary.exe --NAME_out=OUT_DIR 54 55#ifndef GOOGLE_PROTOBUF_COMPILER_PLUGIN_H__ 56#define GOOGLE_PROTOBUF_COMPILER_PLUGIN_H__ 57 58#include <google/protobuf/stubs/common.h> 59 60namespace google { 61namespace protobuf { 62namespace compiler { 63 64class CodeGenerator; // code_generator.h 65 66// Implements main() for a protoc plugin exposing the given code generator. 67LIBPROTOC_EXPORT int PluginMain(int argc, char* argv[], const CodeGenerator* generator); 68 69} // namespace compiler 70} // namespace protobuf 71 72} // namespace google 73#endif // GOOGLE_PROTOBUF_COMPILER_PLUGIN_H__ 74