Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

ppi::document::normalized(3) [osx man page]

PPI::Document::Normalized(3)				User Contributed Perl Documentation			      PPI::Document::Normalized(3)

NAME
PPI::Document::Normalized - A normalized Perl Document DESCRIPTION
A "Normalized Document" object is the result of the normalization process contained in the PPI::Normal class. See the documentation for PPI::Normal for more information. The object contains a version stamp and function list for the version of PPI::Normal used to create it, and a processed and delinked PPI::Document object. Typically, the Document object will have been mangled by the normalization process in a way that would make it fatal to try to actually DO anything with it. Put simply, never use the Document object after normalization. YOU HAVE BEEN WARNED! The object is designed the way it is to provide a bias towards false negatives. A comparison between two ::Normalized object will only return true if they were produced by the same version of PPI::Normal, with the same set of normalization functions (in the same order). You may get false negatives if you are caching objects across an upgrade. Please note that this is done for security purposes, as there are many cases in which low layer normalization is likely to be done as part of a code security process, and false positives could be highly dangerous. METHODS
new The "new" method is intended for use only by the PPI::Normal class, and to get ::Normalized objects, you are highly recommended to use either that module, or the "normalized" method of the PPI::Document object itself. version The "version" accessor returns the PPI::Normal version used to create the object. functions The "functions" accessor returns a reference to an array of the normalization functions (in order) that were called when creating the object. equal $Normalized The "equal" method is the primary comparison method, taking another PPI::Document::Normalized object, and checking for equivalence to it. The "==" operator is also overload to this method, so that you can do something like the following: my $first = PPI::Document->load('first.pl'); my $second = PPI::Document->load('second.pl'); if ( $first->normalized == $second->normalized ) { print "The two documents are equivalent"; } Returns true if the normalized documents are equivalent, false if not, or "undef" if there is an error. SUPPORT
See the support section in the main module. AUTHOR
Adam Kennedy <adamk@cpan.org> COPYRIGHT
Copyright 2005 - 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::Document::Normalized(3)

Check Out this Related Man Page

PPI::Document::File(3)					User Contributed Perl Documentation				    PPI::Document::File(3)

NAME
PPI::Document::File - A Perl Document located in a specific file DESCRIPTION
WARNING: This class is experimental, and may change without notice PPI::Document::File provides a PPI::Document subclass that represents a Perl document stored in a specific named file. METHODS
new my $file = PPI::Document::File->new( 'Module.pm' ); The "new" constructor works the same as for the regular one, except that the only params allowed is a file name. You cannot create an "anonymous" PPI::Document::File object, not can you create an empty one. Returns a new PPI::Document::File object, or "undef" on error. filename The "filename" accessor returns the name of the file in which the document is stored. save # Save to the file we were loaded from $file->save; # Save a copy to somewhere else $file->save( 'Module2.pm' ); The "save" method works similarly to the one in the parent PPI::Document class, saving a copy of the document to a file. The difference with this subclass is that if "save" is not passed any filename, it will save it back to the file it was loaded from. Note: When saving to a different file, it is considered to be saving a copy and so the value returned by the "filename" accessor will stay the same, and not change to the new filename. TO DO
- May need to overload some methods to forcefully prevent Document objects becoming children of another Node. 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.3 2011-02-26 PPI::Document::File(3)
Man Page