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 (at) 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 43 namespace google { 44 namespace protobuf { 45 46 class Descriptor; 47 class EnumDescriptor; 48 class FileDescriptor; 49 class ServiceDescriptor; 50 51 namespace compiler { 52 namespace csharp { 53 54 // Requires: 55 // descriptor != NULL 56 // 57 // Returns: 58 // The namespace to use for given file descriptor. 59 string GetFileNamespace(const FileDescriptor* descriptor); 60 61 // Requires: 62 // descriptor != NULL 63 // 64 // Returns: 65 // The fully-qualified C# class name. 66 string GetClassName(const Descriptor* descriptor); 67 68 // Requires: 69 // descriptor != NULL 70 // 71 // Returns: 72 // The fully-qualified name of the C# class that provides 73 // access to the file descriptor. Proto compiler generates 74 // such class for each .proto file processed. 75 string GetReflectionClassName(const FileDescriptor* descriptor); 76 77 // Generates output file name for given file descriptor. If generate_directories 78 // is true, the output file will be put under directory corresponding to file's 79 // namespace. base_namespace can be used to strip some of the top level 80 // directories. E.g. for file with namespace "Bar.Foo" and base_namespace="Bar", 81 // the resulting file will be put under directory "Foo" (and not "Bar/Foo"). 82 // 83 // Requires: 84 // descriptor != NULL 85 // error != NULL 86 // 87 // Returns: 88 // The file name to use as output file for given file descriptor. In case 89 // of failure, this function will return empty string and error parameter 90 // will contain the error message. 91 string GetOutputFile( 92 const google::protobuf::FileDescriptor* descriptor, 93 const string file_extension, 94 const bool generate_directories, 95 const string base_namespace, 96 string* error); 97 98 } // namespace csharp 99 } // namespace compiler 100 } // namespace protobuf 101 } // namespace google 102 103 #endif // GOOGLE_PROTOBUF_COMPILER_CSHARP_NAMES_H__ 104
