Digital Mages

Digital Mages - Parse::PlainConfig::Settings(3)

Parse::PlainConfig::Settings

Section: User Contributed Perl Documentation (3)
Updated: 2016-08-09
Index  

NAME

Parse::PlainConfig::Settings - Settings Class  

VERSION

$Id: lib/Parse/PlainConfig/Settings.pm, 3.03 2016/08/09 16:11:12 acorliss Exp $  

SYNOPSIS

    use Parse::PlainConfig::Settings;

    my $settings = new Parse::PlainConfig::Settings;

    $ts         = $settings->tabStop;
    $subindent  = $settings->subindentation;
    $comment    = $settings->comment;
    $delim      = $settings->delimiter;
    $ldelim     = $settings->listDelimiter;
    $hdelim     = $settings->hashDelimiter;
    $hdoc       = $settings->hereDoc;
    %propTypes  = $settings->propertyTypes;
    %propRegex  = $settings->propertyRegexes;
    %prototypes = $settings->prototypes;
    %protoRegex = $settings->prototypeRegexes;

 

DESCRIPTION

The settings object is created and initialized automatically by Parse::PlainConfig.  

SUBROUTINES/METHODS

 

tabStop

    $ts         = $settings->tabStop;

Default column width for tab stops.  

subindentation

    $subindent  = $settings->subindentation;

Default columns for indentation on line continuations.  

comment

    $comment    = $settings->comment;

Default character sequence for comments.  

delimiter

    $delim      = $settings->delimiter;

Default character sequence used as the delimiter between the parameter name and the parameter value.  

listDelimiter

    $ldelim     = $settings->listDelimiter;

Default character sequence used as the delimiter between array elements.  

hashDelimiter

    $hdelim     = $settings->hashDelimiter;

Default character sequence used as the delimiter between key/value pairs.  

hereDoc

    $hdoc       = $settings->hereDoc;

Default character sequence used as the token marking the end of here docs.  

propertyTypes

    %propTypes  = $settings->propertyTypes;

Hash of property names => data types.  

propertyRegexes

    %propRegex  = $settings->propertyRegexes;

Hash of property names to regular expression to extract data from the line.  

prototypes

    %prototypes = $settings->prototypes;

Hash of prototype names => data types.  

prototypeRegexes

    %protoRegex = $settings->prototypeRegexes;

Hash of prototype names to regular expression to extract data from the line.  

DEPENDENCIES

o
Class::EHierarchy
o
Paranoid
o
Paranoid::Debug
o
Parse::PlainConfig::Constants
 

BUGS AND LIMITATIONS

 

AUTHOR

Arthur Corliss (corliss@digitalmages.com)  

LICENSE AND COPYRIGHT

This software is licensed under the same terms as Perl, itself. Please see http://dev.perl.org/licenses/ for more information.

(c) 2015, Arthur Corliss (corliss@digitalmages.com)


 

Index

NAME
VERSION
SYNOPSIS
DESCRIPTION
SUBROUTINES/METHODS
tabStop
subindentation
comment
delimiter
listDelimiter
hashDelimiter
hereDoc
propertyTypes
propertyRegexes
prototypes
prototypeRegexes
DEPENDENCIES
BUGS AND LIMITATIONS
AUTHOR
LICENSE AND COPYRIGHT