/*

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

// -D61056   <klr> Use Util.helperName

import java.io.PrintWriter;

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

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

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

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

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

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

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

/**

 *

 **/

public class Holder implements AuxGen

{

  /**

   * Public zero-argument constructor.

   **/

  public Holder ()

  {

  } // ctor

  /**

   * Generate the holder class. Provides general algorithm for

   * auxiliary binding generation:

   * 1.) Initialize symbol table and symbol table entry members,

   *     common to all generators.

   * 2.) Initialize members unique to this generator.

   * 3.) Open print stream

   * 4.) Write class heading (package, prologue, source comment, class

   *     statement, open curly

   * 5.) Write class body (member data and methods)

   * 6.) Write class closing (close curly)

   * 7.) Close the print stream

   **/

  public void generate (java.util.Hashtable symbolTable, com.sun.tools.corba.se.idl.SymtabEntry entry)

  {

    this.symbolTable = symbolTable;

    this.entry       = entry;

    init ();

    openStream ();

    if (stream == null)

      return;

    writeHeading ();

    writeBody ();

    writeClosing ();

    closeStream ();

  } // generate

  /**

   * Initialize variables unique to this generator.

   **/

  protected void init ()

  {

    holderClass = entry.name () + "Holder";

    helperClass = Util.helperName (entry, true); // <d61056>

    if (entry instanceof ValueBoxEntry)

    {

      ValueBoxEntry v = (ValueBoxEntry) entry;

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

      SymtabEntry mType =  member.type ();

      holderType = Util.javaName (mType);

    }

    else

      holderType = Util.javaName (entry);

  } // init

  /**

   * Open the print stream for subsequent output.

   **/

  protected void openStream ()

  {

    stream = Util.stream (entry, "Holder.java");

  } // openStream

  /**

   * Generate the heading, including the package, imports,

   * source comment, class statement, and left curly.

   **/

  protected void writeHeading ()

  {

    Util.writePackage (stream, entry, Util.HolderFile);

    Util.writeProlog (stream, stream.name ());

    if (entry.comment () != null)

      entry.comment ().generate ("", stream);

    stream.println ("public final class " + holderClass + " implements org.omg.CORBA.portable.Streamable");

    stream.println ('{');

  } // writeHeading

  /**

   * Generate members of this class.

   **/

  protected void writeBody ()

  {

    if (entry instanceof ValueBoxEntry)

      stream.println ("  public " + holderType + " value;");

    else

      Util.writeInitializer ("  public ", "value", "", entry, stream);

    stream.println ();

    writeCtors ();

    writeRead ();

    writeWrite ();

    writeType ();

  } // writeBody

  /**

   * Generate the closing statements.

   **/

  protected void writeClosing ()

  {

    stream.println ('}');

  } // writeClosing

  /**

   * Write the stream to file by closing the print stream.

   **/

  protected void closeStream ()

  {

    stream.close ();

  } // closeStream

  /**

   * Generate the constructors.

   **/

  protected void writeCtors ()

  {

    stream.println ("  public " + holderClass + " ()");

    stream.println ("  {");

    stream.println ("  }");

    stream.println ();

    stream.println ("  public " + holderClass + " (" + holderType + " initialValue)");

    stream.println ("  {");

    stream.println ("    value = initialValue;");

    stream.println ("  }");

    stream.println ();

  } // writeCtors

  /**

   * Generate the _read method.

   **/

  protected void writeRead ()

  {

    stream.println ("  public void _read (org.omg.CORBA.portable.InputStream i)");

    stream.println ("  {");

    if (entry instanceof ValueBoxEntry)

    {

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

      SymtabEntry mType = member.type ();

      if (mType instanceof StringEntry)

        stream.println ("    value = i.read_string ();");

      else if (mType instanceof PrimitiveEntry)

        stream.println ("    value = " + helperClass + ".read (i).value;");

      else

        stream.println ("    value = " + helperClass + ".read (i);");

    }

    else

      stream.println ("    value = " + helperClass + ".read (i);");

    stream.println ("  }");

    stream.println ();

  } // writeRead

  /**

   * Generate the _write method.

   **/

  protected void writeWrite ()

  {

    stream.println ("  public void _write (org.omg.CORBA.portable.OutputStream o)");

    stream.println ("  {");

    if (entry instanceof ValueBoxEntry)

    {

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

      SymtabEntry mType = member.type ();

      if (mType instanceof StringEntry)

        stream.println ("    o.write_string (value);");

      else if (mType instanceof PrimitiveEntry)

      {

        String name = entry.name ();

        stream.println ("    " + name + " vb = new " + name + " (value);");

        stream.println ("    " + helperClass + ".write (o, vb);");

      }

      else

        stream.println ("    " + helperClass + ".write (o, value);");

    }

    else

      stream.println ("    " + helperClass + ".write (o, value);");

    stream.println ("  }");

    stream.println ();

  } // writeWrite

  /**

   * Generate the _type method.

   **/

  protected void writeType ()

  {

    stream.println ("  public org.omg.CORBA.TypeCode _type ()");

    stream.println ("  {");

    stream.println ("    return " + helperClass + ".type ();");

    stream.println ("  }");

    stream.println ();

  } // writeType

  protected java.util.Hashtable     symbolTable;

  protected com.sun.tools.corba.se.idl.SymtabEntry entry;

  protected GenFileStream           stream;

  // Unique to this generator

  protected String holderClass;

  protected String helperClass;

  protected String holderType;

} // class Holder