SortSRS 1.4 build: 9470 released: 2011-11-16

Sorts/DeDups Funduc Search/Replace *.srs Scripts.

Copyright: (c) 2012 Canadian Mind Products.

Java application.
Download from: http://mindprod.com/products2.html#SORTSRS

===> 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.5 <><> 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\sortsrs\sortsrs.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/sortsrs/sortsrs.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:

SortSRS is a fairly esoteric utility.  It is an add-on for Funduc 
Search-Replace.  It tidies *.srs script files by sorting, deduping and 
general tidying.  It is only of use to users of the Funduc SR bulk Search 
Replace Utility.  

It is only of use to users of the Funduc SR bulk Search Replace Utility.  

Be careful.  Sorting a script may it behave differently since SR 
applies the search/replaces in the same order they appear in the *.srs 
script file.  Make a backup before using SortSRS in case sorting makes the 
script stop working.  

It sorts the search/replace pairs by search string, using a 
case-insensitive sort, i.e.  interleaving upper and lower case.  It also 
sorts and deDups the path items.  

To convert a script file, type:

  java -jar C:\com\mindprod\sortsrs\sortsrs.jar myscript.srs

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\sortsrs\sortsrs.jar my.srs C:\myscripts\another.srs

DON'T USE WILDCARDS unless you deeply understand how they work.  Windows 
expands them, not sortsrs, and feeds them to sortsrs (or any other 
program) as a giant list of all the directories and files in the current 
directory.  Sortsrs will thus tend process all the files in your 
directories, when you just meant to process the files in the current 
directory.  Read up on wildcard in the mindprod.com wildcard entry in the 
Java glossary.  

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

e.g.

  java -jar C:\com\mindprod\sortsrs\sortsrs.jar -s E:\env\srscripts

will fix all *.srs files in the E:\env\srscripts directory tree, ignoring 
other types of files.  

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

  C:\com\mindprod\sortsrs\sortsrs.jar .     
   
If you have Jet, that abbreviates even further to
 
  sortsrs.exe .
  
You can strip out comments from the scripts with:

  java -jar C:\com\mindprod\sortsrs\sortsrs.jar -strip -s E:\env\srscripts

  
Favourites are just mini-scripts containing a single search/replace pair, 
also stored as *.srs files, but stored in a different directory.  If you 
run SortSRS on them, it won't do any harm, and it won't do any good 
either.  Since the contain only one item, they are already sorted.  
However SortSRS will replace missing lead BOMs, an indicator the file is 
UTF-8 encoded even on favourites.  

If this utility is of use to you, possibly the CSVToSRS utility part of 
the mindprod.com CSV suite may also be of interest.  

Beware!  If you edit *.srs scripts outside of Funduc Search/Replace, or if 
you generate them programmatically, and you introduce syntax errors, 
e.g.  two [Replace] in a row, when you feed them to SR, it will just crash 
without any error message.  If you are experimenting, keeps lots of 
backups and intermediate backups, so you can compare working and 
non-working scripts to see the differences.  

I wrote this program without documentation of the SRS file format.  I just 
guessed at it by examining examples and doing experiments.  I have 
overlooked something, and my program will not handle that feature 
correctly.  If you suspect something like that has happened, please email 
me the offending script so I can fix immediately fix it.  



----

Version History:

 1.0 2011-11-11 initial version

 1.1 2011-11-12 more checks for damaged scripts. fix bug that dropped the first [search]

 1.2 2011-11-12 deal with scripts that contain [Search or [Replace as literal data, and two types of dup.

 1.3 2011-11-14 major refactoring. Sort Paths as well and search/replace items. Handle comments.

 1.4 2011-11-16 fix bug when ] in comment. add -strip option

-30-