• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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 #ifndef GOOGLE_PROTOBUF_COMPILER_CSHARP_OPTIONS_H__
32 #define GOOGLE_PROTOBUF_COMPILER_CSHARP_OPTIONS_H__
33 
34 #include <string>
35 
36 #include <google/protobuf/stubs/common.h>
37 namespace google {
38 namespace protobuf {
39 namespace compiler {
40 namespace csharp {
41 
42 // Generator options (used by csharp_generator.cc):
43 struct Options {
OptionsOptions44   Options() :
45       file_extension(".cs"),
46       base_namespace(""),
47       base_namespace_specified(false),
48       internal_access(false),
49       legacy_enum_values(false) {
50   }
51   // Extension of the generated file. Defaults to ".cs"
52   string file_extension;
53   // Base namespace to use to create directory hierarchy. Defaults to "".
54   // This option allows the simple creation of a conventional C# file layout,
55   // where directories are created relative to a project-specific base
56   // namespace. For example, in a project with a base namespace of PetShop, a
57   // proto of user.proto with a C# namespace of PetShop.Model.Shared would
58   // generate Model/Shared/User.cs underneath the specified --csharp_out
59   // directory.
60   //
61   // If no base namespace is specified, all files are generated in the
62   // --csharp_out directory, with no subdirectories created automatically.
63   string base_namespace;
64   // Whether the base namespace has been explicitly specified by the user.
65   // This is required as the base namespace can be explicitly set to the empty
66   // string, meaning "create a full directory hierarchy, starting from the first
67   // segment of the namespace."
68   bool base_namespace_specified;
69   // Whether the generated classes should have accessibility level of "internal".
70   // Defaults to false that generates "public" classes.
71   bool internal_access;
72   // By default, C# codegen now uses PascalCased enum values names, after
73   // removing the enum type name as a prefix (if it *is* a prefix of the value).
74   // Setting this option reverts to the previous behavior of just copying the
75   // value name specified in the .proto file, allowing gradual migration.
76   // This option will be removed before final release.
77   bool legacy_enum_values;
78 };
79 
80 }  // namespace csharp
81 }  // namespace compiler
82 }  // namespace protobuf
83 
84 
85 }  // namespace google
86 #endif  // GOOGLE_PROTOBUF_COMPILER_CSHARP_OPTIONS_H__
87