1PPI::Token::BOM(3)    User Contributed Perl Documentation   PPI::Token::BOM(3)
2
3
4

NAME

6       PPI::Token::BOM - Tokens representing Unicode byte order marks
7

INHERITANCE

9         PPI::Token::BOM
10         isa PPI::Token
11             isa PPI::Element
12

DESCRIPTION

14       This is a special token in that it can only occur at the beginning of
15       documents.  If a BOM byte mark occurs elsewhere in a file, it should be
16       treated as PPI::Token::Whitespace.  We recognize the byte order marks
17       identified at this URL: <http://www.unicode.org/faq/utf_bom.html#BOM>
18
19           UTF-32, big-endian     00 00 FE FF
20           UTF-32, little-endian  FF FE 00 00
21           UTF-16, big-endian     FE FF
22           UTF-16, little-endian  FF FE
23           UTF-8                  EF BB BF
24
25       Note that as of this writing, PPI only has support for UTF-8 (namely,
26       in POD and strings) and no support for UTF-16 or UTF-32.  We support
27       the BOMs of the latter two for completeness only.
28
29       The BOM is considered non-significant, like white space.
30

METHODS

32       There are no additional methods beyond those provided by the parent
33       PPI::Token and PPI::Element classes.
34

SUPPORT

36       See the support section in the main module
37

AUTHOR

39       Chris Dolan <cdolan@cpan.org>
40

42       Copyright 2001 - 2011 Adam Kennedy.
43
44       This program is free software; you can redistribute it and/or modify it
45       under the same terms as Perl itself.
46
47       The full text of the license can be found in the LICENSE file included
48       with this module.
49
50
51
52perl v5.32.1                      2021-01-27                PPI::Token::BOM(3)
Impressum