Commit | Line | Data |
3fea05b9 |
1 | package PPI::Structure::Unknown; |
2 | |
3 | =pod |
4 | |
5 | =head1 NAME |
6 | |
7 | PPI::Structure::Unknown - An unknown or unresolved brace structure |
8 | |
9 | =head1 INHERITANCE |
10 | |
11 | PPI::Structure::Unknown |
12 | isa PPI::Structure |
13 | isa PPI::Node |
14 | isa PPI::Element |
15 | |
16 | =head1 DESCRIPTION |
17 | |
18 | C<PPI::Structure::Unknown> is class for braces whose type is unknown, or |
19 | temporarily unknown. |
20 | |
21 | It primarily exists temporarily inside the lexer. Although some types of |
22 | braces can be determined immediately at opening, there are a number of |
23 | different brace types that can only be correctly identified after the |
24 | braces are closed. |
25 | |
26 | A structure is typed as unknown during this period it is indeterminate. |
27 | |
28 | A C<PPI::Structure::Unknown> object should not B<ever> make it out of the |
29 | lexer without being converted to it's final type. Any time you encounter |
30 | this class in a PDOM tree it should be considered a bug and reported |
31 | accordingly. |
32 | |
33 | =head1 METHODS |
34 | |
35 | C<PPI::Structure::Unknown> has no methods beyond those provided by the |
36 | standard L<PPI::Structure>, L<PPI::Node> and L<PPI::Element> methods. |
37 | |
38 | Got any ideas for methods? Submit a report to rt.cpan.org! |
39 | |
40 | =cut |
41 | |
42 | use strict; |
43 | use PPI::Structure (); |
44 | |
45 | use vars qw{$VERSION @ISA}; |
46 | BEGIN { |
47 | $VERSION = '1.206'; |
48 | @ISA = 'PPI::Structure'; |
49 | } |
50 | |
51 | 1; |
52 | |
53 | =pod |
54 | |
55 | =head1 SUPPORT |
56 | |
57 | See the L<support section|PPI/SUPPORT> in the main module. |
58 | |
59 | =head1 AUTHOR |
60 | |
61 | Adam Kennedy E<lt>adamk@cpan.orgE<gt> |
62 | |
63 | =head1 COPYRIGHT |
64 | |
65 | Copyright 2001 - 2009 Adam Kennedy. |
66 | |
67 | This program is free software; you can redistribute |
68 | it and/or modify it under the same terms as Perl itself. |
69 | |
70 | The full text of the license can be found in the |
71 | LICENSE file included with this module. |
72 | |
73 | =cut |