.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40) .\" .\" 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 .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . 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 .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "Lintian::Data::JoinedLines 3" .TH Lintian::Data::JoinedLines 3 "2022-07-02" "Lintian v2.115.1~bpo11+1" "Debian Package Checker" .\" 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" Lintian::Data::JoinedLines \- Lintian interface to query lists of keywords .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 10 \& my $keyword; \& my $list = Lintian::Data::JoinedLines\->new(\*(Aqtype\*(Aq); \& if ($list\->recognizes($keyword)) { \& # do something ... \& } \& my $hash = Lintian::Data::JoinedLines\->new(\*(Aqanother\-type\*(Aq, qr{\es++}); \& if ($hash\->value($keyword) > 1) { \& # do something ... \& } \& if ($list\->value($keyword) > 1) { \& # do something ... \& } \& my @keywords = $list\->all; \& if ($list\->matches_any($keyword)) { \& # do something ... \& } .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" Lintian::Data::JoinedLines provides a way of loading a list of keywords or key/value pairs from a file in the Lintian root and then querying that list. The lists are stored in the \fIdata\fR directory of the Lintian root and consist of one keyword or key/value pair per line. Blank lines and lines beginning with \f(CW\*(C`#\*(C'\fR are ignored. Leading and trailing whitespace is stripped. .PP If requested, the lines are split into key/value pairs with a given separator regular expression. Otherwise, keywords are taken verbatim as they are listed in the file and may include spaces. .PP This module allows lists such as menu sections, doc-base sections, obsolete packages, package fields, and so forth to be stored in simple, easily editable files. .PP \&\s-1NB:\s0 By default Lintian::Data::JoinedLines is lazy and defers loading of the data file until it is actually needed. .SS "Interface for the \s-1CODE\s0 argument" .IX Subsection "Interface for the CODE argument" This section describes the interface between for the \s-1CODE\s0 argument for the class method new. .PP The sub will be called once for each key/pair with three arguments, \&\s-1KEY, VALUE\s0 and \s-1CURVALUE.\s0 The first two are the key/value pair parsed from the data file and \s-1CURVALUE\s0 is current value associated with the key. \s-1CURVALUE\s0 will be \f(CW\*(C`undef\*(C'\fR the first time the sub is called with that \s-1KEY\s0 argument. .PP The sub can then modify \s-1VALUE\s0 in some way and return the new value for that \s-1KEY.\s0 If \s-1CURVALUE\s0 is not \f(CW\*(C`undef\*(C'\fR, the sub may return \f(CW\*(C`undef\*(C'\fR to indicate that the current value should still be used. It is not permissible for the sub to return \f(CW\*(C`undef\*(C'\fR if \s-1CURVALUE\s0 is \f(CW\*(C`undef\*(C'\fR. .PP Where Perl semantics allow it, the sub can modify \s-1CURVALUE\s0 and the changes will be reflected in the result. As an example, if \s-1CURVALUE\s0 is a hashref, new keys can be inserted etc. .SH "INSTANCE METHODS" .IX Header "INSTANCE METHODS" .IP "dataset" 4 .IX Item "dataset" .PD 0 .ie n .IP """keyorder""" 4 .el .IP "\f(CWkeyorder\fR" 4 .IX Item "keyorder" .IP "all" 4 .IX Item "all" .PD Returns all keywords listed in the data file as a list in original order. In a scalar context, returns the number of keywords. .IP "recognizes (\s-1KEY\s0)" 4 .IX Item "recognizes (KEY)" Returns true if \s-1KEY\s0 was listed in the data file represented by this Lintian::Data::JoinedLines instance and false otherwise. .IP "resembles (\s-1KEY\s0)" 4 .IX Item "resembles (KEY)" Returns true if the data file contains a key that is a case-insensitive match to \s-1KEY,\s0 and false otherwise. .IP "value (\s-1KEY\s0)" 4 .IX Item "value (KEY)" Returns the value attached to \s-1KEY\s0 if it was listed in the data file represented by this Lintian::Data::JoinedLines instance and the undefined value otherwise. .IP "matches_any(KEYWORD[, \s-1MODIFIERS\s0])" 4 .IX Item "matches_any(KEYWORD[, MODIFIERS])" Returns true if \s-1KEYWORD\s0 matches any regular expression listed in the data file. The optional \s-1MODIFIERS\s0 serve as modifiers on all regexes. .IP "load" 4 .IX Item "load" .SH "FILES" .IX Header "FILES" .PD 0 .IP "LINTIAN_INCLUDE_DIR/data" 4 .IX Item "LINTIAN_INCLUDE_DIR/data" .PD The files loaded by this module must be located in this directory. Relative paths containing a \f(CW\*(C`/\*(C'\fR are permitted, so files may be organized in subdirectories in this directory. .Sp Note that lintian supports multiple LINTIAN_INCLUDE_DIRs. .SH "AUTHOR" .IX Header "AUTHOR" Originally written by Russ Allbery for Lintian. .SH "SEE ALSO" .IX Header "SEE ALSO" \&\fBlintian\fR\|(1),