/usr/share/perl5/Gtk2/Ex/PodViewer.pm is in libgtk2-ex-podviewer-perl 0.18-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 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 | # $Id: PodViewer.pm,v 1.44 2008/10/04 14:01:23 gavin Exp $
# Copyright (c) 2003-2008 Gavin Brown. All rights reserved. This program is
# free software; you can redistribute it and/or modify it under the same
# terms as Perl itself.
package Gtk2::Ex::PodViewer;
use Gtk2;
use Gtk2::Ex::PodViewer::Parser;
use vars qw($VERSION $self->{db});
use Gtk2::Pango;
use Pod::Simple::Search;
use strict;
our $VERSION = '0.18';
#
# we want to create a new signal for this object, which means we need to
# create a new GType. however, using Glib::Object::Subclass (as of Glib
# 1.031 and all previous) makes it impossible for us to be require'd,
# thanks to the CHECK block madness. so, we use Glib::Type::register
# directly.
#
# inherit new from Glib::Object.
*new = \&Glib::Object::new;
Glib::Type->register(
Gtk2::TextView::,
__PACKAGE__,
signals => {
link_clicked => {
param_types => [qw/Glib::String/],
},
'link_enter' => {
param_types => [qw/Glib::String/],
},
'link_leave' => {
},
},
properties => [
],
);
sub INIT_INSTANCE {
my $self = shift;
$self->set_editable(0);
$self->set_wrap_mode('word');
$self->{parser} = Gtk2::Ex::PodViewer::Parser->new(buffer => $self->get_buffer);
$self->get_buffer->create_tag(
'bold',
weight => PANGO_WEIGHT_BOLD
);
$self->get_buffer->create_tag(
'italic',
style => 'italic',
);
$self->get_buffer->create_tag(
'word_wrap',
wrap_mode => 'word',
);
$self->get_buffer->create_tag(
'head1',
weight => PANGO_WEIGHT_BOLD,
size => 15 * PANGO_SCALE,
wrap_mode => 'word',
foreground => '#404080',
);
$self->get_buffer->create_tag(
'head2',
weight => PANGO_WEIGHT_BOLD,
size => 12 * PANGO_SCALE,
wrap_mode => 'word',
foreground => '#404080',
);
$self->get_buffer->create_tag(
'head3',
weight => PANGO_WEIGHT_BOLD,
size => 9 * PANGO_SCALE,
wrap_mode => 'word',
foreground => '#404080',
);
$self->get_buffer->create_tag(
'head4',
weight => PANGO_WEIGHT_BOLD,
size => 6 * PANGO_SCALE,
wrap_mode => 'word',
foreground => '#404080',
);
$self->get_buffer->create_tag(
'monospace',
family => 'monospace',
wrap_mode => 'none',
foreground => '#606060',
);
$self->get_buffer->create_tag(
'typewriter',
family => 'monospace',
wrap_mode => 'word',
);
$self->get_buffer->create_tag(
'link',
foreground => 'blue',
underline => 'single',
wrap_mode => 'word',
);
$self->get_buffer->create_tag(
'indented',
left_margin => 40,
);
$self->get_buffer->create_tag(
'normal',
wrap_mode => 'word',
);
# put a 6pixel white border around the text:
$self->set_border_window_size('left', 6);
$self->set_border_window_size('top', 6);
$self->set_border_window_size('right', 6);
$self->set_border_window_size('bottom', 6);
$self->modify_bg('normal', Gtk2::Gdk::Color->new(65535, 65535, 65535));
my $cursor = Gtk2::Gdk::Cursor->new('xterm');
my $url_cursor = Gtk2::Gdk::Cursor->new('hand2');
$self->signal_connect('button_release_event', sub { $self->clicked($_[1]) ; return 0 });
$self->signal_connect_after('realize' => sub {
my $view = shift;
$view->get_window('text')->set_events([qw(exposure-mask
pointer-motion-mask
button-press-mask
button-release-mask
key-press-mask
structure-mask
property-change-mask
scroll-mask)]);
return 0;
});
$self->signal_connect('motion_notify_event' => sub {
my ($view, $event) = @_;
my ($x, $y) = $view->window_to_buffer_coords('text', $event->x, $event->y);
my $over_link = $view->get_iter_at_location($x, $y)->has_tag($view->get_buffer()->get_tag_table()->lookup("link"));
if ($over_link && !$self->{was_over_link}) {
# user has just brought the mouse over a link:
$self->{was_over_link} = 1;
my $text = $self->get_link_text_at_iter($view->get_iter_at_location($x, $y));
$self->signal_emit('link_enter', $text) if ($text ne '');
} elsif (!$over_link && $self->{was_over_link}) {
# user has just moved the mouse away from a link:
$self->{was_over_link} = 0;
$self->signal_emit('link_leave');
}
$view->get_window('text')->set_cursor($over_link ? $url_cursor : $cursor);
return 0;
});
}
=pod
=head1 NAME
Gtk2::Ex::PodViewer - a Gtk2 widget for displaying Plain old Documentation (POD).
NB: This module used to be called L<Gtk2::PodViewer>. That module is now a stub that points to this module.
=head1 SYNOPSIS
use Gtk2 -init;
use Gtk2::Ex::PodViewer;
my $viewer = Gtk2::Ex::PodViewer->new;
$viewer->load('/path/to/file.pod'); # load a file
$viewer->load('IO::Scalar'); # load a module
$viewer->load('perlvar'); # load a perldoc
$viewer->load('bless'); # load a function
$viewer->show; # see, it's a widget!
my $window = Gtk2::Window->new;
$window->add($viewer);
$window->show;
Gtk2->main;
=head1 DESCRIPTION
Gtk2::Ex::PodViewer is a widget for rendering Perl POD documents. It is based on the Gtk2::TextView widget and uses Pod::Parser for manipulating POD data.
Gtk2::Ex::PodViewer widgets inherit all the methods and properties of Gtk2::TextView widgets. Full information about text buffers can be found in the Gtk+ documentation at L<http://developer.gnome.org/doc/API/2.0/gtk/GtkTextView.html>.
=head1 OBJECT HIERARCHY
L<Glib::Object>
+--- L<Gtk2::Object>
+--- L<Gtk2::Widget>
+--- L<Gtk2::Editable>
+--- L<Gtk2::TextView>
+--- L<Gtk2::Ex::PodViewer>
=head1 CONSTRUCTOR
my $view = Gtk2::Ex::PodViewer->new;
creates and returns a new Gtk2::Ex::PodViewer widget.
=head1 ADDITIONAL METHODS
$viewer->clear;
This clears the viewer's buffer and resets the iter. You should never need to use this method since the loader methods (see L<Document Loaders> below) will do it for you.
=cut
sub _init_db {
my $self = shift;
$self->{db} = Pod::Simple::Search->new->survey;
}
=pod
my $db = $viewer->get_db;
This method returns a hashref that contains the POD document database used internally by Gtk2::Ex::PodViewer. If you want to improve startup performance, you can cache this database using a module like C<Storable>. To load a cached database into a viewer object, call
$viewer->set_db($db);
before making a call to any of the document loader methods below (otherwise, Gtk2::Ex::PodViewer will create a new database for itself). If you want to tell Gtk2::Ex::PodViewer to create a new document database (for example, after a new module has been installed), use
$viewer->reinitialize_db;
=cut
sub set_db { $_[0]->{db} = $_[1] }
sub get_db { $_[0]->{db} }
sub reinitialize_db { shift()->_init_db }
sub clear {
my $self = shift;
$self->get_buffer->set_text('');
$self->{parser}{iter} = $self->get_buffer->get_iter_at_offset(0);
return 1;
}
=pod
@marks = $view->get_marks;
This returns an array of section headers. So for example, a POD document of the form
=pod
=head1 NAME
=head1 SYNOPSIS
=cut
would result in
@marks = ('NAME', 'SYNOPSIS');
You can then use the contents of this array to create a document index.
=cut
sub get_marks {
return $_[0]->{parser}->get_marks;
}
=pod
$name = 'SYNOPSIS';
$mark = $view->get_mark($name);
returns the GtkTextMark object referred to by C<$name>.
=cut
sub get_mark {
return $_[0]->{parser}->get_mark($_[1]);
}
=pod
$name = 'SYNOPSIS';
$view->jump_to($name);
this scrolls the PodViewer window to the selected mark.
=cut
sub jump_to {
my ($self, $name) = @_;
my $mark = $self->get_mark($name);
return undef unless (ref($mark) eq 'Gtk2::TextMark');
return $self->scroll_to_mark($mark, undef, 1, 0, 0);
}
=pod
$viewer->load($document);
Loads a given document. C<$document> can be a perldoc name (eg., C<'perlvar'>), a module (eg. C<'IO::Scalar'>), a filename or the name of a Perl builtin function from L<perlfunc>. Documents are searched for in that order, that is, the L<perlvar> document will be loaded before a file called C<perlvar> in the current directory.
=cut
sub load {
my ($self, $name) = @_;
$self->_init_db if (!defined($self->{db}));
return 1 if $self->load_function($name);
return 1 if $self->load_doc($name);
return 1 if $self->load_file($name);
return undef;
}
=pod
=head1 DOCUMENT LOADERS
The C<load()> method is a wrapper to a number of specialised document loaders. You can call one of these loaders directly to override the order in which Gtk2::Ex::PodViewer searches for documents:
$viewer->load_doc($perldoc);
loads a perldoc file or Perl module documentation, or undef on failure.
$viewer->load_file($file);
loads POD from a file, or returns undef on failure.
$viewer->load_function($function);
This method scans the L<perlfunc> POD document for the documentation for a given function. The algorithm for this is lifted from the L<Pod::Perldoc> module, so it should work identically to C<perldoc -f [function]>.
$viewer->load_string($string);
This method renders the POD data in the C<$string> variable.
=head2 DEPRECATED DOCUMENT LOADERS
The following document loads are now deprecated, and are now just wrapper of the C<load_doc> method:
$viewer->load_perldoc($perldoc);
$viewer->load_module($module);
=cut
sub load_perldoc { $_[0]->load_doc($_[1]) }
sub load_module { $_[0]->load_doc($_[1]) }
sub load_doc {
my ($self, $doc) = @_;
return ($self->{db}->{$doc} ? $self->load_file($self->{db}->{$doc}) : undef);
}
sub load_function {
my ($self, $function) = @_;
my $perlfunc = $self->perlfunc;
return undef if ($perlfunc eq '');
open(PERLFUNC, $perlfunc) or return undef;
# ignore everything up to here:
while (<PERLFUNC>) {
last if /^=head2 Alphabetical Listing of Perl Functions/;
}
# this is lifted straight from Pod/Perldoc.pm, with only a couple
# of modifications:
my $found = 0;
my $inlist = 0;
my $pod = '';
while (<PERLFUNC>) {
if (/^=item\s+\Q$function\E\b/) {
$found = 1;
}
elsif (/^=item/) {
last if $found > 1 and not $inlist;
}
next unless $found;
if (/^=over/) {
++$inlist;
}
elsif (/^=back/) {
--$inlist;
}
$pod .= $_;
++$found if /^\w/;
}
close(PERLFUNC) or return undef;
return undef if ($pod eq '');
$self->load_string($pod);
return 1;
}
sub load_file {
my ($self, $file) = @_;
if (-e $file) {
$self->clear;
$self->parser->clear_marks;
$self->parser->parse_from_file($file);
return 1;
} else {
return undef;
}
}
sub load_string {
my ($self, $string) = @_;
$self->clear;
$self->parser->clear_marks;
$self->parser->parse_from_string($string);
return 1;
}
sub perlfunc {
my $self = shift;
return $self->{perlfunc} if (defined($self->{perlfunc}));
foreach my $dir (@INC) {
my $file = sprintf('%s/pod/perlfunc.pod', $dir);
if (-e $file) {
$self->{perlfunc} = $file;
return $self->{perlfunc};
}
}
}
=pod
$parser = $view->parser;
returns the C<Gtk2::Ex::PodViewer::Parser> object used to render the POD data.
=cut
sub parser {
return $_[0]->{parser};
}
sub clicked {
my ($self, $event) = @_;
my ($x, $y) = $self->window_to_buffer_coords('widget', $event->get_coords);
my $iter = $self->get_iter_at_location($x, $y);
my $text = $self->get_link_text_at_iter($iter);
if (defined($text) && $text ne '') {
$self->signal_emit('link_clicked', $text);
}
return 1;
}
sub get_link_text_at_iter {
my ($self, $iter) = @_;
my $tag = $self->get_buffer->get_tag_table->lookup('link');
if ($iter->has_tag($tag)) {
my $offset = $iter->get_offset;
for (my $i = 0 ; $i < scalar(@{$self->parser->{links}}) ; $i++) {
my ($text, $this_offset) = @{@{$self->parser->{links}}[$i]};
if ($offset >= $this_offset && $offset <= ($this_offset + length($text))) {
return $text;
}
}
}
return undef;
}
=pod
=head1 SIGNALS
Gtk2::Ex::PodViewer inherits all of Gtk2::TextView's signals, and has the following:
=head2 The C<'link_clicked'> signal
$viewer->signal_connect('link_clicked', \&clicked);
sub clicked {
my ($viewer, $link_text) = @_;
print "user clicked on '$link_text'\n";
}
Emitted when the user clicks on a hyperlink within the POD. This may be a section title, a document name, or a URL. The receiving function will be giving two arguments: a reference to the Gtk2::Ex::PodViewer object, and a scalar containing the link text.
=head2 The C<'link_enter'> signal
$viewer->signal_connect('link_enter', \&enter);
sub enter {
my ($viewer, $link_text) = @_;
print "user moused over '$link_text'\n";
}
Emitted when the user moves the mouse pointer over a hyperlink within the POD. This may be a section title, a document name, or a URL. The receiving function will be giving two arguments: a reference to the Gtk2::Ex::PodViewer object, and a scalar containing the link text.
=head2 The C<'link_leave'> signal
$viewer->signal_connect('link_leave', \&leave);
sub clicked {
my $viewer = shift;
print "user moused out\n";
}
Emitted when the user moves the mouse pointer out from a hyperlink within the POD.
=head1 Getting and Setting Font preferences
You can set the font used to render text in a Gtk2::Ex::PodViewer widget like so:
$viewer->modify_font(Gtk2::Pango::FontDescription->from_string($FONT_NAME);
To modify the appearance of the various elements of the page, you need to extract the L<Gtk2::TextTag> from the viewer's buffer:
my $tag = $viewer->get_buffer->get_tag_table->lookup('monospace');
$tag->set('font' => $FONT_NAME);
The tags used by Gtk2::Ex::PodViewer are:
=over
=item C<bold>
Used to format bold text.
=item C<italic>
Used to format italic text.
=item C<head1> ... C<head4>
Used to format headers.
=item C<monospace>
Used to format preformatted text.
=item C<typewriter>
Used to format inline preformatted text.
=item C<link>
Used to format hyperlinks.
=back
=head1 THE podviewer PROGRAM
C<podviewer> is installed with Gtk2::Ex::PodViewer. It is a simple Pod viewing program. It is pretty minimal, but does do the job quite well. Those looking for a more feature-complete documentation browser should try PodBrowser, available from L<http://jodrell.net/projects/podbrowser>.
=head1 BUGS AND TASKS
Gtk2::Ex::PodViewer is a work in progress. All comments, complaints, offers of help and patches are welcomed.
We currently know about these issues:
=over
=item *
When rendering long documents the UI freezes for too long.
=item *
Some strangeness with Unicode.
=back
=head1 PREREQUISITES
=over
=item *
L<Gtk2> (obviously). The most recent version will be from L<http://gtk2-perl.sf.net/>.
=item *
L<Pod::Parser>
=item *
L<IO::Scalar>
=item *
L<Pod::Simple::Search>
=back
L<Gtk2::Ex::PodViewer::Parser>, which is part of the L<Gtk2::Ex::PodViewer> distribution, also requires L<Locale::gettext>.
=head1 SEE ALSO
=over
=item *
L<Gtk2> or L<http://gtk2-perl.sf.net/>
=item *
L<http://developer.gnome.org/doc/API/2.0/gtk/GtkTextView.html>
=item *
L<Gtk2::Ex::PodViewer::Parser>
=back
=head1 AUTHORS
Gavin Brown, Torsten Schoenfeld and Scott Arrington.
=head1 COPYRIGHT
(c) 2003-2005 Gavin Brown (gavin.brown@uk.com). All rights reserved. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
=cut
1;
|