Section 3: library functions
Dpkg::Interface::Storable – common methods related to object serialization Description Dpkg::Interface::Storable is only meant to be used as parent class for other objects. It provides common methods that are all implemented on top of two basic methods parse() and output(). Base Methods Those methods must be provided by the object that wish to inherit from Dpkg::Interface::Storable…
Dpkg::Index – generic index of control information Description This object represent a set of Dpkg::Control objects. Functions my $index = Dpkg::Index->new(%opts) Creates a new empty index. See set_options() for more details. $index->set_options(%opts) The “type” option is checked first to define default values for other options. Here are the relevant options: “get_key_func” is a function returning…
Dpkg::IPC – helper functions for IPC Description Dpkg::IPC offers helper functions to allow you to execute other programs in an easy, yet flexible way, while hiding all the gory details of IPC (Inter-Process Communication) from you. Methods spawn Creates a child process and executes another program in it. The arguments are interpreted as a hash…
Dpkg::Gettext – convenience wrapper around Locale::gettext Description The Dpkg::Gettext module is a convenience wrapper over the Locale::gettext module, to guarantee we always have working gettext functions, and to add some commonly used aliases. Functions my $trans = _g($msgid) Calls gettext() on the $msgid and returns its translation for the current locale. If gettext() is not…
Dpkg::Exit – program exit handlers Description The Dpkg::Exit module provides support functions to run handlers on exit. Functions push_exit_handler($func) Register a code reference into the exit function handlers stack. pop_exit_handler() Pop the last registered exit handler from the handlers stack. run_exit_handlers() Run the registered exit handlers. Changes Version 1.01 New functions: push_exit_handler(), pop_exit_handler(), run_exit_handlers() Deprecated…
Dpkg::Deps – parse and manipulate dependencies of Debian packages Description The Dpkg::Deps module provides objects implementing various types of dependencies. The most important function is deps_parse(), it turns a dependency line in a set of Dpkg::Deps::{Simple,AND,OR,Union} objects depending on the case. Functions All the deps_* functions are exported by default. deps_eval_implication($rel_p, $v_p, $rel_q, $v_q) ($rel_p,…
Dpkg::Control::Types – export CTRL_* constants Description You should not use this module directly. Instead you more likely want to use Dpkg::Control which also re-exports the same constants. This module has been introduced solely to avoid a dependency loop between Dpkg::Control and Dpkg::Control::Fields. Changes Version 0.xx This is a private module. Author Raphaël Hertzog <hertzog [at]…
Dpkg::Control::Info – parse files like debian/control Description It provides an object to access data of files that follow the same syntax as debian/control. Functions $c = Dpkg::Control::Info->new($file) Create a new Dpkg::Control::Info object for $file. If $file is omitted, it loads debian/control. If file is “-”, it parses the standard input. $c->reset() Resets what got read….
Dpkg::Control::HashCore – parse and manipulate a block of RFC822-like fields Description The Dpkg::Control::Hash object is a hash-like representation of a set of RFC822-like fields. The fields names are case insensitive and are always capitalized the same when output (see field_capitalize function in Dpkg::Control::Fields). The order in which fields have been set is remembered and is…
Dpkg::Control::Hash – parse and manipulate a block of RFC822-like fields Description This module is just like Dpkg::Control::HashCore, with vendor-specific field knowledge. Changes Version 1.00 Mark the module as public. Author Raphaël Hertzog <hertzog [at] debian.org>.
Dpkg::Control::FieldsCore – manage (list of official) control fields Description The modules contains a list of fieldnames with associated meta-data explaining in which type of control information they are allowed. The types are the CTRL_* constants exported by Dpkg::Control. Functions my $f = field_capitalize($field_name) Returns the field name properly capitalized. All characters are lowercase, except the…
Dpkg::Control::Fields – manage (list of official) control fields Description The module contains a list of vendor-neutral and vendor-specific fieldnames with associated meta-data explaining in which type of control information they are allowed. The vendor-neutral fieldnames and all functions are inherited from Dpkg::Control::FieldsCore. Changes Version 1.00 Mark the module as public. Author Raphaël Hertzog <hertzog [at]…
Dpkg::Control::Changelog – represent info fields output by dpkg-parsechangelog Description This object derives directly from Dpkg::Control with the type CTRL_CHANGELOG. Functions $c = Dpkg::Control::Changelog->new() Create a new empty set of changelog related fields. Changes Version 1.00 Mark the module as public. Author Raphaël Hertzog <hertzog [at] debian.org>.
Dpkg::Control – parse and manipulate official control-like information Description The Dpkg::Control object is a smart version of Dpkg::Control::Hash. It associates a type to the control information. That type can be used to know what fields are allowed and in what order they must be output. The types are constants that are exported by default. Here’s…
Dpkg::Conf – parse dpkg configuration files Description The Dpkg::Conf object can be used to read options from a configuration file. It can exports an array that can then be parsed exactly like @ARGV. Functions my $conf = Dpkg::Conf->new(%opts) Create a new Dpkg::Conf object. Some options can be set through %opts: if allow_short evaluates to true…
Dpkg::Compression::Process – run compression/decompression processes Description This module provides an object oriented interface to run and manage compression/decompression processes. Methods my $proc = Dpkg::Compression::Process->new(%opts) Create a new instance of the object. Supported options are “compression” and “compression_level” (see corresponding set_* functions). $proc->set_compression($comp) Select the compression method to use. It errors out if the method is…
Dpkg::Compression::FileHandle – object dealing transparently with file compression Synopsis use Dpkg::Compression::FileHandle; $fh = Dpkg::Compression::FileHandle->new(filename => ‘sample.gz’); print $fh "Something "; close $fh; $fh = Dpkg::Compression::FileHandle->new(); open($fh, ‘>’, ‘sample.bz2’); print $fh "Something "; close $fh; $fh = Dpkg::Compression::FileHandle->new(); $fh->open(‘sample.xz’, ‘w’); $fh->print("Something "); $fh->close(); $fh = Dpkg::Compression::FileHandle->new(filename => ‘sample.gz’); my @lines = <$fh>; close $fh; $fh =…
Dpkg::Compression – simple database of available compression methods Description This modules provides a few public funcions and a public regex to interact with the set of supported compression methods. Functions my @list = compression_get_list() Returns a list of supported compression methods (sorted alphabetically). compression_is_supported($comp) Returns a boolean indicating whether the give compression method is known…
Dpkg::Checksums – generate and manipulate file checksums Description This module provides an object that can generate and manipulate various file checksums as well as some methods to query information about supported checksums. Functions @list = checksums_get_list() Returns the list of supported checksums algorithms. $bool = checksums_is_supported($alg) Returns a boolean indicating whether the given checksum algorithm…
Dpkg::Changelog::Parse – generic changelog parser for dpkg-parsechangelog Description This module provides a single function changelog_parse() which reproduces all the features of dpkg-parsechangelog. FUNCTIONS my $fields = changelog_parse(%opt) This function will parse a changelog. In list context, it return as many Dpkg::Control object as the parser did output. In scalar context, it will return only the…