1 package C4
::TmplTokenType
;
5 # This file is part of Koha.
7 # Koha is free software; you can redistribute it and/or modify it
8 # under the terms of the GNU General Public License as published by
9 # the Free Software Foundation; either version 3 of the License, or
10 # (at your option) any later version.
12 # Koha is distributed in the hope that it will be useful, but
13 # WITHOUT ANY WARRANTY; without even the implied warranty of
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 # GNU General Public License for more details.
17 # You should have received a copy of the GNU General Public License
18 # along with Koha; if not, see <http://www.gnu.org/licenses>.
21 #use warnings; FIXME - Bug 2505
24 use vars
qw(@ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
26 ###############################################################################
30 C4::TmplTokenType.pm - Types of TmplToken objects
34 This is a Java-style "safe enum" singleton class for types of TmplToken objects.
35 The predefined constants are
39 ###############################################################################
55 ###############################################################################
57 use vars
qw( $_text $_text_parametrized $_cdata
58 $_tag $_decl $_pi $_directive $_comment $_null $_unknown );
62 my $this = 'C4::TmplTokenType';#shift;
63 my $class = ref($this) || $this;
66 ($self->{'id'}, $self->{'name'}, $self->{'desc'}) = @_;
69 $_text = &$new(0, 'TEXT');
70 $_text_parametrized = &$new(8, 'TEXT-PARAMETRIZED');
71 $_cdata = &$new(1, 'CDATA');
72 $_tag = &$new(2, 'TAG');
73 $_decl = &$new(3, 'DECL');
74 $_pi = &$new(4, 'PI');
75 $_directive = &$new(5, 'DIRECTIVE');
76 $_comment = &$new(6, 'COMMENT');
77 $_unknown = &$new(7, 'UNKNOWN');
82 return $this->{'name'}
86 sub TEXT_PARAMETRIZED { $_text_parametrized }
91 sub DIRECTIVE { $_directive }
92 sub COMMENT { $_comment }
93 sub UNKNOWN { $_unknown }
95 ###############################################################################
101 normal text (#text in the DTD)
103 =item TEXT_PARAMETRIZED
105 parametrized normal text
106 (result of simple recognition of text interspersed with <TMPL_VAR> directives;
107 this has to be explicitly enabled in the scanner)
111 normal text (CDATA in the DTD)
115 something that has the form of an HTML tag
119 something that has the form of an SGML declaration
123 something that has the form of an SGML processing instruction
127 a Template Toolkit directive
131 something that has the form of an HTML comment
132 (and is not recognized as an HTML::Template directive)
136 something that is not recognized at all by the scanner
140 Note that end of file is currently represented by undef,
141 instead of a constant predefined by this module.