1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
|
# -*- perl -*-
#
# Copyright (C) 1998 Christian Schwarz and Richard Braakman
# Copyright (C) 2009 Russ Allbery
# Copyright (C) 2020-2021 Felix Lechner
#
# This program is free software; you can redistribute it and/or modify it
# under the terms of the GNU General Public License as published by the Free
# Software Foundation; either version 2 of the License, or (at your option)
# any later version.
#
# This program is distributed in the hope that it will be useful, but WITHOUT
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
# FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
# more details.
#
# You should have received a copy of the GNU General Public License along with
# this program. If not, see <http://www.gnu.org/licenses/>.
package Lintian::Output::Markdown;
use v5.20;
use warnings;
use utf8;
use Exporter qw(import);
our @EXPORT_OK = qw(
markdown_citation
markdown_authority
markdown_bug
markdown_manual_page
markdown_uri
markdown_hyperlink
);
use Const::Fast;
const my $EMPTY => q{};
const my $SPACE => q{ };
=head1 NAME
Lintian::Output::Markdown - Lintian interface for markdown output
=head1 SYNOPSIS
use Lintian::Output::Markdown;
=head1 DESCRIPTION
Lintian::Output::Markdown provides functions for Markdown output.
=head1 FUNCTIONS
=over 4
=item markdown_citation
=cut
sub markdown_citation {
my ($data, $citation) = @_;
if ($citation =~ m{^ ([\w-]+) \s+ (.+) $}x) {
my $volume = $1;
my $section = $2;
my $markdown = $data->markdown_authority_reference($volume, $section);
$markdown ||= $citation;
return $markdown;
}
if ($citation =~ m{^ ([\w.-]+) [(] (\d\w*) [)] $}x) {
my $name = $1;
my $section = $2;
return markdown_manual_page($name, $section);
}
if ($citation =~ m{^(?:Bug)?#(\d+)$}) {
my $number = $1;
return markdown_bug($number);
}
# turn bare file into file uris
$citation =~ s{^ / }{file://}x;
# strip scheme from uri
if ($citation =~ s{^ (\w+) : // }{}x) {
my $scheme = $1;
return markdown_uri($scheme, $citation);
}
return $citation;
}
=item markdown_authority
=cut
sub markdown_authority {
my ($volume_title, $volume_url, $section_key, $section_title,$section_url)
= @_;
my $directed_link;
$directed_link = markdown_hyperlink($section_title, $section_url)
if length $section_title
&& length $section_url;
my $pointer;
if (length $section_key) {
if ($section_key =~ /^[A-Z]+$/ || $section_key =~ /^appendix-/) {
$pointer = "Appendix $section_key";
} elsif ($section_key =~ /^\d+$/) {
$pointer = "Chapter $section_key";
} else {
$pointer = "Section $section_key";
}
}
# overall manual.
my $volume_link = markdown_hyperlink($volume_title, $volume_url);
if (length $directed_link) {
return "$directed_link ($pointer) in the $volume_title"
if length $pointer;
return "$directed_link in the $volume_title";
}
return "$pointer of the $volume_link"
if length $pointer;
return "the $volume_link";
}
=item markdown_bug
=cut
sub markdown_bug {
my ($number) = @_;
return markdown_hyperlink("Bug#$number","https://bugs.debian.org/$number");
}
=item markdown_manual_page
=cut
sub markdown_manual_page {
my ($name, $section) = @_;
my $url
="https://manpages.debian.org/cgi-bin/man.cgi?query=$name&sektion=$section";
my $hyperlink = markdown_hyperlink("$name($section)", $url);
return "the $hyperlink manual page";
}
=item markdown_uri
=cut
sub markdown_uri {
my ($scheme, $locator) = @_;
my $url = "$scheme://$locator";
# use plain path as label for files
return markdown_hyperlink($locator, $url)
if $scheme eq 'file';
# or nothing for everything else
return markdown_hyperlink($EMPTY, $url);
}
=item markdown_hyperlink
=cut
sub markdown_hyperlink {
my ($text, $url) = @_;
return $text
unless length $url;
return "<$url>"
unless length $text;
return "[$text]($url)";
}
=back
=head1 AUTHOR
Originally written by Felix Lechner <felix.lechner@lease-up.com> for Lintian.
=head1 SEE ALSO
lintian(1)
=cut
1;
# Local Variables:
# indent-tabs-mode: nil
# cperl-indent-level: 4
# End:
# vim: syntax=perl sw=4 sts=4 sr et
|
