Home | History | Annotate | only in /external/antlr/antlr-3.4/runtime/Python
Up to higher level directory
NameDateSize
antlr3/25-Jul-2013
AUTHORS25-Jul-2013147
ChangeLog25-Jul-20131.3K
dist/25-Jul-2013
doxyfile25-Jul-20139.8K
ez_setup.py25-Jul-20138.3K
hudson-build.sh25-Jul-20131.9K
LICENSE25-Jul-20131.4K
MANIFEST.in25-Jul-201337
mkdoxy.sh25-Jul-2013414
pylintrc25-Jul-20139.1K
README25-Jul-20133K
setup.py25-Jul-20138.9K
tests/25-Jul-2013
TODO25-Jul-20132.9K
unittests/25-Jul-2013
xmlrunner.py25-Jul-201312.2K

README

      1 1) ABOUT
      2 ========
      3 
      4 This is the Python package 'antlr3', which is required to use parsers created
      5 by the ANTLR3 tool. See <http://www.antlr.org/> for more information about
      6 ANTLR3.
      7 
      8 
      9 2) STATUS
     10 =========
     11 
     12 The Python target for ANTLR3 is still in beta. Documentation is lacking, some
     13 bits of the code is not yet done, some functionality has not been tested yet.
     14 Also the API might change a bit - it currently mimics the Java implementation,
     15 but it may be made a bit more pythonic here and there.
     16 
     17 WARNING: Currently the runtime library for V3.1 is not compatible with
     18 recognizers generated by ANTLR V3.0.x. If you are an application developer,
     19 then the suggested way to solve this is to package the correct runtime with
     20 your application. Installing the runtime in the global site-packages directory
     21 may not be a good idea.
     22 It is still undetermined, if a future release of the V3.1 runtime will be
     23 compatible with V3.0.x recognizers or if future runtimes V3.2+ will be
     24 compatible with V3.1 recognizers.
     25 Sorry for the inconvenience.
     26 
     27 
     28 3) DOWNLOAD
     29 ===========
     30 
     31 This runtime is part of the ANTLR distribution. The latest version can be found
     32 at <http://www.antlr.org/download.html>.
     33 
     34 If you are interested in the latest, most bleeding edge version, have a look at
     35 the perforce depot at <http://fisheye2.cenqua.com/browse/antlr>. There are
     36 tarballs ready to download, so you don't have to install the perforce client.
     37 
     38 
     39 4) INSTALLATION
     40 ===============
     41 
     42 Just like any other Python package:
     43 $ python setup.py install
     44 
     45 See <http://docs.python.org/inst/> for more information.
     46 
     47 
     48 5) DOCUMENTATION
     49 ================
     50 
     51 Documentation (as far as it exists) can be found in the wiki
     52 <http://www.antlr.org/wiki/display/ANTLR3/Antlr3PythonTarget>
     53 
     54 
     55 6) REPORTING BUGS
     56 =================
     57 
     58 Please send bug reports to the ANTLR mailing list 
     59 <http://www.antlr.org:8080/mailman/listinfo/antlr-interest> or
     60 <pink (a] odahoda.de>.
     61 
     62 Existing bugs may appear someday in the bugtracker:
     63 <http://www.antlr.org:8888/browse/ANTLR>
     64 
     65 
     66 7) HACKING
     67 ==========
     68 
     69 Only the runtime package can be found here. There are also some StringTemplate
     70 files in 'src/org/antlr/codegen/templates/Python/' and some Java code in
     71 'src/org/antlr/codegen/PythonTarget.java' (of the main ANTLR3 source
     72 distribution).
     73 
     74 If there are no directories 'tests' and 'unittests' in 'runtime/Python', you
     75 should fetch the latest ANTLR3 version from the perforce depot. See section
     76 DOWNLOAD.
     77 You'll need java and ant in order to compile and use the tool.
     78 Be sure to properly setup your CLASSPATH.
     79 (FIXME: is there some generic information, how to build it yourself? I should
     80 point to it to avoid duplication.)
     81 
     82 You can then use the commands
     83 $ python setup.py unittest
     84 $ python setup.py functest
     85 to ensure that changes do not break existing behaviour.
     86 
     87 Please send patches to <pink (a] odahoda.de>. For larger code contributions you'll
     88 have to sign the "Developer's Certificate of Origin", which can be found on
     89 <http://www.antlr.org/license.html> or use the feedback form at
     90 <http://www.antlr.org/misc/feedback>.
     91