.SD;.FLAGS CAPITALIZE
.TITLE SETSEQ - SEQUENCE DEFINITION ROUTINE
.PAGE
.INDENT 50
SETSEQ
.SKIP 1
.CENTER
SETSEQ - SEQUENCE DEFINITION ROUTINE
.LEFT MARGIN 10
.SKIP 1
.INDENT -10
^^ROUTINE NAME: SETSEQ\\
.SKIP 1
.INDENT -10
^^PURPOSE:\\ <SETSEQ IS PART OF A GROUP OF ROUTINES FOR PARSING A SPECIAL KIND OF INPUT DATA,
CALLED SEQUENCE DEFINITONS.  ^SEQUENCE DIFINITIONS ALLOW A DATA ENTRY OPERATOR
TO AVOID TYPING REPETATIVE OF SEQUENTIAL DATA WHEN THE DATA IS GOING TO BE PARSED
BY THESE SEQUENCE ROUTINES.  ^SETSEQ IS THE ROUTINE THAT INITIALIZES PROCESSING
OF A STRING.  ^TO GET SUCCESSIVE TOKENS FROM THE SEQUENCE, SEE THE <NXTSEQ
ROUTINE.
.SKIP 1
.INDENT -10
^^CALLABLE:\\ FROM ^^FORTRAN--
.CENTER; CALL SETSEQ(TABLE,MAX,STRING,LEN,WIDTH,ERR)
.SKIP 1
.INDENT -10
^^PARAMETERS:\\ 
.SKIP;.INDENT -9
^^TABLE---T\\HE BUFFER SPACE TO STORE THE PARAMETERS OF THE SEQUENCE
DEFINED BY <STRING.  ^<TABLE SHOULD BE DIMENSIONED TO AT LEAST TWICE THE SIZE IN BYTES OF THE LONGEST
STRING YOU PLAN TO PROCESS.
.SK;.I -9
^^MAX------T\\HE SIZE OF ^^TABLE\\ IN ^BYTES.
.SKIP;.INDENT -9
^^STRING---T\\HE SEQUENCE DEFINITION ARRAY.  ^THE SYNTAX FOR
A SEQUENCE IS AS FOLLOWS:
.SKIP;.INDENT -5
[^N*](_<STRING>) ^WHERE ^N IS THE NUMBER OF TIMES
TO REPEAT THE SEQUENCE OF TOKENS IN <_<STRING>. 
E.G., 3*(^A>1^A) WILL GENERATE THE SEQUENCE ^^A,B,C...Z,1A
THREE TIMES.
.SKIP;.INDENT -5
<[^N@](_<STRING>)\\  ^WHERE ^N IS THE NUMBER OF TIMES TO REPEAT EACH
TOKEN IN <_<STRING>.  E.G., 3@(^^A>1A)\\ WILL GENERATE THE
SEQUEN CE ^^A,A,A,B,B,B,C,C,C...Z,Z,Z,1A,1A,1A.\\
^NOTE THAT THE PARENS ARE MANDATORY EVEN IN SIMPLE CASES LIKE 3*(^A) OR 4@(^B).
.SKIP;.INDENT -5
^^TOKEN>TOKEN2.\\  ^THE '>' IS THE 'THROUGH' COMMAND.
^IT RETURNS ^^TOKEN1\\ THE 1ST CALL TO ^^NXTSEQ\\ THEN THE
SUCESSOR OF EACH PREVIOUS ^^TOKEN\\ UNTIL IT HAS RETURNED
TOKEN 2.  NOTE THAT NO CHECKING IS DONE TO ASSURE THAT ^^TOKEN
\\IS GREATER THAN TOKEN 2.
.SKIP;.INDENT -5
<_<^^TOKEN>_<SEPARATOR>_<TOKEN>_<SEPARATOR>_<TOKEN> W\\HERE
SEPARATOR IS SPACE, COMMA, OR TAB. 
AN EXAMPLE OF A MORE COMPLEX SEQUENCE IS:
5*((0^A1>^^OB9), 3@(AB,GG), 3*(QUALITY-CONT))\\
.SKIP;.INDENT -9
.SK;.I -5
^^BLANK TOKEN\\--- ^SINCE SPACES ARE TREATED AS SEPERATORS THIS CONVENTION WAS
NECESSARY TO RETURN A <BLANK TOKEN (<B-L-A-N-K) FROM <NXTSEQ.
.SK;.I -9
^^LEN------L\\ENGTH OF STRING IN BYTES.
.SKIP;.INDENT -9
^^WIDTH----T\\HE # OF BYTES IN AN ELEMENT WITHIN THE STRING. ^DEFAULT IS 8 BYTES,
NOTE THAT THIS PARAMETER DETERMINES THE SIZE OF THE STRINGS RETURNED BY
<NXTSEQ, AND THEREBY DETERMINES THE MAXIMUM SIZE OF ANY TOKEN. TOKENS WIDER THAN
WIDTH HAVE THEIR LEFT MOST BYTES DISCARDED UNTIL THEY FIT.
.SKIP;.INDENT -9
^^ERR------.TRUE.  R\\ETURNED FOR AN ERROR CONDITION..^^FALSE. W\\HEN NO ERROR.
.SKIP 1
.INDENT -10
^^AUTHOR:\\ ^MIKE ^HIGGINS ^^CETUS\\ ^CORP.
.SKIP 1
.INDENT -10
^^WRITTEN:\\ ^JUNE 1977
.SKIP 1
.INDENT -10
^^SOURCE LANGUAGE:\\ ^^SUPERMAC
.SKIP 1
.INDENT -10
^^OBJECT MODULE NAME:\\ ^^SETSEQ
.SKIP 1
.INDENT -10
^^LIBRARY:\\ ^^DP:[60,60]CETUS
.SKIP 1
.INDENT -10
^^LAST MODIFICATION:\\ NONE
.SKIP 1
.INDENT -10
^^MAINTENANCE:\\ ^SEE ^MIKE ^HIGGINS OR ^JACK ^MARTINELLI
.SKIP 1
.INDENT -10