package VCP::UI::Text ; =head1 NAME VCP::UI::Text - A textual user interface for VCP. =head1 SYNOPSIS $ vcp ## VCP::UI::Text is the current default =head1 DESCRIPTION This is a text-only user interface for VCP. It prints out descriptions, prompts the user, reads the responses, and validates input. This class is designed to be refactored and/or inherited from for alternative user interfaces, like GUIs. =head1 METHODS =over =for test_script 00uitext.t =cut $VERSION = 0.1 ; use strict ; use VCP::UIMachines; use VCP::Debug qw( :debug ); use VCP::Utils qw( empty ); use fields ( 'Source', ## reference to the source plugin object 'Dest', ## reference to the destination plugin object 'UIManager', ## The instance of VCP::UI that is managing us 'Run', ## Whether or not to run a conversion when complete 'SaveAsConfigFileName', ## if non-empty, what filename to save as ) ; sub new { my $class = shift ; $class = ref $class || $class; my VCP::UI::Text $self = do { no strict 'refs' ; bless [ \%{"$class\::FIELDS"} ], $class; }; %$self = @_; return $self ; } =item ask $text_ui->ask( $is_error, $description, $always_verbose, $prompt, $default, $answer_key ); Prompts the user, giving them the possibly lengthy description, a blank line and a prompt. Reads a single line of input and returns it and a reference to the matching answer key. The answer key looks like: [ [ $suggested_answer_1, $validator_1, ... ], [ $suggested_answer_2, $validator_2, ... ], [ $suggested_answer_3, $validator_3, ... ], ... ] The suggested answers are like "yes", "No", etc. Leave this as undef or "" to run a validator without an answer. The validators are one of: undef Entry is compared to the suggested answer, if defined 'foo' Answer must equal 'foo' (case sensitive) qr// Answer must match the indicated regexp sub {...}, \&foo The subroutine will validate. If all validators are strings that are equal to the suggested answer, a multiple choice prompt/response is generated instead of free text entry. Validation subroutines must return TRUE for valid input, FALSE for invalid input but without a message, or die "...\n" with an error message for the user if the input is not valid. If no validators pass, an error message will be printed and the user will be reprompted. If multiple code reference validators fail with different error messages, then these will all be printed. The answer to be validated is placed in $_ when calling a code ref. =cut sub _trim { ( @_ ? $_[0] : $_ ) =~ s/\A[\r\n\s]*(.*?)[\r\n\s]*\z/$1/s or warn "Couldn't trim '$_'"; } { my $try_count = 0; my $prev_prompt = ""; sub ask { my VCP::UI::Text $self = shift; my ( $is_error, $description, $always_verbose, $prompt, $default, $answer_key ) = @_; die "prompt is required" unless defined $prompt; ## reset $try_count if this is a new question. if ( $prompt ne $prev_prompt ) { $try_count = 0; $prev_prompt = $prompt; } ## take a copy so _trim doesn't modify the original and also ## skip over answer_key records with no suggested answers. my @suggested_answers = grep defined, map $_->[0], @$answer_key; _trim for grep defined, $description, $prompt, @suggested_answers; ## We require that multiple choice is pure multiple choice, ## meaning that if any answer_key records have undef suggested ## answers, its still text input. If need be, we could make ## those multiple choice but offer an "other" choice leading ## to text entry, but that's not yet needed. my $is_multiple_choice = !grep !defined $_->[0] || $_->[0] ne $_->[1], @$answer_key; my $choices; if ( $is_multiple_choice ) { $choices = [ sort @suggested_answers ]; $prompt = $self->build_prompt( $prompt ); } else { $prompt = $self->build_prompt( $prompt, $default, \@suggested_answers ); } $self->emit_blank_line; $self->emit_hrule; while (1) { $self->output( $is_error, $try_count++ % 10 ? 2 : ( ! $always_verbose && $self->{UIManager}->{TersePrompts} ) ? 1 : 0, $description, $choices, $default, $prompt ); my $answer = $self->input; exit(0) unless defined $answer; # only when piping stdin (test scripts) _trim $answer; if ( $is_multiple_choice && ( length $answer || empty $default ) ) { if ( $answer !~ /\A\d+\z/ || $answer < 1 || $answer > $#suggested_answers + 1 ) { $self->emit_error( "Please enter a number between 1 and ", $#suggested_answers + 1, "." ); next; } $answer = $choices->[ $answer - 1 ]; } $answer = $default if defined $default && ! length $answer; my @results = eval { $self->validate( $answer, $answer_key ) }; return @results if @results > 1; $self->emit_error( @results ? !length $answer ? "Please enter a value." : "Invalid input." : $@ ); } } } =item input my $line = $text_ui->input; Gets the user's input with or without surrounding whitespace and newline. =cut sub input { my VCP::UI::Text $self = shift; return scalar ; } =item output $text_ui->output( $terseness, $description, $choices, $default, $prompt ); Outputs the parameters to the user; defaults to print()ing it with stdout buffering off. $description will be undef after the first call until ask() decides that the user needs to see it again. =cut sub output { my VCP::UI::Text $self = shift; my ( $is_error, $terse, $description, $choices, $default, $prompt ) = @_; local $| = 1; if ( ! $terse && defined $description ) { $description =~ s/^/*** /mg if $is_error; print "\n$description\n"; } print "\n"; if ( $terse < 2 && $choices && @$choices ) { my $format = do { my $iw = length( $#$choices + 1 ); my $ow = 0; for ( @$choices ) { $ow = length if ! $ow || length > $ow; } " %${iw}d) %-${ow}s%s\n"; }; my $counter = 0; print map( sprintf( $format, ++$counter, $_, defined $default && $_ eq $default ? " <--default" : "", ), @$choices ), "\n"; } print $prompt, " "; } =item emit_hrule Prints a separator line. Used between prompts and at exit. =cut sub emit_hrule { print "-" x 40, "\n" } =item emit_blank_line Prints a blank line. Used at exit. =cut sub emit_blank_line { print "\n" } =item emit_error Prints a message. Defaults to warn()ing. =cut sub emit_error { shift; my $msg = join "", @_; 1 while chomp $msg; $msg =~ s/^/*** /mg; warn $msg, "\n"; } =item build_prompt $text_ui->build_prompt( $prompt, \@suggested_answers ); Assembed $prompt and possibly the strings in \@suggested_answers in to a single string fit for a user. =cut sub build_prompt { my VCP::UI::Text $self = shift; my ( $prompt, $default, $suggested_answers ) = @_; my @s = grep length, @$suggested_answers; return join "", $prompt, @s ? ( " (", join( ", ", sort @s ), ")" ) : (), defined $default ? " [$default]" : "", "?"; } =item validate $text_ui->validate( $answer, $answer_key ); Returns a two element list ( $answer, $matching_answer_key_entry ) or dies with an error message. =cut sub validate { my VCP::UI::Text $self = shift; my ( $answer, $answer_key ) = @_; my @msgs; for my $entry ( @$answer_key ) { debug "checking '$answer' against $entry->[1]" if debugging; return ( $answer, $entry ) if ( ! defined $entry->[1] && ( ! defined $entry->[0] || $answer eq $entry->[0] ) ) || ( ref $entry->[1] eq "" && $answer eq $entry->[1] ) || ( ref $entry->[1] eq "Regexp" && $answer =~ $entry->[1] ) || ( ref $entry->[1] eq "CODE" && do { local $_ = $answer; my $ok = eval { $entry->[1]->() || 0 }; push @msgs, $@ unless defined $ok; $ok; } ); } die join "", @msgs if @msgs; return 0; } sub run { my VCP::UI::Text $self = shift; my $m = VCP::UIMachines->new; $m->run( $self ); $self->emit_hrule; $self->emit_blank_line; return ( $self->{Source}, $self->{Dest}, $self->{SaveAsConfigFileName}, $self->{Run}, ); } =back =head1 COPYRIGHT Copyright 2000, Perforce Software, Inc. All Rights Reserved. This module and the VCP::UI::Text package are licensed according to the terms given in the file LICENSE accompanying this distribution, a copy of which is included in L. =head1 AUTHOR Barrie Slaymaker =cut 1