/usr/share/perl5/CGI/Test/Form/Widget.pm is in libcgi-test-perl 1.111-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 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 | package CGI::Test::Form::Widget;
use strict;
use warnings;
################################################################
# $Id: Widget.pm 411 2011-09-26 11:19:30Z nohuhu@nohuhu.org $
# $Name: cgi-test_0-104_t1 $
################################################################
#
# Copyright (c) 2001, Raphael Manfredi
#
# You may redistribute only under the terms of the Artistic License,
# as specified in the README file that comes with the distribution.
#
use Carp;
#
# This class models a CGI form widget (button, text field, etc...).
# It belongs to one form, identified by its `form' attribute , a ref
# to a CGI::Test::Form object.
#
############################################################
#
# ->new
#
# Creation routine -- common to ALL widgets but <BUTTON> elements.
#
############################################################
sub new
{
my $this = bless {}, shift;
my ($node, $form) = @_;
#
# Can't create a CGI::Test::Form::Widget object, only heirs.
#
confess "%s is a deferred class", __PACKAGE__
if ref $this eq __PACKAGE__;
$this->_common_init($form);
#
# We don't keep any reference on the node.
# Analyze the HTML tree to determine some parameters.
#
$this->_init($node); # Defined in each heir
return $this;
}
############################################################
#
# ->_common_init
#
# Common attribute initialization for all widgets
#
############################################################
sub _common_init
{
my $this = shift;
my ($form) = @_;
$this->{form} = $form; # <FORM> containing this widget
$this->{name} = ""; # Always possible to query, must be defined
$this->{value} = ""; # Idem
return;
}
############################################################
#
# ->_init
#
# Per-widget initialization routine.
# Parse HTML node to determine our specific parameters.
#
############################################################
sub _init
{
my $this = shift;
my ($node) = @_;
confess "deferred";
}
############################################################
#
# ->_parse_attr
#
# Each heir locally defines a hash table mapping HTML node attributes to
# class attributes. This structure is used to parse the node and setup
# the object accordingly.
#
############################################################
sub _parse_attr
{
my $this = shift;
my ($node, $attr) = @_;
while (my ($html_attr, $obj_attr) = each %$attr)
{
my $val = $node->attr($html_attr);
$this->{$obj_attr} = $val if defined $val;
}
return;
}
#
# Attribute access
#
sub form
{
my $this = shift;
return $this->{form};
}
#
# Access to attributes that must be setup by heirs within _init()
# Those are common attributes for the whole Widget hierarchy.
#
# The `value' attribute may not have any meaning (e.g. for an image button)
# but it is always possible to query it.
#
sub name
{
my $this = shift;
return $this->{name};
}
sub value
{
my $this = shift;
return $this->{value};
}
sub old_value
{
my $this = shift;
return $this->{old_value};
}
sub is_disabled
{
my $this = shift;
return $this->{is_disabled};
} # "grayed out"
#
# Global widget predicates
#
sub is_read_only
{
0
} # Can change "value"
#
# High-level classification predicates
#
############################################################
sub is_button
{
return 0;
}
############################################################
sub is_input
{
return 0;
}
############################################################
sub is_menu
{
return 0;
}
############################################################
sub is_box
{
return 0;
}
############################################################
sub is_hidden
{
return 0;
}
############################################################
sub is_file
{
return 0;
}
sub gui_type
{
confess "deferred";
}
############################################################
#
# ->is_mutable
#
# Check whether it is possible to change widget's value from a user interface.
# Optionally warn if widget's value cannot be changed.
#
############################################################
sub is_mutable
{
my $this = shift;
my ($warn) = @_;
if ($this->is_disabled)
{
carp 'cannot change value of disabled %s "%s"', $this->gui_type,
$this->name
if $warn;
return 0;
}
if ($this->is_read_only)
{
carp 'cannot change value of read-only %s "%s"', $this->gui_type,
$this->name
if $warn;
return 0;
}
return 1;
}
############################################################
#
# ->set_value
#
# Change value.
# Only allowd to proceed if mutable.
#
############################################################
sub set_value
{
my $this = shift;
my ($value) = @_;
return unless $this->is_mutable(1); # Cannot change value
return if $value eq $this->{value}; # No change
#
# To ease redefinition, let this call _frozen_set_value, which is
# not redefinable and performs the common operation.
#
$this->_frozen_set_value($value);
return;
}
############################################################
#
# ->_frozen_set_value -- frozen
#
# Change value.
#
############################################################
sub _frozen_set_value
{
my $this = shift;
my ($value) = @_;
#
# The first time we do this, save current value in `old_value'.
#
$this->{old_value} = $this->{value} unless exists $this->{old_value};
$this->{value} = $value;
return;
}
############################################################
#
# ->reset_state
#
# Called when a "Reset" button is pressed to restore the value the widget
# had upon form entry.
#
############################################################
sub reset_state
{
my $this = shift;
#
# If there is `old_value' attribute yet, then the value is already OK.
#
return unless exists $this->{old_value};
#
# Restore value from old_value, and delete this attribute to signal that
# the value is now back to its original setting.
#
$this->{value} = delete $this->{old_value};
return;
}
############################################################
#
# ->is_submitable
#
# Check whether widget is "successful" (that's such an ugly name), in other
# words, whether its name/value pair should be part of submittted form data.
#
# A "successful" widget must not be disabled.
# Heirs should define the _is_successful internal routine.
#
# Returns true if submitable.
#
############################################################
sub is_submitable
{
my $this = shift;
return 0 if $this->is_disabled;
return $this->_is_successful;
}
############################################################
#
# ->_is_successful
#
# Is the enabled widget "successful", according to W3C's specs?
#
############################################################
sub _is_successful
{
confess "deferred";
}
############################################################
#
# ->submit_tuples
#
# Returns list of (name => value) tuples that should be part of the
# submitted form data. There may be more than one tuple returned for
# scrollable lists only: each checkbox is a widget, and therefore can
# return only one tuple.
#
############################################################
sub submit_tuples
{
my $this = shift;
return ($this->name(), $this->value());
}
############################################################
#
# ->delete
#
# Done with this widget, cleanup by breaking circular refs.
#
############################################################
sub delete
{
my $this = shift;
$this->{form} = undef;
return;
}
1;
=head1 NAME
CGI::Test::Form::Widget - Ancestor of all form widget classes
=head1 SYNOPSIS
# Deferred class, only heirs can be created
=head1 DESCRIPTION
The C<CGI::Test::Form::Widget> class is deferred.
It is an abstract representation of a <FORM> widget, i.e. a graphical control
element like a popup menu or a submit button.
Here is an outline of the class hierarchy tree, with the leading
C<CGI::Test::Form::> string stripped for readability, and a trailing C<*>
indicating deferred classes:
Widget*
. Widget::Box*
. . Widget::Box::Check
. . Widget::Box::Radio
. Widget::Button*
. . Widget::Button::Plain
. . Widget::Button::Submit
. . Widget::Button::Image
. . Widget::Button::Reset
. Widget::Hidden
. Widget::Input*
. . Widget::Input::Text_Area
. . Widget::Input::Text_Field
. . Widget::Input::File
. . Widget::Input::Password
. Widget::Menu*
. . Widget::Menu::List
. . Widget::Menu::Popup
Only leaf nodes are concrete classes, and there is one such class for each
known control type that can appear in the <FORM> element.
Those classes are constructed as needed by C<CGI::Test>. They are the
programmatic artefacts which can be used to manipulate those graphical
elements, on which you would otherwise click and fill within a browser.
=head1 INTERFACE
This is the interface defined at the C<CGI::Test::Form::Widget> level,
and which is therefore common to all classes in the hierarchy.
Each subclass may naturally add further specific features.
It is very important to stick to using common widget features when
writing a matching callback for the C<widgets_matching> routine in
C<CGI::Test::Form>, or you run the risk of getting a runtime error
since Perl is not statically typed.
=head2 Attributes
=over 4
=item C<form>
The C<CGI::Test::Form> to which this widget belongs.
=item C<gui_type>
A human readable description of the widget, as it would appear on a GUI,
like "popup menu" or "radio button". Meant for logging only, not to
determine the object type.
=item C<name>
The CGI parameter name.
=item C<value>
The current CGI parameter value.
=back
=head2 Attribute Setting
=over 4
=item C<set_value> I<new_value>
Change the C<value> attribute to I<new_value>.
The widget must not be C<is_read_only> nor C<is_disabled>.
=back
=head2 Widget Modification Predicates
Those predicates may be used to determine whether it is possible to
change the value of a widget from the user interface.
=over 4
=item C<is_disabled>
When I<true>, the widget is disabled, i.e. not available for editing.
It would typically appear as being I<grayed out> within a browser.
This predicate is not architecturally defined: a widget may or may not
be marked as disabled in HTML via a suitable attribute.
=item C<is_mutable> [I<warn_flag>]
Test whether widget can change value. Returns I<false> when
the widget C<is_read_only> or C<is_disabled>.
When the optional I<warn_flag> is true, C<carp> is called
to emit a warning from the perspective of the caller.
=item C<is_read_only>
When I<false>, the C<value> parameter can be changed with C<set_value>.
This is an architecturally defined predicate, i.e. its value depends only
on the widget type.
=back
=head2 Widget Classification Predicates
Those predicates may be used to determine the overall widget type.
The classification is rather high level and only helps determining
the kind of calls that may be used on a given widget object.
=over 4
=item C<is_box>
Returns true for radio buttons and checkboxes.
=item C<is_button>
Returns true for all buttons that are not boxes.
=item C<is_file>
Returns true for a I<file upload> widget, which allows file selection.
=item C<is_hidden>
Returns true for hidden fields, which have no graphical representation
by definition.
=item C<is_input>
Returns true for all input fields, where the user can type text.
=item C<is_menu>
Returns true for popup menus and scrolling lists.
=back
=head2 Miscellaneous Features
Although documented, those features are more targetted for internal use...
=over 4
=item C<delete>
Breaks circular references.
This is normally done by the C<delete> routine on the enclosing form.
=item C<is_submitable>
Returns I<true> when the name/value tupple of this widget need to be
part of the submitted parameters. The rules for determining the submitable
nature of a widget vary depending on the widget type.
=item C<reset_state>
Reset the widget's C<value> to the one it had initially. Invoked internally
when a reset button is pressed.
=item C<submit_tuples>
For submitable widgets, return the list of (name => value) tupples that
should be part of the submitted data. Widgets like scrolling list may return
more than one tuple.
This routine is invoked to compute the parameter list that must be sent back
when pressing a submit button.
=back
=head1 AUTHORS
The original author is Raphael Manfredi.
Steven Hilton was long time maintainer of this module.
Current maintainer is Alexander Tokarev F<E<lt>tokarev@cpan.orgE<gt>>.
=head1 SEE ALSO
CGI::Test::Form(3),
CGI::Test::Form::Widget::Box(3),
CGI::Test::Form::Widget::Button(3),
CGI::Test::Form::Widget::Input(3),
CGI::Test::Form::Widget::Hidden(3),
CGI::Test::Form::Widget::Menu(3).
=cut
|