require Exporter;
-@ISA = (Exporter);
-@EXPORT = qw(wrap);
-@EXPORT_OK = qw($columns);
+@ISA = qw(Exporter);
+@EXPORT = qw(wrap fill);
+@EXPORT_OK = qw($columns $break $huge);
-$VERSION = 96.041801;
+$VERSION = 2001.0131;
-use vars qw($VERSION $columns $debug);
+use vars qw($VERSION $columns $debug $break $huge);
use strict;
BEGIN {
$columns = 76; # <= screen width
$debug = 0;
+ $break = '\s';
+ $huge = 'wrap'; # alternatively: 'die' or 'overflow'
}
-use Text::Tabs;
+use Text::Tabs qw(expand unexpand);
sub wrap
{
my ($ip, $xp, @t) = @_;
my $r = "";
- my $t = expand(join(" ",@t));
+ my $tail = pop(@t);
+ my $t = expand(join("", (map { /\s+\Z/ ? ( $_ ) : ($_, ' ') } @t), $tail));
my $lead = $ip;
- my $ll = $columns - length(expand($lead)) - 1;
+ my $ll = $columns - length(expand($ip)) - 1;
+ my $nll = $columns - length(expand($xp)) - 1;
my $nl = "";
-
- # remove up to a line length of things that aren't
- # new lines and tabs.
-
- if ($t =~ s/^([^\n]{0,$ll})(\s|\Z(?!\n))//xm) {
-
- # accept it.
- $r .= unexpand($lead . $1);
-
- # recompute the leader
- $lead = $xp;
- $ll = $columns - length(expand($lead)) - 1;
- $nl = $2;
-
- # repeat the above until there's none left
- while ($t and $t =~ s/^([^\n]{0,$ll})(\s|\Z(?!\n))//xm) {
- print "\$2 is '$2'\n" if $debug;
- $nl = $2;
- $r .= unexpand("\n" . $lead . $1);
+ my $remainder = "";
+
+ pos($t) = 0;
+ while ($t !~ /\G\s*\Z/gc) {
+ if ($t =~ /\G([^\n]{0,$ll})($break|\Z(?!\n))/xmgc) {
+ $r .= unexpand($nl . $lead . $1);
+ $remainder = $2;
+ } elsif ($huge eq 'wrap' && $t =~ /\G([^\n]{$ll})/gc) {
+ $r .= unexpand($nl . $lead . $1);
+ $remainder = "\n";
+ } elsif ($huge eq 'overflow' && $t =~ /\G([^\n]*?)($break|\Z(?!\n))/xmgc) {
+ $r .= unexpand($nl . $lead . $1);
+ $remainder = $2;
+ } elsif ($huge eq 'die') {
+ die "couldn't wrap '$t'";
+ } else {
+ die "This shouldn't happen";
}
- $r .= $nl;
- }
-
- die "couldn't wrap '$t'"
- if length($t) > $ll;
+
+ $lead = $xp;
+ $ll = $nll;
+ $nl = "\n";
+ }
+ $r .= $remainder;
print "-----------$r---------\n" if $debug;
- print "Finish up with '$lead', '$t'\n" if $debug;
+ print "Finish up with '$lead'\n" if $debug;
- $r .= $lead . $t if $t ne "";
+ $r .= $lead . substr($t, pos($t), length($t)-pos($t))
+ if pos($t) ne length($t);
print "-----------$r---------\n" if $debug;;
+
return $r;
}
+sub fill
+{
+ my ($ip, $xp, @raw) = @_;
+ my @para;
+ my $pp;
+
+ for $pp (split(/\n\s+/, join("\n",@raw))) {
+ $pp =~ s/\s+/ /g;
+ my $x = wrap($ip, $xp, $pp);
+ push(@para, $x);
+ }
+
+ # if paragraph_indent is the same as line_indent,
+ # separate paragraphs with blank lines
+
+ my $ps = ($ip eq $xp) ? "\n\n" : "\n";
+ return join ($ps, @para);
+}
1;
-__DATA__
+__END__
=head1 NAME
=head1 SYNOPSIS
+B<Example 1>
+
use Text::Wrap
+ $initial_tab = "\t"; # Tab before first line
+ $subsequent_tab = ""; # All other lines flush left
+
print wrap($initial_tab, $subsequent_tab, @text);
+ print fill($initial_tab, $subsequent_tab, @text);
- use Text::Wrap qw(wrap $columns);
+ @lines = wrap($initial_tab, $subsequent_tab, @text);
- $columns = 132;
+ @paragraphs = fill($initial_tab, $subsequent_tab, @text);
-=head1 DESCRIPTION
+B<Example 2>
-Text::Wrap::wrap() is a very simple paragraph formatter. It formats a
-single paragraph at a time by breaking lines at word boundries.
-Indentation is controlled for the first line ($initial_tab) and
-all subsquent lines ($subsequent_tab) independently. $Text::Wrap::columns
-should be set to the full width of your output device.
+ use Text::Wrap qw(wrap $columns $huge);
-=head1 EXAMPLE
-
- print wrap("\t","","This is a bit of text that forms
- a normal book-style paragraph");
+ $columns = 132; # Wrap at 132 characters
+ $huge = 'die';
+ $huge = 'wrap';
+ $huge = 'overflow';
-=head1 AUTHOR
+B<Example 3>
-David Muir Sharnoff <muir@idiom.com> with help from Tim Pierce and
-others.
+ use Text::Wrap
-=cut
+ $Text::Wrap::columns = 72;
+ print wrap('', '', @text);
- print fill($initial_tab, $subsequent_tab, @text);
+=head1 DESCRIPTION
- print fill("", "", `cat book`);
+Text::Wrap::wrap() is a very simple paragraph formatter. It formats a
+single paragraph at a time by breaking lines at word boundries.
+Indentation is controlled for the first line (C<$initial_tab>) and
+all subsquent 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.
+
+Lines are wrapped at C<$Text::Wrap::columns> columns. C<$Text::Wrap::columns>
+should be set to the full width of your output device. In fact,
+every resulting line will have length of no more than C<$columns - 1>.
+
+Beginner note: In example 2, above C<$columns> is imported into
+the local namespace, and set locally. In example 3,
+C<$Text::Wrap::columns> is set in its own namespace without importing it.
+
+When words that are longer than C<$columns> are encountered, they
+are broken up. C<wrap()> adds a C<"\n"> at column C<$columns>.
+This behavior can be overridden by setting C<$huge> to
+'die' or to 'overflow'. When set to 'die', large words will cause
+C<die()> to be called. When set to 'overflow', large words will be
+left intact.
Text::Wrap::fill() is a simple multi-paragraph formatter. It formats
each paragraph separately and then joins them together when it's done. It
paragraphs by looking for whitespace after a newline. In other respects
it acts like wrap().
-# Tim Pierce did a faster version of this:
+When called in list context, C<wrap()> will return a list of lines and
+C<fill()> will return a list of paragraphs.
-sub fill
-{
- my ($ip, $xp, @raw) = @_;
- my @para;
- my $pp;
+Historical notes: Older versions of C<wrap()> and C<fill()> always
+returned strings. Also, 'die' used to be the default value of
+C<$huge>. Now, 'wrap' is the default value.
- for $pp (split(/\n\s+/, join("\n",@raw))) {
- $pp =~ s/\s+/ /g;
- my $x = wrap($ip, $xp, $pp);
- push(@para, $x);
- }
+=head1 EXAMPLE
- # if paragraph_indent is the same as line_indent,
- # separate paragraphs with blank lines
+ print wrap("\t","","This is a bit of text that forms
+ a normal book-style paragraph");
- return join ($ip eq $xp ? "\n\n" : "\n", @para);
-}
+=head1 AUTHOR
+
+David Muir Sharnoff <muir@idiom.com> with help from Tim Pierce and
+many many others.
projects / p5sagit/p5-mst-13.2.git / blobdiff