NAME

  Config::Model::TermUI - Provides Config::Model UI à la Term::ReadLine

SYNOPSIS

 my $model = Config::Model -> new ;
 my $inst = $model->instance (root_class_name => 'RootClass', 
                                 instance_name => 'my_instance');
 my $root = $inst -> config_root ;

 my $term_ui = Config::Model::TermUI->new( root => $root ,
                                           title => 'My Title',
                                           prompt => 'My Prompt',
                                         );

 # engage in user interaction
 $term_ui -> run_loop ;

DESCRIPTION

This module provides a helper to construct pure ascii user interface on top of Term::ReadLine.

USER COMMAND SYNTAX

cd ...

Jump into node or value element. You can use cd <element>, cd <elt:key> or cd - to go up one node or cd ! to go to configuration root.

set elt=value, elt:key=value

Set a value.

display elt elt:key

Display a value

ls

Show elements of current node

help

Show available commands.

desc[ription]

Show class description of current node.

desc(elt)

Show description of element from current node.

desc(value)

Show effect of value (for enum)

CONSTRUCTOR

parameters

root

Root node of the configuration tree

title

UI title

prompt

UI prompt. The prompt will be completed with the location of the current node.

Methods

run_loop()

Engage in user interaction until user enters '^D' (CTRL-D).

BUGS

• Auto-completion is not complete.

• Auto-completion provides wrong choice when you try to cd in a hash where the index contains a white space. I.e. the correct command is cd foo:"a b" instead of cd foo:a b as proposed by auto completion.

• UI should take into account permission.

AUTHOR

Dominique Dumont, (ddumont at cpan dot org)

SEE ALSO

Config::Model, Config::Model::Instance, Config::Model::Node,