内容

名称

Pod::Simple::SimpleTree -- 将 Pod 解析为简单的解析树

概要

% cat ptest.pod

=head1 PIE

I like B<pie>!

% perl -MPod::Simple::SimpleTree -MData::Dumper -e \
   "print Dumper(Pod::Simple::SimpleTree->new->parse_file(shift)->root)" \
   ptest.pod

$VAR1 = [
          'Document',
          { 'start_line' => 1 },
          [
            'head1',
            { 'start_line' => 1 },
            'PIE'
          ],
          [
            'Para',
            { 'start_line' => 3 },
            'I like ',
            [
              'B',
              {},
              'pie'
            ],
            '!'
          ]
        ];

描述

这个类对编写 Pod 处理器/格式化程序的人员很有用。

这个类接收 Pod 并解析它,返回一个仅由数组引用、哈希引用和字符串组成的解析树。

这是 Pod::Simple 的子类,并继承了它所有的方法。

这个类受 XML::Parser 的“树”解析风格启发,尽管它没有使用完全相同的 LoL 格式。

方法

在解析结束时,调用 $parser->root 获取树的顶层节点。

树内容

解析树中的每个元素节点都由一个数组引用表示,形式为:[ 元素名称, \%attributes, ...子节点... ]。请参见概要中给出的示例树转储。

树中的每个文本节点都由一个简单的(非引用)字符串标量表示。因此,您可以测试 ref($node) 来查看您是否拥有一个元素节点或只是一个文本节点。

树的顶层节点是 [ 'Document', \%attributes, ...子节点... ]

另请参阅

Pod::Simple

perllol

XML::Parser 中的“树”子节

支持

有关 POD 和 Pod::Simple 的问题或讨论,请发送邮件至 [email protected] 邮件列表。发送空邮件至 [email protected] 订阅。

此模块在开放的 GitHub 仓库中进行管理,https://github.com/perl-pod/pod-simple/。欢迎您随意 fork 和贡献,或者克隆 git://github.com/perl-pod/pod-simple.git 并发送补丁!

欢迎您针对 Pod::Simple 发送补丁。请将错误报告发送至 <[email protected]>。

版权和免责声明

版权所有 (c) 2002 Sean M. Burke。

此库是自由软件;您可以根据与 Perl 本身相同的条款重新分发和/或修改它。

此程序按“原样”提供,不提供任何形式的明示或暗示的保证,包括但不限于适销性或特定用途适用性的暗示保证。

作者

Pod::Simple 由 Sean M. Burke <[email protected]> 创建。但请不要打扰他,他已经退休了。

Pod::Simple 由以下人员维护: