xref: /aosp_15_r20/external/antlr/runtime/ActionScript/README (revision 16467b971bd3e2009fad32dd79016f2c7e421deb)
1*16467b97STreehugger Robot1) ABOUT
2*16467b97STreehugger Robot========
3*16467b97STreehugger Robot
4*16467b97STreehugger RobotThis is the ActionScript package 'antlr3', which is required to use parsers created
5*16467b97STreehugger Robotby the ANTLR3 tool. See <http://www.antlr.org/> for more information about
6*16467b97STreehugger RobotANTLR3.
7*16467b97STreehugger Robot
8*16467b97STreehugger Robot
9*16467b97STreehugger Robot2) STATUS
10*16467b97STreehugger Robot=========
11*16467b97STreehugger Robot
12*16467b97STreehugger RobotThe ActionScript target for ANTLR3 is considered a solid beta at this point.  Most things
13*16467b97STreehugger Robotshould work, but a comprehensive suite of tests has not been built yet, so some areas may
14*16467b97STreehugger Robotbe untested.
15*16467b97STreehugger Robot
16*16467b97STreehugger Robot3) DOWNLOAD
17*16467b97STreehugger Robot===========
18*16467b97STreehugger Robot
19*16467b97STreehugger RobotThis runtime is part of the ANTLR distribution. The latest version can be found
20*16467b97STreehugger Robotat <http://www.antlr.org/download.html>.
21*16467b97STreehugger Robot
22*16467b97STreehugger RobotIf you are interested in the latest, most bleeding edge version, have a look at
23*16467b97STreehugger Robotthe perforce depot at <http://fisheye2.cenqua.com/browse/antlr>. There are
24*16467b97STreehugger Robottarballs ready to download, so you don't have to install the perforce client.
25*16467b97STreehugger Robot
26*16467b97STreehugger Robot
27*16467b97STreehugger Robot4) USAGE
28*16467b97STreehugger Robot===============
29*16467b97STreehugger Robot
30*16467b97STreehugger RobotInclude the antlr3.swc from the lib directory into your flex project.
31*16467b97STreehugger Robot
32*16467b97STreehugger Robot5) DOCUMENTATION
33*16467b97STreehugger Robot================
34*16467b97STreehugger Robot
35*16467b97STreehugger RobotAPI Documentation is available in the file "antlr3-asdoc.zip"  User documentation
36*16467b97STreehugger Robot(as far as it exists) can be found in the wiki
37*16467b97STreehugger Robot<http://www.antlr.org/wiki/display/ANTLR3/Antlr3ActionScriptTarget>
38*16467b97STreehugger Robot
39*16467b97STreehugger Robot
40*16467b97STreehugger Robot6) REPORTING BUGS
41*16467b97STreehugger Robot=================
42*16467b97STreehugger Robot
43*16467b97STreehugger RobotPlease send bug reports to the ANTLR mailing list
44*16467b97STreehugger Robot<http://www.antlr.org:8080/mailman/listinfo/antlr-interest> or
45*16467b97STreehugger Robot<[email protected]>.  Direct e-mail is preferable as the antlr-interest
46*16467b97STreehugger Robotlist is not read on a daily basis by the maintainers.
47*16467b97STreehugger Robot
48*16467b97STreehugger RobotExisting bugs may appear someday in the bugtracker:
49*16467b97STreehugger Robot<http://www.antlr.org:8888/browse/ANTLR>
50*16467b97STreehugger Robot
51*16467b97STreehugger Robot
52*16467b97STreehugger Robot7) HACKING
53*16467b97STreehugger Robot==========
54*16467b97STreehugger Robot
55*16467b97STreehugger RobotOnly the runtime package can be found here. There are also some StringTemplate
56*16467b97STreehugger Robotfiles in 'src/org/antlr/codegen/templates/ActionScript/' and some Java code in
57*16467b97STreehugger Robot'src/org/antlr/codegen/ActionScriptTarget.java' (of the main ANTLR3 source
58*16467b97STreehugger Robotdistribution).
59*16467b97STreehugger Robot
60*16467b97STreehugger RobotThe 'project' directory contains everything you need to rebuild the library from source.
61*16467b97STreehugger RobotIt also includes all unit tests.
62*16467b97STreehugger Robot
63*16467b97STreehugger RobotPlease send patches to <[email protected]>. For larger code contributions you'll
64*16467b97STreehugger Robothave to sign the "Developer's Certificate of Origin", which can be found on
65*16467b97STreehugger Robot<http://www.antlr.org/license.html> or use the feedback form at
66*16467b97STreehugger Robot<http://www.antlr.org/misc/feedback>.
67