GlueGen: src/java/com/jogamp/gluegen/CodeUnit.java Source File

GlueGen v2.6.0-rc-20250822 GlueGen, Native Binding Generator for Java™ (public API).

CodeUnit.java
Go to the documentation of this file.
1/**
2 * Copyright 2023 JogAmp Community. All rights reserved.
3 *
4 * Redistribution and use in source and binary forms, with or without modification, are
5 * permitted provided that the following conditions are met:
6 *
7 * 1. Redistributions of source code must retain the above copyright notice, this list of
8 * conditions and the following disclaimer.
9 *
10 * 2. Redistributions in binary form must reproduce the above copyright notice, this list
11 * of conditions and the following disclaimer in the documentation and/or other materials
12 * provided with the distribution.
13 *
14 * THIS SOFTWARE IS PROVIDED BY JogAmp Community ``AS IS'' AND ANY EXPRESS OR IMPLIED
15 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
16 * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL JogAmp Community OR
17 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
19 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
20 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
21 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
22 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
23 *
24 * The views and conclusions contained in the software and documentation are those of the
25 * authors and should not be interpreted as representing official policies, either expressed
26 * or implied, of JogAmp Community.
27 */
28package com.jogamp.gluegen;
29
30import java.io.BufferedWriter;
31import java.io.File;
32import java.io.FileWriter;
33import java.io.IOException;
34import java.io.PrintWriter;
35import java.util.HashSet;
36import java.util.Set;
37
38/**
39 * General code unit (a generated C or Java source file),
40 * covering multiple {@link FunctionEmitter} allowing to unify output, decoration and dynamic helper code injection per unit.
41 **/
42 public class CodeUnit {
43 public final String filename;
44 public final PrintWriter output;
45 private final Set<String> tailCode = new HashSet<String>();
46
47 /**
48 * @param filename the class's full filename to open w/ write access
49 * @param generator informal optional object that is creating this unit, used to be mentioned in a warning message if not null.
50 * @throws IOException
51 */
52 protected CodeUnit(final String filename, final Object generator) throws IOException {
53 this.filename = filename;
54 this.output = openFile(filename);
55 }
56
57 private static PrintWriter openFile(final String filename) throws IOException {
58 final File file = new File(filename);
59 final String parentDir = file.getParent();
60 if (parentDir != null) {
61 new File(parentDir).mkdirs();
62 }
63 return new PrintWriter(new BufferedWriter(new FileWriter(file)));
64 }
65
66 /**
67 * Add a tail code to this unit
68 * @param c the code to be added to the tail of this code unit
69 * @return true if the `tailCode` set did not already contain the specified code `c`
70 */
71 public boolean addTailCode(final String c) {
72 return tailCode.add(c);
73 }
74
75 public void emitln() {
76 output.println();
77 }
78 public void emitln(final String s) {
79 output.println(s);
80 }
81 public void emit(final String s) {
82 output.print(s);
83 }
84 public void emitf(final String s, final Object... args) {
85 output.printf(s, args);
86 }
87 public void emitTailCode() {
88 tailCode.forEach( (final String t) -> { output.write(t); output.println(); } );
89 tailCode.clear();
90 }
91 public void close() {
92 emitTailCode();
93 output.flush();
94 output.close();
95 }
96
97 @Override
98 public String toString() { return "CodeUnit[file "+filename+"]"; }
99}
com.jogamp.gluegen.CodeUnit
General code unit (a generated C or Java source file), covering multiple FunctionEmitter allowing to ...
Definition: CodeUnit.java:42
com.jogamp.gluegen.CodeUnit.emitln
void emitln()
Definition: CodeUnit.java:75
com.jogamp.gluegen.CodeUnit.emitln
void emitln(final String s)
Definition: CodeUnit.java:78
com.jogamp.gluegen.CodeUnit.toString
String toString()
Definition: CodeUnit.java:98
com.jogamp.gluegen.CodeUnit.addTailCode
boolean addTailCode(final String c)
Add a tail code to this unit.
Definition: CodeUnit.java:71
com.jogamp.gluegen.CodeUnit.emit
void emit(final String s)
Definition: CodeUnit.java:81
com.jogamp.gluegen.CodeUnit.filename
final String filename
Definition: CodeUnit.java:43
com.jogamp.gluegen.CodeUnit.close
void close()
Definition: CodeUnit.java:91
com.jogamp.gluegen.CodeUnit.output
final PrintWriter output
Definition: CodeUnit.java:44
com.jogamp.gluegen.CodeUnit.emitf
void emitf(final String s, final Object... args)
Definition: CodeUnit.java:84
com.jogamp.gluegen.CodeUnit.CodeUnit
CodeUnit(final String filename, final Object generator)
Definition: CodeUnit.java:52
com.jogamp.gluegen.CodeUnit.emitTailCode
void emitTailCode()
Definition: CodeUnit.java:87