/phpDocumentor/TutorialHighlightParser.inc

Description

Source Code Highlighting

The classes in this file are responsible for the dynamic @example, and <programlisting role="tutorial"> tags output. Using the WordParser, the phpDocumentor_TutorialHighlightParser retrieves PHP tokens one by one from the array generated by WordParser source retrieval functions and then highlights them individually.

It accomplishes this highlighting through the assistance of methods in the output Converter passed to its parse() method, and then returns the fully highlighted source as a string

phpDocumentor :: automatic documentation generator

PHP versions 4 and 5

Copyright (c) 2003-2007 Gregory Beaver

LICENSE:

This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA

Classes
Class Description
phpDocumentor_TutorialHighlightParser Highlights source code using parse()
Constants
STATE_TUTORIAL_ATTRIBUTE = 104 (line 568)

currently parsing an open <tag>

STATE_TUTORIAL_CLOSETAG = 105 (line 578)

currently parsing a close </tag>

STATE_TUTORIAL_COMMENT = 107 (line 598)

currently parsing a <!-- comment -->

STATE_TUTORIAL_DOUBLEQUOTE = 109 (line 618)

currently parsing a <!-- comment -->

STATE_TUTORIAL_ENTITY = 106 (line 588)

currently parsing an &entity;

STATE_TUTORIAL_ITAG = 102 (line 548)

currently parsing an [email protected] tag}

STATE_TUTORIAL_NOEVENTS = 101 (line 538)

currently in starting state

STATE_TUTORIAL_OPENTAG = 103 (line 558)

currently parsing an open <tag>

STATE_TUTORIAL_SINGLEQUOTE = 108 (line 608)

currently parsing a <!-- comment -->

TUTORIAL_EVENT_ATTRIBUTE = 4 (line 563)

used when a <tag attr="attribute"> is found

TUTORIAL_EVENT_CLOSETAG = 5 (line 573)

used when a close </tag> is found

TUTORIAL_EVENT_COMMENT = 7 (line 593)

used when a <!-- comment --> is found

TUTORIAL_EVENT_DOUBLEQUOTE = 9 (line 613)

used when a <!-- comment --> is found

TUTORIAL_EVENT_ENTITY = 6 (line 583)

used when an &entity; is found

TUTORIAL_EVENT_ITAG = 2 (line 543)

used when an [email protected] tag} is found

TUTORIAL_EVENT_NOEVENTS = 1 (line 533)

starting state

TUTORIAL_EVENT_OPENTAG = 3 (line 553)

used when an open <tag> is found

TUTORIAL_EVENT_SINGLEQUOTE = 8 (line 603)

used when a <!-- comment --> is found

Documentation generated on Mon, 05 Dec 2011 21:01:19 -0600 by phpDocumentor 1.4.4