Home | History | Annotate | Download | only in compiler 
      1 /*
      2  *
      3  * Copyright 2015, Google Inc.
      4  * All rights reserved.
      5  *
      6  * Redistribution and use in source and binary forms, with or without
      7  * modification, are permitted provided that the following conditions are
      8  * met:
      9  *
     10  *     * Redistributions of source code must retain the above copyright
     11  * notice, this list of conditions and the following disclaimer.
     12  *     * Redistributions in binary form must reproduce the above
     13  * copyright notice, this list of conditions and the following disclaimer
     14  * in the documentation and/or other materials provided with the
     15  * distribution.
     16  *     * Neither the name of Google Inc. nor the names of its
     17  * contributors may be used to endorse or promote products derived from
     18  * this software without specific prior written permission.
     19  *
     20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
     21  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
     22  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
     23  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
     24  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
     25  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
     26  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
     27  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
     28  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
     29  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
     30  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
     31  *
     32  */
     33 
     34 #ifndef GRPC_INTERNAL_COMPILER_CPP_GENERATOR_H
     35 #define GRPC_INTERNAL_COMPILER_CPP_GENERATOR_H
     36 
     37 // cpp_generator.h/.cc do not directly depend on GRPC/ProtoBuf, such that they
     38 // can be used to generate code for other serialization systems, such as
     39 // FlatBuffers.
     40 
     41 #include <memory>
     42 #include <vector>
     43 
     44 #include "src/compiler/config.h"
     45 #include "src/compiler/schema_interface.h"
     46 
     47 #ifndef GRPC_CUSTOM_STRING
     48 #include <string>
     49 #define GRPC_CUSTOM_STRING std::string
     50 #endif
     51 
     52 namespace grpc {
     53 
     54 typedef GRPC_CUSTOM_STRING string;
     55 
     56 }  // namespace grpc
     57 
     58 namespace grpc_cpp_generator {
     59 
     60 // Contains all the parameters that are parsed from the command line.
     61 struct Parameters {
     62   // Puts the service into a namespace
     63   grpc::string services_namespace;
     64   // Use system includes (<>) or local includes ("")
     65   bool use_system_headers;
     66   // Prefix to any grpc include
     67   grpc::string grpc_search_path;
     68   // Generate GMOCK code to facilitate unit testing.
     69   bool generate_mock_code;
     70 };
     71 
     72 // Return the prologue of the generated header file.
     73 grpc::string GetHeaderPrologue(grpc_generator::File *file,
     74                                const Parameters &params);
     75 
     76 // Return the includes needed for generated header file.
     77 grpc::string GetHeaderIncludes(grpc_generator::File *file,
     78                                const Parameters &params);
     79 
     80 // Return the includes needed for generated source file.
     81 grpc::string GetSourceIncludes(grpc_generator::File *file,
     82                                const Parameters &params);
     83 
     84 // Return the epilogue of the generated header file.
     85 grpc::string GetHeaderEpilogue(grpc_generator::File *file,
     86                                const Parameters &params);
     87 
     88 // Return the prologue of the generated source file.
     89 grpc::string GetSourcePrologue(grpc_generator::File *file,
     90                                const Parameters &params);
     91 
     92 // Return the services for generated header file.
     93 grpc::string GetHeaderServices(grpc_generator::File *file,
     94                                const Parameters &params);
     95 
     96 // Return the services for generated source file.
     97 grpc::string GetSourceServices(grpc_generator::File *file,
     98                                const Parameters &params);
     99 
    100 // Return the epilogue of the generated source file.
    101 grpc::string GetSourceEpilogue(grpc_generator::File *file,
    102                                const Parameters &params);
    103 
    104 // Return the prologue of the generated mock file.
    105 grpc::string GetMockPrologue(grpc_generator::File *file,
    106                              const Parameters &params);
    107 
    108 // Return the includes needed for generated mock file.
    109 grpc::string GetMockIncludes(grpc_generator::File *file,
    110                              const Parameters &params);
    111 
    112 // Return the services for generated mock file.
    113 grpc::string GetMockServices(grpc_generator::File *file,
    114                              const Parameters &params);
    115 
    116 // Return the epilogue of generated mock file.
    117 grpc::string GetMockEpilogue(grpc_generator::File *file,
    118                              const Parameters &params);
    119 
    120 // Return the prologue of the generated mock file.
    121 grpc::string GetMockPrologue(grpc_generator::File *file,
    122                              const Parameters &params);
    123 
    124 // Return the includes needed for generated mock file.
    125 grpc::string GetMockIncludes(grpc_generator::File *file,
    126                              const Parameters &params);
    127 
    128 // Return the services for generated mock file.
    129 grpc::string GetMockServices(grpc_generator::File *file,
    130                              const Parameters &params);
    131 
    132 // Return the epilogue of generated mock file.
    133 grpc::string GetMockEpilogue(grpc_generator::File *file,
    134                              const Parameters &params);
    135 
    136 }  // namespace grpc_cpp_generator
    137 
    138 #endif  // GRPC_INTERNAL_COMPILER_CPP_GENERATOR_H
    139