kbbF77tricks.html KBB F77 Tricks library

KBB F77 Tricks library

Dr. K.B.Beard

15 October 2001
Center for Advanced Studies of Accelerators
Thomas Jefferson National Accelerator Facility

This is just a collection of the author's handy F77 string manipulation routines which are not machine dependent. Many are for use with the "Q" formalism (see below).

Unless otherwise stated, all integers are INTEGER*4, all real are REAL*4, and all character strings (string, InPut, OUTPUT, line, Cx, old, new) declared as CHARACTER*(*), and all logicals as LOGICAL*4 (ok). Inputs are in green, outputs in red, and both are in orange.

VERSION:

SUBROUTINE tricks_version(string) - return this library version and date

DEBUGGING:

SUBROUTINE kb_if_namebug( here, OfInterest ) - return whether descriptions within HERE match those set in kbb_set_namebug

SUBROUTINE kb_set_namebug( list, Ok, err ) - sets descriptions for use with kb_if_namebug, returns success or failure and why

STRING MANIPULATION:

INTEGER FUNCTION important_length(string) - replaces all nulls & tabs with spaces, removes leading and redundant spaces, returns the last nonblank character or "1" if the string is blank

LOGICAL FUNCTION match(test, pattern) - require all of "test" match "pattern", require at least up to "*", ignore ":" or "=" onward

LOGICAL FUNCTION stringmatch(test, pattern) - require all of "test" match "pattern" (with * and % wildcards)

SUBROUTINE UP_case(string) - change lower case letters to upper.

SUBROUTINE UP_shift(string) - change lower case to upper, replace nulls&tabs with spaces

SUBROUTINE NO_backslash(string) - replace all "\" characters with blanks

SUBROUTINE NO_Comments(string) - remove comments

SUBROUTINE NO_control(string) - replace all characters outside " " to "~" with blanks

SUBROUTINE NO_leading_blanks(string) - remove leading blanks

SUBROUTINE NO_nulls(string) - replace nulls with blanks

SUBROUTINE NO_unquoted_blanks(string) - remove all blanks not in "quotes"

SUBROUTINE null_end(string) - replace trailing whitespace with nulls

SUBROUTINE nullterminate(string) - insert null after last important character

SUBROUTINE blankterminate(string) - insert blanks from 1st null character onward

SUBROUTINE only_one_blank(string) - remove all redundant blanks

SUBROUTINE strip_comment_field(string) - remove comments (except those in parenthesis)

SUBROUTINE unquoted_NO_Comments(string) - remove unquoted comments

SUBROUTINE NO_blanks(string) - remove all blanks

SUBROUTINE squeeze(string,nonblank) - remove all blanks, return nonblank length

SUBROUTINE ShiftAll(InPut, OUTPUT) - copy input to output and shift to upper case

SUBROUTINE ShiftAll_unquoted(InPut, OUTPUT) - similar, but doesn't shift "quoted"

SUBROUTINE real_data_row(string) - prepare data for scan (ex:"1 2.3"->"1,2.3,,,,")

SUBROUTINE rep_err(good, string) - if LOGICAL*2 good=.FALSE., output string

SUBROUTINE sub_string(string, old, new) - substitue "new" for "old" in string

Q FORMAT INTERFACE

c+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
c
c		....Q interface style....
c
c	The LAMPF-Q acquisition system uses line oriented commands with
c  the style:   
c		field1/option1:data1:data2/option2 field2/option3....
c	or	@filename.ext
c	ex:       TRIG/info:[qBeard]TRIG.DAT/help /test
c		  @scratch1:[Beard.demo]DEMO1.com
c
c	These routines handle command files "@file.ext" which can in turn
c  contain other command files ("@next.ext") to a depth of 10 layers.
c  The INCLUDE file allows communication with special options within the
c  routines.  Codes using these routines are PSEUDOQ and CAMAC_CHAT.
c  Typical use:
c
c	call Qcommand('WHAT',inst,Nfld,fld,Nopt,opt,key,ret,kill)
c	Do k=1,Nopt
c	  call parse_i4_option(opt(k),op,kind,value,string)
c	  if(op.eq.'HE') then
c	    ............
c	  endif
c	EndDo
c
c+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++

Usually, only Qcommand and parse_i4_option are commonly called by the user.

SUBROUTINE Qcommand( prmpt, inst, Nfld, fld, Nopt, opt, key, ret, kill) - - provides a prompt "prmpt>", and given an input line "inst" (possibly including a file to read with @file, which possibly contains references to other files to a maximum depth of 10), parses it into INTEGER Nfld and Nopt, CHARACTER*(*) fld(*) and opt(*), and LOGICAL key, ret, and kill which indicate respectively keyboard input, return at end-of-file, and abort.

SUBROUTINE parse_i4_option( option, opt, kind, value, string) - from option, gets CHARACTER*(*) opt, the kind (or number) of values, the INTEGER*4 value(*) or string following opt (ex: option="opt:ok" or "opt:1:2:5")

SUBROUTINE parse_i2_option( option, opt, kind, value, string) - from option, gets CHARACTER*(*) opt, the kind (or number) of values, the INTEGER*2 value(*) or string following opt (ex: option="opt:ok" or "opt:1:2:5")