<?xml version="1.0" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title></title>
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
<link rev="made" href="mailto:root@localhost" />
</head>
<body style="background-color: white">
<ul id="index">
<li><a href="#NAME">NAME</a></li>
<li><a href="#DESCRIPTION">DESCRIPTION</a></li>
<li><a href="#SYNOPSIS">SYNOPSIS</a></li>
<li><a href="#CONSTRUCTOR">CONSTRUCTOR</a></li>
<li><a href="#GENERAL-METHODS">GENERAL METHODS</a></li>
<li><a href="#SPECIFIC-METHODS">SPECIFIC METHODS</a></li>
</ul>
<h1 id="NAME">NAME</h1>
<p>Libconf::Templates::Generic::Value - Libconf generic low level template for semantic (VALUE) styles config files</p>
<h1 id="DESCRIPTION">DESCRIPTION</h1>
<p>Libconf::Templates::Generic::Value is a generic template that handles config files that contain semantic informations of type : (VALUE).</p>
<h1 id="SYNOPSIS">SYNOPSIS</h1>
<pre><code> $template = new Libconf::Templates::Generic::Value({
filename => 'some_filename',
regexp => '^\s*(\S+)\s*$',
comments_struct => [['#']],
output_function => sub { my ($atom) = @_; 'val : ' . $atom->{value} }
});
$template->read_conf();
$template->edit_atom(-1, { value => 'foo' }, { value => 'foo' });
$template->edit_atom(5, { value => 'some value' });
...
(see L<Libconf::Templates> for transformation methods on $template) ...
...
$template->write_conf("output_file");</code></pre>
<h1 id="CONSTRUCTOR">CONSTRUCTOR</h1>
<dl>
<dt id="new-options"><b>new($options)</b></dt>
<dd>
<p>creates the template</p>
<pre><code> $template = new Libconf::Templates::Generic::Value({
filename => 'some_file',
regexp => '^\s*(\S+)\s*$',
comments_struct => [['#']],
output_function => sub { my ($atom) = @_; 'val : ' . $atom->{value} }
})</code></pre>
<p><b>arguments</b></p>
<p>$options [<b>type</b> : HASH_REF] specifies the options to create the new template instance.</p>
<p><b>options</b></p>
<p>filename [<b>type</b> : STRING, <b>default</b> : ''] : the filename of the config file you want to work on. Can be read and written lately by using set_filename and get_filename.</p>
<p>comments_struct [<b>type</b> : ARRAY_REF of ARRAY_REF of STRING,STRING,SCALAR, <b>default</b> : [['#']] ] : defines the type and the characters of comments. See <a>Libconf::Templates::Keyvalue</a> for additional details on it</p>
<p>regexp [<b>type</b> : STRING, <b>default</b> : ''] : the regexp that is applied to each line. It should catch something, that will be stored as the value</p>
<p>output_function [<b>type</b> : FUNCTION_REF, <b>default</b> : sub {} ] : the code to be applied to an atom, to generate the line to output. It takes in arguments the atom</p>
</dd>
</dl>
<h1 id="GENERAL-METHODS">GENERAL METHODS</h1>
<p>See <a>Libconf::Templates</a> for the general list of methods you can call on this template.</p>
<h1 id="SPECIFIC-METHODS">SPECIFIC METHODS</h1>
<p>There is no specific method</p>
</body>
</html>
