utils/abcasm/README

   1 /* -*- Mode: text; c-basic-offset: 4; indent-tabs-mode: nil; tab-width: 4 -*- */
   2  * ***** BEGIN LICENSE BLOCK *****
   3  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   4  *
   5  * The contents of this file are subject to the Mozilla Public License Version
   6  * 1.1 (the "License"); you may not use this file except in compliance with
   7  * the License. You may obtain a copy of the License at
   8  * http://www.mozilla.org/MPL/
   9  *
  10  * Software distributed under the License is distributed on an "AS IS" basis,
  11  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12  * for the specific language governing rights and limitations under the
  13  * License.
  14  *
  15  * The Original Code is [Open Source Virtual Machine.].
  16  *
  17  * The Initial Developer of the Original Code is
  18  * Adobe System Incorporated.
  19  * Portions created by the Initial Developer are Copyright (C) 2009
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  *   Adobe AS3 Team
  24  *
  25  * Alternatively, the contents of this file may be used under the terms of
  26  * either the GNU General Public License Version 2 or later (the "GPL"), or
  27  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  28  * in which case the provisions of the GPL or the LGPL are applicable instead
  29  * of those above. If you wish to allow use of your version of this file only
  30  * under the terms of either the GPL or the LGPL, and not to allow others to
  31  * use your version of this file under the terms of the MPL, indicate your
  32  * decision by deleting the provisions above and replace them with the notice
  33  * and other provisions required by the GPL or the LGPL. If you do not delete
  34  * the provisions above, a recipient may use your version of this file under
  35  * the terms of any one of the MPL, the GPL or the LGPL.
  36  *
  37  * ***** END LICENSE BLOCK *****
  38 abcasm is an ABC assembler.
  39
  40 Usage: see abcasm.sh
  41
  42 Syntax: the assembler language is based on abcdump's output format.
  43
  44 Hacking:
  45
  46 1. Rebuilding the parser requires antlr-3.0.1 and antlr-2.7.7,
  47 (ANTLR to be upgraded to version 3.1).
  48
  49 2. $ASC must point to asc.jar.
  50
  51 3. Put the paths to the ANTLR jarfiles in a build.properties file, e.g.
  52
  53 # ANTLR grammar regeneration support
  54 # Note both ANTLR3 and ANTLR 2.7.7 are required, and both are provided
  55 # by the 3.0.1 distribution.
  56 lib.dir=C:/work/antlr-3.0.1
  57
  58 4. ant
  59
  60 Hacking with Eclipse:
  61
  62 1. make abcasm be the root of your eclipse project
  63 2. add asc.jar, antlr-3.0.1.jar, and antlr-2.7.7.jar as external libraries
  64 3. build with ant, first, to get gensrc/*.java
  65 4. now you should be able to edit/save/test in eclipse