.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Config::Model::Backend::DpkgSyntax 3pm"
.TH Config::Model::Backend::DpkgSyntax 3pm 2024-03-03 "perl v5.38.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
Config::Model::Backend::DpkgSyntax \- Role to read and write files with Dpkg syntax
.SH SYNOPSIS
.IX Header "SYNOPSIS"
With a dpkg file containing:
.PP
.Vb 2
\& Name: Foo
\& Version: 1.2
\&
\& # section comment
\& Name: Bar
\& # data comment
\& Version: 1.3
\& Files: file1,
\& # inline comment
\&        file2
\& Description: A very
\&  .
\&  long description
.Ve
.PP
Parse the file with:
.PP
.Vb 1
\& package MyParser ;
\&
\& use strict;
\& use warnings;
\&
\& use 5.20.1;
\&
\& # DpkgSyntax uses Log4perl, so we must initialise this module
\& use Log::Log4perl qw(:easy);
\& Log::Log4perl\->easy_init($WARN);
\&
\& # load role
\& use Mouse ;
\& with \*(AqConfig::Model::Backend::DpkgSyntax\*(Aq;
\&
\& package main ;
\& use Path::Tiny;
\& use YAML::PP;
\&
\& # load control file
\& my $file = path(\*(Aqdpkg\-test\*(Aq);
\&
\& # create your parser
\& my $parser = MyParser\->new() ;
\&
\& # convert control file data in a Perl data structure
\& # documented in Synopsis
\& my $data = $parser\->parse_dpkg_file($file, \*(Aqyes\*(Aq, 1);
.Ve
.PP
Data contains:
.PP
.Vb 10
\& [
\&   1,          # section 1 found in line 1
\&   [
\&     \*(AqName\*(Aq,    # first parameter
\&       [
\&         \*(Aqsection comment\*(Aq,
\&         [
\&           \*(AqFoo\*(Aq,  # first parameter data
\&           1,      # also found in line 1
\&           \*(Aq\*(Aq      # currently always empty
\&         ]
\&       ],
\&    \*(AqVersion\*(Aq, [ \*(Aqdata comment\*(Aq, [\*(Aq1.2\*(Aq, 2, \*(Aq\*(Aq]]
\&   ],          # end of section 1
\&   4,          # section 2 found in line 4
\&   [
\&     \*(AqName\*(Aq, [[\*(AqBar\*(Aq, 5, \*(Aq\*(Aq]],
\&     \*(AqVersion\*(Aq, [[\*(Aq1.3\*(Aq, 7, \*(Aq\*(Aq]],
\&     \*(AqFiles\*(Aq, # param with 2 lines
\&     [
\&       [\*(Aqfile1,\*(Aq, 8, \*(Aq\*(Aq],
\&       [\*(Aq      file2\*(Aq, 10, \*(Aq\*(Aq, \*(Aqinline comment\*(Aq] # padding is kept
\&     ],
\&     \*(AqDescription\*(Aq, # param with 3 lines
\&     [
\&       [\*(AqA very\*(Aq, 11, \*(Aq\*(Aq],
\&       [\*(Aq\*(Aq, 12, \*(Aq\*(Aq],  # empty line, note: dot was removed
\&       [\*(Aqlong description\*(Aq, 13, \*(Aq\*(Aq]
\&     ]
\&   ]                  # end of section 2
\& ];                   # end of data
.Ve
.PP
To write Dpkg file back:
.PP
.Vb 1
\& package MyParser ;
\&
\& use strict;
\& use warnings;
\&
\& use 5.20.1;
\&
\& # DpkgSyntax uses Log4perl, so we must initialise this module
\& use Log::Log4perl qw(:easy);
\& Log::Log4perl\->easy_init($WARN);
\&
\& # load role
\& use Mouse ;
\& with \*(AqConfig::Model::Backend::DpkgSyntax\*(Aq;
\&
\& package main ;
\& use Path::Tiny;
\&
\& my $data = [
\&     [
\&         \*(Aq# section comment\*(Aq, qw/Name Foo/,
\&         \*(Aq# data comment\*(Aq, qw/Version 1.2/
\&     ],
\&     [
\&         qw/Name Bar Version 1.3/ ,
\&         Files => [qw/file1/, [ \*(Aqfile2\*(Aq , \*(Aq# inline comment\*(Aq] ] ,
\&         Description => "A very\en\enlong description"
\&     ]
\& ];
\&
\& my $parser = MyParser\->new() ;
\&
\& # print control file content
\& say $parser\->write_dpkg_file($data) ;
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This module is a Moose role to read and write dpkg control files.
.PP
Debian control file are read and transformed in a structure
matching the control file. The top level list of a list of section.
.PP
Each section is mapped to a structure containing the parameter names and values, 
comments and line numbers. See the synopsis for an example.
.PP
Note: The description is changed into a paragraph without the Dpkg
syntax idiosyncrasies. The leading white space is removed and the
single dot is transformed in to a "\en". These characters are restored
when the file is written back.
.PP
Last not but not least, this module can be re-used outside of
\&\f(CW\*(C`Config::Model\*(C'\fR with some small modifications in exception
handling. Ask the author if you want this module shipped in its own
distribution.
.SH ""
.IX Header ""
.SS parse_dpkg_file
.IX Subsection "parse_dpkg_file"
Parameters: \f(CW\*(C`( file_path, file_handle, [ check, [ comment_allowed ]] )\*(C'\fR
.PP
Read a control file from \f(CW\*(C`file_handle\*(C'\fR and returns a nested list (or
a list ref) containing data from the file.
.PP
See synopsis for the returned structure.
.PP
\&\f(CW\*(C`check\*(C'\fR is \f(CW\*(C`yes\*(C'\fR, \f(CW\*(C`skip\*(C'\fR or \f(CW\*(C`no\*(C'\fR (default \f(CW\*(C`yes\*(C'\fR).
 \f(CW\*(C`comment_allowed\*(C'\fR is boolean (default 0)
.SS parse_dpkg_lines
.IX Subsection "parse_dpkg_lines"
Parameters: \f(CW\*(C` ( file_path, lines, check, comment_allowed ) \*(C'\fR
.PP
Parse the dpkg date from lines (which is an array ref) and return a data 
structure like parse_dpkg_file.
.SS write_dpkg_file
.IX Subsection "write_dpkg_file"
Parameters \f(CW\*(C` ( list_ref, list_sep ) \*(C'\fR
.PP
Munge the passed list ref into a string compatible with control files
and write it in the passed file handle.
.PP
The input is a list of list in a form similar to the one generated by
parse_dpkg_file. See the synopsis for an example
.PP
List items (like \f(CW\*(C`Depends\*(C'\fR field in \f(CW\*(C`debian/control\*(C'\fR) are joined
with the value \f(CW\*(C`list_sep\*(C'\fR before being written. Values are aligned in
case of multi-line output of a list. Default value of \f(CW\*(C`list_sep\*(C'\fR is "\f(CW\*(C`,\en\*(C'\fR"
.PP
For instance, after the following code :
.PP
.Vb 2
\& my $ref = [ [ Foo => \*(Aqfoo value\*(Aq , Bar => [ \*(Aqv1\*(Aq, \*(Aqv2\*(Aq ] ];
\& my $res = write_dpkg_file ( $ref, \*(Aq, \*(Aq )
.Ve
.PP
\&\f(CW$res\fR contains:
.PP
.Vb 2
\& Foo: foo value
\& Bar: v1, v2
.Ve
.PP
Here's an example using default \f(CW$sep_list\fR:
.PP
.Vb 1
\& print write_dpkg_file ( $ref )
.Ve
.PP
yields:
.PP
.Vb 3
\& Foo: foo value
\& Bar: v1,
\&      v2
.Ve
.SH AUTHOR
.IX Header "AUTHOR"
Dominique Dumont, (ddumont at cpan dot org)
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Config::Model,
Config::Model::BackendMgr,
Config::Model::Backend::Any,