compiler/cpp/src/generate/t_oop_generator.h

   1 // Copyright (c) 2006- Facebook
   2 // Distributed under the Thrift Software License
   3 //
   4 // See accompanying file LICENSE or visit the Thrift site at:
   5 // http://developers.facebook.com/thrift/
   6
   7 #ifndef T_OOP_GENERATOR_H
   8 #define T_OOP_GENERATOR_H
   9
  10 #include "globals.h"
  11 #include "t_generator.h"
  12
  13 /**
  14  * Class with utility methods shared across common object oriented languages.
  15  * Specifically, most of this stuff is for C++/Java.
  16  *
  17  * @author Mark Slee <mcslee@facebook.com>
  18  */
  19 class t_oop_generator : public t_generator {
  20  public:
  21   t_oop_generator(t_program* program) :
  22     t_generator(program) {}
  23
  24   /**
  25    * Scoping, using curly braces!
  26    */
  27
  28   void scope_up(std::ostream& out) {
  29     indent(out) << "{" << std::endl;
  30     indent_up();
  31   }
  32
  33   void scope_down(std::ostream& out) {
  34     indent_down();
  35     indent(out) << "}" << std::endl;
  36   }
  37
  38   /**
  39    * Generates a comment about this code being autogenerated, using C++ style
  40    * comments, which are also fair game in Java / PHP, yay!
  41    *
  42    * @return C-style comment mentioning that this file is autogenerated.
  43    */
  44   virtual std::string autogen_comment() {
  45     return
  46       std::string("/**\n") +
  47       " * Autogenerated by Thrift\n" +
  48       " *\n" +
  49       " * DO NOT EDIT UNLESS YOU ARE SURE THAT YOU KNOW WHAT YOU ARE DOING\n" +
  50       " */\n";
  51   }
  52 };
  53
  54 #endif
  55