Subversion-Projekte lars-tiefland.php_share

<?php

/**

 * HTML original framed output converter, modified to use Smarty Template.

 * This Converter takes output from the {@link Parser} and converts it to HTML-ready output for use with {@link Smarty}.

 *

 * phpDocumentor :: automatic documentation generator

 *

 * PHP versions 4 and 5

 *

 * Copyright (c) 2002-2006 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

 *

 * @package    Converters

 * @subpackage HTMLframes

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

 * @copyright  2002-2006 Gregory Beaver

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

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

 * @filesource

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

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

 * @see        parserDocBlock, parserInclude, parserPage, parserClass

 * @see        parserDefine, parserFunction, parserMethod, parserVar

 * @since      1.2

 */

/**

 * HTML output converter.

 * This Converter takes output from the {@link Parser} and converts it to HTML-ready output for use with {@link Smarty}.

 *

 * @package Converters

 * @subpackage HTMLframes

 * @see parserDocBlock, parserInclude, parserPage, parserClass, parserDefine, parserFunction, parserMethod, parserVar

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

 * @since 1.2

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

 */

class HTMLframesConverter extends Converter

{

    /**

     * This converter knows about the new root tree processing

     * In order to fix PEAR Bug #6389

     * @var boolean

     */

    var $processSpecialRoots = true;

    /**

     * Smarty Converter 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 = 'HTML';

    /** @var string */

    var $name = 'frames';

    /**

     * 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 HTMLdefaultConverter 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();

    /**

     * sets {@link $base_dir} to $targetDir

     * @see Converter()

     */

    function HTMLframesConverter(&$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('HTMLframes_outputfilter');

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

        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('HTMLframes_outputfilter');

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

        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 '<div class="src-code"><ol>' . parent::ProgramExample($example, $tutorial, $inlinesourceparse, $class, $linenum, $filesourcepath)

               .'</ol></div>';

    }

    /**

     * @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('HTMLframes_outputfilter');

        $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('HTMLframes_outputfilter');

        $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>';

    }

    function makeLeft()

    {

        foreach($this->page_elements as $package => $o1)

        {

            foreach($o1 as $subpackage => $links)

            {

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

                {

                    $left[$package][$subpackage]['files'][] =

                        array("link" => $this->getId($links[$i]), "title" => $links[$i]->name);

                }

            }

        }

        $interfaces = $classes = false;

        foreach($this->class_elements as $package => $o1)

        {

            foreach($o1 as $subpackage => $links)

            {

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

                {

                    $class = $this->classes->getClassByPackage($links[$i]->name, $links[$i]->package);

                    $isinterface = $isclass = false;

                    if ($class->isInterface()) {

                        $isinterface = true;

                        $interfaces = true;

                    } else {

                        $isclass = true;

                        $classes = true;

                    }

                    if ($class && isset($class->docblock) && $class->docblock->hasaccess) {

                        $left[$package][$subpackage]['classes'][] =

                            array("link" => $this->getId($links[$i]),

                                  "title" => $links[$i]->name,

                                  'is_interface' => $isinterface,

                                  'is_class' => $isclass,

                                  "access" => $class->docblock->tags['access'][0]->value,

                                  "abstract" => isset ($class->docblock->tags['abstract'][0]));

                    } else {

                        $left[$package][$subpackage]['classes'][] =

                            array("link" => $this->getId($links[$i]),

                                  "title" => $links[$i]->name,

                                  'is_interface' => $isinterface,

                                  'is_class' => $isclass,

                                  "access" => 'public',

                                  "abstract" => isset ($class->docblock->tags['abstract'][0]));

                    }

                }

            }

        }

        foreach($this->function_elements as $package => $o1)

        {

            foreach($o1 as $subpackage => $links)

            {

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

                {

                    $left[$package][$subpackage]['functions'][] =

                        array("link" => $this->getId($links[$i]), "title" => $links[$i]->name);

                }

            }

        }

        $ret = array();

        foreach($left as $package => $r)

        {

            $pd = 'blank';

            if (isset($this->package_pages[$package])) $pd = $package.'/package_'.$package.'.html';

            if (!isset($r['']))

            {

                $pt = false;

                $ptnoa = false;

                $ptt = $package;

                if ($t = $this->hasTutorial('pkg',$package,$package,''))

                {

                    $pt = $t->getLink($this);

                    $ptnoa = $this->getId($t->getLink($this,true));

                    $ptt = $t->getTitle($this);

                }

                $tutes = array();

                foreach($this->tutorial_tree as $root => $tr)

                {

                    if ($tr['tutorial']->package == $package && $tr['tutorial']->subpackage == '') {

                        $tutes[$tr['tutorial']->tutorial_type][] =

                            $this->getTutorialTree($tr['tutorial']);

                    }

                }

                if (isset($this->childless_tutorials[$package][$subpackage]))

                {

                    foreach($this->childless_tutorials[$package][$subpackage] as $ext => $other)

                    {

                        foreach($other as $tutorial)

                        {

                            $tutes[$tutorial->tutorial_type][] = $this->getTutorialTree($tutorial);

                        }

                    }

                }

                $ret[$package][] =

                    array(

                        'package' => $package,

                        'subpackage' => '',

                        'packagedoc' => $pd,

                        'packagetutorial' => $pt,

                        'packagetutorialnoa' => $ptnoa,

                        'packagetutorialtitle' => $ptt,

                        'files' => array(),

                        'functions' => array(),

                        'classes' => array(),

                        'tutorials' => $tutes,

                        );

            }

            foreach($r as $subpackage => $info)

            {

                $my = array();

                $my['package'] = $package;

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

                $my['packagedoc'] = $pd;

                else

                $my['packagedoc'] = 'blank';

                $my['subpackage'] = $subpackage;

                if (empty($subpackage))

                {

                    if ($t = $this->hasTutorial('pkg',$package,$package,$subpackage))

                    {

                        $my['packagetutorial'] = $t->getLink($this);

                        $my['packagetutorialnoa'] = $this->getId($t->getLink($this,true));

                        $my['packagetutorialtitle'] = $t->getTitle($this);

                    } else

                    {

                        $my['packagetutorial'] = '<a href="blank.html">No Package-Level Tutorial</a>';

                        $my['packagetutorialnoa'] = 'blank.html';

                        $my['packagetutorialtitle'] = $package;

                    }

                } else

                {

                    if ($t = $this->hasTutorial('pkg',$subpackage,$package,$subpackage))

                    {

                        $my['subpackagetutorial'] = $this->returnSee($this->getTutorialLink($t));

                        $my['subpackagetutorialnoa'] = $this->getId($t->getLink($this,true));

                        $my['subpackagetutorialtitle'] = $t->getTitle($this);

                    } else

                    {

                        $my['subpackagetutorial'] = false;

                        $my['subpackagetutorialnoa'] = false;

                        $my['subpackagetutorialtitle'] = $subpackage;

                    }

                }

                $tutes = array();

                foreach($this->tutorial_tree as $root => $tr)

                {

                    if ($tr['tutorial']->package == $package && $tr['tutorial']->subpackage == $subpackage)

                    {

                        $tutes[$tr['tutorial']->tutorial_type][] = $this->getTutorialTree($tr['tutorial']);

                    }

                }

                $my['tutorials'] = $tutes;

                $my['files'] = $my['classes'] = $my['functions'] = array();

                if (isset($info['files']))

                $my['files'] = $info['files'];

                if (isset($info['classes']))

                $my['classes'] = $info['classes'];

                $my['hasclasses'] = $classes;

                $my['hasinterfaces'] = $interfaces;

                if (isset($info['functions']))

                $my['functions'] = $info['functions'];

                $ret[$package][] = $my;

            }

        }

        return $ret;

    }

    function getTutorialTree($tutorial,$k = false)

    {

        $ret = '';

        if (is_object($tutorial)) $tree = parent::getTutorialTree($tutorial); else $tree = $tutorial;

//        debug($this->vardump_tree($tree));exit;

        if (!$tree)

        {

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

            $template->assign('subtree',false);

            $template->assign('name',str_replace('.','',$tutorial->name));

            $template->assign('parent',false);

            $template->assign('haskids',false);

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

            $link = new tutorialLink;

            $t = $tutorial;

            $link->addLink('',$t->path,$t->name,$t->package,$t->subpackage,$t->getTitle($this));

            $main = array('link' => $this->getId($link), 'title' => $link->title);

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

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

        }

        if (isset($tree['kids']))

        {

            foreach($tree['kids'] as $subtree)

            {

                $ret .= $this->getTutorialTree($subtree, true);

            }

        }

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

        $template->assign('subtree',$k);

        $template->assign('name',str_replace('.','',$tree['tutorial']->name));

        $template->assign('parent',($k ? str_replace('.','',$tree['tutorial']->parent->name) : false));

        $template->assign('haskids',strlen($ret));

        $template->assign('kids',$ret);

        $link = new tutorialLink;

        $t = $tree['tutorial'];

        $link->addLink('',$t->path,$t->name,$t->package,$t->subpackage,$t->getTitle($this));

        $main = array('link' => $this->getId($link), 'title' => $link->title);

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

        $ret = $template->fetch('tutorial_tree.tpl');

				return $ret;

    }

    /**

     * HTMLdefaultConverter 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->register_outputfilter('HTMLframes_outputfilter');

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

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

        }

        phpDocumentor_out("\n");

        flush();

        }

    /**

     * HTMLdefaultConverter 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->register_outputfilter('HTMLframes_outputfilter');

        phpDocumentor_out("\n");

        flush();

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

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

        usort($this->package_index,"HTMLframes_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);

            }

        }

        // Created index.html

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

        $this->package = $start;

        $this->subpackage = '';

        $index->assign("package_count",count($this->pkg_elements));

        if (count($this->ric_set))

        $index->assign("package_count",2);

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

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

        $index->assign("start","li_$start.html");

        $index->register_outputfilter('HTMLframes_outputfilter');

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

        {

            $index->assign("blank",$start.'/tutorial_'.$start.'.pkg');

        } elseif (isset($this->package_pages[$start]))

        {

            $index->assign("blank",$start.'/package_'.$start);

        }

        else

        {

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

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

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

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

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

        }

        phpDocumentor_out("\n");

        flush();

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

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

        // Create package index

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

        $package->assign('ric',array());

        if (isset($this->ric_set))

        {

            foreach($this->ric_set as $name => $u)

            {

                $package->append('ric',array('file' => 'ric_'.$name.'.html','name' => $name));

            }

        }

        $package->assign("packages",$this->package_index);

        $package->register_outputfilter('HTMLframes_outputfilter');

        $this->writefile("packages.html",$package->fetch('top_frame.tpl'));

        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('HTMLframes_outputfilter');

        phpDocumentor_out("\n");

        flush();

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

        $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();

        }

        $x = $this->makeLeft();

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

        {

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

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

            $template->assign("info",$x[$package]);

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

            $template->assign("hastutorials",isset($this->tutorials[$package]));

            $template->assign('hastodos',count($this->todoList));

            $template->assign('todolink','todolist.html');

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

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

            $template->register_outputfilter('HTMLframes_outputfilter');

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

            {

                $template->assign("packagedoc",$package.'/package_' . $package . '.html');

            } else

            {

                $template->assign("packagedoc",false);

            }

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

            // Create class tree page

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

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

            $template->assign("interfaces",$this->generateFormattedInterfaceTrees($package));

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

            $template->register_outputfilter('HTMLframes_outputfilter');

            $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 (!is_object($element) || !$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;

        }

    }

    /**

     * 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->writefile('ric_'.$name . '.html',$template->fetch('ric.tpl'));

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

    }

    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('HTMLframes_outputfilter');

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

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

    }

    /**

     * 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 getTutorialId($package,$subpackage,$tutorial,$id)

    {

        return $id;

    }

    function getCData($value)

    {

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

    }

    /**

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

     * @param parserPackagePage

     */

    function convertPackagepage(&$element)

    {