The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
 / 
App-SimpleScan-3.01
River stage one • 6 direct dependents • 6 total dependents
++
/ App::SimpleScan::Substitution::Line

NAME

App::SimpleScan::Substitution::Line - a line with optional fixed variable values

SYNOPSIS

  my $line = 
    App::SimpleScan::Substitution::Line->new("<substitute> this <too>");

  # Use only this value when substituting "<substitute>".
  $line->fix('substituite' => 'change');

  # what vars are fixed?
  my @fixed_ones = $line->fixed();

  # Forget about <substitute> now.
  $line->unfix('substitute');

  # Forget all fixed variables.
  $line->no_fixed

  # Get the line back as a string.
  print "$line";

DESCRIPTION

App::SimpleScan::Substitution::Line allows us to associate fixed substitution values with a specific string. This allows us to re-substituted the same value if, during string substitution, we find the variable reappearing as the result of substituting some other variable. This eliminates the "cross-product" bug that appeared in some complex nest substitions.

INTERFACE

new($line)

Creates a new object. The line is required.

no_fixed

Deletes all fixed variables for this object.

fix($var, $value)

Fixes the given variable to the specified value.

unfix($var, $value)

Drops the fixed variable value for the given variable.

fixed

With no argument, returns a list of variable with fixed values associated with the object. With an argument, returns the fixed value (if any) for the variable specified.

DIAGNOSTICS

No line supplied You must supply a line to be substituted in new().

CONFIGURATION AND ENVIRONMENT

App::SimpleScan::Substitution::Line requires no configuration files or environment variables.

DEPENDENCIES

None.

INCOMPATIBILITIES

None reported.

BUGS AND LIMITATIONS

No bugs have been reported.

Please report any bugs or feature requests to "bug-app-simplescan@rt.cpan.org", or through the web interface at <http://rt.cpan.org>.

AUTHOR

Joe McMahon <mcmahon@yahoo-inc.com >

LICENCE AND COPYRIGHT

Copyright (c) 2006, Joe McMahon mcmahon@yahoo-inc.com. All rights reserved.

DISCLAIMER OF WARRANTY

BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR, OR CORRECTION.

IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.