I've enclosed two workspaces. arg_parser.apl is a library to parse
command line arguments. arg_parser_script.apl is a workspace to test
that workspace. To run the test, place both files in ~/wslib1, chmod
775 wslib1/arg_parser_script.apl and then execute
wslib1/arg_parser_script.apl -- --first=Bill --third=Daly .
I tried moving the -- from the command line to line one of the script
with this result
dalyw@verdun:~$ wslib1/arg_parser_script.apl --first=Bill --third=Daly
DUMPED 2022-07-26 16:36:05 (GMT-4)
NEW )COPY_ONCE workspace: 1 utl
DUMPED 2022-07-26 16:36:05 (GMT-4)
NEW )COPY_ONCE workspace: 1 lex
DUMPED 2022-07-26 16:36:05 (GMT-4)
This workspaces test the arg_parser workspace. Function test_one sets
up a parser object that expects arguments for --first --second and
--third and will dispaly the values of those arguments on the command
line.
The command line must contain an argument '--' which acts as a
delimter between the command line arguments passed to apl and those
passed to this script. So a test run might be:
arg_parser_script -- --first=last --third=first
SYNTAX ERROR, wslib1/arg_parser_script.apl SHOULD BEGIN WITH --
w
#! apl --script
⍝ ********************************************************************
⍝ <one line to give the program's name and a brief idea of what it does.>
⍝ Copyright (C) <year> <name of author>
⍝ This program is free software: you can redistribute it and/or modify
⍝ it under the terms of the GNU General Public License as published by
⍝ the Free Software Foundation, either version 3 of the License, or
⍝ (at your option) any later version.
⍝ This program is distributed in the hope that it will be useful,
⍝ but WITHOUT ANY WARRANTY; without even the implied warranty of
⍝ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
⍝ GNU General Public License for more details.
⍝ You should have received a copy of the GNU General Public License
⍝ along with this program. If not, see <http://www.gnu.org/licenses/>.
⍝ ********************************************************************
⍝ Options
⍝ ********************************************************************
⍝ Options are a lexicon of name, value, type, and help.
)copy_once 1 utl
)copy_once 1 lex
∇ opt←ap∆opt∆new arg
⍝ Function returns a new option named 1⊃arg of type 2⊃arg with,
⍝ optionally help 3⊃arg
opt←lex∆init
opt←opt lex∆assign (⊂'name'),⊂ 1⊃arg
⍎(∧/'type'=4↑2⊃arg)/'opt←opt lex∆assign ''value'' 0'
opt←opt lex∆assign (⊂'type'),⊂ 2⊃arg
opt←opt lex∆assign (⊂'help'),⊂ 3⊃3↑arg
∇
⍝ Option accessor methods
∇b←ap∆opt∆is option
⍝ Function test whether option is valid
→(~b←lex∆is option)/0
b←∧/(option lex∆haskey 'name'),(option lex∆haskey 'type')
∇
∇name←ap∆opt∆get_name opt
name←opt lex∆lookup 'name'
∇
∇b←ap∆opt∆has_help opt
b←~0=⍴opt lex∆lookup 'help'
∇
∇help←ap∆opt∆get_help opt
help←opt lex∆lookup 'help'
∇
∇new←old ap∆opt∆set_help help
new←old lex∆assign 'help' help
∇
∇b←ap∆opt∆has_value opt
b←opt lex∆haskey 'value'
∇
∇value←ap∆opt∆get_value opt
value←opt lex∆lookup 'value'
∇
∇new←old ap∆opt∆set_value value
new←old lex∆assign 'value' value
∇
∇type←ap∆opt∆get_type opt
type←opt lex∆lookup 'type'
∇
∇new←old ap∆opt∆set_type type
new←old lex∆assign 'type' type
∇
∇msg←ap∆opt∆get_help_msg opt
⍝ Function compiles a help message
msg←'--',(15↑ap∆opt∆get_name opt),ap∆opt∆get_help opt
∇
⍝ Options instance accessors
∇options←ap∆opts∆init
⍝ Functions creates an empty option list
options←lex∆init
∇
∇b←ap∆opts∆is options
b←lex∆is options
∇
∇options←old ap∆opts∆add_opt opt;name
⍝ function to add an exisitng option
name←ap∆opt∆get_name opt
options←old lex∆assign name opt
∇
∇b←options ap∆opts∆has_opt name
b←options lex∆haskey name
∇
∇opt←options ap∆opts∆get_opt name
opt←options lex∆lookup name
∇
∇options←old ap∆opts∆set_opt opt
options←old lex∆assign (⊂ap∆opt∆get_name opt),⊂opt
∇
⍝ Parser instance accessors
∇ao←ap∆init
⍝ Functions returns a new instance of parser data.
ao←lex∆init
ao←ao lex∆assign 'error' ''
ao←ao lex∆assign 'name' ''
ao←ao lex∆assign 'options' ap∆opts∆init
∇
∇instance←old ap∆set_name name
instance←old lex∆assign 'name' name
∇
∇name ←ap∆get_name instance
⍝ Function returns the parser instance's name
name←instance lex∆lookup 'name'
∇
∇options←ap∆get_options instance
options←instance lex∆lookup 'options'
∇
∇instance←old ap∆set_options options
instance←old lex∆assign 'options' options
∇
∇value←instance ap∆get_option_value name;opt
⍝ Function returns the value of an option
opt←(ap∆get_options instance) ap∆opts∆get_opt name
value←ap∆opt∆get_value opt
∇
∇b←ap∆has_errors instance
⍝ Function test to see if an error condition has been defined for
⍝ the currennt instance.
b←0≠⍴instance lex∆lookup 'error'
∇
∇errs←ap∆get_errors instance
errs←instance lex∆lookup 'error'
∇
∇b←ap∆has_help instance
⍝ Function test to see if help has been requested
b←instance lex∆haskey 'help'
∇
∇help←ap∆get_help instance
⍝ Function returns the help message
help←instance lex∆lookup 'help'
∇
∇instance←old ap∆add_error msg
⍝ Function to add an error to the current instance.
⍎(1=≡msg)/'msg←⊂msg'
instance←old lex∆assign (⊂'error'),⊂ msg,old lex∆lookup 'error'
∇
∇instance←old ap∆add_option option;options;name
⍝ Add on option to the parser instance's list
options←ap∆get_options old
options←options ap∆opts∆add_opt option
instance←old ap∆set_options options
∇
∇b←instance ap∆has_option name;options
⍝ Function test whether the parser instance has an option
b←(ap∆get_options instance) ap∆opts∆has_opt name
∇
∇instance←old ap∆new_option args;options;name
⍝ Function to add a new option. Args may either be an option, or an alist.
instance←old
options←ap∆get_options instance
⍝ Option test
→(ap∆opt∆is args)/l1
⍎(0≠2|⍴args←,args)/'instance←instance ap∆add_error ''OPTION LIST IS
INCOMPLETE''◊→0'
l1:
→(ap∆opt∆is args←lex∆from_alist args)/l2
instance←instance ap∆add_error 'SUPPLIED ATTRIBUTES ARE ',(' ' utl∆join
lex∆keys args),' name, type, AND value ARE REQUIRED.'
→0
l2:
⍎('boolean' utl∆stringEquals args lex∆lookup 'type')/'args←args lex∆assign
''value'' 0'
instance←instance ap∆add_option args
→0
∇
∇instance←cmds ap∆parse old;options;ct
⍝ Function to parse the command line and set the options values."
⍎(0=⎕nc'cmds')/'cmds←⎕arg'
ct←cmds utl∆listSearch '--'
instance←old ap∆set_name (ct-1)⊃cmds
cmds←ct↓cmds ⍝ Drop inerpretor commands
options←(ap∆get_options old) ap∆next_option cmds
→(0=1↑⍴options)/0
instance←instance ap∆set_options options
→(options ap∆opts∆has_opt 'error')/errs
→(options ap∆opts∆has_opt 'help')/help
→0
errs:
instance←instance lex∆assign (⊂'error'),⊂ options ap∆opts∆get_opt 'error'
→0
help:
instance←instance lex∆assign (⊂'help'),⊂ap∆help instance
→0
∇
∇options←old ap∆next_option args;name;value;opt
⍝ Function recursively updates options from the command line.
options←old
→(0=⍴args)/0
options←options ap∆next_option 1↓args
→(∧/'--'=2↑1⊃args)/syn_good
options←options ap∆add_error 'SYNTAX ERROR, ',(1⊃args),' SHOULD BEGIN WITH --'
→0
syn_good:
name←(~∧\'-'=name)/name←1⊃args
name←'=' utl∆split name
→(∧/'help'=4↑1⊃name)/help
→(1=⍴name)/single
double:
value←2⊃name
name←1⊃name
→(options ap∆opts∆has_opt name)/db2
options←options ap∆add_error 'SYNTAX ERROR, ',name,' NOT A VALID OPTION.'
→0
db2:
opt←options ap∆opts∆get_opt name
→(∧/'string'=6↑ ap∆opt∆get_type options ap∆opts∆get_opt name)/db3
options←options ap∆add_error 'SYNTAX ERROR, ',name,' SHOULD NOT HAVE A VALUE.'
→0
db3:
opt←opt ap∆opt∆set_value value
options←options ap∆opts∆set_opt opt
→0
single:
name←,⊃name
→(options ap∆opts∆has_opt name)/s2
options←options ap∆add_error 'SYNTAX ERROR, ',name,' IS NOT A VALID OPTION.'
→0
s2:
opt←options ap∆opts∆get_opt name
opt←opt ap∆opt∆set_value 1
options←options ap∆opts∆set_opt opt
→0
help:
options←options ap∆opts∆set_opt ap∆opt∆new 'help' 'string'
→0
∇
∇ msg←ap∆help instance;lb;ix;opts;opt;names;name
⍝ Functions extracts the help message for each option and compiles a
⍝ short report
opts←ap∆get_options instance
names←lex∆keys opts
msg←'Usage: ',(ap∆get_name instance),' -- [options]',⎕av[11 11]
lb←((1↑⍴opts)⍴st),ed
ix←1
st:
opt←opts lex∆lookup name←ix⊃names
→(('help' utl∆stringEquals name)∨'error' utl∆stringEquals name)/lp
msg←msg,⎕av[10],(ap∆opt∆get_help_msg opt),⎕av[11]
lp:
→lb[ix←ix+1]
ed:
→0
∇
∇Z←ap⍙metadata
Z←0 2⍴⍬
Z←Z⍪'Author' 'Bill Daly'
Z←Z⍪'BugEmail' 'b...@dalywebandedit.com'
Z←Z⍪'Documentation' 'doc/apl-library.info'
Z←Z⍪'Download'
'https://sourceforge.net/p/apl-library/code/ci/master/tree/arg_parser.apl'
Z←Z⍪'License' 'GPL v3.0'
Z←Z⍪'Portability' 'L3'
Z←Z⍪'Provides' ''
Z←Z⍪'Requires' 'lex,utl'
Z←Z⍪'Version' '0 0 2'
Z←Z⍪'Last update' '2019-06-30'
Z←Z⍪'WSID' 'arg_parser.apl'
∇
#! /usr/local/bin/apl --script
⍝ ********************************************************************
⍝ arg_parser_test.apl Script to test arg_parser
⍝ Copyright (C) 2019 Bill Daly
⍝ This program is free software: you can redistribute it and/or modify
⍝ it under the terms of the GNU General Public License as published by
⍝ the Free Software Foundation, either version 3 of the License, or
⍝ (at your option) any later version.
⍝ This program is distributed in the hope that it will be useful,
⍝ but WITHOUT ANY WARRANTY; without even the implied warranty of
⍝ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
⍝ GNU General Public License for more details.
⍝ You should have received a copy of the GNU General Public License
⍝ along with this program. If not, see <http://www.gnu.org/licenses/>.
⍝ ********************************************************************
)load 1 arg_parser
⍞←⊃ABOUT ←⎕inp 'EOM'
This workspaces test the arg_parser workspace. Function test_one sets
up a parser object that expects arguments for --first --second and
--third and will dispaly the values of those arguments on the command
line.
The command line must contain an argument '--' which acts as a
delimter between the command line arguments passed to apl and those
passed to this script. So a test run might be:
arg_parser_script -- --first=last --third=first
EOM
∇test_one;args;opts;keys
args←ap∆init
args←args ap∆new_option 'name' 'first' 'type' 'string' 'help' 'The first
thing we must do'
args←args ap∆new_option 'name' 'second' 'type' 'boolean' 'help' 'Do we do the
second thing'
args←args ap∆new_option 'name' 'third' 'type' 'string' 'help' 'The third
thing to do.'
args←ap∆parse args
try_errors:
→(~ap∆has_errors args)/try_help
⍞←⎕tc[3] utl∆join ap∆get_errors args
→0
try_help:
→(~ap∆has_help args)/show_result
⍞←ap∆get_help args
→0
show_result:
opts←ap∆get_options args
⍞←⎕tc[3],test_result args
⍞←'Script name: ',ap∆get_name args
∇
∇msg←test_result args;opts;names;opt;ix;lb
⍝ Function displays option values
opts←ap∆get_options args
names←lex∆keys opts
msg←⍬
lb←((⍴names)⍴st),ed
ix←1
st:
→('error' utl∆stringEquals ix⊃names)/lp
msg←msg, ((ix⊃names),⎕av[10],args ap∆get_option_value ix⊃names),⎕av[11]
lp:
→lb[ix←ix+1]
ed:
→0
∇
⍝ ∇args←test_two
⍝ args←ap∆init
⍝ args←args ap∆new_option 'name' 'first' 'type' 'string' 'help' 'The first
thing we must do'
⍝ args←args ap∆new_option 'name' 'second' 'type' 'boolean' 'help' 'Do we do
the second thing'
⍝ args←args ap∆new_option 'name' 'third' 'type' 'string' 'help' 'The third
thing to do.'
⍝ ∇
test_one
)off
