/*

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

 *

 * This code is free software; you can redistribute it and/or modify it

 * under the terms of the GNU General Public License version 2 only, as

 * particular file as subject to the "Classpath" exception as provided

 *

 * This code is distributed in the hope that it will be useful, but WITHOUT

 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

 * version 2 for more details (a copy is included in the LICENSE file that

 * accompanied this code).

 *

 * You should have received a copy of the GNU General Public License version

 * 2 along with this work; if not, write to the Free Software Foundation,

 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

 *

 */

/*

 * COMPONENT_NAME: idl.toJava

 *

 * ORIGINS: 27

 *

 * Licensed Materials - Property of IBM

 * 5639-D57 (C) COPYRIGHT International Business Machines Corp. 1997, 1999

 * RMI-IIOP v1.0

 *

 */

package com.sun.tools.corba.se.idl.toJavaPortable;

// Notes:

// -F46838.4<klr> Ported -td option from toJava.

// -10/17/98  KLR Ported fix for d48911 from toJava

// -10/18/98  KLR Ported fix from toJava for "unsigned long" constants

// -F46082.51<daz> Removed code to collect makefile list generation inforamtion

//  from getStream(); see f46830.

// -F46082.51<daz> Removed -stateful feature: methods javaStatefulName(String)

//  and javaStatefulName(SymtabEntry) are obsolete, supplanted by javaName().

// -D54640<daz> Represent unsigned long long expressions with their computed

//  value rather than their actual representation (see notes in method

//  parseTerminal(), parseBinary(), and parseUnary().)

// -D58319<daz> Add getVersion() method.

// -D48034<daz> Import Helper classes for typedef struct members when generating

//  helper.  See method addImportLines().

// -D59851<daz> Modify to enable QuickTest build. (pending)

// -D42256<daz> Determine import lines for template types, which may specify any

//  positive int., constant expression for a boundary. Such expression containing

//  non-literal contansts previously caused problems when appearing in constructs

//  structs, unions, exceptions, typedefs, operation types and parameters,

//  attributes; and of course, sequences, strings.

// -D59063<daz> Add helper for global exception to stub import list.

// -D58951<daz> Publicise members for QuickTest.

// -D59421<klr> Change ValueBaseHolder to SerializableHolder

// -D59596<klr> Prevent accesses to elements of empty Vectors.

// -D59771<daz> Add import stmt for Helper of global type in stubs.

// -D59355<daz> Remove target dir. from filename when writing to prolog.

// -D59437<daz> Fill typename information for value boxes.

// -D62023<klr> Don't import ValueBase*

// -D62023<klr> Add corbaLevel

import java.io.File;

import java.io.PrintWriter;

import java.math.BigInteger;

import java.text.DateFormat;

import java.util.Date;

import java.util.Enumeration;

import java.util.Hashtable;

import java.util.Locale;

import java.util.Vector;

import com.sun.tools.corba.se.idl.ConstEntry;

import com.sun.tools.corba.se.idl.EnumEntry;

import com.sun.tools.corba.se.idl.ExceptionEntry;

import com.sun.tools.corba.se.idl.GenFileStream;

import com.sun.tools.corba.se.idl.InterfaceEntry;

import com.sun.tools.corba.se.idl.MethodEntry;

import com.sun.tools.corba.se.idl.NativeEntry;

import com.sun.tools.corba.se.idl.ParameterEntry;

import com.sun.tools.corba.se.idl.PrimitiveEntry;

import com.sun.tools.corba.se.idl.SequenceEntry;

import com.sun.tools.corba.se.idl.StringEntry;

import com.sun.tools.corba.se.idl.StructEntry;

import com.sun.tools.corba.se.idl.SymtabEntry;

import com.sun.tools.corba.se.idl.TypedefEntry;

import com.sun.tools.corba.se.idl.UnionBranch;

import com.sun.tools.corba.se.idl.UnionEntry;

import com.sun.tools.corba.se.idl.ValueEntry;

import com.sun.tools.corba.se.idl.ValueBoxEntry;

import com.sun.tools.corba.se.idl.InterfaceState;

import com.sun.tools.corba.se.idl.constExpr.*;

/**

 * Class Util is a repository of static members available for general

 * use by the IDL parser framework and any generator extensions.

 **/

public class Util extends com.sun.tools.corba.se.idl.Util

{

  // <d58319>

  /**

   * Fetch the version number of this build of the IDL-to-Java (portable)

   * compiler from the appropriate properties file.

   * @return the version number of this compiler build.

   **/

  public static String getVersion ()

  {

    return com.sun.tools.corba.se.idl.Util.getVersion ("com/sun/tools/corba/se/idl/toJavaPortable/toJavaPortable.prp");

  } // getVersion

  /**

   * This method is called by Setup.preEmit, so

   * symbolTable is available for all Util methods.

   **/

  static void setSymbolTable (Hashtable symtab)

  {

    symbolTable = symtab;

  } // setSymbolTable

  public static void setPackageTranslation( Hashtable pkgtrans )

  {

    packageTranslation = pkgtrans ;

  }

  public static boolean isInterface (String name)

  {

    return isInterface (name, symbolTable);

  } // isInterface

  static String arrayInfo (Vector arrayInfo)

  {

    int         arrays = arrayInfo.size ();

    String      info   = "";

    Enumeration e      = arrayInfo.elements ();

    while (e.hasMoreElements ())

      info = info + '[' + parseExpression ((Expression)e.nextElement ()) + ']';

    return info;

  } // arrayInfo

  // <d58951> static String sansArrayInfo (Vector arrayInfo)

  public static String sansArrayInfo (Vector arrayInfo)

  {

    int    arrays   = arrayInfo.size ();

    String brackets = "";

    for (int i = 0; i < arrays; ++i)

      brackets = brackets + "[]";

    return brackets;

  } // sansArrayInfo

  // <d58951> static String sansArrayInfo (String name)

  static public String sansArrayInfo (String name)

  {

    int index = name.indexOf ('[');

    if (index >= 0)

    {

      String array = name.substring (index);

      name = name.substring (0, index);

      while (!array.equals (""))

      {

        name = name + "[]";

        array = array.substring (array.indexOf (']') + 1);

      }

    }

    return name;

  } // sansArrayInfo

  /**

   * Given a symbol table entry, return the name of

   * the file which should be created.

   **/

  public static String fileName (SymtabEntry entry, String extension )

  {

    NameModifier nm = new NameModifierImpl() ;

    return fileName( entry, nm, extension ) ;

  } // fileName

  public static String fileName (SymtabEntry entry, NameModifier modifier, String extension )

  {

    // This may not be the most appropriate place for

    // the mkdir calls, but it's common to everything:

    String pkg = containerFullName (entry.container ());

    if (pkg != null && !pkg.equals (""))

      mkdir (pkg);

    String name = entry.name ();

    name = modifier.makeName( name ) + extension ;

    if (pkg != null && !pkg.equals (""))

      name = pkg + '/' + name;

    return name.replace ('/', File.separatorChar);

  } // fileName

  public static GenFileStream stream (SymtabEntry entry, String extension)

  {

    NameModifier nm = new NameModifierImpl() ;

    return stream(entry, nm, extension);

  } // stream

  public static GenFileStream stream (SymtabEntry entry, NameModifier modifier, String extension )

  {

    return getStream ( fileName (entry,modifier,extension), entry ) ;

  }

  public static GenFileStream getStream (String name, SymtabEntry entry)

  {

    // <f46838.4>

    String absPathName = ((Arguments)Compile.compiler.arguments).targetDir + name;

    if (Compile.compiler.arguments.keepOldFiles && new File (absPathName).exists ())

      return null;

    else

      // Write the data to the file stream

      return new GenFileStream (absPathName);

  } // getStream

  public static String containerFullName( SymtabEntry container)

  {

      String name = doContainerFullName( container ) ;

      if (packageTranslation.size() > 0)

          name = translate( name ) ;

      return name ;

  }

  public static String translate( String name )

  {

      String head = name ;

      String tail = "" ;

      int index ;

      String trname ;

      // Check for package name translations, starting with the

      // most specific match.

      do {

          trname = (String)(packageTranslation.get( head )) ;

          if (trname != null)

              return trname + tail ;

          index = head.lastIndexOf( '/' ) ;

          if (index >= 0) {

              tail = head.substring( index ) + tail ;

              head = head.substring( 0, index ) ;

          }

      } while (index >= 0) ;

      return name ;

  }

  private static String doContainerFullName (SymtabEntry container)

  {

    String name = "";

    if (container == null)

      name = "";

    else

    {

      if (container instanceof InterfaceEntry ||

          container instanceof StructEntry ||

          container instanceof UnionEntry)

        name = container.name () + "Package";

      else

        name = container.name ();

      if (container.container () != null &&

        !container.container ().name ().equals (""))

        name = doContainerFullName (container.container ()) + '/' + name;

    }

    return name;

  } // doContainerFullName

  /**

   * Given a SymtabEntry, return the string which should be used

   * for this entry. Enums are converted to ints, typedefs and

   * sequences are converted to their info types. javaQualifiedName

   * does not do any of these conversions.

   **/

  public static String javaName (SymtabEntry entry)

  {

    // First get the real name of this type

    String name = "";

    if (entry instanceof TypedefEntry || entry instanceof SequenceEntry)

      try

      {

        name = sansArrayInfo ((String)entry.dynamicVariable (Compile.typedefInfo));

      }

      catch (NoSuchFieldException e)

      {

        name = entry.name ();

      }

    else if (entry instanceof PrimitiveEntry)

      name = javaPrimName (entry.name ());

    else if (entry instanceof StringEntry)

      name = "String";

    else if (entry instanceof NativeEntry)

      name = javaNativeName (entry.name());

    else if (entry instanceof ValueEntry && entry.name ().equals ("ValueBase"))

        name = "java.io.Serializable";

    else if (entry instanceof ValueBoxEntry)

    {

      ValueBoxEntry v = (ValueBoxEntry) entry;

      TypedefEntry member = ((InterfaceState) v.state ().elementAt (0)).entry;

      SymtabEntry mType = member.type ();

      if (mType instanceof PrimitiveEntry)

      {

         name = containerFullName (entry.container ());

         if (!name.equals (""))

           name = name + '.';

         name = name + entry.name ();

      }

      else

         name = javaName (mType);

    }

    else

    {

      name = containerFullName (entry.container ());

      if (name.equals (""))

        name = entry.name ();

      else

        name = name + '.' + entry.name ();

    }

    // Make it a fully package-qualified name

    return name.replace ('/', '.');

  } // javaName

  public static String javaPrimName (String name)

  {

    if (name.equals ("long") || name.equals ("unsigned long"))

      name = "int";

    else if (name.equals ("octet"))

      name = "byte";

    // "unisigned long long" exceeds Java long.

    else if (name.equals ("long long") || name.equals ("unsigned long long"))

      name = "long";

    else if (name.equals ("wchar"))

      name = "char";

    else if (name.equals ("unsigned short"))

      name = "short";

    else if (name.equals ("any"))

      name = "org.omg.CORBA.Any";

    else if (name.equals ("TypeCode"))

      name = "org.omg.CORBA.TypeCode";

    else if (name.equals ("Principal")) // <d61961>

      name = "org.omg.CORBA.Principal";

    return name;

  } // javaPrimName

  public static String javaNativeName (String name)

  {

    // translations for Native declarations according to CORBA 2.3 spec

    if (name.equals ("AbstractBase") || name.equals ("Cookie"))

      name = "java.lang.Object";

    else if (name.equals ("Servant"))

      name = "org.omg.PortableServer.Servant";

    else if (name.equals ("ValueFactory"))

      name = "org.omg.CORBA.portable.ValueFactory";

    return name;

  }

  /**

   * Given a symtabEntry, return the name of this entry. This

   * method does not do any conversions like javaName does.

   **/

  public static String javaQualifiedName (SymtabEntry entry)

  {

    String name = "";

    if (entry instanceof PrimitiveEntry)

      name = javaPrimName (entry.name ());

    else if (entry instanceof StringEntry)

      name = "String";

    else if (entry instanceof ValueEntry && entry.name ().equals ("ValueBase"))

      name = "java.io.Serializable";

    else

    {

      SymtabEntry container = entry.container ();

      if (container != null)

        name = container.name ();

      if (name.equals (""))

        name = entry.name ();

      else

        name = containerFullName (entry.container ()) + '.' + entry.name ();

    }

    return name.replace ('/', '.');

  } // javaQualifiedName

  // <f46082.03> Publicize for extensions.

  //static String collapseName (String name)

  /**

   * Collapse primitive type names.

   **/

  public static String collapseName (String name)

  {

    if (name.equals ("unsigned short"))

      name = "ushort";

    else if (name.equals ("unsigned long"))

      name = "ulong";

    else if (name.equals ("unsigned long long"))

      name = "ulonglong";

    else if (name.equals ("long long"))

      name = "longlong";

    return name;

  } // collapseName

  /**

   *

   **/

  public static SymtabEntry typeOf (SymtabEntry entry)

  {

    while (entry instanceof TypedefEntry && ((TypedefEntry)entry).arrayInfo ().isEmpty () && !(entry.type () instanceof SequenceEntry))

      entry = entry.type ();

    return entry;

  } // typeOf

  /**

   * Fill the info field with the full name (with array info) of the type.

   **/

  static void fillInfo (SymtabEntry infoEntry)

  {

    String      arrayInfo   = "";

    SymtabEntry entry       = infoEntry;

    boolean     alreadyHave = false;

    do

    {

      try

      {

        alreadyHave = entry.dynamicVariable (Compile.typedefInfo) != null;

      }

      catch (NoSuchFieldException e)

      {}

      // If this entry's info has already been processed

      // don't bother processing it again, just take it.

      if (!alreadyHave)

      {

        if (entry instanceof TypedefEntry)

          arrayInfo = arrayInfo + arrayInfo (((TypedefEntry)entry).arrayInfo ());

        else if (entry instanceof SequenceEntry)

        {

          Expression maxSize = ((SequenceEntry)entry).maxSize ();

          if (maxSize == null)

            arrayInfo = arrayInfo + "[]";

          else

            arrayInfo = arrayInfo + '[' + parseExpression (maxSize) + ']';

        }

        if (entry.type () == null)

        {

          // <d59437> Suppress this message.  It tells the developer nothing, and

          // this path does not cause the algorithm to fail.  Value boxes may

          // contain anonymous types, like a struct or enum.

          //System.err.println (getMessage ("PreEmit.indeterminateTypeInfo", entry.typeName ()));

        }

        else

          entry = entry.type ();

      }

    } while (!alreadyHave && entry != null &&

        (entry instanceof TypedefEntry || entry instanceof SequenceEntry));

    // <d59437> Value boxes may contain types lacking typename info., which

    // causes the 2nd case, below, to fail with exception when retrieving the

    // javaName().

    if (entry instanceof ValueBoxEntry)

      fillValueBoxInfo ((ValueBoxEntry)entry);

    try

    {

      if (alreadyHave)

        infoEntry.dynamicVariable (Compile.typedefInfo, (String)entry.dynamicVariable (Compile.typedefInfo) + arrayInfo);

      else

        infoEntry.dynamicVariable (Compile.typedefInfo, javaName (entry) + arrayInfo);

    }

    catch (NoSuchFieldException e)

    {}

  } // fillInfo

  // <d59437>

  /**

   *

   **/

  static void fillValueBoxInfo (ValueBoxEntry vb)

  {

    SymtabEntry stateMember = (((InterfaceState) vb.state ().elementAt (0)).entry);

    if (stateMember.type() != null)

      Util.fillInfo (stateMember.type ());

    Util.fillInfo (stateMember);

  } // fillValueBoxInfo

  /**

   *

   **/

  public static String holderName (SymtabEntry entry)

  {

    String name;

    if (entry instanceof PrimitiveEntry)

      if (entry.name ().equals ("any"))

        name = "org.omg.CORBA.AnyHolder";

      else if (entry.name ().equals ("TypeCode"))

        name = "org.omg.CORBA.TypeCodeHolder";

      else if (entry.name ().equals ("Principal")) // <d61961>

        name = "org.omg.CORBA.PrincipalHolder";

      else

        name = "org.omg.CORBA." + capitalize (javaQualifiedName (entry)) + "Holder";

    else if (entry instanceof TypedefEntry)

    {

      TypedefEntry td = (TypedefEntry)entry;

      if (!td.arrayInfo ().isEmpty () || td.type () instanceof SequenceEntry)

        name = javaQualifiedName (entry) + "Holder";

      else

        name = holderName (entry.type ());

    }

    else if (entry instanceof StringEntry)

      name = "org.omg.CORBA.StringHolder";

    else if (entry instanceof ValueEntry)

    {

      if (entry.name ().equals ("ValueBase"))

          name = "org.omg.CORBA.ValueBaseHolder"; // <d59421>, <d60929>

      else

          name = javaName (entry) + "Holder";

    } else if (entry instanceof NativeEntry) {

      // do not attach holder to the translation for Native Entries, e.g.

      // for Cookie it should be CookieHolder instead of java.lang.ObjectHolder

      // returns the complete name for the package, etc.