From 681e14b3b823c3e700812b19c1f561e6370df0c4 Mon Sep 17 00:00:00 2001 From: TingPing Date: Mon, 20 Jan 2014 01:14:10 -0500 Subject: Remove unused perl files - old example scripts - outdated docs - mingw build script --- plugins/perl/Makefile.am | 2 +- plugins/perl/alt_completion.pl | 511 --------- plugins/perl/char_count.pl | 101 -- plugins/perl/generate_html | 27 - plugins/perl/lib/Pod/Html.pm | 2399 ---------------------------------------- plugins/perl/lib/Xchat.pod | 1362 ----------------------- plugins/perl/syntax_highlight | 69 -- plugins/perl/xcperl_build.bat | 43 - 8 files changed, 1 insertion(+), 4513 deletions(-) delete mode 100644 plugins/perl/alt_completion.pl delete mode 100644 plugins/perl/char_count.pl delete mode 100644 plugins/perl/generate_html delete mode 100644 plugins/perl/lib/Pod/Html.pm delete mode 100644 plugins/perl/lib/Xchat.pod delete mode 100644 plugins/perl/syntax_highlight delete mode 100644 plugins/perl/xcperl_build.bat (limited to 'plugins/perl') diff --git a/plugins/perl/Makefile.am b/plugins/perl/Makefile.am index b54df005..2b6b8ace 100644 --- a/plugins/perl/Makefile.am +++ b/plugins/perl/Makefile.am @@ -1,5 +1,5 @@ -EXTRA_DIST=alt_completion.pl generate_header lib/HexChat.pm lib/Xchat.pm lib/HexChat/Embed.pm lib/HexChat/List/Network.pm \ +EXTRA_DIST=generate_header lib/HexChat.pm lib/Xchat.pm lib/HexChat/Embed.pm lib/HexChat/List/Network.pm \ lib/HexChat/List/Network/Entry.pm lib/HexChat/List/Network/AutoJoin.pm lib/IRC.pm libdir = $(hexchatlibdir) diff --git a/plugins/perl/alt_completion.pl b/plugins/perl/alt_completion.pl deleted file mode 100644 index 71c1884d..00000000 --- a/plugins/perl/alt_completion.pl +++ /dev/null @@ -1,511 +0,0 @@ -use strict; -use warnings; -use Xchat (); -use File::Spec (); -use File::Basename qw(fileparse); - -# if the last time you addressed someone was greater than this many minutes -# ago, ignore it -# this avoids having people you have talked to a long time ago coming up too -# early in the completion list -# Setting this to 0 will disable the check which is effectively the same as -# setting it to infinity -my $last_use_threshold = 10; # 10 minutes - -# added to the front of a completion the same way as a suffix, only if -# the word is at the beginning of the line -my $prefix = ''; - -# ignore leading non-alphanumeric characters: -[\]^_`{|} -# Assuming you have the following nicks in a channel: -# [SomeNick] _SomeNick_ `SomeNick SomeNick SomeOtherNick -# when $ignore_leading_non_alnum is set to 0 -# s will cycle through SomeNick and SomeOtherNick -# when $ignore_leading_non_alnum is set to 1 -# s will cycle through [SomeNick] _SomeNick_ `SomeNick SomeNick -# SomeOtherNick -my $ignore_leading_non_alnum = 0; - -# enable path completion -my $path_completion = 1; -my $base_path = ''; - -# ignore the completion_amount setting and always cycle through nicks with tab -my $always_cycle = 0; - -Xchat::register( - "Tab Completion", "1.0500", "Alternative tab completion behavior" -); -Xchat::hook_print( "Key Press", \&complete ); -Xchat::hook_print( "Close Context", \&close_context ); -Xchat::hook_print( "Focus Tab", \&focus_tab ); -Xchat::hook_print( "Part", \&clean_selected ); -Xchat::hook_print( "Part with Reason", \&clean_selected ); -Xchat::hook_command( "", \&track_selected ); - -sub SHIFT() { 1 } -sub CTRL() { 4 } -sub ALT() { 8 } - -sub TAB() { 0xFF09 } -sub LEFT_TAB() { 0xFE20 } - -my %completions; -my %last_visit; -my %selected; -my %escape_map = ( - '[' => qr![\[{]!, - '{' => qr![\[{]!, - '}' => qr![\]}]!, - ']' => qr![\]}]!, - '\\' => qr![\\\|]!, - '|' => qr![\\\|]!, - '.' => qr!\.!, - '^' => qr!\^!, - '$' => qr!\$!, - '*' => qr!\*!, - '+' => qr!\+!, - '?' => qr!\?!, - '(' => qr!\(!, - ')' => qr!\)!, - '-' => qr!\-!, -); - -my $escapes = join "", keys %escape_map; -$escapes = qr/[\Q$escapes\E]/; - -# used to determine if a word is the start of a path -my $path_pattern = qr{^(?:~|/|[[:alpha:]]:\\)}; - -sub complete { - my ($key, $modifiers) = @{$_[0]}; - # if $_[0][0] contains the value of the key pressed - # $_[0][1] contains modifiers - # the value for tab is 0xFF09 - # the value for shift-tab(Left Tab) is 0xFE20 - # we don't care about other keys - - # the key must be a tab and left tab - return Xchat::EAT_NONE unless $key == TAB || $key == LEFT_TAB; - - # if it is a tab then it must not have any modifiers - return Xchat::EAT_NONE if $key == TAB && $modifiers & (CTRL|ALT|SHIFT); - - # loop backwards for shift+tab/left tab - my $delta = $modifiers & SHIFT ? -1 : 1; - my $context = Xchat::get_context; - $completions{$context} ||= {}; - - my $completions = $completions{$context}; - $completions->{pos} ||= -1; - - my $suffix = Xchat::get_prefs( "completion_suffix" ); - $suffix =~ s/^\s+//; - - my $input = Xchat::get_info( "inputbox" ); - my $cursor_pos = Xchat::get_info( "state_cursor" ); - my $left = substr( $input, 0, $cursor_pos ); - my $right = substr( $input, $cursor_pos ); - my $length = length $left; - - # trim spaces from the end of $left to avoid grabbing the wrong word - # this is mainly needed for completion at the very beginning where a space - # is added after the completion - $left =~ s/\s+$//; - - # always add one to the index because - # 1) if a space is found we want the position after it - # 2) if a space isn't found then we get back -1 - my $word_start = rindex( $left, " " ) + 1; - my $word = substr( $left, $word_start ); - $left = substr( $left, 0, -length $word ); - - if( $cursor_pos == $completions->{pos} ) { - my $previous_word = $completions->{completed}; - my $new_left = $input; - substr( $new_left, $cursor_pos ) = ""; - - if( $previous_word and $new_left =~ s/(\Q$previous_word\E)$// ) { - $word = $1; - $word_start = length( $new_left ); - $left = $new_left; - } - } - - my $command_char = Xchat::get_prefs( "input_command_char" ); - # ignore commands - if( ($word !~ m{^[${command_char}]}) - or ( $word =~ m{^[${command_char}]} and $word_start != 0 ) ) { - - if( $cursor_pos == length $input # end of input box - # not a valid nick char - && $input =~ /(?{pos} # not continuing a completion - && $word !~ m{^(?:[&#/~]|[[:alpha:]]:\\)} # not a channel or path - ) { - # check for path completion - unless( $path_completion and $word =~ $path_pattern ) { - $word_start = $cursor_pos; - $left = $input; - $length = length $length; - $right = ""; - $word = ""; - } - } - - if( $word_start == 0 && $prefix && $word =~ /^\Q$prefix/ ) { - $word =~ s/^\Q$prefix//; - } - - my $completed; # this is going to be the "completed" word - - # for parital completions and channel names so a : isn't added - #$completions->{skip_suffix} = ($word =~ /^[&#]/) ? 1 : 0; - - # continuing from a previous completion - if( - exists $completions->{matches} && @{$completions->{matches}} - && $cursor_pos == $completions->{pos} - && $word =~ /^\Q$completions->{matches}[$completions->{index}]/ - ) { - $completions->{index} += $delta; - - if( $completions->{index} < 0 ) { - $completions->{index} += @{$completions->{matches}}; - } else { - $completions->{index} %= @{$completions->{matches}}; - } - - } else { - - if( $word =~ /^[&#]/ ) { - # channel name completion - $completions->{matches} = [ matching_channels( $word ) ]; - $completions->{skip_suffix} = 0; - } elsif( $path_completion and $word =~ $path_pattern ) { - # file name completion - $completions->{matches} = [ matching_files( $word ) ]; - $completions->{skip_suffix} = 1; - } else { - # nick completion - # fix $word so { equals [, ] equals }, \ equals | - # and escape regex metacharacters - $word =~ s/($escapes)/$escape_map{$1}/g; - - $completions->{matches} = [ matching_nicks( $word ) ]; - $completions->{skip_suffix} = 0; - } - $completions->{index} = 0; - - } - $completed = $completions->{matches}[ $completions->{index} ]; - $completions->{completed} = $completed; - - my $completion_amount = Xchat::get_prefs( "completion_amount" ); - - # don't cycle if the number of possible completions is greater than - # completion_amount - if( - !$always_cycle && ( - @{$completions->{matches}} > $completion_amount - && @{$completions->{matches}} != 1 ) - ) { - # don't print if we tabbed in the beginning and the list of possible - # completions includes all nicks in the channel - my $context_type = Xchat::context_info->{type}; - if( $context_type != 2 # not a channel - or @{$completions->{matches}} < Xchat::get_list("users") - ) { - Xchat::print( join " ", @{$completions->{matches}}, "\n" ); - } - - $completed = lcs( $completions->{matches} ); - $completions->{skip_suffix} = 1; - } - - if( $completed ) { - - if( $word_start == 0 && !$completions->{skip_suffix} ) { - # at the start of the line append completion suffix - Xchat::command( "settext $prefix$completed$suffix$right"); - $completions->{pos} = length( "$prefix$completed$suffix" ); - } else { - Xchat::command( "settext $left$completed$right" ); - $completions->{pos} = length( "$left$completed" ); - } - - Xchat::command( "setcursor $completions->{pos}" ); - } - -=begin -# debugging stuff - local $, = " "; - my $input_length = length $input; - Xchat::print [ - qq{input[$input]}, - qq{input_length[$input_length]}, - qq{cursor[$cursor_pos]}, - qq{start[$word_start]}, - qq{length[$length]}, - qq{left[$left]}, - qq{word[$word]}, qq{right[$right]}, - qq{completed[}. ($completed||""). qq{]}, - qq{pos[$completions->{pos}]}, - ]; - use Data::Dumper; - local $Data::Dumper::Indent = 0; - Xchat::print Dumper $completions->{matches}; -=cut - - return Xchat::EAT_ALL; - } else { - return Xchat::EAT_NONE; - } -} - - -# all channels starting with $word -sub matching_channels { - my $word = shift; - - # for use in compare_channels(); - our $current_chan; - local $current_chan = Xchat::get_info( "channel" ); - - my $conn_id = Xchat::get_info( "id" ); - $word =~ s/^[&#]+//; - - return - map { $_->[1]->{channel} } - sort compare_channels map { - my $chan = $_->{channel}; - $chan =~ s/^[#&]+//; - - # comparisons will be done based only on the name - # matching name, same connection, only channels - $chan =~ /^$word/i && $_->{id} == $conn_id ? - [ $chan, $_ ] : - () - } channels(); -} - -sub channels { - return grep { $_->{type} == 2 } Xchat::get_list( "channels" ); -} - -sub compare_channels { - # package variable, value set in matching_channels() - our $current_chan; - - # turn off warnings generated from channels that have not yet been visited - # since the script was loaded - no warnings "uninitialized"; - - # the current channel is always first, then ordered by most recently visited - return - $a->[1]{channel} eq $current_chan ? -1 : - $b->[1]{channel} eq $current_chan ? 1 : - $last_visit{ $b->[1]{context} } <=> $last_visit{ $a->[1]{context} } - || $a->[1]{channel} cmp $b->[1]{channel}; - -} - -sub matching_nicks { - my $word_re = shift; - - # for use in compare_nicks() - our ($my_nick, $selections, $now); - local $my_nick = Xchat::get_info( "nick" ); - local $selections = $selected{ Xchat::get_context() }; - local $now = time; - - my $pattern = $ignore_leading_non_alnum ? - qr/^[\-\[\]^_`{|}\\]*$word_re/i : qr/^$word_re/i; - return - map { $_->{nick} } - sort compare_nicks grep { - $_->{nick} =~ $pattern; - } Xchat::get_list( "users" ) - -} - -sub max { - return unless @_; - my $max = shift; - for(@_) { - $max = $_ if $_ > $max; - } - return $max; -} - -sub compare_times { - # package variables set in matching_nicks() - our $selections; - our $now; - - for my $nick ( $a->{nick}, $b->{nick} ) { - # turn off the warnings that get generated from users who have yet - # to speak since the script was loaded - no warnings "uninitialized"; - - if( $last_use_threshold - && (( $now - $selections->{$nick}) > ($last_use_threshold * 60)) ) { - delete $selections->{ $nick } - } - } - my $a_time = $selections->{ $a->{nick} } || 0 ; - my $b_time = $selections->{ $b->{nick} } || 0 ; - - if( $a_time || $b_time ) { - return $b_time <=> $a_time; - } elsif( !$a_time && !$b_time ) { - return $b->{lasttalk} <=> $a->{lasttalk}; - } - -} - -sub compare_nicks { - # more package variables, value set in matching_nicks() - our $my_nick; - - # our own nick is always last, then ordered by the people we spoke to most - # recently and the people who were speaking most recently - return - $a->{nick} eq $my_nick ? 1 : - $b->{nick} eq $my_nick ? -1 : - compare_times() - || Xchat::nickcmp( $a->{nick}, $b->{nick} ); - -# $selections->{ $b->{nick} } <=> $selections->{ $a->{nick} } -# || $b->{lasttalk} <=> $a->{lasttalk} - -} - -sub matching_files { - my $word = shift; - - my ($file, $input_dir) = fileparse( $word ); - - my $dir = expand_tilde( $input_dir ); - - if( opendir my $dir_handle, $dir ) { - my @files; - - if( $file ) { - @files = grep { - #Xchat::print( $_ ); - /^\Q$file/ } readdir $dir_handle; - } else { - @files = readdir $dir_handle; - } - - return map { - File::Spec->catfile( $input_dir, $_ ); - } sort - grep { !/^[.]{1,2}$/ } @files; - } else { - return (); - } -} - -# Remove completion related data for tabs that are closed -sub close_context { - my $context = Xchat::get_context; - delete $completions{$context}; - delete $last_visit{$context}; - return Xchat::EAT_NONE; -} - -# track visit times -sub focus_tab { - $last_visit{Xchat::get_context()} = time(); - return Xchat::EAT_NONE; -} - -# keep track of the last time a message was addressed to someone -# a message is considered addressed to someone if their nick is used followed -# by the completion suffix -sub track_selected { - my $input = $_[1][0]; - return Xchat::EAT_NONE unless defined $input; - - my $suffix = Xchat::get_prefs( "completion_suffix" ); - for( grep defined, $input =~ /^(.+)\Q$suffix/, $_[0][0] ) { - if( in_channel( $_ ) ) { - $selected{Xchat::get_context()}{$_} = time(); - last; - } - } - - return Xchat::EAT_NONE; -} - -# if a user is in the current channel -# user_info() can also be used instead of the loop -sub in_channel { - my $target = shift; - for my $nick ( nicks() ) { - if( $nick eq $target ) { - return 1; - } - } - - return 0; -} - -# list of nicks in the current channel -sub nicks { - return map { $_->{nick} } Xchat::get_list( "users" ); -} - -# remove people from the selected list when they leave the channel -sub clean_selected { - delete $selected{ Xchat::get_context() }{$_[0][0]}; - return Xchat::EAT_NONE; -} - -# Longest common substring -# Used for partial completion when using non-cycling completion -sub lcs { - my @nicks = @{+shift}; - return "" if @nicks == 0; - return $nicks[0] if @nicks == 1; - - my $substring = shift @nicks; - - while(@nicks) { - $substring = common_string( $substring, shift @nicks ); - } - - return $substring; -} - -sub common_string { - my ($nick1, $nick2) = @_; - my $index = 0; - - $index++ while( - ($index < length $nick1) && ($index < length $nick2) && - lc(substr( $nick1, $index, 1 )) eq lc(substr( $nick2, $index, 1 )) - ); - - - return substr( $nick1, 0, $index ); -} - -sub expand_tilde { - my $file = shift; - - $file =~ s/^~/home_dir()/e; - return $file; -} - -sub home_dir { - return $base_path if $base_path; - - if ( $^O eq "MSWin32" ) { - return $ENV{USERPROFILE}; - } else { - return ((getpwuid($>))[7] || $ENV{HOME} || $ENV{LOGDIR}); - } -} diff --git a/plugins/perl/char_count.pl b/plugins/perl/char_count.pl deleted file mode 100644 index 418046f4..00000000 --- a/plugins/perl/char_count.pl +++ /dev/null @@ -1,101 +0,0 @@ - -use strict; -use warnings; -use Xchat qw(:all); -use Glib qw(TRUE FALSE); -use Gtk2 -init; - -sub get_inputbox { - my $widget = Glib::Object->new_from_pointer( get_info( "win_ptr" ), 0 ); - my $input_box; - - my @containers = ($widget); - - while( @containers ) { - my $container = shift @containers; - - for my $child ( $container->get_children ) { - if( $child->get( "name" ) eq 'xchat-inputbox' ) { - $input_box = $child; - last; - } elsif( $child->isa( "Gtk2::Container" ) ) { - push @containers, $child; - } - } - } - return $input_box; -} - -sub get_hbox { - my $widget = shift; - my $hbox; - - while( $widget->parent ) { - if( $widget->parent->isa( "Gtk2::HBox" ) ) { - return $widget->parent; - } - $widget = $widget->parent; - } - -} - -my $input_box = get_inputbox(); - -if( $input_box ) { - my $hbox = get_hbox( $input_box ); - if( $hbox ) { - my $label = Gtk2::Label->new(); - $label->set_alignment( 0.5, ($label->get_alignment)[1] ); - $hbox->pack_end( $label, 0, 0, 5 ); - $label->show(); - - my $update_label = sub { - my $ctx_type = context_info->{"type"}; - hook_timer( 0, sub { - if( $ctx_type == 2 || $ctx_type == 3 ) { - my $count = length get_info "inputbox"; - $label->set_text( $count ? $count : "" ); - } else { - $label->set_text( "" ); - } - return REMOVE; - }); - return EAT_NONE; - }; - - hook_print( "Key Press", $update_label ); - hook_print( "Focus Tab", $update_label ); - hook_print( "Focus Window", $update_label ); - hook_command( "", - sub { - $label->set_text( "" ); - return EAT_NONE; - } - ); - - my @handlers; - my $buffer = $input_box->get_buffer; - my $handler = sub { $update_label->(); return TRUE }; - - if( $buffer->isa( "Gtk2::TextBuffer" ) ) { - push @handlers, $buffer->signal_connect( "changed", $handler ); - } elsif( $buffer->isa( "Gtk2::EntryBuffer" ) ) { - push @handlers, - $buffer->signal_connect( "deleted-text", $handler ); - $buffer->signal_connect( "inserted-text", $handler ); - } - - register( "Character Counter", "1.0.0", - "Display the number of characters in the inputbox", - sub { - $hbox->remove( $label ); - $buffer->signal_handler_disconnect( $_ ) for @handlers; - } - ); - } else { - prnt "Counldn't find hbox"; - } - -} else { - prnt "Couldn't fint input box"; -} diff --git a/plugins/perl/generate_html b/plugins/perl/generate_html deleted file mode 100644 index c144ce7e..00000000 --- a/plugins/perl/generate_html +++ /dev/null @@ -1,27 +0,0 @@ -#!/usr/bin/env perl -use strict; -use warnings; -use File::Basename qw(dirname); - -sub __DIR__ { - return dirname +(caller 0)[1]; -} - -# this must go before use Pod::Html to use our private copy -use lib __DIR__ . '/lib'; -use Pod::Html; - -chdir( __DIR__ ) or die $!; -pod2html( -# "pod2html", - "--header", - "--infile=lib/Xchat.pod", - "--outfile=xchat2-perl.html", -); - -#system( qw(tidy -m -i -xml -utf8 -quiet xchat2-perl.html) ); -unlink( "pod2htmd.tmp" ); -unlink( "pod2htmi.tmp" ); - -exec( "./syntax_highlight", "xchat2-perl.html" ) - or die $!; diff --git a/plugins/perl/lib/Pod/Html.pm b/plugins/perl/lib/Pod/Html.pm deleted file mode 100644 index 3695564b..00000000 --- a/plugins/perl/lib/Pod/Html.pm +++ /dev/null @@ -1,2399 +0,0 @@ -package Pod::Html; -use strict; -require Exporter; - -use vars qw($VERSION @ISA @EXPORT @EXPORT_OK); -$VERSION = 1.08; -@ISA = qw(Exporter); -@EXPORT = qw(pod2html htmlify); -@EXPORT_OK = qw(anchorify); - -use Carp; -use Config; -use Cwd; -use File::Spec; -use File::Spec::Unix; -use Getopt::Long; - -use locale; # make \w work right in non-ASCII lands - -=head1 NAME - -Pod::Html - module to convert pod files to HTML - -=head1 SYNOPSIS - - use Pod::Html; - pod2html([options]); - -=head1 DESCRIPTION - -Converts files from pod format (see L) to HTML format. It -can automatically generate indexes and cross-references, and it keeps -a cache of things it knows how to cross-reference. - -=head1 FUNCTIONS - -=head2 pod2html - - pod2html("pod2html", - "--podpath=lib:ext:pod:vms", - "--podroot=/usr/src/perl", - "--htmlroot=/perl/nmanual", - "--libpods=perlfunc:perlguts:perlvar:perlrun:perlop", - "--recurse", - "--infile=foo.pod", - "--outfile=/perl/nmanual/foo.html"); - -pod2html takes the following arguments: - -=over 4 - -=item backlink - - --backlink="Back to Top" - -Adds "Back to Top" links in front of every C heading (except for -the first). By default, no backlinks are generated. - -=item cachedir - - --cachedir=name - -Creates the item and directory caches in the given directory. - -=item css - - --css=stylesheet - -Specify the URL of a cascading style sheet. Also disables all HTML/CSS -C - - - -$block -END_OF_HEAD - - # load/reload/validate/cache %Pages and %Items - get_cache( $Dircache, $Itemcache, \@Podpath, $Podroot, $Recurse ); - - # scan the pod for =item directives - scan_items( \%Local_Items, "", @poddata ); - - # put an index at the top of the file. note, if $Doindex is 0 we - # still generate an index, but surround it with an html comment. - # that way some other program can extract it if desired. - $index =~ s/--+/-/g; - - my $hr = ( $Doindex and $index ) ? qq(
) : ""; - - unless ($Doindex) { - $index = qq(\n); - } - - print HTML << "END_OF_INDEX"; - - -
-

-$index -$hr -
- - -END_OF_INDEX - - # now convert this file - my $after_item; # set to true after an =item - my $need_dd = 0; - warn "Converting input file $Podfile\n" if $Verbose; - foreach my $i ( 0 .. $#poddata ) { - $_ = $poddata[$i]; - $Paragraph = $i + 1; - if (/^(=.*)/s) { # is it a pod directive? - $Ignore = 0; - $after_item = 0; - $need_dd = 0; - $_ = $1; - if (/^=begin\s+(\S+)\s*(.*)/si) { # =begin - process_begin( $1, $2 ); - } elsif (/^=end\s+(\S+)\s*(.*)/si) { # =end - process_end( $1, $2 ); - } elsif (/^=cut/) { # =cut - process_cut(); - } elsif (/^=pod/) { # =pod - process_pod(); - } else { - next if @Begin_Stack && $Begin_Stack[-1] ne 'html'; - - if (/^=(head[1-6])\s+(.*\S)/s) { # =head[1-6] heading - process_head( $1, $2, $Doindex && $index ); - } elsif (/^=item\s*(.*\S)?/sm) { # =item text - $need_dd = process_item($1); - $after_item = 1; - } elsif (/^=over\s*(.*)/) { # =over N - process_over(); - } elsif (/^=back/) { # =back - process_back($need_dd); - } elsif (/^=for\s+(\S+)\s*(.*)/si) { # =for - process_for( $1, $2 ); - } else { - /^=(\S*)\s*/; - warn "$0: $Podfile: unknown pod directive '$1' in " - . "paragraph $Paragraph. ignoring.\n" - unless $Quiet; - } - } - $Top = 0; - } else { - next if $Ignore; - next if @Begin_Stack && $Begin_Stack[-1] ne 'html'; - print HTML and next if @Begin_Stack && $Begin_Stack[-1] eq 'html'; - print HTML "
\n" if $need_dd; - my $text = $_; - if ( $text =~ /\A\s+/ ) { - process_pre( \$text ); - print HTML "
\n$text
\n"; - - } else { - process_text( \$text ); - - # experimental: check for a paragraph where all lines - # have some ...\t...\t...\n pattern - if ( $text =~ /\t/ ) { - my @lines = split( "\n", $text ); - if ( @lines > 1 ) { - my $all = 2; - foreach my $line (@lines) { - if ( $line =~ /\S/ && $line !~ /\t/ ) { - $all--; - last if $all == 0; - } - } - if ( $all > 0 ) { - $text =~ s/\t+//g; - $text =~ s/^//gm; - $text = - '' - . $text - . '
'; - } - } - } - ## end of experimental - - if ($after_item) { - $After_Lpar = 1; - } - print HTML "

$text

\n"; - } - print HTML "
\n" if $need_dd; - $after_item = 0; - } - } - - # finish off any pending directives - finish_list(); - - # link to page index - print HTML "

$Backlink

\n" - if $Doindex - and $index - and $Backlink; - - print HTML < - - -END_OF_TAIL - - # close the html file - close(HTML); - - warn "Finished\n" if $Verbose; -} - -############################################################################## - -sub usage { - my $podfile = shift; - warn "$0: $podfile: @_\n" if @_; - die < --infile= --outfile= - --podpath=:...: --podroot= - --libpods=:...: --recurse --verbose --index - --netscape --norecurse --noindex --cachedir= - - --backlink - set text for "back to top" links (default: none). - --cachedir - directory for the item and directory cache files. - --css - stylesheet URL - --flush - flushes the item and directory caches. - --[no]header - produce block header/footer (default is no headers). - --help - prints this message. - --hiddendirs - search hidden directories in podpath - --htmldir - directory for resulting HTML files. - --htmlroot - http-server base directory from which all relative paths - in podpath stem (default is /). - --[no]index - generate an index at the top of the resulting html - (default behaviour). - --infile - filename for the pod to convert (input taken from stdin - by default). - --libpods - colon-separated list of pages to search for =item pod - directives in as targets of C<> and implicit links (empty - by default). note, these are not filenames, but rather - page names like those that appear in L<> links. - --outfile - filename for the resulting html file (output sent to - stdout by default). - --podpath - colon-separated list of directories containing library - pods (empty by default). - --podroot - filesystem base directory from which all relative paths - in podpath stem (default is .). - --[no]quiet - suppress some benign warning messages (default is off). - --[no]recurse - recurse on those subdirectories listed in podpath - (default behaviour). - --title - title that will appear in resulting html file. - --[no]verbose - self-explanatory (off by default). - --[no]netscape - deprecated, has no effect. for backwards compatibility only. - -END_OF_USAGE - -} - -sub parse_command_line { - my ( - $opt_backlink, $opt_cachedir, $opt_css, $opt_flush, - $opt_header, $opt_help, $opt_htmldir, $opt_htmlroot, - $opt_index, $opt_infile, $opt_libpods, $opt_netscape, - $opt_outfile, $opt_podpath, $opt_podroot, $opt_quiet, - $opt_recurse, $opt_title, $opt_verbose, $opt_hiddendirs - ); - - unshift @ARGV, split ' ', $Config{pod2html} if $Config{pod2html}; - my $result = GetOptions( - 'backlink=s' => \$opt_backlink, - 'cachedir=s' => \$opt_cachedir, - 'css=s' => \$opt_css, - 'flush' => \$opt_flush, - 'header!' => \$opt_header, - 'help' => \$opt_help, - 'hiddendirs!' => \$opt_hiddendirs, - 'htmldir=s' => \$opt_htmldir, - 'htmlroot=s' => \$opt_htmlroot, - 'index!' => \$opt_index, - 'infile=s' => \$opt_infile, - 'libpods=s' => \$opt_libpods, - 'netscape!' => \$opt_netscape, - 'outfile=s' => \$opt_outfile, - 'podpath=s' => \$opt_podpath, - 'podroot=s' => \$opt_podroot, - 'quiet!' => \$opt_quiet, - 'recurse!' => \$opt_recurse, - 'title=s' => \$opt_title, - 'verbose!' => \$opt_verbose, - ); - usage( "-", "invalid parameters" ) if not $result; - - usage("-") if defined $opt_help; # see if the user asked for help - $opt_help = ""; # just to make -w shut-up. - - @Podpath = split( ":", $opt_podpath ) if defined $opt_podpath; - @Libpods = split( ":", $opt_libpods ) if defined $opt_libpods; - - $Backlink = $opt_backlink if defined $opt_backlink; - $Cachedir = $opt_cachedir if defined $opt_cachedir; - $Css = $opt_css if defined $opt_css; - $Header = $opt_header if defined $opt_header; - $Htmldir = $opt_htmldir if defined $opt_htmldir; - $Htmlroot = $opt_htmlroot if defined $opt_htmlroot; - $Doindex = $opt_index if defined $opt_index; - $Podfile = $opt_infile if defined $opt_infile; - $HiddenDirs = $opt_hiddendirs if defined $opt_hiddendirs; - $Htmlfile = $opt_outfile if defined $opt_outfile; - $Podroot = $opt_podroot if defined $opt_podroot; - $Quiet = $opt_quiet if defined $opt_quiet; - $Recurse = $opt_recurse if defined $opt_recurse; - $Title = $opt_title if defined $opt_title; - $Verbose = $opt_verbose if defined $opt_verbose; - - warn "Flushing item and directory caches\n" - if $opt_verbose && defined $opt_flush; - $Dircache = "$Cachedir/pod2htmd.tmp"; - $Itemcache = "$Cachedir/pod2htmi.tmp"; - if ( defined $opt_flush ) { - 1 while unlink( $Dircache, $Itemcache ); - } -} - -my $Saved_Cache_Key; - -sub get_cache { - my ( $dircache, $itemcache, $podpath, $podroot, $recurse ) = @_; - my @cache_key_args = @_; - - # A first-level cache: - # Don't bother reading the cache files if they still apply - # and haven't changed since we last read them. - - my $this_cache_key = cache_key(@cache_key_args); - - return if $Saved_Cache_Key and $this_cache_key eq $Saved_Cache_Key; - - # load the cache of %Pages and %Items if possible. $tests will be - # non-zero if successful. - my $tests = 0; - if ( -f $dircache && -f $itemcache ) { - warn "scanning for item cache\n" if $Verbose; - $tests = load_cache( $dircache, $itemcache, $podpath, $podroot ); - } - - # if we didn't succeed in loading the cache then we must (re)build - # %Pages and %Items. - if ( !$tests ) { - warn "scanning directories in pod-path\n" if $Verbose; - scan_podpath( $podroot, $recurse, 0 ); - } - $Saved_Cache_Key = cache_key(@cache_key_args); -} - -sub cache_key { - my ( $dircache, $itemcache, $podpath, $podroot, $recurse ) = @_; - return join( '!', - $dircache, $itemcache, $recurse, @$podpath, $podroot, stat($dircache), - stat($itemcache) ); -} - -# -# load_cache - tries to find if the caches stored in $dircache and $itemcache -# are valid caches of %Pages and %Items. if they are valid then it loads -# them and returns a non-zero value. -# -sub load_cache { - my ( $dircache, $itemcache, $podpath, $podroot ) = @_; - my ($tests); - local $_; - - $tests = 0; - - open( CACHE, "<$itemcache" ) - || die "$0: error opening $itemcache for reading: $!\n"; - $/ = "\n"; - - # is it the same podpath? - $_ = ; - chomp($_); - $tests++ if ( join( ":", @$podpath ) eq $_ ); - - # is it the same podroot? - $_ = ; - chomp($_); - $tests++ if ( $podroot eq $_ ); - - # load the cache if its good - if ( $tests != 2 ) { - close(CACHE); - return 0; - } - - warn "loading item cache\n" if $Verbose; - while () { - /(.*?) (.*)$/; - $Items{$1} = $2; - } - close(CACHE); - - warn "scanning for directory cache\n" if $Verbose; - open( CACHE, "<$dircache" ) - || die "$0: error opening $dircache for reading: $!\n"; - $/ = "\n"; - $tests = 0; - - # is it the same podpath? - $_ = ; - chomp($_); - $tests++ if ( join( ":", @$podpath ) eq $_ ); - - # is it the same podroot? - $_ = ; - chomp($_); - $tests++ if ( $podroot eq $_ ); - - # load the cache if its good - if ( $tests != 2 ) { - close(CACHE); - return 0; - } - - warn "loading directory cache\n" if $Verbose; - while () { - /(.*?) (.*)$/; - $Pages{$1} = $2; - } - - close(CACHE); - - return 1; -} - -# -# scan_podpath - scans the directories specified in @podpath for directories, -# .pod files, and .pm files. it also scans the pod files specified in -# @Libpods for =item directives. -# -sub scan_podpath { - my ( $podroot, $recurse, $append ) = @_; - my ( $pwd, $dir ); - my ( $libpod, $dirname, $pod, @files, @poddata ); - - unless ($append) { - %Items = (); - %Pages = (); - } - - # scan each directory listed in @Podpath - $pwd = getcwd(); - chdir($podroot) - || die "$0: error changing to directory $podroot: $!\n"; - foreach $dir (@Podpath) { - scan_dir( $dir, $recurse ); - } - - # scan the pods listed in @Libpods for =item directives - foreach $libpod (@Libpods) { - - # if the page isn't defined then we won't know where to find it - # on the system. - next unless defined $Pages{$libpod} && $Pages{$libpod}; - - # if there is a directory then use the .pod and .pm files within it. - # NOTE: Only finds the first so-named directory in the tree. - # if ($Pages{$libpod} =~ /([^:]*[^(\.pod|\.pm)]):/) { - if ( $Pages{$libpod} =~ /([^:]*(?; - close(POD); - clean_data( \@poddata ); - - scan_items( \%Items, "$dirname/$pod", @poddata ); - } - - # use the names of files as =item directives too. -### Don't think this should be done this way - confuses issues.(WL) -### foreach $pod (@files) { -### $pod =~ /^(.*)(\.pod|\.pm)$/; -### $Items{$1} = "$dirname/$1.html" if $1; -### } - } elsif ( $Pages{$libpod} =~ /([^:]*\.pod):/ - || $Pages{$libpod} =~ /([^:]*\.pm):/ ) - { - - # scan the .pod or .pm file for =item directives - $pod = $1; - open( POD, "<$pod" ) - || die "$0: error opening $pod for input: $!\n"; - @poddata = ; - close(POD); - clean_data( \@poddata ); - - scan_items( \%Items, "$pod", @poddata ); - } else { - warn "$0: shouldn't be here (line " . __LINE__ . "\n" unless $Quiet; - } - } - @poddata = (); # clean-up a bit - - chdir($pwd) - || die "$0: error changing to directory $pwd: $!\n"; - - # cache the item list for later use - warn "caching items for later use\n" if $Verbose; - open( CACHE, ">$Itemcache" ) - || die "$0: error open $Itemcache for writing: $!\n"; - - print CACHE join( ":", @Podpath ) . "\n$podroot\n"; - foreach my $key ( keys %Items ) { - print CACHE "$key $Items{$key}\n"; - } - - close(CACHE); - - # cache the directory list for later use - warn "caching directories for later use\n" if $Verbose; - open( CACHE, ">$Dircache" ) - || die "$0: error open $Dircache for writing: $!\n"; - - print CACHE join( ":", @Podpath ) . "\n$podroot\n"; - foreach my $key ( keys %Pages ) { - print CACHE "$key $Pages{$key}\n"; - } - - close(CACHE); -} - -# -# scan_dir - scans the directory specified in $dir for subdirectories, .pod -# files, and .pm files. notes those that it finds. this information will -# be used later in order to figure out where the pages specified in L<> -# links are on the filesystem. -# -sub scan_dir { - my ( $dir, $recurse ) = @_; - my ( $t, @subdirs, @pods, $pod, $dirname, @dirs ); - local $_; - - @subdirs = (); - @pods = (); - - opendir( DIR, $dir ) - || die "$0: error opening directory $dir: $!\n"; - while ( defined( $_ = readdir(DIR) ) ) { - if ( -d "$dir/$_" - && $_ ne "." - && $_ ne ".." - && ( $HiddenDirs || !/^\./ ) ) - { # directory - $Pages{$_} = "" unless defined $Pages{$_}; - $Pages{$_} .= "$dir/$_:"; - push( @subdirs, $_ ); - } elsif (/\.pod\z/) { # .pod - s/\.pod\z//; - $Pages{$_} = "" unless defined $Pages{$_}; - $Pages{$_} .= "$dir/$_.pod:"; - push( @pods, "$dir/$_.pod" ); - } elsif (/\.html\z/) { # .html - s/\.html\z//; - $Pages{$_} = "" unless defined $Pages{$_}; - $Pages{$_} .= "$dir/$_.pod:"; - } elsif (/\.pm\z/) { # .pm - s/\.pm\z//; - $Pages{$_} = "" unless defined $Pages{$_}; - $Pages{$_} .= "$dir/$_.pm:"; - push( @pods, "$dir/$_.pm" ); - } elsif ( -T "$dir/$_" ) { # script(?) - local *F; - if ( open( F, "$dir/$_" ) ) { - my $line; - while ( defined( $line = ) ) { - if ( $line =~ /^=(?:pod|head1)/ ) { - $Pages{$_} = "" unless defined $Pages{$_}; - $Pages{$_} .= "$dir/$_.pod:"; - last; - } - } - close(F); - } - } - } - closedir(DIR); - - # recurse on the subdirectories if necessary - if ($recurse) { - foreach my $subdir (@subdirs) { - scan_dir( "$dir/$subdir", $recurse ); - } - } -} - -# -# scan_headings - scan a pod file for head[1-6] tags, note the tags, and -# build an index. -# -sub scan_headings { - my ( $sections, @data ) = @_; - my ( $tag, $which_head, $otitle, $listdepth, $index ); - - local $Ignore = 0; - - $listdepth = 0; - $index = ""; - - # scan for =head directives, note their name, and build an index - # pointing to each of them. - foreach my $line (@data) { - if ( $line =~ /^=(head)([1-6])\s+(.*)/ ) { - ( $tag, $which_head, $otitle ) = ( $1, $2, $3 ); - - my $title = depod($otitle); - my $name = anchorify($title); - $$sections{$name} = 1; - $title = process_text( \$otitle ); - - while ( $which_head != $listdepth ) { - if ( $which_head > $listdepth ) { - $index .= "\n" - . ( "\t" x ($listdepth) ) - . ( $listdepth > 0 ? qq{
  • \n} - . "\t"x($listdepth + 1): "" ) - . "
      "; - $listdepth++; - } elsif ( $which_head < $listdepth ) { - $listdepth--; - $index .= "\n" - . ( "\t" x $listdepth ) - . ( $listdepth > 0 ? "\t" : "" ) - . "
    " - . ( $listdepth >= 0 ? "\n" . ("\t"x$listdepth) - . "
  • " : "" ) - . "\n"; - } - } - - $index .= "\n" - . ( "\t" x $listdepth ) . "
  • " - . "" - . $title - . "
  • "; - } - } - - # finish off the lists - while ( $listdepth-- ) { - $index .= "\n" . ( "\t" x $listdepth ) - . ($listdepth > 0 ? "\t" : "") - ."\n" - . ($listdepth > 0 ? ("\t" x $listdepth) . "" : "" ); - } - - # get rid of bogus lists - $index =~ s,\t*
      \s*
    \n,,g; - - return $index; -} - -# -# scan_items - scans the pod specified by $pod for =item directives. we -# will use this information later on in resolving C<> links. -# -sub scan_items { - my ( $itemref, $pod, @poddata ) = @_; - my ( $i, $item ); - local $_; - - $pod =~ s/\.pod\z//; - $pod .= ".html" if $pod; - - foreach $i ( 0 .. $#poddata ) { - my $txt = depod( $poddata[$i] ); - - # figure out what kind of item it is. - # Build string for referencing this item. - if ( $txt =~ /\A=item\s+\*\s*(.*)\Z/s ) { # bullet - next unless $1; - $item = $1; - } elsif ( $txt =~ /\A=item\s+(?>\d+\.?)\s*(.*)\Z/s ) { # numbered list - $item = $1; - } elsif ( $txt =~ /\A=item\s+(.*)\Z/s ) { # plain item - $item = $1; - } else { - next; - } - my $fid = fragment_id($item); - $$itemref{$fid} = "$pod" if $fid; - } -} - -# -# process_head - convert a pod head[1-6] tag and convert it to HTML format. -# -sub process_head { - my ( $tag, $heading, $hasindex ) = @_; - - # figure out the level of the =head - $tag =~ /head([1-6])/; - my $level = $1; - - if ($Listlevel) { - warn -"$0: $Podfile: unterminated list at =head in paragraph $Paragraph. ignoring.\n" - unless $Quiet; - while ($Listlevel) { - process_back(); - } - } - - print HTML "

    \n"; - if ( $level == 1 && !$Top ) { - print HTML "$Backlink\n" - if $hasindex and $Backlink; - print HTML "

    \n
    \n"; - } else { - print HTML "

    \n"; - } - - my $name = anchorify( depod($heading) ); - my $convert = process_text( \$heading ); - $convert =~ s{]+>}{}g; - print HTML "$convert\n"; -} - -# -# emit_item_tag - print an =item's text -# Note: The global $EmittedItem is used for inhibiting self-references. -# -my $EmittedItem; - -sub emit_item_tag($$$) { - my ( $otext, $text, $compact ) = @_; - my $item = fragment_id( depod($text), -generate ); - Carp::confess( "Undefined fragment '$text' (" - . depod($text) - . ") from fragment_id() in emit_item_tag() in $Podfile" ) - if !defined $item; - $EmittedItem = $item; - ### print STDERR "emit_item_tag=$item ($text)\n"; - - print HTML ''; - if ( $Items_Named{$item}++ ) { - print HTML process_text( \$otext ); - } else { - my $name = $item; - $name = anchorify($name); - print HTML -#qq{}, - process_text( \$otext ), - # '' - ; - } - print HTML "\n"; - undef($EmittedItem); -} - -sub emit_li { - my ($tag) = @_; - if ( $Items_Seen[$Listlevel]++ == 0 ) { - push( @Listend, "" ); - print HTML "<$tag>\n"; - } - my $emitted = $tag eq 'dl' ? 'dt' : 'li'; - print HTML "<$emitted>"; - return $emitted; -} - -# -# process_item - convert a pod item tag and convert it to HTML format. -# -sub process_item { - my ($otext) = @_; - my $need_dd = 0; # set to 1 if we need a
    after an item - - # lots of documents start a list without doing an =over. this is - # bad! but, the proper thing to do seems to be to just assume - # they did do an =over. so warn them once and then continue. - if ( $Listlevel == 0 ) { - warn -"$0: $Podfile: unexpected =item directive in paragraph $Paragraph. ignoring.\n" - unless $Quiet; - process_over(); - } - - # formatting: insert a paragraph if preceding item has >1 paragraph - if ($After_Lpar) { - print HTML $need_dd ? "\n" : "\n" if $After_Lpar; - $After_Lpar = 0; - } - - # remove formatting instructions from the text - my $text = depod($otext); - - my $emitted; # the tag actually emitted, used for closing - - # all the list variants: - if ( $text =~ /\A\*/ ) { # bullet - $emitted = emit_li('ul'); - if ( $text =~ /\A\*\s+(\S.*)\Z/s ) { # with additional text - my $tag = $1; - $otext =~ s/\A\*\s+//; - emit_item_tag( $otext, $tag, 1 ); - } - print HTML "" - } elsif ( $text =~ /\A\d+/ ) { # numbered list - $emitted = emit_li('ol'); - if ( $text =~ /\A(?>\d+\.?)\s*(\S.*)\Z/s ) { # with additional text - my $tag = $1; - $otext =~ s/\A\d+\.?\s*//; - emit_item_tag( $otext, $tag, 1 ); - } - print HTML ""; - } else { # definition list - $emitted = emit_li('dl'); - if ( $text =~ /\A(.+)\Z/s ) { # should have text - emit_item_tag( $otext, $text, 1 ); - } - $need_dd = 1; - } - print HTML "\n"; - return $need_dd; -} - -# -# process_over - process a pod over tag and start a corresponding HTML list. -# -sub process_over { - - # start a new list - $Listlevel++; - push( @Items_Seen, 0 ); - $After_Lpar = 0; -} - -# -# process_back - process a pod back tag and convert it to HTML format. -# -sub process_back { - my $need_dd = shift; - if ( $Listlevel == 0 ) { - warn -"$0: $Podfile: unexpected =back directive in paragraph $Paragraph. ignoring.\n" - unless $Quiet; - return; - } - - # close off the list. note, I check to see if $Listend[$Listlevel] is - # defined because an =item directive may have never appeared and thus - # $Listend[$Listlevel] may have never been initialized. - $Listlevel--; - if ( defined $Listend[$Listlevel] ) { - print HTML $need_dd ? "\n" : "\n" if $After_Lpar; - print HTML $Listend[$Listlevel]; - print HTML "\n"; - pop(@Listend); - } - $After_Lpar = 0; - - # clean up item count - pop(@Items_Seen); -} - -# -# process_cut - process a pod cut tag, thus start ignoring pod directives. -# -sub process_cut { - $Ignore = 1; -} - -# -# process_pod - process a pod tag, thus stop ignoring pod directives -# until we see a corresponding cut. -# -sub process_pod { - - # no need to set $Ignore to 0 cause the main loop did it -} - -# -# process_for - process a =for pod tag. if it's for html, spit -# it out verbatim, if illustration, center it, otherwise ignore it. -# -sub process_for { - my ( $whom, $text ) = @_; - if ( $whom =~ /^(pod2)?html$/i ) { - print HTML $text; - } elsif ( $whom =~ /^illustration$/i ) { - 1 while chomp $text; - for my $ext (qw[.png .gif .jpeg .jpg .tga .pcl .bmp]) { - $text .= $ext, last if -r "$text$ext"; - } - print HTML -qq{

    $text illustration

    }; - } -} - -# -# process_begin - process a =begin pod tag. this pushes -# whom we're beginning on the begin stack. if there's a -# begin stack, we only print if it us. -# -sub process_begin { - my ( $whom, $text ) = @_; - $whom = lc($whom); - push( @Begin_Stack, $whom ); - if ( $whom =~ /^(pod2)?html$/ ) { - print HTML $text if $text; - } -} - -# -# process_end - process a =end pod tag. pop the -# begin stack. die if we're mismatched. -# -sub process_end { - my ( $whom, $text ) = @_; - $whom = lc($whom); - if ( !defined $Begin_Stack[-1] or $Begin_Stack[-1] ne $whom ) { - Carp::confess( - "Unmatched begin/end at chunk $Paragraph in pod $Podfile\n"); - } - pop(@Begin_Stack); -} - -# -# process_pre - indented paragraph, made into
    
    -#
    -sub process_pre {
    -	my ($text) = @_;
    -	my ($rest);
    -	return if $Ignore;
    -
    -	$rest = $$text;
    -
    -	# insert spaces in place of tabs
    -	$rest =~ s#(.+)#
    -	    my $line = $1;
    -            1 while $line =~ s/(\t+)/' ' x ((length($1) * 8) - $-[0] % 8)/e;
    -	    $line;
    -	#eg;
    -
    -	# convert some special chars to HTML escapes
    -	$rest = html_escape($rest);
    -
    -	# try and create links for all occurrences of perl.* within
    -	# the preformatted text.
    -	$rest =~ s{
    -	         (\s*)(perl\w+)
    -	      }{
    -		 if ( defined $Pages{$2} ){	# is a link
    -		     qq($1$2);
    -		 } elsif (defined $Pages{dosify($2)}) {	# is a link
    -		     qq($1$2);
    -		 } else {
    -		     "$1$2";
    -		 }
    -	      }xeg;
    -	$rest =~ s{
    -		 ('
    -	|			# or:
    -	    [$punc]*		# 0 or more punctuation
    -	    (?:			#   followed
    -		[^$any]		#   by a non-url char
    -	    |			#   or
    -		$		#   end of the string
    -	    )			#
    -	|			# or else
    -	    $			#   then end of the string
    -        )
    -      }{$1}igox;
    -
    -	# text should be as it is (verbatim)
    -	$$text = $rest;
    -}
    -
    -#
    -# pure text processing
    -#
    -# pure_text/inIS_text: differ with respect to automatic C<> recognition.
    -# we don't want this to happen within IS
    -#
    -sub pure_text($) {
    -	my $text = shift();
    -	process_puretext( $text, 1 );
    -}
    -
    -sub inIS_text($) {
    -	my $text = shift();
    -	process_puretext( $text, 0 );
    -}
    -
    -#
    -# process_puretext - process pure text (without pod-escapes) converting
    -#  double-quotes and handling implicit C<> links.
    -#
    -sub process_puretext {
    -	my ( $text, $notinIS ) = @_;
    -
    -	## Guessing at func() or [\$\@%&]*var references in plain text is destined
    -	## to produce some strange looking ref's. uncomment to disable:
    -	## $notinIS = 0;
    -
    -	my ( @words, $lead, $trail );
    -
    -	# keep track of leading and trailing white-space
    -	$lead  = ( $text =~ s/\A(\s+)//s ? $1 : "" );
    -	$trail = ( $text =~ s/(\s+)\Z//s ? $1 : "" );
    -
    -	# split at space/non-space boundaries
    -	@words = split( /(?<=\s)(?=\S)|(?<=\S)(?=\s)/, $text );
    -
    -	# process each word individually
    -	foreach my $word (@words) {
    -
    -		# skip space runs
    -		next if $word =~ /^\s*$/;
    -
    -		# see if we can infer a link or a function call
    -		#
    -		# NOTE: This is a word based search, it won't automatically
    -		# mark "substr($var, 1, 2)" because the 1st word would be "substr($var"
    -		# User has to enclose those with proper C<>
    -
    -		if (
    -			   $notinIS
    -			&& $word =~ m/
    -		^([a-z_]{2,})                 # The function name
    -		\(
    -		    ([0-9][a-z]*              # Manual page(1) or page(1M)
    -		    |[^)]*[\$\@\%][^)]+       # ($foo), (1, @foo), (%hash)
    -		    |                         # ()
    -		    )
    -		\)
    -		([.,;]?)$                     # a possible punctuation follows
    -	    /xi
    -			)
    -		{
    -
    -			# has parenthesis so should have been a C<> ref
    -			## try for a pagename (perlXXX(1))?
    -			my ( $func, $args, $rest ) = ( $1, $2, $3 || '' );
    -			if ( $args =~ /^\d+$/ ) {
    -				my $url = page_sect( $word, '' );
    -				if ( defined $url ) {
    -					$word =
    -qq(the $word manpage$rest);
    -					next;
    -				}
    -			}
    -			## try function name for a link, append tt'ed argument list
    -			$word = emit_C( $func, '', "($args)" ) . $rest;
    -
    -#### disabled. either all (including $\W, $\w+{.*} etc.) or nothing.
    -##      } elsif( $notinIS && $word =~ /^[\$\@%&*]+\w+$/) {
    -##	    # perl variables, should be a C<> ref
    -##	    $word = emit_C( $word );
    -
    -		} elsif ( $word =~ m,^\w+://\w, ) {
    -
    -			# looks like a URL
    -			# Don't relativize it: leave it as the author intended
    -			$word = qq($word);
    -		} elsif ( $word =~ /[\w.-]+\@[\w-]+\.\w/ ) {
    -
    -			# looks like an e-mail address
    -			my ( $w1, $w2, $w3 ) = ( "", $word, "" );
    -			( $w1, $w2, $w3 ) = ( "(", $1, ")$2" ) if $word =~ /^\((.*?)\)(,?)/;
    -			( $w1, $w2, $w3 ) = ( "<", $1, ">$2" )
    -				if $word =~ /^<(.*?)>(,?)/;
    -			$word = qq($w1$w2$w3);
    -		} else {
    -			$word = html_escape($word) if $word =~ /["&<>]/;
    -		}
    -	}
    -
    -	# put everything back together
    -	return $lead . join( '', @words ) . $trail;
    -}
    -
    -#
    -# process_text - handles plaintext that appears in the input pod file.
    -# there may be pod commands embedded within the text so those must be
    -# converted to html commands.
    -#
    -
    -sub process_text1($$;$$);
    -sub pattern ($) { $_[0] ? '\s+' . ( '>' x ( $_[0] + 1 ) ) : '>' }
    -sub closing ($) { local ($_) = shift; ( defined && s/\s+\z// ) ? length : 0 }
    -
    -sub process_text {
    -	return if $Ignore;
    -	my ($tref) = @_;
    -	my $res = process_text1( 0, $tref );
    -	$res =~ s/\s+$//s;
    -	$$tref = $res;
    -}
    -
    -sub process_text_rfc_links {
    -	my $text = shift;
    -
    -	# For every "RFCnnnn" or "RFC nnn", link it to the authoritative
    -	# ource. Do not use the /i modifier here. Require "RFC" to be written in
    -	#  in capital letters.
    -
    -	$text =~ s{
    -	(?<=[^<>[:alpha:]])           # Make sure this is not an URL already
    -	(RFC\s*([0-9]{1,5}))(?![0-9]) # max 5 digits
    -    }
    -    {$1}gx;
    -
    -	$text;
    -}
    -
    -sub process_text1($$;$$) {
    -	my ( $lev, $rstr, $func, $closing ) = @_;
    -	my $res = '';
    -
    -	unless ( defined $func ) {
    -		$func = '';
    -		$lev++;
    -	}
    -
    -	if ( $func eq 'B' ) {
    -
    -		# B - boldface
    -		$res = '' . process_text1( $lev, $rstr ) . '';
    -
    -	} elsif ( $func eq 'C' ) {
    -
    -		# C - can be a ref or 
    -		# need to extract text
    -		my $par = go_ahead( $rstr, 'C', $closing );
    -
    -		## clean-up of the link target
    -		my $text = depod($par);
    -
    -		### my $x = $par =~ /[BI]call emit_C($par) lev=$lev, par with BI=$x\n";
    -
    -		$res = emit_C( $text, $lev > 1 || ( $par =~ /[BI] - convert to character
    -		$$rstr =~ s/^([^>]*)>//;
    -		my $escape = $1;
    -		$escape =~ s/^(\d+|X[\dA-F]+)$/#$1/i;
    -		$res = "&$escape;";
    -
    -	} elsif ( $func eq 'F' ) {
    -
    -		# F - italicize
    -		$res = '' . process_text1( $lev, $rstr ) . '';
    -
    -	} elsif ( $func eq 'I' ) {
    -
    -		# I - italicize
    -		$res = '' . process_text1( $lev, $rstr ) . '';
    -
    -	} elsif ( $func eq 'L' ) {
    -
    -		# L - link
    -		## L => produce text, use cross-ref for linking
    -		## L => make text from cross-ref
    -		## need to extract text
    -		my $par = go_ahead( $rstr, 'L', $closing );
    -
    -		# some L<>'s that shouldn't be:
    -		# a) full-blown URL's are emitted as-is
    -		if ( $par =~ m{^\w+://}s ) {
    -			return make_URL_href($par);
    -		}
    -
    -		# b) C<...> is stripped and treated as C<>
    -		if ( $par =~ /^C<(.*)>$/ ) {
    -			my $text = depod($1);
    -			return emit_C( $text, $lev > 1 || ( $par =~ /[BI] L<$par> to page $page, ident $ident\n";
    -
    -		} elsif ( $par =~ m{^(.*?)/"?(.*?)"?$} ) {    # [name]/"section"
    -			    # even though this should be a "section", we go for ident first
    -			( $page, $ident ) = ( $1, $2 );
    -			### print STDERR "--> L<$par> to page $page, section $section\n";
    -
    -		} elsif ( $par =~ /\s/ ) {  # this must be a section with missing quotes
    -			( $page, $section ) = ( '', $par );
    -			### print STDERR "--> L<$par> to void page, section $section\n";
    -
    -		} else {
    -			( $page, $section ) = ( $par, '' );
    -			### print STDERR "--> L<$par> to page $par, void section\n";
    -		}
    -
    -		# now, either $section or $ident is defined. the convoluted logic
    -		# below tries to resolve L<> according to what the user specified.
    -		# failing this, we try to find the next best thing...
    -		my ( $url, $ltext, $fid );
    -
    -	RESOLVE: {
    -			if ( defined $ident ) {
    -				## try to resolve $ident as an item
    -				( $url, $fid ) = coderef( $page, $ident );
    -				if ($url) {
    -					if ( !defined($linktext) ) {
    -						$linktext = $ident;
    -						$linktext .= " in " if $ident && $page;
    -						$linktext .= "the $page manpage" if $page;
    -					}
    -					###  print STDERR "got coderef url=$url\n";
    -					last RESOLVE;
    -				}
    -				## no luck: go for a section (auto-quoting!)
    -				$section = $ident;
    -			}
    -			## now go for a section
    -			my $htmlsection = htmlify($section);
    -			$url = page_sect( $page, $htmlsection );
    -			if ($url) {
    -				if ( !defined($linktext) ) {
    -					$linktext = $section;
    -					$linktext .= " in " if $section && $page;
    -					$linktext .= "the $page manpage" if $page;
    -				}
    -				### print STDERR "got page/section url=$url\n";
    -				last RESOLVE;
    -			}
    -			## no luck: go for an ident
    -			if ($section) {
    -				$ident = $section;
    -			} else {
    -				$ident = $page;
    -				$page  = undef();
    -			}
    -			( $url, $fid ) = coderef( $page, $ident );
    -			if ($url) {
    -				if ( !defined($linktext) ) {
    -					$linktext = $ident;
    -					$linktext .= " in " if $ident && $page;
    -					$linktext .= "the $page manpage" if $page;
    -				}
    -				### print STDERR "got section=>coderef url=$url\n";
    -				last RESOLVE;
    -			}
    -
    -			# warning; show some text.
    -			$linktext = $opar unless defined $linktext;
    -			warn
    -"$0: $Podfile: cannot resolve L<$opar> in paragraph $Paragraph.\n"
    -				unless $Quiet;
    -		}
    -
    -		# now we have a URL or just plain code
    -		$$rstr = $linktext . '>' . $$rstr;
    -		if ( defined($url) ) {
    -			$res = "" . process_text1( $lev, $rstr ) . '';
    -		} else {
    -			$res = '' . process_text1( $lev, $rstr ) . '';
    -		}
    -
    -	} elsif ( $func eq 'S' ) {
    -
    -		# S - non-breaking spaces
    -		$res = process_text1( $lev, $rstr );
    -		$res =~ s/ / /g;
    -
    -	} elsif ( $func eq 'X' ) {
    -
    -		# X<> - ignore
    -		warn "$0: $Podfile: invalid X<> in paragraph $Paragraph.\n"
    -			unless $$rstr =~ s/^[^>]*>//
    -				or $Quiet;
    -	} elsif ( $func eq 'Z' ) {
    -
    -		# Z<> - empty
    -		warn "$0: $Podfile: invalid Z<> in paragraph $Paragraph.\n"
    -			unless $$rstr =~ s/^>//
    -				or $Quiet;
    -
    -	} else {
    -		my $term = pattern $closing;
    -		while ( $$rstr =~ s/\A(.*?)(([BCEFILSXZ])<(<+[^\S\n]+)?|$term)//s ) {
    -
    -			# all others: either recurse into new function or
    -			# terminate at closing angle bracket(s)
    -			my $pt = $1;
    -			$pt .= $2 if !$3 && $lev == 1;
    -			$res .= $lev == 1 ? pure_text($pt) : inIS_text($pt);
    -			return $res if !$3 && $lev > 1;
    -			if ($3) {
    -				$res .= process_text1( $lev, $rstr, $3, closing $4 );
    -			}
    -		}
    -		if ( $lev == 1 ) {
    -			$res .= pure_text($$rstr);
    -		} elsif ( !$Quiet ) {
    -			my $snippet = substr( $$rstr, 0, 60 );
    -			warn
    -"$0: $Podfile: undelimited $func<> in paragraph $Paragraph: '$snippet'.\n"
    -
    -		}
    -		$res = process_text_rfc_links($res);
    -	}
    -	return $res;
    -}
    -
    -#
    -# go_ahead: extract text of an IS (can be nested)
    -#
    -sub go_ahead($$$) {
    -	my ( $rstr, $func, $closing ) = @_;
    -	my $res     = '';
    -	my @closing = ($closing);
    -	while ( $$rstr =~
    -		s/\A(.*?)(([BCEFILSXZ])<(<+\s+)?|@{[pattern $closing[0]]})//s )
    -	{
    -		$res .= $1;
    -		unless ($3) {
    -			shift @closing;
    -			return $res unless @closing;
    -		} else {
    -			unshift @closing, closing $4;
    -		}
    -		$res .= $2;
    -	}
    -	unless ($Quiet) {
    -		my $snippet = substr( $$rstr, 0, 60 );
    -		warn
    -"$0: $Podfile: undelimited $func<> in paragraph $Paragraph (go_ahead): '$snippet'.\n";
    -	}
    -	return $res;
    -}
    -
    -#
    -# emit_C - output result of C
    -#    $text is the depod-ed text
    -#
    -sub emit_C($;$$) {
    -	my ( $text, $nocode, $args ) = @_;
    -	$args = '' unless defined $args;
    -	my $res;
    -	my ( $url, $fid ) = coderef( undef(), $text );
    -
    -	# need HTML-safe text
    -	my $linktext = html_escape("$text$args");
    -
    -	if ( $text !~ /^[\$@%]/
    -		&& defined($url)
    -		&& ( !defined($EmittedItem) || $EmittedItem ne $fid ) )
    -	{
    -		$res = "$linktext";
    -	} elsif ( 0 && $nocode ) {
    -		$res = $linktext;
    -	} else {
    -		$res = "$linktext";
    -	}
    -	return $res;
    -}
    -
    -#
    -# html_escape: make text safe for HTML
    -#
    -sub html_escape {
    -	my $rest = $_[0];
    -	$rest =~ s/&/&/g;
    -	$rest =~ s//>/g;
    -	$rest =~ s/"/"/g;
    -
    -	# ' is only in XHTML, not HTML4.  Be conservative
    -	#$rest   =~ s/'/'/g;
    -	return $rest;
    -}
    -
    -#
    -# dosify - convert filenames to 8.3
    -#
    -sub dosify {
    -	my ($str) = @_;
    -	return lc($str) if $^O eq 'VMS';    # VMS just needs casing
    -	if ($Is83) {
    -		$str = lc $str;
    -		$str =~ s/(\.\w+)/substr ($1,0,4)/ge;
    -		$str =~ s/(\w+)/substr ($1,0,8)/ge;
    -	}
    -	return $str;
    -}
    -
    -#
    -# page_sect - make a URL from the text of a L<>
    -#
    -sub page_sect($$) {
    -	my ( $page, $section ) = @_;
    -	my ( $linktext, $page83, $link );    # work strings
    -
    -	# check if we know that this is a section in this page
    -	if ( !defined $Pages{$page} && defined $Sections{$page} ) {
    -		$section = $page;
    -		$page    = "";
    -		### print STDERR "reset page='', section=$section\n";
    -	}
    -
    -	$page83 = dosify($page);
    -	$page = $page83 if ( defined $Pages{$page83} );
    -	if ( $page eq "" ) {
    -		$link = "#" . anchorify($section);
    -	} elsif ( $page =~ /::/ ) {
    -		$page =~ s,::,/,g;
    -
    -		# Search page cache for an entry keyed under the html page name,
    -		# then look to see what directory that page might be in.  NOTE:
    -		# this will only find one page. A better solution might be to produce
    -		# an intermediate page that is an index to all such pages.
    -		my $page_name = $page;
    -		$page_name =~ s,^.*/,,s;
    -		if ( defined( $Pages{$page_name} )
    -			&& $Pages{$page_name} =~ /([^:]*$page)\.(?:pod|pm):/ )
    -		{
    -			$page = $1;
    -		} else {
    -
    -			# NOTE: This branch assumes that all A::B pages are located in
    -			# $Htmlroot/A/B.html . This is often incorrect, since they are
    -			# often in $Htmlroot/lib/A/B.html or such like. Perhaps we could
    -			# analyze the contents of %Pages and figure out where any
    -			# cousins of A::B are, then assume that.  So, if A::B isn't found,
    -			# but A::C is found in lib/A/C.pm, then A::B is assumed to be in
    -			# lib/A/B.pm. This is also limited, but it's an improvement.
    -			# Maybe a hints file so that the links point to the correct places
    -			# nonetheless?
    -
    -		}
    -		$link = "$Htmlroot/$page.html";
    -		$link .= "#" . anchorify($section) if ($section);
    -	} elsif ( !defined $Pages{$page} ) {
    -		$link = "";
    -	} else {
    -		$section = anchorify($section) if $section ne "";
    -		### print STDERR "...section=$section\n";
    -
    -		# if there is a directory by the name of the page, then assume that an
    -		# appropriate section will exist in the subdirectory
    -		#	if ($section ne "" && $Pages{$page} =~ /([^:]*[^(\.pod|\.pm)]):/) {
    -		if ( $section ne "" && $Pages{$page} =~ /([^:]*(?, Foo.(pod|pm) is preferred to A/Foo.(pod|pm)
    -			if ( $Pages{$page} =~ /([^:]*)\.(?:pod|pm):/ ) {
    -				$link = "$Htmlroot/$1.html$section";
    -			} else {
    -				$link = "";
    -			}
    -		}
    -	}
    -
    -	if ($link) {
    -
    -		# Here, we take advantage of the knowledge that $Htmlfileurl ne ''
    -		# implies $Htmlroot eq ''. This means that the link in question
    -		# needs a prefix of $Htmldir if it begins with '/'. The test for
    -		# the initial '/' is done to avoid '#'-only links, and to allow
    -		# for other kinds of links, like file:, ftp:, etc.
    -		my $url;
    -		if ( $Htmlfileurl ne '' ) {
    -			$link = "$Htmldir$link" if $link =~ m{^/}s;
    -			$url = relativize_url( $link, $Htmlfileurl );
    -
    -			# print( "  b: [$link,$Htmlfileurl,$url]\n" );
    -		} else {
    -			$url = $link;
    -		}
    -		return $url;
    -
    -	} else {
    -		return undef();
    -	}
    -}
    -
    -#
    -# relativize_url - convert an absolute URL to one relative to a base URL.
    -# Assumes both end in a filename.
    -#
    -sub relativize_url {
    -	my ( $dest, $source ) = @_;
    -
    -	my ( $dest_volume, $dest_directory, $dest_file ) =
    -		File::Spec::Unix->splitpath($dest);
    -	$dest = File::Spec::Unix->catpath( $dest_volume, $dest_directory, '' );
    -
    -	my ( $source_volume, $source_directory, $source_file ) =
    -		File::Spec::Unix->splitpath($source);
    -	$source =
    -		File::Spec::Unix->catpath( $source_volume, $source_directory, '' );
    -
    -	my $rel_path = '';
    -	if ( $dest ne '' ) {
    -		$rel_path = File::Spec::Unix->abs2rel( $dest, $source );
    -	}
    -
    -	if (   $rel_path ne ''
    -		&& substr( $rel_path, -1 ) ne '/'
    -		&& substr( $dest_file, 0, 1 ) ne '#' )
    -	{
    -		$rel_path .= "/$dest_file";
    -	} else {
    -		$rel_path .= "$dest_file";
    -	}
    -
    -	return $rel_path;
    -}
    -
    -#
    -# coderef - make URL from the text of a C<>
    -#
    -sub coderef($$) {
    -	my ( $page, $item ) = @_;
    -	my ($url);
    -
    -	my $fid = fragment_id($item);
    -
    -	if ( defined($page) && $page ne "" ) {
    -
    -		# we have been given a $page...
    -		$page =~ s{::}{/}g;
    -
    -		Carp::confess(
    -"Undefined fragment '$item' from fragment_id() in coderef() in $Podfile"
    -		) if !defined $fid;
    -
    -		# Do we take it? Item could be a section!
    -		my $base = $Items{$fid} || "";
    -		$base =~ s{[^/]*/}{};
    -		if ( $base ne "$page.html" ) {
    -			###   print STDERR "coderef( $page, $item ): items{$fid} = $Items{$fid} = $base => discard page!\n";
    -			$page = undef();
    -		}
    -
    -	} else {
    -
    -		# no page - local items precede cached items
    -		if ( defined($fid) ) {
    -			if ( exists $Local_Items{$fid} ) {
    -				$page = $Local_Items{$fid};
    -			} else {
    -				$page = $Items{$fid};
    -			}
    -		}
    -	}
    -
    -	# if there was a pod file that we found earlier with an appropriate
    -	# =item directive, then create a link to that page.
    -	if ( defined $page ) {
    -		if ($page) {
    -			if ( exists $Pages{$page} and $Pages{$page} =~ /([^:.]*)\.[^:]*:/ )
    -			{
    -				$page = $1 . '.html';
    -			}
    -			my $link = "$Htmlroot/$page#" . anchorify($fid);
    -
    -			# Here, we take advantage of the knowledge that $Htmlfileurl
    -			# ne '' implies $Htmlroot eq ''.
    -			if ( $Htmlfileurl ne '' ) {
    -				$link = "$Htmldir$link";
    -				$url = relativize_url( $link, $Htmlfileurl );
    -			} else {
    -				$url = $link;
    -			}
    -		} else {
    -			$url = "#" . anchorify($fid);
    -		}
    -
    -		confess "url has space: $url" if $url =~ /"[^"]*\s[^"]*"/;
    -	}
    -	return ( $url, $fid );
    -}
    -
    -#
    -# Adapted from Nick Ing-Simmons' PodToHtml package.
    -sub relative_url {
    -	my $source_file      = shift;
    -	my $destination_file = shift;
    -
    -	my $source = URI::file->new_abs($source_file);
    -	my $uo = URI::file->new( $destination_file, $source )->abs;
    -	return $uo->rel->as_string;
    -}
    -
    -#
    -# finish_list - finish off any pending HTML lists.  this should be called
    -# after the entire pod file has been read and converted.
    -#
    -sub finish_list {
    -	while ( $Listlevel > 0 ) {
    -		print HTML "\n";
    -		$Listlevel--;
    -	}
    -}
    -
    -#
    -# htmlify - converts a pod section specification to a suitable section
    -# specification for HTML. Note that we keep spaces and special characters
    -# except ", ? (Netscape problem) and the hyphen (writer's problem...).
    -#
    -sub htmlify {
    -	my ($heading) = @_;
    -	$heading =~ s/(\s+)/ /g;
    -	$heading =~ s/\s+\Z//;
    -	$heading =~ s/\A\s+//;
    -
    -	# The hyphen is a disgrace to the English language.
    -	# $heading =~ s/[-"?]//g;
    -	$heading =~ s/["?]//g;
    -	$heading = lc($heading);
    -	return $heading;
    -}
    -
    -#
    -# similar to htmlify, but turns non-alphanumerics into underscores
    -#
    -sub anchorify {
    -	my ($anchor) = @_;
    -	$anchor =~ s/\([^)]*\)//;
    -	$anchor = htmlify($anchor);
    -	$anchor =~ s/\W/_/g;
    -	$anchor =~ tr/_/_/s;
    -	return $anchor;
    -}
    -
    -#
    -# depod - convert text by eliminating all interior sequences
    -# Note: can be called with copy or modify semantics
    -#
    -my %E2c;
    -$E2c{lt}     = '<';
    -$E2c{gt}     = '>';
    -$E2c{sol}    = '/';
    -$E2c{verbar} = '|';
    -$E2c{amp}    = '&';    # in Tk's pods
    -
    -sub depod1($;$$);
    -
    -sub depod($) {
    -	my $string;
    -	if ( ref( $_[0] ) ) {
    -		$string = ${ $_[0] };
    -		${ $_[0] } = depod1( \$string );
    -	} else {
    -		$string = $_[0];
    -		depod1( \$string );
    -	}
    -}
    -
    -sub depod1($;$$) {
    -	my ( $rstr, $func, $closing ) = @_;
    -	my $res = '';
    -	return $res unless defined $$rstr;
    -	if ( !defined($func) ) {
    -
    -		# skip to next begin of an interior sequence
    -		while ( $$rstr =~ s/\A(.*?)([BCEFILSXZ])<(<+[^\S\n]+)?//s ) {
    -
    -			# recurse into its text
    -			$res .= $1 . depod1( $rstr, $2, closing $3);
    -		}
    -		$res .= $$rstr;
    -	} elsif ( $func eq 'E' ) {
    -
    -		# E - convert to character
    -		$$rstr =~ s/^([^>]*)>//;
    -		$res .= $E2c{$1} || "";
    -	} elsif ( $func eq 'X' ) {
    -
    -		# X<> - ignore
    -		$$rstr =~ s/^[^>]*>//;
    -	} elsif ( $func eq 'Z' ) {
    -
    -		# Z<> - empty
    -		$$rstr =~ s/^>//;
    -	} else {
    -
    -		# all others: either recurse into new function or
    -		# terminate at closing angle bracket
    -		my $term = pattern $closing;
    -		while ( $$rstr =~ s/\A(.*?)(([BCEFILSXZ])<(<+[^\S\n]+)?|$term)//s ) {
    -			$res .= $1;
    -			last unless $3;
    -			$res .= depod1( $rstr, $3, closing $4 );
    -		}
    -		## If we're here and $2 ne '>': undelimited interior sequence.
    -		## Ignored, as this is called without proper indication of where we are.
    -		## Rely on process_text to produce diagnostics.
    -	}
    -	return $res;
    -}
    -
    -{
    -	my %seen;    # static fragment record hash
    -
    -	sub fragment_id_readable {
    -		my $text     = shift;
    -		my $generate = shift;    # optional flag
    -
    -		my $orig = $text;
    -
    -		# leave the words for the fragment identifier,
    -		# change everything else to underbars.
    -		$text =~
    -			s/[^A-Za-z0-9_]+/_/g;    # do not use \W to avoid locale dependency.
    -		$text =~ s/_{2,}/_/g;
    -		$text =~ s/\A_//;
    -		$text =~ s/_\Z//;
    -
    -		unless ($text) {
    -
    -			# Nothing left after removing punctuation, so leave it as is
    -			# E.g. if option is named: "=item -#"
    -
    -			$text = $orig;
    -		}
    -
    -		if ($generate) {
    -			if ( exists $seen{$text} ) {
    -
    -				# This already exists, make it unique
    -				$seen{$text}++;
    -				$text = $text . $seen{$text};
    -			} else {
    -				$seen{$text} = 1;    # first time seen this fragment
    -			}
    -		}
    -
    -		$text;
    -	}
    -}
    -
    -my @HC;
    -
    -sub fragment_id_obfuscated {         # This was the old "_2d_2d__"
    -	my $text     = shift;
    -	my $generate = shift;            # optional flag
    -
    -	# text? Normalize by obfuscating the fragment id to make it unique
    -	$text =~ s/\s+/_/sg;
    -
    -	$text =~ s{(\W)}{
    -        defined( $HC[ord($1)] ) ? $HC[ord($1)]
    -        : ( $HC[ord($1)] = sprintf( "%%%02X", ord($1) ) ) }gxe;
    -	$text = substr( $text, 0, 50 );
    -
    -	$text;
    -}
    -
    -#
    -# fragment_id - construct a fragment identifier from:
    -#   a) =item text
    -#   b) contents of C<...>
    -#
    -
    -sub fragment_id {
    -	my $text     = shift;
    -	my $generate = shift;    # optional flag
    -
    -	$text =~ s/\s+\Z//s;
    -	if ($text) {
    -
    -		# a method or function?
    -		return $1 if $text =~ /(\w+)\s*\(/;
    -		return $1 if $text =~ /->\s*(\w+)\s*\(?/;
    -
    -		# a variable name?
    -		return $1 if $text =~ /^([\$\@%*]\S+)/;
    -
    -		# some pattern matching operator?
    -		return $1 if $text =~ m|^(\w+/).*/\w*$|;
    -
    -		# fancy stuff... like "do { }"
    -		return $1 if $text =~ m|^(\w+)\s*{.*}$|;
    -
    -		# honour the perlfunc manpage: func [PAR[,[ ]PAR]...]
    -		# and some funnies with ... Module ...
    -		return $1 if $text =~ m{^([a-z\d_]+)(\s+[A-Z,/& ][A-Z\d,/& ]*)?$};
    -		return $1 if $text =~ m{^([a-z\d]+)\s+Module(\s+[A-Z\d,/& ]+)?$};
    -
    -		return fragment_id_readable( $text, $generate );
    -	} else {
    -		return;
    -	}
    -}
    -
    -#
    -# make_URL_href - generate HTML href from URL
    -# Special treatment for CGI queries.
    -#
    -sub make_URL_href($;$) {
    -	my ($url) = shift;
    -	my $linktext = shift || $url;
    -	if ( $url !~ s{^(http:[-\w/#~:.+=&%@!]+)(\?.*)$}{$1}i ) {
    -		$url = "$linktext";
    -	}
    -	return $url;
    -}
    -
    -1;
    diff --git a/plugins/perl/lib/Xchat.pod b/plugins/perl/lib/Xchat.pod
    deleted file mode 100644
    index 7b11e25c..00000000
    --- a/plugins/perl/lib/Xchat.pod
    +++ /dev/null
    @@ -1,1362 +0,0 @@
    -=head1 X-Chat 2 Perl Interface
    -
    -=head2 Introduction
    -
    -This is the new Perl interface for X-Chat 2.  However, due to changes in
    -xchat's plugin code you will need xchat 2.0.8 or above to load this.  Scripts
    -written using the old interface will continue to work. If there are any
    -problems, questions, comments or suggestions please email them to the address
    -on the bottom of this page.
    -
    -=head2 Constants
    -
    -=head3 Priorities
    -
    -=over 3
    -
    -=item *
    -C 
    -
    -=item *
    -C 
    -
    -=item *
    -C 
    -
    -=item *
    -C 
    -
    -=item *
    -C 
    -
    -=back
    -
    -=head3 Return values
    -
    -=over 3
    -
    -=item *
    -C     - pass the event along
    -
    -=item *
    -C    - don't let xchat see this event
    -
    -=item *
    -C   - don't let other scripts and plugins see this event but xchat will still see it
    -
    -=item *
    -C      - don't let anything else see this event
    -
    -=back
    -
    -=head4 Timer and fd hooks
    -
    -=over 3
    -
    -=item *
    -C         - keep the timer going or hook watching the handle
    -
    -=item *
    -C       - remove the timer or hook watching the handle
    -
    -=back
    -
    -=head3 hook_fd flags
    -
    -=over 3
    -
    -=item *
    -C			- invoke the callback when the handle is ready for reading
    -
    -=item *
    -C		- invoke the callback when the handle is ready for writing
    -
    -=item *
    -C	- invoke the callback if an exception occurs
    -
    -=item *
    -C	- indicate that the handle being hooked is not a socket
    -
    -=back
    -
    -=head2 Functions
    -
    -=head3 C 
    -
    -=over 3
    -
    -=item *
    -C<$name>             -  The name of this script
    -
    -=item *
    -C<$version>          -  This script's version
    -
    -=item *
    -C<$description>   -  A description for this script
    -
    -=item *
    -C<$callback>      -  This is a function that will be called when the is script
    -                     unloaded. This can be either a reference to a
    -                     function or an anonymous sub reference.
    -
    -=back
    -
    -This is the first thing to call in every script.
    -
    -=head3 C 
    -
    -=head3 C 
    -
    -=head3 C 
    -
    -=head3 C 
    -
    -=head3 C
    -
    -These functions can be to intercept various events.
    -hook_server can be used to intercept any incoming message from the IRC server.
    -hook_command can be used to intercept any command, if the command doesn't currently exist then a new one is created.
    -hook_print can be used to intercept any of the events listed in Setttings-EAdvanced-EText Events
    -hook_timer can be used to create a new timer
    -
    -
    -=over 3
    -
    -=item *
    -C<$message>       -  server message to hook such as PRIVMSG
    -
    -=item *
    -C<$command>       -  command to intercept, without the leading /
    -
    -=item *
    -C<$event>      -  one of the events listed in Settings-EAdvanced-EText Events
    -
    -=item *
    -C<$timeout>       -  timeout in milliseconds
    -
    -=item *
    -C<$handle>     - the I/O handle you want to monitor with hook_fd. This must be something that has a fileno. See perldoc -f fileno or L
    -
    -=item *
    -C<$callback>   -  callback function, this is called whenever
    -                  the hooked event is trigged, the following are
    -                  the conditions that will trigger the different hooks.
    -                  This can be either a reference to a
    -                  function or an anonymous sub reference.
    -
    -=item *
    -\%options   -  a hash reference containing addional options for the hooks
    -
    -=back
    -
    -Valid keys for \%options:
    -
    -=begin html
    -
    -
    -
    -   
    -   
    -   
    -
    -   
    -      
    -
    -   
    -
    -   
    -      
    -   
    -
    -   
    -      
    -   
    -
    -
    data Additional data that is to be associated with the
    - hook. For timer hooks this value can be provided either as
    - Xchat::hook_timer( $timeout, $cb,{data=>$data})
    - or Xchat::hook_timer( $timeout, $cb, $data ).
    - However, this means that hook_timer cannot be provided
    - with a hash reference containing data as a key.
    - - example:
    - my $options = { data => [@arrayOfStuff] };
    - Xchat::hook_timer( $timeout, $cb, $options );
    -
    - In this example, the timer's data will be
    - [@arrayOfStuff] and not { data => [@arrayOfStuff] }
    -
    - This key is valid for all of the hook functions.
    -
    - Default is undef.
    -
    priority Sets the priority for the hook.
    - It can be set to one of the - Xchat::PRI_* constants.
    -
    - This key only applies to server, command - and print hooks.
    -
    - Default is Xchat::PRI_NORM. -
    help_text Text displayed for /help $command.
    -
    - This key only applies to command hooks.
    -
    - Default is "". -
    flags Specify the flags for a fd hook.
    -
    - See hook fd flags section for valid values.
    -
    - On Windows if the handle is a pipe you specify
    - Xchat::FD_NOTSOCKET in addition to any other flags you might be using.
    -
    - This key only applies to fd hooks.
    - Default is Xchat::FD_READ -
    - -=end html - -=head4 When callbacks are invoked - -Each of the hooks will be triggered at different times depending on the type -of hook. - -=begin html - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Hook Type When the callback will be invoked
    server hooks a $message message is - received from the server -
    command hooks the $command command is - executed, either by the user or from a script -
    print hooks X-Chat is about to print the message for the - $event event -
    timer hooks called every $timeout milliseconds - (1000 millisecond is 1 second)
    - the callback will be executed in the same context where - the hook_timer was called, if the context no longer exists - then it will execute in a random context -
    fd hooks depends on the flags that were passed to hook_fd
    - See hook_fd flags section. -
    - -=end html - - -The value return from these hook functions can be passed to C -to remove the hook. - -=head4 Callback Arguments - -All callback functions will receive their arguments in C<@_> like every -other Perl subroutine. - -=begin html - -

    -Server and command callbacks
    -
    -$_[0] - array reference containing the IRC message or command and -arguments broken into words
    -example:
    -/command arg1 arg2 arg3
    -$_[0][0] - command
    -$_[0][1] - arg1
    -$_[0][2] - arg2
    -$_[0][3] - arg3
    -
    -$_[1] - array reference containing the Nth word to the last word
    -example:
    -/command arg1 arg2 arg3
    -$_[1][0] - command arg1 arg2 arg3
    -$_[1][1] - arg1 arg2 arg3
    -$_[1][2] - arg2 arg3
    -$_[1][3] - arg3
    -
    -$_[2] - the data that was passed to the hook function
    -
    -Print callbacks
    -
    -$_[0] - array reference containing the values for the - text event see Settings->Advanced->Text Events
    -$_[1] - the data that was passed to the hook function
    -
    -Timer callbacks
    -
    -$_[0] - the data that was passed to the hook function
    -
    - -fd callbacks
    -
    -$_[0] - the handle that was passed to hook_fd
    -$_[1] - flags indicating why the callback was called
    -$_[2] - the data that was passed to the hook function
    -

    - -=end html - -=head4 Callback return values - -All server, command and print callbacks should return one of -the C constants. -Timer callbacks can return Xchat::REMOVE to remove -the timer or Xchat::KEEP to keep it going - -=head4 Miscellaneous Hook Related Information - -For server hooks, if C<$message> is "RAW LINE" then C<$cb> will be called for -every IRC message than X-Chat receives. - -For command hooks if C<$command> is "" then C<$cb> will be called for -messages entered by the user that is not a command. - -For print hooks besides those events listed in -Settings-EAdvanced-EText Events, these additional events can be used. - -=begin html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Event Description
    "Open Context" a new context is created
    "Close Context" a context has been close
    "Focus Tab" when a tab is brought to the front
    "Focus Window" when a top level window is focused or the - main tab window is focused by the window manager -
    "DCC Chat Text" when text from a DCC Chat arrives. - $_[0] will have these values
    -
    - $_[0][0] - Address
    - $_[0][1] - Port
    - $_[0][2] - Nick
    - $_[0][3] - Message
    -
    "Key Press" used for intercepting key presses
    - $_[0][0] - key value
    - $_[0][1] - state bitfield, 1 - shift, 4 - control, 8 - alt
    - $_[0][2] - string version of the key which might be empty for unprintable keys
    - $_[0][3] - length of the string in $_[0][2]
    -
    - -=end html - -=head3 C - -=over 3 - -=item * -C<$hook> - the hook that was previously returned by one of the C functions - -=back - - -This function is used to removed a hook previously added with one of -the C functions - -It returns the data that was passed to the C function when -the hook was added - - -=head3 C - -=over 3 - -=item * -C<$text> - the text to print - -=item * -C<\@lines> - array reference containing lines of text to be printed - all the elements will be joined together before printing - -=item * -C<$channel> - channel or tab with the given name where C<$text> - will be printed - -=item * -C<$server> - specifies that the text will be printed in a channel or tab - that is associated with C<$server> - -=back - -The first argument can either be a string or an array reference of strings. -Either or both of C<$channel> and C<$server> can be undef. - -If called as C, it will always return true. -If called with either the channel or the channel and the server -specified then it will return true if a context is found and -false otherwise. The text will not be printed if the context -is not found. The meaning of setting C<$channel> or C<$server> to -undef is the same as -L. - - -=head3 C - -=over 3 - -=item * -C<$format> - a format string, see "perldoc -f L" for further detail - -=item * -LIST - list of values for the format fields - -=back - -=head3 C - -=over 3 - -=item * -C<$command> - the command to execute, without the leading / - -=item * -C<\@commands> - array reference containing a list of commands to execute - -=item * -C<$channel> - channel or tab with the given name where C<$command> will be executed - -=item * -C<$server> - specifies that the command will be executed in a channel or tab that is associated with C<$server> - -=back - -The first argument can either be a string or an array reference of strings. -Either or both of C<$channel> and C<$server> can be undef. - -If called as C, it will always return true. -If called with either the channel or the channel and the server -specified then it will return true if a context is found and false -otherwise. The command will not be executed if the context is not found. -The meaning of setting C<$channel> or C<$server> to undef is the same -as find_context. - - -=head3 C - -=over 3 - -=item * -C<$format> - a format string, see "perldoc -f L" for further detail - -=item * -LIST - list of values for the format fields - -=back - -=head3 C - -=over 3 - -=item * -C<$channel> - name of a channel - -=item * -C<$server> - name of a server - -=back - -Either or both of C<$channel> and $server can be undef. Calling -C is the same as calling -C and -C is -the same as C. - -If C<$server> is undef, find any channel named $channel. -If C<$channel> is undef, find the front most window -or tab named C<$server>.If both $channel and -C<$server> are undef, find the currently focused tab or window. - -Return the context found for one of the above situations or undef if such -a context cannot be found. - - -=head3 C - -=over 3 - -=back - -Returns the current context. - -=head3 C - -=over 3 - -=item * -C<$context> - context value as returned from L,L or one - of the fields in the list of hashrefs returned by list_get - -=item * -C<$channel> - name of a channel you want to switch context to - -=item * -C<$server> - name of a server you want to switch context to - -=back - -See L for more details on C<$channel> and C<$server>. - -Returns true on success, false on failure - -=head3 C - -=over 3 - -=item * -C<$id> - one of the following case sensitive values - -=back - -=begin html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    IDReturn valueAssociated Command(s)
    awayaway reason or undef if you are not awayAWAY, BACK
    channelcurrent channel nameSETTAB
    charsetcharacter-set used in the current contextCHARSET
    event_text <Event Name> text event format string for <Event name>
    - Example: -
    - my $channel_msg_format = Xchat::get_info( "event_text Channel Message" ); -
    -
    hostreal hostname of the current server
    idconnection id
    inputboxcontents of the inputboxSETTEXT
    libdirfsthe system wide directory where xchat will look for plugins. - this string is in the same encoding as the local file system
    modesthe current channels modes or undef if not knownMODE
    networkcurrent network name or undef, this value is taken from the Network List
    nickcurrent nickNICK
    nickservnickserv password for this network or undef, this value is taken from the Network List
    server current server name
    - (what the server claims to be) undef if not connected -
    state_cursorcurrent inputbox cursor position in charactersSETCURSOR
    topiccurrent channel topicTOPIC
    versionxchat version number
    win_statusstatus of the xchat window, possible values are "active", "hidden" - and "normal"GUI
    win_ptr native window pointer, GtkWindow * on Unix, HWND on Win32.
    - On Unix if you have the Glib module installed you can use my $window = Glib::Object->new_from_pointer( Xchat::get_info( "win_ptr" ) ); to get a Gtk2::Window object.
    - Additionally when you have detached tabs, each of the windows will return a different win_ptr for the different Gtk2::Window objects.
    - See char_count.pl for a longer example of a script that uses this to show how many characters you currently have in your input box. -
    gtkwin_ptrsimilar to win_ptr except it will always be a GtkWindow *
    configdir HexChat config directory encoded in UTF-8
    - examples:
    - /home/user/.config/hexchat
    - C:\Users\user\Appdata\Roaming\HexChat -
    - -

    This function is used to retrieve certain information about the current -context. If there is an associated command then that command can be used to change the value for a particular ID.

    - -=end html - -=head3 C - -=over 3 - -=item * -C<$name> - name of a X-Chat setting (available through the /set command) - -=back - -This function provides a way to retrieve X-Chat's setting information. - -Returns C if there is no setting called called C<$name>. - - -=head3 C - -=over 3 - -=item * -C<$event> - name from the Event column in Settings-EAdvanced-EText Events - -=item * -LIST - this depends on the Description column on the bottom of Settings-EAdvanced-EText Events - -=back - -This functions is used to generate one of the events listed under -Settings-EAdvanced-EText Events - -Note: when using this function you MUST return Xchat::EAT_ALL otherwise you will end up with duplicate events. -One is the original and the second is the one you emit. - -Returns true on success, false on failure - -=head3 C - -=over 3 - -=item * -C<$target> - a single nick to set the mode on - -=item * -C<\@targets> - an array reference of the nicks to set the mode on - -=item * -C<$sign> - the mode sign, either '+' or '-' - -=item * -C<$mode> - the mode character such as 'o' and 'v', this can only be one character long - -=item * -C<$modes_per_line> - an optional argument maximum number of modes to send per at once, pass 0 use the current server's maximum (default) - -=back - -Send multiple mode changes for the current channel. It may send multiple MODE lines if the request doesn't fit on one. - -Example: - -=begin html -
    - -use strict; -use warning; -use Xchat qw(:all); - -hook_command( "MODES", sub { - my (undef, $who, $sign, $mode) = @{$_[0]}; - - my @targets = split /,/, $who; - if( @targets > 1 ) { - send_modes( \@targets, $sign, $mode, 1 ); - } else { - send_modes( $who, $sign, $mode ); - } - - return EAT_XCHAT; -}); - - -
    - -=end html - -=head3 C - -=over 3 - -=item * -C<$nick1, $nick2> - the two nicks or channel names that are to be compared - -=back - -The comparsion is based on the current server. Either a RFC1459 compliant -string compare or plain ascii will be using depending on the server. The -comparison is case insensitive. - -Returns a number less than, equal to or greater than zero if -C<$nick1> is -found respectively, to be less than, to match, or be greater than -C<$nick2>. - - -=head3 C - -=over 3 - -=item * -C<$name> - name of the list, one of the following: -"channels", "dcc", "ignore", "notify", "users" - -=back - -This function will return a list of hash references. The hash references -will have different keys depend on the list. An empty list is returned -if there is no such list. - -=begin html - -

    "channels" - list of channels, querys and their server

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Key Description
    channel tab name
    chantypeschannel types supported by the server, typically "#&"
    context can be used with set_context
    flags Server Bits:
    - 0 - Connected
    - 1 - Connecting
    - 2 - Away
    - 3 - EndOfMotd(Login complete)
    - 4 - Has WHOX
    - 5 - Has IDMSG (FreeNode)
    -
    -

    The following correspond to the /chanopt command

    - 6 - Hide Join/Part Message (text_hidejoinpart)
    - 7 - unused (was for color paste)
    - 8 - Beep on message (alert_beep)
    - 9 - Blink Tray (alert_tray)
    - 10 - Blink Task Bar (alert_taskbar)
    -

    Example of checking if the current context has Hide Join/Part messages set:

    -
    - -if( Xchat::context_info->{flags} & (1 << 6) ) { - Xchat::print( "Hide Join/Part messages is enabled" ); -} - -
    - -
    id Unique server ID
    laglag in milliseconds
    maxmodes Maximum modes per line
    network network name to which this channel belongs
    nickprefixes Nickname prefixes e.g. "+@"
    nickmodes Nickname mode chars e.g. "vo"
    queuenumber of bytes in the send queue
    server server name to which this channel belongs
    type the type of this context
    - 1 - server
    - 2 - channel
    - 3 - dialog
    - 4 - notices
    - 5 - server notices
    -
    users Number of users in this channel
    - -

    "dcc" - list of DCC file transfers

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Key Value
    address32 address of the remote user(ipv4 address)
    cps bytes per second(speed)
    destfile destination full pathname
    file file name
    nicknick of the person this DCC connection is connected to
    port TCP port number
    pos bytes sent/received
    poshigh bytes sent/received, high order 32 bits
    resume point at which this file was resumed
    - (zero if it was not resumed) -
    resumehigh point at which this file was resumed, high order 32 bits
    -
    size file size in bytes low order 32 bits
    sizehigh file size in bytes, high order 32 bits (when the files is > 4GB)
    status DCC Status:
    - 0 - queued
    - 1 - active
    - 2 - failed
    - 3 - done
    - 4 - connecting
    - 5 - aborted -
    type DCC Type:
    - 0 - send
    - 1 - receive
    - 2 - chatrecv
    - 3 - chatsend -
    - -

    "ignore" - current ignore list

    - - - - - - - - - - - - - - -
    Key Value
    mask ignore mask. e.g: *!*@*.aol.com
    flags Bit field of flags.
    - 0 - private
    - 1 - notice
    - 2 - channel
    - 3 - ctcp
    - 4 - invite
    - 5 - unignore
    - 6 - nosave
    - 7 - dcc
    -
    - -

    "notify" - list of people on notify

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Key Value
    networkscomma separated list of networks where you will be notfified about this user's online/offline status or undef if you will be notificed on every network you are connected to
    nick nickname
    flags 0 = is online
    on time when user came online
    off time when user went offline
    seen time when user was last verified still online
    - -

    the values indexed by on, off and seen can be passed to localtime -and gmtime, see perldoc -f localtime and perldoc -f gmtime for more -detail

    - -

    "users" - list of users in the current channel

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Key Value
    away away status(boolean)
    lasttalklast time a user was seen talking, this is the an epoch time(number of seconds since a certain date, that date depends on the OS)
    nick nick name
    hosthost name in the form: user@host or undef if not known
    prefix prefix character, .e.g: @ or +
    realnameReal name or undef
    selectedselected status in the user list, only works when retrieving the user list of the focused tab. You can use the /USELECT command to select the nicks
    - -

    "networks" - list of networks and the associated settings from network list

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Key Value
    autojoins An object with the following methods:
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    MethodDescription
    channels()returns a list of this networks' autojoin channels in list context, a count of the number autojoin channels in scalar context
    keys()returns a list of the keys to go with the channels, the order is the same as the channels, if a channel doesn't have a key, '' will be returned in it's place
    pairs()a combination of channels() and keys(), returns a list of (channels, keys) pairs. This can be assigned to a hash for a mapping from channel to key.
    as_hash()return the pairs as a hash reference
    as_string()the original string that was used to construct this autojoin object, this can be used with the JOIN command to join all the channels in the autojoin list
    as_array()return an array reference of hash references consisting of the keys "channel" and "key"
    as_bool()returns true if the network has autojoins and false otherwise
    -
    connect_commands An array reference containing the connect commands for a network. An empty array if there aren't any
    encoding the encoding for the network
    flags - a hash reference corresponding to the checkboxes in the network edit window - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    allow_invalidtrue if "Accept invalid SSL certificate" is checked
    autoconnecttrue if "Auto connect to this network at startup" is checked
    cycletrue if "Connect to selected server only" is NOT checked
    use_globaltrue if "Use global user information" is checked
    use_proxytrue if "Bypass proxy server" is NOT checked
    use_ssltrue if "Use SSL for all the servers on this network" is checked
    -
    irc_nick1Corresponds with the "Nick name" field in the network edit window
    irc_nick2Corresponds with the "Second choice" field in the network edit window
    irc_real_nameCorresponds with the "Real name" field in the network edit window
    irc_user_nameCorresponds with the "User name" field in the network edit window
    networkName of the network
    nickserv_passwordCorresponds with the "Nickserv password" field in the network edit window
    selectedIndex into the list of servers in the "servers" key, this is used if the "cycle" flag is false
    server_passwordCorresponds with the "Server password" field in the network edit window
    serversAn array reference of hash references with a "host" and "port" key. If a port is not specified then 6667 will be used.
    - -=end html - -=head3 C - -=over 3 - -=item * -C<$nick> - the nick to look for, if this is not given your own nick will be - used as default - -=back - -This function is mainly intended to be used as a shortcut for when you need -to retrieve some information about only one user in a channel. Otherwise it -is better to use L. -If C<$nick> is found a hash reference containing the same keys as those in the -"users" list of L is returned otherwise undef is returned. -Since it relies on L this function can only be used in a -channel context. - -=head3 C - -=over 3 - -=item * -C<$context> - context returned from L, L and L, this is the context that you want infomation about. If this is omitted, it will default to current context. - -=back - -This function will return the information normally retrieved with L, except this is for the context that is passed in. The information will be returned in the form of a hash. The keys of the hash are the C<$id> you would normally supply to L as well as all the keys that are valid for the items in the "channels" list from L. Use of this function is more efficient than calling get_list( "channels" ) and searching through the result. - -=begin html - -

    Example:

    -
    -use strict; -use warnings; -use Xchat qw(:all); # imports all the functions documented on this page - -register( "User Count", "0.1", - "Print out the number of users on the current channel" ); - -hook_command( "UCOUNT", \&display_count ); - -sub display_count { - prnt "There are " . context_info()->{users} . " users in this channel."; - return EAT_XCHAT; -} -
    - -=end html - -=head3 C - -=over 3 - -=item * -C<$string> - string to remove codes from - -=back - -This function will remove bold, color, beep, reset, reverse and underline codes from C<$string>. It will also remove ANSI escape codes which might get used by certain terminal based clients. If it is called in void context C<$string> will be modified otherwise a modified copy of C<$string> is returned. - -=head2 Examples - -=head3 Asynchronous DNS resolution with hook_fd - -=begin html - -
    - -use strict; -use warnings; -use Xchat qw(:all); -use Net::DNS; - -hook_command( "BGDNS", sub { - my $host = $_[0][1]; - my $resolver = Net::DNS::Resolver->new; - my $sock = $resolver->bgsend( $host ); - - hook_fd( $sock, sub { - my $ready_sock = $_[0]; - my $packet = $resolver->bgread( $ready_sock ); - - if( $packet->authority && (my @answers = $packet->answer ) ) { - - if( @answers ) { - prnt "$host:"; - my $padding = " " x (length( $host ) + 2); - for my $answer ( @answers ) { - prnt $padding . $answer->rdatastr . ' ' . $answer->type; - } - } - } else { - prnt "Unable to resolve $host"; - } - - return REMOVE; - }, - { - flags => FD_READ, - }); - - return EAT_XCHAT; -}); - -
    - -=end html - -=head2 Contact Information - -Contact Lian Wan Situ at Eatmcmnky [at] yahoo.comE for questions, comments and -corrections about this page or the Perl plugin itself. You can also find me -in #xchat on FreeNode under the nick Khisanth. diff --git a/plugins/perl/syntax_highlight b/plugins/perl/syntax_highlight deleted file mode 100644 index 96d57003..00000000 --- a/plugins/perl/syntax_highlight +++ /dev/null @@ -1,69 +0,0 @@ -#!/usr/bin/env perl -use 5.010; -use strict; -use warnings; -use Text::VimColor; -use HTML::TokeParser::Simple; -use HTML::Entities qw(decode_entities); -use Path::Class; - -my $html_file = shift; -my $reader = file( $html_file )->openr; -unlink $html_file; -my $writer = file( $html_file )->openw; - -my $parser = HTML::TokeParser::Simple->new( $reader ); - -while( my $token = $parser->get_token ) { - - my $class_name = $token->get_attr( "class" ); - - if( $token->is_start_tag( "div" ) - && ( $class_name && $class_name =~ qr/\bexample\b/ ) - ) { - my $start_tag = $token; - $start_tag->set_attr( class => $class_name . " synNormal" ); - my @content; - my $end_tag; - - EXAMPLE: - while( $token = $parser->get_token ) { - if( $token->is_end_tag( "div" ) ) { - $end_tag = $token; - last EXAMPLE; - } - - if( $token->is_text ) { - push @content, decode_entities( $token->as_is ); - } - } - - my $code = join "", @content; -# say $code; - my $vim = Text::VimColor->new( - string => $code, - filetype => "perl", - vim_options => [qw( -RXZ -i NONE -u NONE -N -n)], - ); - my $html = $vim->html; - $html =~ s/^\s+//; - $html =~ s/\s+$//; - - print $writer $start_tag->as_is; - - my $lines = $html =~ tr/\n/\n/; - - say $writer "
    "; - for my $line ( 0 .. $lines ) { - say $writer "
    ",1 + $line,"
    "; - } - say $writer "
    "; - - print $writer "
    ";
    -		say $writer $html;
    -		say $writer "
    "; - print $writer $end_tag->as_is; - } else { - print $writer $token->as_is; - } -} diff --git a/plugins/perl/xcperl_build.bat b/plugins/perl/xcperl_build.bat deleted file mode 100644 index 6f569c47..00000000 --- a/plugins/perl/xcperl_build.bat +++ /dev/null @@ -1,43 +0,0 @@ -perl generate_header - -gcc -W -Os -DWIN32 -I "C:\MinGW\include" -I .. -I "C:\ActivePerl-5.8.9\perl\lib\CORE" -L "C:\ActivePerl-5.8.9\perl\bin" -c perl.c -o perl5.8.9.o - -dllwrap --def perl.def --dllname xcperl5.8.9.dll "C:\ActivePerl-5.8.9\perl\bin\perl58.dll" perl5.8.9.o - -strip xcperl5.8.9.dll - - - -gcc -W -Os -DWIN32 -I "C:\MinGW\include" -I .. -I "C:\Perl\lib\CORE" -L "C:\Perl\bin" -c perl.c -o perl5.10.0.o - -dllwrap --def perl.def --dllname xcperl5.10.0.dll "C:\Perl\bin\perl510.dll" perl5.10.0.o - -strip xcperl5.10.0.dll - - -gcc -W -Os -DWIN32 -I "C:\MinGW\include" -I .. -I "C:\ActivePerl-5.10.1\perl\lib\CORE" -L "C:\ActivePerl-5.10.1\perl\bin" -c perl.c -o perl5.10.1.o - -dllwrap --def perl.def --dllname xcperl5.10.1.dll "C:\ActivePerl-5.10.1\perl\bin\perl510.dll" perl5.10.1.o - -strip xcperl5.10.1.dll - - -gcc -W -Os -DWIN32 -I "C:\MinGW\include" -I .. -I "C:\ActivePerl-5.12.1\perl\lib\CORE" -L "C:\ActivePerl-5.12.1\perl\bin" -c perl.c -o perl5.12.1.o - -dllwrap --def perl.def --dllname xcperl5.12.1.dll "C:\ActivePerl-5.12.1\perl\bin\perl512.dll" perl5.12.1.o - -strip xcperl5.12.1.dll - -gcc -W -Os -DWIN32 -I "C:\MinGW\include" -I .. -I "C:\strawberry-perl-5.10.1.3\perl\lib\CORE" -L "C:\strawberry-perl-5.10.1.3\perl\bin" -c perl.c -o perl-strawberry5.10.1.o - -dllwrap --def perl.def --dllname xcperl-strawberry5.10.1.dll "C:\strawberry-perl-5.10.1.3\perl\bin\perl510.dll" perl5.10.1.o - -strip xcperl-strawberry5.10.1.dll - - -gcc -W -Os -DWIN32 -I "C:\MinGW\include" -I .. -I "C:\strawberry-perl-5.12.1.0-portable\perl\lib\CORE" -L "C:\strawberry-perl-5.12.1.0-portable\perl\bin" -c perl.c -o perl-strawberry5.12.1.o - -dllwrap --def perl.def --dllname xcperl-strawberry5.12.1.dll "C:\strawberry-perl-5.12.1.0-portable\perl\bin\perl512.dll" perl5.12.1.o - -strip xcperl-strawberry5.12.1.dll - -- cgit 1.4.1