csharp_options.h 3.5 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182
  1. // Protocol Buffers - Google's data interchange format
  2. // Copyright 2008 Google Inc. All rights reserved.
  3. // https://developers.google.com/protocol-buffers/
  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. #ifndef GOOGLE_PROTOBUF_COMPILER_CSHARP_OPTIONS_H__
  31. #define GOOGLE_PROTOBUF_COMPILER_CSHARP_OPTIONS_H__
  32. #include <string>
  33. namespace google {
  34. namespace protobuf {
  35. namespace compiler {
  36. namespace csharp {
  37. // Generator options (used by csharp_generator.cc):
  38. struct Options {
  39. Options() :
  40. file_extension(".cs"),
  41. base_namespace(""),
  42. base_namespace_specified(false),
  43. internal_access(false),
  44. serializable(false) {
  45. }
  46. // Extension of the generated file. Defaults to ".cs"
  47. std::string file_extension;
  48. // Base namespace to use to create directory hierarchy. Defaults to "".
  49. // This option allows the simple creation of a conventional C# file layout,
  50. // where directories are created relative to a project-specific base
  51. // namespace. For example, in a project with a base namespace of PetShop, a
  52. // proto of user.proto with a C# namespace of PetShop.Model.Shared would
  53. // generate Model/Shared/User.cs underneath the specified --csharp_out
  54. // directory.
  55. //
  56. // If no base namespace is specified, all files are generated in the
  57. // --csharp_out directory, with no subdirectories created automatically.
  58. std::string base_namespace;
  59. // Whether the base namespace has been explicitly specified by the user.
  60. // This is required as the base namespace can be explicitly set to the empty
  61. // string, meaning "create a full directory hierarchy, starting from the first
  62. // segment of the namespace."
  63. bool base_namespace_specified;
  64. // Whether the generated classes should have accessibility level of "internal".
  65. // Defaults to false that generates "public" classes.
  66. bool internal_access;
  67. // Whether the generated classes should have a global::System.Serializable attribute added
  68. // Defaults to false
  69. bool serializable;
  70. };
  71. } // namespace csharp
  72. } // namespace compiler
  73. } // namespace protobuf
  74. } // namespace google
  75. #endif // GOOGLE_PROTOBUF_COMPILER_CSHARP_OPTIONS_H__