Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improved CmdLine help message formatting #1054

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Improved CmdLine help message formatting #1054

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 38 additions & 2 deletions CmdLine.lua
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,35 @@ local function pad(str, sz)
return str .. string.rep(' ', sz-#str)
end

--[[
This function takes a string, and inserts newlines wherever it exceeds a
the given block_sz. It also pads each new line with pre_pad number of
spaces.
--]]
local function block_txt(str, pre_pad, block_sz)
local ret_str = ""
local txt_width = block_sz - pre_pad
local start_i = 0
local end_i = 0

while end_i and str do
-- start search for text ahead of previous last position
start_i = end_i + 1
-- newline if the string already has text
if #ret_str > 0 then
ret_str = ret_str .. "\n" .. string.rep(' ', pre_pad)
end
-- find the first non-space character
local start_i = string.find(str, "[^%s]", start_i)
if not start_i then break end
-- find the first space character after allowed width is run over
end_i = string.find(str, "%s", start_i + txt_width - 1)
ret_str = ret_str .. string.sub(str, start_i, end_i)
end

return ret_str
end

function CmdLine:error(msg)
print('')
io.stderr:write(msg)
Expand Down Expand Up @@ -249,17 +278,24 @@ function CmdLine:help(arg)
end
end

-- set the allowable width of each option help
local opt_str_width = 80
if optsz > 70 then
opt_str_width = optsz + 30
end

-- second pass to print
for _,option in ipairs(self.helplines) do
if type(option) == 'table' then
io.write(' ')
local opt_help = block_txt(option.help, optsz+3, opt_str_width)
if option.default ~= nil then -- it is an option
io.write(pad(option.key, optsz))
if option.help then io.write(' ' .. option.help) end
if option.help then io.write(' ' .. opt_help) end
io.write(' [' .. tostring(option.default) .. ']')
else -- it is an argument
io.write(pad('<' .. strip(option.key) .. '>', optsz))
if option.help then io.write(' ' .. option.help) end
if option.help then io.write(' ' .. opt_help) end
end
else
io.write(option) -- just some additional help
Expand Down