/usr/share/perl5/FCM1/Interactive.pm is in fcm 2016.12.0-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 | # ------------------------------------------------------------------------------
# (C) British Crown Copyright 2006-16 Met Office.
#
# This file is part of FCM, tools for managing and building source code.
#
# FCM is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# FCM 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 General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with FCM. If not, see <http://www.gnu.org/licenses/>.
# ------------------------------------------------------------------------------
use strict;
use warnings;
package FCM1::Interactive;
use base qw{Exporter};
our @EXPORT_OK = qw{get_input};
use FCM1::Util::ClassLoader;
my $DEFAULT_IMPL_CLASS = 'FCM1::Interactive::InputGetter::CLI';
my %DEFAULT_IMPL_CLASS_OPTIONS = ();
my $IMPL_CLASS = $DEFAULT_IMPL_CLASS;
my %IMPL_CLASS_OPTIONS = %DEFAULT_IMPL_CLASS_OPTIONS;
################################################################################
# Returns the name of the current class/settings for getting input
sub get_impl {
return (wantarray() ? ($IMPL_CLASS, \%IMPL_CLASS_OPTIONS) : $IMPL_CLASS);
}
################################################################################
# Returns the name of the current class/settings for getting input
sub get_default_impl {
return (
wantarray()
? ($DEFAULT_IMPL_CLASS, \%DEFAULT_IMPL_CLASS_OPTIONS)
: $DEFAULT_IMPL_CLASS
);
}
################################################################################
# Sets the name of the class/settings for getting input
sub set_impl {
my ($impl_class, $impl_class_options_ref) = @_;
if ($impl_class) {
$IMPL_CLASS = $impl_class;
if ($impl_class_options_ref) {
%IMPL_CLASS_OPTIONS = (%{$impl_class_options_ref});
}
else {
%IMPL_CLASS_OPTIONS = ();
}
}
}
################################################################################
# Gets an input from the user and returns it
sub get_input {
my (%options) = @_;
my ($class_name, $class_options_ref) = get_impl();
FCM1::Util::ClassLoader::load($class_name);
%options = map {lc($_), $options{$_}} keys(%options);
return $class_name->new({%{$class_options_ref}, %options})->invoke();
}
1;
__END__
=head1 NAME
FCM1::Interactive
=head1 SYNOPSIS
use FCM1::Interactive;
FCM1::Interactive::set_impl('My::InputGetter', {option1 => 'value1', ...});
$answer = FCM1::Interactive::get_input(
title => 'My title',
message => 'Would you like to ...?',
type => 'yn',
default => 'n',
);
=head1 DESCRIPTION
Common interface for getting an interactive user reply. The default is to use a
L<FCM1::Interactive::InputGetter::CLI|FCM1::Interactive::InputGetter::CLI> object
with no extra options.
=head1 FUNCTIONS
=over 4
=item get_impl()
Returns the class that implements the function for get_input(%options). In
scalar context, returns the class name only. In list context, returns the class
name and the extra hash options that would be passed to its constructor.
=item get_default_impl()
Returns the defaut values for get_impl().
=item set_impl($impl_class,$impl_class_options_ref)
Sets the class that implements the function for get_input(%options). The name
of the class is given in $impl_class. Any extra options that should be given to
the constructor should be set in the hash reference $impl_class_options_ref.
=item get_input(%options)
Calls the appropriate function to get an input string from the user, and
returns it.
Input options are: I<title>, for a short title of the prompt, I<message>, for
the message prompt, I<type> for the prompt type, and I<default> for the default
value of the return value.
Prompt type can be YN (yes or no), YNA (yes, no or all) or input (for an input
string).
=back
=head1 SEE ALSO
L<FCM1::Interactive::InputGetter|FCM1::Interactive::InputGetter>,
L<FCM1::Interactive::InputGetter::CLI|FCM1::Interactive::InputGetter::CLI>,
L<FCM1::Interactive::InputGetter::GUI|FCM1::Interactive::InputGetter::GUI>
=head1 COPYRIGHT
E<169> Crown copyright Met Office. All rights reserved.
=cut
|