|
|
|
|
@ -137,11 +137,31 @@ tcl::namespace::eval textblock {
|
|
|
|
|
return " -choices \{$choices\} -help {algorithm choice $choicemsg} " |
|
|
|
|
} |
|
|
|
|
} |
|
|
|
|
namespace eval argdoc { |
|
|
|
|
tcl::namespace::import ::punk::ansi::a+ |
|
|
|
|
# -- --- --- --- --- |
|
|
|
|
#non colour SGR codes |
|
|
|
|
# we can use these directly via ${$I} etc without marking a definition with @dynamic |
|
|
|
|
#This is because they don't need to change when colour switched on and off. |
|
|
|
|
set I [a+ italic] |
|
|
|
|
set NI [a+ noitalic] |
|
|
|
|
set B [a+ bold] |
|
|
|
|
set N [a+ normal] |
|
|
|
|
# -- --- --- --- --- |
|
|
|
|
proc example {str} { |
|
|
|
|
set str [string trimleft $str \n] |
|
|
|
|
set block [punk::ansi::ansiwrap Web-gray [textblock::frame -ansibase [a+ Web-gray bold white] -ansiborder [a+ black White] -boxlimits {hl} -type block $str]] |
|
|
|
|
set result [textblock::bookend_lines $block [a] "[a defaultbg] [a]"] |
|
|
|
|
#puts $result |
|
|
|
|
return $result |
|
|
|
|
} |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
# hash_algorithm -optional 1 -choices {${[::textblock::argdoc::hash_algorithm_choices]}} -help\ |
|
|
|
|
# "algorithm choice" |
|
|
|
|
namespace eval argdoc { |
|
|
|
|
set DYN_HASH_ALGORITHM_CHOICES_AND_HELP {$[::textblock::argdoc::hash_algorithm_choices_and_help]} |
|
|
|
|
set DYN_HASH_ALGORITHM_CHOICES_AND_HELP {${[::textblock::argdoc::hash_algorithm_choices_and_help]}} |
|
|
|
|
punk::args::define { |
|
|
|
|
@dynamic |
|
|
|
|
@id -id ::textblock::use_hash |
|
|
|
|
@ -7769,75 +7789,93 @@ tcl::namespace::eval textblock {
|
|
|
|
|
# ${[textblock::frame_samples]} |
|
|
|
|
|
|
|
|
|
#todo punk::args alias for centre center etc? |
|
|
|
|
punk::args::define { |
|
|
|
|
@dynamic |
|
|
|
|
@id -id ::textblock::frame |
|
|
|
|
@cmd -name "textblock::frame"\ |
|
|
|
|
-help "Frame a block of text with a border." |
|
|
|
|
-checkargs -default 1 -type boolean\ |
|
|
|
|
-help "If true do extra argument checks and |
|
|
|
|
provide more comprehensive error info. |
|
|
|
|
As the argument parser loads around 16 default frame |
|
|
|
|
samples dynamically, this can add add up as each may |
|
|
|
|
take 10s of microseconds. For many-framed tables |
|
|
|
|
and other applications this can add up. |
|
|
|
|
Set false for performance improvement." |
|
|
|
|
-etabs -default 0\ |
|
|
|
|
-help "expanding tabs - experimental/unimplemented." |
|
|
|
|
-type -default light -choices {${[textblock::frametypes]}} -choicerestricted 0 -choicecolumns 8 -type dict\ |
|
|
|
|
-choicelabels { |
|
|
|
|
${[textblock::frame_samples]} |
|
|
|
|
}\ |
|
|
|
|
-help "Type of border for frame." |
|
|
|
|
-boxlimits -default {hl vl tlc blc trc brc} -type list -help "Limit the border box to listed elements. |
|
|
|
|
passing an empty string will result in no box, but title/subtitle will still appear if supplied. |
|
|
|
|
${[textblock::EG]}e.g: -frame -boxlimits {} -title things [a+ red White]my\\ncontent${[textblock::RST]}" |
|
|
|
|
-boxmap -default {} -type dict |
|
|
|
|
-joins -default {} -type list |
|
|
|
|
-title -default "" -type string -regexprefail {\n}\ |
|
|
|
|
-help "Frame title placed on topbar - no newlines. |
|
|
|
|
May contain ANSI - no trailing reset required. |
|
|
|
|
${[textblock::EG]}e.g 1: frame -title My[a+ green]Green[a]Thing |
|
|
|
|
e.g 2: frame -title [a+ red underline]MyThing${[textblock::RST]}" |
|
|
|
|
-titlealign -default "centre" -choices {left centre right} |
|
|
|
|
-subtitle -default "" -type string -regexprefail {\n}\ |
|
|
|
|
-help "Frame subtitle placed on bottombar - no newlines |
|
|
|
|
May contain Ansi - no trailing reset required." |
|
|
|
|
-subtitlealign -default "centre" -choices {left centre right} |
|
|
|
|
-width -default "" -type int\ |
|
|
|
|
-help "Width of resulting frame including borders. |
|
|
|
|
If omitted or empty-string, the width will be determined automatically based on content." |
|
|
|
|
-height -default "" -type int\ |
|
|
|
|
-help "Height of resulting frame including borders." |
|
|
|
|
-ansiborder -default "" -type ansistring\ |
|
|
|
|
-help "Ansi escape sequence to set border attributes. |
|
|
|
|
${[textblock::EG]}e.g 1: frame -ansiborder [a+ web-red] contents |
|
|
|
|
e.g 2: frame -ansiborder \"\\x1b\\\[31m\" contents${[textblock::RST]}" |
|
|
|
|
-ansibase -default "" -type ansistring\ |
|
|
|
|
-help "Default ANSI attributes within frame." |
|
|
|
|
-blockalign -default centre -choices {left right centre}\ |
|
|
|
|
-help "Alignment of the content block within the frame." |
|
|
|
|
-pad -default 1 -type boolean -help "Whether to pad within the ANSI so content background |
|
|
|
|
extends within the content block inside the frame. |
|
|
|
|
Has no effect if no ANSI in content." |
|
|
|
|
-textalign -default left -choices {left right centre}\ |
|
|
|
|
-help "Alignment of text within the content block. (centre unimplemented)" |
|
|
|
|
-ellipsis -default 1 -type boolean\ |
|
|
|
|
-help "Whether to show elipsis for truncated content and title/subtitle." |
|
|
|
|
-usecache -default 1 -type boolean |
|
|
|
|
-buildcache -default 1 -type boolean |
|
|
|
|
-crm_mode -default 0 -type boolean\ |
|
|
|
|
-help "Show ANSI control characters within frame contents. |
|
|
|
|
(Control Representation Mode) |
|
|
|
|
Frame width doesn't adapt and content may be truncated |
|
|
|
|
so -width may need to be manually set to display more." |
|
|
|
|
namespace eval argdoc { |
|
|
|
|
punk::args::define { |
|
|
|
|
@dynamic |
|
|
|
|
@id -id ::textblock::frame |
|
|
|
|
@cmd -name "textblock::frame"\ |
|
|
|
|
-summary "Frame a block of content with a border."\ |
|
|
|
|
-help\ |
|
|
|
|
"This command allows content to be framed with various border styles. The content can include |
|
|
|
|
other ANSI codes and unicode characters. Some predefined border types can be selected with |
|
|
|
|
the -type option and the characters can be overridden either in part or in total by supplying |
|
|
|
|
some or all entries in the -boxmap dictionary. |
|
|
|
|
The ${$B}textblock::framedef${$N} command can be used to return a dictionary for a frame type. |
|
|
|
|
Border elements can also be suppressed on chosen sides with -boxlimits. |
|
|
|
|
ANSI colours can be applied to borders or as defaults for the content using -ansiborder and |
|
|
|
|
-ansibase options. |
|
|
|
|
The punk::ansi::a+ function (aliased as a+) can be used to apply ANSI styles. |
|
|
|
|
e.g |
|
|
|
|
frame -type block -ansiborder [a+ blue Red] -ansibase [a+ black Red] \"A\\nB\"" |
|
|
|
|
-checkargs -default 1 -type boolean\ |
|
|
|
|
-help "If true do extra argument checks and |
|
|
|
|
provide more comprehensive error info. |
|
|
|
|
As the argument parser loads around 16 default frame |
|
|
|
|
samples dynamically, this can add add up as each may |
|
|
|
|
take 10s of microseconds. For many-framed tables |
|
|
|
|
and other applications this can add up. |
|
|
|
|
Set false for performance improvement." |
|
|
|
|
-etabs -default 0\ |
|
|
|
|
-help "expanding tabs - experimental/unimplemented." |
|
|
|
|
-type -default light\ |
|
|
|
|
-type dict\ |
|
|
|
|
-typesynopsis {${$I}choice${$NI}|<${$I}dict${$NI}>}\ |
|
|
|
|
-choices {${[textblock::frametypes]}}\ |
|
|
|
|
-choicerestricted 0 -choicecolumns 8\ |
|
|
|
|
-choicelabels { |
|
|
|
|
${[textblock::frame_samples]} |
|
|
|
|
}\ |
|
|
|
|
-help "Type of border for frame." |
|
|
|
|
-boxlimits -default {hl vl tlc blc trc brc} -type list -help "Limit the border box to listed elements. |
|
|
|
|
passing an empty string will result in no box, but title/subtitle will still appear if supplied. |
|
|
|
|
${[textblock::EG]}e.g: -frame -boxlimits {} -title things [a+ red White]my\\ncontent${[textblock::RST]}" |
|
|
|
|
-boxmap -default {} -type dict |
|
|
|
|
-joins -default {} -type list |
|
|
|
|
-title -default "" -type string -regexprefail {\n}\ |
|
|
|
|
-help "Frame title placed on topbar - no newlines. |
|
|
|
|
May contain ANSI - no trailing reset required. |
|
|
|
|
${[textblock::EG]}e.g 1: frame -title My[a+ green]Green[a]Thing |
|
|
|
|
e.g 2: frame -title [a+ red underline]MyThing${[textblock::RST]}" |
|
|
|
|
-titlealign -default "centre" -choices {left centre right} |
|
|
|
|
-subtitle -default "" -type string -regexprefail {\n}\ |
|
|
|
|
-help "Frame subtitle placed on bottombar - no newlines |
|
|
|
|
May contain Ansi - no trailing reset required." |
|
|
|
|
-subtitlealign -default "centre" -choices {left centre right} |
|
|
|
|
-width -default "" -type int\ |
|
|
|
|
-help "Width of resulting frame including borders. |
|
|
|
|
If omitted or empty-string, the width will be determined automatically based on content." |
|
|
|
|
-height -default "" -type int\ |
|
|
|
|
-help "Height of resulting frame including borders." |
|
|
|
|
-ansiborder -default "" -type ansistring\ |
|
|
|
|
-help "Ansi escape sequence to set border attributes. |
|
|
|
|
${[textblock::EG]}e.g 1: frame -ansiborder [a+ web-red] contents |
|
|
|
|
e.g 2: frame -ansiborder \"\\x1b\\\[31m\" contents${[textblock::RST]}" |
|
|
|
|
-ansibase -default "" -type ansistring\ |
|
|
|
|
-help "Default ANSI attributes within frame." |
|
|
|
|
-blockalign -default centre -choices {left right centre}\ |
|
|
|
|
-help "Alignment of the content block within the frame." |
|
|
|
|
-pad -default 1 -type boolean -help "Whether to pad within the ANSI so content background |
|
|
|
|
extends within the content block inside the frame. |
|
|
|
|
Has no effect if no ANSI in content." |
|
|
|
|
-textalign -default left -choices {left right centre}\ |
|
|
|
|
-help "Alignment of text within the content block. (centre unimplemented)" |
|
|
|
|
-ellipsis -default 1 -type boolean\ |
|
|
|
|
-help "Whether to show elipsis for truncated content and title/subtitle." |
|
|
|
|
-usecache -default 1 -type boolean |
|
|
|
|
-buildcache -default 1 -type boolean |
|
|
|
|
-crm_mode -default 0 -type boolean\ |
|
|
|
|
-help "Show ANSI control characters within frame contents. |
|
|
|
|
(Control Representation Mode) |
|
|
|
|
Frame width doesn't adapt and content may be truncated |
|
|
|
|
so -width may need to be manually set to display more." |
|
|
|
|
|
|
|
|
|
@values -min 0 -max 1 |
|
|
|
|
contents -default "" -type string\ |
|
|
|
|
-help "Frame contents - may be a block of text containing newlines and ANSI. |
|
|
|
|
Text may be 'ragged' - ie unequal line-lengths. |
|
|
|
|
No trailing ANSI reset required. |
|
|
|
|
${[textblock::EG]}e.g: frame \"[a+ blue White] \\nMy blue foreground text on\\nwhite background\\n\"${[textblock::RST]}" |
|
|
|
|
@values -min 0 -max 1 |
|
|
|
|
contents -default "" -type string\ |
|
|
|
|
-help "Frame contents - may be a block of text containing newlines and ANSI. |
|
|
|
|
Text may be 'ragged' - ie unequal line-lengths. |
|
|
|
|
No trailing ANSI reset required. |
|
|
|
|
${[textblock::EG]}e.g: frame \"[a+ blue White] \\nMy blue foreground text on\\nwhite background\\n\"${[textblock::RST]}" |
|
|
|
|
} |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
#options before content argument - which is allowed to be absent |
|
|
|
|
|
