ppi::token::whitespace(3) [osx man page]

PPI::Token::Whitespace(3)				User Contributed Perl Documentation				 PPI::Token::Whitespace(3)

NAME

       PPI::Token::Whitespace - Tokens representing ordinary white space

INHERITANCE

	 PPI::Token::Whitespace
	 isa PPI::Token
	     isa PPI::Element

DESCRIPTION

       As a full "round-trip" parser, PPI records every last byte in a file and ensure that it is included in the PPI::Document object.

       This even includes whitespace. In fact, Perl documents are seen as "floating in a sea of whitespace", and thus any document will contain
       vast quantities of "PPI::Token::Whitespace" objects.

       For the most part, you shouldn't notice them. Or at least, you shouldn't have to notice them.

       This means doing things like consistently using the "S for significant" series of PPI::Node and PPI::Element methods to do things.

       If you want the nth child element, you should be using "schild" rather than "child", and likewise "snext_sibling", "sprevious_sibling", and
       so on and so forth.

METHODS

       Again, for the most part you should really not need to do anything very significant with whitespace.

       But there are a couple of convenience methods provided, beyond those provided by the parent PPI::Token and PPI::Element classes.

   null
       Because PPI sees documents as sitting on a sort of substrate made of whitespace, there are a couple of corner cases that get particularly
       nasty if they don't find whitespace in certain places.

       Imagine walking down the beach to go into the ocean, and then quite unexpectedly falling off the side of the planet. Well it's somewhat
       equivalent to that, including the whole screaming death bit.

       The "null" method is a convenience provided to get some internals out of some of these corner cases.

       Specifically it create a whitespace token that represents nothing, or at least the null string ''. It's a handy way to have some
       "whitespace" right where you need it, without having to have any actual characters.

   tidy
       "tidy" is a convenience method for removing unneeded whitespace.

       Specifically, it removes any whitespace from the end of a line.

       Note that this doesn't include POD, where you may well need to keep certain types of whitespace. The entire POD chunk lives in its own
       PPI::Token::Pod object.

SUPPORT

       See the support section in the main module.

AUTHOR

       Adam Kennedy <adamk@cpan.org>

COPYRIGHT

       Copyright 2001 - 2011 Adam Kennedy.

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

       The full text of the license can be found in the LICENSE file included with this module.

perl v5.16.2							    2011-02-25						 PPI::Token::Whitespace(3)

Check Out this Related Man Page

PPI::Token::Comment(3)					User Contributed Perl Documentation				    PPI::Token::Comment(3)

NAME

       PPI::Token::Comment - A comment in Perl source code

INHERITANCE

	 PPI::Token::Comment
	 isa PPI::Token
	     isa PPI::Element

SYNOPSIS

	 # This is a PPI::Token::Comment

	 print "Hello World!"; # So it this

	 $string =~ s/ foo  # This, unfortunately, is not :(
	       bar
	       /w;

DESCRIPTION

       In PPI, comments are represented by "PPI::Token::Comment" objects.

       These come in two flavours, line comment and inline comments.

       A "line comment" is a comment that stands on its own line. These comments hold their own newline and whitespace (both leading and trailing)
       as part of the one "PPI::Token::Comment" object.

       An inline comment is a comment that appears after some code, and continues to the end of the line. This does not include whitespace, and
       the terminating newlines is considered a separate PPI::Token::Whitespace token.

       This is largely a convenience, simplifying a lot of normal code relating to the common things people do with comments.

       Most commonly, it means when you "prune" or "delete" a comment, a line comment disappears taking the entire line with it, and an inline
       comment is removed from the inside of the line, allowing the newline to drop back onto the end of the code, as you would expect.

       It also means you can move comments around in blocks much more easily.

       For now, this is a suitably handy way to do things. However, I do reserve the right to change my mind on this one if it gets dangerously
       anachronistic somewhere down the line.

METHODS

       Only very limited methods are available, beyond those provided by our parent PPI::Token and PPI::Element classes.

   line
       The "line" accessor returns true if the "PPI::Token::Comment" is a line comment, or false if it is an inline comment.

SUPPORT

       See the support section in the main module.

AUTHOR

       Adam Kennedy <adamk@cpan.org>

COPYRIGHT

       Copyright 2001 - 2011 Adam Kennedy.

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

       The full text of the license can be found in the LICENSE file included with this module.

perl v5.18.2							    2011-02-25						    PPI::Token::Comment(3)

Linux and UNIX Man Pages

ppi::token::whitespace(3) [osx man page]

Check Out this Related Man Page