path: root/TAO/TAO_IDL/driver/drv_preproc.cpp

// $Id$

/*

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.h"
#include "idl_extern.h"
#include "drv_private.h"
#include "drv_extern.h"
#include "ace/Process_Manager.h"
#include "ace/SString.h"
#include "ace/Env_Value_T.h"
#include "ace/ARGV.h"

ACE_RCSID(driver, drv_preproc, "$Id$")

#undef  MAX_ARGLIST
#define MAX_ARGLIST 128

static const char *arglist[MAX_ARGLIST];
static long argcount = 0;

// The ACE_Process_Options default size of 1024 is sometimes not enough.
const unsigned long TAO_IDL_COMMAND_LINE_BUFFER_SIZE = 4 * 1024;

// Push the new CPP location if we got a -Yp argument
void
DRV_cpp_new_location (const char *new_loc)
{
  arglist[0] = new_loc;
}

// Push an argument into the arglist
void
DRV_cpp_putarg (const char *str)
{
  if (argcount >= MAX_ARGLIST)
    {
      ACE_ERROR ((LM_ERROR,
                  "%s%s %d %s\n",
                  ACE_TEXT (idl_global->prog_name ()),
                  ACE_TEXT (": More than"),
                  MAX_ARGLIST,
                  ACE_TEXT ("arguments to preprocessor")));

      ACE_OS::exit (99);
    }

  arglist[argcount++] = str == 0 ? 0 : ACE::strnew (str);
}

// Initialize the cpp argument list
void
DRV_cpp_init (void)
{
  // @@ There are two "one time" memory leaks in this function.
  //    They will not blow off the program but should be fixed at some point.
  const char *cpp_loc, *cpp_args;

  // See if TAO_IDL_PREPROCESSOR is defined.

  ACE_Env_Value<char*> preprocessor ("TAO_IDL_PREPROCESSOR", (char *) 0);

  // Set cpp_loc to the built in location, unless it has been overriden by
  // environment variables.

  if (preprocessor != 0)
    {
      cpp_loc = preprocessor;
    }
  else
    {
      // Check for the deprecated CPP_LOCATION environment variable
      ACE_Env_Value<char*> cpp_path ("CPP_LOCATION", (char *) 0);
      if (cpp_path != 0)
        {
          ACE_ERROR ((LM_ERROR,
                      ACE_TEXT ("Warning: The environment variable ")
                      ACE_TEXT ("CPP_LOCATION has been deprecated.\n")
                      ACE_TEXT ("         Please use TAO_IDL_PREPROCESSOR ")
                      ACE_TEXT ("instead.\n")));

          cpp_loc = cpp_path;
        }
      else
        {
          cpp_loc = idl_global->cpp_location ();
        }
    }

  DRV_cpp_putarg (cpp_loc);
  DRV_cpp_putarg ("-DIDL");
  DRV_cpp_putarg ("-I.");

  // Added some customizable preprocessor options

  ACE_Env_Value<char*> args1 ("TAO_IDL_PREPROCESSOR_ARGS", (char *) 0);

  if (args1 != 0)
    {
      cpp_args = args1;
    }
  else
    {
      // Check for the deprecated TAO_IDL_DEFAULT_CPP_FLAGS environment variable
      ACE_Env_Value<char*> args2 ("TAO_IDL_DEFAULT_CPP_FLAGS", (char *) 0);
      if (args2 != 0)
        {
          ACE_ERROR ((LM_ERROR,
                      ACE_TEXT ("Warning: The environment variable ")
                      ACE_TEXT ("TAO_IDL_DEFAULT_CPP_FLAGS has been ")
                      ACE_TEXT ("deprecated.\n")
                      ACE_TEXT ("         Please use ")
                      ACE_TEXT ("TAO_IDL_PREPROCESSOR_ARGS instead.\n")));

          cpp_args = args2;
        }
      else
        {
          // If no cpp flag was defined by the user, we define some
          // platform specific flags here.
          char option[BUFSIZ];
//          char* option = 0;
//          ACE_NEW (option,
//                   char[BUFSIZ]);

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

          // So we can find OMG IDL files, such as `orb.idl'.
          ACE_OS::strcpy (option, "-I");

#if defined (TAO_IDL_INCLUDE_DIR)
          // TAO_IDL_INCLUDE_DIR should be in quotes,
          // e.g. "/usr/local/include/tao"

          ACE_OS::strcat (option, TAO_IDL_INCLUDE_DIR);
#else
          const char* TAO_ROOT = ACE_OS::getenv ("TAO_ROOT");
          if (TAO_ROOT != 0)
            {
              ACE_OS::strcat (option, TAO_ROOT);
              ACE_OS::strcat (option, "/tao");
            }
          else
            {
              const char* ACE_ROOT = ACE_OS::getenv ("ACE_ROOT");
              if (ACE_ROOT != 0)
                {
                  ACE_OS::strcat (option, ACE_ROOT);
                  ACE_OS::strcat (option, "/TAO/tao");
                }
              else
                {
                  ACE_ERROR ((
                      LM_ERROR,
                      ACE_TEXT ("Note: The environment variables ")
                      ACE_TEXT ("TAO_ROOT and ACE_ROOT are not defined.\n")
                      ACE_TEXT ("      TAO_IDL may not be able to ")
                      ACE_TEXT ("locate orb.idl\n")
                    ));

                  ACE_OS::strcat (option, ".");
                }
            }
#endif  /* TAO_IDL_INCLUDE_DIR */

          DRV_cpp_putarg (option);
      }
  }

  // Add any flags in cpp_args to cpp's arglist.
  ACE_ARGV arglist (cpp_args);
  for (size_t arg_cnt = 0; arg_cnt < arglist.argc (); ++arg_cnt)
    {
      DRV_cpp_putarg (arglist[arg_cnt]);
    }
}

// Lines can be 1024 chars long.
#define LINEBUF_SIZE    1024
static  char    drv_line[LINEBUF_SIZE + 1];

// Get a line from stdin
static long
DRV_get_line (FILE *f)
{
    char *l = fgets (drv_line,
                     LINEBUF_SIZE,
                     f);
    long i = 0;

    if (l == NULL)
      {
        return I_FALSE;
      }

    if (*l == '\0' && feof (f))
      {
        return I_FALSE;
      }

    if (*l == '\0')
      {
        return I_TRUE;
      }

    i = strlen(l) - 1;

    if (l[i] == '\n')
      {
        l[i] = '\0';
      }

    return I_TRUE;
}

// Copy from stdin to a file
static void
DRV_copy_input (FILE *fin,
                char *fn,
                const char *orig_filename)
{
  FILE  *f = ACE_OS::fopen (fn, "w");

  if (f == NULL)
    {
      ACE_ERROR ((LM_ERROR,
                  ACE_TEXT (idl_global->prog_name ()),
                  ACE_TEXT (": cannot open temp file "),
                  ACE_TEXT (fn),
                  ACE_TEXT (" for writing\n")));

      ACE_OS::exit (99);
    }

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

      ACE_OS::exit (99);
    }

#if !defined (ACE_WIN32)
  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))
    {
      // 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);

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

  // Close the temp 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;
    long        l;

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

    l = 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;
}

// File names
static char     tmp_file[128];
static char     tmp_ifile[128];

// Pass input through preprocessor
void
DRV_pre_proc (const char *myfile)
{
  long  readfromstdin = I_FALSE;

  // Macro to avoid "warning: unused parameter" type warning.
  ACE_UNUSED_ARG (readfromstdin);

  const char* tmpdir = idl_global->temp_dir ();

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

  ACE_OS::strcat (tmp_file, "idlf_XXXXXX");
  ACE_OS::strcat (tmp_ifile, "idli_XXXXXX");

  (void) ACE_OS::mktemp (tmp_file); ACE_OS::strcat (tmp_file, ".cc");
  (void) ACE_OS::mktemp (tmp_ifile); ACE_OS::strcat (tmp_ifile, ".cc");

  UTL_String *tmp = 0;

  if (strcmp (myfile, "standard input") == 0)
    {
      ACE_NEW (tmp,
               UTL_String (tmp_ifile));
      idl_global->set_filename (tmp);

      ACE_NEW (tmp,
               UTL_String (tmp_ifile));
      idl_global->set_main_filename (tmp);

      ACE_NEW (tmp,
               UTL_String (DRV_stripped_name (tmp_ifile)));
      idl_global->set_stripped_filename (tmp);

      ACE_NEW (tmp,
               UTL_String (tmp_ifile));
      idl_global->set_real_filename (tmp);

      DRV_copy_input (stdin,
                      tmp_ifile,
                      "standard input");

      idl_global->set_read_from_stdin (I_TRUE);
    }
  else
    {
      FILE *fd = fopen (myfile, "r");
      DRV_copy_input (fd,
                      tmp_ifile,
                      myfile);
      fclose (fd);

      idl_global->set_read_from_stdin (I_FALSE);

      ACE_NEW (tmp,
               UTL_String (myfile));
      idl_global->set_filename (tmp);

      ACE_NEW (tmp,
               UTL_String (myfile));
      idl_global->set_main_filename (tmp);

      ACE_Auto_String_Free safety (ACE_OS::strdup (myfile));
      ACE_NEW (tmp,
               UTL_String (DRV_stripped_name (safety.get ())));
      idl_global->set_stripped_filename (tmp);

      ACE_NEW (tmp,
               UTL_String (tmp_ifile));
      idl_global->set_real_filename (tmp);
    }

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

  // For complex builds, the default command line buffer size of 1024
  // is sometimes not enough. We use 4096 here.
  ACE_Process_Options cpp_options (1,       // Inherit environment.
                                   TAO_IDL_COMMAND_LINE_BUFFER_SIZE);

  DRV_cpp_putarg (tmp_ifile);
  DRV_cpp_putarg (0); // Null terminate the arglist.

  cpp_options.command_line (arglist);

  ACE_HANDLE fd = ACE_OS::open (tmp_file,
                                O_WRONLY | O_CREAT | O_TRUNC,
                                ACE_DEFAULT_FILE_PERMS);

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

      return;
    }

  cpp_options.set_handles (ACE_INVALID_HANDLE, fd);

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

      return;
    }

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

      return;
    }

  // Remove the null termination and the input file from the arglist,
  // the next file will the previous args.
  argcount -= 2;

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

      return;
    }

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

          ACE_ERROR ((LM_ERROR,
                      ACE_TEXT (idl_global->prog_name ()),
                      ACE_TEXT (": preprocessor "),
                      ACE_TEXT (arglist[0]),
                      ACE_TEXT (" returned with an error\n")));

          ACE_OS::exit (1);
        }
    }
  else
    {
      // child didn't call exit(); perhaps it received a signal?
      errno = EINTR;

      ACE_ERROR ((LM_ERROR,
                  ACE_TEXT (idl_global->prog_name ()),
                  ACE_TEXT (": preprocessor "),
                  ACE_TEXT (arglist[0]),
                  ACE_TEXT (" appears to have been interrupted\n")));

      ACE_OS::exit (1);
    }
  // TODO: Manage problems in the pre-processor, in the previous
  // version the current process would exit if the pre-processor
  // returned with error.

  FILE *yyin = ACE_OS::fopen (tmp_file, "r");

  if (yyin == NULL)
    {
      ACE_ERROR ((LM_ERROR,
                  "%s%s %s\n",
                  ACE_TEXT (idl_global->prog_name ()),
                  ACE_TEXT (": Could not open cpp output file"),
                  ACE_TEXT (tmp_file)));

      ACE_OS::exit (99);
    }

  FE_set_yyin (ACE_reinterpret_cast (File *, yyin));

  if (idl_global->compile_flags() & IDL_CF_ONLY_PREPROC) 
    {
      FILE *preproc = ACE_OS::fopen (tmp_file, "r");      
      char buffer[BUFSIZ + 1];  // 1 for extra null
      int bytes;

      if (preproc == NULL)
        {
          ACE_ERROR ((LM_ERROR,
                      "%s: Could not open cpp output file: %s\n",
                      ACE_TEXT (idl_global->prog_name ()),
                      ACE_TEXT (tmp_file)));

          ACE_OS::exit (99);
        }

      while ((bytes = ACE_OS::fread (buffer, sizeof (char), BUFSIZ, preproc)) != 0) 
        {
          buffer[bytes] = 0;  // Null char

          ACE_DEBUG ((LM_DEBUG, buffer));
        }

      ACE_OS::fclose (preproc);
    }

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

      ACE_OS::exit (99);
    }

#if !defined (ACE_WIN32) || defined (ACE_HAS_WINNT4) && (ACE_HAS_WINNT4 != 0)
  if (ACE_OS::unlink (tmp_file) == -1)
    {
      ACE_ERROR ((LM_ERROR,
                  "%s%s %s\n",
                  ACE_TEXT (idl_global->prog_name ()),
                  ACE_TEXT (": Could not remove cpp output file"),
                  ACE_TEXT (tmp_file)));

      ACE_OS::exit (99);
    }
#endif /* ACE_HAS_WINNT4 && ACE_HAS_WINNT4 != 0 */

  if (idl_global->compile_flags() & IDL_CF_ONLY_PREPROC)
    {
      ACE_OS::exit (0);
    }
}

// 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)
{
  const char* r = buf;
  const char* h;

  // Skip initial '#'.
  if (*r != '#')
    {
      return;
    }
  else
    {
      r++;
    }

  // Skip the tabs and spaces.
  while (*r == ' ' || *r == '\t')
    {
      r++;
    }

  // Probably we are at the word `include`. If not return.
  if (*r != 'i')
    {
      return;
    }

  // Check whether this word is `include` or no.
  const char* include_str = "include";

  for (size_t ii = 0;
       ii < strlen ("include") && *r != '\0' && *r != ' ' && *r != '\t';
       r++, ii++)
    {
      // Return if it doesn't match.
      if (include_str [ii] != *r)
        {
          return;
        }
    }

  // Next thing is finding the file that has been `#include'd. Skip
  // all the blanks and tabs and reach the startng " or < character.
  for (; (*r != '"') && (*r != '<'); r++)
    {
      if (*r == '\n' || *r == '\0')
        {
          return;
        }
    }

  // Decide on the end char.
  char end_char = '"';

  if (*r == '<')
    {
      end_char = '>';
    }

  // Skip this " or <.
  r++;

  // Store this position.
  h = r;

  // Found this in idl.ll. Decides the file to be standard input.
  if (*h == '\0')
    {
      return;
    }

  // Find the closing " or < character.
  for (; *r != end_char; r++)
    {
      continue;
    }

  // Make a new string for this file name.
  char* file_name = 0;
  ACE_NEW (file_name,
           char [r - h + 1]);

  // Copy the char's.
  size_t fi = 0;

  for (; h != r; fi++, h++)
    {
      file_name [fi] = *h;
    }

  // Terminate the string.
  file_name [fi] = '\0';

  // Put Microsoft-style pathnames into a canonical form.
  size_t i = 0;

  for (size_t j = 0; file_name [j] != '\0'; i++, j++)
    {
      if (file_name [j] == '\\' && file_name [j + 1] == '\\')
        {
          j++;
        }

      file_name [i] = file_name [j];
    }

  // Terminate this string.
  file_name [i] = '\0';

  // Store in the idl_global, unless it's "orb.idl" -
  // we don't want to generate header includes for that.
  if (ACE_OS::strcmp (file_name, "orb.idl"))
    {
      idl_global->add_to_included_idl_files (file_name);
    }
}

#if defined (ACE_HAS_EXPLICIT_TEMPLATE_INSTANTIATION)
  template class ACE_Env_Value<char*>;
#elif defined (ACE_HAS_TEMPLATE_INSTANTIATION_PRAGMA)
# pragma instantiate  ACE_Env_Value<char*>
#endif