MASMTidy 1.1 build: 9470 released: 2011-01-05

Tidies MASM assembler source, aligning it in four columns.

Copyright: (c) 2012 Canadian Mind Products.

Java application.
Download from: http://mindprod.com/products1.html#MASMTIDY

===> Free <===
Full source included.
You may even include the source code, modified or unmodified
in free/commercial open source/proprietary programs that you write and distribute.
May be used freely for any purpose but military.
For more details on this restriction, see
http://mindprod.com/contact/nonmil.html
If you include any Canadian Mind Products code in your own applications,
your app too must be labeled non-military use only.
All Java jars and source code are included.

----

Prerequisites:

This program runs under any OS,
(e.g. Win2K/XP/Vista/W7x86/W7-64/OSX/Linux/Solaris/AIX...) so long as you have
<><> Java version 1.6 <><> or later installed (32-bit or 64-bit Java).
See http://mindprod.com/jgloss/installingjava.html for details.

----

Installing on a PC:

Download source and compiled class files to run on your own machine as an application.
First install a recent Java JDK or JVM.
See http://mindprod.com/jgloss/installingjava.html.
To install, extract the zip download with WinZip
(or similar unzip utility) into any directory you please,
often J:\ --  ticking off the "use folder names" option.
To run as an application,type:
java -ea -jar J:\com\mindprod\masmtidy\masmtidy.jar {put any parms here}

adjusting as necessary to account for where the jar file is.

----

Installing on a MacIntosh:

Use Safari to download source and compiled class files to run on your own machine as an application.
Safari will automatically unpack the zip into ~/Downloads (version 10.5)
[or on the Desktop (version 10.4 and earlier)].
First install a recent Java JDK or JVM.
See http://mindprod.com/jgloss/installingjava.html.
You may optionally move the download tree to a permanent home.
I don't have a MacIntosh, just a PC, so I can't test my Java programs for Mac compatibility.
In theory they should work without problems, but in practice that does not always happen.
If you have problems please, let me know, preferably with screenshots and complete verbatim error messages.
To run as an application, without parameters, just double click the jar file.

To run as an application with parameters, in bash shell type:
open Terminal.app
cd ~/Desktop
java -ea -jar com/mindprod/masmtidy/masmtidy.jar {put any parms here}

adjusting as necessary to account for where the jar file is.

----

Rebuilding:

The zip already contains the necessary class and jar files, so unless you modify
the program, there is no need to recompile the source or rebuild the jar.
Configure.java basedir="E:/" in rebuild.xml to the drive where your files are.
Use ANT and rebuild.xml, not build.xml, to recompile and recreate the jar.

----

Use:

MASMTidy tidies MASM *.asm assembler source, aligning it in four columns.

It also converts all your operators to lower case.  It does not reorder
the code in any way or insert or remove anything.

It handles single line comments, tail comments and comment | style
comments.

To convert a single program, type:

  java -jar C:\com\mindprod\masmtidy\masmtidy.jar myprogram.asm

The results replace the old file, so you had better make a
backup just in case this is not what you want.

You can also list several files on the command line:

  java -jar C:\com\mindprod\masmtidy\masmtidy.jar myprogram.asm C:\mydir\another.asm

To use convert the current directory of asm files:

  java -jar C:\com\mindprod\masmtidy\masmtidy.jar .

Sorry no wildcards, or negative wildcards, just . , and ..

DON'T USE WILDCARDS unless you deeply understand how they
work. See http://mindprod.com/jgloss/wildcard.html. Windows
expands them, not MASMTidy, and feeds them to MASMTidy (or any other program)
as a giant list of all the directories and files in the
current directory. MASMTidy will thus tend  process all the files
in your directories, when you just meant to process the files in
the current directory.

The -s switch makes all subsequent directories searched
recursively to include all their subdirectories.

e.g.

  java -jar C:\com\mindprod\masmtidy\masmtidy.jar -s E:\com

will fix all *.asm files in the E:\com directory tree,
ignoring other types of files.

The -q option switch suppresses output. Without it, you see
a list of the files it changed.

If you have the jar extension set up as executable, you can
abbreviate:

  C:\com\mindprod\masmtidy\masmtidy.jar .

CONFIGURING

You can change the column widths and suppress conversion of operators to
lower case by modifying the constants in MASMSTate.java and recompiliing.
Here is how they default:

   /**
     * configure false to allow mixed case operators in second column.
     */
    private static final boolean LOWER_CASE_OPERATORS = true;

    /**
     * configure 0-based column for the third operand column
     */
    private static final int COL_FOR_OPERAND = 25;

    /**
     * configure 0-based column for the second operator column
     */
    private static final int COL_FOR_OPERATOR = 15;

    /**
     * configure 0-based column for the fourth commend column
     */
    private static final int COL_FOR_TAIL_COMMENT = 40;


----

Version History:

 1.0 2011-01-01 initial version

 1.1 2011-01-05 remove excess blank lines

-30-