csharp_names.h 3.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104
  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. // Author: kenton@google.com (Kenton Varda)
  31. // Based on original Protocol Buffers design by
  32. // Sanjay Ghemawat, Jeff Dean, and others.
  33. //
  34. // Provides a mechanism for mapping a descriptor to the
  35. // fully-qualified name of the corresponding C# class.
  36. #ifndef GOOGLE_PROTOBUF_COMPILER_CSHARP_NAMES_H__
  37. #define GOOGLE_PROTOBUF_COMPILER_CSHARP_NAMES_H__
  38. #include <string>
  39. #include <google/protobuf/stubs/port.h>
  40. namespace google {
  41. namespace protobuf {
  42. class Descriptor;
  43. class EnumDescriptor;
  44. class FileDescriptor;
  45. class ServiceDescriptor;
  46. namespace compiler {
  47. namespace csharp {
  48. // Requires:
  49. // descriptor != NULL
  50. //
  51. // Returns:
  52. // The namespace to use for given file descriptor.
  53. string LIBPROTOC_EXPORT GetFileNamespace(const FileDescriptor* descriptor);
  54. // Requires:
  55. // descriptor != NULL
  56. //
  57. // Returns:
  58. // The fully-qualified C# class name.
  59. string LIBPROTOC_EXPORT GetClassName(const Descriptor* descriptor);
  60. // Requires:
  61. // descriptor != NULL
  62. //
  63. // Returns:
  64. // The fully-qualified name of the C# class that provides
  65. // access to the file descriptor. Proto compiler generates
  66. // such class for each .proto file processed.
  67. string LIBPROTOC_EXPORT GetReflectionClassName(const FileDescriptor* descriptor);
  68. // Generates output file name for given file descriptor. If generate_directories
  69. // is true, the output file will be put under directory corresponding to file's
  70. // namespace. base_namespace can be used to strip some of the top level
  71. // directories. E.g. for file with namespace "Bar.Foo" and base_namespace="Bar",
  72. // the resulting file will be put under directory "Foo" (and not "Bar/Foo").
  73. //
  74. // Requires:
  75. // descriptor != NULL
  76. // error != NULL
  77. //
  78. // Returns:
  79. // The file name to use as output file for given file descriptor. In case
  80. // of failure, this function will return empty string and error parameter
  81. // will contain the error message.
  82. string LIBPROTOC_EXPORT GetOutputFile(
  83. const google::protobuf::FileDescriptor* descriptor,
  84. const string file_extension,
  85. const bool generate_directories,
  86. const string base_namespace,
  87. string* error);
  88. } // namespace csharp
  89. } // namespace compiler
  90. } // namespace protobuf
  91. } // namespace google
  92. #endif // GOOGLE_PROTOBUF_COMPILER_CSHARP_NAMES_H__