Merge pull request #2301 from sonndinh/remove-dup-reactor-functions

[ACE_TAO.git] / TAO / TAO_IDL / driver / drv_preproc.cpp

/*

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.

*/

// Pass an IDL file through the C preprocessor


#include "idl_defines.h"
#include "global_extern.h"
#include "fe_extern.h"
#include "drv_extern.h"
#include "utl_string.h"
#include "utl_err.h"

#include "ace/Version.h"
#include "ace/Process.h"
#include "ace/SString.h"
#include "ace/Env_Value_T.h"
#include "ace/ARGV.h"
#include "ace/Dirent.h"
#include "ace/OS_NS_sys_stat.h"
#include "ace/Truncate.h"

// FUZZ: disable check_for_streams_include
#include "ace/streams.h"

#include "ace/OS_NS_stdio.h"
#include "ace/OS_NS_unistd.h"
#include "ace/OS_NS_fcntl.h"
#include "ace/OS_NS_sys_stat.h"

// Storage for preprocessor args.
unsigned long const DRV_MAX_ARGCOUNT = 1024;
unsigned long DRV_argcount = 0;
ACE_TCHAR const * DRV_arglist[DRV_MAX_ARGCOUNT] = { nullptr };

static char const * output_arg_format = nullptr;
static long output_arg_index = 0;

ACE_TCHAR const TCHAR_DIR_DOT[] = ACE_TEXT(".");

#if defined (ACE_HAS_TCHAR_DIRENT)
// ACE_TCHAR const DIR_DOT[] = ACE_TEXT(".");
ACE_TCHAR const DIR_DOT_DOT[] = ACE_TEXT("..");
#else
// char const DIR_DOT[] = ".";
char const DIR_DOT_DOT[] = "..";
#endif /* ACE_HAS_TCHAR_DIRENT */

// File names.
static char tmp_file [MAXPATHLEN + 1] = { 0 };
static char tmp_ifile[MAXPATHLEN + 1] = { 0 };

// Lines can be 1024 chars long intially -
// it will expand as required.
#define LINEBUF_SIZE 1024
char* drv_line = nullptr;
static size_t drv_line_size = LINEBUF_SIZE + 1;

// Push the new CPP location if we got a -Yp argument.
void
DRV_cpp_new_location (char const * new_loc)
{
  ACE::strdelete (const_cast<ACE_TCHAR *> (DRV_arglist[0]));
  DRV_arglist[0] =
    ACE::strnew (ACE_TEXT_CHAR_TO_TCHAR (new_loc));
}

// Push an argument into the DRV_arglist.
void
DRV_cpp_putarg (const char *str)
{
  if (DRV_argcount >= DRV_MAX_ARGCOUNT)
    {
      ACE_ERROR ((LM_ERROR,
                  "%C: More than %d arguments to preprocessor\n",
                  idl_global->prog_name (),
                  DRV_MAX_ARGCOUNT ));

      throw Bailout ();
    }

  char *replace = nullptr;
  if (str)
    {
      bool allocate_error = false;

#ifdef ACE_WIN32
      const char *const first_quote = ACE_OS::strchr (str, '"');
      if (first_quote)
        {
          // Escape Doublequotes on Windows

          size_t quote_count = 0;
          for (const char *quote = first_quote; quote; quote = ACE_OS::strchr (quote, '"'))
            {
              ++quote_count;
              ++quote;
            }

          ACE_NEW_NORETURN (replace, char[ACE_OS::strlen (str) + quote_count + 1]);
          allocate_error = !replace;
          if (replace)
            {
              char *to = replace;
              for (const char *from = str; *from; ++from)
                {
                  if (*from == '"')
                    {
                      *to = '\\';
                      ++to;
                    }
                  *to = *from;
                  ++to;
                }
              *to = '\0';
            }
        }
#endif
      if (ACE_OS::strchr (str, ' '))
        {
          ACE_NEW_NORETURN (replace, char[ACE_OS::strlen (str) + 3]);
          allocate_error = !replace;
          if (replace)
            {
              replace[0] = '"';
              ACE_OS::strcpy (replace + 1, str);
              ACE_OS::strcat (replace, "\"");
            }
        }

      if (allocate_error)
        {
          idl_global->err()->misc_error ("DRV_cpp_putarg failed to allocate memory for argument!");
          throw Bailout ();
        }
    }

  DRV_arglist[DRV_argcount++] = ACE::strnew (ACE_TEXT_CHAR_TO_TCHAR (replace ? replace : str));

  if (replace)
    {
      delete [] replace;
      replace = nullptr;
    }
}

// Expand the output argument with the given filename.
void
DRV_cpp_expand_output_arg (const char *filename)
{
  if (output_arg_format != nullptr)
    {
      ACE::strdelete (const_cast<ACE_TCHAR *> (
                        DRV_arglist[output_arg_index]));
      DRV_arglist[output_arg_index] = nullptr;

      ACE_NEW (DRV_arglist[output_arg_index],
               ACE_TCHAR [ACE_OS::strlen (output_arg_format)
                     + ACE_OS::strlen (filename)
                     + 1]);

      ACE_OS::sprintf (const_cast<ACE_TCHAR *> (
                         DRV_arglist[output_arg_index]),
                       ACE_TEXT_CHAR_TO_TCHAR (output_arg_format),
                       ACE_TEXT_CHAR_TO_TCHAR (filename));
    }
}

// calculate the total size of all commandline arguments
unsigned int
DRV_cpp_calc_total_argsize()
{
  unsigned long size = 0;
  unsigned long ix = 0;
  while (DRV_arglist[ix] != nullptr)
    {
      size += ACE_Utils::truncate_cast<unsigned long> (ACE_OS::strlen (DRV_arglist[ix]) + 1);
      ++ix;
    }
  return size;
}

// Get a line from stdin.
static bool
DRV_get_line (FILE *file)
{
  char *line = ACE_OS::fgets (drv_line,
                              ACE_Utils::truncate_cast<int> (drv_line_size),
                              file);
  if (!line || (!*line && feof (file)))
    {
      // End of file, nothing else read in.
      return false;
    }

  do
    {
      // Check for line continuation escape...
      size_t len = ACE_OS::strlen (drv_line);
      if (2 <= len &&
          '\n' == drv_line [len-1] &&
          '\\' == drv_line [len-2]    )
        {
          // This is a "false" end-of-line, remove token
          len-= 2;
          drv_line [len]= '\0';
        }

      // Check for end-of-line
      if (len && '\n' == drv_line [len-1])
        {
          // Replace the end-of-line with a null
          drv_line [len-1] = '\0';
          return true;
        }

      // Need to continue to read more of this line in,
      // is there enough space left in the buffer?
      if (drv_line_size - len < 10)
        {
          // Create a bigger buffer
          size_t temp_size = drv_line_size * 2;
          char *temp = nullptr;
          ACE_NEW_RETURN (temp, char [temp_size], false);
          ACE_OS::strcpy (temp, drv_line);
          delete [] drv_line;
          drv_line = temp;
          drv_line_size = temp_size;
        }

      line = ACE_OS::fgets (drv_line + len,
                            ACE_Utils::truncate_cast<int> (drv_line_size - len),
                            file);
    } while (line && *line);

  return true;
}

// Initialize the cpp argument list.
void
DRV_cpp_init ()
{
  // Create the line buffer.
  // (JP) Deleting this at the end or DRV_pre_proc() causes
  // Purify to output a Freeing Mismatched Memory warning.
  // When it is not deleted (currently the case) there is no
  // memory leak reported by Purify. I don't know why.
  ACE_NEW (drv_line,
           char [drv_line_size]);

  char const * const cpp_loc = FE_get_cpp_loc_from_env ();
  DRV_cpp_putarg (cpp_loc);

  // Add an option to the IDL compiler to make the TAO version
  // available to the user. A XX.YY.ZZ release gets
  // version 0xXXYYZZ, for example, 5.1.14 gets 0x050114.
  char version_option[128];
  ACE_OS::sprintf (version_option,
                   "-D__TAO_IDL=0x%2.2d%2.2d%2.2d",
                   ACE_MAJOR_VERSION,
                   ACE_MINOR_VERSION,
                   ACE_MICRO_VERSION);

  DRV_cpp_putarg (version_option);
  DRV_cpp_putarg ("-I.");

  const char *platform_cpp_args =
    FE_get_cpp_args_from_env ();

  if (platform_cpp_args == nullptr)
    {
      // If no cpp flag was defined by the user, we define some
      // platform specific flags here.

#if defined (TAO_IDL_PREPROCESSOR_ARGS)
      platform_cpp_args = TAO_IDL_PREPROCESSOR_ARGS;
#elif defined (ACE_CC_PREPROCESSOR_ARGS)
      platform_cpp_args = ACE_CC_PREPROCESSOR_ARGS;
#else
      platform_cpp_args = "-E";
#endif /* TAO_IDL_PREPROCESSOR_ARGS */

      // So we can find OMG IDL files, such as `orb.idl'.
      ACE_CString include_path1, include_path2;

      char* TAO_ROOT = ACE_OS::getenv ("TAO_ROOT");

      if (TAO_ROOT != nullptr)
        {
            DRV_add_include_path (include_path1,
                                  TAO_ROOT,
                                  nullptr,
                                  true);

            DRV_add_include_path (include_path2,
                                  TAO_ROOT,
                                  "/tao",
                                  true);
        }
      else
        {
          char* ACE_ROOT = ACE_OS::getenv ("ACE_ROOT");

          if (ACE_ROOT != nullptr)
            {
              DRV_add_include_path (include_path1,
                                    ACE_ROOT,
                                    "/TAO",
                                    true);

              DRV_add_include_path (include_path2,
                                    ACE_ROOT,
                                    "/TAO/tao",
                                    true);
            }
          else
            {
#if defined (TAO_IDL_INCLUDE_DIR)
              // TAO_IDL_INCLUDE_DIR may be in quotes,
              // e.g. "/usr/local/include/tao"
              // We deal with a case like this below ...
              DRV_add_include_path (include_path1,
                                    TAO_IDL_INCLUDE_DIR,
                                    0,
                                    true);
              DRV_add_include_path (include_path2,
                                    TAO_IDL_INCLUDE_DIR,
                                    "/tao",
                                    true);
#else
              DRV_add_include_path (include_path1,
                                    ".",
                                    nullptr,
                                    true);
#endif  /* TAO_IDL_INCLUDE_DIR */
            }
        }

      idl_global->tao_root (include_path1.c_str ());
    }

  // Add any flags in platform_cpp_args to cpp's DRV_arglist.
  ACE_ARGV platform_arglist (
    ACE_TEXT_CHAR_TO_TCHAR (platform_cpp_args));

  for (int i = 0; i < platform_arglist.argc (); ++i)
    {
      // Check for an argument that specifies
      // the preprocessor's output file.
      if (ACE_OS::strstr (platform_arglist[i], ACE_TEXT ("%s")) != nullptr
          && output_arg_format == nullptr)
        {
          output_arg_format =
            ACE::strnew (ACE_TEXT_ALWAYS_CHAR (platform_arglist[i]));
          output_arg_index = DRV_argcount;
          DRV_cpp_putarg (nullptr);
        }
      else
        {
          DRV_cpp_putarg (ACE_TEXT_ALWAYS_CHAR (platform_arglist[i]));
        }
    }
}

int
DRV_sweep_dirs (const char *rel_path,
                const char *base_path)
{
  // Zero rel_path means we're not using this option, and
  // so we become a no-op.
  if (rel_path == nullptr)
    {
      return 0;
    }

  if (ACE_OS::chdir (rel_path) == -1)
    {
      ACE_ERROR_RETURN ((LM_ERROR,
                         "DRV_sweep_dirs: chdir %C failed\n",
                         rel_path),
                        -1);
    }

  ACE_Dirent dir (TCHAR_DIR_DOT);
  ACE_CString bname (base_path);
  bname += (bname.length () > 0 ? "/" : "");
  bname += rel_path;
  bool include_added = false;
  char abspath[MAXPATHLEN] = "";
  char *full_path = nullptr;

  for (ACE_DIRENT *dir_entry; (dir_entry = dir.read ()) != nullptr;)
    {
      // Skip the ".." and "." files in each directory.
      if (ACE::isdotdir (dir_entry->d_name) == true)
        {
          continue;
        }

#if defined (ACE_HAS_TCHAR_DIRENT)
      ACE_CString lname (ACE_TEXT_ALWAYS_CHAR (dir_entry->d_name));
#else
      ACE_CString lname (dir_entry->d_name);
#endif
      ACE_stat stat_buf;

      if (ACE_OS::lstat (lname.c_str (), &stat_buf) == -1)
        {
          ACE_ERROR_RETURN ((LM_ERROR,
                             "DRV_sweep_dirs: ACE_OS::lstat"
                             " (%C) failed\n",
                             lname.c_str ()),
                            -1);
        }

      size_t len = 0;

      switch (stat_buf.st_mode & S_IFMT)
        {
        case S_IFREG: // Either a regular file or an executable.
          len = lname.length ();

          if (len > 4 && lname.substr (len - 4) == ".idl")
            {
              if (!include_added)
                {
                  ACE_CString incl_arg ("-I");
                  incl_arg += bname;
                  DRV_cpp_putarg (incl_arg.c_str ());
                  idl_global->add_rel_include_path (bname.c_str ());
                  full_path = ACE_OS::realpath ("", abspath);

                  if (full_path != nullptr)
                    {
                      idl_global->add_include_path (full_path,
                                                    false);
                    }

                  include_added = true;
                }

              ACE_CString fname (bname);
              fname += "/";
              fname += lname;
              DRV_push_file (fname.c_str ());
            }

          break;
        case S_IFDIR: // Subdirectory.
          DRV_sweep_dirs (lname.c_str (), bname.c_str ());
          break;
        case S_IFLNK: // Either a file link or directory link.
        default: // Some other type of file (PIPE/FIFO/device).
          break;
        }
    }

  // Move back up a level.
  if (ACE_OS::chdir (DIR_DOT_DOT) == -1)
    {
      ACE_ERROR_RETURN ((LM_ERROR,
                         "DRV_sweep_dirs: chdir "
                         ".. (from %C) failed\n",
                         rel_path),
                        -1);
    }

  return 0;
}

ACE_CString&
DRV_add_include_path (ACE_CString& include_path,
                      const char *path,
                      const char *suffix,
                      bool is_system)
{
  if (path == nullptr)
    {
      return include_path;
    }

  const bool needToQuote =
    (('"' == *path) || ACE_OS::strchr (path, ' '));
  const size_t pathLength = ACE_OS::strlen (path);
  const char
#if defined (ACE_WIN32)
    nativeDir =  '\\',
    foreignDir = '/';
#else
    nativeDir =  '/',
    foreignDir = '\\';
#endif

  // Eliminate possible enclosing quotes
  // from the path, and since some compilers
  // choke on double directory separators in
  // paths, ensure that the path does not
  // end with a directory slash.
  include_path =
    ACE_CString (path + ('"' == *path),     // Skip leading Quote
                 pathLength
                 - ('"' == *path)           // Don't count leading Quote
                 - ( (1uL < pathLength) &&  // Don't count trailing Quote XOR directory
                     ('"'        == path [pathLength - 1uL] ||
                      nativeDir  == path [pathLength - 1uL] ||
                      foreignDir == path [pathLength - 1uL]
                   ) )
                 - ( (2uL < pathLength) &&  // Don't count trailing Quote AND directory
                     '"' == path [pathLength - 1uL] &&
                     (nativeDir  == path [pathLength - 2uL] ||
                      foreignDir == path [pathLength - 2uL]
                   ) )
                );

  if (suffix != nullptr)
    {
      if (!include_path.length ()
          && ((nativeDir == *suffix) || (foreignDir == *suffix)))
        {
          // Path is empty, don't add the
          // suffix's leading directory separator.
          ++suffix;
        }

      if (include_path.length ()
          && (*suffix != '\0')
          && (nativeDir != *suffix)
          && (foreignDir != *suffix))
        {
          // Force a directory separator.
          include_path += nativeDir;
        }

      // Add the suffix string to the path,
      // ensuring that foreign directory slashes
      // are added as the native type.
      for ( ; *suffix != '\0'; ++suffix)
        {
          include_path += (foreignDir == *suffix)
                             ? nativeDir
                             : *suffix;
        }
    }

  // Build up the include string from the new path+suffix
  ACE_CString include_option ("-I\"", 2 + needToQuote);
  include_option+= include_path;

  if (needToQuote)
    {
      include_option+= '"';
    }

  DRV_cpp_putarg (include_option.c_str ());

  idl_global->add_include_path (include_path.c_str (),
                                is_system);

  return include_path;
}

// Adds additional include paths, but after parse_args() has
// added user-defined include paths.
void
DRV_cpp_post_init ()
{
  char idl_version_arg[128];
  ACE_OS::sprintf (idl_version_arg, "-D__TAO_IDL_IDL_VERSION=%s",
    idl_global->idl_version_.to_macro ());
  DRV_cpp_putarg (idl_version_arg);

  DRV_cpp_putarg ("-D__TAO_IDL_FEATURES="
#ifdef TAO_IDL_FEATURES
    TAO_IDL_FEATURES
#else
    "\"tao/idl_features.h\""
#endif
  );

  // Add include path for TAO_ROOT/orbsvcs.
  char* TAO_ROOT = ACE_OS::getenv ("TAO_ROOT");

  ACE_CString include_path3, include_path4, include_path5;

  // When adding new dirs here don't forget to update
  // FE_Utils::validate_orb_include accordingly.
  if (TAO_ROOT != nullptr)
    {
      DRV_add_include_path (include_path3,
                            TAO_ROOT,
                            "/orbsvcs",
                            true);
    }
  else
    {
      // If TAO_ROOT isn't defined, assume it's under ACE_ROOT.
      char* ACE_ROOT = ACE_OS::getenv ("ACE_ROOT");

      if (ACE_ROOT != nullptr)
        {
          DRV_add_include_path (include_path3,
                                ACE_ROOT,
                                "/TAO/orbsvcs",
                                true);
        }
      else
        {
#if defined (TAO_IDL_INCLUDE_DIR)
          DRV_add_include_path (include_path3,
                                TAO_IDL_INCLUDE_DIR,
                                "/orbsvcs",
                                true);
#else
          // If ACE_ROOT isn't defined either, there will already
          // be a warning from DRV_preproc().
          DRV_add_include_path (include_path3,
                                ".",
                                nullptr,
                                true);
#endif  /* TAO_IDL_INCLUDE_DIR */
        }
    }

  // Add include paths for CIAO_ROOT and CIAO_ROOT/ciao.
  char* CIAO_ROOT = ACE_OS::getenv ("CIAO_ROOT");

  // When adding new dirs here don't forget to update
  // FE_Utils::validate_orb_include accordingly.
  if (CIAO_ROOT != nullptr)
    {
      DRV_add_include_path (include_path4,
                            CIAO_ROOT,
                            nullptr,
                            true);

      DRV_add_include_path (include_path5,
                            CIAO_ROOT,
                            "/ciao",
                            true);

      DRV_add_include_path (include_path5,
                            CIAO_ROOT,
                            "/ccm",
                            true);
    }

  // Save path of current directory, in case
  // the call to DRV_sweep_dirs()
  // below is not a no-op - then the current
  // working directory will
  // have to be restored.
  char cwd_path[MAXPATHLEN];

  if (ACE_OS::getcwd (cwd_path, sizeof (cwd_path)) == nullptr)
    {
      ACE_ERROR ((LM_ERROR,
                  "DRV_cpp_post_init: ACE_OS::getcwd failed\n"));

      throw Bailout ();
    }

  // If first arg is non-zero, adds an include path and filename
  // for every IDL file found in all subdirectories. This is a
  // no-op for most backends.
  if (DRV_sweep_dirs (idl_global->recursion_start (), "") == -1)
    {
      ACE_ERROR ((LM_ERROR,
                  "DRV_cpp_post_init: DRV_sweep_dirs (%C) failed\n",
                  idl_global->recursion_start ()));

      throw Bailout ();
    }

  // This is redundant for most backends, but not if the call to
  // DRV_sweep_dirs() above is more than a no-op.
  if (ACE_OS::chdir (cwd_path) == -1)
    {
      ACE_ERROR ((LM_ERROR,
                  "DRV_cpp_post_init: ACE_OS::chdir (%C) failed\n",
                  cwd_path));

      throw Bailout ();
    }
}

// Local/internal helper function.
namespace
{
  // Advances the input char buffer to the first non-white
  // space character, handles /**/ comments as well.
  char
  DRV_skip_over_white_spaces (const char *&input)
  {
    while (*input != 0)
      {
        // Skip the spaces, tabs, vertical-tabs and form feeds.
        while (' ' == *input ||
              '\t' == *input ||
              '\v' == *input ||
              '\f' == *input)
          {
            ++input;
          }

        // Skip any "/*...*/" inline comments
        // (Note we can't cope with fully multi-line comments since we
        //  are scanning only single lines at a time here.)
        if ('/' != *input)
          {
            // This is the first non-white space character (could be
            // end of line).
            return *input;
          }

        if ('*' != *++input)
          {
            // Wasn't the start of a comment so / was the first non-white space character.
            return *--input;
          }

        // Skip over the contents of the comment (if we reach the end of the input
        // line we have no option but to concider the comment closed, bummer).
        do
          {
            // Looking for the closing "*/" characters
            while ('*' != *++input && *input)
              {}

            while ('*' == *input)
              {
                ++input;
              }
          } while ('/' != *input && *input);

          if ('/' == *input)
            {
              ++input;
            }
      }

    return '\0'; // Reached end of line.
  }

  // Checks for and skips over #include, positions buffer
  // at the leading quote character of the filename if
  // #include is found.
  bool
  DRV_find_include_filename (const char *&input)
  {
    // Must have initial # character
    if ('#' != DRV_skip_over_white_spaces (input))
      {
        return false;
      }

    // Only want #include to match
    const char *include_str = "include";

    if (*include_str != DRV_skip_over_white_spaces (++input))
      {
        return false;
      }

    while (*++include_str == *++input && *input)
      {}

    if (*include_str || !*input)
      {
        // Not #include (or it ends before filename given).
        return false;
      }

    // Next thing is finding the file that has been `#include'd. Skip
    // over to the starting " or < character.
    const char start_char = DRV_skip_over_white_spaces (input);
    return ('"' == start_char || '<' == start_char);
  }

  // We really need to know whether
  // this line is a "#include ...". If
  // so, we would like to separate the
  // "file name" and keep that in the
  // idl_global. We need them to produce
  // "#include's in the stubs and
  // skeletons.
  void
  DRV_check_for_include (const char *buf)
  {
    if (!DRV_find_include_filename (buf))
      {
        return;
      }

    // Skip over this leading " or < and
    // copy the filename upto the
    // closing " or > character.
    const char
      start_char = *buf++,
      end_char   = ('<' == start_char) ? '>' : start_char;

    char
      incl_file[MAXPATHLEN + 1],
      *fi = incl_file;

    while (*buf != '\0' && *buf != end_char)
      {
        // Put Microsoft-style pathnames into a canonical form.
        if ('\\' == buf[0] && '\\' == buf [1])
          {
            ++buf;
          }

        *fi++ = *buf++;

        if (fi == incl_file + sizeof (incl_file) - 1)
          {
            // Safety valve, filename given was too long!
            break;
          }
      }

    *fi= '\0';
    const size_t len = fi - incl_file;

    if (len == 0)
    {
      return; // Null filename not allowed.
    }

    ACE_CString const name_str (incl_file);
    ACE_CString const simple ("orb.idl");
    ACE_CString const nix_path ("tao/orb.idl");
    ACE_CString const win_path ("tao\\orb.idl");

    // Some backends pass this file through, others don't.
    if (name_str == simple
        || name_str == nix_path
        || name_str == win_path)
      {
        if (idl_global->pass_orb_idl ())
          {
            idl_global->add_to_included_idl_files (incl_file);
          }
        else
          {
            DRV_get_orb_idl_includes ();
          }
      }
    // We have special lookup for orb.idl (TAO_ROOT/tao) that
    // also kicks in for .pidl files. If one of the latter is
    // included as a local name only, we add the 'tao/' prefix
    // so the generated C++ include files will be correct.
    else if ((5 <= len && !ACE_OS::strcmp (incl_file + len - 5, ".pidl"))
             && !ACE_OS::strchr (incl_file, '/')
             && !ACE_OS::strchr (incl_file, '\\'))
      {
        ACE_CString fixed_name ("tao/");
        fixed_name += incl_file;

        idl_global->add_to_included_idl_files (fixed_name.c_str ());
      }
    else
      {
        idl_global->add_to_included_idl_files (incl_file);
      }
  }

  // This method turns a line like '#include "a.idl"' into the
  // line '#include <a.idl>'
  void
  DRV_convert_includes (char *buf)
  {
    const char *input = buf;

    if (!DRV_find_include_filename (input) || '"' != *input)
      {
        return; // Only interested in #include "" type
      }

    buf = const_cast<char *> (input);

    // Find the closing '"' character.
    char *open_quote= buf;

    while ('"' != *++buf && *buf != '\0')
      {
        if ('>' == *buf)
          {
            // Can't change to #include <> as it
            // has a > character in the filename!
            return;
          }
      }
    if ('"' == *buf)
      {
        // Replace the quotes with angle brackets.
        *open_quote = '<';
        *buf = '>';
      }
  }
} // End of local/internal namespace

void
DRV_get_orb_idl_includes ()
{
  static char const orb_idl[] = "tao/orb.idl";

 // Search for orb.idl in supplied include file search paths.
  char const * directory = nullptr;
  FILE * fp = FE_Utils::open_included_file (orb_idl, directory);

  if (fp == nullptr)
    {
      // Fall back on $TAO_ROOT/tao/orb.idl if orb.idl is not in the
      // include path.
      ACE_CString orb_idl_path (ACE_CString (idl_global->tao_root ())
                                + ACE_CString ('/')
                                + ACE_CString (orb_idl));

      fp = ACE_OS::fopen (orb_idl_path.c_str (), "r");

      if (fp == nullptr)
        {
          ACE_ERROR ((LM_ERROR,
                      "TAO_IDL: cannot open or find file: %C\n",
                      orb_idl_path.c_str ()));

          throw Bailout ();
        }
    }
  else
    {
      // Make sure the include directory containing orb.idl is passed
      // to the preprocessor.
      // This should go after user supplied include paths.
      ACE_CString include_path_arg;
      DRV_add_include_path (include_path_arg, directory, "/tao", true);
    }

  while (DRV_get_line (fp))
    {
      // Find the included .pidl files in orb.idl and add them to the
      // included IDL file list.
      DRV_check_for_include (drv_line);
    }

  ACE_OS::fclose (fp);
}

// Copy to a file.
static void
DRV_copy_input (FILE *fin,
                FILE *f,
                const char *fn,
                const char *orig_filename)
{
  if (f == nullptr)
    {
      ACE_ERROR ((LM_ERROR,
                  "%C: cannot open temp file \"%C\" for copying from \"%C\": %m\n",
                  idl_global->prog_name (),
                  fn,
                  orig_filename));

      throw Bailout ();
    }

  if (fin == nullptr)
    {
      ACE_ERROR ((LM_ERROR,
                  "%C: cannot open input file\n",
                  idl_global->prog_name ()));

      throw Bailout ();
    }

#if !defined (ACE_WIN32)
  ACE_OS::fprintf (f,
                   "#line 1 \"%s\"\n",
                   orig_filename);
#else
  // Convert single \ into double \ otherwise MSVC++ pre-processor
  // gets awfully confused.
  char buf[2*MAXPATHLEN];
  char *d = buf;

  for (const char *s = orig_filename; *s != 0; ++s)
    {
      if (*s == '\\')
        {
          *d = '\\';
          ++d;
        }

      *d = *s;
      ++d;
    }

  *d = 0;
  ACE_OS::fprintf (f,
                   "#line 1 \"%s\"\n",
                   buf);
#endif /* ! ACE_WIN32 */

  while (DRV_get_line (fin))
    {
      DRV_convert_includes (drv_line);

      // Print the line to the temporary file.
      ACE_OS::fprintf (f,
                       "%s\n",
                       drv_line);

      // We really need to know whether this line is a "#include
      // ...". If so, we would like to separate the "file name" and
      // keep that in the idl_global. We need them to produce
      // "#include's in the stubs and skeletons.
      DRV_check_for_include (drv_line);
    }

  // Close the temporary file.
  ACE_OS::fclose (f);
}

// Strip down a name to the last component,
// i.e. everything after the last '/' or '\' character.
static char *
DRV_stripped_name (char *fn)
{
    char *n = fn;
    size_t l;

    if (n == nullptr)
      {
        return nullptr;
      }

    l = ACE_OS::strlen (n);
    int slash_found = 0;

    for (n += l - 1; n >= fn && !slash_found; n--)
      {
        slash_found = (*n == '/' || *n == '\\');
      }

    n += 1;

    if (slash_found)
      {
        n += 1;
      }

    return n;
}

// Pass input through preprocessor.
void
DRV_pre_proc (const char *myfile)
{
  // Check to see that the file is a normal file. If we don't and the file is a
  // directory, then the copy would be blank and any error message later might
  // not be helpful.
  ACE_stat file_stat;
  if (ACE_OS::stat (myfile, &file_stat) == -1)
    {
      ACE_ERROR ((LM_ERROR,
                  "%C: ERROR: Unable to open file (stat) \"%C\": %m\n",
                  idl_global->prog_name (),
                  myfile));
      throw Bailout ();
    }
  else if ((file_stat.st_mode & S_IFREG) != S_IFREG)
    {
      ACE_ERROR ((LM_ERROR,
                  "%C: ERROR: This is not a regular file: \"%C\"\n",
                  idl_global->prog_name (),
                  myfile));
      throw Bailout ();
    }

  const char* tmpdir = idl_global->temp_dir ();
  static const char temp_file_extension[] = ".cpp";

  static char const tao_idlf_template[] = "tao-idlf_XXXXXX";
  static char const tao_idli_template[] = "tao-idli_XXXXXX";

  size_t const tlen =
    ACE_OS::strlen (tmpdir) + sizeof (temp_file_extension);

  // Prevent a buffer overrun.
  if (tlen + sizeof (tao_idlf_template) > sizeof (tmp_file)
      || tlen + sizeof (tao_idli_template) > sizeof (tmp_ifile))
    {
      ACE_ERROR ((LM_ERROR,
                  "%C: temporary path/filename length is greater than "
                  "length allowed by platform\n",
                  idl_global->prog_name ()));

      throw Bailout ();
    }

  ACE_OS::strcpy (tmp_file,  tmpdir);
  ACE_OS::strcpy (tmp_ifile, tmpdir);

  // Append temporary filename template to temporary directory.
  ACE_OS::strcat (tmp_file,  tao_idlf_template);
  ACE_OS::strcat (tmp_ifile, tao_idli_template);

  ACE_HANDLE const ti_fd = ACE_OS::mkstemp (tmp_ifile);

  if (ti_fd == ACE_INVALID_HANDLE)
    {
      ACE_ERROR ((LM_ERROR,
                  "%C: Unable to create temporary file \"%C\": %m\n",
                  idl_global->prog_name (),
                  tmp_ifile));

      throw Bailout ();
    }

  ACE_HANDLE const tf_fd = ACE_OS::mkstemp (tmp_file);

  if (tf_fd == ACE_INVALID_HANDLE)
    {
      ACE_ERROR ((LM_ERROR,
                  "%C: Unable to create temporary file \"%C\": %m\n",
                  idl_global->prog_name (),
                  tmp_file));

      (void) ACE_OS::unlink (tmp_ifile);
      throw Bailout ();
    }

  char tmp_cpp_file [MAXPATHLEN + 1] = { 0 };
  char tmp_cpp_ifile[MAXPATHLEN + 1] = { 0 };

  // Append C++ source file extension.  Temporary files will be renamed
  // to these filenames.
  ACE_OS::strcpy (tmp_cpp_file,  tmp_file);
  ACE_OS::strcpy (tmp_cpp_ifile, tmp_ifile);
  ACE_OS::strcat (tmp_cpp_file,  temp_file_extension);
  ACE_OS::strcat (tmp_cpp_ifile, temp_file_extension);

  char * const t_file  = tmp_cpp_file;
  char * const t_ifile = tmp_cpp_ifile;

  ACE_OS::close (tf_fd);

  // Rename temporary files so that they have extensions accepted
  // by the preprocessor.
  FILE * const file = ACE_OS::fopen (myfile, "r");
  if (file == nullptr)
    {
      ACE_ERROR ((LM_ERROR,
                  "%C: ERROR: Unable to open file (fopen) \"%C\": %m\n",
                  idl_global->prog_name (),
                  myfile));
      (void) ACE_OS::unlink (tmp_ifile);
      (void) ACE_OS::unlink (tmp_file);
      throw Bailout ();
    }

  DRV_copy_input (file,
                  ACE_OS::fdopen (ti_fd, ACE_TEXT("w")),
                  tmp_ifile,
                  myfile);
  ACE_OS::fclose (file);

  UTL_String *utl_string = nullptr;

  ACE_NEW (utl_string,
           UTL_String (myfile, true));

  idl_global->set_main_filename (utl_string);

  ACE_Auto_String_Free safety (ACE_OS::strdup (myfile));

  UTL_String *stripped_tmp = nullptr;
  ACE_NEW (stripped_tmp,
           UTL_String (DRV_stripped_name (safety.get ()), true));

  idl_global->set_stripped_filename (stripped_tmp);

  UTL_String *real_tmp = nullptr;
  ACE_NEW (real_tmp,
           UTL_String (t_ifile, true));

  idl_global->set_real_filename (real_tmp);

  // We use ACE instead of the (low level) fork facilities, this also
  // works on NT.
  ACE_Process process;

  DRV_cpp_expand_output_arg (t_file);
  DRV_cpp_putarg (t_ifile);
  DRV_cpp_putarg (nullptr); // Null terminate the DRV_arglist.

  // For complex builds, the default
  // command line buffer size of 1024
  // is often not enough. We determine
  // the required space and arg nr
  // dynamically here.
  ACE_Process_Options cpp_options (true,       // Inherit environment.
                                   DRV_cpp_calc_total_argsize (),
                                   16 * 1024,
                                   512,
                                   DRV_argcount);

  if (cpp_options.command_line (DRV_arglist) != 0)
    {
      ACE_ERROR ((LM_ERROR,
                  ACE_TEXT ("%C: command line processing \"%s\" failed\n"),
                  idl_global->prog_name (),
                  DRV_arglist[0]));

      (void) ACE_OS::unlink (tmp_ifile);
      (void) ACE_OS::unlink (tmp_file);
      throw Bailout ();
    }

  // Rename temporary files so that they have extensions accepted
  // by the preprocessor.  Renaming is (supposed to be) an atomic
  // operation so we shouldn't be susceptible to attack.
  if (ACE_OS::rename (tmp_file, t_file) != 0)
    {
      ACE_ERROR ((LM_ERROR,
                  "%C: Unable to rename temporary "
                  "file \"%C\" to \"%C\": %m\n",
                  idl_global->prog_name (),
                  tmp_file,
                  t_file));


      (void) ACE_OS::unlink (tmp_ifile);
      (void) ACE_OS::unlink (tmp_file);
      throw Bailout ();
    }

  if (ACE_OS::rename (tmp_ifile, t_ifile) != 0)
    {
      ACE_ERROR ((LM_ERROR,
                  "%C: Unable to rename temporary "
                  "file \"%C\" to \"%C\": %m\n",
                  idl_global->prog_name (),
                  tmp_ifile,
                  t_ifile));

      (void) ACE_OS::unlink (tmp_ifile);
      (void) ACE_OS::unlink (t_file);
      throw Bailout ();
    }

  // Remove any existing output file.
  (void) ACE_OS::unlink (t_file);

  ACE_HANDLE fd = ACE_INVALID_HANDLE;

  if (output_arg_format == nullptr)
    {
      // If the following open() fails, then we're either being hit with a
      // symbolic link attack, or another process opened the file before
      // us.
      fd = ACE_OS::open (t_file,
                         O_WRONLY | O_CREAT | O_EXCL,
                         ACE_DEFAULT_FILE_PERMS);

      if (fd == ACE_INVALID_HANDLE)
        {
          ACE_ERROR ((LM_ERROR,
                      "%C: cannot open temp file"
                      " \"%C\" for writing: %m\n",
                      idl_global->prog_name (),
                      t_file));

          (void) ACE_OS::unlink (t_file);
          (void) ACE_OS::unlink (t_ifile);
          throw Bailout ();
        }

      if (cpp_options.set_handles (ACE_INVALID_HANDLE, fd) == -1)
        {
          ACE_ERROR ((LM_ERROR, "%C: cannot set stdout for child process: %m\n",
                      idl_global->prog_name ()));

          throw Bailout ();
        }
    }

  if (idl_global->compile_flags () & IDL_CF_INFORMATIVE)
    {
      ACE_DEBUG ((LM_DEBUG, "%C: spawning: %s\n",
                  idl_global->prog_name (),
                  cpp_options.command_line_buf ()));
    }

  if (process.spawn (cpp_options) == ACE_INVALID_PID)
    {
      ACE_ERROR ((LM_ERROR,
                  "%C: spawn of \"%s\" failed\n",
                  idl_global->prog_name (),
                  DRV_arglist[0]));


      (void) ACE_OS::unlink (t_file);
      (void) ACE_OS::unlink (t_ifile);
      throw Bailout ();
    }

  if (fd != ACE_INVALID_HANDLE)
    {
      // Close the output file on the parent process.
      if (ACE_OS::close (fd) == -1)
        {
          ACE_ERROR ((LM_ERROR,
            "%C: cannot close temp file \"%C\" on parent: %m\n",
                      idl_global->prog_name (),
                      t_file));

          (void) ACE_OS::unlink (t_file);
          (void) ACE_OS::unlink (t_ifile);
          throw Bailout ();
        }
    }

  // Remove the null termination and the
  // input file from the DRV_arglist,
  // the next file will the previous args.
  DRV_argcount -= 2;
  ACE::strdelete (
    const_cast<ACE_TCHAR *> (DRV_arglist[DRV_argcount]));
  DRV_arglist[DRV_argcount] = nullptr;
  ACE_exitcode status = 0;

  if (process.wait (&status) == ACE_INVALID_PID)
    {
      ACE_ERROR ((LM_ERROR,
                  "%C: wait for child process failed\n",
                  idl_global->prog_name ()));

      (void) ACE_OS::unlink (t_file);
      (void) ACE_OS::unlink (t_ifile);
      throw Bailout ();
    }

  if (WIFEXITED ((status)))
    {
      // Child terminated normally?
      if (WEXITSTATUS ((status)) != 0)
        {
          errno = WEXITSTATUS ((status));

          ACE_ERROR ((LM_ERROR,
                      "%C: preprocessor \"%s\" "
                      "returned with an error\n",
                      idl_global->prog_name (),
                      DRV_arglist[0]));

          (void) ACE_OS::unlink (t_file);
          (void) ACE_OS::unlink (t_ifile);
          throw Bailout ();
        }
    }
  else
    {
      // Child didn't call exit(); perhaps it received a signal?
      errno = EINTR;

      ACE_ERROR ((LM_ERROR,
                  "%C: preprocessor \"%s\" appears "
                  "to have been interrupted\n",
                  idl_global->prog_name (),
                  DRV_arglist[0]));

      (void) ACE_OS::unlink (t_file);
      (void) ACE_OS::unlink (t_ifile);
      throw Bailout ();
    }
  // TODO: Manage problems in the
  // pre-processor, in the previous
  // version the current process
  // would exit if the pre-processor
  // returned with error.
  FILE * const yyin = ACE_OS::fopen (t_file, "r");

  if (yyin == nullptr)
    {
      ACE_ERROR ((LM_ERROR,
                  "%C: Could not open cpp "
                  "output file \"%C\": %m\n",
                  idl_global->prog_name (),
                  t_file));

      (void) ACE_OS::unlink (t_file);
      (void) ACE_OS::unlink (t_ifile);
      throw Bailout ();
    }

  FE_set_yyin (yyin);

  if (idl_global->compile_flags () & IDL_CF_ONLY_PREPROC)
    {
      FILE *preproc = ACE_OS::fopen (t_file, "r");
      char buffer[ACE_MAXLOGMSGLEN];
      size_t bytes;

      if (preproc == nullptr)
        {
          ACE_ERROR ((LM_ERROR,
                      "%C: Could not open cpp "
                      "output file \"%C\": %m\n",
                      idl_global->prog_name (),
                      t_file));

          (void) ACE_OS::unlink (t_file);
          (void) ACE_OS::unlink (t_ifile);
          throw Bailout ();
        }

      // ACE_DEBUG sends to stderr - we want stdout for this dump
      // of the preprocessor output. So we modify the singleton that
      // was created in this process. Since IDL_CF_ONLY_PREPROC causes
      // an (almost) immediate exit below, we don't have to restore
      // the singleton's default parameters.
      ACE_Log_Msg *out = ACE_Log_Msg::instance ();
      out->msg_ostream (&cout);
      out->clr_flags (ACE_Log_Msg::STDERR);
      out->set_flags (ACE_Log_Msg::OSTREAM);

      while ((bytes = ACE_OS::fread (buffer,
                                     sizeof (char),
                                     ACE_MAXLOGMSGLEN - 1,
                                     preproc))
               != 0)
        {
          buffer[bytes] = 0;
          ACE_DEBUG ((LM_DEBUG, buffer));
        }

      ACE_OS::fclose (preproc);
    }

  if (ACE_OS::unlink (t_ifile) == -1)
    {
      ACE_ERROR ((LM_ERROR,
                  "%C: Could not remove cpp "
                  "input file \"%C\": %m\n",
                  idl_global->prog_name (),
                  t_ifile));

      throw Bailout ();
    }

  if (ACE_OS::unlink (t_file) == -1)
    {
      ACE_ERROR ((LM_ERROR,
                  "%C: Could not remove cpp "
                  "output file \"%C\": %m\n",
                  idl_global->prog_name (),
                  t_file));

      throw Bailout ();
    }
}