summaryrefslogtreecommitdiffstats
path: root/src/net/java/games/gluegen/FunctionEmitter.java
blob: cb5ef415979697503c3646d742b64d2d09f62337 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
/*
 * Copyright (c) 2003 Sun Microsystems, Inc. All Rights Reserved.
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met:
 * 
 * - Redistribution of source code must retain the above copyright
 *   notice, this list of conditions and the following disclaimer.
 * 
 * - Redistribution in binary form must reproduce the above copyright
 *   notice, this list of conditions and the following disclaimer in the
 *   documentation and/or other materials provided with the distribution.
 * 
 * Neither the name of Sun Microsystems, Inc. or the names of
 * contributors may be used to endorse or promote products derived from
 * this software without specific prior written permission.
 * 
 * This software is provided "AS IS," without a warranty of any kind. ALL
 * EXPRESS OR IMPLIED CONDITIONS, REPRESENTATIONS AND WARRANTIES,
 * INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY, FITNESS FOR A
 * PARTICULAR PURPOSE OR NON-INFRINGEMENT, ARE HEREBY EXCLUDED. SUN
 * MIDROSYSTEMS, INC. ("SUN") AND ITS LICENSORS SHALL NOT BE LIABLE FOR
 * ANY DAMAGES SUFFERED BY LICENSEE AS A RESULT OF USING, MODIFYING OR
 * DISTRIBUTING THIS SOFTWARE OR ITS DERIVATIVES. IN NO EVENT WILL SUN OR
 * ITS LICENSORS BE LIABLE FOR ANY LOST REVENUE, PROFIT OR DATA, OR FOR
 * DIRECT, INDIRECT, SPECIAL, CONSEQUENTIAL, INCIDENTAL OR PUNITIVE
 * DAMAGES, HOWEVER CAUSED AND REGARDLESS OF THE THEORY OF LIABILITY,
 * ARISING OUT OF THE USE OF OR INABILITY TO USE THIS SOFTWARE, EVEN IF
 * SUN HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
 * 
 * You acknowledge that this software is not designed or intended for use
 * in the design, construction, operation or maintenance of any nuclear
 * facility.
 * 
 * Sun gratefully acknowledges that this software was originally authored
 * and developed by Kenneth Bradley Russell and Christopher John Kline.
 */

package net.java.games.gluegen;

import java.util.*;
import java.io.*;

public abstract class FunctionEmitter
{
  public static final EmissionModifier STATIC = new EmissionModifier("static");

  private HashSet modifiers = new HashSet(4);
  private CommentEmitter commentEmitter = null;
  private PrintWriter defaultOutput;

  /**
   * Constructs the FunctionEmitter with a CommentEmitter that emits nothing.
   */
  public FunctionEmitter(PrintWriter defaultOutput)
  {
    assert(defaultOutput != null);
    this.defaultOutput = defaultOutput;
  }
  
  public PrintWriter getDefaultOutput() { return defaultOutput; }
  
  public void addModifiers(Iterator/*<EmissionModifier>*/ mi)
  {
    while (mi.hasNext())
    {
      modifiers.add((EmissionModifier) mi.next());
    }
  }
  public void addModifier(EmissionModifier m) { modifiers.add(m); }

  public boolean removeModifier(EmissionModifier m) { return modifiers.remove(m); }

  public void clearModifiers() { modifiers.clear(); }

  public boolean hasModifier(EmissionModifier m) { return modifiers.contains(m); }

  public Iterator getModifiers() { return modifiers.iterator(); }

  public abstract String getName();

  /**
   * Emit the function to the specified output (instead of the default
   * output).
   */
  public void emit(PrintWriter output)
  {
    emitDocComment(output);
    //output.println("  // Emitter: " + getClass().getName());
    emitSignature(output);
    emitBody(output);
  }

  /**
   * Emit the function to the default output (the output that was passed to
   * the constructor)
   */
  public final void emit()
  {
    emit(getDefaultOutput());
  }

  /** Returns, as a String, whatever {@link emit()} would output. */
  public String toString()
  {
    StringWriter sw = new StringWriter(500);
    PrintWriter w = new PrintWriter(sw);
    emit(w);
    return sw.toString();
  }

  /**
   * Set the object that will emit the comment for this function. If the
   * parameter is null, no comment will be emitted.
   */
  public void setCommentEmitter(CommentEmitter cEmitter)
  {
    commentEmitter = cEmitter;
  }

  /**
   * Get the comment emitter for this FunctionEmitter. The return value may be
   * null, in which case no comment emitter has been set.
   */
  public CommentEmitter getCommentEmitter() { return commentEmitter; }
  
  protected void emitDocComment(PrintWriter writer)
  {
    if (commentEmitter != null)
    {
      writer.print(getBaseIndentString()); //indent

      writer.print(getCommentStartString());

      commentEmitter.emit(this, writer);

      writer.print(getBaseIndentString()); //indent
      
      writer.println(getCommentEndString());
    }
  }
  
  protected void emitSignature(PrintWriter writer)
  {
    writer.print(getBaseIndentString()); // indent method

    int numEmitted = emitModifiers(writer);
    if (numEmitted > 0)
    {
      writer.print(" ");
    }

    emitReturnType(writer);
    writer.print(" ");

    emitName(writer);
    writer.print("(");

    emitArguments(writer);
    writer.print(")");
  }

  protected int emitModifiers(PrintWriter writer)
  {
    PrintWriter w = getDefaultOutput();
    int numEmitted = 0;
    for (Iterator it = getModifiers(); it.hasNext(); )
    {
      writer.print(it.next());
      ++numEmitted;
      if (it.hasNext())
      {
        writer.print(" ");
      }
    }
    return numEmitted;
  }

  protected String getBaseIndentString() { return ""; }
  
  protected String getCommentStartString() { return "/* "; }
  protected String getCommentEndString() { return " */"; }
  
  protected abstract void emitReturnType(PrintWriter writer);
  protected abstract void emitName(PrintWriter writer); 
  /** Returns the number of arguments emitted. */
  protected abstract int emitArguments(PrintWriter writer);  
  protected abstract void emitBody(PrintWriter writer);
  
  public static class EmissionModifier
  {    
    public final String toString() { return emittedForm; }
    
    private String emittedForm;
    protected EmissionModifier(String emittedForm) { this.emittedForm = emittedForm; } 
  }
}