local-lib5/man/man3/PPI::Transform.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::Transform 3"
 127 .TH PPI::Transform 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::Transform \- Abstract base class for document transformation classes
 134 .SH "DESCRIPTION"
 135 .IX Header "DESCRIPTION"
 136 \&\f(CW\*(C`PPI::Transform\*(C'\fR provides an \s-1API\s0 for the creation of classes and objects
 137 that modify or transform \s-1PPI\s0 documents.
 138 .SH "METHODS"
 139 .IX Header "METHODS"
 140 .SS "new"
 141 .IX Subsection "new"
 142 .Vb 4
 143 \&  my $transform = PPI::Transform\->new(
 144 \&      param1 => \*(Aqvalue1\*(Aq,
 145 \&      param2 => \*(Aqvalue2\*(Aq,
 146 \&  );
 147 .Ve
 148 .PP
 149 The \f(CW\*(C`new\*(C'\fR constructor creates a new object for your \f(CW\*(C`PPI::Transform\*(C'\fR
 150 subclass. A default constructor is provided for you which takes no params
 151 and creates a basic, empty, object.
 152 .PP
 153 If you wish to have your transform constructor take params, these \fBmust\fR
 154 be in the form of a list of key/value pairs.
 155 .PP
 156 Returns a new \f(CW\*(C`PPI::Transform\*(C'\fR\-compatible object, or returns
 157 \&\f(CW\*(C`undef\*(C'\fR on error.
 158 .SS "document"
 159 .IX Subsection "document"
 160 The \f(CW\*(C`document\*(C'\fR method should be implemented by each subclass, and
 161 takes a single argument of a PPI::Document object, modifying it
 162 \&\fBin place\fR as appropriate for the particular transform class.
 163 .PP
 164 That's right, this method \fBwill not clone\fR and \fBshould not clone\fR
 165 the document object. If you do not want the original to be modified,
 166 you need to clone it yourself before passing it in.
 167 .PP
 168 Returns the numbers of changes made to the document. If the transform
 169 is unable to track the quantity (including the situation where it cannot
 170 tell \fB\s-1IF\s0\fR it made a change) it should return 1. Returns zero if no
 171 changes were made to the document, or \f(CW\*(C`undef\*(C'\fR if an error occurs.
 172 .PP
 173 By default this error is likely to only mean that you passed in something
 174 that wasn't a PPI::Document, but may include additional errors
 175 depending on the subclass.
 176 .SS "apply"
 177 .IX Subsection "apply"
 178 The \f(CW\*(C`apply\*(C'\fR method is used to apply the transform to something. The
 179 argument must be a PPI::Document, or something which can be turned
 180 into a one and then be written back to again.
 181 .PP
 182 Currently, this list is limited to a \f(CW\*(C`SCALAR\*(C'\fR reference, although a
 183 handler registration process is available for you to add support for
 184 additional types of object should you wish (see the source for this module).
 185 .PP
 186 Returns true if the transform was applied, false if there is an error in the
 187 transform process, or may die if there is a critical error in the apply
 188 handler.
 189 .SS "file"
 190 .IX Subsection "file"
 191 .Vb 2
 192 \&  # Read from one file and write to another
 193 \&  $transform\->file( \*(AqInput.pm\*(Aq => \*(AqOutput.pm\*(Aq );
 194 \&
 195 \&  # Change a file in place
 196 \&  $transform\->file( \*(AqChange.pm\*(Aq );
 197 .Ve
 198 .PP
 199 The \f(CW\*(C`file\*(C'\fR method modifies a Perl document by filename. If passed a single
 200 parameter, it modifies the file in-place. If provided a second parameter,
 201 it will attempt to save the modified file to the alternative filename.
 202 .PP
 203 Returns true on success, or \f(CW\*(C`undef\*(C'\fR on error.
 204 .SH "SUPPORT"
 205 .IX Header "SUPPORT"
 206 See the support section in the main module.
 207 .SH "AUTHOR"
 208 .IX Header "AUTHOR"
 209 Adam Kennedy <adamk@cpan.org>
 210 .SH "COPYRIGHT"
 211 .IX Header "COPYRIGHT"
 212 Copyright 2001 \- 2009 Adam Kennedy.
 213 .PP
 214 This program is free software; you can redistribute
 215 it and/or modify it under the same terms as Perl itself.
 216 .PP
 217 The full text of the license can be found in the
 218 \&\s-1LICENSE\s0 file included with this module.