mirror of
https://github.com/lxsang/antd-lua-plugin
synced 2025-07-13 05:34:25 +02:00
mimgrating from another repo
This commit is contained in:
Xuan Sang LE
349
lib/ann/fann/docs/NaturalDocs-1.52/Modules/NaturalDocs/Builder/Base.pm
Executable file
349
lib/ann/fann/docs/NaturalDocs-1.52/Modules/NaturalDocs/Builder/Base.pm
Executable file
@ -0,0 +1,349 @@
|
||||
###############################################################################
|
||||
#
|
||||
# Class: NaturalDocs::Builder::Base
|
||||
#
|
||||
###############################################################################
|
||||
#
|
||||
# A base class for all Builder output formats.
|
||||
#
|
||||
###############################################################################
|
||||
|
||||
# This file is part of Natural Docs, which is Copyright <20> 2003-2010 Greg Valure
|
||||
# Natural Docs is licensed under version 3 of the GNU Affero General Public License (AGPL)
|
||||
# Refer to License.txt for the complete details
|
||||
|
||||
use strict;
|
||||
use integer;
|
||||
|
||||
package NaturalDocs::Builder::Base;
|
||||
|
||||
|
||||
###############################################################################
|
||||
# Group: Notes
|
||||
|
||||
|
||||
#
|
||||
# Topic: Implementation
|
||||
#
|
||||
# Builder packages are implemented as blessed arrayrefs, not hashrefs. This is done for all objects in Natural Docs for
|
||||
# efficiency reasons. You create members by defining constants via <NaturalDocs::DefineMembers> and using them as
|
||||
# indexes into the array.
|
||||
#
|
||||
|
||||
#
|
||||
# Topic: Function Order
|
||||
#
|
||||
# The functions in the build process will always be called in the following order.
|
||||
#
|
||||
# - <BeginBuild()> will always be called.
|
||||
# - <PurgeFiles()> will be called next only if there's files that need to be purged.
|
||||
# - <PurgeIndexes()> will be called next only if there's indexes that need to be purged.
|
||||
# - <PurgeImages()> will e called next only if there's images that need to be purged.
|
||||
# - <BuildFile()> will be called once for each file that needs to be built, if any.
|
||||
# - <BuildIndex()> will be called once for each index that changed and is part of the menu, if any.
|
||||
# - <UpdateImage()> will be called once for each image that needs to be updated, if any.
|
||||
# - <UpdateMenu()> will be called next only if the menu changed.
|
||||
# - <EndBuild()> will always be called.
|
||||
#
|
||||
|
||||
#
|
||||
# Topic: How to Approach
|
||||
#
|
||||
# Here's an idea of how to approach making packages for different output types.
|
||||
#
|
||||
#
|
||||
# Multiple Output Files, Embedded Menu:
|
||||
#
|
||||
# This example is for when you want to build one output file per source file, each with its own copy of the menu within it.
|
||||
# This is how <NaturalDocs::Builder::HTML> works.
|
||||
#
|
||||
# Make sure you create a function that generates just the menu for a particular source file. We'll need to generate menus for
|
||||
# both building a file from scratch and for updating the menu on an existing output file, so it's better to give it its own function.
|
||||
# You may want to surround it with something that can be easily detected in the output file to make replacing easier.
|
||||
#
|
||||
# <BeginBuild()> isn't important. You don't need to implement it.
|
||||
#
|
||||
# Implement <PurgeFiles()> to delete the output files associated with the purged files.
|
||||
#
|
||||
# Implement <PurgeIndexes()> to delete the output files associated with the purged indexes.
|
||||
#
|
||||
# Implement <BuildFile()> to create an output file for the parsed source file. Use the menu function described earlier.
|
||||
#
|
||||
# Implement <BuildIndex()> to create an output file for each index. Use the menu function described earlier for each page.
|
||||
#
|
||||
# Implement <UpdateMenu()> to go through the list of unbuilt files and update their menus. You can get the list from
|
||||
# <NaturalDocs::Project->UnbuiltFilesWithContent()>. You need to open their output files, replace the menu, and save it back
|
||||
# to disk. Yes, it would be simpler from a programmer's point of view to just rebuild the file completely, but that would be
|
||||
# _very_ inefficient since there could potentially be a _lot_ of files in this group.
|
||||
#
|
||||
# Also make sure <UpdateMenu()> goes through the unchanged indexes and updates them as well.
|
||||
#
|
||||
# <EndBuild()> isn't important. You don't need to implement it.
|
||||
#
|
||||
#
|
||||
# Multiple Output Files, Menu in File:
|
||||
#
|
||||
# This example is for when you want to build one output file per source file, but keep the menu in its own separate file. This
|
||||
# is how <NaturalDocs::Builder::FramedHTML> works.
|
||||
#
|
||||
# <BeginBuild()> isn't important. You don't need to implement it.
|
||||
#
|
||||
# Implement <PurgeFiles()> to delete the output files associated with the purged files.
|
||||
#
|
||||
# Implement <PurgeIndexes()> to delete the output files associated with the purged indexes.
|
||||
#
|
||||
# Implement <BuildFile()> to generate an output file from the parsed source file.
|
||||
#
|
||||
# Implement <BuildIndex()> to generate an output file for each index.
|
||||
#
|
||||
# Implement <UpdateMenu()> to rebuild the menu file.
|
||||
#
|
||||
# <EndBuild()> isn't important. You don't need to implement it.
|
||||
#
|
||||
#
|
||||
# Single Output File using Intermediate Files:
|
||||
#
|
||||
# This example is for when you want to build one output file, such as a PDF file, but use intermediate files to handle differential
|
||||
# building. This would be much like how a compiler compiles each source file into a object file, and then a linker stitches them
|
||||
# all together into the final executable file.
|
||||
#
|
||||
# <BeginBuild()> isn't important. You don't need to implement it.
|
||||
#
|
||||
# Implement <PurgeFiles()> to delete the intermediate files associated with the purged files.
|
||||
#
|
||||
# Implement <PurgeIndexes()> to delete the intermediate files associated with the purged indexes.
|
||||
#
|
||||
# Implement <BuildFile()> to generate an intermediate file from the parsed source file.
|
||||
#
|
||||
# Implement <BuildIndex()> to generate an intermediate file for the specified index.
|
||||
#
|
||||
# Implement <UpdateMenu()> to generate the intermediate file for the menu.
|
||||
#
|
||||
# Implement <EndBuild()> so that if the project changed, it stitches the intermediate files together into the final
|
||||
# output file. Make sure you check the parameter because the function will be called when nothing changes too.
|
||||
#
|
||||
#
|
||||
# Single Output File using Direct Changes:
|
||||
#
|
||||
# This example is for when you want to build one output file, such as a PDF file, but engineering it in such a way that you don't
|
||||
# need to use intermediate files. In other words, you're able to add, delete, and modify entries directly in the output file.
|
||||
#
|
||||
# Implement <BeginBuild()> so that if the project changed, it opens the output file and does anything it needs to do
|
||||
# to get ready for editing.
|
||||
#
|
||||
# Implement <PurgeFiles()> to remove the entries associated with the purged files.
|
||||
#
|
||||
# Implement <PurgeIndexes()> to remove the entries associated with the purged indexes.
|
||||
#
|
||||
# Implement <BuildFile()> to add or replace a section of the output file with a new one generated from the parsed file.
|
||||
#
|
||||
# Implement <BuildIndex()> to add or replace an index in the output file with a new one generated from the specified index.
|
||||
#
|
||||
# Implement <EndBuild()> so that if the project changed, it saves the output file to disk.
|
||||
#
|
||||
# How you handle the menu depends on how the output file references other sections of itself. If it can do so by name, then
|
||||
# you can implement <UpdateMenu()> to update the menu section of the file and you're done. If it has to reference itself
|
||||
# by address or offset, it gets trickier. You should skip <UpdateMenu()> and instead rebuild the menu in <EndBuild()> if
|
||||
# the parameter is true. This lets you do it whenever anything changes in a file, rather than just when the menu
|
||||
# visibly changes. How you keep track of the locations and how they change is your problem.
|
||||
#
|
||||
|
||||
|
||||
###############################################################################
|
||||
#
|
||||
# Group: Required Interface Functions
|
||||
#
|
||||
# All Builder classes *must* define these functions.
|
||||
#
|
||||
|
||||
|
||||
#
|
||||
# Function: INIT
|
||||
#
|
||||
# Define this function to call <NaturalDocs::Builder->Add()> so that <NaturalDocs::Builder> knows about this package.
|
||||
# Packages are defined this way so that new ones can be added without messing around in other code.
|
||||
#
|
||||
|
||||
|
||||
#
|
||||
# Function: CommandLineOption
|
||||
#
|
||||
# Define this function to return the text that should be put in the command line after -o to use this package. It cannot have
|
||||
# spaces and is not case sensitive.
|
||||
#
|
||||
# For example, <NaturalDocs::Builder::HTML> returns 'html' so someone could use -o html [directory] to use that package.
|
||||
#
|
||||
sub CommandLineOption
|
||||
{
|
||||
NaturalDocs::Error->SoftDeath($_[0] . " didn't define CommandLineOption().");
|
||||
};
|
||||
|
||||
|
||||
#
|
||||
# Function: BuildFile
|
||||
#
|
||||
# Define this function to convert a parsed file to this package's output format. This function will be called once for every source
|
||||
# file that needs to be rebuilt. However, if a file hasn't changed since the last time Natural Docs was run, it will not be sent to
|
||||
# this function. All packages must support differential build.
|
||||
#
|
||||
# Parameters:
|
||||
#
|
||||
# sourceFile - The name of the source file.
|
||||
# parsedFile - The parsed source file, as an arrayref of <NaturalDocs::Parser::ParsedTopic> objects.
|
||||
#
|
||||
sub BuildFile #(sourceFile, parsedFile)
|
||||
{
|
||||
NaturalDocs::Error->SoftDeath($_[0] . " didn't define BuildFile().");
|
||||
};
|
||||
|
||||
|
||||
###############################################################################
|
||||
#
|
||||
# Group: Optional Interface Functions
|
||||
#
|
||||
# These functions can be implemented but packages are not required to do so.
|
||||
#
|
||||
|
||||
|
||||
#
|
||||
# Function: New
|
||||
#
|
||||
# Creates and returns a new object.
|
||||
#
|
||||
# Note that this is the only function where the first parameter will be the package name, not the object itself.
|
||||
#
|
||||
sub New
|
||||
{
|
||||
my $package = shift;
|
||||
|
||||
my $object = [ ];
|
||||
bless $object, $package;
|
||||
|
||||
return $object;
|
||||
};
|
||||
|
||||
|
||||
#
|
||||
# Function: BeginBuild
|
||||
#
|
||||
# Define this function if the package needs to do anything at the beginning of the build process. This function will be called
|
||||
# every time Natural Docs is run, even if the project hasn't changed. This allows you to manage dependencies specific
|
||||
# to the output format that may change independently from the source tree and menu. For example,
|
||||
# <NaturalDocs::Builder::HTML> needs to keep the CSS files in sync regardless of whether the source tree changed or not.
|
||||
#
|
||||
# Parameters:
|
||||
#
|
||||
# hasChanged - Whether the project has changed, such as source files or the menu file. If false, nothing else is going to be
|
||||
# called except <EndBuild()>.
|
||||
#
|
||||
sub BeginBuild #(hasChanged)
|
||||
{
|
||||
};
|
||||
|
||||
|
||||
#
|
||||
# Function: EndBuild
|
||||
#
|
||||
# Define this function if the package needs to do anything at the end of the build process. This function will be called every time
|
||||
# Natural Docs is run, even if the project hasn't changed. This allows you to manage dependencies specific to the output
|
||||
# format that may change independently from the source tree. For example, <NaturalDocs::Builder::HTML> needs to keep the
|
||||
# CSS files in sync regardless of whether the source tree changed or not.
|
||||
#
|
||||
# Parameters:
|
||||
#
|
||||
# hasChanged - Whether the project has changed, such as source files or the menu file. If false, the only other function that
|
||||
# was called was <BeginBuild()>.
|
||||
#
|
||||
sub EndBuild #(hasChanged)
|
||||
{
|
||||
};
|
||||
|
||||
|
||||
#
|
||||
# Function: BuildIndex
|
||||
#
|
||||
# Define this function to create an index for the passed topic. You can get the index from
|
||||
# <NaturalDocs::SymbolTable->Index()>.
|
||||
#
|
||||
# The reason it's not passed directly to this function is because indexes may be time-consuming to create. As such, they're
|
||||
# generated on demand because some output packages may choose not to implement them.
|
||||
#
|
||||
# Parameters:
|
||||
#
|
||||
# topic - The <TopicType> to limit the index by.
|
||||
#
|
||||
sub BuildIndex #(topic)
|
||||
{
|
||||
};
|
||||
|
||||
|
||||
#
|
||||
# Function: UpdateImage
|
||||
#
|
||||
# Define this function to add or update the passed image in the output.
|
||||
#
|
||||
# Parameters:
|
||||
#
|
||||
# file - The image <FileName>
|
||||
#
|
||||
sub UpdateImage #(file)
|
||||
{
|
||||
};
|
||||
|
||||
|
||||
#
|
||||
# Function: PurgeFiles
|
||||
#
|
||||
# Define this function to make the package remove all output related to the passed files. These files no longer have Natural Docs
|
||||
# content.
|
||||
#
|
||||
# Parameters:
|
||||
#
|
||||
# files - An existence hashref of the files to purge.
|
||||
#
|
||||
sub PurgeFiles #(files)
|
||||
{
|
||||
};
|
||||
|
||||
|
||||
#
|
||||
# Function: PurgeIndexes
|
||||
#
|
||||
# Define this function to make the package remove all output related to the passed indexes. These indexes are no longer part
|
||||
# of the menu.
|
||||
#
|
||||
# Parameters:
|
||||
#
|
||||
# indexes - An existence hashref of the <TopicTypes> of the indexes to purge.
|
||||
#
|
||||
sub PurgeIndexes #(indexes)
|
||||
{
|
||||
};
|
||||
|
||||
|
||||
#
|
||||
# Function: PurgeImages
|
||||
#
|
||||
# Define this function to make the package remove all output related to the passed image files. These files are no longer used
|
||||
# by the documentation.
|
||||
#
|
||||
# Parameters:
|
||||
#
|
||||
# files - An existence hashref of the image <FileNames> to purge.
|
||||
#
|
||||
sub PurgeImages #(files)
|
||||
{
|
||||
};
|
||||
|
||||
|
||||
#
|
||||
# Function: UpdateMenu
|
||||
#
|
||||
# Define this function to make the package update the menu. It will only be called if the menu changed.
|
||||
#
|
||||
sub UpdateMenu
|
||||
{
|
||||
};
|
||||
|
||||
|
||||
1;
|
||||
354
lib/ann/fann/docs/NaturalDocs-1.52/Modules/NaturalDocs/Builder/FramedHTML.pm
Executable file
354
lib/ann/fann/docs/NaturalDocs-1.52/Modules/NaturalDocs/Builder/FramedHTML.pm
Executable file
@ -0,0 +1,354 @@
|
||||
###############################################################################
|
||||
#
|
||||
# Package: NaturalDocs::Builder::FramedHTML
|
||||
#
|
||||
###############################################################################
|
||||
#
|
||||
# A package that generates output in HTML with frames.
|
||||
#
|
||||
# All functions are called with Package->Function() notation.
|
||||
#
|
||||
###############################################################################
|
||||
|
||||
# This file is part of Natural Docs, which is Copyright <20> 2003-2010 Greg Valure
|
||||
# Natural Docs is licensed under version 3 of the GNU Affero General Public License (AGPL)
|
||||
# Refer to License.txt for the complete details
|
||||
|
||||
|
||||
use strict;
|
||||
use integer;
|
||||
|
||||
package NaturalDocs::Builder::FramedHTML;
|
||||
|
||||
use base 'NaturalDocs::Builder::HTMLBase';
|
||||
|
||||
|
||||
###############################################################################
|
||||
# Group: Implemented Interface Functions
|
||||
|
||||
|
||||
#
|
||||
# Function: INIT
|
||||
#
|
||||
# Registers the package with <NaturalDocs::Builder>.
|
||||
#
|
||||
sub INIT
|
||||
{
|
||||
NaturalDocs::Builder->Add(__PACKAGE__);
|
||||
};
|
||||
|
||||
|
||||
#
|
||||
# Function: CommandLineOption
|
||||
#
|
||||
# Returns the option to follow -o to use this package. In this case, "html".
|
||||
#
|
||||
sub CommandLineOption
|
||||
{
|
||||
return 'FramedHTML';
|
||||
};
|
||||
|
||||
|
||||
#
|
||||
# Function: BuildFile
|
||||
#
|
||||
# Builds the output file from the parsed source file.
|
||||
#
|
||||
# Parameters:
|
||||
#
|
||||
# sourcefile - The <FileName> of the source file.
|
||||
# parsedFile - An arrayref of the source file as <NaturalDocs::Parser::ParsedTopic> objects.
|
||||
#
|
||||
sub BuildFile #(sourceFile, parsedFile)
|
||||
{
|
||||
my ($self, $sourceFile, $parsedFile) = @_;
|
||||
|
||||
my $outputFile = $self->OutputFileOf($sourceFile);
|
||||
|
||||
|
||||
# 99.99% of the time the output directory will already exist, so this will actually be more efficient. It only won't exist
|
||||
# if a new file was added in a new subdirectory and this is the first time that file was ever parsed.
|
||||
if (!open(OUTPUTFILEHANDLE, '>' . $outputFile))
|
||||
{
|
||||
NaturalDocs::File->CreatePath( NaturalDocs::File->NoFileName($outputFile) );
|
||||
|
||||
open(OUTPUTFILEHANDLE, '>' . $outputFile)
|
||||
or die "Couldn't create output file " . $outputFile . "\n";
|
||||
};
|
||||
|
||||
binmode(OUTPUTFILEHANDLE, ':encoding(UTF-8)');
|
||||
my $usePrettify = (NaturalDocs::Settings->HighlightCode() || NaturalDocs::Settings->HighlightAnonymous());
|
||||
|
||||
|
||||
print OUTPUTFILEHANDLE
|
||||
|
||||
# IE 6 doesn't like any doctype here at all. Add one (strict or transitional doesn't matter) and it makes the page slightly too
|
||||
# wide for the frame. Mozilla and Opera handle it like champs either way because they Don't Suck(tm).
|
||||
|
||||
# '<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" '
|
||||
# . '"http://www.w3.org/TR/REC-html40/loose.dtd">' . "\n\n"
|
||||
|
||||
'<html><head>'
|
||||
|
||||
. '<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">'
|
||||
|
||||
. '<title>'
|
||||
. $self->BuildTitle($sourceFile)
|
||||
. '</title>'
|
||||
|
||||
. '<link rel="stylesheet" type="text/css" href="' . $self->MakeRelativeURL($outputFile, $self->MainCSSFile(), 1) . '">'
|
||||
|
||||
. '<script language=JavaScript src="' . $self->MakeRelativeURL($outputFile, $self->MainJavaScriptFile(), 1) . '"></script>';
|
||||
|
||||
if ($usePrettify)
|
||||
{
|
||||
print OUTPUTFILEHANDLE
|
||||
'<script language=JavaScript src="' . $self->MakeRelativeURL($outputFile, $self->PrettifyJavaScriptFile(), 1) . '">'
|
||||
. '</script>';
|
||||
}
|
||||
|
||||
print OUTPUTFILEHANDLE
|
||||
'</head><body class="FramedContentPage" onLoad="NDOnLoad();' . ($usePrettify ? 'prettyPrint();' : '') . '">'
|
||||
. $self->OpeningBrowserStyles()
|
||||
|
||||
. $self->StandardComments()
|
||||
|
||||
. "\n\n\n"
|
||||
. $self->BuildContent($sourceFile, $parsedFile)
|
||||
. "\n\n\n"
|
||||
|
||||
. $self->BuildToolTips()
|
||||
|
||||
. $self->ClosingBrowserStyles()
|
||||
. '</body></html>';
|
||||
|
||||
|
||||
close(OUTPUTFILEHANDLE);
|
||||
};
|
||||
|
||||
|
||||
#
|
||||
# Function: BuildIndex
|
||||
#
|
||||
# Builds an index for the passed type.
|
||||
#
|
||||
# Parameters:
|
||||
#
|
||||
# type - The <TopicType> to limit the index to, or undef if none.
|
||||
#
|
||||
sub BuildIndex #(type)
|
||||
{
|
||||
my ($self, $type) = @_;
|
||||
|
||||
my $indexTitle = $self->IndexTitleOf($type);
|
||||
my $indexFile = $self->IndexFileOf($type);
|
||||
|
||||
my $startIndexPage =
|
||||
|
||||
'<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" '
|
||||
. '"http://www.w3.org/TR/REC-html40/loose.dtd">' . "\n\n"
|
||||
|
||||
. '<html><head>'
|
||||
|
||||
. '<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">'
|
||||
|
||||
. '<title>';
|
||||
|
||||
if (defined NaturalDocs::Menu->Title())
|
||||
{ $startIndexPage .= $self->StringToHTML(NaturalDocs::Menu->Title()) . ' - '; };
|
||||
|
||||
$startIndexPage .=
|
||||
$indexTitle
|
||||
. '</title>'
|
||||
|
||||
. '<link rel="stylesheet" type="text/css" href="' . $self->MakeRelativeURL($indexFile, $self->MainCSSFile(), 1) . '">'
|
||||
|
||||
. '<script language=JavaScript src="' . $self->MakeRelativeURL($indexFile, $self->MainJavaScriptFile(), 1) . '"></script>'
|
||||
|
||||
. '</head><body class="FramedIndexPage" onLoad="NDOnLoad()">'
|
||||
. $self->OpeningBrowserStyles()
|
||||
|
||||
. "\n\n\n"
|
||||
. $self->StandardComments()
|
||||
. "\n\n\n"
|
||||
. '<div id=Index>'
|
||||
. '<div class=IPageTitle>'
|
||||
. $indexTitle
|
||||
. '</div>';
|
||||
|
||||
|
||||
my $endIndexPage =
|
||||
|
||||
'</div><!--Index-->'
|
||||
. "\n\n\n"
|
||||
|
||||
. $self->ClosingBrowserStyles()
|
||||
|
||||
. '</body></html>';
|
||||
|
||||
my $startSearchResultsPage =
|
||||
|
||||
'<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" '
|
||||
. '"http://www.w3.org/TR/REC-html40/loose.dtd">' . "\n\n"
|
||||
|
||||
. '<html><head>'
|
||||
|
||||
. '<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">'
|
||||
|
||||
. '<link rel="stylesheet" type="text/css" href="' . $self->MakeRelativeURL($indexFile, $self->MainCSSFile(), 1) . '">'
|
||||
|
||||
. '<script language=JavaScript src="' . $self->MakeRelativeURL($indexFile, $self->MainJavaScriptFile(), 1) . '"></script>'
|
||||
. '<script language=JavaScript src="' . $self->MakeRelativeURL($indexFile, $self->SearchDataJavaScriptFile(), 1) . '">'
|
||||
. '</script>'
|
||||
|
||||
. '</head><body class="FramedSearchResultsPage" onLoad="NDOnLoad()">'
|
||||
. $self->OpeningBrowserStyles()
|
||||
|
||||
. "\n\n\n"
|
||||
. $self->StandardComments()
|
||||
. "\n\n\n"
|
||||
|
||||
. '<div id=Index>'
|
||||
. '<div class=IPageTitle>'
|
||||
. 'Search Results'
|
||||
. '</div>';
|
||||
|
||||
my $endSearchResultsPage =
|
||||
|
||||
'</div><!--Index-->'
|
||||
. "\n\n\n"
|
||||
|
||||
. $self->ClosingBrowserStyles()
|
||||
|
||||
. '</body></html>';
|
||||
|
||||
my $indexContent = NaturalDocs::SymbolTable->Index($type);
|
||||
my $pageCount = $self->BuildIndexPages($type, $indexContent, $startIndexPage, $endIndexPage,
|
||||
$startSearchResultsPage, $endSearchResultsPage);
|
||||
$self->PurgeIndexFiles($type, $indexContent, $pageCount + 1);
|
||||
};
|
||||
|
||||
|
||||
#
|
||||
# Function: UpdateMenu
|
||||
#
|
||||
# Builds the menu file. Also generates index.html.
|
||||
#
|
||||
sub UpdateMenu
|
||||
{
|
||||
my $self = shift;
|
||||
|
||||
my $outputDirectory = NaturalDocs::Settings->OutputDirectoryOf($self);
|
||||
my $outputFile = NaturalDocs::File->JoinPaths($outputDirectory, 'menu.html');
|
||||
|
||||
|
||||
open(OUTPUTFILEHANDLE, '>' . $outputFile)
|
||||
or die "Couldn't create output file " . $outputFile . "\n";
|
||||
|
||||
binmode(OUTPUTFILEHANDLE, ':encoding(UTF-8)');
|
||||
|
||||
my $title = 'Menu';
|
||||
if (defined $title)
|
||||
{ $title .= ' - ' . NaturalDocs::Menu->Title(); };
|
||||
|
||||
$title = $self->StringToHTML($title);
|
||||
|
||||
|
||||
print OUTPUTFILEHANDLE
|
||||
|
||||
'<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" '
|
||||
. '"http://www.w3.org/TR/REC-html40/loose.dtd">' . "\n\n"
|
||||
|
||||
. '<html><head>'
|
||||
|
||||
. '<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">'
|
||||
|
||||
. '<title>'
|
||||
. $title
|
||||
. '</title>'
|
||||
|
||||
. '<base target="Content">'
|
||||
|
||||
. '<link rel="stylesheet" type="text/css" href="' . $self->MakeRelativeURL($outputFile, $self->MainCSSFile(), 1) . '">'
|
||||
|
||||
. '<script language=JavaScript src="' . $self->MakeRelativeURL($outputFile, $self->MainJavaScriptFile(), 1) . '"></script>'
|
||||
. '<script language=JavaScript src="' . $self->MakeRelativeURL($outputFile, $self->SearchDataJavaScriptFile(), 1) . '">'
|
||||
. '</script>'
|
||||
|
||||
. '</head><body class="FramedMenuPage" onLoad="NDOnLoad()">'
|
||||
. $self->OpeningBrowserStyles()
|
||||
|
||||
. $self->StandardComments()
|
||||
|
||||
. "\n\n\n"
|
||||
. $self->BuildMenu(undef, undef)
|
||||
. "\n\n\n"
|
||||
. $self->BuildFooter(1)
|
||||
. "\n\n\n"
|
||||
|
||||
. $self->ClosingBrowserStyles()
|
||||
. '</body></html>';
|
||||
|
||||
|
||||
close(OUTPUTFILEHANDLE);
|
||||
|
||||
|
||||
# Update index.html
|
||||
|
||||
my $firstMenuEntry = $self->FindFirstFile();
|
||||
my $indexFile = NaturalDocs::File->JoinPaths( NaturalDocs::Settings->OutputDirectoryOf($self), 'index.html' );
|
||||
|
||||
# We have to check because it's possible that there may be no files with Natural Docs content and thus no files on the menu.
|
||||
if (defined $firstMenuEntry)
|
||||
{
|
||||
open(INDEXFILEHANDLE, '>' . $indexFile)
|
||||
or die "Couldn't create output file " . $indexFile . ".\n";
|
||||
|
||||
binmode(OUTPUTFILEHANDLE, ':encoding(UTF-8)');
|
||||
|
||||
print INDEXFILEHANDLE
|
||||
|
||||
'<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Frameset//EN" '
|
||||
. '"http://www.w3.org/TR/REC-html40/frameset.dtd">'
|
||||
|
||||
. '<html>'
|
||||
|
||||
. '<head>'
|
||||
|
||||
. '<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">'
|
||||
|
||||
. '<title>'
|
||||
. $self->StringToHTML(NaturalDocs::Menu->Title())
|
||||
. '</title>'
|
||||
|
||||
. '</head>'
|
||||
|
||||
. $self->StandardComments()
|
||||
|
||||
. '<frameset cols="185,*">'
|
||||
. '<frame name=Menu src="menu.html">'
|
||||
. '<frame name=Content src="'
|
||||
. $self->MakeRelativeURL($indexFile, $self->OutputFileOf($firstMenuEntry->Target()), 1) . '">'
|
||||
. '</frameset>'
|
||||
|
||||
. '<noframes>'
|
||||
. 'This documentation was designed for use with frames. However, you can still use it by '
|
||||
. '<a href="menu.html">starting from the menu page</a>.'
|
||||
. "<script language=JavaScript><!--\n"
|
||||
. 'location.href="menu.html";'
|
||||
. "\n// --></script>"
|
||||
. '</noframes>'
|
||||
|
||||
. '</html>';
|
||||
|
||||
close INDEXFILEHANDLE;
|
||||
}
|
||||
|
||||
elsif (-e $indexFile)
|
||||
{
|
||||
unlink($indexFile);
|
||||
};
|
||||
};
|
||||
|
||||
|
||||
1;
|
||||
414
lib/ann/fann/docs/NaturalDocs-1.52/Modules/NaturalDocs/Builder/HTML.pm
Executable file
414
lib/ann/fann/docs/NaturalDocs-1.52/Modules/NaturalDocs/Builder/HTML.pm
Executable file
@ -0,0 +1,414 @@
|
||||
###############################################################################
|
||||
#
|
||||
# Package: NaturalDocs::Builder::HTML
|
||||
#
|
||||
###############################################################################
|
||||
#
|
||||
# A package that generates output in HTML.
|
||||
#
|
||||
# All functions are called with Package->Function() notation.
|
||||
#
|
||||
###############################################################################
|
||||
|
||||
# This file is part of Natural Docs, which is Copyright <20> 2003-2010 Greg Valure
|
||||
# Natural Docs is licensed under version 3 of the GNU Affero General Public License (AGPL)
|
||||
# Refer to License.txt for the complete details
|
||||
|
||||
|
||||
use strict;
|
||||
use integer;
|
||||
|
||||
package NaturalDocs::Builder::HTML;
|
||||
|
||||
use base 'NaturalDocs::Builder::HTMLBase';
|
||||
|
||||
|
||||
###############################################################################
|
||||
# Group: Implemented Interface Functions
|
||||
|
||||
|
||||
#
|
||||
# Function: INIT
|
||||
#
|
||||
# Registers the package with <NaturalDocs::Builder>.
|
||||
#
|
||||
sub INIT
|
||||
{
|
||||
NaturalDocs::Builder->Add(__PACKAGE__);
|
||||
};
|
||||
|
||||
|
||||
#
|
||||
# Function: CommandLineOption
|
||||
#
|
||||
# Returns the option to follow -o to use this package. In this case, "html".
|
||||
#
|
||||
sub CommandLineOption
|
||||
{
|
||||
return 'HTML';
|
||||
};
|
||||
|
||||
|
||||
#
|
||||
# Function: BuildFile
|
||||
#
|
||||
# Builds the output file from the parsed source file.
|
||||
#
|
||||
# Parameters:
|
||||
#
|
||||
# sourcefile - The <FileName> of the source file.
|
||||
# parsedFile - An arrayref of the source file as <NaturalDocs::Parser::ParsedTopic> objects.
|
||||
#
|
||||
sub BuildFile #(sourceFile, parsedFile)
|
||||
{
|
||||
my ($self, $sourceFile, $parsedFile) = @_;
|
||||
|
||||
my $outputFile = $self->OutputFileOf($sourceFile);
|
||||
|
||||
|
||||
# 99.99% of the time the output directory will already exist, so this will actually be more efficient. It only won't exist
|
||||
# if a new file was added in a new subdirectory and this is the first time that file was ever parsed.
|
||||
if (!open(OUTPUTFILEHANDLE, '>' . $outputFile))
|
||||
{
|
||||
NaturalDocs::File->CreatePath( NaturalDocs::File->NoFileName($outputFile) );
|
||||
|
||||
open(OUTPUTFILEHANDLE, '>' . $outputFile)
|
||||
or die "Couldn't create output file " . $outputFile . "\n";
|
||||
};
|
||||
|
||||
binmode(OUTPUTFILEHANDLE, ':encoding(UTF-8)');
|
||||
my $usePrettify = (NaturalDocs::Settings->HighlightCode() || NaturalDocs::Settings->HighlightAnonymous());
|
||||
|
||||
|
||||
print OUTPUTFILEHANDLE
|
||||
|
||||
'<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0//EN" '
|
||||
. '"http://www.w3.org/TR/REC-html40/strict.dtd">' . "\n\n"
|
||||
|
||||
. '<html><head>'
|
||||
|
||||
. '<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">'
|
||||
|
||||
. '<title>'
|
||||
. $self->BuildTitle($sourceFile)
|
||||
. '</title>'
|
||||
|
||||
. '<link rel="stylesheet" type="text/css" href="' . $self->MakeRelativeURL($outputFile, $self->MainCSSFile(), 1) . '">'
|
||||
|
||||
. '<script language=JavaScript src="' . $self->MakeRelativeURL($outputFile, $self->MainJavaScriptFile(), 1) . '">'
|
||||
. '</script>';
|
||||
|
||||
if ($usePrettify)
|
||||
{
|
||||
print OUTPUTFILEHANDLE
|
||||
'<script language=JavaScript src="' . $self->MakeRelativeURL($outputFile, $self->PrettifyJavaScriptFile(), 1) . '">'
|
||||
. '</script>';
|
||||
}
|
||||
|
||||
print OUTPUTFILEHANDLE
|
||||
'<script language=JavaScript src="' . $self->MakeRelativeURL($outputFile, $self->SearchDataJavaScriptFile(), 1) . '">'
|
||||
. '</script>'
|
||||
|
||||
. '</head><body class="ContentPage" onLoad="NDOnLoad();' . ($usePrettify ? 'prettyPrint();' : '') . '">'
|
||||
. $self->OpeningBrowserStyles()
|
||||
|
||||
. $self->StandardComments()
|
||||
|
||||
. "\n\n\n"
|
||||
. $self->BuildContent($sourceFile, $parsedFile)
|
||||
. "\n\n\n"
|
||||
. $self->BuildFooter()
|
||||
. "\n\n\n"
|
||||
. $self->BuildMenu($sourceFile, undef)
|
||||
. "\n\n\n"
|
||||
. $self->BuildToolTips()
|
||||
. "\n\n\n"
|
||||
. '<div id=MSearchResultsWindow>'
|
||||
. '<iframe src="" frameborder=0 name=MSearchResults id=MSearchResults></iframe>'
|
||||
. '<a href="javascript:searchPanel.CloseResultsWindow()" id=MSearchResultsWindowClose>Close</a>'
|
||||
. '</div>'
|
||||
. "\n\n\n"
|
||||
|
||||
. $self->ClosingBrowserStyles()
|
||||
. '</body></html>';
|
||||
|
||||
|
||||
close(OUTPUTFILEHANDLE);
|
||||
};
|
||||
|
||||
|
||||
#
|
||||
# Function: BuildIndex
|
||||
#
|
||||
# Builds an index for the passed type.
|
||||
#
|
||||
# Parameters:
|
||||
#
|
||||
# type - The <TopicType> to limit the index to, or undef if none.
|
||||
#
|
||||
sub BuildIndex #(type)
|
||||
{
|
||||
my ($self, $type) = @_;
|
||||
|
||||
my $indexTitle = $self->IndexTitleOf($type);
|
||||
|
||||
my $startIndexPage =
|
||||
|
||||
'<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0//EN" '
|
||||
. '"http://www.w3.org/TR/REC-html40/strict.dtd">' . "\n\n"
|
||||
|
||||
. '<html><head>'
|
||||
|
||||
. '<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">'
|
||||
|
||||
. '<title>'
|
||||
. $indexTitle;
|
||||
|
||||
if (defined NaturalDocs::Menu->Title())
|
||||
{ $startIndexPage .= ' - ' . $self->StringToHTML(NaturalDocs::Menu->Title()); };
|
||||
|
||||
$startIndexPage .=
|
||||
'</title>'
|
||||
|
||||
. '<link rel="stylesheet" type="text/css" href="' . $self->MakeRelativeURL($self->IndexDirectory(),
|
||||
$self->MainCSSFile()) . '">'
|
||||
|
||||
. '<script language=JavaScript src="' . $self->MakeRelativeURL($self->IndexDirectory(),
|
||||
$self->MainJavaScriptFile()) . '"></script>'
|
||||
. '<script language=JavaScript src="' . $self->MakeRelativeURL($self->IndexDirectory(),
|
||||
$self->SearchDataJavaScriptFile()) . '">'
|
||||
. '</script>'
|
||||
|
||||
. '</head><body class="IndexPage" onLoad="NDOnLoad()">'
|
||||
. $self->OpeningBrowserStyles()
|
||||
|
||||
. $self->StandardComments()
|
||||
|
||||
. "\n\n\n"
|
||||
|
||||
. '<div id=Index>'
|
||||
. '<div class=IPageTitle>'
|
||||
. $indexTitle
|
||||
. '</div>';
|
||||
|
||||
my $endIndexPage =
|
||||
'</div><!--Index-->'
|
||||
|
||||
. "\n\n\n"
|
||||
. $self->BuildFooter()
|
||||
. "\n\n\n"
|
||||
. $self->BuildMenu(undef, $type)
|
||||
. "\n\n\n"
|
||||
. '<div id=MSearchResultsWindow>'
|
||||
. '<iframe src="" frameborder=0 name=MSearchResults id=MSearchResults></iframe>'
|
||||
. '<a href="javascript:searchPanel.CloseResultsWindow()" id=MSearchResultsWindowClose>Close</a>'
|
||||
. '</div>'
|
||||
. "\n\n\n"
|
||||
|
||||
. $self->ClosingBrowserStyles()
|
||||
. '</body></html>';
|
||||
|
||||
|
||||
my $startSearchResultsPage =
|
||||
|
||||
'<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0//EN" '
|
||||
. '"http://www.w3.org/TR/REC-html40/strict.dtd">' . "\n\n"
|
||||
|
||||
. '<html><head>'
|
||||
|
||||
. '<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">'
|
||||
|
||||
. '<link rel="stylesheet" type="text/css" href="' . $self->MakeRelativeURL($self->SearchResultsDirectory(),
|
||||
$self->MainCSSFile()) . '">'
|
||||
|
||||
. '<script language=JavaScript src="' . $self->MakeRelativeURL($self->SearchResultsDirectory(),
|
||||
$self->MainJavaScriptFile()) . '"></script>'
|
||||
|
||||
. '</head><body class="PopupSearchResultsPage" onLoad="NDOnLoad()">'
|
||||
. $self->OpeningBrowserStyles()
|
||||
|
||||
. $self->StandardComments()
|
||||
|
||||
. "\n\n\n"
|
||||
|
||||
. '<div id=Index>';
|
||||
|
||||
|
||||
my $endSearchResultsPage =
|
||||
'</div>'
|
||||
. $self->ClosingBrowserStyles()
|
||||
. '</body></html>';
|
||||
|
||||
my $indexContent = NaturalDocs::SymbolTable->Index($type);
|
||||
my $pageCount = $self->BuildIndexPages($type, $indexContent, $startIndexPage, $endIndexPage,
|
||||
$startSearchResultsPage, $endSearchResultsPage);
|
||||
$self->PurgeIndexFiles($type, $indexContent, $pageCount + 1);
|
||||
};
|
||||
|
||||
|
||||
#
|
||||
# Function: UpdateMenu
|
||||
#
|
||||
# Updates the menu in all the output files that weren't rebuilt. Also generates index.html.
|
||||
#
|
||||
sub UpdateMenu
|
||||
{
|
||||
my $self = shift;
|
||||
|
||||
|
||||
# Update the menu on unbuilt files.
|
||||
|
||||
my $filesToUpdate = NaturalDocs::Project->UnbuiltFilesWithContent();
|
||||
|
||||
foreach my $sourceFile (keys %$filesToUpdate)
|
||||
{
|
||||
$self->UpdateFile($sourceFile);
|
||||
};
|
||||
|
||||
|
||||
# Update the menu on unchanged index files.
|
||||
|
||||
my $indexes = NaturalDocs::Menu->Indexes();
|
||||
|
||||
foreach my $index (keys %$indexes)
|
||||
{
|
||||
if (!NaturalDocs::SymbolTable->IndexChanged($index))
|
||||
{
|
||||
$self->UpdateIndex($index);
|
||||
};
|
||||
};
|
||||
|
||||
|
||||
# Update index.html
|
||||
|
||||
my $firstMenuEntry = $self->FindFirstFile();
|
||||
my $indexFile = NaturalDocs::File->JoinPaths( NaturalDocs::Settings->OutputDirectoryOf($self), 'index.html' );
|
||||
|
||||
# We have to check because it's possible that there may be no files with Natural Docs content and thus no files on the menu.
|
||||
if (defined $firstMenuEntry)
|
||||
{
|
||||
open(INDEXFILEHANDLE, '>' . $indexFile)
|
||||
or die "Couldn't create output file " . $indexFile . ".\n";
|
||||
|
||||
binmode(INDEXFILEHANDLE, ':encoding(UTF-8)');
|
||||
|
||||
print INDEXFILEHANDLE
|
||||
'<html><head>'
|
||||
. '<meta http-equiv="Refresh" CONTENT="0; URL='
|
||||
. $self->MakeRelativeURL( NaturalDocs::File->JoinPaths( NaturalDocs::Settings->OutputDirectoryOf($self), 'index.html'),
|
||||
$self->OutputFileOf($firstMenuEntry->Target()), 1 ) . '">'
|
||||
. '</head></html>';
|
||||
|
||||
close INDEXFILEHANDLE;
|
||||
}
|
||||
|
||||
elsif (-e $indexFile)
|
||||
{
|
||||
unlink($indexFile);
|
||||
};
|
||||
};
|
||||
|
||||
|
||||
|
||||
###############################################################################
|
||||
# Group: Support Functions
|
||||
|
||||
|
||||
#
|
||||
# Function: UpdateFile
|
||||
#
|
||||
# Updates an output file. Replaces the menu, HTML title, and footer. It opens the output file, makes the changes, and saves it
|
||||
# back to disk, which is much quicker than rebuilding the file from scratch if these were the only things that changed.
|
||||
#
|
||||
# Parameters:
|
||||
#
|
||||
# sourceFile - The source <FileName>.
|
||||
#
|
||||
# Dependencies:
|
||||
#
|
||||
# - Requires <Builder::BuildMenu()> to surround its content with the exact strings "<div id=Menu>" and "</div><!--Menu-->".
|
||||
# - Requires <Builder::BuildFooter()> to surround its content with the exact strings "<div id=Footer>" and
|
||||
# "</div><!--Footer-->".
|
||||
#
|
||||
sub UpdateFile #(sourceFile)
|
||||
{
|
||||
my ($self, $sourceFile) = @_;
|
||||
|
||||
my $outputFile = $self->OutputFileOf($sourceFile);
|
||||
|
||||
if (open(OUTPUTFILEHANDLE, '<' . $outputFile))
|
||||
{
|
||||
my $content;
|
||||
|
||||
binmode(OUTPUTFILEHANDLE, ':encoding(UTF-8)');
|
||||
read(OUTPUTFILEHANDLE, $content, -s OUTPUTFILEHANDLE);
|
||||
close(OUTPUTFILEHANDLE);
|
||||
|
||||
|
||||
$content =~ s{<title>[^<]*<\/title>}{'<title>' . $self->BuildTitle($sourceFile) . '</title>'}e;
|
||||
|
||||
$content =~ s/<div id=Menu>.*?<\/div><!--Menu-->/$self->BuildMenu($sourceFile, undef)/es;
|
||||
|
||||
$content =~ s/<div id=Footer>.*?<\/div><!--Footer-->/$self->BuildFooter()/e;
|
||||
|
||||
|
||||
open(OUTPUTFILEHANDLE, '>' . $outputFile);
|
||||
binmode(OUTPUTFILEHANDLE, ':encoding(UTF-8)');
|
||||
print OUTPUTFILEHANDLE $content;
|
||||
close(OUTPUTFILEHANDLE);
|
||||
};
|
||||
};
|
||||
|
||||
|
||||
#
|
||||
# Function: UpdateIndex
|
||||
#
|
||||
# Updates an index's output file. Replaces the menu and footer. It opens the output file, makes the changes, and saves it
|
||||
# back to disk, which is much quicker than rebuilding the file from scratch if these were the only things that changed.
|
||||
#
|
||||
# Parameters:
|
||||
#
|
||||
# type - The index <TopicType>, or undef if none.
|
||||
#
|
||||
sub UpdateIndex #(type)
|
||||
{
|
||||
my ($self, $type) = @_;
|
||||
|
||||
my $page = 1;
|
||||
|
||||
my $outputFile = $self->IndexFileOf($type, $page);
|
||||
|
||||
my $newMenu = $self->BuildMenu(undef, $type);
|
||||
my $newFooter = $self->BuildFooter();
|
||||
|
||||
while (-e $outputFile)
|
||||
{
|
||||
open(OUTPUTFILEHANDLE, '<' . $outputFile)
|
||||
or die "Couldn't open output file " . $outputFile . ".\n";
|
||||
|
||||
my $content;
|
||||
|
||||
binmode(OUTPUTFILEHANDLE, ':encoding(UTF-8)');
|
||||
read(OUTPUTFILEHANDLE, $content, -s OUTPUTFILEHANDLE);
|
||||
close(OUTPUTFILEHANDLE);
|
||||
|
||||
|
||||
$content =~ s/<div id=Menu>.*?<\/div><!--Menu-->/$newMenu/es;
|
||||
|
||||
$content =~ s/<div id=Footer>.*<\/div><!--Footer-->/$newFooter/e;
|
||||
|
||||
|
||||
open(OUTPUTFILEHANDLE, '>' . $outputFile)
|
||||
or die "Couldn't save output file " . $outputFile . ".\n";
|
||||
|
||||
binmode(OUTPUTFILEHANDLE, ':encoding(UTF-8)');
|
||||
print OUTPUTFILEHANDLE $content;
|
||||
close(OUTPUTFILEHANDLE);
|
||||
|
||||
$page++;
|
||||
$outputFile = $self->IndexFileOf($type, $page);
|
||||
};
|
||||
};
|
||||
|
||||
|
||||
1;
|
||||
3745
lib/ann/fann/docs/NaturalDocs-1.52/Modules/NaturalDocs/Builder/HTMLBase.pm
Executable file
3745
lib/ann/fann/docs/NaturalDocs-1.52/Modules/NaturalDocs/Builder/HTMLBase.pm
Executable file
File diff suppressed because it is too large
Load Diff
Reference in New Issue
Block a user