OpenFDL Compiler Readme

OpenFDL Compiler v0.9.0

Description
Running OpenFDL
Support
License
History

Description

OpenFDL is an open-source frame description language compiler. So in other words you enter something in FDL and you get a header file that you can use in TI Flash Studio. I felt it was a good idea to make this, since (1) TI never did, and (2) it's a good way to learn ANTLR (In fact, if you want to learn ANTLR, I recommend trying to make this app all over again, and if you need help, just take a peak at the source code).

Running OpenFDL

Requirements:

Java Runtime Environment (At the time of writing, the most recent version was 1.5.0_03) [download link]
ANTLR v2.7.5 JAR file [download link]

Step 1:	Install Java, if you haven't already done so.
Step 2:	Download and move antlr-2.7.5.jar to the directory with openfdl.jar in it.
Step 3:	Open a console window and type something to the effect of `java -jar openfdl.jar infile.fdl outfile.h`

You will either get outfile.h, a usage statement from OpenFDL or an error message from Java. Good luck!

Support

I keep getting a message saying Exception in thread "main" java.lang.NoClassDefFoundError: antlr/RecognitionException.
Java cannot find the antlr-2.7.5.jar, this package must be in the same directory as the OpenFDL JAR.

How come my char const * parameter keeps giving me an error message?
OpenFDL can handle the const attribute, but you have to put it first (at least for now..), like const char *.

When I compile my *.fdl file, it says "Build Suceeded" at the end but the header file only has that output/date/input/generator junk at the top.
I'd be willing to bet you also got some error/warning messages during that build. They might even say "parser failure before EOF ." This is primarily caused by a misspelled frame type (var, appvar, func, or appfunc) which tend to make the parser exit completely instead of skipping it, like other errors do.

If you have any other questions, comments, or bug reports, feel free to e-mail me.

License

OpenFDL Compiler

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program 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 for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

History
0.1	start

0.1.1	usage
0.1.2	apache ant

0.2	antlr scanner

0.2.1	literals, comments, etc
0.2.2	operators

0.3	antlr parser

0.3.1	C types
0.3.2	frame types
0.3.3	declarations
0.3.4	ast building

0.4	generic AST reader (scrapped)

0.5	antlr treeparser

0.5.1	grammer file
0.5.2	var/appvar declaration
0.5.3	func declaration
0.5.4	appfunc declaration
0.5.5	methods and fields
0.5.6	nodes
0.5.7	slot numbers

0.6	file output

0.6.1	node structure
0.6.2	variables
0.6.3	functions
0.6.4	header
0.6.5	parameters

0.7	error catching

0.7.1	AST [TreeParser]
0.7.2	Lexer [Parser]

0.8	(skipped)

0.9	debug / release candidate

1.0	finish - not here yet

OpenFDL Compiler v0.9.0

Table of Contents

Description

Running OpenFDL

Support

License