.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "Config::Model::TermUI 3pm" .TH Config::Model::TermUI 3pm "2023-08-19" "perl v5.36.0" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" Config::Model::TermUI \- Interactive command line interface for cme .SH "VERSION" .IX Header "VERSION" version 2.153 .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 2 \& use Config::Model; \& use Config::Model::TermUI ; \& \& # define configuration tree object \& my $model = Config::Model\->new; \& $model\->create_config_class( \& name => "Foo", \& element => [ \& [qw/foo bar/] => { \& type => \*(Aqleaf\*(Aq, \& value_type => \*(Aqstring\*(Aq \& }, \& ] \& ); \& $model \->create_config_class ( \& name => "MyClass", \& \& element => [ \& \& [qw/foo bar/] => { \& type => \*(Aqleaf\*(Aq, \& value_type => \*(Aqstring\*(Aq \& }, \& hash_of_nodes => { \& type => \*(Aqhash\*(Aq, # hash id \& index_type => \*(Aqstring\*(Aq, \& cargo => { \& type => \*(Aqnode\*(Aq, \& config_class_name => \*(AqFoo\*(Aq \& }, \& }, \& ], \& ) ; \& \& my $inst = $model\->instance(root_class_name => \*(AqMyClass\*(Aq ); \& \& my $root = $inst\->config_root ; \& \& # put data \& my $steps = \*(Aqfoo=FOO hash_of_nodes:fr foo=bonjour \- \& hash_of_nodes:en foo=hello \*(Aq; \& $root\->load( steps => $steps ); \& \& my $ui = Config::Model::TermUI\->new( \& root => $root , \& title => \*(AqMy class ui\*(Aq, \& prompt => \*(Aqclass ui\*(Aq, \& ); \& \& # engage in user interaction \& $ui \-> run_loop ; \& \& print $root\->dump_tree ; .Ve .PP Once the synopsis above has been saved in \f(CW\*(C`my_test.pl\*(C'\fR, you can achieve the same interactions as with \f(CW\*(C`Config::Model::SimpleUI\*(C'\fR. Except that you can use \&\s-1TAB\s0 completion: .PP .Vb 5 \& class ui:$ ls \& foo bar hash_of_nodes \& class ui:$ ll hash_of_nodes \& name value type comment \& hash_of_nodes node hash keys: "en" "fr" \& \& class ui:$ cd hash_of_nodes:en \& class ui: hash_of_nodes:en $ ll \& name value type comment \& foo hello string \& bar [undef] string \& \& class ui: hash_of_nodes:en $ set bar=bonjour \& class ui: hash_of_nodes:en $ ll \& name value type comment \& foo hello string \& bar bonjour string \& \& class ui: hash_of_nodes:en $ ^D .Ve .PP At the end, the test script dumps the configuration tree. The modified \&\f(CW\*(C`bar\*(C'\fR value can be found in there: .PP .Vb 6 \& foo=FOO \& hash_of_nodes:en \& foo=hello \& bar=bonjour \- \& hash_of_nodes:fr \& foo=bonjour \- \- .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" This module provides a helper to construct pure \s-1ASCII\s0 user interface on top of Term::ReadLine. To get better interaction you must install either Term::ReadLine::Gnu or Term::ReadLine::Perl. .PP Depending on your installation, either Term::ReadLine::Gnu or Term::ReadLine::Perl is used. See Term::ReadLine to override default choice. .SH "Dependencies" .IX Header "Dependencies" This module is optional and depends on Term::ReadLine to work. To reduce the dependency list of Config::Model, \f(CW\*(C`Term::ReadLine\*(C'\fR is only recommended. cme gracefully degrades to Config::Model::SimpleUI when necessary. .SH "USER COMMAND SYNTAX" .IX Header "USER COMMAND SYNTAX" See \*(L"\s-1USER COMMAND SYNTAX\*(R"\s0 in Config::Model::SimpleUI. .SH "CONSTRUCTOR" .IX Header "CONSTRUCTOR" .SS "parameters" .IX Subsection "parameters" .IP "root" 4 .IX Item "root" Root node of the configuration tree .IP "title" 4 .IX Item "title" \&\s-1UI\s0 title .IP "prompt" 4 .IX Item "prompt" \&\s-1UI\s0 prompt. The prompt will be completed with the location of the current node. .SH "Methods" .IX Header "Methods" .SS "run_loop" .IX Subsection "run_loop" Engage in user interaction until user enters '^D' (CTRL-D). .SH "BUGS" .IX Header "BUGS" .IP "\(bu" 4 Auto-completion is not complete. .IP "\(bu" 4 Auto-completion provides wrong choice when you try to \f(CW\*(C`cd\*(C'\fR in a hash where the index contains a white space. I.e. the correct command is \&\f(CW\*(C`cd foo:"a b"\*(C'\fR instead of \f(CW\*(C`cd foo: "a b"\*(C'\fR as proposed by auto completion. .SH "AUTHOR" .IX Header "AUTHOR" Dominique Dumont, (ddumont at cpan dot org) .SH "SEE ALSO" .IX Header "SEE ALSO" Config::Model, Config::Model::Instance, Config::Model::Node, .SH "AUTHOR" .IX Header "AUTHOR" Dominique Dumont .SH "COPYRIGHT AND LICENSE" .IX Header "COPYRIGHT AND LICENSE" This software is Copyright (c) 2005\-2022 by Dominique Dumont. .PP This is free software, licensed under: .PP .Vb 1 \& The GNU Lesser General Public License, Version 2.1, February 1999 .Ve