JavaCompilerCore/doc/LambdaJavadoc/mycompiler/MyCompilerAPI.html

400 lines
15 KiB
HTML
Executable File
Raw Blame History

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="de">
<head>
<!-- Generated by javadoc (version 1.7.0_25) on Wed Sep 18 10:43:01 CEST 2013 -->
<title>MyCompilerAPI</title>
<meta name="date" content="2013-09-18">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="MyCompilerAPI";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/MyCompilerAPI.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../deprecated-list.html">Deprecated</a></li>
<li><a href="../index-files/index-1.html">Index</a></li>
<li><a href="../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../mycompiler/MyCompiler.html" title="class in mycompiler"><span class="strong">Prev Class</span></a></li>
<li><a href="../mycompiler/SourceFile.html" title="class in mycompiler"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../index.html?mycompiler/MyCompilerAPI.html" target="_top">Frames</a></li>
<li><a href="MyCompilerAPI.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">mycompiler</div>
<h2 title="Interface MyCompilerAPI" class="title">Interface MyCompilerAPI</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../mycompiler/MyCompiler.html" title="class in mycompiler">MyCompiler</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="strong">MyCompilerAPI</span></pre>
<div class="block">Schnittstellen-Klasse zum Compiler. Diese Klasse soll der
IDE als Compiler-API zum Kompilieren einer Quellcode-Datei
dienen und stellt somit die Schnittstelle zur Studienarbeit
von Markus Melzer (Eclipse-Plugin) dar.</div>
<dl><dt><span class="strong">Version:</span></dt>
<dd>$Date: 2013/09/22 20:12:45 $</dd>
<dt><span class="strong">Author:</span></dt>
<dd>J<EFBFBD>rg B<>uerle</dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../mycompiler/MyCompilerAPI.html#codeGeneration()">codeGeneration</a></strong>()</code>
<div class="block">Author: J<>rg B<>uerle<br/>
Generiert den Bytecode und das Class-File f<>r den Syntaxbaum.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../mycompiler/MyCompilerAPI.html#getOutputDir()">getOutputDir</a></strong>()</code>
<div class="block">Author: Juergen Schmiing <br>
Gibt das Ausgabeverzeichnis fuer die class-Files zurueck.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../mycompiler/SourceFile.html" title="class in mycompiler">SourceFile</a></code></td>
<td class="colLast"><code><strong><a href="../mycompiler/MyCompilerAPI.html#getSyntaxTree()">getSyntaxTree</a></strong>()</code>
<div class="block">Author: J<>rg B<>uerle<br/>
Liefert den geparsten Syntaxbaum zur<75>ck.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../mycompiler/MyCompilerAPI.html#init()">init</a></strong>()</code>
<div class="block">Author: J<>rg B<>uerle<br/>
Initialisiert den Compiler</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../mycompiler/MyCompilerAPI.html#parse(java.io.File)">parse</a></strong>(java.io.File&nbsp;file)</code>
<div class="block">Author: J<>rg B<>uerle<br/>
Parst eine Quellcodedatei und baut den abstrakten Syntaxbaum auf.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../mycompiler/MyCompilerAPI.html#parse(java.lang.String)">parse</a></strong>(java.lang.String&nbsp;srcCode)</code>
<div class="block">Author: J<>rg B<>uerle<br/>
Parst einen String und baut den abstrakten Syntaxbaum auf.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../mycompiler/MyCompilerAPI.html#parse(de.dhbwstuttgart.typeinference.Menge)">parse</a></strong>(de.dhbwstuttgart.typeinference.Menge&lt;java.lang.String&gt;&nbsp;filenames)</code>
<div class="block">Parst zusammenh<6E>ngende JavaKlassen in verschiedenen Dateien.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../mycompiler/MyCompilerAPI.html#setOutputDir(java.lang.String)">setOutputDir</a></strong>(java.lang.String&nbsp;dir)</code>
<div class="block">Author: Juergen Schmiing <br>
Legt das Ausgabeverzeichnis fuer die class-Files fest.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>de.dhbwstuttgart.typeinference.Menge&lt;<a href="../mycompiler/mytypereconstruction/CTypeReconstructionResult.html" title="class in mycompiler.mytypereconstruction">CTypeReconstructionResult</a>&gt;</code></td>
<td class="colLast"><code><strong><a href="../mycompiler/MyCompilerAPI.html#typeReconstruction()">typeReconstruction</a></strong>()</code>
<div class="block">Author: J<>rg B<>uerle<br/>
Ruft den Typrekonstruktionsalgorithmus auf.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="init()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>init</h4>
<pre>void&nbsp;init()</pre>
<div class="block">Author: J<>rg B<>uerle<br/>
Initialisiert den Compiler</div>
</li>
</ul>
<a name="parse(java.io.File)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>parse</h4>
<pre>void&nbsp;parse(java.io.File&nbsp;file)
throws java.io.FileNotFoundException,
java.io.IOException,
<a href="../mycompiler/myparser/JavaParser.yyException.html" title="class in mycompiler.myparser">JavaParser.yyException</a></pre>
<div class="block">Author: J<>rg B<>uerle<br/>
Parst eine Quellcodedatei und baut den abstrakten Syntaxbaum auf.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>file</code> - Die Quellcode-Datei</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.FileNotFoundException</code> - Wenn die Quellcode-Datei nicht existiert.</dd>
<dd><code>java.io.IOException</code> - Wenn was schief l<>uft.</dd>
<dd><code>JavaParser.yyException</code> - Wenn ein Fehler beim Parsen auftritt.</dd></dl>
</li>
</ul>
<a name="parse(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>parse</h4>
<pre>void&nbsp;parse(java.lang.String&nbsp;srcCode)
throws java.io.IOException,
<a href="../mycompiler/myparser/JavaParser.yyException.html" title="class in mycompiler.myparser">JavaParser.yyException</a></pre>
<div class="block">Author: J<>rg B<>uerle<br/>
Parst einen String und baut den abstrakten Syntaxbaum auf.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>srcCode</code> - Der zu parsende Quellcode</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code> - Wenn was schief l<>uft.</dd>
<dd><code>JavaParser.yyException</code> - Wenn ein Fehler beim Parsen auftritt.</dd></dl>
</li>
</ul>
<a name="typeReconstruction()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>typeReconstruction</h4>
<pre>de.dhbwstuttgart.typeinference.Menge&lt;<a href="../mycompiler/mytypereconstruction/CTypeReconstructionResult.html" title="class in mycompiler.mytypereconstruction">CTypeReconstructionResult</a>&gt;&nbsp;typeReconstruction()
throws java.lang.NullPointerException,
<a href="../mycompiler/myexception/CTypeReconstructionException.html" title="class in mycompiler.myexception">CTypeReconstructionException</a></pre>
<div class="block">Author: J<>rg B<>uerle<br/>
Ruft den Typrekonstruktionsalgorithmus auf.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>Die Menge aller m<>glichen Typkombinationen</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - Wenn noch kein abstrakter Syntaxbaum vorhanden
ist. @throws CTypeReconstructionException Wenn ein Fehler bei der
Typrekonstruktion auftritt.</dd>
<dd><code><a href="../mycompiler/myexception/CTypeReconstructionException.html" title="class in mycompiler.myexception">CTypeReconstructionException</a></code></dd></dl>
</li>
</ul>
<a name="getSyntaxTree()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSyntaxTree</h4>
<pre><a href="../mycompiler/SourceFile.html" title="class in mycompiler">SourceFile</a>&nbsp;getSyntaxTree()
throws java.lang.NullPointerException</pre>
<div class="block">Author: J<>rg B<>uerle<br/>
Liefert den geparsten Syntaxbaum zur<75>ck.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>Die Syntaxb<78>ume</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - Wenn noch kein Syntaxbaum berechnet worden ist.</dd></dl>
</li>
</ul>
<a name="codeGeneration()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>codeGeneration</h4>
<pre>void&nbsp;codeGeneration()
throws java.lang.NullPointerException,
<a href="../mycompiler/myexception/JVMCodeException.html" title="class in mycompiler.myexception">JVMCodeException</a></pre>
<div class="block">Author: J<>rg B<>uerle<br/>
Generiert den Bytecode und das Class-File f<>r den Syntaxbaum.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>syntaxTree</code> - Der Syntaxbaum</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - Wenn noch kein abstrakter Syntaxbaum vorhanden
ist. @throws JVMCodeException</dd>
<dd><code><a href="../mycompiler/myexception/JVMCodeException.html" title="class in mycompiler.myexception">JVMCodeException</a></code></dd></dl>
</li>
</ul>
<a name="setOutputDir(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setOutputDir</h4>
<pre>void&nbsp;setOutputDir(java.lang.String&nbsp;dir)</pre>
<div class="block">Author: Juergen Schmiing <br>
Legt das Ausgabeverzeichnis fuer die class-Files fest.</div>
</li>
</ul>
<a name="getOutputDir()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOutputDir</h4>
<pre>java.lang.String&nbsp;getOutputDir()</pre>
<div class="block">Author: Juergen Schmiing <br>
Gibt das Ausgabeverzeichnis fuer die class-Files zurueck.</div>
</li>
</ul>
<a name="parse(de.dhbwstuttgart.typeinference.Menge)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>parse</h4>
<pre>void&nbsp;parse(de.dhbwstuttgart.typeinference.Menge&lt;java.lang.String&gt;&nbsp;filenames)</pre>
<div class="block">Parst zusammenh<6E>ngende JavaKlassen in verschiedenen Dateien.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>filenames</code> - - Eine Liste von Quellcodedateien, welche gseparst werden sollen</dd></dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/MyCompilerAPI.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../deprecated-list.html">Deprecated</a></li>
<li><a href="../index-files/index-1.html">Index</a></li>
<li><a href="../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../mycompiler/MyCompiler.html" title="class in mycompiler"><span class="strong">Prev Class</span></a></li>
<li><a href="../mycompiler/SourceFile.html" title="class in mycompiler"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../index.html?mycompiler/MyCompilerAPI.html" target="_top">Frames</a></li>
<li><a href="MyCompilerAPI.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>