docs/running-ant.txt

   1 Running the ant tasks
   2 ============================================================
   3
   4 This project supplies an ant build file.
   5
   6 When used without parameters it will
   7 - build the main tool, mjc2wsl, as well as the MicroJava compiler
   8 - compile all the given MicroJava samples in a temp folder
   9 - translated these to WSL
  10 - run a transformation script for all of these files
  11 (if FermaT is found)
  12
  13 There are other tasks available, as well as the option of
  14 doing some of the above taks on their own.
  15
  16 Many of these can be given parameters, such as
  17
  18 ant mjc2wsl -Dfilename=temp/Rek1.obj -Dmjc2wsl.options=-q
  19
  20
  21 General tasks
  22 -------------
  23
  24 all - the default one.
  25
  26 init - sets everything up, makes the folders, copies the
  27 samples as needed. Used by most, just in case.
  28
  29 clean - will clean up everything in the temp dirs and
  30 the bin dires, as well as the logs.
  31
  32
  33 mjc2wsl tasks
  34 -------------
  35
  36 mjc2wsl - run the tool on a single file given in "filename".
  37 influenced by "mjc2wsl.options"
  38
  39 mjc2wsl - runs the tool on all obj files in "samples.temp.dir"
  40
  41
  42 MicroJava tasks
  43 ---------------
  44
  45 These tasks use "compiler.class.dir"
  46
  47 mj-decode - decode the bytecode given in "filename" into
  48 operation names and parameteres (uses
  49 "compiler.classname.decoder")
  50
  51 mj-decode-samples - decode the samples in "samples.temp.dir"
  52 and save everything in a file called "decoded.txt" in the
  53 same dir.
  54
  55 mj-compile - compile a file given with "filename" (uses
  56 "compiler.classname.compiler")
  57
  58 mj-samples - compile all the samples in "samples.temp.dir"
  59
  60 mj-run - run with MJVM the obj file given in "filename",
  61 give it "inputstring" as the inputstring (uses
  62 "compiler.classname.interpreter")
  63
  64
  65 WSL tasks
  66 ---------
  67
  68 All of these are influenced by "fermat.dir" - it needs to
  69 be setup properly.
  70
  71 wsl-run - run the wsl file given in "filename",
  72 give it "inputstring" as the inputstring.
  73
  74 wsl-transf - run the wsl transformation script (given in
  75 "transf.wsl.file" on "transf.filename". the result file ends
  76 with "_t".
  77
  78 wsl-transf-samples - transform all the wsl file in the
  79 samples folder, except those ending in "_t" (should be
  80 transformations results from earlier).
  81
  82
  83 Testing tasks
  84 -------------
  85
  86 test-run - run sequentially the '.obj', '.wsl' and '_t.wsl'
  87 versions of the same program. given are "file.dir" and
  88 "file.name" without an extension.
  89
  90 test-run-samples-dir - same as above, presumes that
  91 "file.dir" is "samples.temp.dir".
  92
  93
  94 Logging
  95 ------------------------------------------------------------
  96
  97 Calls to some of the bigger tasks are automatically logged
  98 in the "log.dir" directory.
  99
 100 mjc2wsl-samples is logged in "mjc2wsl-TIMESTAMP.txt". the
 101 last run is always copied to "mjc2wsl.txt" (property
 102 "log.file.mjc2wsl")
 103
 104 wsl-transf-samples is logged in
 105 "transformations-TIMESTAMP.txt". The last run is always
 106 copied to "transformations.txt" (property
 107 "log.file.transformations")