ExtUtils/typemap: better error messages + constant string optimization
[p5sagit/p5-mst-13.2.git] / lib / Text / Wrap.pm
index 602cdab..b0e15a7 100644 (file)
@@ -6,10 +6,10 @@ require Exporter;
 @EXPORT = qw(wrap fill);
 @EXPORT_OK = qw($columns $break $huge);
 
-$VERSION = 2001.09293;
+$VERSION = 2006.0711;
 
 use vars qw($VERSION $columns $debug $break $huge $unexpand $tabstop
-       $separator);
+       $separator $separator2);
 use strict;
 
 BEGIN  {
@@ -20,6 +20,7 @@ BEGIN {
        $unexpand = 1;
        $tabstop = 8;
        $separator = "\n";
+       $separator2 = undef;
 }
 
 use Text::Tabs qw(expand unexpand);
@@ -42,8 +43,8 @@ sub wrap
        use re 'taint';
 
        pos($t) = 0;
-       while ($t !~ /\G\s*\Z/gc) {
-               if ($t =~ /\G([^\n]{0,$ll})($break|\n*\z)/xmgc) {
+       while ($t !~ /\G(?:$break)*\Z/gc) {
+               if ($t =~ /\G([^\n]{0,$ll})($break|\n+|\z)/xmgc) {
                        $r .= $unexpand 
                                ? unexpand($nl . $lead . $1)
                                : $nl . $lead . $1;
@@ -52,21 +53,29 @@ sub wrap
                        $r .= $unexpand 
                                ? unexpand($nl . $lead . $1)
                                : $nl . $lead . $1;
-                       $remainder = $separator;
-               } elsif ($huge eq 'overflow' && $t =~ /\G([^\n]*?)($break|\z)/xmgc) {
+                       $remainder = defined($separator2) ? $separator2 : $separator;
+               } elsif ($huge eq 'overflow' && $t =~ /\G([^\n]*?)($break|\n+|\z)/xmgc) {
                        $r .= $unexpand 
                                ? unexpand($nl . $lead . $1)
                                : $nl . $lead . $1;
                        $remainder = $2;
                } elsif ($huge eq 'die') {
                        die "couldn't wrap '$t'";
+               } elsif ($columns < 2) {
+                       warn "Increasing \$Text::Wrap::columns from $columns to 2";
+                       $columns = 2;
+                       return ($ip, $xp, @t);
                } else {
                        die "This shouldn't happen";
                }
                        
                $lead = $xp;
                $ll = $nll;
-               $nl = $separator;
+               $nl = defined($separator2)
+                       ? ($remainder eq "\n"
+                               ? "\n"
+                               : $separator2)
+                       : $separator;
        }
        $r .= $remainder;
 
@@ -134,7 +143,7 @@ B<Example 2>
        $huge = 'overflow';
 
 B<Example 3>
-
+       
        use Text::Wrap
 
        $Text::Wrap::columns = 72;
@@ -143,11 +152,11 @@ B<Example 3>
 =head1 DESCRIPTION
 
 C<Text::Wrap::wrap()> is a very simple paragraph formatter.  It formats a
-single paragraph at a time by breaking lines at word boundries.
+single paragraph at a time by breaking lines at word boundaries.
 Indentation is controlled for the first line (C<$initial_tab>) and
 all subsequent lines (C<$subsequent_tab>) independently.  Please note: 
 C<$initial_tab> and C<$subsequent_tab> are the literal strings that will
-be used: it is unlikley you would want to pass in a number.
+be used: it is unlikely you would want to pass in a number.
 
 Text::Wrap::fill() is a simple multi-paragraph formatter.  It formats
 each paragraph separately and then joins them together when it's done.  It
@@ -155,6 +164,8 @@ will destroy any whitespace in the original text.  It breaks text into
 paragraphs by looking for whitespace after a newline.  In other respects
 it acts like wrap().
 
+Both C<wrap()> and C<fill()> return a single string.
+
 =head1 OVERRIDES
 
 C<Text::Wrap::wrap()> has a number of variables that control its behavior.
@@ -188,7 +199,10 @@ want to use 8-character tabstops, set C<$Text::Wrap::tabstop> to
 the number of characters you do want for your tabstops.
 
 If you want to separate your lines with something other than C<\n>
-then set C<$Text::Wrap::separator> to your preference.
+then set C<$Text::Wrap::separator> to your preference.  This replaces
+all newlines with C<$Text::Wrap::separator>.  If you just to preserve
+existing newlines but add new breaks with something else, set 
+C<$Text::Wrap::separator2> instead.
 
 When words that are longer than C<$columns> are encountered, they
 are broken up.  C<wrap()> adds a C<"\n"> at column C<$columns>.
@@ -200,13 +214,36 @@ left intact.
 Historical notes: 'die' used to be the default value of
 C<$huge>.  Now, 'wrap' is the default value.
 
-=head1 EXAMPLE
+=head1 EXAMPLES
+
+Code:
+
+  print wrap("\t","",<<END);
+  This is a bit of text that forms 
+  a normal book-style indented paragraph
+  END
+
+Result:
+
+  "    This is a bit of text that forms
+  a normal book-style indented paragraph   
+  "
+
+Code:
+
+  $Text::Wrap::columns=20;
+  $Text::Wrap::separator="|";
+  print wrap("","","This is a bit of text that forms a normal book-style paragraph");
+
+Result:
 
-       print wrap("\t","","This is a bit of text that forms 
-               a normal book-style paragraph");
+  "This is a bit of|text that forms a|normal book-style|paragraph"
 
-=head1 AUTHOR
+=head1 LICENSE
 
 David Muir Sharnoff <muir@idiom.com> with help from Tim Pierce and
-many many others.  
+many many others.  Copyright (C) 1996-2006 David Muir Sharnoff.  
+This module may be modified, used, copied, and redistributed at
+your own risk.  Publicly redistributed modified versions must use 
+a different name.