| Options(3pm) | User Contributed Perl Documentation | Options(3pm) |
PDL::Options - simplifies option passing by hash in PerlDL
use PDL::Options;
%hash = parse( \%defaults, \%user_options);
use PDL::Options ();
$opt = new PDL::Options;
$opt = new PDL::Options ( \%defaults );
$opt->defaults ( \%defaults );
$opt->synonyms ( { 'COLOR' => 'COLOUR' } );
$hashref = $opt->defaults;
$opt->options ( \%user_options );
$hashref = $opt->options;
$opt->incremental(1);
$opt->full_options(0);
Object to simplify option passing for PerlDL subroutines. Allows you to merge a user defined options with defaults. A simplified (non-OO) interface is provided.
parse({Ext => 'TIF', ifhref($opt)});
just return the argument if it is a hashref otherwise return an empty hashref. Useful in conjunction with parse to return just the default values if argument is not a hash ref
A simplified non-object oriented interface is provided. These routines are exported into the callers namespace by default.
A hash (not hash reference) containing the processed options is returned.
%options = parse( { LINE => 1, COLOUR => 'red'}, { COLOR => 'blue'});
The following default synonyms are available in the non-OO interface:
COLOR => COLOUR COLOUR => COLOR CENTER => CENTRE CENTRE => CENTER
The following methods are available to PDL::Options objects.
The current values are reset whenever the defaults are changed.
This allows you to provide alternate keywords (such as allowing 'COLOR' as an option when your defaults uses 'COLOUR').
This method can be used to setup the dictionary and is hash reference with the following structure:
OPTIONA => {
'string1' => decode1,
'string2' => decode2
},
OPTIONB => {
's4' => decodeb1,
}
etc....
Where OPTION? corresponds to the top level option name as stored in the defaults array (eg LINECOLOR) and the anonymous hashes provide the translation from string1 ('red') to decode1 ('#ff0000').
An options string will be translated automatically during the main options() processing if autotrans() is set to true. Else translation can be initiated by the user using the translate() method.
Can be used to set or return this value. Default is false.
This can be useful when you are only interested in the changes to the options rather than knowing the full state. (For example, if defaults contains keys for COLOUR and LINESTYLE and the user supplied a key of COL, you may simply be interested in the modification to COLOUR rather than the state of LINESTYLE and COLOUR.)
Default is true.
Can be used to set or return this value.
If a particular key matches exactly (within the constraints imposed bby case sensitivity) this key will always be taken as correct even if others are similar. For example COL would match COL and COLOUR but this implementation will always return COL in this case (note that for CO it will return both COL and COLOUR and pick one at random.
Can be used to set or return this value.
Can be used to set or return this value.
Can be used to set or return this value.
If a particular key matches exactly (within the constraints imposed bby case sensitivity) this key will always be taken as correct even if others are similar. For example COL would match COL and COLOUR but this implementation will always return COL in this case (note that for CO it will return both COL and COLOUR and pick one at random.
Can be used to set or return this value.
The user-supplied keys will be compared with the defaults. Case sensitivity and minimum matching can be configured using the mimatch() and casesens() methods.
A warning is raised if keys present in the user options are not present in the defaults unless warnonmissing is set.
A reference to a hash containing the merged options is returned.
$merged = $opt->options( { COL => 'red', Width => 1});
The state of the object can be retrieved after this by using the current() method or by using the options() method with no arguments. If full_options() is true, all options are returned (options plus overrides), if full_options() is false then only the modified options are returned.
Synonyms are supported if they have been configured via the synonyms() method.
This method updates the current state of the object and returns the updated options hash as a reference.
$ref = $opt->translate;
Two examples are shown. The first uses the simplified interface and the second uses the object-oriented interface.
use PDL::Options (':Func');
%options = parse( {
LINE => 1,
COLOUR => 'red',
},
{
COLOR => 'blue'
}
);
This will return a hash containing
%options = (
LINE => 1,
COLOUR => 'blue'
)
The following example will try to show the main points:
use PDL::Options ();
# Create new object and supply defaults
$opt = new PDL::Options( { Colour => 'red',
LineStyle => 'dashed',
LineWidth => 1
}
);
# Create synonyms
$opt->synonyms( { Color => 'Colour' } );
# Create translation dictionary
$opt->translation( { Colour => {
'blue' => '#0000ff',
'red' => '#ff0000',
'green'=> '#00ff00'
},
LineStyle => {
'solid' => 1,
'dashed' => 2,
'dotted' => 3
}
}
);
# Generate and parse test hash
$options = $opt->options( { Color => 'green',
lines => 'solid',
}
);
When this code is run, $options will be the reference to a hash containing the following:
Colour => '#00ff00', LineStyle => 1, LineWidth => 1
If full_options() was set to false (0), $options would be a reference to a hash containing:
Colour => '#00ff00', LineStyle => 1
Minimum matching and case insensitivity can be configured for both the initial parsing and for the subsequent translating. The translation can be turned off if not desired.
Currently synonyms are not available for the translation although this could be added quite simply.
Copyright (C) Tim Jenness 1998 (t.jenness@jach.hawaii.edu). All rights reserved. There is no warranty. You are allowed to redistribute this software / documentation under certain conditions. For details, see the file COPYING in the PDL distribution. If this file is separated from the PDL distribution, the copyright notice should be included in the file.
| 2018-11-02 | perl v5.28.0 |