StructEntry.java revision 672:2bb058ce572e 
1/*
2 * Copyright (c) 1999, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation.  Oracle designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Oracle in the LICENSE file that accompanied this code.
10 *
11 * This code is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22 * or visit www.oracle.com if you need additional information or have any
23 * questions.
24 */
25/*
26 * COMPONENT_NAME: idl.parser
27 *
28 * ORIGINS: 27
29 *
30 * Licensed Materials - Property of IBM
31 * 5639-D57 (C) COPYRIGHT International Business Machines Corp. 1997, 1999
32 * RMI-IIOP v1.0
33 *
34 */
35
36package com.sun.tools.corba.se.idl;
37
38// NOTES:
39
40import java.io.PrintWriter;
41import java.util.Enumeration;
42import java.util.Hashtable;
43import java.util.Vector;
44
45/**
46 * This is the symbol table entry for structs.
47 **/
48public class StructEntry extends SymtabEntry
49{
50  protected StructEntry ()
51  {
52    super ();
53  } // ctor
54
55  protected StructEntry (StructEntry that)
56  {
57    super (that);
58    if (!name ().equals (""))
59    {
60      module (module () + name ());
61      name ("");
62    }
63    _members   = (Vector)that._members.clone ();
64    _contained = (Vector)that._contained.clone ();
65  } // ctor
66
67  protected StructEntry (SymtabEntry that, IDLID clone)
68  {
69    super (that, clone);
70    if (module ().equals (""))
71      module (name ());
72    else if (!name ().equals (""))
73      module (module () + "/" + name ());
74  } // ctor
75
76  public Object clone ()
77  {
78    return new StructEntry (this);
79  } // clone
80
81  /** Invoke the struct generator.
82      @param symbolTable the symbol table is a hash table whose key is
83       a fully qualified type name and whose value is a SymtabEntry or
84       a subclass of SymtabEntry.
85      @param stream the stream to which the generator should sent its output.
86      @see SymtabEntry */
87  public void generate (Hashtable symbolTable, PrintWriter stream)
88  {
89    structGen.generate (symbolTable, this, stream);
90  } // generate
91
92  /** Access the struct generator.
93      @return an object which implements the StructGen interface.
94      @see StructGen */
95  public Generator generator ()
96  {
97    return structGen;
98  } // generator
99
100  /** Add a member to the member list. */
101  public void addMember (TypedefEntry member)
102  {
103    _members.addElement (member);
104  } // addMember
105
106  /** This is a vector of TypedefEntry's.  In this context, only the name,
107      type, and arrayInfo fields hold any meaning. */
108  public Vector members ()
109  {
110    return _members;
111  } // members
112
113  public void addContained (SymtabEntry entry)
114  {
115    _contained.addElement (entry);
116  } // addContained
117
118  /** This is a vector of SymtabEntry's.  It itemizes any types which
119      this struct contains.  It is different than the member list.
120      For example:
121      <pre>
122      struct A
123      {
124        long x;
125        Struct B
126        {
127          long a;
128          long b;
129        } y;
130      }
131      </pre>
132      Struct B is contained within struct A.
133      The members vector will contain entries for x and y. */
134  public Vector contained ()
135  {
136    return _contained;
137  } // contained
138
139  private Vector _members   = new Vector ();
140  private Vector _contained = new Vector ();
141
142  static StructGen structGen;
143} // class StructEntry
144