docs/Tidy.html

   1 <?xml version="1.0" ?>
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
   3 <html xmlns="http://www.w3.org/1999/xhtml">
   4 <head>
   5 <title></title>
   6 <meta http-equiv="content-type" content="text/html; charset=utf-8" />
   7 <link rev="made" href="mailto:root@localhost" />
   8 </head>
   9
  10 <body>
  11
  12
  13
  14 <ul id="index">
  15   <li><a href="#NAME">NAME</a></li>
  16   <li><a href="#SYNOPSIS">SYNOPSIS</a></li>
  17   <li><a href="#DESCRIPTION">DESCRIPTION</a></li>
  18   <li><a href="#ERROR-HANDLING">ERROR HANDLING</a></li>
  19   <li><a href="#NOTES-ON-FORMATTING-PARAMETERS">NOTES ON FORMATTING PARAMETERS</a></li>
  20   <li><a href="#EXAMPLES">EXAMPLES</a></li>
  21   <li><a href="#Using-the-formatter-Callback-Object">Using the formatter Callback Object</a></li>
  22   <li><a href="#EXPORT">EXPORT</a></li>
  23   <li><a href="#VERSION">VERSION</a></li>
  24   <li><a href="#LICENSE">LICENSE</a></li>
  25   <li><a href="#BUG-REPORTS">BUG REPORTS</a></li>
  26   <li><a href="#SEE-ALSO">SEE ALSO</a></li>
  27 </ul>
  28
  29 <h1 id="NAME">NAME</h1>
  30
  31 <p>Perl::Tidy - Parses and beautifies perl source</p>
  32
  33 <h1 id="SYNOPSIS">SYNOPSIS</h1>
  34
  35 <pre><code>    use Perl::Tidy;
  36
  37     my $error_flag = Perl::Tidy::perltidy(
  38         source            =&gt; $source,
  39         destination       =&gt; $destination,
  40         stderr            =&gt; $stderr,
  41         argv              =&gt; $argv,
  42         perltidyrc        =&gt; $perltidyrc,
  43         logfile           =&gt; $logfile,
  44         errorfile         =&gt; $errorfile,
  45         formatter         =&gt; $formatter,           # callback object (see below)
  46         dump_options      =&gt; $dump_options,
  47         dump_options_type =&gt; $dump_options_type,
  48         prefilter         =&gt; $prefilter_coderef,
  49         postfilter        =&gt; $postfilter_coderef,
  50     );</code></pre>
  51
  52 <h1 id="DESCRIPTION">DESCRIPTION</h1>
  53
  54 <p>This module makes the functionality of the perltidy utility available to perl scripts. Any or all of the input parameters may be omitted, in which case the @ARGV array will be used to provide input parameters as described in the perltidy(1) man page.</p>
  55
  56 <p>For example, the perltidy script is basically just this:</p>
  57
  58 <pre><code>    use Perl::Tidy;
  59     Perl::Tidy::perltidy();</code></pre>
  60
  61 <p>The call to <b>perltidy</b> returns a scalar <b>$error_flag</b> which is TRUE if an error caused premature termination, and FALSE if the process ran to normal completion. Additional discuss of errors is contained below in the <a href="#ERROR-HANDLING">&quot;ERROR HANDLING&quot;</a> section.</p>
  62
  63 <p>The module accepts input and output streams by a variety of methods. The following list of parameters may be any of the following: a filename, an ARRAY reference, a SCALAR reference, or an object with either a <b>getline</b> or <b>print</b> method, as appropriate.</p>
  64
  65 <pre><code>        source            - the source of the script to be formatted
  66         destination       - the destination of the formatted output
  67         stderr            - standard error output
  68         perltidyrc        - the .perltidyrc file
  69         logfile           - the .LOG file stream, if any
  70         errorfile         - the .ERR file stream, if any
  71         dump_options      - ref to a hash to receive parameters (see below),
  72         dump_options_type - controls contents of dump_options
  73         dump_getopt_flags - ref to a hash to receive Getopt flags
  74         dump_options_category - ref to a hash giving category of options
  75         dump_abbreviations    - ref to a hash giving all abbreviations</code></pre>
  76
  77 <p>The following chart illustrates the logic used to decide how to treat a parameter.</p>
  78
  79 <pre><code>   ref($param)  $param is assumed to be:
  80    -----------  ---------------------
  81    undef        a filename
  82    SCALAR       ref to string
  83    ARRAY        ref to array
  84    (other)      object with getline (if source) or print method</code></pre>
  85
  86 <p>If the parameter is an object, and the object has a <b>close</b> method, that close method will be called at the end of the stream.</p>
  87
  88 <dl>
  89
  90 <dt id="source">source</dt>
  91 <dd>
  92
  93 <p>If the <b>source</b> parameter is given, it defines the source of the input stream. If an input stream is defined with the <b>source</b> parameter then no other source filenames may be specified in the @ARGV array or <b>argv</b> parameter.</p>
  94
  95 </dd>
  96 <dt id="destination">destination</dt>
  97 <dd>
  98
  99 <p>If the <b>destination</b> parameter is given, it will be used to define the file or memory location to receive output of perltidy.</p>
 100
 101 </dd>
 102 <dt id="stderr">stderr</dt>
 103 <dd>
 104
 105 <p>The <b>stderr</b> parameter allows the calling program to redirect the stream that would otherwise go to the standard error output device to any of the stream types listed above. This stream contains important warnings and errors related to the parameters passed to perltidy.</p>
 106
 107 </dd>
 108 <dt id="perltidyrc">perltidyrc</dt>
 109 <dd>
 110
 111 <p>If the <b>perltidyrc</b> file is given, it will be used instead of any <i>.perltidyrc</i> configuration file that would otherwise be used.</p>
 112
 113 </dd>
 114 <dt id="errorfile">errorfile</dt>
 115 <dd>
 116
 117 <p>The <b>errorfile</b> parameter allows the calling program to capture the stream that would otherwise go to either a .ERR file. This stream contains warnings or errors related to the contents of one source file or stream.</p>
 118
 119 <p>The reason that this is different from the stderr stream is that when perltidy is called to process multiple files there will be up to one .ERR file created for each file and it would be very confusing if they were combined.</p>
 120
 121 <p>However if perltidy is called to process just a single perl script then it may be more convenient to combine the <b>errorfile</b> stream with the <b>stderr</b> stream. This can be done by setting the <b>-se</b> parameter, in which case this parameter is ignored.</p>
 122
 123 </dd>
 124 <dt id="logfile">logfile</dt>
 125 <dd>
 126
 127 <p>The <b>logfile</b> parameter allows the calling program to capture the log stream. This stream is only created if requested with a <b>-g</b> parameter. It contains detailed diagnostic information about a script which may be useful for debugging.</p>
 128
 129 </dd>
 130 <dt id="argv">argv</dt>
 131 <dd>
 132
 133 <p>If the <b>argv</b> parameter is given, it will be used instead of the <b>@ARGV</b> array. The <b>argv</b> parameter may be a string, a reference to a string, or a reference to an array. If it is a string or reference to a string, it will be parsed into an array of items just as if it were a command line string.</p>
 134
 135 </dd>
 136 <dt id="dump_options">dump_options</dt>
 137 <dd>
 138
 139 <p>If the <b>dump_options</b> parameter is given, it must be the reference to a hash. In this case, the parameters contained in any perltidyrc configuration file will be placed in this hash and perltidy will return immediately. This is equivalent to running perltidy with --dump-options, except that the perameters are returned in a hash rather than dumped to standard output. Also, by default only the parameters in the perltidyrc file are returned, but this can be changed (see the next parameter). This parameter provides a convenient method for external programs to read a perltidyrc file. An example program using this feature, <i>perltidyrc_dump.pl</i>, is included in the distribution.</p>
 140
 141 <p>Any combination of the <b>dump_</b> parameters may be used together.</p>
 142
 143 </dd>
 144 <dt id="dump_options_type">dump_options_type</dt>
 145 <dd>
 146
 147 <p>This parameter is a string which can be used to control the parameters placed in the hash reference supplied by <b>dump_options</b>. The possible values are &#39;perltidyrc&#39; (default) and &#39;full&#39;. The &#39;full&#39; parameter causes both the default options plus any options found in a perltidyrc file to be returned.</p>
 148
 149 </dd>
 150 <dt id="dump_getopt_flags">dump_getopt_flags</dt>
 151 <dd>
 152
 153 <p>If the <b>dump_getopt_flags</b> parameter is given, it must be the reference to a hash. This hash will receive all of the parameters that perltidy understands and flags that are passed to Getopt::Long. This parameter may be used alone or with the <b>dump_options</b> flag. Perltidy will exit immediately after filling this hash. See the demo program <i>perltidyrc_dump.pl</i> for example usage.</p>
 154
 155 </dd>
 156 <dt id="dump_options_category">dump_options_category</dt>
 157 <dd>
 158
 159 <p>If the <b>dump_options_category</b> parameter is given, it must be the reference to a hash. This hash will receive a hash with keys equal to all long parameter names and values equal to the title of the corresponding section of the perltidy manual. See the demo program <i>perltidyrc_dump.pl</i> for example usage.</p>
 160
 161 </dd>
 162 <dt id="dump_abbreviations">dump_abbreviations</dt>
 163 <dd>
 164
 165 <p>If the <b>dump_abbreviations</b> parameter is given, it must be the reference to a hash. This hash will receive all abbreviations used by Perl::Tidy. See the demo program <i>perltidyrc_dump.pl</i> for example usage.</p>
 166
 167 </dd>
 168 <dt id="prefilter">prefilter</dt>
 169 <dd>
 170
 171 <p>A code reference that will be applied to the source before tidying. It is expected to take the full content as a string in its input, and output the transformed content.</p>
 172
 173 </dd>
 174 <dt id="postfilter">postfilter</dt>
 175 <dd>
 176
 177 <p>A code reference that will be applied to the tidied result before outputting. It is expected to take the full content as a string in its input, and output the transformed content.</p>
 178
 179 <p>Note: A convenient way to check the function of your custom prefilter and postfilter code is to use the --notidy option, first with just the prefilter and then with both the prefilter and postfilter. See also the file <b>filter_example.pl</b> in the perltidy distribution.</p>
 180
 181 </dd>
 182 </dl>
 183
 184 <h1 id="ERROR-HANDLING">ERROR HANDLING</h1>
 185
 186 <p>Perltidy will return with an error flag indicating if the process had to be terminated early due to errors in the input parameters. This can happen for example if a parameter is misspelled or given an invalid value. The calling program should check this flag because if it is set the destination stream will be empty or incomplete and should be ignored. Error messages in the <b>stderr</b> stream will indicate the cause of any problem.</p>
 187
 188 <p>If the error flag is not set then perltidy ran to completion. However there may still be warning messages in the <b>stderr</b> stream related to control parameters, and there may be warning messages in the <b>errorfile</b> stream relating to possible syntax errors in the source code being tidied.</p>
 189
 190 <p>In the event of a catastrophic error for which recovery is not possible <b>perltidy</b> terminates by making calls to <b>croak</b> or <b>confess</b> to help the programmer localize the problem. These should normally only occur during program development.</p>
 191
 192 <h1 id="NOTES-ON-FORMATTING-PARAMETERS">NOTES ON FORMATTING PARAMETERS</h1>
 193
 194 <p>Parameters which control formatting may be passed in several ways: in a <i>.perltidyrc</i> configuration file, in the <b>perltidyrc</b> parameter, and in the <b>argv</b> parameter.</p>
 195
 196 <p>The <b>-syn</b> (<b>--check-syntax</b>) flag may be used with all source and destination streams except for standard input and output. However data streams which are not associated with a filename will be copied to a temporary file before being be passed to Perl. This use of temporary files can cause somewhat confusing output from Perl.</p>
 197
 198 <p>If the <b>-pbp</b> style is used it will typically be necessary to also specify a <b>-nst</b> flag. This is necessary to turn off the <b>-st</b> flag contained in the <b>-pbp</b> parameter set which otherwise would direct the output stream to the standard output.</p>
 199
 200 <h1 id="EXAMPLES">EXAMPLES</h1>
 201
 202 <p>The following example uses string references to hold the input and output code and error streams, and illustrates checking for errors.</p>
 203
 204 <pre><code>  use Perl::Tidy;
 205
 206   my $source_string = &lt;&lt;&#39;EOT&#39;;
 207   my$error=Perl::Tidy::perltidy(argv=&gt;$argv,source=&gt;\$source_string,
 208     destination=&gt;\$dest_string,stderr=&gt;\$stderr_string,
 209   errorfile=&gt;\$errorfile_string,);
 210   EOT
 211
 212   my $dest_string;
 213   my $stderr_string;
 214   my $errorfile_string;
 215   my $argv = &quot;-npro&quot;;   # Ignore any .perltidyrc at this site
 216   $argv .= &quot; -pbp&quot;;     # Format according to perl best practices
 217   $argv .= &quot; -nst&quot;;     # Must turn off -st in case -pbp is specified
 218   $argv .= &quot; -se&quot;;      # -se appends the errorfile to stderr
 219   ## $argv .= &quot; --spell-check&quot;;  # uncomment to trigger an error
 220
 221   print &quot;&lt;&lt;RAW SOURCE&gt;&gt;\n$source_string\n&quot;;
 222
 223   my $error = Perl::Tidy::perltidy(
 224       argv        =&gt; $argv,
 225       source      =&gt; \$source_string,
 226       destination =&gt; \$dest_string,
 227       stderr      =&gt; \$stderr_string,
 228       errorfile   =&gt; \$errorfile_string,    # ignored when -se flag is set
 229       ##phasers   =&gt; &#39;stun&#39;,                # uncomment to trigger an error
 230   );
 231
 232   if ($error) {
 233
 234       # serious error in input parameters, no tidied output
 235       print &quot;&lt;&lt;STDERR&gt;&gt;\n$stderr_string\n&quot;;
 236       die &quot;Exiting because of serious errors\n&quot;;
 237   }
 238
 239   if ($dest_string)      { print &quot;&lt;&lt;TIDIED SOURCE&gt;&gt;\n$dest_string\n&quot; }
 240   if ($stderr_string)    { print &quot;&lt;&lt;STDERR&gt;&gt;\n$stderr_string\n&quot; }
 241   if ($errorfile_string) { print &quot;&lt;&lt;.ERR file&gt;&gt;\n$errorfile_string\n&quot; }</code></pre>
 242
 243 <p>Additional examples are given in examples section of the perltidy distribution.</p>
 244
 245 <h1 id="Using-the-formatter-Callback-Object">Using the <b>formatter</b> Callback Object</h1>
 246
 247 <p>The <b>formatter</b> parameter is an optional callback object which allows the calling program to receive tokenized lines directly from perltidy for further specialized processing. When this parameter is used, the two formatting options which are built into perltidy (beautification or html) are ignored. The following diagram illustrates the logical flow:</p>
 248
 249 <pre><code>                    |-- (normal route)   -&gt; code beautification
 250   caller-&gt;perltidy-&gt;|-- (-html flag )    -&gt; create html
 251                     |-- (formatter given)-&gt; callback to write_line</code></pre>
 252
 253 <p>This can be useful for processing perl scripts in some way. The parameter <code>$formatter</code> in the perltidy call,</p>
 254
 255 <pre><code>        formatter   =&gt; $formatter,  </code></pre>
 256
 257 <p>is an object created by the caller with a <code>write_line</code> method which will accept and process tokenized lines, one line per call. Here is a simple example of a <code>write_line</code> which merely prints the line number, the line type (as determined by perltidy), and the text of the line:</p>
 258
 259 <pre><code> sub write_line {
 260
 261      # This is called from perltidy line-by-line
 262      my $self              = shift;
 263      my $line_of_tokens    = shift;
 264      my $line_type         = $line_of_tokens-&gt;{_line_type};
 265      my $input_line_number = $line_of_tokens-&gt;{_line_number};
 266      my $input_line        = $line_of_tokens-&gt;{_line_text};
 267      print &quot;$input_line_number:$line_type:$input_line&quot;;
 268  }</code></pre>
 269
 270 <p>The complete program, <b>perllinetype</b>, is contained in the examples section of the source distribution. As this example shows, the callback method receives a parameter <b>$line_of_tokens</b>, which is a reference to a hash of other useful information. This example uses these hash entries:</p>
 271
 272 <pre><code> $line_of_tokens-&gt;{_line_number} - the line number (1,2,...)
 273  $line_of_tokens-&gt;{_line_text}   - the text of the line
 274  $line_of_tokens-&gt;{_line_type}   - the type of the line, one of:
 275
 276     SYSTEM         - system-specific code before hash-bang line
 277     CODE           - line of perl code (including comments)
 278     POD_START      - line starting pod, such as &#39;=head&#39;
 279     POD            - pod documentation text
 280     POD_END        - last line of pod section, &#39;=cut&#39;
 281     HERE           - text of here-document
 282     HERE_END       - last line of here-doc (target word)
 283     FORMAT         - format section
 284     FORMAT_END     - last line of format section, &#39;.&#39;
 285     DATA_START     - __DATA__ line
 286     DATA           - unidentified text following __DATA__
 287     END_START      - __END__ line
 288     END            - unidentified text following __END__
 289     ERROR          - we are in big trouble, probably not a perl script</code></pre>
 290
 291 <p>Most applications will be only interested in lines of type <b>CODE</b>. For another example, let&#39;s write a program which checks for one of the so-called <i>naughty matching variables</i> <code>&amp;`</code>, <code>$&amp;</code>, and <code>$&#39;</code>, which can slow down processing. Here is a <b>write_line</b>, from the example program <b>find_naughty.pl</b>, which does that:</p>
 292
 293 <pre><code> sub write_line {
 294
 295      # This is called back from perltidy line-by-line
 296      # We&#39;re looking for $`, $&amp;, and $&#39;
 297      my ( $self, $line_of_tokens ) = @_;
 298
 299      # pull out some stuff we might need
 300      my $line_type         = $line_of_tokens-&gt;{_line_type};
 301      my $input_line_number = $line_of_tokens-&gt;{_line_number};
 302      my $input_line        = $line_of_tokens-&gt;{_line_text};
 303      my $rtoken_type       = $line_of_tokens-&gt;{_rtoken_type};
 304      my $rtokens           = $line_of_tokens-&gt;{_rtokens};
 305      chomp $input_line;
 306
 307      # skip comments, pod, etc
 308      return if ( $line_type ne &#39;CODE&#39; );
 309
 310      # loop over tokens looking for $`, $&amp;, and $&#39;
 311      for ( my $j = 0 ; $j &lt; @$rtoken_type ; $j++ ) {
 312
 313          # we only want to examine token types &#39;i&#39; (identifier)
 314          next unless $$rtoken_type[$j] eq &#39;i&#39;;
 315
 316          # pull out the actual token text
 317          my $token = $$rtokens[$j];
 318
 319          # and check it
 320          if ( $token =~ /^\$[\`\&amp;\&#39;]$/ ) {
 321              print STDERR
 322                &quot;$input_line_number: $token\n&quot;;
 323          }
 324      }
 325  }</code></pre>
 326
 327 <p>This example pulls out these tokenization variables from the $line_of_tokens hash reference:</p>
 328
 329 <pre><code>     $rtoken_type = $line_of_tokens-&gt;{_rtoken_type};
 330      $rtokens     = $line_of_tokens-&gt;{_rtokens};</code></pre>
 331
 332 <p>The variable <code>$rtoken_type</code> is a reference to an array of token type codes, and <code>$rtokens</code> is a reference to a corresponding array of token text. These are obviously only defined for lines of type <b>CODE</b>. Perltidy classifies tokens into types, and has a brief code for each type. You can get a complete list at any time by running perltidy from the command line with</p>
 333
 334 <pre><code>     perltidy --dump-token-types</code></pre>
 335
 336 <p>In the present example, we are only looking for tokens of type <b>i</b> (identifiers), so the for loop skips past all other types. When an identifier is found, its actual text is checked to see if it is one being sought. If so, the above write_line prints the token and its line number.</p>
 337
 338 <p>The <b>formatter</b> feature is relatively new in perltidy, and further documentation needs to be written to complete its description. However, several example programs have been written and can be found in the <b>examples</b> section of the source distribution. Probably the best way to get started is to find one of the examples which most closely matches your application and start modifying it.</p>
 339
 340 <p>For help with perltidy&#39;s peculiar way of breaking lines into tokens, you might run, from the command line,</p>
 341
 342 <pre><code> perltidy -D filename</code></pre>
 343
 344 <p>where <i>filename</i> is a short script of interest. This will produce <i>filename.DEBUG</i> with interleaved lines of text and their token types. The <b>-D</b> flag has been in perltidy from the beginning for this purpose. If you want to see the code which creates this file, it is <code>write_debug_entry</code> in Tidy.pm.</p>
 345
 346 <h1 id="EXPORT">EXPORT</h1>
 347
 348 <pre><code>  &amp;perltidy</code></pre>
 349
 350 <h1 id="VERSION">VERSION</h1>
 351
 352 <p>This man page documents Perl::Tidy version 20181120</p>
 353
 354 <h1 id="LICENSE">LICENSE</h1>
 355
 356 <p>This package is free software; you can redistribute it and/or modify it under the terms of the &quot;GNU General Public License&quot;.</p>
 357
 358 <p>Please refer to the file &quot;COPYING&quot; for details.</p>
 359
 360 <h1 id="BUG-REPORTS">BUG REPORTS</h1>
 361
 362 <p>A list of current bugs and issues can be found at the CPAN site <a href="https://rt.cpan.org/Public/Dist/Display.html?Name=Perl-Tidy">https://rt.cpan.org/Public/Dist/Display.html?Name=Perl-Tidy</a></p>
 363
 364 <p>To report a new bug or problem, use the link on this page.</p>
 365
 366 <p>The source code repository is at <a href="https://github.com/perltidy/perltidy">https://github.com/perltidy/perltidy</a>.</p>
 367
 368 <h1 id="SEE-ALSO">SEE ALSO</h1>
 369
 370 <p>The perltidy(1) man page describes all of the features of perltidy. It can be found at http://perltidy.sourceforge.net.</p>
 371
 372
 373 </body>
 374
 375 </html>
 376
 377