1 ANTLR v3.1 .NET Runtime Library (for us with the ANTLR C# Code Generator) 2 3 29 September, 2007 4 5 Kunle Odutola : kunle UNDERSCORE odutola AT hotmail DOT com 6 Micheal Jordan 7 8 1. INTRODUCTION 9 10 The ANTLR v3.1 .NET Runtime Library extend the ANTLR language processing 11 tools generator to the C#/CLI platforms such as Microsoft .NET, 12 Novell/Ximian Mono and dotGNU. It is written in the C# programming language 13 and was designed specifically for use with the ANTLR C# Code Generation 14 target but, it would work equally well with a VB.NET, C++/CLI or indeed 15 IronPython code generator were such a thing to be developed for ANTLR v3.1. 16 17 We hope you find the ANTLR v3.1 .NET Runtime Library delightful and useful 18 even but, as per the license under which you may use it, this software is not 19 guaranteed to work. 20 21 Please see LICENSE.TXT for the full text of the license and NOTICE.TXT 22 for attribution notices. 23 24 25 2. WHAT'S IN THE PACK? 26 27 This distribution contains three projects, the project files needed to 28 build them with Microsoft Visual Studio 2003 & 2005 and, Nant build files. 29 30 The projects are: 31 32 1. Antlr3.Runtime - the ANTLR v3.1 .NET Runtime Library 33 34 2. Antlr3.Utility - the ANTLR v3.1 .NET Runtime Utility Library 35 36 3. Antlr3.Runtime.Tests - the ANTLR v3.1 .NET Runtime Library Tests 37 38 In addition the Libraries sub-directory contains externals dependencies. 39 40 2.1 Dependencies 41 42 1. Antlr3.Runtime - none 43 44 2. Antlr3.Utility - Antlr3.Runtime.dll 45 StringTemplate.dll 46 antlr.runtime.dll 47 48 3. Antlr3.Runtime.Tests - Antlr3.Runtime.dll 49 StringTemplate.dll 50 antlr.runtime.dll 51 52 In addition, Antlr3.Runtime.Tests has a dependency on the MbUnit v2.4 dlls. 53 54 55 3. USING The ANTLR v3.1 .NET Runtime Library 56 57 Tou use the ANTLR v3.1 .NET Runtime Library in your projects, add a 58 reference to the following file in your projects: 59 - Antlr3.Runtime.dll 60 61 If you are using StringTemplate out in your grammar, add the following 62 files too: 63 - StringTemplate.dll 64 - antlr.runtime.dll 65 66 You can find examples of using ANTLR v3.1 and the ANTLR v3.1 .NET Runtime 67 Library at: 68 http://www.antlr.org/download/examples-v3.tar.gz 69 70 71 4. BUILDING The ANTLR v3.1 .NET Runtime Library 72 73 If you wish to re-build The ANTLR v3.1 .NET Runtime Library for any reason, this 74 is what you need to know. 75 76 nant clean 77 nant release -t:net-1.1 78 or 79 nant clean 80 nant release -t:net-2.0 81 82 83 5. ANTLR v3.1 .NET Runtime Library STATUS 84 85 This release of the ANTLR v3.1 .NET Runtime Library is a stable beta release. 86 87 There are currently 0 failures in the unit test suite. 88 89 90 Don't forget to visit the www.antlr.org for further info. The mailing lists 91 are (currently) low volume and have a very high Signal-to-Noise ratio. We'd 92 like to hear about how you're using ANTLR v3.1 and the .NET Runtime Library. 93 94 95 7. CONTRIBUTORS 96 97 Kunle Odutola 98 Micheal Jordan 99 100 101 Enjoy! 102 103 Kunle Odutola 104