#!/usr/bin/perl -w
#
# man.t -- Additional specialized tests for Pod::Man.
#
# Copyright 2002, 2003, 2004, 2006, 2007, 2008, 2009, 2010
# Russ Allbery <rra@stanford.edu>
#
# This program is free software; you may redistribute it and/or modify it
# under the same terms as Perl itself.
BEGIN {
chdir 't' if -d 't';
if ($ENV{PERL_CORE}) {
@INC = '../lib';
}
unshift (@INC, '../blib/lib');
$| = 1;
}
use strict;
use Test::More tests => 31;
BEGIN { use_ok ('Pod::Man') }
# Test whether we can use binmode to set encoding.
my $have_encoding = (eval { require PerlIO::encoding; 1 } and not $@);
my $parser = Pod::Man->new;
isa_ok ($parser, 'Pod::Man', 'Parser object');
my $n = 1;
while (<DATA>) {
next until $_ eq "###\n";
open (TMP, '> tmp.pod') or die "Cannot create tmp.pod: $!\n";
# We have a test in ISO 8859-1 encoding. Make sure that nothing strange
# happens if Perl thinks the world is Unicode. Wrap this in eval so that
# older versions of Perl don't croak.
eval { binmode (\*TMP, ':encoding(iso-8859-1)') if $have_encoding };
while (<DATA>) {
last if $_ eq "###\n";
print TMP $_;
}
close TMP;
open (OUT, '> out.tmp') or die "Cannot create out.tmp: $!\n";
$parser->parse_from_file ('tmp.pod', \*OUT);
close OUT;
open (OUT, 'out.tmp') or die "Cannot open out.tmp: $!\n";
while (<OUT>) { last if /^\.nh/ }
my $output;
{
local $/;
$output = <OUT>;
}
close OUT;
1 while unlink ('tmp.pod', 'out.tmp');
my $expected = '';
while (<DATA>) {
last if $_ eq "###\n";
$expected .= $_;
}
is ($output, $expected, "Output correct for test $n");
$n++;
}
# Below the marker are bits of POD and corresponding expected nroff output.
# This is used to test specific features or problems with Pod::Man. The input
# and output are separated by lines containing only ###.
__DATA__
###
=head1 NAME
gcc - GNU project C<C> and C++ compiler
=head1 C++ NOTES
Other mentions of C++.
###
.SH "NAME"
gcc \- GNU project "C" and C++ compiler
.SH "\*(C+ NOTES"
.IX Header " NOTES"
Other mentions of \*(C+.
###
###
=head1 PERIODS
This C<.> should be quoted.
###
.SH "PERIODS"
.IX Header "PERIODS"
This \f(CW\*(C`.\*(C'\fR should be quoted.
###
###
=over 4
=item *
A bullet.
=item *
Another bullet.
=item * Also a bullet.
=back
###
.IP "\(bu" 4
A bullet.
.IP "\(bu" 4
Another bullet.
.IP "\(bu" 4
Also a bullet.
###
###
=over 4
=item foo
Not a bullet.
=item *
Also not a bullet.
=back
###
.IP "foo" 4
.IX Item "foo"
Not a bullet.
.IP "*" 4
Also not a bullet.
###
###
=encoding iso-8859-1
=head1 ACCENTS
Beyoncé! Beyoncé! Beyoncé!!
Beyoncé! Beyoncé!
Beyoncé! Beyoncé!
Beyoncé! Beyoncé!
Older versions didn't convert Beyoncé in verbatim.
###
.SH "ACCENTS"
.IX Header "ACCENTS"
Beyonce\*'! Beyonce\*'! Beyonce\*'!!
.PP
.Vb 3
\& Beyonce\*'! Beyonce\*'!
\& Beyonce\*'! Beyonce\*'!
\& Beyonce\*'! Beyonce\*'!
.Ve
.PP
Older versions didn't convert Beyonce\*' in verbatim.
###
###
=over 4
=item 1. Not a number
=item 2. Spaced right
=back
=over 2
=item 1 Not a number
=item 2 Spaced right
=back
###
.IP "1. Not a number" 4
.IX Item "1. Not a number"
.PD 0
.IP "2. Spaced right" 4
.IX Item "2. Spaced right"
.IP "1 Not a number" 2
.IX Item "1 Not a number"
.IP "2 Spaced right" 2
.IX Item "2 Spaced right"
###
###
=over 4
=item Z<>*
Not bullet.
=back
###
.IP "*" 4
Not bullet.
###
###
=head1 SEQS
"=over ... Z<>=back"
"SE<lt>...E<gt>"
The quotes should be converted in the above to paired quotes.
###
.SH "SEQS"
.IX Header "SEQS"
\&\*(L"=over ... =back\*(R"
.PP
\&\*(L"S<...>\*(R"
.PP
The quotes should be converted in the above to paired quotes.
###
###
=head1 YEN
It cost me E<165>12345! That should be an X.
###
.SH "YEN"
.IX Header "YEN"
It cost me X12345! That should be an X.
###
###
=head1 agrave
Open E<agrave> la shell. Previous versions mapped it wrong.
###
.SH "agrave"
.IX Header "agrave"
Open a\*` la shell. Previous versions mapped it wrong.
###
###
=over
=item First level
Blah blah blah....
=over
=item *
Should be a bullet.
=back
=back
###
.IP "First level" 4
.IX Item "First level"
Blah blah blah....
.RS 4
.IP "\(bu" 4
Should be a bullet.
.RE
.RS 4
.RE
###
###
=over 4
=item 1. Check fonts in @CARP_NOT test.
=back
###
.ie n .IP "1. Check fonts in @CARP_NOT test." 4
.el .IP "1. Check fonts in \f(CW@CARP_NOT\fR test." 4
.IX Item "1. Check fonts in @CARP_NOT test."
###
###
=head1 LINK QUOTING
There should not be double quotes: L<C<< (?>pattern) >>>.
###
.SH "LINK QUOTING"
.IX Header "LINK QUOTING"
There should not be double quotes: \f(CW\*(C`(?>pattern)\*(C'\fR.
###
###
=head1 SE<lt>E<gt> MAGIC
Magic should be applied S<RISC OS> to that.
###
.SH "S<> MAGIC"
.IX Header "S<> MAGIC"
Magic should be applied \s-1RISC\s0\ \s-1OS\s0 to that.
###
###
=head1 MAGIC MONEY
These should be identical.
Bippity boppity boo "The
price is $Z<>100."
Bippity boppity boo "The
price is $100."
###
.SH "MAGIC MONEY"
.IX Header "MAGIC MONEY"
These should be identical.
.PP
Bippity boppity boo \*(L"The
price is \f(CW$100\fR.\*(R"
.PP
Bippity boppity boo \*(L"The
price is \f(CW$100\fR.\*(R"
###
###
=head1 NAME
"Stuff" (no guesswork)
=head2 THINGS
Oboy, is this C++ "fun" yet! (guesswork)
###
.SH "NAME"
"Stuff" (no guesswork)
.SS "\s-1THINGS\s0"
.IX Subsection "THINGS"
Oboy, is this \*(C+ \*(L"fun\*(R" yet! (guesswork)
###
###
=head1 Newline C Quote Weirdness
Blorp C<'
''>. Yes.
###
.SH "Newline C Quote Weirdness"
.IX Header "Newline C Quote Weirdness"
Blorp \f(CW\*(Aq
\&\*(Aq\*(Aq\fR. Yes.
###
###
=head1 Soft Hypen Testing
sigE<shy>action
manuE<shy>script
JarkE<shy>ko HieE<shy>taE<shy>nieE<shy>mi
And again:
sigE<173>action
manuE<173>script
JarkE<173>ko HieE<173>taE<173>nieE<173>mi
And one more time:
sigE<0x00AD>action
manuE<0x00AD>script
JarkE<0x00AD>ko HieE<0x00AD>taE<0x00AD>nieE<0x00AD>mi
###
.SH "Soft Hypen Testing"
.IX Header "Soft Hypen Testing"
sig\%action
manu\%script
Jark\%ko Hie\%ta\%nie\%mi
.PP
And again:
.PP
sig\%action
manu\%script
Jark\%ko Hie\%ta\%nie\%mi
.PP
And one more time:
.PP
sig\%action
manu\%script
Jark\%ko Hie\%ta\%nie\%mi
###
###
=head1 XE<lt>E<gt> Whitespace
Blorpy L<B<prok>|blap> X<bivav> wugga chachacha.
###
.SH "X<> Whitespace"
.IX Header "X<> Whitespace"
Blorpy \fBprok\fR wugga chachacha.
.IX Xref "bivav"
###
###
=head1 Hyphen in SE<lt>E<gt>
Don't S<transform even-this hyphen>. This "one's-fine!", as well. However,
$-0.13 should have a real hyphen.
###
.SH "Hyphen in S<>"
.IX Header "Hyphen in S<>"
Don't transform\ even-this\ hyphen. This \*(L"one's-fine!\*(R", as well. However,
$\-0.13 should have a real hyphen.
###
###
=head1 Quote escaping
Don't escape `this' but do escape C<`this'> (and don't surround it in quotes).
###
.SH "Quote escaping"
.IX Header "Quote escaping"
Don't escape `this' but do escape \f(CW\`this\*(Aq\fR (and don't surround it in quotes).
###
###
=pod
E<eth>
###
.PP
\&\*(d-
###
###
=head1 C<one> and C<two>
###
.ie n .SH """one"" and ""two"""
.el .SH "\f(CWone\fP and \f(CWtwo\fP"
.IX Header "one and two"
###
###
=pod
Some text.
=for man
Some raw nroff.
=for roff \fBBold text.\fP
=for html
Stuff that's hidden.
=for MAN \fIItalic text.\fP
=for ROFF
.PP
\&A paragraph.
More text.
###
Some text.
Some raw nroff.
\fBBold text.\fP
\fIItalic text.\fP
.PP
\&A paragraph.
.PP
More text.
###
###
=head1 NAME
test - C<test>
###
.SH "NAME"
test \- "test"
###
###
=head1 INDEX
Index entry matching a whitespace escape.X<\n>
###
.SH "INDEX"
.IX Header "INDEX"
Index entry matching a whitespace escape.
.IX Xref "\\n"
###
###
=head1 LINK TO URL
This is a L<link|http://www.example.com/> to a URL.
###
.SH "LINK TO URL"
.IX Header "LINK TO URL"
This is a link <http://www.example.com/> to a \s-1URL\s0.
###
###
=head1 NAME
test - B<test> I<italics> F<file>
###
.SH "NAME"
test \- test italics file
###
###
=head1 TRAILING SPACE
HelloS< >
worldS< >
.
###
.SH "TRAILING SPACE"
.IX Header "TRAILING SPACE"
Hello\
.PP
world\ \ \
.PP
\&.
###