Procedural File: TutorialHighlightParser.inc

Source Location: /phpDocumentor/TutorialHighlightParser.inc

Page Details

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

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

Link:	http://pear.php.net/PhpDocumentor
Since:	1.3.0
Filesource:	Source Code for this file
Link:	http://www.phpdoc.org
Tutorial:	@example, @filesource
Copyright:	2003-2006 Gregory Beaver
License:	LGPL
Version:	CVS: $Id: TutorialHighlightParser.inc,v 1.4 2006/05/01 04:13:51 cellog Exp $
Author:	Gregory Beaver <[email protected]>

Classes

Class	Description
phpDocumentor_TutorialHighlightParser	Highlights source code using parse()

Constants

STATE_TUTORIAL_ATTRIBUTE [line 478]

STATE_TUTORIAL_ATTRIBUTE = 104

currently parsing an open <tag>

[ Top ]

STATE_TUTORIAL_CLOSETAG [line 483]

STATE_TUTORIAL_CLOSETAG = 105

currently parsing a close </tag>

[ Top ]

STATE_TUTORIAL_COMMENT [line 493]

STATE_TUTORIAL_COMMENT = 107

currently parsing a 

[ Top ]

STATE_TUTORIAL_DOUBLEQUOTE [line 503]

STATE_TUTORIAL_DOUBLEQUOTE = 109

currently parsing a 

[ Top ]

STATE_TUTORIAL_ENTITY [line 488]

STATE_TUTORIAL_ENTITY = 106

currently parsing an &entity;

[ Top ]

STATE_TUTORIAL_ITAG [line 468]

STATE_TUTORIAL_ITAG = 102

currently parsing an {@inline tag}

[ Top ]

STATE_TUTORIAL_NOEVENTS [line 463]

STATE_TUTORIAL_NOEVENTS = 101

currently in starting state

[ Top ]

STATE_TUTORIAL_OPENTAG [line 473]

STATE_TUTORIAL_OPENTAG = 103

currently parsing an open <tag>

[ Top ]

STATE_TUTORIAL_SINGLEQUOTE [line 498]

STATE_TUTORIAL_SINGLEQUOTE = 108

currently parsing a 

[ Top ]

TUTORIAL_EVENT_ATTRIBUTE [line 476]

TUTORIAL_EVENT_ATTRIBUTE = 4

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

[ Top ]

TUTORIAL_EVENT_CLOSETAG [line 481]

TUTORIAL_EVENT_CLOSETAG = 5

used when a close </tag> is found

[ Top ]

TUTORIAL_EVENT_COMMENT [line 491]

TUTORIAL_EVENT_COMMENT = 7

used when a  is found

[ Top ]

TUTORIAL_EVENT_DOUBLEQUOTE [line 501]

TUTORIAL_EVENT_DOUBLEQUOTE = 9

used when a  is found

[ Top ]

TUTORIAL_EVENT_ENTITY [line 486]

TUTORIAL_EVENT_ENTITY = 6

used when an &entity; is found

[ Top ]

TUTORIAL_EVENT_ITAG [line 466]

TUTORIAL_EVENT_ITAG = 2

used when an {@inline tag} is found

[ Top ]

TUTORIAL_EVENT_NOEVENTS [line 461]

TUTORIAL_EVENT_NOEVENTS = 1

starting state

[ Top ]

TUTORIAL_EVENT_OPENTAG [line 471]

TUTORIAL_EVENT_OPENTAG = 3

used when an open <tag> is found

[ Top ]

TUTORIAL_EVENT_SINGLEQUOTE [line 496]

TUTORIAL_EVENT_SINGLEQUOTE = 8

used when a  is found

[ Top ]

Documentation generated on Tue, 24 Oct 2006 09:26:35 -0500 by phpDocumentor 1.3.1

	phpDocumentor Parsers

[ class tree: phpDocumentor ] [ index: phpDocumentor ] [ all elements ]