749 posts
BOO!!
Posted 30 November 2016 - 03:11 PM
GetOpts, a linux-styled argument parser
*Updated. The old version is depreciated, and will soon be removed.
MORE PLANNED UPDATES:
APIS:
What has changed?
Initializing a struct without the autoGenItems flag will not contain help and -%. Re-initializing the parser.opts table will also remove these.
With just the following code:
You will have a working parser-based program.
APIS:
*Updated. The old version is depreciated, and will soon be removed.
MORE PLANNED UPDATES:
- Add substitution of a table of arg sets for the number of args.
- Test function for itable reversion
- Add more itable management functions
pastebin get PSFnwfPp getOptsExample Program
local getOpts = loadfile('getOpts')()
local struct = getOpts.newStruct(true)
struct:setHeader('Line printer. A getOpts example.')
struct:add('-nl', '--newLine', 'Creates new line', function() print() end, 0)
struct:addM('-e', 'anon', 'Enables progam', function() end, 0)
struct:add(nil, '--text', 'Sets the text to print.',
function(args, parser)
args = parser.functions.toITable(args) --The toITable function can also be called as getOpts.toITable
if not (#args > 0) then
error('Required <text>')
getOpts.help(parser)
return
end
for k, v in ipairs(args) do
write(v.." ")
end
end
, nil, "<text>")
struct:add('-st', '--simpletext', 'Prints one word.',
function(args, parser)
args = parser.functions.toITable(args) --The toITable function can also be called as getOpts.toITable
if not args[1] then
error('Required <text>')
getOpts.help(parser)
return
end
write(args[1])
end
, 1, "<text>")
local left = getOpts.parse(struct, {...}, true)
if not left then return end
print()
print('Leftover args:')
for k, v in pairs(getOpts.toITable(left)) do print(v) endpastebin get PSFnwfPp getOpts
pastebin get kLNpFQj4 test
test
test -e
test --text hi
test -e -h
test -e --text not escaped -% escaped!
test -e --text --aflag
test -e --text %--naddaflag
test Even Returns Leftovers! -e
test -e -st Specify Max # of args (optional)
Try playing around with itAPIS:
[object parserObject]
:add(aliases, fullname, help, runFunc, maxArgs or nil, usage) --runFunc is a function with args [args [, [object parserObject]]]
:addM([same args as :add]) --Same as add, but creates mandatory args
:setHeader(head) --Creates the help header
.opts --a table with more tables, stores flag info
.functions --Only available in flags
.escape(escapepoint) --Escaping. If a number is provided, anything >= that number will be escaped. If a table is provided, those specific arguments are escaped.
.toITable() --Removes gaps from tables
.getFlagPos() --Untested, returns pos of current flag
loadfile('getOpts', _G)()
.getArgs(string) returns table --A tokeniser
.toITable(table) --removes gaps from table
.help(struct.opts, struct.header) --Prints help screen
.parse(struct, args) returns table --Returns left over args, this is the main function
.newStruct(autoGenItems) returns [object parserObject]
What has changed?
- Items can now be called multiple times
- New functions
- Reversed args for the function used for :add func argument, now args, parser instead of parser, args
- Now run in chronological order
- You can figure out which numbered item from the original table args were. The indices on the argument tables contain gaps.
- Added anon functions. The -% flag is now an anon function and is no longer hard-coded in
- added usage arg to :add
Initializing a struct without the autoGenItems flag will not contain help and -%. Re-initializing the parser.opts table will also remove these.
Old post
GetOpts, a table parser
pastebin get UHDHsbx2 getOpts
With just the following code:
local getOpts = loadfile('getOpts')()
local struct = getOpts.newStruct(true)
struct:setHeader('Line printer. A getOpts example.')
struct:add('-nl', '--newLine', 'No args. Creates new line', function() print() end, 0)
struct:addM(nil, '--text', '<text>. Sets the text to print.', function(parser, args) if not args[1] then printError('Required <text>') fHelp(parser) return end for k, v in pairs(args) do write(v.." ") end end)
local left = parse(struct, {...})
if not left then return end
print()
print('Leftover args:')
for k, v in pairs(left) do print(v) end
<progSaveLoc> --text testText
<progSaveLoc> --text text -nl
<progSaveLoc>
<progSaveLoc> -nl
<progSaveLoc> --newLine --text newLine!! Yay!
<progSaveLoc> Leftover Arguments --text Leftovers!
<progSaveLoc> --text escaping example A -% ESCAPED!
<progSaveLoc> %% %--escaping %-e --text Escaping Example B
<progSaveLoc> -h --text some text
You will have a working parser-based program.
APIS:
loadfile('getOpts', _G)()
.getArgs(string) returns table --A tokeniser
.help(struct.opts, struct.header) --Prints help screen
.parse(struct, args) returns table --Returns left over args, this is the main function
.newStruct(autoGenHelp) returns table
:add(aliases, fullname, help, runFunc, maxArgs or nil)
:addM([same args as :add]) --Same as add, but creates mandatory args
:setHeader(head) --Creates the help header
Edited on 19 December 2017 - 02:05 PM
