| Name : perl-Perl-Tidy
| |
| Version : 20240903
| Vendor : obs://build_opensuse_org/devel:languages:perl
|
| Release : lp154.1.1
| Date : 2024-09-04 06:38:47
|
| Group : Unspecified
| Source RPM : perl-Perl-Tidy-20240903-lp154.1.1.src.rpm
|
| Size : 3.88 MB
| |
| Packager : https://www_suse_com/
| |
| Summary : Indent and reformat perl scripts
|
Description :
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 AATTARGV array will be used to provide input parameters as described
in the perltidy(1) man page.
For example, the perltidy script is basically just this:
use Perl::Tidy;
Perl::Tidy::perltidy();
The call to *perltidy* returns a scalar *$error_flag* 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 ERROR
HANDLING section.
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 *getline*
or *print* method, as appropriate.
source - the source of the script to be formatted
destination - the destination of the formatted output
stderr - standard error output
perltidyrc - the .perltidyrc file
logfile - the .LOG file stream, if any
errorfile - the .ERR file stream, if any
dump_options - ref to a hash to receive parameters (see below),
dump_options_type - controls contents of dump_options
dump_getopt_flags - ref to a hash to receive Getopt flags
dump_options_category - ref to a hash giving category of options
dump_abbreviations - ref to a hash giving all abbreviations
The following chart illustrates the logic used to decide how to treat a
parameter.
ref($param) $param is assumed to be:
----------- ---------------------
undef a filename
SCALAR ref to string
ARRAY ref to array
(other) object with getline (if source) or print method
If the parameter is an object, and the object has a *close* method, that
close method will be called at the end of the stream.
* *source*
If the *source* parameter is given, it defines the source of the input
stream. If an input stream is defined with the *source* parameter then no
other source filenames may be specified in the AATTARGV array or *argv*
parameter.
* *destination*
If the *destination* parameter is given, it will be used to define the file
or memory location to receive output of perltidy.
*Important note if destination is a string or array reference*. Perl
strings of characters which are decoded as utf8 by Perl::Tidy can be
returned in either of two possible states, decoded or encoded, and it is
important that the calling program and Perl::Tidy are in agreement
regarding the state to be returned. A flag *--encode-output-strings*, or
simply *-eos*, was added in Perl::Tidy version 20220217 for this purpose.
* Use *-eos* if Perl::Tidy should encode any string which it decodes. This is
the current default because it makes perltidy behave well as a filter, and
is the correct setting for most programs. But do not use this setting if
the calling program will encode the data too, because double encoding will
corrupt data.
* Use *-neos* if a string should remain decoded if it was decoded by
Perl::Tidy. This is only appropriate if the calling program will handle any
needed encoding before outputting the string. If needed, this flag can be
added to the end of the *argv* parameter passed to Perl::Tidy.
For some background information see
https://github.com/perltidy/perltidy/blob/master/docs/eos_flag.md.
This change in default behavior was made over a period of time as follows:
* For versions before 20220217 the *-eos* flag was not available and the
behavior was equivalent to *-neos*.
* In version 20220217 the *-eos* flag was added but the default remained
*-neos*.
* For versions after 20220217 the default was set to *-eos*.
* *stderr*
The *stderr* 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.
* *perltidyrc*
If the *perltidyrc* file is given, it will be used instead of any
_.perltidyrc_ configuration file that would otherwise be used.
* *errorfile*
The *errorfile* 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.
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.
However if perltidy is called to process just a single perl script then it
may be more convenient to combine the *errorfile* stream with the *stderr*
stream. This can be done by setting the *-se* parameter, in which case this
parameter is ignored.
* *logfile*
The *logfile* parameter allows the calling program to capture the log
stream. This stream is only created if requested with a *-g* parameter. It
contains detailed diagnostic information about a script which may be useful
for debugging.
* *teefile*
The *teefile* parameter allows the calling program to capture the tee
stream. This stream is only created if requested with one of the \'tee\'
parameters, a *--tee-pod* , *--tee-block-comments*, *--tee-side-commnts*,
or *--tee-all-comments*.
* *debugfile*
The *debugfile* parameter allows the calling program to capture the stream
produced by the *--DEBUG* parameter. This parameter is mainly used for
debugging perltidy itself.
* *argv*
If the *argv* parameter is given, it will be used instead of the *AATTARGV*
array. The *argv* 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.
* *dump_options*
If the *dump_options* 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 parameters 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,
_perltidyrc_dump.pl_, is included in the distribution.
Any combination of the *dump_* parameters may be used together.
* *dump_options_type*
This parameter is a string which can be used to control the parameters
placed in the hash reference supplied by *dump_options*. The possible
values are \'perltidyrc\' (default) and \'full\'. The \'full\' parameter causes
both the default options plus any options found in a perltidyrc file to be
returned.
* *dump_getopt_flags*
If the *dump_getopt_flags* 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 *dump_options* flag. Perltidy will exit
immediately after filling this hash. See the demo program
_perltidyrc_dump.pl_ for example usage.
* *dump_options_category*
If the *dump_options_category* 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 _perltidyrc_dump.pl_ for
example usage.
* *dump_abbreviations*
If the *dump_abbreviations* 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 _perltidyrc_dump.pl_ for example usage.
* *prefilter*
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.
* *postfilter*
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.
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 *filter_example.pl* in the perltidy distribution.
|
RPM found in directory: /packages/linux-pbone/ftp5.gwdg.de/pub/opensuse/repositories/devel:/languages:/perl:/CPAN-P/15.4/noarch |
