/*

 * 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.

 *

 */

/*

 * Licensed Materials - Property of IBM

 * RMI-IIOP v1.0

 * Copyright IBM Corp. 1998 1999  All Rights Reserved

 *

 */

package sun.rmi.rmic.iiop;

import java.util.Hashtable;

import java.util.Locale;

import sun.tools.java.Identifier;

import sun.tools.java.CompilerError;

import sun.tools.java.ClassDefinition;

import sun.tools.java.ClassNotFound;

import com.sun.corba.se.impl.util.RepositoryId;

/**

 * IDLNames provides static utility methods to perform the IDL

 * name mappings specified in Chapter 5 of the Java Language

 * to IDL specification.

 *

 * @author      Bryan Atsatt

 */

public class IDLNames implements sun.rmi.rmic.iiop.Constants {

    /**

     * Used to convert ascii to hex.

     */

    public static final byte ASCII_HEX[] =      {

        (byte)'0',

        (byte)'1',

        (byte)'2',

        (byte)'3',

        (byte)'4',

        (byte)'5',

        (byte)'6',

        (byte)'7',

        (byte)'8',

        (byte)'9',

        (byte)'A',

        (byte)'B',

        (byte)'C',

        (byte)'D',

        (byte)'E',

        (byte)'F',

    };

    //_____________________________________________________________________

    // Public Interfaces

    //_____________________________________________________________________

    /**

     * Convert a name. The nameContext argument MUST be pre-filled with

     * all names from the appropriate context (e.g. all the method names

     * in a given class). The names must not have had any IDL conversions

     * applied.

     * <p>

     * Section 28.3.2.2

     * Section 28.3.2.3

     * Section 28.3.2.4

     * Section 28.3.2.7 (member and method names only)

     */

    public static String getMemberOrMethodName (NameContext nameContext,

                                                String name,

                                                BatchEnvironment env) {

        // Check namesCache...

        String result = (String) env.namesCache.get(name);

        if (result == null) {

            // 28.3.2.7 Case sensitive member names.

            // Note:    This must be done before any of

            //          the other conversions!

            result = nameContext.get(name);

            // 28.3.2.3 Leading underscores...

            result = convertLeadingUnderscores(result);

            // 28.3.2.2 IDL keywords (NOTE: must be done

            // after leading underscore conversion because

            // the mangling for IDL keywords creates a

            // leading underscore!)...

            result = convertIDLKeywords(result);

            // 28.3.2.4 Illegal IDL identifier characters...

            result = convertToISOLatin1(result);

            // Add to namesCache...

            env.namesCache.put(name,result);

        }

        return result;

    }

    /**

     * Convert names with illegal IDL identifier characters.

     * <p>

     * Section 28.3.2.4

     */

    public static String convertToISOLatin1 (String name) {

        // First, replace any escape sequences...

        String result = replace(name,"x\\u","U");

        result = replace(result,"x\\U","U");

        // Now see if we have any remaining illegal characters (see

        // RepositoryId.IDL_IDENTIFIER_CHARS array)...

        int length = result.length();

        StringBuffer buffer = null;

        for (int i = 0; i < length; i++) {

            char c = result.charAt(i);

            if (c > 255 || RepositoryId.IDL_IDENTIFIER_CHARS[c] == 0) {

                // We gotta convert. Have we already started?

                if (buffer == null) {

                    // No, so get set up...

                    buffer = new StringBuffer(result.substring(0,i));

                }

                // Convert the character into the IDL escape syntax...

                buffer.append("U");

                buffer.append((char)ASCII_HEX[(c & 0xF000) >>> 12]);

                buffer.append((char)ASCII_HEX[(c & 0x0F00) >>> 8]);

                buffer.append((char)ASCII_HEX[(c & 0x00F0) >>> 4]);

                buffer.append((char)ASCII_HEX[(c & 0x000F)]);

            } else {

                if (buffer != null) {

                    buffer.append(c);

                }

            }

        }

        if (buffer != null) {

            result = buffer.toString();

        }

        return result;

    }

    /**

     * Convert names which collide with IDL keywords.

     * <p>

     * Section 28.3.2.5

     */

    public static String convertIDLKeywords (String name) {

        for (int i = 0; i < IDL_KEYWORDS.length; i++) {

            if (name.equalsIgnoreCase(IDL_KEYWORDS[i])) {

                return "_" + name;

            }

        }

        return name;

    }

    /**

     * Convert names which have leading underscores

     * <p>

     * Section 28.3.2.3

     */

    public static String convertLeadingUnderscores (String name) {

        if (name.startsWith("_")) {

            return "J" + name;

        }

        return name;

    }

    /**

     * Convert a type name.

     * <p>

     * Section 28.3.2.5

     * Section 28.3.2.7 (class or interface names only)

     * Throws exception if fails 28.3.2.7.

     */

    public static String getClassOrInterfaceName (Identifier id,

                                                  BatchEnvironment env) throws Exception {

        // Get the type and package name...

        String typeName = id.getName().toString();

        String packageName = null;

        if (id.isQualified()) {

            packageName = id.getQualifier().toString();

        }

        // Check namesCache...

        String result = (String) env.namesCache.get(typeName);

        if (result == null) {

            // 28.3.2.5 Inner classes...

            result = replace(typeName,". ","__");

            // 28.3.2.4 Illegal identifier characters...

            result = convertToISOLatin1(result);

            // 28.3.2.7 Case sensitive class or interface names...

            NameContext context = NameContext.forName(packageName,false,env);

            context.assertPut(result);

            // Run it through the name checks...

            result = getTypeOrModuleName(result);

            // Add it to the namesCache...

            env.namesCache.put(typeName,result);

        }

        return result;

    }

    /**

     * Convert an Exception name.

     * <p>

     * Section 28.3.7.2    (see ValueType)

     */

    public static String getExceptionName (String idlName) {

        String result = idlName;

// d.11315 Incorrectly mangled exception names

        if (idlName.endsWith(EXCEPTION_SUFFIX)) {

            // Remove "Exception" and append "Ex". Strip leading underscore

            // in case the idlName is exactly "_Exception"...

            result = stripLeadingUnderscore(idlName.substring(0,idlName.lastIndexOf(EXCEPTION_SUFFIX)) + EX_SUFFIX);

        } else {

            result = idlName + EX_SUFFIX;

        }

        return result;

    }

    /**

     * Convert a qualified Identifier into an array of IDL names.

     * <p>

     * Section 28.3.2.1    (see CompoundType)

     * Throws exception if fails 28.3.2.7.

     */

    public static String[] getModuleNames (Identifier theID,

                                           boolean boxIt,

                                           BatchEnvironment env) throws Exception {

        String[] result = null;

        if (theID.isQualified()) {

            // Extract the qualifier...

            Identifier id = theID.getQualifier();

            // 28.3.2.7 Case sensitive module names.

            env.modulesContext.assertPut(id.toString());

            // Count them...

            int count = 1;

            Identifier current = id;

            while (current.isQualified()) {

                current = current.getQualifier();

                count++;

            }

            result = new String[count];

            int index = count-1;

            current = id;

            // Now walk them and fill our array (backwards)...

            for (int i = 0; i < count; i++) {

                String item = current.getName().toString();

                // Check namesCache...

                String cachedItem = (String) env.namesCache.get(item);

                if (cachedItem == null) {

                    // 28.3.2.4 Illegal identifier characters...

                    cachedItem = convertToISOLatin1(item);

                    // Run it through the name checks...

                    cachedItem = getTypeOrModuleName(cachedItem);

                    // Add it to the namesCache...

                    env.namesCache.put(item,cachedItem);

                }

                result[index--] = cachedItem;

                current = current.getQualifier();

            }

        }

        // If it is supposed to be "boxed", prepend

        // IDL_BOXEDIDL_MODULE...

        if (boxIt) {

            if (result == null) {

                result = IDL_BOXEDIDL_MODULE;

            } else {

            String[] boxed = new String[result.length+IDL_BOXEDIDL_MODULE.length];

            System.arraycopy(IDL_BOXEDIDL_MODULE,0,boxed,0,IDL_BOXEDIDL_MODULE.length);

            System.arraycopy(result,0,boxed,IDL_BOXEDIDL_MODULE.length,result.length);

            result = boxed;

        }

        }

        return result;

    }

    /**

     * Get an array name with the specified dimensions.

     * <p>

     * Section 28.3.6  (see ArrayType)

     */

    public static String getArrayName (Type theType, int arrayDimension) {

        StringBuffer idlName = new StringBuffer(64);

        // Prefix with seq<n>_...

        idlName.append(IDL_SEQUENCE);

        idlName.append(Integer.toString(arrayDimension));

        idlName.append("_");

        // Add the type name. We need to map any spaces in the

        // name to "_"...

        idlName.append(replace(stripLeadingUnderscore(theType.getIDLName())," ","_"));

        // And we're done...

        return idlName.toString();

    }

    /**

     * Get an array module names.

     */

    public static String[] getArrayModuleNames (Type theType) {

        String[] moduleName;

        String[] typeModule = theType.getIDLModuleNames();

        int typeModuleLength = typeModule.length;

        // Does the type have a module?

        if (typeModuleLength == 0) {

            // Nope, so just use the sequence module...

            moduleName = IDL_SEQUENCE_MODULE;

        } else {

            // Yes, so gotta concatenate...

            moduleName = new String[typeModuleLength + IDL_SEQUENCE_MODULE.length];

            System.arraycopy(IDL_SEQUENCE_MODULE,0,moduleName,0,IDL_SEQUENCE_MODULE.length);

            System.arraycopy(typeModule,0,moduleName,IDL_SEQUENCE_MODULE.length,typeModuleLength);

        }

        return moduleName;

    }

    private static int getInitialAttributeKind (CompoundType.Method method,

                                                BatchEnvironment env) throws ClassNotFound {

        int result = ATTRIBUTE_NONE;

        // First make sure it is not a constructor...

        if (!method.isConstructor()) {

            // Now check exceptions. It may not throw any checked

            // exception other than RemoteException or one of its

            // subclasses...

            boolean validExceptions = true;

            ClassType[] exceptions = method.getExceptions();

            if (exceptions.length > 0) {

                for (int i = 0; i < exceptions.length; i++) {

                    if (exceptions[i].isCheckedException() &&

                        !exceptions[i].isRemoteExceptionOrSubclass()) {

                        validExceptions = false;

                        break;

                    }

                }

            } else {

                // If this is a ValueType, it is ok to not have any exceptions,

                // otherwise this method does not qualify...

                validExceptions = method.getEnclosing().isType(TYPE_VALUE);

            }

            if (validExceptions) {

                String name = method.getName();

                int nameLength = name.length();

                int argCount = method.getArguments().length;

                Type returnType = method.getReturnType();

                boolean voidReturn = returnType.isType(TYPE_VOID);

                boolean booleanReturn = returnType.isType(TYPE_BOOLEAN);

                // It's a getter if name starts with "get" and it has no arguments

                // and a return type that is not void...

                if (name.startsWith("get") && nameLength > 3 && argCount == 0 && !voidReturn) {

                    result = ATTRIBUTE_GET;

                } else {

                    // It's a getter if name starts with "is" and it has no arguments

                    // and a boolean return type...

                    if (name.startsWith("is") && nameLength > 2 && argCount == 0 && booleanReturn) {

                        result = ATTRIBUTE_IS;

                    } else {

                        // It's a setter if name starts with "set" and it has 1 argument

                        // and a void return type...

                        if (name.startsWith("set") && nameLength > 3 && argCount == 1 && voidReturn) {

                            result = ATTRIBUTE_SET;

                        }

                    }

                }

            }

        }

        return result;

    }

    private static void setAttributeKinds (CompoundType.Method[] methods,

                                           int[] kinds,

                                           String[] names) {

        int count = methods.length;

        // Strip the prefixes off of the attribute names...

        for (int i = 0; i < count; i++) {

            switch (kinds[i]) {

                case ATTRIBUTE_GET: names[i] = names[i].substring(3); break;

                case ATTRIBUTE_IS: names[i] = names[i].substring(2); break;

                case ATTRIBUTE_SET: names[i] = names[i].substring(3); break;

            }

        }

        // Now, we need to look at all the IS attributes to see

        // if there is a corresponding getter or setter which has

        // a different return type. If so, mark it as not an

        // attribute. Do this before checking for invalid setters...

        for (int i = 0; i < count; i++) {

            if (kinds[i] == ATTRIBUTE_IS) {

                for (int j = 0; j < count; j++) {

                    if (j != i &&

                        (kinds[j] == ATTRIBUTE_GET || kinds[j] == ATTRIBUTE_SET) &&

                        names[i].equals(names[j])) {

                        // We have matching getter or setter. Do the types match?

                        Type isType = methods[i].getReturnType();

                        Type targetType;

                        if (kinds[j] == ATTRIBUTE_GET) {

                            targetType = methods[j].getReturnType();

                        } else {

                            targetType = methods[j].getArguments()[0];

                        }