dds_generator Class Reference

#include <dds_generator.h>

Inheritance diagram for dds_generator:

Public Member Functions
virtual	~dds_generator ()=0
virtual bool	do_included_files () const
virtual void	gen_prologue ()
virtual void	gen_epilogue ()
virtual bool	gen_const (UTL_ScopedName *, bool, AST_Constant *)
virtual bool	gen_enum (AST_Enum *, UTL_ScopedName *, const std::vector< AST_EnumVal *> &, const char *)
virtual bool	gen_struct (AST_Structure *node, UTL_ScopedName *name, const std::vector< AST_Field *> &fields, AST_Type::SIZE_TYPE size, const char *repoid)=0
virtual bool	gen_struct_fwd (UTL_ScopedName *, AST_Type::SIZE_TYPE)
virtual bool	gen_typedef (AST_Typedef *node, UTL_ScopedName *name, AST_Type *base, const char *repoid)=0
virtual bool	gen_interf (AST_Interface *, UTL_ScopedName *, bool, const std::vector< AST_Interface *> &, const std::vector< AST_Interface *> &, const std::vector< AST_Attribute *> &, const std::vector< AST_Operation *> &, const char *)
virtual bool	gen_interf_fwd (UTL_ScopedName *)
virtual bool	gen_native (AST_Native *, UTL_ScopedName *, const char *)
virtual bool	gen_union (AST_Union *node, UTL_ScopedName *name, const std::vector< AST_UnionBranch *> &branches, AST_Type *discriminator, const char *repoid)=0
virtual bool	gen_union_fwd (AST_UnionFwd *, UTL_ScopedName *, AST_Type::SIZE_TYPE)

Static Public Member Functions
static std::string	get_tag_name (const std::string &base_name, bool nested_key_only=false)
static std::string	get_xtag_name (UTL_ScopedName *name)
static bool	cxx_escaped (const std::string &s)
static std::string	valid_var_name (const std::string &str)
static std::string	to_string (Identifier *id, EscapeContext ec=EscapeContext_Normal)
static std::string	scoped_helper (UTL_ScopedName *sn, const char *sep, EscapeContext cxt=EscapeContext_Normal)
static std::string	module_scope_helper (UTL_ScopedName *sn, const char *sep, EscapeContext cxt=EscapeContext_Normal)

Detailed Description

Definition at line 48 of file dds_generator.h.

Constructor & Destructor Documentation

~dds_generator()

dds_generator::~dds_generator ( )

pure virtual

Definition at line 15 of file dds_generator.cpp.

{}

Member Function Documentation

cxx_escaped()

bool dds_generator::cxx_escaped ( const std::string &  s )

static

Definition at line 21 of file dds_generator.cpp.

{
  return s.substr(0, cxx_escape.size()) == cxx_escape;
}

do_included_files()

virtual bool dds_generator::do_included_files ( ) const

inlinevirtual

Reimplemented in itl_generator.

Definition at line 60 of file dds_generator.h.

{ return false; }

gen_const()

virtual bool dds_generator::gen_const ( UTL_ScopedName *  , bool  , AST_Constant *    )

inlinevirtual

Reimplemented in composite_generator, and langmap_generator.

Definition at line 66 of file dds_generator.h.

  { return true; }

gen_enum()

virtual bool dds_generator::gen_enum ( AST_Enum *  , UTL_ScopedName *  , const std::vector< AST_EnumVal *> &  , const char *    )

inlinevirtual

Reimplemented in composite_generator, itl_generator, typeobject_generator, langmap_generator, metaclass_generator, value_reader_generator, value_writer_generator, and marshal_generator.

Definition at line 71 of file dds_generator.h.

References gen_struct().

  { return true; }

gen_epilogue()

virtual void dds_generator::gen_epilogue ( )

inlinevirtual

Reimplemented in composite_generator, itl_generator, and typeobject_generator.

Definition at line 64 of file dds_generator.h.

{}

gen_interf()

virtual bool dds_generator::gen_interf ( AST_Interface *  , UTL_ScopedName *  , bool  , const std::vector< AST_Interface *> &  , const std::vector< AST_Interface *> &  , const std::vector< AST_Attribute *> &  , const std::vector< AST_Operation *> &  , const char *    )

inlinevirtual

Reimplemented in composite_generator.

Definition at line 88 of file dds_generator.h.

  { return true; }

gen_interf_fwd()

virtual bool dds_generator::gen_interf_fwd ( UTL_ScopedName *  )

inlinevirtual

Reimplemented in composite_generator, and langmap_generator.

Definition at line 96 of file dds_generator.h.

  { return true; }

gen_native()

virtual bool dds_generator::gen_native ( AST_Native *  , UTL_ScopedName *  , const char *    )

inlinevirtual

Reimplemented in composite_generator.

Definition at line 99 of file dds_generator.h.

References gen_union().

  { return true; }

gen_prologue()

virtual void dds_generator::gen_prologue ( )

inlinevirtual

Reimplemented in composite_generator, and itl_generator.

Definition at line 62 of file dds_generator.h.

{}

gen_struct()

virtual bool dds_generator::gen_struct ( AST_Structure *  node, UTL_ScopedName *  name, const std::vector< AST_Field *> &  fields, AST_Type::SIZE_TYPE  size, const char *  repoid  )

pure virtual

Implemented in composite_generator, itl_generator, typeobject_generator, ts_generator, langmap_generator, metaclass_generator, value_reader_generator, value_writer_generator, marshal_generator, and keys_generator.

Referenced by gen_enum().

gen_struct_fwd()

virtual bool dds_generator::gen_struct_fwd ( UTL_ScopedName *  , AST_Type::SIZE_TYPE    )

inlinevirtual

Reimplemented in composite_generator, and langmap_generator.

Definition at line 81 of file dds_generator.h.

References gen_typedef().

  { return true; }

gen_typedef()

virtual bool dds_generator::gen_typedef ( AST_Typedef *  node, UTL_ScopedName *  name, AST_Type *  base, const char *  repoid  )

pure virtual

Implemented in composite_generator, itl_generator, typeobject_generator, langmap_generator, ts_generator, metaclass_generator, marshal_generator, keys_generator, value_reader_generator, and value_writer_generator.

Referenced by gen_struct_fwd().

gen_union()

virtual bool dds_generator::gen_union ( AST_Union *  node, UTL_ScopedName *  name, const std::vector< AST_UnionBranch *> &  branches, AST_Type *  discriminator, const char *  repoid  )

pure virtual

Implemented in composite_generator, itl_generator, typeobject_generator, langmap_generator, ts_generator, metaclass_generator, value_reader_generator, value_writer_generator, marshal_generator, and keys_generator.

Referenced by gen_native().

gen_union_fwd()

virtual bool dds_generator::gen_union_fwd ( AST_UnionFwd *  , UTL_ScopedName *  , AST_Type::SIZE_TYPE    )

inlinevirtual

Reimplemented in composite_generator, and langmap_generator.

Definition at line 107 of file dds_generator.h.

References EscapeContext_Normal, module_scope_helper(), scoped_helper(), and to_string().

  { return true; }

get_tag_name()

std::string dds_generator::get_tag_name ( const std::string &  base_name, bool  nested_key_only = false  )

static

Definition at line 61 of file dds_generator.cpp.

Referenced by func(), marshal_generator::gen_enum(), marshal_generator::gen_field_getValueFromSerialized(), metaclass_generator::gen_struct(), metaclass_generator::gen_typedef(), generateCaseBody(), FieldInfo::ref(), and type_to_default_array().

{
  return valid_var_name(base_name) + (nested_key_only ? "_nested_key_only" : "") + "_tag";
}

get_xtag_name()

std::string dds_generator::get_xtag_name ( UTL_ScopedName *  name )

static

Definition at line 66 of file dds_generator.cpp.

Referenced by ts_generator::generate_ts(), and typeobject_generator::tag_type().

{
  return scoped_helper(name, "_") + "_xtag";
}

module_scope_helper()

string dds_generator::module_scope_helper ( UTL_ScopedName *  sn, const char *  sep, EscapeContext  cxt = EscapeContext_Normal  )

static

Definition at line 117 of file dds_generator.cpp.

References EscapeContext_FromGenIdl, EscapeContext_Normal, and OpenDDS::DCPS::to_string().

Referenced by gen_union_fwd(), and module_scope().

{
  string sname;

  for (; sn && sn->tail(); sn = static_cast<UTL_ScopedName*>(sn->tail())) {
    sname += to_string(sn->head(), ec == EscapeContext_FromGenIdl ? EscapeContext_Normal : ec);

    if (sname.size()) {
      sname += sep;
    }
  }

  return sname;
}

scoped_helper()

string dds_generator::scoped_helper ( UTL_ScopedName *  sn, const char *  sep, EscapeContext  cxt = EscapeContext_Normal  )

static

Definition at line 100 of file dds_generator.cpp.

References EscapeContext_FromGenIdl, EscapeContext_Normal, and OpenDDS::DCPS::to_string().

Referenced by canonical_name(), func(), langmap_generator::gen_const(), metaclass_generator::gen_enum(), marshal_generator::gen_field_getValueFromSerialized(), metaclass_generator::gen_struct(), gen_union_fwd(), face_ts_generator::generate(), ts_generator::generate_ts(), generateCaseBody(), and scoped().

{
  string sname;

  for (; sn; sn = static_cast<UTL_ScopedName*>(sn->tail())) {
    const bool not_last = sn->tail();
    sname += to_string(sn->head(),
      (ec == EscapeContext_FromGenIdl && not_last) ? EscapeContext_Normal : ec);

    if (sname.size() && not_last) {
      sname += sep;
    }
  }

  return sname;
}

to_string()

string dds_generator::to_string ( Identifier *  id, EscapeContext  ec = EscapeContext_Normal  )

static

Definition at line 71 of file dds_generator.cpp.

References EscapeContext_ForGenIdl, EscapeContext_FromGenIdl, EscapeContext_Normal, and EscapeContext_StripEscapes.

Referenced by canonical_name(), gen_union_fwd(), ts_generator::generate_ts(), and ScopedNamespaceGuard::ScopedNamespaceGuard().

{
  string str = id->get_string();
  switch (ec) {
  case EscapeContext_ForGenIdl:
    if (id->escaped()) {
      // If it was escaped in the input, it must be escaped in generated IDL.
      if (cxx_escaped(str)) {
        // Strip "_cxx"
        str = str.substr(cxx_escape.size() - 1);
      } else {
        str = '_' + str;
      }
    }
    break;
  case EscapeContext_FromGenIdl:
  case EscapeContext_StripEscapes:
    if (id->escaped() && cxx_escaped(str)) {
      // If this is a C++ keyword that was inserted into generated IDL, the
      // "_cxx_" was stripped.
      str = str.substr(cxx_escape.size());
    }
    break;
  case EscapeContext_Normal:
    break;
  }
  return str;
}

valid_var_name()

std::string dds_generator::valid_var_name ( const std::string &  str )

static

Definition at line 26 of file dds_generator.cpp.

Referenced by marshal_generator::gen_enum().

{
  // Replace invalid characters with a single underscore
  // Replace existing "_" with "_9" to prevent collision
  const std::string invalid_chars("<>()[]*.: ");
  std::string s;
  char last_char = '\0';
  for (size_t i = 0; i < str.size(); ++i) {
    const char c = str[i];
    if (invalid_chars.find(c) == std::string::npos) {
      s.push_back(c);
      last_char = c;
      if (c == '_') {
        s.push_back('9');
        last_char = '9';
      }
    } else if (last_char != '_') {
      s.push_back('_');
      last_char = '_';
    }
  }

  // Remove underscores at start and end
  if (s.size() > 1 && s[0] == '_') {
    if (!cxx_escaped(s)) {
      s.erase(0, 1);
    }
  }
  if (s.size() > 1 && s[s.size() - 1] == '_') {
    s.erase(s.size() - 1, 1);
  }

  return s;
}

---

The documentation for this class was generated from the following files:

• dds_generator.h
• dds_generator.cpp