Subversion-Projekte lars-tiefland.php_share

<?php

/**

 * CHM (Compiled Help Manual) output converter for Smarty Template.

 *

 * phpDocumentor :: automatic documentation generator

 *

 * PHP versions 4 and 5

 *

 * Copyright (c) 2003-2006 Andrew Eddie, Greg 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

 *

 * @package    Converters

 * @subpackage CHMdefault

 * @author     Joshua Eichorn <jeichorn@phpdoc.org>

 * @author     Greg Beaver <cellog@php.net>

 * @copyright  2000-2006 Joshua Eichorn, Gregory Beaver

 * @license    http://www.opensource.org/licenses/lgpl-license.php LGPL

 * @version    CVS: $Id: CHMdefaultConverter.inc 234145 2007-04-19 20:20:57Z ashnazg $

 * @filesource

 * @link       http://www.phpdoc.org

 * @link       http://pear.php.net/PhpDocumentor

 * @since      1.0rc1

 */

/**

 * Generates files that MS HTML Help Worshop can use to create a MS Windows

 * compiled help file (CHM)

 *

 * The free MS HTML Help compiler takes the project file (phpdoc.hhp) and reads

 * the table of contents file specified in the project (which is always contents.hhc

 * in phpDocumentor).  When the converter reaches stable state, it will also

 * output an index file index.hhk.  The free download for MS HTML Help Workshop

 * is available below

 * @link http://www.microsoft.com/downloads/release.asp?releaseid=33071 MS HTML Help Workshop download

 * @package Converters

 * @subpackage CHMdefault

 * @author Greg Beaver <cellog@php.net>

 * @since 1.0rc1

 * @version $Revision: 234145 $

 */

class CHMdefaultConverter extends Converter

{

    /**

     * CHMdefaultConverter wants elements sorted by type as well as alphabetically

     * @see Converter::$sort_page_contents_by_type

     * @var boolean

     */

    var $sort_page_contents_by_type = true;

    /** @var string */

    var $outputformat = 'CHM';

    /** @var string */

    var $name = 'default';

    /**

     * indexes of elements by package that need to be generated

     * @var array

     */

    var $leftindex = array('classes' => true, 'pages' => true, 'functions' => true, 'defines' => false, 'globals' => false);

    /**

     * output directory for the current procedural page being processed

     * @var string

     */

    var $page_dir;

    /**

     * target directory passed on the command-line.

     * {@link $targetDir} is malleable, always adding package/ and package/subpackage/ subdirectories onto it.

     * @var string

     */

    var $base_dir;

    /**

     * output directory for the current class being processed

     * @var string

     */

    var $class_dir;

    /**

     * array of converted package page names.

     * Used to link to the package page in the left index

     * @var array Format: array(package => 1)

     */

    var $package_pages = array();

    /**

     * controls formatting of parser informative output

     *

     * Converter prints:

     * "Converting /path/to/file.php... Procedural Page Elements... Classes..."

     * Since CHMdefaultConverter outputs files while converting, it needs to send a \n to start a new line.  However, if there

     * is more than one class, output is messy, with multiple \n's just between class file output.  This variable prevents that

     * and is purely cosmetic

     * @var boolean

     */

    var $juststarted = false;

    /**

     * contains all of the template procedural page element loop data needed for the current template

     * @var array

     */

    var $current;

    /**

     * contains all of the template class element loop data needed for the current template

     * @var array

     */

    var $currentclass;

    var $wrote = false;

    var $ric_set = array();

    /**

     * Table of Contents entry for index.hhk

     * @var array

     */

    var $KLinks = array();

    /**

     * sets {@link $base_dir} to $targetDir

     * @see Converter()

     */

    function CHMdefaultConverter(&$allp, &$packp, &$classes, &$procpages, $po, $pp, $qm, $targetDir, $templateDir, $title)

    {

        Converter::Converter($allp, $packp, $classes, $procpages,$po, $pp, $qm, $targetDir, $templateDir, $title);

        $this->base_dir = $targetDir;

    }

    /**

     * @deprecated in favor of PHP 4.3.0+ tokenizer-based source highlighting

     */

    function unmangle($sourcecode)

    {

        $sourcecode = str_replace('<code>','<pre>',$sourcecode);

        $sourcecode = str_replace('</code>','</pre>',$sourcecode);

        $sourcecode = str_replace('<br />',"\n",$sourcecode);

        $sourcecode = str_replace(' ',' ',$sourcecode);

        $sourcecode = str_replace('&lt;','<',$sourcecode);

        $sourcecode = str_replace('>','>',$sourcecode);

        $sourcecode = str_replace('&','&',$sourcecode);

        return $sourcecode;

    }

    /**

     * @param string full path to the source file

     * @param string fully highlighted source code

     */

    function writeSource($path, $value)

    {

        $templ = &$this->newSmarty();

        $pathinfo = $this->proceduralpages->getPathInfo($path, $this);

        $templ->assign('source',$value);

        $templ->assign('package',$pathinfo['package']);

        $templ->assign('subpackage',$pathinfo['subpackage']);

        $templ->assign('name',$pathinfo['name']);

        $templ->assign('source_loc',$pathinfo['source_loc']);

        $templ->assign('docs',$pathinfo['docs']);

        $templ->assign("subdir",'../');

        $templ->register_outputfilter('CHMdefault_outputfilter');

        $this->setTargetDir($this->getFileSourcePath($this->base_dir));

        $this->addSourceTOC($pathinfo['name'],$this->getFileSourceName($path),$pathinfo['package'],$pathinfo['subpackage'], true);

        phpDocumentor_out("\n");

        $this->setSourcePaths($path);

        $this->writefile($this->getFileSourceName($path).'.html',$templ->fetch('filesource.tpl'));

    }

    function writeExample($title, $path, $source)

    {

        $templ = &$this->newSmarty();

        $templ->assign('source',$source);

        if (empty($title))

        {

            $title = 'example';

            addWarning(PDERROR_EMPTY_EXAMPLE_TITLE, $path, $title);

        }

        $templ->assign('title',$title);

        $templ->assign('file',$path);

        $templ->assign("subdir",'../');

        $templ->register_outputfilter('CHMdefault_outputfilter');

        $pathinfo = $this->proceduralpages->getPathInfo($path, $this);

        $this->setTargetDir($this->base_dir . PATH_DELIMITER . '__examplesource');

        $this->addSourceTOC($title,'exsource_'.$path,$pathinfo['package'],$pathinfo['subpackage'], false);

        phpDocumentor_out("\n");

        $this->writefile('exsource_'.$path.'.html',$templ->fetch('examplesource.tpl'));

    }

    function getExampleLink($path, $title)

    {

        return $this->returnLink('{$subdir}__examplesource' . PATH_DELIMITER . 'exsource_'.$path.'.html',$title);

    }

    function getSourceLink($path)

    {

        return $this->returnLink('{$subdir}__filesource/' .

        $this->getFileSourceName($path).'.html','Source Code for this file');

    }

    /**

     * Retrieve a Converter-specific anchor to a segment of a source code file

     * parsed via a {@tutorial tags.filesource.pkg} tag.

     * @param string full path to source file

     * @param string name of anchor

     * @param string link text, if this is a link

     * @param boolean returns either a link or a destination based on this

     *                parameter

     * @return string link to an anchor, or the anchor

     */

    function getSourceAnchor($sourcefile,$anchor,$text = '',$link = false)

    {

        if ($link) {

            return $this->returnLink('{$subdir}__filesource/' .

                $this->getFileSourceName($sourcefile) . '.html#a' . $anchor, $text);

        } else {

            return '<a name="a'.$anchor.'"></a>';

        }

    }

    /**

     * Return a line of highlighted source code with formatted line number

     *

     * If the $path is a full path, then an anchor to the line number will be

     * added as well

     * @param integer line number

     * @param string highlighted source code line

     * @param false|string full path to @filesource file this line is a part of,

     *        if this is a single line from a complete file.

     * @return string formatted source code line with line number

     */

    function sourceLine($linenumber, $line, $path = false)

    {

        $extra = '';

        if (strlen(str_replace("\n", '', $line)) == 0) {

            $extra = ' ';

        }

        if ($path)

        {

            return '<li><div class="src-line">' . $this->getSourceAnchor($path, $linenumber) .

                   str_replace("\n",'',$line) . $extra .

                   "</div></li>\n";

        } else

        {

            return '<li><div class="src-line">' . str_replace("\n",'',$line) .

                "$extra</div></li>\n";

        }

    }

    /**

     * Used to convert the <<code>> tag in a docblock

     * @param string

     * @param boolean

     * @return string

     */

    function ProgramExample($example, $tutorial = false, $inlinesourceparse = null/*false*/,

                            $class = null/*false*/, $linenum = null/*false*/, $filesourcepath = null/*false*/)

    {

        return $this->PreserveWhiteSpace(parent::ProgramExample($example, $tutorial, $inlinesourceparse, $class, $linenum, $filesourcepath));

    }

    /**

     * @param string

     */

    function TutorialExample($example)

    {

        $trans = $this->template_options['desctranslate'];

        $this->template_options['desctranslate'] = array();

        $example = '<ol>' . parent::TutorialExample($example)

               .'</ol>';

        $this->template_options['desctranslate'] = $trans;

        if (!isset($this->template_options['desctranslate'])) return $example;

        if (!isset($this->template_options['desctranslate']['code'])) return $example;

        $example = $this->template_options['desctranslate']['code'] . $example;

        if (!isset($this->template_options['desctranslate']['/code'])) return $example;

        return $example . $this->template_options['desctranslate']['/code'];

    }

    function getCurrentPageLink()

    {

        return $this->curname . '.html';

    }

    /**

     * Uses htmlspecialchars() on the input

     */

    function postProcess($text)

    {

        if ($this->highlightingSource) {

            return str_replace(array(' ',"\t"), array(' ', '   '),

                htmlspecialchars($text));

        }

        return htmlspecialchars($text);

    }

    /**

     * Use the template tutorial_toc.tpl to generate a table of contents for HTML

     * @return string table of contents formatted for use in the current output format

     * @param array format: array(array('tagname' => section, 'link' => returnsee link, 'id' => anchor name, 'title' => from title tag),...)

     */

    function formatTutorialTOC($toc)

    {

        $template = &$this->newSmarty();

        $template->assign('toc',$toc);

        return $template->fetch('tutorial_toc.tpl');

    }

    function &SmartyInit(&$templ)

    {

        if (!isset($this->package_index))

        foreach($this->all_packages as $key => $val)

        {

            if (isset($this->pkg_elements[$key]))

            {

                if (!isset($start)) $start = $key;

                $this->package_index[] = array('link' => "li_$key.html", 'title' => $key);

            }

        }

        $templ->assign("packageindex",$this->package_index);

        $templ->assign("subdir",'');

        return $templ;

    }

    /**

     * Writes out the template file of {@link $class_data} and unsets the template to save memory

     * @see registerCurrentClass()

     * @see parent::endClass()

     */

    function endClass()

    {

        $a = '../';

        if (!empty($this->subpackage)) $a .= '../';

        if ($this->juststarted)

        {

            $this->juststarted = false;

            phpDocumentor_out("\n");

            flush();

        }

        $this->setTargetDir($this->base_dir . PATH_DELIMITER . $this->class_dir);

        $this->class_data->assign("subdir",$a);

        $this->class_data->register_outputfilter('CHMdefault_outputfilter');

        $this->addTOC($this->class,$this->class,$this->package,$this->subpackage, true);

        $this->writefile($this->class . '.html',$this->class_data->fetch('class.tpl'));

        unset($this->class_data);

    }

    /**

     * Writes out the template file of {@link $page_data} and unsets the template to save memory

     * @see registerCurrent()

     * @see parent::endPage()

     */

    function endPage()

    {

        $this->package = $this->curpage->package;

        $this->subpackage = $this->curpage->subpackage;

        $a = '../';

        if (!empty($this->subpackage)) $a .= '../';

        $this->setTargetDir($this->base_dir . PATH_DELIMITER . $this->page_dir);

        $this->page_data->assign("package",$this->package);

        $this->page_data->assign("subdir",$a);

        $this->page_data->register_outputfilter('CHMdefault_outputfilter');

        $this->addTOC($this->curpage->file,$this->page,$this->package,$this->subpackage);

        $this->writefile($this->page . '.html',$this->page_data->fetch('page.tpl'));

        unset($this->page_data);

    }

    /**

     * @param string

     * @param string

     * @return string &lt;a href="'.$link.'">'.$text.'</a&gt;

     */

    function returnLink($link,$text)

    {

        return '<a href="'.$link.'">'.$text.'</a>';

    }

    /**

     * CHMdefaultConverter chooses to format both package indexes and the complete index here

     *

     * This function formats output for the elementindex.html and pkgelementindex.html template files.  It then

     * writes them to the target directory

     * @see generateElementIndex(), generatePkgElementIndex()

     */

    function formatPkgIndex()

    {

        list($package_indexes,$packages,$mletters) = $this->generatePkgElementIndexes();

        for($i=0;$i<count($package_indexes);$i++)

        {

            $template = &$this->newSmarty();

            $this->package = $package_indexes[$i]['package'];

            $this->subpackage = '';

            $template->assign("index",$package_indexes[$i]['pindex']);

            $template->assign("package",$package_indexes[$i]['package']);

            $template->assign("letters",$mletters[$package_indexes[$i]['package']]);

            $template->assign("title","Package ".$package_indexes[$i]['package']." Element Index");

            $template->assign("subdir",'../');

            $template->register_outputfilter('CHMdefault_outputfilter');

            $this->setTargetDir($this->base_dir . PATH_DELIMITER . $package_indexes[$i]['package']);

            $this->addTOC($package_indexes[$i]['package']." Alphabetical Index",'elementindex_'.$package_indexes[$i]['package'],$package_indexes[$i]['package'],'');

            $this->writefile('elementindex_'.$package_indexes[$i]['package'].'.html',$template->fetch('pkgelementindex.tpl'));

        }

        phpDocumentor_out("\n");

        flush();

        }

    /**

     * CHMdefaultConverter uses this function to format template index.html and packages.html

     *

     * This function generates the package list from {@link $all_packages}, eliminating any

     * packages that don't have any entries in their package index (no files at all, due to @ignore

     * or other factors).  Then it uses the default package name as the first package index to display.

     * It sets the right pane to be either a blank file with instructions on making package-level docs,

     * or the package-level docs for the default package.

     * @global string Used to set the starting package to display

     */

    function formatIndex()

    {

        global $phpDocumentor_DefaultPackageName;

        list($elindex,$mletters) = $this->generateElementIndex();

        $template = &$this->newSmarty();

        $template->assign("index",$elindex);

        $template->assign("letters",$mletters);

        $template->assign("title","Element Index");

        $template->assign("date",date("r",time()));

        $template->register_outputfilter('CHMdefault_outputfilter');

        phpDocumentor_out("\n");

        flush();

        $this->setTargetDir($this->base_dir);

        $this->addTOC("Alphabetical Index Of All Elements",'elementindex',"Index",'');

        $this->writefile('elementindex.html',$template->fetch('elementindex.tpl'));

        usort($this->package_index,"CHMdefault_pindexcmp");

        $index = &$this->newSmarty();

        foreach($this->all_packages as $key => $val)

        {

            if (isset($this->pkg_elements[$key]))

            {

                if (!isset($start)) $start = $key;

                if (!isset($this->package_pages[$key])) $this->writeNewPPage($key);

            }

        }

        $this->setTargetDir($this->base_dir);

        // Created index.html

        if (isset($this->pkg_elements[$phpDocumentor_DefaultPackageName])) $start = $phpDocumentor_DefaultPackageName;

        $this->package = $start;

        $this->subpackage = '';

        $setalready = false;

        if (isset($this->tutorials[$start]['']['pkg']))

        {

            foreach($this->tutorials[$start]['']['pkg'] as $tute)

            {

                if ($tute->name == $start . '.pkg')

                {

                    $setalready = true;

                       $this->addTOC("Start page",$start.'/tutorial_'.$tute->name,"Index",'');

                }

            }

        }

        if (!$setalready)

        {

            if (isset($this->package_pages[$start]))

            {

                   $this->addTOC("Start page",'package_'.$start,"Index",'');

            }

            else

            {

                $index->assign("blank","blank");

                $blank = &$this->newSmarty();

                $blank->assign('package',$phpDocumentor_DefaultPackageName);

                $this->addTOC("Start page",'blank',"Index",'');

                $this->writefile("blank.html",$blank->fetch('blank.tpl'));

                Converter::writefile('index.html',$blank->fetch('tutorial.tpl'));

            }

        }

        phpDocumentor_out("\n");

        flush();

        unset($index);

    }

    function writeNewPPage($key)

    {

        return;

        $template = &$this->newSmarty();

        $this->package = $key;

        $this->subpackage = '';

        $template->assign("date",date("r",time()));

        $template->assign("title",$this->title);

        $template->assign("package",$key);

        $template->register_outputfilter('CHMdefault_outputfilter');

        phpDocumentor_out("\n");

        flush();

        $this->setTargetDir($this->base_dir);

        $this->addTOC("$key Index","li_$key",$key,'');

        $this->writefile("li_$key.html",$template->fetch('index.tpl'));

        unset($template);

    }

    /**

     * Generate indexes for li_package.html and classtree output files

     *

     * This function generates the li_package.html files from the template file left.html.  It does this by

     * iterating through each of the $page_elements, $class_elements and  $function_elements arrays to retrieve

     * the pre-sorted {@link abstractLink} descendants needed for index generation.  Conversion of these links to

     * text is done by {@link returnSee()}.  The {@link $local} parameter is set to false to ensure that paths are correct.

     *

     * Then it uses {@link generateFormattedClassTrees()} to create class trees from the template file classtrees.html.  Output

     * filename is classtrees_packagename.html.  This function also unsets {@link $elements} and {@link $pkg_elements} to free

     * up the considerable memory these two class vars use

     * @see $page_elements, $class_elements, $function_elements

     */

    function formatLeftIndex()

    {

        phpDocumentor_out("\n");

        flush();

        $this->setTargetDir($this->base_dir);

        if (0)//!isset($this->left))

        {

            debug("Nothing parsed, check the command-line");

            die();

        }

        foreach($this->all_packages as $package => $rest)

        {

            if (!isset($this->pkg_elements[$package])) continue;

            // Create class tree page

            $template = &$this->newSmarty();

            $template->assign("classtrees",$this->generateFormattedClassTrees($package));

            $template->assign("package",$package);

            $template->assign("date",date("r",time()));

            $template->register_outputfilter('CHMdefault_outputfilter');

            $this->addTOC("$package Class Trees","classtrees_$package",$package,'');

            $this->writefile("classtrees_$package.html",$template->fetch('classtrees.tpl'));

            phpDocumentor_out("\n");

            flush();

        }

        // free up considerable memory

        unset($this->elements);

        unset($this->pkg_elements);

    }

    /**

     * This function takes an {@link abstractLink} descendant and returns an html link

     *

     * @param abstractLink a descendant of abstractlink should be passed, and never text

     * @param string text to display in the link

     * @param boolean this parameter is not used, and is deprecated

     * @param boolean determines whether the returned text is enclosed in an <a> tag

     */

    function returnSee(&$element, $eltext = false, $with_a = true)

    {

        if (!$element) return false;

        if (!$with_a) return $this->getId($element, false);

        if (!$eltext)

        {

            $eltext = '';

            switch($element->type)

            {

                case 'tutorial' :

                $eltext = strip_tags($element->title);

                break;

                case 'method' :

                case 'var' :

                case 'const' :

                $eltext .= $element->class.'::';

                case 'page' :

                case 'define' :

                case 'class' :

                case 'function' :

                case 'global' :

                default :

                $eltext .= $element->name;

                if ($element->type == 'function' || $element->type == 'method') $eltext .= '()';

                break;

            }

        }

        return '<a href="'.$this->getId($element).'">'.$eltext.'</a>';

    }

    function getId($element, $fullpath = true)

    {

        if (phpDocumentor_get_class($element) == 'parserdata')

        {

            $element = $this->addLink($element->parent);

            $elp = $element->parent;

        } elseif (is_a($element, 'parserbase'))

        {

            $elp = $element;

            $element = $this->addLink($element);

        }

        $c = '';

        if (!empty($element->subpackage))

        {

            $c = '/'.$element->subpackage;

        }

        $b = '{$subdir}';

        switch ($element->type)

        {

            case 'page' :

            if ($fullpath)

            return $b.$element->package.$c.'/'.$element->fileAlias.'.html';

            return 'top';

            break;

            case 'define' :

            case 'global' :

            case 'function' :

            if ($fullpath)

            return $b.$element->package.$c.'/'.$element->fileAlias.'.html#'.$element->type.$element->name;

            return $element->type.$element->name;

            break;

            case 'class' :

            if ($fullpath)

            return $b.$element->package.$c.'/'.$element->name.'.html';

            return 'top';

            break;

            case 'method' :

            case 'var' :

            case 'const' :

            if ($fullpath)

            return $b.$element->package.$c.'/'.$element->class.'.html#'.$element->type.$element->name;

            return $element->type.$element->name;

            break;

            case 'tutorial' :

            $d = '';

            if ($element->section)

            {

                $d = '#'.$element->section;

            }

            return $b.$element->package.$c.'/tutorial_'.$element->name.'.html'.$d;

        }

    }

    function ConvertTodoList()

    {

        $todolist = array();

        foreach($this->todoList as $package => $alltodos)

        {

            foreach($alltodos as $todos)

            {

                $converted = array();

                $converted['link'] = $this->returnSee($todos[0]);

                if (!is_array($todos[1]))

                {

                    $converted['todos'][] = $todos[1]->Convert($this);

                } else

                {

                    foreach($todos[1] as $todo)

                    {

                        $converted['todos'][] = $todo->Convert($this);

                    }

                }

                $todolist[$package][] = $converted;

            }

        }

        $templ = &$this->newSmarty();

        $templ->assign('todos',$todolist);

        $templ->register_outputfilter('CHMdefault_outputfilter');

        $this->setTargetDir($this->base_dir);

        $this->addTOC('Todo List','todolist','Index','',false,true);

        $this->addKLink('Todo List', 'todolist', '', 'Development');

        $this->writefile('todolist.html',$templ->fetch('todolist.tpl'));

    }

    /**

     * Convert README/INSTALL/CHANGELOG file contents to output format

     * @param README|INSTALL|CHANGELOG

     * @param string contents of the file

     */

    function Convert_RIC($name, $contents)

    {

        $template = &$this->newSmarty();

        $template->assign('contents',$contents);

        $template->assign('name',$name);

        $this->setTargetDir($this->base_dir);

        $this->addTOC($name,'ric_'.$name,'Index','',false,true);

        $this->addKLink($name, 'ric_'.$name, '', 'Development');

        $this->writefile('ric_'.$name . '.html',$template->fetch('ric.tpl'));

        $this->ric_set[$name] = true;

    }

    /**

     * Create errors.html template file output

     *

     * This method takes all parsing errors and warnings and spits them out ordered by file and line number.

     * @global ErrorTracker We'll be using it's output facility

     */

    function ConvertErrorLog()

    {

        global $phpDocumentor_errors;

        $allfiles = array();

        $files = array();

        $warnings = $phpDocumentor_errors->returnWarnings();

        $errors = $phpDocumentor_errors->returnErrors();

        $template = &$this->newSmarty();

        foreach($warnings as $warning)

        {

            $file = '##none';

            $linenum = 'Warning';

            if ($warning->file)

            {

                $file = $warning->file;

                $allfiles[$file] = 1;

                $linenum .= ' on line '.$warning->linenum;

            }

            $files[$file]['warnings'][] = array('name' => $linenum, 'listing' => $warning->data);

        }

        foreach($errors as $error)

        {

            $file = '##none';

            $linenum = 'Error';

            if ($error->file)

            {

                $file = $error->file;

                $allfiles[$file] = 1;

                $linenum .= ' on line '.$error->linenum;

            }

            $files[$file]['errors'][] = array('name' => $linenum, 'listing' => $error->data);

        }

        $i=1;

        $af = array();

        foreach($allfiles as $file => $num)

        {

            $af[$i++] = $file;

        }

        $allfiles = $af;

        usort($allfiles,'strnatcasecmp');

        $allfiles[0] = "Post-parsing";

        foreach($allfiles as $i => $a)

        {

            $allfiles[$i] = array('file' => $a);

        }

        $out = array();

        foreach($files as $file => $data)

        {

            if ($file == '##none') $file = 'Post-parsing';

            $out[$file] = $data;

        }

        $template->assign("files",$allfiles);

        $template->assign("all",$out);

        $template->assign("title","phpDocumentor Parser Errors and Warnings");

        $this->setTargetDir($this->base_dir);

        $this->writefile("errors.html",$template->fetch('errors.tpl'));

        unset($template);

        phpDocumentor_out("\n\nTo view errors and warnings, look at ".$this->base_dir. PATH_DELIMITER . "errors.html\n");

        flush();

    }

    function getCData($value)

    {

        return '<pre>'.htmlentities($value).'</pre>';

    }

    function getTutorialId($package,$subpackage,$tutorial,$id)

    {

        return $id;

    }

    /**

     * Converts package page and sets its package as used in {@link $package_pages}

     * @param parserPackagePage

     */

    function convertPackagepage(&$element)

    {

        phpDocumentor_out("\n");

        flush();

        $this->package = $element->package;

        $this->subpackage = '';

        $contents = $element->Convert($this);

        $this->package_pages[$element->package] = str_replace('{$subdir}','../',$contents);

        phpDocumentor_out("\n");

        flush();

        $this->setTargetDir($this->base_dir . PATH_DELIMITER . $element->package);

        $this->addTOC($element->package." Tutorial",'package_'.$element->package,$element->package,'');

        $this->writeFile('package_'.$element->package.'.html',str_replace('{$subdir}','../',$contents));

        $this->setTargetDir($this->base_dir);

        Converter::writefile('index.html',str_replace('{$subdir}','',$contents));

        $this->addKLink($element->package." Tutorial", 'package_'.$element->package, '', 'Tutorials');

    }

    /**

     * @param parserTutorial

     */

    function convertTutorial(&$element)

    {

        phpDocumentor_out("\n");

        flush();

        $template = &parent::convertTutorial($element);

        $a = '../';

        if ($element->subpackage) $a .= '../';

        $template->assign('subdir',$a);

        $template->register_outputfilter('CHMdefault_outputfilter');

        $contents = $template->fetch('tutorial.tpl');

        if ($element->package == $GLOBALS['phpDocumentor_DefaultPackageName'] && empty($element->subpackage) && ($element->name == $element->package . '.pkg'))

        {

            $template->assign('subdir','');

            $this->setTargetDir($this->base_dir);

            Converter::writefile('index.html',$template->fetch('tutorial.tpl'));

        }

        $a = '';

        if ($element->subpackage) $a = PATH_DELIMITER . $element->subpackage;

        phpDocumentor_out("\n");

        flush();

        $this->setTargetDir($this->base_dir . PATH_DELIMITER . $element->package . $a);

        $this->addTOC($a = strip_tags($element->getTitle($this)), 'tutorial_'.$element->name,

            $element->package, $element->subpackage, false, true);

        $this->writeFile('tutorial_'.$element->name.'.html',$contents);

        $this->addKLink($element->getTitle($this), $element->package . $a . PATH_DELIMITER . 'tutorial_'.$element->name,

            '', 'Tutorials');

    }

    /**

     * Converts class for template output

     * @see prepareDocBlock(), generateChildClassList(), generateFormattedClassTree(), getFormattedConflicts()

     * @see getFormattedInheritedMethods(), getFormattedInheritedVars()

     * @param parserClass

     */

    function convertClass(&$element)

    {

        parent::convertClass($element);

        $this->class_dir = $element->docblock->package;

        if (!empty($element->docblock->subpackage)) $this->class_dir .= PATH_DELIMITER . $element->docblock->subpackage;

        $a = '../';

        if ($element->docblock->subpackage != '') $a = "../$a";

        $this->class_data->assign('subdir',$a);

        $this->class_data->assign("title","Docs For Class " . $element->getName());

        $this->class_data->assign("page",$element->getName() . '.html');

        $this->addKLink($element->name, $this->class_dir . PATH_DELIMITER . $this->class, '', 'Classes');

    }

    /**

     * Converts class variables for template output

     * @see prepareDocBlock(), getFormattedConflicts()

     * @param parserDefine

     */

    function convertVar(&$element)

    {

        parent::convertVar($element, array('var_dest' => $this->getId($element,false)));

        $this->setTargetDir($this->base_dir . PATH_DELIMITER . $this->class_dir);

        $this->addKLink($element->name, $this->class_dir . PATH_DELIMITER .$this->class, $this->getId($element,false), $element->class.' Properties');

    }

    /**

     * Converts class constants for template output

     * @see prepareDocBlock(), getFormattedConflicts()

     * @param parserDefine

     */

    function convertConst(&$element)

    {

        parent::convertConst($element, array('const_dest' => $this->getId($element,false)));

        $this->setTargetDir($this->base_dir . PATH_DELIMITER . $this->class_dir);

        $this->addKLink($element->name, $this->class_dir . PATH_DELIMITER .$this->class, $this->getId($element,false), $element->class.' Constants');

    }

    /**

     * Converts class methods for template output

     * @see prepareDocBlock(), getFormattedConflicts()

     * @param parserDefine

     */

    function convertMethod(&$element)

    {

        parent::convertMethod($element, array('method_dest' => $this->getId($element,false)));

        $this->setTargetDir($this->base_dir . PATH_DELIMITER . $this->class_dir);

        $this->addKLink($element->name, $this->class_dir . PATH_DELIMITER .$this->class, $this->getId($element,false), $element->class.' Methods');

    }

    /**

     * Converts function for template output

     * @see prepareDocBlock(), parserFunction::getFunctionCall(), getFormattedConflicts()

     * @param parserFunction

     */

    function convertFunction(&$element)

    {

        $funcloc = $this->getId($this->addLink($element));

        parent::convertFunction($element,array('function_dest' => $this->getId($element,false)));

        $this->setTargetDir($this->base_dir . PATH_DELIMITER . $this->page_dir);

        $this->addKLink($element->name, $this->page_dir . PATH_DELIMITER . $this->page, $this->getId($element,false), 'Functions');

    }

    /**

     * Converts include elements for template output

     * @see prepareDocBlock()

     * @param parserInclude

     */

    function convertInclude(&$element)

    {

        parent::convertInclude($element, array('include_file'    => '_'.strtr($element->getValue(),array('"' => '', "'" => '','.' => '_'))));

        $this->setTargetDir($this->base_dir . PATH_DELIMITER . $this->page_dir);

        $this->addKLink(str_replace('"', '', $element->getValue()), $this->page_dir . PATH_DELIMITER . $this->page, '', ucfirst($element->name));

    }

    /**

     * Converts defines for template output

     * @see prepareDocBlock(), getFormattedConflicts()

     * @param parserDefine

     */

    function convertDefine(&$element)

    {

        parent::convertDefine($element, array('define_link' => $this->getId($element,false)));

        $this->setTargetDir($this->base_dir . PATH_DELIMITER . $this->page_dir);

        $this->addKLink($element->name, $this->page_dir . PATH_DELIMITER . $this->page, $this->getId($element,false), 'Constants');

    }

    /**

     * Converts global variables for template output

     * @param parserGlobal

     */

    function convertGlobal(&$element)

    {

        parent::convertGlobal($element, array('global_link' => $this->getId($element,false)));

        $this->setTargetDir($this->base_dir . PATH_DELIMITER . $this->page_dir);

        $this->addKLink($element->name, $this->page_dir . PATH_DELIMITER . $this->page, $this->getId($element,false), 'Global Variables');

    }

    /**

     * converts procedural pages for template output

     * @see prepareDocBlock(), getClassesOnPage()

     * @param parserData

     */

    function convertPage(&$element)

    {

        parent::convertPage($element);

        $this->juststarted = true;

        $this->page_dir = $element->parent->package;

        if (!empty($element->parent->subpackage)) $this->page_dir .= PATH_DELIMITER . $element->parent->subpackage;

        // registering stuff on the template

        $this->page_data->assign("page",$this->getPageName($element) . '.html');

        $this->page_data->assign("title","Docs for page ".$element->parent->getFile());

        $this->setTargetDir($this->base_dir . PATH_DELIMITER . $this->page_dir);

        $this->addKLink($element->parent->file, $this->page_dir . PATH_DELIMITER . $this->page, '', 'Files');

    }

    function getPageName(&$element)

    {

        if (phpDocumentor_get_class($element) == 'parserpage') return '_'.$element->getName();

        return '_'.$element->parent->getName();

    }

    /**

     * returns an array containing the class inheritance tree from the root object to the class

     *

     * @param parserClass    class variable

     * @return array Format: array(root,child,child,child,...,$class)

     * @uses parserClass::getParentClassTree()

     */

    function generateFormattedClassTree($class)

    {

        $tree = $class->getParentClassTree($this);

        $out = '';

        if (count($tree) - 1)

        {

            $result = array($class->getName());

            $parent = $tree[$class->getName()];

            $distance[] = '';

            while ($parent)

            {

                $x = $parent;

                if (is_object($parent))

                {

                    $subpackage = $parent->docblock->subpackage;

                    $package = $parent->docblock->package;

                    $x = $parent;

                    $x = $parent->getLink($this);

                    if (!$x) $x = $parent->getName();

                }

                $result[] =

                    $x;

                $distance[] =

                    "\n%s|\n" .

                    "%s--";

                if (is_object($parent))

                $parent = $tree[$parent->getName()];

                elseif (isset($tree[$parent]))

                $parent = $tree[$parent];

            }

            $nbsp = '   ';

            for($i=count($result) - 1;$i>=0;$i--)

            {

                $my_nbsp = '';