/usr/share/perl5/Config/Model/Describe.pm is in libconfig-model-perl 2.005-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 | #
# This file is part of Config-Model
#
# This software is Copyright (c) 2012 by Dominique Dumont, Krzysztof Tyszecki.
#
# This is free software, licensed under:
#
# The GNU Lesser General Public License, Version 2.1, February 1999
#
# Copyright (c) 2006-2010 Dominique Dumont.
#
# This file is part of Config-Model.
#
# Config-Model is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser Public License as
# published by the Free Software Foundation; either version 2.1 of
# the License, or (at your option) any later version.
#
# Config-Model is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
# Lesser Public License for more details.
#
# You should have received a copy of the GNU Lesser Public License
# along with Config-Model; if not, write to the Free Software
# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
package Config::Model::Describe;
{
$Config::Model::Describe::VERSION = '2.005';
}
use Carp;
use strict;
use warnings ;
use Config::Model::Exception ;
use Config::Model::ObjTreeScanner ;
=head1 NAME
Config::Model::Describe - Provide a description of a node element
=head1 VERSION
version 2.005
=head1 SYNOPSIS
use Config::Model;
use Log::Log4perl qw(:easy);
Log::Log4perl->easy_init($WARN);
# define configuration tree object
my $model = Config::Model->new;
$model->create_config_class(
name => "Foo",
element => [
[qw/foo bar/] => {
type => 'leaf',
value_type => 'string'
},
]
);
$model ->create_config_class (
name => "MyClass",
element => [
[qw/foo bar/] => {
type => 'leaf',
value_type => 'string'
},
hash_of_nodes => {
type => 'hash', # hash id
index_type => 'string',
cargo => {
type => 'node',
config_class_name => 'Foo'
},
},
],
) ;
my $inst = $model->instance(root_class_name => 'MyClass' );
my $root = $inst->config_root ;
# put data
my $step = 'foo=FOO hash_of_nodes:fr foo=bonjour -
hash_of_nodes:en foo=hello ';
$root->load( step => $step );
print $root->describe ;
### prints
# name value type comment
# foo FOO string
# bar [undef] string
# hash_of_nodes <Foo> node hash keys: "en" "fr"
=head1 DESCRIPTION
This module is used directly by L<Config::Model::Node> to describe
a node element. This module returns a human readable string that
shows the content of a configuration node.
For instance (as shown by C<fstab> example:
name value type comment
fs_spec [undef] string mandatory
fs_vfstype [undef] enum choice: auto davfs ext2 ext3 swap proc iso9660 vfat ignore, mandatory
fs_file [undef] string mandatory
fs_freq 0 boolean
fs_passno 0 integer
This module is also used by the C<ll> command of L<Config::Model::TermUI>.
=head1 CONSTRUCTOR
=head2 new ( )
No parameter. The constructor should be used only by
L<Config::Model::Node>.
=cut
sub new {
bless {}, shift ;
}
=head1 Methods
=head2 describe(...)
Return a description string.
Parameters are:
=over
=item node
Reference to a L<Config::Model::Node> object. Mandatory
=item element
Describe only this element from the node. Optional. All elements are
described if omitted.
=back
=cut
sub describe {
my $self = shift ;
my %args = @_;
my $desc_node = delete $args{node}
|| croak "describe: missing 'node' parameter";
my $element = delete $args{element} ; # optional
my $check = delete $args{check} || 'yes' ;
my $std_cb = sub {
my ( $scanner, $data_r, $obj, $element, $index, $value_obj ) = @_;
my $value = $value_obj->fetch (check => $check) ;
$value = '"' . $value . '"' if defined $value and $value =~ /\s/;
#print "DEBUG: std_cb on $element, idx $index, value $value\n";
my $name = defined $index ? "$element:$index" : $element;
$value = defined $value ? $value : '[undef]' ;
my $type = $value_obj->value_type ;
my @comment ;
push @comment, "choice: " . join(' ',@{$value_obj->choice})
if $type eq 'enum' ;
push @comment, 'mandatory' if $value_obj->mandatory ;
push @$data_r , [ $name, $value, $type, join(', ',@comment) ] ;
};
my $list_element_cb = sub {
my ( $scanner, $data_r, $obj, $element, @keys ) = @_;
#print "DEBUG: list_element_cb on $element, keys @keys\n";
my $list_obj = $obj->fetch_element($element) ;
my $elt_type = $list_obj->cargo_type ;
if ( $elt_type eq 'node' ) {
my $class_name = $list_obj->config_class_name ;
my @show_keys = @keys ? @keys : ('<empty>') ;
push @$data_r , [ $element, "<$class_name>",
'node list', "indexes: @show_keys" ];
}
else {
push @$data_r , [ $element,
join( ',', $list_obj->fetch_all_values(check => 'no' )),
'list','' ];
}
};
my $check_list_element_cb = sub {
my ( $scanner, $data_r, $obj, $element, @choices ) = @_;
my $list_obj = $obj->fetch_element($element) ;
push @$data_r , [ $element,
join( ',', $list_obj->get_checked_list ),
'check_list','' ];
};
my $hash_element_cb = sub {
my ( $scanner, $data_r, $obj, $element, @keys ) = @_;
#print "DEBUG: hash_element_cb on $element, keys @keys\n";
my $hash_obj = $obj->fetch_element($element) ;
my $elt_type = $hash_obj->cargo_type ;
if ( $elt_type eq 'node' ) {
my $class_name = $hash_obj->config_class_name ;
my @show_keys = @keys ? map { qq("$_") } @keys : ('<empty>') ;
my $show_str = "keys: @show_keys";
push @$data_r , [ $element, "<$class_name>",
'node hash', $show_str ];
}
elsif (@keys) {
map {$scanner->scan_hash($data_r, $obj,$element,$_)} @keys ;
}
else {
push @$data_r, [ $element, "[empty hash]", 'value hash', "" ];
}
};
my $node_element_cb = sub {
my ( $scanner, $data_r, $obj, $element, $key, $next ) = @_;
#print "DEBUG: elt_cb on $element, key $key\n";
my $type = $obj -> element_type($element);
my $class_name = $next->config_class_name ;
push @$data_r, [ $element,"<$class_name>",'node','' ];
#$ret .= ":$key" if $type eq 'list' or $type eq 'hash';
#$view_scanner->scan_node($next);
};
my @scan_args = (
experience => delete $args{experience} || 'master',
fallback => 'all',
auto_vivify => 0,
list_element_cb => $list_element_cb,
check_list_element_cb => $check_list_element_cb,
hash_element_cb => $hash_element_cb,
leaf_cb => $std_cb ,
node_element_cb => $node_element_cb,
);
my @left = keys %args;
croak "Describe: unknown parameter:@left" if @left;
# perform the scan
my $view_scanner = Config::Model::ObjTreeScanner->new(@scan_args);
my $format = "%-12s %-12s %-12s %-35s\n" ;
my @ret = [ qw/name value type comment/ ];
if (defined $element and $desc_node->has_element($element)) {
$view_scanner->scan_element(\@ret ,$desc_node, $element);
}
elsif (defined $element) {
Config::Model::Exception::UnknownElement
->throw(
object => $desc_node,
function => 'Describe',
where => $desc_node->location || 'configuration root',
element => $element,
) ;
}
else {
$view_scanner->scan_node(\@ret ,$desc_node);
}
return join '', map { sprintf($format, @$_) } @ret ;
}
1;
=head1 AUTHOR
Dominique Dumont, (ddumont at cpan dot org)
=head1 SEE ALSO
L<Config::Model>,L<Config::Model::Node>,L<Config::Model::ObjTreeScanner>
|