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