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

http://github.com/tomahawk-player/tomahawk · C++ Header · 73 lines · 12 code · 8 blank · 53 comment · 0 complexity · f0c0534b2384e349f9831894dd978c56 MD5 · raw file

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