X-Git-Url: http://git.ieval.ro/?a=blobdiff_plain;f=lib%2FPod%2FConstants.pm;h=a66ee0cf7e166a3708d4eb3e3d7a10f54f82e162;hb=refs%2Ftags%2F0.18;hp=0ad1a556f9d3941b5e79b9d6608a463efd169e6a;hpb=e18addae1712737d97002f3a98aafeb1f26592fc;p=pod-constants.git

diff --git a/lib/Pod/Constants.pm b/lib/Pod/Constants.pm
index 0ad1a55..a66ee0c 100644
--- a/lib/Pod/Constants.pm
+++ b/lib/Pod/Constants.pm
@@ -1,17 +1,205 @@
-# Copyright (C) 2001, 2002, 2007 Sam Vilain.  All Rights Reserved.
-# This module is free software. It may be used, redistributed and/or
-# modified under the terms of the Perl Artistic License, version 2 or
-# later, OR the terms of the GNU General Public License, v3 or later.
-
 package Pod::Constants;
 
+use 5.006002;
+use strict;
+use warnings;
+
+use base qw(Pod::Parser Exporter);
+use Carp;
+
+our $VERSION = 0.18;
+
+# An ugly hack to go from caller() to the relevant parser state
+# variable
+my %parsers;
+
+sub end_input {
+	#my ($parser, $command, $paragraph, $line_num) = (@_);
+	my $parser = shift;
+
+	return unless $parser->{active};
+
+	print "Found end of $parser->{active}\n" if $parser->{DEBUG};
+	my $whereto = $parser->{wanted_pod_tags}->{$parser->{active}};
+	print "\$_ will be set to:\n---\n$parser->{paragraphs}\n---\n" if $parser->{DEBUG};
+
+	$parser->{paragraphs} =~ s/^\s*|\s*$//gs if $parser->{trimmed_tags}->{$parser->{active}};
+
+	if (ref $whereto eq 'CODE') {
+		print "calling sub\n" if $parser->{DEBUG};
+		local ($_) = $parser->{paragraphs};
+		$whereto->();
+		print "done\n" if $parser->{DEBUG};
+	} elsif (ref $whereto eq 'SCALAR') {
+		print "inserting into scalar\n" if $parser->{DEBUG};
+		$$whereto = $parser->{paragraphs};
+	} elsif (ref $whereto eq 'ARRAY') {
+		print "inserting into array\n" if $parser->{DEBUG};
+		@$whereto = split /\n/, $parser->{paragraphs};
+	} elsif (ref $whereto eq 'HASH') {
+		print "inserting into hash\n" if $parser->{DEBUG};
+		# Oh, sorry, should I be in LISP101?
+		%$whereto = (
+			map { map { s/^\s*|\s*$//g; $_ } split /=>/ } grep m/^
+					 ( (?:[^=]|=[^>])+ )   # scan up to "=>"
+					 =>
+					 ( (?:[^=]|=[^>])+ =? )# don't allow more "=>"'s
+					 $/x, split /\n/, $parser->{paragraphs},);
+	} else { die $whereto }
+	$parser->{active} = undef;
+}
+
+# Pod::Parser overloaded command
+sub command {
+	my ($parser, $command, $paragraph, $line_num) = @_;
+
+	$paragraph =~ s/(?:\r\n|\n\r)/\n/g;
+
+	print "Got command =$command, value=$paragraph\n" if $parser->{DEBUG};
+
+	$parser->end_input() if $parser->{active};
+
+	my ($lookup);
+	# first check for a catch-all for this command type
+	if ( exists $parser->{wanted_pod_tags}->{"*$command"} ) {
+		$parser->{paragraphs} = $paragraph;
+		$parser->{active} = "*$command";
+	} elsif ($command =~ m/^(head\d+|item|(for|begin))$/) {
+		if ( $2 ) {
+			# if it's a "for" or "begin" section, the title is the
+			# first word only
+			($lookup, $parser->{paragraphs}) = $paragraph =~ m/^\s*(\S*)\s*(.*)/s;
+		} else {
+			# otherwise, it's up to the end of the line
+			($lookup, $parser->{paragraphs}) = $paragraph =~ m/^\s*(\S[^\n]*?)\s*\n(.*)$/s;
+		}
+
+		# Look for a match by name
+		if (defined $lookup && exists $parser->{wanted_pod_tags}->{$lookup}) {
+			print "Found $lookup\n" if ($parser->{DEBUG});
+			$parser->{active} = $lookup;
+		} elsif ($parser->{DEBUG}) {
+			local $^W = 0;
+			print "Ignoring =$command $paragraph (lookup = $lookup)\n"
+		}
+
+	} else {
+		# nothing
+		print "Ignoring =$command (not known)\n" if $parser->{DEBUG};
+	}
+}
+
+# Pod::Parser overloaded verbatim
+sub verbatim {
+	my ($parser, $paragraph, $line_num) = @_;
+	$paragraph =~ s/(?:\r\n|\n\r)/\n/g;
+
+	my $status = $parser->{active} ? 'using' : 'ignoring';
+	print "Got paragraph: $paragraph ($status)\n" if $parser->{DEBUG};
+
+	$parser->{paragraphs} .= $paragraph if defined $parser->{active}
+}
+
+# Pod::Parser overloaded textblock
+sub textblock { goto \&verbatim }
+
+sub import {
+	my $class = shift;
+
+	# if no args, just return
+	return unless (@_);
+
+	# try to guess the source file of the caller
+	my $source_file;
+	if (caller ne 'main') {
+		(my $module = caller.'.pm') =~ s|::|/|g;
+		$source_file = $INC{$module};
+	}
+	$source_file ||= $0;
+
+	croak "Cannot find source file (guessed $source_file) for package ".caller unless -f $source_file;
+
+	# nasty tricks with the stack so we don't have to be silly with
+	# caller()
+	unshift @_, $source_file;
+	goto \&import_from_file;
+}
+
+sub import_from_file {
+	my $filename = shift;
+
+	my $parser = __PACKAGE__->new();
+
+	$parser->{wanted_pod_tags} = {};
+	$parser->{trimmed_tags} = {};
+	$parser->{trim_next} = 0;
+	$parser->{DEBUG} = 0;
+	$parser->{active} = undef;
+	$parsers{caller()} = $parser;
+
+	$parser->add_hook(@_);
+
+	print "Pod::Parser: DEBUG: Opening $filename for reading\n" if $parser->{DEBUG};
+	open my $fh, '<', $filename or croak "cannot open $filename for reading; $!";
+
+	$parser->parse_from_filehandle($fh, \*STDOUT);
+
+	close $fh;
+}
+
+sub add_hook {
+	my $parser;
+	if (eval { $_[0]->isa(__PACKAGE__) }) {
+		$parser = shift;
+	} else {
+		$parser = $parsers{caller()} or croak 'add_hook called, but don\'t know what for - caller = '.caller;
+	}
+	while (my ($pod_tag, $var) = splice @_, 0, 2) {
+		#print "$pod_tag: $var\n";
+		if (lc($pod_tag) eq '-trim') {
+			$parser->{trim_next} = $var;
+		} elsif ( lc($pod_tag) eq '-debug' ) {
+			$parser->{DEBUG} = $var;
+		} elsif (lc($pod_tag) eq '-usage') {
+			# an idea for later - automatic "usage"
+			#%wanted_pod_tags{@tags}
+		} else {
+			if ((ref $var) =~ /^(?:SCALAR|CODE|ARRAY|HASH)$/) {
+				print "Will look for $pod_tag.\n" if $parser->{DEBUG};
+				$parser->{wanted_pod_tags}->{$pod_tag} = $var;
+				$parser->{trimmed_tags}->{$pod_tag} = 1 if $parser->{trim_next};
+			} else {
+				croak "Sorry - need a reference to import POD sections into, not the scalar value $var"
+			}
+		}
+	}
+}
+
+sub delete_hook {
+	my $parser;
+	if (eval { $_[0]->isa(__PACKAGE__) }) {
+		$parser = shift;
+	} else {
+		$parser = $parsers{caller()} or croak 'delete_hook called, but don\'t know what for - caller = '.caller;
+	}
+	while ( my $label = shift ) {
+		delete $parser->{wanted_pod_tags}->{$label};
+		delete $parser->{trimmed_tags}->{$label};
+	}
+}
+
+1;
+__END__
+
+=encoding utf-8
+
 =head1 NAME
 
 Pod::Constants - Include constants from POD
 
 =head1 SYNOPSIS
 
- use vars qw($myvar $VERSION @myarray $html %myhash);
+ our ($myvar, $VERSION, @myarray, $html, %myhash);
 
  use Pod::Constants -trim => 1,
      'Pod Section Name' => \$myvar,
@@ -29,7 +217,7 @@ Pod::Constants - Include constants from POD
  # This is an example of using a closure.  $_ is set to the
  # contents of the paragraph.  In this example, "eval" is
  # used to execute this code at run time.
- $VERSION = 0.17;
+ $VERSION = 0.18;
 
  =head2 Some list
 
@@ -76,131 +264,6 @@ For `for' and `begin' sections, only the first word is counted as
 being a part of the specifier, as opposed to `headN' and `item', where
 the entire rest of the line counts.
 
-=cut
-
-use 5.004;
-use strict;
-
-use base qw(Pod::Parser Exporter);
-use Data::Dumper;
-use Carp;
-
-use vars qw($VERSION);
-$VERSION = 0.17;
-
-# An ugly hack to go from caller() to the relevant parser state
-# variable
-my %parsers;
-
-sub end_input {
-    #my ($parser, $command, $paragraph, $line_num) = (@_);
-    my $parser = shift;
-
-    return unless $parser->{active};
-
-    print "Found end of $parser->{active}\n" if ($parser->{DEBUG});
-    my $whereto = $parser->{wanted_pod_tags}->{$parser->{active}};
-    print "\$_ will be set to:\n---\n$parser->{paragraphs}\n---\n"
-	if ($parser->{DEBUG});
-
-    $parser->{paragraphs} =~ s/^\s*|\s*$//gs
-	if $parser->{trimmed_tags}->{$parser->{active}};
-
-    if (ref $whereto eq "CODE") {
-	print "calling sub\n" if $parser->{DEBUG};
-	local ($_) = $parser->{paragraphs};
-	$whereto->();
-	print "done\n" if $parser->{DEBUG};
-    } elsif (ref $whereto eq "SCALAR") {
-	print "inserting into scalar\n" if $parser->{DEBUG};
-	$$whereto = $parser->{paragraphs};
-    } elsif (ref $whereto eq "ARRAY") {
-	print "inserting into array\n" if $parser->{DEBUG};
-	@$whereto = split /\n/, $parser->{paragraphs};
-    } elsif (ref $whereto eq "HASH") {
-	print "inserting into hash\n" if $parser->{DEBUG};
-	# Oh, sorry, should I be in LISP101?
-	%$whereto = (map { map { s/^\s*|\s*$//g; $_ }
-			       split /=>/, $_ }
-		     grep m/^
-			    ( (?:[^=]|=[^>])+ )   # scan up to "=>"
-			    =>
-			    ( (?:[^=]|=[^>])+ =? )# don't allow more "=>"'s
-			    $/x,
-		     split /\n/, $parser->{paragraphs});
-    } else { die $whereto }
-    $parser->{active} = undef;
-}
-
-# Pod::Parser overloaded command
-sub command {
-    my ($parser, $command, $paragraph, $line_num) = @_;
-
-    $paragraph =~ s/(?:\r\n|\n\r)/\n/g;
-
-    print "Got command =$command, value=$paragraph\n"
-	if $parser->{DEBUG};
-
-    $parser->end_input() if $parser->{active};
-
-    my $does_she_want_it_sir;
-
-    my ($lookup);
-    # first check for a catch-all for this command type
-    if ( exists $parser->{wanted_pod_tags}->{"*$command"} ) {
-	$parser->{paragraphs} = $paragraph;
-	$parser->{active} = "*$command";
-	$does_she_want_it_sir = "oohw";
-
-    } elsif ($command =~ m/^(head\d+|item|(for|begin))$/) {
-	if ( $2 ) {
-	    # if it's a "for" or "begin" section, the title is the
-	    # first word only
-	    ($lookup, $parser->{paragraphs}) =
-		($paragraph =~ m/^\s*(\S*)\s*(.*)/s);
-	} else {
-	    # otherwise, it's up to the end of the line
-	    ($lookup, $parser->{paragraphs})
-		= ($paragraph =~ m/^\s*(\S[^\n]*?)\s*\n(.*)$/s);
-	}
-
-	# Look for a match by name
-	if (defined $lookup
-	    and exists $parser->{wanted_pod_tags}->{$lookup}) {
-	    print "Found $lookup\n" if ($parser->{DEBUG});
-	    $parser->{active} = $lookup;
-	    $does_she_want_it_sir = "suits you sir";
-	}
-
-    } else {
-	# nothing
-	print "Ignoring =$command (not known)\n" if $parser->{DEBUG};
-    }
-
-    {
-	local $^W = 0;
-	print "Ignoring =$command $paragraph (lookup = $lookup)\n"
-	    if (!$does_she_want_it_sir and $parser->{DEBUG})
-    }
-}
-
-# Pod::Parser overloaded verbatim
-sub verbatim {
-    my ($parser, $paragraph, $line_num) = @_;
-    $paragraph =~ s/(?:\r\n|\n\r)/\n/g;
-
-    print("Got paragraph: $paragraph ("
-	  .($parser->{active}?"using":"ignoring").")\n")
-	if $parser->{DEBUG};
-
-    if (defined $parser->{active}) {
-	$parser->{paragraphs} .= $paragraph;
-    }
-}
-
-# Pod::Parser overloaded textblock
-sub textblock { goto \&verbatim }
-
 =head1 FUNCTIONS
 
 =head2 import(@args)
@@ -250,11 +313,11 @@ Hash:
   HOOK => sub {
   %hash =
       (map { map { s/^\s+|\s+$//g; $_ } split /=>/, $_ }
-	    (grep m/^
-		    ( (?:[^=]|=[^>])+ )   # scan up to "=>"
-		    =>
-		    ( (?:[^=]|=[^>])+ =? )# don't allow more "=>"'s
-		    $/x, split /\n/, $_));
+        (grep m/^
+            ( (?:[^=]|=[^>])+ )   # scan up to "=>"
+            =>
+            ( (?:[^=]|=[^>])+ =? )# don't allow more "=>"'s
+            $/x, split /\n/, $_));
   }
 
 Well, they're simple if you can grok map, a regular expression like
@@ -273,66 +336,11 @@ Here's the procedural equivalent:
      }
   },
 
-=cut
-
-sub import {
-    my $class = shift;
-
-    # if no args, just return
-    return unless (@_);
-
-    # try to guess the source file of the caller
-    my $source_file;
-    if (caller ne "main") {
-	(my $module = caller().".pm") =~ s|::|/|g;
-	$source_file = $INC{$module};
-    }
-    $source_file ||= $0;
-
-    ( -f $source_file )
-	or croak ("Cannot find source file (guessed $source_file) for"
-		  ." package ".caller());
-
-    # nasty tricks with the stack so we don't have to be silly with
-    # caller()
-    unshift @_, $source_file;
-    goto \&import_from_file;
-}
-
 =head2 import_from_file($filename, @args)
 
 Very similar to straight "import", but you specify the source filename
 explicitly.
 
-=cut
-
-use IO::Handle;
-
-sub import_from_file {
-    my $filename = shift;
-
-    my $parser = __PACKAGE__->new();
-
-    $parser->{wanted_pod_tags} = {};
-    $parser->{trimmed_tags} = {};
-    $parser->{trim_next} = 0;
-    $parser->{DEBUG} = 0;
-    $parser->{active} = undef;
-    $parsers{caller()} = $parser;
-
-    $parser->add_hook(@_);
-
-    print "Pod::Parser: DEBUG: Opening $filename for reading\n"
-	if $parser->{DEBUG};
-    my $fh = new IO::Handle;
-    open $fh, "<$filename"
-	or die ("cannot open $filename for reading; $!");
-
-    $parser->parse_from_filehandle($fh, \*STDOUT);
-
-    close $fh;
-}
-
 =head2 add_hook(NAME => value)
 
 This function adds another hook, it is useful for dynamic updating of
@@ -342,63 +350,10 @@ For an example, please see t/01-constants.t in the source
 distribution.  More detailed examples will be added in a later
 release.
 
-=cut
-
-sub add_hook {
-    my $parser;
-    if ( UNIVERSAL::isa($_[0], __PACKAGE__) ) {
-	$parser = shift;
-    } else {
-	$parser = $parsers{caller()}
-	    or die("add_hook called, but don't know what for - "
-		   ."caller = ".caller());
-    }
-    while (my ($pod_tag, $var) = splice @_, 0, 2) {
-	#print "$pod_tag: $var\n";
-	if (lc($pod_tag) eq "-trim") {
-	    $parser->{trim_next} = $var;
-	} elsif ( lc($pod_tag) eq "-debug" ) {
-	    $parser->{DEBUG} = $var;
-	} elsif (lc($pod_tag) eq "-usage") {
-	    # an idea for later - automatic "usage"
-	    #%wanted_pod_tags{@tags}
-	} else {
-	    if ((ref $var) =~ /^(?:SCALAR|CODE|ARRAY|HASH)$/) {
-		print "Will look for $pod_tag.\n"
-		    if ($parser->{DEBUG});
-		$parser->{wanted_pod_tags}->{$pod_tag} = $var;
-		$parser->{trimmed_tags}->{$pod_tag} = 1
-		    if $parser->{trim_next};
-	    } else {
-		die ("Sorry - need a reference to import POD "
-		     ."sections into, not the scalar value $var"
-		     ." importing $pod_tag into ".caller());
-	    }
-	}
-    }
-}
-
 =head2 delete_hook(@list)
 
 Deletes the named hooks.  Companion function to add_hook
 
-=cut
-
-sub delete_hook {
-    my $parser;
-    if ( UNIVERSAL::isa($_[0], __PACKAGE__) ) {
-	$parser = shift;
-    } else {
-	$parser = $parsers{caller()}
-	    or die("delete_hook called, but don't know what for - "
-		   ."caller = ".caller());
-    }
-    while ( my $label = shift ) {
-	delete $parser->{wanted_pod_tags}->{$label};
-	delete $parser->{trimmed_tags}->{$label};
-    }
-}
-
 =head2 CLOSURES AS DESTINATIONS
 
 If the given value is a ref CODE, then that function is called, with
@@ -443,7 +398,7 @@ method seems to break dh-make-perl.
 
  WriteMakefile
      (
-      'NAME'		=> $NAME,
+      'NAME'        => $NAME,
       'PREREQ_PM'        => $PREREQ_PM,
       'VERSION'          => $VERSION,
       ($] >= 5.005 ?    ## Add these new keywords supported since 5.005
@@ -473,7 +428,7 @@ method seems to break dh-make-perl.
 
  =cut
 
- use vars qw($VERSION);
+ our $VERSION;
  use Pod::Constants -trim => 1,
      'MODULE RELEASE' => sub { ($VERSION) = m/(\d+\.\d+) or die };
 
@@ -481,6 +436,16 @@ method seems to break dh-make-perl.
 
 Sam Vilain, <samv@cpan.org>
 
+Maintained by Marius Gavrilescu, <marius@ieval.ro> since July 2015
+
+=head1 COPYRIGHT AND LICENSE
+
+Copyright (C) 2001, 2002, 2007 Sam Vilain. All Rights Reserved.
+Copyright (C) 2015 by Marius Gavrilescu <marius@ieval.ro>
+
+This module is free software. It may be used, redistributed and/or
+modified under the terms of the Perl Artistic License, version 2
+
 =head1 BUGS/TODO
 
 I keep thinking it would be nice to be able to import an =item list
@@ -495,24 +460,5 @@ Would this be useful?
 
 Debug output is not very readable
 
-=head1 PATCHES WELCOME
-
-If you have any suggestions for enhancements, they are much more likely
-to happen if you submit them as a patch to the distribution.
-
-Source is kept at
-
-  git://utsl.gen.nz/Pod-Constants 
 
 =cut
-
-BEGIN {
-    Pod::Constants->import
-	    (
-	     SYNOPSIS => sub {
-		 eval pop @{[ grep /^\s*\$VERSION/, split /\n/, $_ ]}
-	     }
-	    )
-};
-
-1.4142;