gui: Make $first a local variable of _get_subtree().

Apparently this was missed when the function was introduced. The
variable is only referenced in _get_subtree().

gui: Make _gsu_node_name_pattern private.

Conform to the convention that the name of a private variables should
start with an underscore character. Also there is no need to export
the variable.

gui: Make gsu_menu() private.

Its single caller is _browse(), which is a private function as
well. This patch prepends an underscore to the function name to
indicate that the function is not supposed to be called by application
code.

gui: Remove unused widgets.

No application uses these public functions, so remove them for now.
They can be re-added on demand but for now they are just dead code.

Merge branch 't/kill_pointless_subshell'

Cooking for almost a month.

* t/kill_pointless_subshell:
  subcommand: Overhaul _gsu_print_available_commands().

Merge branch 't/default_gsu_dir'

Cooking for almost a month.

* t/default_gsu_dir:
  Unify gsu_dir handling.

Merge branch 't/arithmetic_eval'

Cooking for almost a month.

* t/arithmetic_eval:
  Use modern style arithmetic evaluation everwhere.

Merge branch 't/kill_gsu_self'

Cooking for three weeks.

* t/kill_gsu_self:
  Remove $_gsu_self.

Conflicts:
subcommand

Use modern style arithmetic evaluation everwhere.

This is an equivalent transformation, and the new code is easier to
read and less error-prone.

Fix _gsu_banner_msg().

This function did not print the banner at all. It also had only a
single caller. This patch removes the function and changes the single
caller to print the banner text.

Unify gsu_dir handling.

The three locations which include the common part of gsu need to know
the gsu installation directory. Currently we rely on the application
to set $gsu_dir. This is unnecessary since gsu can tell where it is
installed by examining ${BASH_SOURCE[0]}.

Also the fallback to $HOME/.gsu is not required. This commit unifies
all three locations and also calls _gsu_setup as early as possible:
when the gsu module is sourced.

Remove $_gsu_self.

It has the same meaning as $gsu_name, so let's use $gsu_name
everywhere. Also avoid to call basename(1), as ${0##*/} does the same
and is cheaper.

subcommand: Overhaul _gsu_print_available_commands().

This function is rather confused. It uses gsu_short_msg() to print
the header to stderr while the list of subcommands is printed to
stdout. This is "fixed" by executing all commands in a subshell and
redirecting stderr to stdout.

It's easier to just print everything to stdout. This patch also
renames the loop variable i to cmd, declares $count as a local
integer variable and switches to single quoted string constants.

Move all files to the top level directory.

With gsu being a separate repository, there is no point in burying
the gsu files below misc/gsu.

gsu: Document gsu().

To get started, gsu application writers need to know how the gsu()
function works. So let's provide a small introduction here and a
minimal example.

gsu: Improve documentation of _gsu_get_command_regex().

Although this function is private, it is central to the subcommand
part of gsu and should thus be properly documented. The new text is
more precise about the meaning of the regular expression that is used
to identify subcommands.

gsu: Don't fail if HOME is unset.

As pointed out by Joffrey Fitz, gsu-based scripts do not work when
run as a user without home directory. This happens for example if
the script is executed through a web application as the www-data user.

This patch replaces all references to HOME by ${HOME:-}, i.e. we just
default to the empty string but don't fail immediately.

gsu: Mark get_geometry() as a private function.

The function is not called from any scripts that currently use gsu.
This commit marks it private by prepending an underscore to its name.

gsu: Improve documentation of gsu_getopts().

The sentence which explains how $o_X is set for both types of options
was rather confusing. The new text should be better.

While we're at it,
* mention that getopts is a bash builtin
* switch to "modern" ((expr)) arithmetic evaluation in example
* use '' to quote constants in example

gsu: Improve help text of complete subcommand.

The current help text talks about two forms to run this command,
but only one is mentioned. This commit tries to clarify that the
function behaves differently when called without argument.

gsu: Fix quoting of config default options.

This makes newlines in the default of a gsu config option work.

gsu: Add missing declaration of a local variable.

"opt" is used but not declared local.

gsu: User banner text also for gsu gui.

Currently the $gsu_banner_txt variable is used only for subcommand
utilities but not for dialog-based tools. There is no real reason for
this restriction, so this commit starts to use the variable also for
the various GUIs.

gsu/gui: Fix regex for tree walk.

If one directory name is a suffix of another, the regex
for grep found both, which is bad.

gsu_gui: Add check for dialog executable.

Currently, programs which use gsu_gui exit silently with no indication about
what went wrong if dialog is not installed. This patch makes it print an error
message in this case.

Add gsu_gui.

The dialog-based shell library for earth-shaking graphical user
interfaces that don't suck.

Its main entry function gsu_gui() allows to pass a tree to control
the menus.

gsu: simplify banner message.

This was unnecessarily complex and caused an error if set -u
was used.

gsu: Avoid referencing an unset variable.

This causes an error if scripts use set -u.

gsu subcommand: Add gsu_get_unnamed_arg_num().

This will be handy for many gsu applications.

gsu subcommand: Fix off-by-one bug in gsu_cword_is_option_parameter().

We define $n as the number of characters in the getopt string *minus one*,
so we must loop from 0 to $n, inclusively.

This patch also adds documentation of this public function.

Fix gsu com_complete().

It should work also if set -u was given. Currently this fails if
_com_complete() is called with no arguments.

Moreover, the first argument, if it is provided, should be a number
but we missed to check this.

gsu subcommand: Use gsu_getopts.

This makes the prefs command error out on invalid options
and avoids the expansion of the possibly unset parameter $1.

gsu_getopts: Rename local variable opt to _gsu_getopts_opt.

As pointed out by Sebastian Stark, calling the loop variable "opt"
in code which is supposed to be eval'd by the application may conflict
with another local variable of the same name defined in the function
which calls gsu_getopt().

This could lead to rather obscure bugs which are hard to detect.
The callers don't use this loop variable directly, so we are free
to call it whatever we want. Therefore this patch renames $opt to
something which is much less likely to cause a conflict.

gsu: Avoid parameter expansion on unset variables.

This patch allows to run scripts which use gsu with bash's -u option
enabled. This is mostly useful to spot bugs due to typos in variable
names.

gsu: Overhaul of the rexexp matching for help commands.

The old sed scripts were unreadable and broken on non-gnu systems
since they made use of some gnuisms of grep and sed like \+ in regular
expressions to match at least one character or sed's T command which
jumps to a label if no substitution has been made since the most
recent reading of an input line.

This patch switches to extended regular expressions and replaces all
broken sed scripts by portable ones, which are known to work at least
on FreeBSD and MacOS. The new scripts are commented verbosely so that
any subsequent changes do not require a full rewrite, hopefully.

gsu: Initial completion support.

This adds the framework for command completion of scripts which make
use of the gsu subcommand library. The idea is to implement as much
as possible as generic helpers within gsu in order to minimize code
duplication in the scripts which source the gsu library.

The new "complete" subcommand is automatically included in each
application, just like the help, man and prefs commands we already
have. This subommand is meant to be used as the completer which calls
the custom subcommand completers included in the application.

Two new public helper functions, gsu_complete_options() and
gsu_cword_is_option_parameter() are introduced in this commit.

The former function takes a usual getopt string and completes according
to all options in this string. The latter is useful for completers
which need to determine whether the current word is the parameter to
some option in order to find out how to complete the current word.

For example, the -s option of cmt's vmem command takes a mandatory
parameter which is a number. So the completer for this command must
complete differently depending on whether the previous word is "-s".

gsu: Don't export functions.

This is no longer necessary now that all gsu scripts include the gsu
shell library directly.

Split gsu.

This patch splits the gsu file into two files for config parsing and
subcommand handling respectively.  Each part may be used independently
of the other.

Moreover, all scripts which use gsu now include the needed parts
directly rather than relying on the shell to have already sourced
the needed gsu files. This shortens bash startup time and makes gsu
easier to use for people whose login shell is not bash.

Allow hyphens in command names.

There is no reason to forbid subcommands with hyphens, and sometimes
it is just natural have such a command. For instance if the subcommand
wraps an existing command with a hyphen like "apt-get".

So change the regular expression for subcommands accordingly.

gsu: Avoid duplication of command regex.

The regular expression for fining the subcommands was duplicated
four times in gsu. Needless to say that this resulted in more than
one variant of the expression...

Avoid this duplication by introducing the global gsu_command_regex
variable. While at it, use a more clever sed command in
_gsu_available_commands() which allows to kill a grep command.

gsu: Set copyright year to 2011.

gsu: Fix handling of config options with newlines.

Without this, newlines are transformed into spaces.

gsu: Don't use the =~ operator.

I need it at least on one machine that still has only bash-2.

gsu_getopts: Abort on programming errors and add documentation.

gsu: Introduce gsu_getopts().

No users yet.

gsu: Remove check on bash version.

It hurts more than the possible incompatibilities.

gsu: com_prefs -e fixes.

Create the subdirectory for the config file if it does not exist, and fix the
return value for the editor command.

gsu: Kill some unused error codes.

gsu: Add -e option to com_prefs.

gsu: Minor cosmetic cleanup.

gsu com_help(): Be more strict when looking for command documentation.

Change name of internal commands.

These are not meant to be called from elsewhere, so mark them with an
underscore. Also fix the indentation of the com_help() code.

gsu: Error out if not running as bash-4.

gsu: Change semantics of gsu_check_arg_count().

It's kind of ugly having to specify an artificial upper bound on the arg count
if the allowed number of arguments is unlimited.

gtt: The git topic tool.

Another gsu-based script for managing git topic branches.

gsu: Add gsu_check_arg_count().

This function is open-coded $MANY times, so it makes sense to
have one globally visible function that can be called from all
scripts that use gsu.

gsu: Print the name of the invalid config variable on errors.

gsu: Fix quoting for multi-line variables.

The new para_adm topics command triggered this bug.

gsu: Fix com_prefs() for invalid preferences.

The prefs command would print only empty values for
all options that come after an invalid option.
Refuse to execute com_prefs() in this case is the most
simple fix.

gsu: Make command line vars trump config file vars.

This allows to overrule preferences  given in the config file by
using command line like this

lv=foo snapfsck

which ignores the setting of lv in ~/.snapfsck.rc and uses the value
"foo" instead.

gsu: Print help text on prefs command.

This uses another nice bashism I recently learned.

gsu: Use bash shebang.

It's kind of pointless trying to be portable here.

gsu: Allow help/man/prefs command even on invalid configs.

These generic subcommands do not need the config file. It's pointless
to refuse to print the help e.g. if a required config variable is unset.

Also, use the name of the executable as the default value for gsu_name.

gsu: Introduce gsu_config_var_prefix.

It defaults to the $gsu_name, i.e. this is a backwards-compatible change.

gsu: Fix a typo in gsu_check_options().

This caused gsu to exit without an error message in case there is
an invalid option type given in the script that used gsu.

gsu: Allow empty default values.

Priliminary version of gsu2.

Backwards compatible, new features are only used by dpch yet.

gsu improvements.

Support config files from within gsu. Untested.

gsu: Remove unused variable "tilde_signs".

gsu: Make man a generic gsu command.

Also, make the help text of eat grutatxt-friendly and add some more
documentation.

gsu: Kill debug "ret=1".

gsu: Replace "$*" by "$@".

This allows to pass parameters containing spaces.

gsu: Trivial gsu_err_msg() cleanup.

gsu: Fix two bashisms.

Always include the '$', even in math expressions where bash doesn't
need it.

gsu: Fix "echo -en" bashism.

gsu: trivial cleanup.

gsu: remove shebang

It's not needed for functions.

gsu: print $(basename $0) instead of $0 on help output.

introduce gsu: The global subcommand utility, and make bbf_adm use it.

eat: the environment admin tool

It is no good sign if one has written so many scripts that
a tool for managing them is neccessary..