local-lib5/man/man3/PPI::Normal.3pm

   1 .\" Automatically generated by Pod::Man 2.22 (Pod::Simple 3.10)
   2 .\"
   3 .\" Standard preamble:
   4 .\" ========================================================================
   5 .de Sp \" Vertical space (when we can't use .PP)
   6 .if t .sp .5v
   7 .if n .sp
   8 ..
   9 .de Vb \" Begin verbatim text
  10 .ft CW
  11 .nf
  12 .ne \\$1
  13 ..
  14 .de Ve \" End verbatim text
  15 .ft R
  16 .fi
  17 ..
  18 .\" Set up some character translations and predefined strings.  \*(-- will
  19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  20 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
  21 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
  22 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
  23 .\" nothing in troff, for use with C<>.
  24 .tr \(*W-
  25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  26 .ie n \{\
  27 .    ds -- \(*W-
  28 .    ds PI pi
  29 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  30 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  31 .    ds L" ""
  32 .    ds R" ""
  33 .    ds C` ""
  34 .    ds C' ""
  35 'br\}
  36 .el\{\
  37 .    ds -- \|\(em\|
  38 .    ds PI \(*p
  39 .    ds L" ``
  40 .    ds R" ''
  41 'br\}
  42 .\"
  43 .\" Escape single quotes in literal strings from groff's Unicode transform.
  44 .ie \n(.g .ds Aq \(aq
  45 .el       .ds Aq '
  46 .\"
  47 .\" If the F register is turned on, we'll generate index entries on stderr for
  48 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
  49 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  50 .\" output yourself in some meaningful fashion.
  51 .ie \nF \{\
  52 .    de IX
  53 .    tm Index:\\$1\t\\n%\t"\\$2"
  54 ..
  55 .    nr % 0
  56 .    rr F
  57 .\}
  58 .el \{\
  59 .    de IX
  60 ..
  61 .\}
  62 .\"
  63 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  64 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  65 .    \" fudge factors for nroff and troff
  66 .if n \{\
  67 .    ds #H 0
  68 .    ds #V .8m
  69 .    ds #F .3m
  70 .    ds #[ \f1
  71 .    ds #] \fP
  72 .\}
  73 .if t \{\
  74 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  75 .    ds #V .6m
  76 .    ds #F 0
  77 .    ds #[ \&
  78 .    ds #] \&
  79 .\}
  80 .    \" simple accents for nroff and troff
  81 .if n \{\
  82 .    ds ' \&
  83 .    ds ` \&
  84 .    ds ^ \&
  85 .    ds , \&
  86 .    ds ~ ~
  87 .    ds /
  88 .\}
  89 .if t \{\
  90 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
  91 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
  92 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
  93 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
  94 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
  95 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
  96 .\}
  97 .    \" troff and (daisy-wheel) nroff accents
  98 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
  99 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 100 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 101 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 102 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 103 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 104 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 105 .ds ae a\h'-(\w'a'u*4/10)'e
 106 .ds Ae A\h'-(\w'A'u*4/10)'E
 107 .    \" corrections for vroff
 108 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 109 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 110 .    \" for low resolution devices (crt and lpr)
 111 .if \n(.H>23 .if \n(.V>19 \
 112 \{\
 113 .    ds : e
 114 .    ds 8 ss
 115 .    ds o a
 116 .    ds d- d\h'-1'\(ga
 117 .    ds D- D\h'-1'\(hy
 118 .    ds th \o'bp'
 119 .    ds Th \o'LP'
 120 .    ds ae ae
 121 .    ds Ae AE
 122 .\}
 123 .rm #[ #] #H #V #F C
 124 .\" ========================================================================
 125 .\"
 126 .IX Title "PPI::Normal 3"
 127 .TH PPI::Normal 3 "2009-08-08" "perl v5.8.7" "User Contributed Perl Documentation"
 128 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 129 .\" way too many mistakes in technical documents.
 130 .if n .ad l
 131 .nh
 132 .SH "NAME"
 133 PPI::Normal \- Normalize Perl Documents
 134 .SS "\s-1DESCRIPTION\s0"
 135 .IX Subsection "DESCRIPTION"
 136 Perl Documents, as created by \s-1PPI\s0, are typically filled with all sorts of
 137 mess such as whitespace and comments and other things that don't effect
 138 the actual meaning of the code.
 139 .PP
 140 In addition, because there is more than one way to do most things, and the
 141 syntax of Perl itself is quite flexible, there are many ways in which the
 142 \&\*(L"same\*(R" code can look quite different.
 143 .PP
 144 PPI::Normal attempts to resolve this by providing a variety of mechanisms
 145 and algorithms to \*(L"normalize\*(R" Perl Documents, and determine a sort of base
 146 form for them (although this base form will be a memory structure, and
 147 not something that can be turned back into Perl source code).
 148 .PP
 149 The process itself is quite complex, and so for convenience and
 150 extensibility it has been separated into a number of layers. At a later
 151 point, it will be possible to write Plugin classes to insert additional
 152 normalization steps into the various different layers.
 153 .PP
 154 In addition, you can choose to do the normalization only as deep as a
 155 particular layer, depending on aggressively you want the normalization
 156 process to be.
 157 .SH "METHODS"
 158 .IX Header "METHODS"
 159 .ie n .SS "register $function => $layer, ..."
 160 .el .SS "register \f(CW$function\fP => \f(CW$layer\fP, ..."
 161 .IX Subsection "register $function => $layer, ..."
 162 The \f(CW\*(C`register\*(C'\fR method is used by normalization method providers to
 163 tell the normalization engines which functions need to be run, and
 164 in which layer they apply.
 165 .PP
 166 Provide a set of key/value pairs, where the key is the full name of the
 167 function (in string form), and the value is the layer (see description
 168 of the layers above) in which it should be run.
 169 .PP
 170 Returns true if all functions are registered, or \f(CW\*(C`undef\*(C'\fR on error.
 171 .SS "new"
 172 .IX Subsection "new"
 173 .Vb 2
 174 \&  my $level_1 = PPI::Normal\->new;
 175 \&  my $level_2 = PPI::Normal\->new(2);
 176 .Ve
 177 .PP
 178 Creates a new normalization object, to which Document objects
 179 can be passed to be normalized.
 180 .PP
 181 Of course, what you probably \s-1REALLY\s0 want is just to call
 182 PPI::Document's \f(CW\*(C`normalize\*(C'\fR method.
 183 .PP
 184 Takes an optional single parameter of the normalisation layer
 185 to use, which at this time can be either \*(L"1\*(R" or \*(L"2\*(R".
 186 .PP
 187 Returns a new \f(CW\*(C`PPI::Normal\*(C'\fR object, or \f(CW\*(C`undef\*(C'\fR on error.
 188 .SH "layer"
 189 .IX Header "layer"
 190 The \f(CW\*(C`layer\*(C'\fR accessor returns the normalisation layer of the object.
 191 .SS "process"
 192 .IX Subsection "process"
 193 The \f(CW\*(C`process\*(C'\fR method takes anything that can be converted to a
 194 PPI::Document (object, \s-1SCALAR\s0 ref, filename), loads it and
 195 applies the normalisation process to the document.
 196 .PP
 197 Returns a PPI::Document::Normalized object, or \f(CW\*(C`undef\*(C'\fR on error.
 198 .SH "NOTES"
 199 .IX Header "NOTES"
 200 The following normalisation layers are implemented. When writing
 201 plugins, you should register each transformation function with the
 202 appropriate layer.
 203 .SS "Layer 1 \- Insignificant Data Removal"
 204 .IX Subsection "Layer 1 - Insignificant Data Removal"
 205 The basic step common to all normalization, layer 1 scans through the
 206 Document and removes all whitespace, comments, \s-1POD\s0, and anything else
 207 that returns false for its \f(CW\*(C`significant\*(C'\fR method.
 208 .PP
 209 It also checks each Element and removes known-useless sub-element
 210 metadata such as the Element's physical position in the file.
 211 .SS "Layer 2 \- Significant Element Removal"
 212 .IX Subsection "Layer 2 - Significant Element Removal"
 213 After the removal of the insignificant data, Layer 2 removed larger, more
 214 complex, and superficially \*(L"significant\*(R" elements, that can be removed
 215 for the purposes of normalisation.
 216 .PP
 217 Examples from this layer include pragmas, now-useless statement
 218 separators (since the \s-1PDOM\s0 tree is holding statement elements), and
 219 several other minor bits and pieces.
 220 .SS "Layer 3 \- \s-1TO\s0 \s-1BE\s0 \s-1COMPLETED\s0"
 221 .IX Subsection "Layer 3 - TO BE COMPLETED"
 222 This version of the forward-port of the Perl::Compare functionality
 223 to the 0.900+ \s-1API\s0 of \s-1PPI\s0 only implements Layer 1 and 2 at this time.
 224 .SH "TO DO"
 225 .IX Header "TO DO"
 226 \&\- Write the other 4\-5 layers :)
 227 .SH "SUPPORT"
 228 .IX Header "SUPPORT"
 229 See the support section in the main module.
 230 .SH "AUTHOR"
 231 .IX Header "AUTHOR"
 232 Adam Kennedy <adamk@cpan.org>
 233 .SH "COPYRIGHT"
 234 .IX Header "COPYRIGHT"
 235 Copyright 2005 Adam Kennedy.
 236 .PP
 237 This program is free software; you can redistribute
 238 it and/or modify it under the same terms as Perl itself.
 239 .PP
 240 The full text of the license can be found in the
 241 \&\s-1LICENSE\s0 file included with this module.