An error occurred while loading the file. Please try again.
-
DanmeiChen authored3d17d280
/******************************************************************************** Copyright (C) 2016 The Qt Company Ltd.** Contact: https://www.qt.io/licensing/**** This file is part of the tools applications of the Qt Toolkit.**** $QT_BEGIN_LICENSE:GPL-EXCEPT$** Commercial License Usage** Licensees holding valid commercial Qt licenses may use this file in** accordance with the commercial license agreement provided with the** Software or, alternatively, in accordance with the terms contained in** a written agreement between you and The Qt Company. For licensing terms** and conditions see https://www.qt.io/terms-conditions. For further** information use the contact form at https://www.qt.io/contact-us.**** GNU General Public License Usage** Alternatively, this file may be used under the terms of the GNU** General Public License version 3 as published by the Free Software** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT** included in the packaging of this file. Please review the following** information to ensure the GNU General Public License requirements will** be met: https://www.gnu.org/licenses/gpl-3.0.html.**** $QT_END_LICENSE$******************************************************************************/// There must be no #include before this !#define setlocale locale_file_name_for_clang_qdoc() { \ static char data[] = __FILE__; \ return data; \ } \ extern char *setlocale#include <locale.h>#undef setlocale#include <qglobal.h>#include <qhashfunctions.h>#include <stdlib.h>#include "codemarker.h"#include "codeparser.h"#include "config.h"#include "cppcodemarker.h"#include "cppcodeparser.h"#include "doc.h"#include "htmlgenerator.h"#include "location.h"#include "plaincodemarker.h"#include "puredocparser.h"#include "tokenizer.h"#include "tree.h"#include "qdocdatabase.h"#include "jscodemarker.h"#include "qmlcodemarker.h"#include "qmlcodeparser.h"#include "clangcodeparser.h"#include <qdatetime.h>#include <qdebug.h>#include "qtranslator.h"#ifndef QT_BOOTSTRAPPED# include "qcoreapplication.h"#endif#include "qcommandlineoption.h"#include "qcommandlineparser.h"#include <algorithm>QT_BEGIN_NAMESPACE7172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140
bool creationTimeBefore(const QFileInfo &fi1, const QFileInfo &fi2)
{
return fi1.lastModified() < fi2.lastModified();
}
static bool highlighting = false;
static bool showInternal = false;
static bool singleExec = false;
static bool writeQaPages = false;
static bool redirectDocumentationToDevNull = false;
static bool noLinkErrors = false;
static bool autolinkErrors = false;
static bool obsoleteLinks = false;
static QStringList defines;
static QStringList includesPaths;
static QStringList dependModules;
static QStringList indexDirs;
static QString currentDir;
static QString prevCurrentDir;
static QHash<QString,QString> defaults;
#ifndef QT_NO_TRANSLATION
typedef QPair<QString, QTranslator*> Translator;
static QList<Translator> translators;
#endif
/*!
Read some XML indexes containing definitions from other
documentation sets. \a config contains a variable that
lists directories where index files can bge found. It also
contains the \c depends variable, which lists the modules
that the current module depends on.
*/
static void loadIndexFiles(Config& config)
{
QDocDatabase* qdb = QDocDatabase::qdocDB();
QStringList indexFiles;
QStringList configIndexes = config.getStringList(CONFIG_INDEXES);
foreach (const QString &index, configIndexes) {
QFileInfo fi(index);
if (fi.exists() && fi.isFile())
indexFiles << index;
else
Location::null.warning(QString("Index file not found: %1").arg(index));
}
dependModules += config.getStringList(CONFIG_DEPENDS);
dependModules.removeDuplicates();
bool noOutputSubdirs = false;
QString singleOutputSubdir;
if (config.getBool(QString("HTML.nosubdirs"))) {
noOutputSubdirs = true;
singleOutputSubdir = config.getString("HTML.outputsubdir");
if (singleOutputSubdir.isEmpty())
singleOutputSubdir = "html";
}
if (dependModules.size() > 0) {
if (indexDirs.size() > 0) {
for (int i = 0; i < indexDirs.size(); i++) {
if (indexDirs[i].startsWith("..")) {
const QString prefix(QDir(currentDir).relativeFilePath(prevCurrentDir));
if (!prefix.isEmpty())
indexDirs[i].prepend(prefix + QLatin1Char('/'));
}
}
/*
Add all subdirectories of the indexdirs as dependModules,
when an asterisk is used in the 'depends' list.
*/
141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210
if (dependModules.contains("*")) {
dependModules.removeOne("*");
for (int i = 0; i < indexDirs.size(); i++) {
QDir scanDir = QDir(indexDirs[i]);
scanDir.setFilter(QDir::Dirs | QDir::NoDotAndDotDot);
QFileInfoList dirList = scanDir.entryInfoList();
for (int j = 0; j < dirList.size(); j++) {
if (dirList[j].fileName().toLower() != config.getString(CONFIG_PROJECT).toLower())
dependModules.append(dirList[j].fileName());
}
}
}
for (int i = 0; i < dependModules.size(); i++) {
QString indexToAdd;
QList<QFileInfo> foundIndices;
for (int j = 0; j < indexDirs.size(); j++) {
QString fileToLookFor = indexDirs[j] + QLatin1Char('/');
if (noOutputSubdirs)
fileToLookFor += singleOutputSubdir;
else
fileToLookFor += dependModules[i];
fileToLookFor += QLatin1Char('/') + dependModules[i] + QLatin1String(".index");
if (QFile::exists(fileToLookFor)) {
QFileInfo tempFileInfo(fileToLookFor);
if (!foundIndices.contains(tempFileInfo))
foundIndices.append(tempFileInfo);
}
}
std::sort(foundIndices.begin(), foundIndices.end(), creationTimeBefore);
if (foundIndices.size() > 1) {
/*
QDoc should always use the last entry in the multimap when there are
multiple index files for a module, since the last modified file has the
highest UNIX timestamp.
*/
QStringList indexPaths;
for (int k = 0; k < foundIndices.size(); k++)
indexPaths << foundIndices[k].absoluteFilePath();
Location::null.warning(QString("Multiple index files found for dependency \"%1\":\n%2").arg(
dependModules[i], indexPaths.join('\n')));
Location::null.warning(QString("Using %1 as index file for dependency \"%2\"").arg(
foundIndices[foundIndices.size() - 1].absoluteFilePath(),
dependModules[i]));
indexToAdd = foundIndices[foundIndices.size() - 1].absoluteFilePath();
}
else if (foundIndices.size() == 1) {
indexToAdd = foundIndices[0].absoluteFilePath();
}
if (!indexToAdd.isEmpty()) {
if (!indexFiles.contains(indexToAdd))
indexFiles << indexToAdd;
}
else {
Location::null.warning(QString("\"%1\" Cannot locate index file for dependency \"%2\"").arg(
config.getString(CONFIG_PROJECT), dependModules[i]));
}
}
}
else {
Location::null.warning(QLatin1String("Dependent modules specified, but no index directories were set. There will probably be errors for missing links."));
}
}
qdb->readIndexes(indexFiles);
}
/*!
Processes the qdoc config file \a fileName. This is the
controller for all of qdoc.
*/
static void processQdocconfFile(const QString &fileName)
211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280
{
/*
The Config instance represents the configuration data for qdoc.
All the other classes are initialized with the config. Below, we
initialize the configuration with some default values.
I don't think the call to translate() does anything here. For one
thing, the translators haven't been installed at this point. And
I doubt any translator would translate QDoc anyway. But I left it
here because it does no harm.
*/
Config config(QCoreApplication::translate("QDoc", "qdoc"));
QHash<QString,QString>::iterator iter;
for (iter = defaults.begin(); iter != defaults.end(); ++iter)
config.setStringList(iter.key(), QStringList() << iter.value());
config.setStringList(CONFIG_SYNTAXHIGHLIGHTING, QStringList(highlighting ? "true" : "false"));
config.setStringList(CONFIG_SHOWINTERNAL, QStringList(showInternal ? "true" : "false"));
config.setStringList(CONFIG_SINGLEEXEC, QStringList(singleExec ? "true" : "false"));
config.setStringList(CONFIG_WRITEQAPAGES, QStringList(writeQaPages ? "true" : "false"));
config.setStringList(CONFIG_REDIRECTDOCUMENTATIONTODEVNULL, QStringList(redirectDocumentationToDevNull ? "true" : "false"));
config.setStringList(CONFIG_NOLINKERRORS, QStringList(noLinkErrors ? "true" : "false"));
config.setStringList(CONFIG_AUTOLINKERRORS, QStringList(autolinkErrors ? "true" : "false"));
config.setStringList(CONFIG_OBSOLETELINKS, QStringList(obsoleteLinks ? "true" : "false"));
prevCurrentDir = QDir::currentPath();
/*
With the default configuration values in place, load
the qdoc configuration file. Note that the configuration
file may include other configuration files.
The Location class keeps track of the current location
in the file being processed, mainly for error reporting
purposes.
*/
Location::initialize(config);
config.load(fileName);
QString project = config.getString(CONFIG_PROJECT);
//qDebug() << "Start project:" << project;
/*
Add the defines to the configuration variables.
*/
QStringList defs = defines + config.getStringList(CONFIG_DEFINES);
config.setStringList(CONFIG_DEFINES,defs);
QStringList incs = includesPaths + config.getStringList(CONFIG_INCLUDEPATHS);
config.setStringList(CONFIG_INCLUDEPATHS, incs);
Location::terminate();
currentDir = QFileInfo(fileName).path();
if (!currentDir.isEmpty())
QDir::setCurrent(currentDir);
QString phase = " in -";
if (Generator::singleExec())
phase += "single exec mode, ";
else
phase += "separate exec mode, ";
if (Generator::preparing())
phase += "prepare phase ";
else if (Generator::generating())
phase += "generate phase ";
QString msg = "Running qdoc for " + config.getString(CONFIG_PROJECT) + phase;
Location::logToStdErr(msg);
/*
Initialize all the classes and data structures with the
qdoc configuration. This is safe to do for each qdocconf
file processed, because all the data structures created
281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350
are either cleared after they have been used, or they
are cleared in the terminate() functions below.
*/
Location::initialize(config);
Tokenizer::initialize(config);
Doc::initialize(config);
CodeMarker::initialize(config);
CodeParser::initialize(config);
Generator::initialize(config);
#ifndef QT_NO_TRANSLATION
/*
Load the language translators, if the configuration specifies any,
but only if they haven't already been loaded. This works in both
-prepare/-generate mode and -singleexec mode.
*/
QStringList fileNames = config.getStringList(CONFIG_TRANSLATORS);
QStringList::ConstIterator fn = fileNames.constBegin();
while (fn != fileNames.constEnd()) {
bool found = false;
if (!translators.isEmpty()) {
for (int i=0; i<translators.size(); ++i) {
if (translators.at(i).first == *fn) {
found = true;
break;
}
}
}
if (!found) {
QTranslator *translator = new QTranslator(0);
if (!translator->load(*fn)) {
config.lastLocation().error(QCoreApplication::translate("QDoc", "Cannot load translator '%1'").arg(*fn));
}
else {
QCoreApplication::instance()->installTranslator(translator);
translators.append(Translator(*fn, translator));
}
}
++fn;
}
#endif
//QSet<QString> outputLanguages = config.getStringSet(CONFIG_OUTPUTLANGUAGES);
/*
Get the source language (Cpp) from the configuration
and the location in the configuration file where the
source language was set.
*/
QString lang = config.getString(CONFIG_LANGUAGE);
Location langLocation = config.lastLocation();
/*
Initialize the qdoc database, where all the parsed source files
will be stored. The database includes a tree of nodes, which gets
built as the source files are parsed. The documentation output is
generated by traversing that tree.
Note: qdocDB() allocates a new instance only if no instance exists.
So it is safe to call qdocDB() any time.
*/
QDocDatabase* qdb = QDocDatabase::qdocDB();
qdb->setVersion(config.getString(CONFIG_VERSION));
qdb->setShowInternal(config.getBool(CONFIG_SHOWINTERNAL));
qdb->setSingleExec(config.getBool(CONFIG_SINGLEEXEC));
/*
By default, the only output format is HTML.
*/
QSet<QString> outputFormats = config.getOutputFormats();
Location outputFormatsLocation = config.lastLocation();
351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420
qdb->clearSearchOrder();
if (!Generator::singleExec()) {
if (!Generator::preparing()) {
Generator::debug(" loading index files");
loadIndexFiles(config);
Generator::debug(" done loading index files");
}
qdb->newPrimaryTree(project);
}
else if (Generator::preparing())
qdb->newPrimaryTree(project);
else
qdb->setPrimaryTree(project);
dependModules = config.getStringList(CONFIG_DEPENDS);
dependModules.removeDuplicates();
qdb->setSearchOrder(dependModules);
// Store the title of the index (landing) page
NamespaceNode* root = qdb->primaryTreeRoot();
if (root)
root->tree()->setIndexTitle(config.getString(CONFIG_NAVIGATION
+ Config::dot
+ CONFIG_LANDINGPAGE));
QSet<QString> excludedDirs = QSet<QString>::fromList(config.getCanonicalPathList(CONFIG_EXCLUDEDIRS));
QSet<QString> excludedFiles = QSet<QString>::fromList(config.getCanonicalPathList(CONFIG_EXCLUDEFILES));
Generator::debug("Adding doc/image dirs found in exampledirs to imagedirs");
QSet<QString> exampleImageDirs;
QStringList exampleImageList = config.getExampleImageFiles(excludedDirs, excludedFiles);
for (int i = 0; i < exampleImageList.size(); ++i) {
if (exampleImageList[i].contains("doc/images")) {
QString t = exampleImageList[i].left(exampleImageList[i].lastIndexOf("doc/images") + 10);
if (!exampleImageDirs.contains(t)) {
exampleImageDirs.insert(t);
}
}
}
Generator::augmentImageDirs(exampleImageDirs);
if (!Generator::singleExec() || !Generator::generating()) {
QStringList headerList;
QStringList sourceList;
Generator::debug("Reading headerdirs");
headerList = config.getAllFiles(CONFIG_HEADERS,CONFIG_HEADERDIRS,excludedDirs,excludedFiles);
QMap<QString,QString> headers;
QMultiMap<QString,QString> headerFileNames;
for (int i=0; i<headerList.size(); ++i) {
if (headerList[i].contains(QString("doc/snippets")))
continue;
if (headers.contains(headerList[i]))
continue;
headers.insert(headerList[i],headerList[i]);
QString t = headerList[i].mid(headerList[i].lastIndexOf('/')+1);
headerFileNames.insert(t,t);
}
Generator::debug("Reading sourcedirs");
sourceList = config.getAllFiles(CONFIG_SOURCES,CONFIG_SOURCEDIRS,excludedDirs,excludedFiles);
QMap<QString,QString> sources;
QMultiMap<QString,QString> sourceFileNames;
for (int i=0; i<sourceList.size(); ++i) {
if (sourceList[i].contains(QString("doc/snippets")))
continue;
if (sources.contains(sourceList[i]))
continue;
sources.insert(sourceList[i],sourceList[i]);
421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490
QString t = sourceList[i].mid(sourceList[i].lastIndexOf('/')+1);
sourceFileNames.insert(t,t);
}
/*
Find all the qdoc files in the example dirs, and add
them to the source files to be parsed.
*/
Generator::debug("Reading exampledirs");
QStringList exampleQdocList = config.getExampleQdocFiles(excludedDirs, excludedFiles);
for (int i=0; i<exampleQdocList.size(); ++i) {
if (!sources.contains(exampleQdocList[i])) {
sources.insert(exampleQdocList[i],exampleQdocList[i]);
QString t = exampleQdocList[i].mid(exampleQdocList[i].lastIndexOf('/')+1);
sourceFileNames.insert(t,t);
}
}
/*
Parse each header file in the set using the appropriate parser and add it
to the big tree.
*/
Generator::debug("Parsing header files");
int parsed = 0;
QMap<QString,QString>::ConstIterator h = headers.constBegin();
while (h != headers.constEnd()) {
CodeParser *codeParser = CodeParser::parserForHeaderFile(h.key());
if (codeParser) {
++parsed;
Generator::debug(QString("Parsing " + h.key()));
codeParser->parseHeaderFile(config.location(), h.key());
}
++h;
}
qdb->resolveInheritance();
/*
Parse each source text file in the set using the appropriate parser and
add it to the big tree.
*/
parsed = 0;
Generator::debug("Parsing source files");
QMap<QString,QString>::ConstIterator s = sources.constBegin();
while (s != sources.constEnd()) {
CodeParser *codeParser = CodeParser::parserForSourceFile(s.key());
if (codeParser) {
++parsed;
Generator::debug(QString("Parsing " + s.key()));
codeParser->parseSourceFile(config.location(), s.key());
}
++s;
}
Generator::debug(QString("Parsing done."));
/*
Now the primary tree has been built from all the header and
source files. Resolve all the class names, function names,
targets, URLs, links, and other stuff that needs resolving.
*/
Generator::debug("Resolving stuff prior to generating docs");
qdb->resolveIssues();
}
else {
qdb->resolveStuff();
}
/*
The primary tree is built and all the stuff that needed
resolving has been resolved. Now traverse the tree and
generate the documentation output. More than one output
491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560
format can be requested. The tree is traversed for each
one.
*/
Generator::debug("Generating docs");
QSet<QString>::ConstIterator of = outputFormats.constBegin();
while (of != outputFormats.constEnd()) {
Generator* generator = Generator::generatorForFormat(*of);
if (generator == 0)
outputFormatsLocation.fatal(QCoreApplication::translate("QDoc",
"Unknown output format '%1'").arg(*of));
generator->generateDocs();
++of;
}
#if 0
if (Generator::generating() && Generator::writeQaPages())
qdb->printLinkCounts(project);
#endif
qdb->clearLinkCounts();
Generator::debug("Terminating qdoc classes");
if (Generator::debugging())
Generator::stopDebugging(project);
QDocDatabase::qdocDB()->setVersion(QString());
Generator::terminate();
CodeParser::terminate();
CodeMarker::terminate();
Doc::terminate();
Tokenizer::terminate();
Location::terminate();
QDir::setCurrent(prevCurrentDir);
Generator::debug("qdoc classes terminated");
}
class QDocCommandLineParser : public QCommandLineParser
{
public:
QDocCommandLineParser();
void process(const QCoreApplication &app);
private:
QCommandLineOption defineOption, dependsOption, highlightingOption;
QCommandLineOption showInternalOption, redirectDocumentationToDevNullOption;
QCommandLineOption noExamplesOption, indexDirOption, installDirOption;
QCommandLineOption obsoleteLinksOption, outputDirOption, outputFormatOption;
QCommandLineOption noLinkErrorsOption, autoLinkErrorsOption, debugOption;
QCommandLineOption prepareOption, generateOption, logProgressOption;
QCommandLineOption singleExecOption, writeQaPagesOption;
QCommandLineOption includePathOption, includePathSystemOption, frameworkOption;
};
QDocCommandLineParser::QDocCommandLineParser()
: QCommandLineParser(),
defineOption(QStringList() << QStringLiteral("D")),
dependsOption(QStringList() << QStringLiteral("depends")),
highlightingOption(QStringList() << QStringLiteral("highlighting")),
showInternalOption(QStringList() << QStringLiteral("showinternal")),
redirectDocumentationToDevNullOption(QStringList() << QStringLiteral("redirect-documentation-to-dev-null")),
noExamplesOption(QStringList() << QStringLiteral("no-examples")),
indexDirOption(QStringList() << QStringLiteral("indexdir")),
installDirOption(QStringList() << QStringLiteral("installdir")),
obsoleteLinksOption(QStringList() << QStringLiteral("obsoletelinks")),
outputDirOption(QStringList() << QStringLiteral("outputdir")),
outputFormatOption(QStringList() << QStringLiteral("outputformat")),
noLinkErrorsOption(QStringList() << QStringLiteral("no-link-errors")),
autoLinkErrorsOption(QStringList() << QStringLiteral("autolink-errors")),
debugOption(QStringList() << QStringLiteral("debug")),
prepareOption(QStringList() << QStringLiteral("prepare")),
generateOption(QStringList() << QStringLiteral("generate")),
561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630
logProgressOption(QStringList() << QStringLiteral("log-progress")),
singleExecOption(QStringList() << QStringLiteral("single-exec")),
writeQaPagesOption(QStringList() << QStringLiteral("write-qa-pages")),
includePathOption("I", "Add dir to the include path for header files.", "path"),
includePathSystemOption("isystem", "Add dir to the system include path for header files.", "path"),
frameworkOption("F", "Add macOS framework to the include path for header files.", "framework")
{
setApplicationDescription(QCoreApplication::translate("qdoc", "Qt documentation generator"));
addHelpOption();
addVersionOption();
setSingleDashWordOptionMode(QCommandLineParser::ParseAsLongOptions);
addPositionalArgument("file1.qdocconf ...", QCoreApplication::translate("qdoc", "Input files"));
defineOption.setDescription(QCoreApplication::translate("qdoc", "Define the argument as a macro while parsing sources"));
defineOption.setValueName(QStringLiteral("macro[=def]"));
addOption(defineOption);
dependsOption.setDescription(QCoreApplication::translate("qdoc", "Specify dependent modules"));
dependsOption.setValueName(QStringLiteral("module"));
addOption(dependsOption);
highlightingOption.setDescription(QCoreApplication::translate("qdoc", "Turn on syntax highlighting (makes qdoc run slower)"));
addOption(highlightingOption);
showInternalOption.setDescription(QCoreApplication::translate("qdoc", "Include content marked internal"));
addOption(showInternalOption);
redirectDocumentationToDevNullOption.setDescription(QCoreApplication::translate("qdoc", "Save all documentation content to /dev/null. Useful if someone is interested in qdoc errors only."));
addOption(redirectDocumentationToDevNullOption);
noExamplesOption.setDescription(QCoreApplication::translate("qdoc", "Do not generate documentation for examples"));
addOption(noExamplesOption);
indexDirOption.setDescription(QCoreApplication::translate("qdoc", "Specify a directory where QDoc should search for index files to load"));
indexDirOption.setValueName(QStringLiteral("dir"));
addOption(indexDirOption);
installDirOption.setDescription(QCoreApplication::translate("qdoc", "Specify the directory where the output will be after running \"make install\""));
installDirOption.setValueName(QStringLiteral("dir"));
addOption(installDirOption);
obsoleteLinksOption.setDescription(QCoreApplication::translate("qdoc", "Report links from obsolete items to non-obsolete items"));
addOption(obsoleteLinksOption);
outputDirOption.setDescription(QCoreApplication::translate("qdoc", "Specify output directory, overrides setting in qdocconf file"));
outputDirOption.setValueName(QStringLiteral("dir"));
addOption(outputDirOption);
outputFormatOption.setDescription(QCoreApplication::translate("qdoc", "Specify output format, overrides setting in qdocconf file"));
outputFormatOption.setValueName(QStringLiteral("format"));
addOption(outputFormatOption);
noLinkErrorsOption.setDescription(QCoreApplication::translate("qdoc", "Do not print link errors (i.e. missing targets)"));
addOption(noLinkErrorsOption);
autoLinkErrorsOption.setDescription(QCoreApplication::translate("qdoc", "Show errors when automatic linking fails"));
addOption(autoLinkErrorsOption);
debugOption.setDescription(QCoreApplication::translate("qdoc", "Enable debug output"));
addOption(debugOption);
prepareOption.setDescription(QCoreApplication::translate("qdoc", "Run qdoc only to generate an index file, not the docs"));
addOption(prepareOption);
generateOption.setDescription(QCoreApplication::translate("qdoc", "Run qdoc to read the index files and generate the docs"));
addOption(generateOption);
logProgressOption.setDescription(QCoreApplication::translate("qdoc", "Log progress on stderr."));
631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700
addOption(logProgressOption);
singleExecOption.setDescription(QCoreApplication::translate("qdoc", "Run qdoc once over all the qdoc conf files."));
addOption(singleExecOption);
writeQaPagesOption.setDescription(QCoreApplication::translate("qdoc", "Write QA pages."));
addOption(writeQaPagesOption);
includePathOption.setFlags(QCommandLineOption::ShortOptionStyle);
addOption(includePathOption);
addOption(includePathSystemOption);
frameworkOption.setFlags(QCommandLineOption::ShortOptionStyle);
addOption(frameworkOption);
}
/*!
Return the system include directory used when compiling this file.
*/
static QByteArray getSystemIncludePath()
{
const char *raw = locale_file_name_for_clang_qdoc();
const char *slash = strrchr(raw, '/');
if (slash == NULL)
slash = strrchr(raw, '\\');
if (slash == NULL)
return QByteArray();
return QByteArray(raw, slash - raw);
}
void QDocCommandLineParser::process(const QCoreApplication &app)
{
QCommandLineParser::process(app);
defines += values(defineOption);
dependModules += values(dependsOption);
highlighting = isSet(highlightingOption);
showInternal = isSet(showInternalOption);
singleExec = isSet(singleExecOption);
writeQaPages = isSet(writeQaPagesOption);
redirectDocumentationToDevNull = isSet(redirectDocumentationToDevNullOption);
Config::generateExamples = !isSet(noExamplesOption);
foreach (const QString &indexDir, values(indexDirOption)) {
if (QFile::exists(indexDir))
indexDirs += indexDir;
else
qDebug() << "Cannot find index directory" << indexDir;
}
if (isSet(installDirOption))
Config::installDir = value(installDirOption);
obsoleteLinks = isSet(obsoleteLinksOption);
if (isSet(outputDirOption))
Config::overrideOutputDir = value(outputDirOption);
foreach (const QString &format, values(outputFormatOption))
Config::overrideOutputFormats.insert(format);
noLinkErrors = isSet(noLinkErrorsOption);
autolinkErrors = isSet(autoLinkErrorsOption);
if (isSet(debugOption))
Generator::startDebugging(QString("command line"));
if (isSet(prepareOption))
Generator::setQDocPass(Generator::Prepare);
if (isSet(generateOption))
Generator::setQDocPass(Generator::Generate);
if (isSet(singleExecOption)) {
Generator::setSingleExec();
if (isSet(indexDirOption))
qDebug() << "WARNING: -indexdir option ignored: Index files are not used in -single-exec mode.";
}
if (isSet(writeQaPagesOption))
701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770
Generator::setWriteQaPages();
if (isSet(logProgressOption))
Location::startLoggingProgress();
QDir currentDir = QDir::current();
const auto paths = values(includePathOption);
for (const auto &i : paths)
includesPaths << "-I" << currentDir.absoluteFilePath(i);
auto paths2 = values(includePathSystemOption);
if (paths2.isEmpty())
paths2 << QString(getSystemIncludePath());
for (const auto &i : paths2)
includesPaths << "-isystem" << currentDir.absoluteFilePath(i);
const auto paths3 = values(frameworkOption);
for (const auto &i : paths3)
includesPaths << "-F" << currentDir.absoluteFilePath(i);
/*
The default indent for code is 0.
The default value for false is 0.
The default supported file extensions are cpp, h, qdoc and qml.
The default language is c++.
The default output format is html.
The default tab size is 8.
And those are all the default values for configuration variables.
*/
if (defaults.isEmpty()) {
defaults.insert(CONFIG_CODEINDENT, QLatin1String("0"));
defaults.insert(CONFIG_FALSEHOODS, QLatin1String("0"));
defaults.insert(CONFIG_FILEEXTENSIONS, QLatin1String("*.cpp *.h *.qdoc *.qml"));
defaults.insert(CONFIG_LANGUAGE, QLatin1String("Cpp"));
defaults.insert(CONFIG_OUTPUTFORMATS, QLatin1String("HTML"));
defaults.insert(CONFIG_TABSIZE, QLatin1String("8"));
}
}
QT_END_NAMESPACE
int main(int argc, char **argv)
{
QT_USE_NAMESPACE
// Initialize Qt:
#ifndef QT_BOOTSTRAPPED
qSetGlobalQHashSeed(0); // set the hash seed to 0 if it wasn't set yet
#endif
QCoreApplication app(argc, argv);
app.setApplicationVersion(QLatin1String(QT_VERSION_STR));
// Instantiate various singletons (used via static methods):
/*
Create code parsers for the languages to be parsed,
and create a tree for C++.
*/
ClangCodeParser clangParser;
QmlCodeParser qmlParser;
PureDocParser docParser;
/*
Create code markers for plain text, C++,
javascript, and QML.
*/
PlainCodeMarker plainMarker;
CppCodeMarker cppMarker;
JsCodeMarker jsMarker;
QmlCodeMarker qmlMarker;
HtmlGenerator htmlGenerator;
// Set the globals declared at the top of this file:
771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820
QDocCommandLineParser parser;
parser.process(app);
// Get the list of files to act on:
QStringList qdocFiles = parser.positionalArguments();
if (qdocFiles.isEmpty())
parser.showHelp();
if (singleExec)
qdocFiles = Config::loadMaster(qdocFiles.at(0));
// Main loop (adapted, when needed, to handle single exec mode):
if (Generator::singleExec())
Generator::setQDocPass(Generator::Prepare);
foreach (const QString &qf, qdocFiles) {
dependModules.clear();
processQdocconfFile(qf);
}
if (Generator::singleExec()) {
Generator::setQDocPass(Generator::Generate);
QDocDatabase* qdb = QDocDatabase::qdocDB();
qdb->processForest();
foreach (const QString &qf, qdocFiles) {
dependModules.clear();
processQdocconfFile(qf);
}
}
// Tidy everything away:
#ifndef QT_NO_TRANSLATION
if (!translators.isEmpty()) {
for (int i=0; i<translators.size(); ++i) {
delete translators.at(i).second;
}
}
translators.clear();
#endif
QmlTypeNode::terminate();
#ifdef DEBUG_SHUTDOWN_CRASH
qDebug() << "main(): Delete qdoc database";
#endif
QDocDatabase::destroyQdocDB();
#ifdef DEBUG_SHUTDOWN_CRASH
qDebug() << "main(): qdoc database deleted";
#endif
return EXIT_SUCCESS;
}