From Code to Community: Sponsoring The Perl and Raku Conference 2025 Learn more

 / 
Text-OutdentEdge-0.01
River stage zero No dependents
/ Text::OutdentEdge

NAME

Text::OutdentEdge - remove indent chars.

VERSION

Version 0.01

SYNOPSIS


            

              
              
use Text::OutdentEdge qw(xoutdent);
print <<INDENT, xoutdent <<XOUTDENT;
  Hello, World!
INDENT
  X Hello, Edged-Outdent!
XOUTDENT
# ==> print "  Hello, World!\n", "Hello, Edged-Outdent!\n";

EXPORT

This Module can export two function.

FUNCTIONS

xoutdent


            

              
              
my $text = xoutdent $in;
my $text = xoutdent $in, $opts;

This function removed edged-indent. For example:


            

              
              
print xoutdent <<TEXT;
  X Hello,
  X World!
TEXT

just prints two words, "Hello" and "World!" on each lines.

This function take two arguments. First one is target text which may be indented. Second one is optional hash-ref. Options are:

indent => $regexp

specifies what are removed. Default is qr/[ \t]+/;

xchar => $regexp

specifies edge-string regexp. Default is qr/\S([ \t]|$)/;

chomp => $flag

specifies whether chomp result text. Default is false.

trim => $flag

specified whether trimming spaces of multiline q{..}. Default is true.

outdent


            

              
              
my $text = outdent $in;
my $text = outdent $in, qr/^ {4}/;
my $text = outdent $in, $opts;

This function take two arguments. This function is same as:


            

              
              
xoutdent $in, { %$opts, indent => minimum-indent, xchar => '', }

If regexp is passed as second argument, it treated as { indent = $regexp, xchar => '', }>.

AUTHOR

YAMASHINA Hio, <hio at cpan.org>

BUGS

Please report any bugs or feature requests to bug-text-outdentedge at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Text-OutdentEdge. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT

You can find documentation for this module with the perldoc command.


            

              
              
perldoc Text::OutdentEdge

You can also look for information at:

ACKNOWLEDGEMENTS

COPYRIGHT & LICENSE

Copyright 2006 YAMASHINA Hio, all rights reserved.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.