be_produce.cpp

Go to the documentation of this file.

/*

COPYRIGHT

Copyright 1992, 1993, 1994 Sun Microsystems, Inc.  Printed in the United
States of America.  All Rights Reserved.

This product is protected by copyright and distributed under the following
license restricting its use.

The Interface Definition Language Compiler Front End (CFE) is made
available for your use provided that you include this license and copyright
notice on all media and documentation and the software program in which
this product is incorporated in whole or part. You may copy and extend
functionality (but may not remove functionality) of the Interface
Definition Language CFE without charge, but you are not authorized to
license or distribute it to anyone else except as part of a product or
program developed by you or with the express written consent of Sun
Microsystems, Inc. ("Sun").

The names of Sun Microsystems, Inc. and any of its subsidiaries or
affiliates may not be used in advertising or publicity pertaining to
distribution of Interface Definition Language CFE as permitted herein.

This license is effective until terminated by Sun for failure to comply
with this license.  Upon termination, you shall destroy or return all code
and documentation for the Interface Definition Language CFE.

INTERFACE DEFINITION LANGUAGE CFE IS PROVIDED AS IS WITH NO WARRANTIES OF
ANY KIND INCLUDING THE WARRANTIES OF DESIGN, MERCHANTIBILITY AND FITNESS
FOR A PARTICULAR PURPOSE, NONINFRINGEMENT, OR ARISING FROM A COURSE OF
DEALING, USAGE OR TRADE PRACTICE.

INTERFACE DEFINITION LANGUAGE CFE IS PROVIDED WITH NO SUPPORT AND WITHOUT
ANY OBLIGATION ON THE PART OF Sun OR ANY OF ITS SUBSIDIARIES OR AFFILIATES
TO ASSIST IN ITS USE, CORRECTION, MODIFICATION OR ENHANCEMENT.

SUN OR ANY OF ITS SUBSIDIARIES OR AFFILIATES SHALL HAVE NO LIABILITY WITH
RESPECT TO THE INFRINGEMENT OF COPYRIGHTS, TRADE SECRETS OR ANY PATENTS BY
INTERFACE DEFINITION LANGUAGE CFE OR ANY PART THEREOF.

IN NO EVENT WILL SUN OR ANY OF ITS SUBSIDIARIES OR AFFILIATES BE LIABLE FOR
ANY LOST REVENUE OR PROFITS OR OTHER SPECIAL, INDIRECT AND CONSEQUENTIAL
DAMAGES, EVEN IF SUN HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

Use, duplication, or disclosure by the government is subject to
restrictions as set forth in subparagraph (c)(1)(ii) of the Rights in
Technical Data and Computer Software clause at DFARS 252.227-7013 and FAR
52.227-19.

Sun, Sun Microsystems and the Sun logo are trademarks or registered
trademarks of Sun Microsystems, Inc.

SunSoft, Inc.
2550 Garcia Avenue
Mountain View, California  94043

NOTE:

SunOS, SunSoft, Sun, Solaris, Sun Microsystems or the Sun logo are
trademarks or registered trademarks of Sun Microsystems, Inc.

*/

// be_produce.cpp - Produce the work of the BE

#include "global_extern.h"

#include "be_extern.h"
#include "dds_visitor.h"

#include "ast_root.h"
#include "utl_string.h"

#include "ace/OS_NS_strings.h"
#include "ace/OS_NS_sys_time.h"
#include "ace/OS_NS_unistd.h"

#include "../Version.h"
#include "ace/Version.h"

#include <iostream>
#include <fstream>
#include <sstream>
#include <string>
#include <limits>
#include <cassert>

using namespace std;

// Clean up before exit, whether successful or not.
// Need not be exported since it is called only from this file.
void
BE_cleanup()
{
  if (idl_global) {
    idl_global->destroy();
  }
}

// Abort this run of the BE.
void
BE_abort()
{
  ACE_ERROR((LM_ERROR, ACE_TEXT("Fatal Error - Aborting\n")));
  BE_cleanup();
  ACE_OS::exit(1);
}

namespace {

/// generate a macro name for the #ifndef header-double-include protector
string to_macro(const char* fn)
{
  string ret = "OPENDDS_IDL_GENERATED_";

  for (size_t i = 0; i < strlen(fn); ++i) {
    if (isalnum(fn[i])) {
      ret += static_cast<char>(toupper(fn[i]));
    } else if (ret[ret.size() - 1] != '_') {
      ret += '_';
    }
  }

  // Add some random characters since two files of the same name (in different
  // directories) could be used in the same translation unit.  The algorithm
  // for randomness comes from TAO_IDL's implementation.

  const size_t NUM_CHARS = 6;

  const ACE_Time_Value now = ACE_OS::gettimeofday();
  ACE_UINT64 msec;
  now.msec(msec);

  msec += ACE_OS::getpid() + (size_t) ACE_OS::thr_self();

  unsigned int seed = static_cast<unsigned int>(msec);

  if (ret[ret.size() - 1] != '_') ret += '_';
  static const char alphanum[] =
    "0123456789"
    "ABCDEFGHIJKLMNOPQRSTUVWXYZ";

  for (unsigned int n = 0; n < NUM_CHARS; ++n) {
    ret += alphanum[ACE_OS::rand_r(&seed) % (sizeof(alphanum) - 1)];
  }

  return ret;
}

/// change *.cpp to *.h
string to_header(const char* cpp_name)
{
  size_t len = strlen(cpp_name);
  assert(len >= 5 && 0 == ACE_OS::strcasecmp(cpp_name + len - 4, ".cpp"));
  string base_name(cpp_name, len - 4);
  return base_name + ".h";
}

void postprocess(const char* fn, ostringstream& content,
                 BE_GlobalData::stream_enum_t which)
{
  ostringstream out;

  if (which == BE_GlobalData::STREAM_H ||
      which == BE_GlobalData::STREAM_LANG_H) {
    out << "/* -*- C++ -*- */\n";
  }

  out << "/* Generated by " << idl_global->prog_name()
      << " version " OPENDDS_VERSION " (ACE version " ACE_VERSION
      << ") running on input file "
      << idl_global->main_filename()->get_string()
      << " */\n";

  //  if .h add #ifndef...#define
  string macrofied;

  switch (which) {
  case BE_GlobalData::STREAM_H:
  case BE_GlobalData::STREAM_FACETS_H:
  case BE_GlobalData::STREAM_LANG_H: {
    macrofied = to_macro(fn);
    out << "#ifndef " << macrofied << "\n#define " << macrofied << '\n';
    if (which == BE_GlobalData::STREAM_H) {
      out <<
        "\n"
        "#include <dds/Version.h>\n"
        "#if !OPENDDS_VERSION_EXACTLY(" << OPENDDS_MAJOR_VERSION
          << ", " << OPENDDS_MINOR_VERSION
          << ", " << OPENDDS_MICRO_VERSION << ")\n"
        "#  error \"This file should be regenerated with opendds_idl\"\n"
        "#endif\n"
        "#include <dds/DCPS/Definitions.h>\n"
        "\n"
        "#include <dds/DdsDcpsC.h>\n"
        "\n";
    }
    if (which == BE_GlobalData::STREAM_LANG_H) {
      if (be_global->language_mapping() == BE_GlobalData::LANGMAP_FACE_CXX ||
          be_global->language_mapping() == BE_GlobalData::LANGMAP_SP_CXX) {
        out <<
          "#include <tao/orbconf.h>\n"
          "#include <tao/Basic_Types_IDLv4.h>\n"
          "TAO_BEGIN_VERSIONED_NAMESPACE_DECL\n"
          "namespace CORBA {\n"
          "  using namespace IDLv4;\n"
          "}\n"
          "TAO_END_VERSIONED_NAMESPACE_DECL\n";
      }
    } else {
      string taoheader = be_global->header_name_.c_str();
      taoheader.replace(taoheader.find("TypeSupportImpl.h"), 17, "C.h");
      const bool explicit_ints = be_global->tao_inc_pre_.length()
        && (taoheader == "Int8SeqC.h" || taoheader == "UInt8SeqC.h");
      std::string indent;
      if (explicit_ints) {
        out << "#if OPENDDS_HAS_EXPLICIT_INTS\n";
        indent = "  ";
      }
      out << "#" << indent << "include \"" << be_global->tao_inc_pre_ << taoheader << "\"\n";
      if (explicit_ints) {
        out << "#endif\n";
      }
    }
  }
  break;
  case BE_GlobalData::STREAM_CPP: {
    ACE_CString pch = be_global->pch_include();
    if (pch.length()) {
      out << "#include \"" << pch << "\"\n";
    }
    if (be_global->java_arg().length() == 0) {
      string header = to_header(fn);
      out << "#include \"" << header << "\"\n\n";
    } else {
      out << "#include \"" << be_global->header_name_.c_str() << "\"\n\n";
    }
  }
  break;
  case BE_GlobalData::STREAM_FACETS_CPP: {
    ACE_CString pch = be_global->pch_include();
    if (pch.length()) {
      out << "#include \"" << pch << "\"\n";
    }
    out << "#include \"" << be_global->facets_header_name_.c_str() << "\"\n"
      "#include \"" << be_global->header_name_.c_str() << "\"\n"
      "#include \"dds/FACE/FaceTSS.h\"\n\n"
      "namespace FACE { namespace TS {\n\n";
  }
  break;
  case BE_GlobalData::STREAM_IDL: {
    macrofied = to_macro(fn);
    out << "#ifndef " << macrofied << "\n#define " << macrofied << '\n';

#ifdef ACE_HAS_CDR_FIXED
    out << "#define __OPENDDS_IDL_HAS_FIXED\n";
#endif

    string filebase(be_global->filename());
    const size_t idx = filebase.find_last_of("/\\"); // allow either slash
    if (idx != string::npos) {
      filebase = filebase.substr(idx + 1);
    }
    out << "#include \"" << filebase << "\"\n\n";
  }
  break;
  default:
    ;
  }

  out << be_global->get_include_block(which);

  out << content.str();

  switch (which) {
  case BE_GlobalData::STREAM_H:
  case BE_GlobalData::STREAM_IDL:
  case BE_GlobalData::STREAM_FACETS_H:
  case BE_GlobalData::STREAM_LANG_H:
    out << "#endif /* " << macrofied << " */\n";
    break;
  case BE_GlobalData::STREAM_FACETS_CPP:
    out << "}}\n";
    break;
  default:
    ;
  }

  if (!BE_GlobalData::writeFile(fn, out.str())) {
    BE_abort();  //error message already printed
  }
}

} // namespace

// Do the work of this BE. This is the starting point for code generation.
void
BE_produce()
{
  const char* idl_fn = idl_global->main_filename()->get_string();
  be_global->filename(idl_fn);

  const BE_GlobalData::stream_enum_t out_stream =
    be_global->language_mapping() == BE_GlobalData::LANGMAP_NONE
    ? BE_GlobalData::STREAM_H : BE_GlobalData::STREAM_LANG_H;

  ifstream idl(idl_fn);
  const size_t buffer_sz = 512;
  char buffer[buffer_sz];
  unsigned lineno = 0;

  while (idl) {
    idl.getline(buffer, buffer_sz);
    ++lineno;

    // search for #includes in the IDL, add them as #includes in the stubs/skels
    if (0 == strncmp("#include", buffer, 8)) { //FUTURE: account for comments?
      string inc(buffer + 8);
      size_t delim1 = inc.find_first_of("<\"");
      size_t delim2 = inc.find_first_of(">\"", delim1 + 1);
      string included(inc, delim1 + 1, delim2 - delim1 - 1);
      size_t len = included.size();
      string base_name;

      if (len >= 5 &&
          0 == ACE_OS::strcasecmp(included.c_str() + len - 4, ".idl")) {
        base_name.assign(included.c_str(), len - 4);

      } else if (len >= 6 &&
                 0 == ACE_OS::strcasecmp(included.c_str() + len - 5, ".pidl")) {
        base_name.assign(included.c_str(), len - 5);

      } else {
        continue;
      }

      if (be_global->language_mapping() == BE_GlobalData::LANGMAP_SP_CXX &&
          base_name.substr(0, 4) == "tao/" &&
          base_name.substr(base_name.size() - 3) == "Seq") {
        continue; // with Safety Profile C++, skip include of tao/*SeqC.h
      }

      string stb_inc = base_name + "C.h";
      if (stb_inc != "tao/orbC.h") {
        be_global->add_include(stb_inc.c_str(), out_stream);
        if (stb_inc == "orbC.h" ||
            (stb_inc.size() >= 7
            && stb_inc.substr(stb_inc.size() - 7) == "/orbC.h") ) {
          be_global->warning(
            "Potential inclusion of TAO orbC.h\n"
            "  Include TAO orb.idl with path of tao/orb.idl"
            "  to prevent compilation errors",
            idl_fn, lineno);
        }
      }

    }
  }

  idl.close();

  be_global->open_streams(idl_fn);

  AST_Decl* d = idl_global->root();
  AST_Root* root = dynamic_cast<AST_Root*>(d);

  if (root == 0) {
    ACE_ERROR((LM_ERROR,
               ACE_TEXT("(%N:%l) BE_produce - ")
               ACE_TEXT("No Root\n")));

    BE_abort();
  }

  be_global->set_inc_paths(idl_global->idl_flags());

  const bool java_ts_only = be_global->java_arg().length() > 0;

  dds_visitor visitor(d, java_ts_only);

  if (root->ast_accept(&visitor) == -1) {
    ACE_ERROR((LM_ERROR,
               ACE_TEXT("(%N:%l) BE_produce -")
               ACE_TEXT(" failed to accept adding visitor\n")));
    BE_abort();
  }

  if (!java_ts_only) {
    postprocess(be_global->header_name_.c_str(),
                be_global->header_, BE_GlobalData::STREAM_H);
    if (!be_global->suppress_idl()) {
      postprocess(be_global->idl_name_.c_str(),
                  be_global->idl_, BE_GlobalData::STREAM_IDL);
    }
  }

  postprocess(be_global->impl_name_.c_str(),
              be_global->impl_, BE_GlobalData::STREAM_CPP);

  if (be_global->itl()) {
    if (!BE_GlobalData::writeFile(be_global->itl_name_.c_str(), be_global->itl_.str())) {
      BE_abort();  //error message already printed
    }
  }

  if (be_global->face_ts()) {
    postprocess(be_global->facets_header_name_.c_str(), be_global->facets_header_,
                BE_GlobalData::STREAM_FACETS_H);
    postprocess(be_global->facets_impl_name_.c_str(), be_global->facets_impl_,
                BE_GlobalData::STREAM_FACETS_CPP);
  }

  if (be_global->language_mapping() != BE_GlobalData::LANGMAP_NONE) {
    postprocess(be_global->lang_header_name_.c_str(), be_global->lang_header_,
                BE_GlobalData::STREAM_LANG_H);
  }

  BE_cleanup();
}