cpp/include/Slice/RubyUtil.h

   1 // **********************************************************************
   2 //
   3 // Copyright (c) 2003-2011 ZeroC, Inc. All rights reserved.
   4 //
   5 // This copy of Ice is licensed to you under the terms described in the
   6 // ICE_LICENSE file included in this distribution.
   7 //
   8 // **********************************************************************
   9
  10 #ifndef SLICE_RUBY_UTIL_H
  11 #define SLICE_RUBY_UTIL_H
  12
  13 #include <Slice/Parser.h>
  14 #include <IceUtil/OutputUtil.h>
  15
  16 namespace Slice
  17 {
  18 namespace Ruby
  19 {
  20
  21 //
  22 // Generate Ruby code for a translation unit.
  23 //
  24 SLICE_API void generate(const Slice::UnitPtr&, bool, bool, const std::vector<std::string>&, IceUtilInternal::Output&);
  25
  26 //
  27 // Check the given identifier against Ruby's list of reserved words. If it matches
  28 // a reserved word, then an escaped version is returned with a leading underscore.
  29 //
  30 enum IdentStyle
  31 {
  32     IdentNormal,
  33     IdentToUpper, // Mapped identifier must begin with an upper-case letter.
  34     IdentToLower  // Mapped identifier must begin with a lower-case letter.
  35 };
  36 SLICE_API std::string fixIdent(const std::string&, IdentStyle);
  37
  38 //
  39 // Get the fully-qualified name of the given definition. If a prefix is provided,
  40 // it is prepended to the definition's unqualified name.
  41 //
  42 SLICE_API std::string getAbsolute(const Slice::ContainedPtr&, IdentStyle, const std::string& = std::string());
  43
  44 //
  45 // Emit a comment header.
  46 //
  47 SLICE_API void printHeader(IceUtilInternal::Output&);
  48
  49 }
  50 }
  51
  52 #endif