1berry/qtbase
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

qdoc: retrying More refactoring of qdoc data structures

Browse Source 
This commit is the second phase of a significant
overhaul of qdoc. Two new classes, QDocIndexFiles,
and QDocTagFiles, are added to encapsulate the
creation and use of the qdoc index files, and the
creation of the qdoc tag file.

Change-Id: I94651b10628e535ea7b26bd8256037cd819ccea7
Reviewed-by: Martin Smith <martin.smith@digia.com>
This commit is contained in:
Martin Smith 2012-09-24 09:54:42 +02:00 committed by The Qt Project
parent d8cebcdf67
commit 4b21631f59
16 changed files with 2016 additions and 1738 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
src/tools/qdoc/ditaxmlgenerator.cpp
View File

@ -532,6 +532,7 @@ void DitaXmlGenerator::initializeGenerator(const Config &config)
projectDescription = project + " Reference Documentation";
projectUrl = config.getString(CONFIG_URL);
tagFile_ = config.getString(CONFIG_TAGFILE);
outputEncoding = config.getString(CONFIG_OUTPUTENCODING);
if (outputEncoding.isEmpty())
@ -676,8 +677,15 @@ void DitaXmlGenerator::generateTree()
generateCollisionPages();
QString fileBase = project.toLower().simplified().replace(QLatin1Char(' '), QLatin1Char('-'));
generateIndex(fileBase, projectUrl, projectDescription);
qdb_->generateIndex(outputDir() + QLatin1Char('/') + fileBase + ".index",
projectUrl,
projectDescription,
this);
writeDitaMap();
/*
Generate the XML tag file, if it was requested.
*/
qdb_->generateTagFile(tagFile_, this);
}
static int countTableColumns(const Atom* t)
@ -1755,7 +1763,7 @@ int DitaXmlGenerator::generateAtom(const Atom *atom,
columnText = pieces.at(0);
pieces.pop_front();
QString path = pieces.join(' ').trimmed();
node = qdb_->findNodeForTarget(path, relative, atom);
node = qdb_->findNodeForTarget(path, relative);
if (!node)
relative->doc().location().warning(tr("Cannot link to '%1'").arg(path));
}
@ -3940,13 +3948,6 @@ QString DitaXmlGenerator::getLink(const Atom* atom, const Node* relative, const
return link;
}
void DitaXmlGenerator::generateIndex(const QString& fileBase,
const QString& url,
const QString& title)
{
qdb_->generateIndex(outputDir() + QLatin1Char('/') + fileBase + ".index", url, title, this);
}
void DitaXmlGenerator::generateStatus(const Node* node, CodeMarker* marker)
{
Text text;

3
src/tools/qdoc/ditaxmlgenerator.h
View File

@ -436,9 +436,6 @@ private:
static int hOffset(const Node *node);
static bool isThreeColumnEnumValueTable(const Atom *atom);
QString getLink(const Atom *atom, const Node *relative, const Node **node);
virtual void generateIndex(const QString& fileBase,
const QString& url,
const QString& title);
#ifdef GENERATE_MAC_REFS
void generateMacRef(const Node* node, CodeMarker* marker);
#endif

50
src/tools/qdoc/generator.cpp
View File

@ -1456,9 +1456,11 @@ void Generator::initialize(const Config &config)
baseDir_ = config.getString(CONFIG_BASEDIR);
if (!baseDir_.isEmpty())
config.location().warning(tr("\"basedir\" specified in config file. "
"All output will be in module directories of the output directory"));
"All output will be in module directories "
"of the output directory"));
if (outDir_.isEmpty())
config.lastLocation().fatal(tr("No output directory specified in configuration file or on the command line"));
config.lastLocation().fatal(tr("No output directory specified in "
"configuration file or on the command line"));
QDir dirInfo;
if (dirInfo.exists(outDir_)) {
@ -1471,17 +1473,13 @@ void Generator::initialize(const Config &config)
}
if (!dirInfo.mkdir(outDir_ + "/images"))
config.lastLocation().fatal(tr("Cannot create output directory '%1'")
.arg(outDir_ + "/images"));
config.lastLocation().fatal(tr("Cannot create output directory '%1'").arg(outDir_ + "/images"));
if (!dirInfo.mkdir(outDir_ + "/images/used-in-examples"))
config.lastLocation().fatal(tr("Cannot create output directory '%1'")
.arg(outDir_ + "/images/used-in-examples"));
config.lastLocation().fatal(tr("Cannot create output directory '%1'").arg(outDir_ + "/images/used-in-examples"));
if (!dirInfo.mkdir(outDir_ + "/scripts"))
config.lastLocation().fatal(tr("Cannot create output directory '%1'")
.arg(outDir_ + "/scripts"));
config.lastLocation().fatal(tr("Cannot create output directory '%1'").arg(outDir_ + "/scripts"));
if (!dirInfo.mkdir(outDir_ + "/style"))
config.lastLocation().fatal(tr("Cannot create output directory '%1'")
.arg(outDir_ + "/style"));
config.lastLocation().fatal(tr("Cannot create output directory '%1'").arg(outDir_ + "/style"));
}
imageFiles = config.getCleanPathList(CONFIG_IMAGES);
@ -1491,16 +1489,13 @@ void Generator::initialize(const Config &config)
styleFiles = config.getCleanPathList(CONFIG_STYLES);
styleDirs = config.getCleanPathList(CONFIG_STYLEDIRS);
exampleDirs = config.getCleanPathList(CONFIG_EXAMPLEDIRS);
exampleImgExts = config.getStringList(CONFIG_EXAMPLES + Config::dot +
CONFIG_IMAGEEXTENSIONS);
exampleImgExts = config.getStringList(CONFIG_EXAMPLES + Config::dot + CONFIG_IMAGEEXTENSIONS);
QString imagesDotFileExtensions =
CONFIG_IMAGES + Config::dot + CONFIG_FILEEXTENSIONS;
QString imagesDotFileExtensions = CONFIG_IMAGES + Config::dot + CONFIG_FILEEXTENSIONS;
QSet<QString> formats = config.subVars(imagesDotFileExtensions);
QSet<QString>::ConstIterator f = formats.constBegin();
while (f != formats.constEnd()) {
imgFileExts[*f] = config.getStringList(imagesDotFileExtensions +
Config::dot + *f);
imgFileExts[*f] = config.getStringList(imagesDotFileExtensions + Config::dot + *f);
++f;
}
@ -1509,8 +1504,7 @@ void Generator::initialize(const Config &config)
if (outputFormats.contains((*g)->format())) {
currentGenerator_ = (*g);
(*g)->initializeGenerator(config);
QStringList extraImages =
config.getCleanPathList(CONFIG_EXTRAIMAGES+Config::dot+(*g)->format());
QStringList extraImages = config.getCleanPathList(CONFIG_EXTRAIMAGES+Config::dot+(*g)->format());
QStringList::ConstIterator e = extraImages.constBegin();
while (e != extraImages.constEnd()) {
QString userFriendlyFilePath;
@ -1530,8 +1524,7 @@ void Generator::initialize(const Config &config)
}
// Documentation template handling
QString templateDir = config.getString(
(*g)->format() + Config::dot + CONFIG_TEMPLATEDIR);
QString templateDir = config.getString((*g)->format() + Config::dot + CONFIG_TEMPLATEDIR);
QStringList searchDirs;
if (!templateDir.isEmpty()) {
@ -1543,8 +1536,7 @@ void Generator::initialize(const Config &config)
if (!searchDirs.isEmpty()) {
QStringList noExts;
QStringList scripts =
config.getCleanPathList((*g)->format()+Config::dot+CONFIG_SCRIPTS);
QStringList scripts = config.getCleanPathList((*g)->format()+Config::dot+CONFIG_SCRIPTS);
e = scripts.constBegin();
while (e != scripts.constEnd()) {
QString userFriendlyFilePath;
@ -1563,8 +1555,7 @@ void Generator::initialize(const Config &config)
++e;
}
QStringList styles =
config.getCleanPathList((*g)->format()+Config::dot+CONFIG_STYLESHEETS);
QStringList styles = config.getCleanPathList((*g)->format()+Config::dot+CONFIG_STYLESHEETS);
e = styles.constBegin();
while (e != styles.constEnd()) {
QString userFriendlyFilePath;
@ -1592,16 +1583,13 @@ void Generator::initialize(const Config &config)
QSet<QString>::ConstIterator n = formattingNames.constBegin();
while (n != formattingNames.constEnd()) {
QString formattingDotName = CONFIG_FORMATTING + Config::dot + *n;
QSet<QString> formats = config.subVars(formattingDotName);
QSet<QString>::ConstIterator f = formats.constBegin();
while (f != formats.constEnd()) {
QString def = config.getString(formattingDotName +
Config::dot + *f);
QString def = config.getString(formattingDotName + Config::dot + *f);
if (!def.isEmpty()) {
int numParams = Config::numParams(def);
int numOccs = def.count("\1");
if (numParams != 1) {
config.lastLocation().warning(tr("Formatting '%1' must "
"have exactly one "
@ -1631,9 +1619,9 @@ void Generator::initialize(const Config &config)
QStringList prefixes = config.getStringList(CONFIG_OUTPUTPREFIXES);
if (!prefixes.isEmpty()) {
foreach (const QString &prefix, prefixes)
outputPrefixes[prefix] = config.getString(
CONFIG_OUTPUTPREFIXES + Config::dot + prefix);
} else
outputPrefixes[prefix] = config.getString(CONFIG_OUTPUTPREFIXES + Config::dot + prefix);
}
else
outputPrefixes[QLatin1String("QML")] = QLatin1String("qml-");
}

1
src/tools/qdoc/generator.h
View File

@ -166,6 +166,7 @@ protected:
QString naturalLanguage;
QTextCodec* outputCodec;
QString outputEncoding;
QString tagFile_;
QStack<QTextStream*> outStreamStack;
private:

17
src/tools/qdoc/htmlgenerator.cpp
View File

@ -176,6 +176,7 @@ void HtmlGenerator::initializeGenerator(const Config &config)
projectDescription = project + " Reference Documentation";
projectUrl = config.getString(CONFIG_URL);
tagFile_ = config.getString(CONFIG_TAGFILE);
outputEncoding = config.getString(CONFIG_OUTPUTENCODING);
if (outputEncoding.isEmpty())
@ -259,10 +260,17 @@ void HtmlGenerator::generateTree()
generateCollisionPages();
QString fileBase = project.toLower().simplified().replace(QLatin1Char(' '), QLatin1Char('-'));
generateIndex(fileBase, projectUrl, projectDescription);
qdb_->generateIndex(outputDir() + QLatin1Char('/') + fileBase + ".index",
projectUrl,
projectDescription,
this);
helpProjectWriter->generate();
generateManifestFiles();
/*
Generate the XML tag file, if it was requested.
*/
qdb_->generateTagFile(tagFile_, this);
}
/*!
@ -3636,13 +3644,6 @@ QString HtmlGenerator::getLink(const Atom *atom, const Node *relative, const Nod
return link;
}
void HtmlGenerator::generateIndex(const QString &fileBase,
const QString &url,
const QString &title)
{
qdb_->generateIndex(outputDir() + QLatin1Char('/') + fileBase + ".index", url, title, this);
}
void HtmlGenerator::generateStatus(const Node *node, CodeMarker *marker)
{
Text text;

3
src/tools/qdoc/htmlgenerator.h
View File

@ -203,9 +203,6 @@ private:
static int hOffset(const Node *node);
static bool isThreeColumnEnumValueTable(const Atom *atom);
QString getLink(const Atom *atom, const Node *relative, const Node** node);
virtual void generateIndex(const QString &fileBase,
const QString &url,
const QString &title);
#ifdef GENERATE_MAC_REFS
void generateMacRef(const Node *node, CodeMarker *marker);
#endif

4
src/tools/qdoc/main.cpp
View File

@ -435,10 +435,6 @@ static void processQdocconfFile(const QString &fileName)
++of;
}
/*
Generate the XML tag file, if it was requested.
*/
qdb->generateTagFile(config.getString(CONFIG_TAGFILE));
//Generator::writeOutFileNames();

4
src/tools/qdoc/qdoc.pro
View File

@ -43,6 +43,8 @@ HEADERS += atom.h \
plaincodemarker.h \
puredocparser.h \
qdocdatabase.h \
qdoctagfiles.h \
qdocindexfiles.h \
quoter.h \
separator.h \
text.h \
@ -69,6 +71,8 @@ SOURCES += atom.cpp \
plaincodemarker.cpp \
puredocparser.cpp \
qdocdatabase.cpp \
qdoctagfiles.cpp \
qdocindexfiles.cpp \
quoter.cpp \
separator.cpp \
text.cpp \

258
src/tools/qdoc/qdocdatabase.cpp
View File

@ -39,8 +39,11 @@
**
****************************************************************************/
#include "atom.h"
#include "tree.h"
#include "qdocdatabase.h"
#include "qdoctagfiles.h"
#include "qdocindexfiles.h"
#include <qdebug.h>
QT_BEGIN_NAMESPACE
@ -555,7 +558,7 @@ const NodeMultiMap& QDocDatabase::getSinceMap(const QString& key) const
*/
void QDocDatabase::resolveIssues() {
tree_->resolveGroups();
tree_->resolveTargets(tree_->root());
resolveTargets(treeRoot());
tree_->resolveCppToQmlLinks();
}
@ -589,7 +592,7 @@ const Node* QDocDatabase::resolveTarget(const QString& target,
QString funcName = target;
funcName.chop(2);
QStringList path = funcName.split("::");
const FunctionNode* fn = tree_->findFunctionNode(path, relative, Tree::SearchBaseClasses);
const FunctionNode* fn = tree_->findFunctionNode(path, relative, SearchBaseClasses);
if (fn) {
/*
Why is this case not accepted?
@ -604,19 +607,17 @@ const Node* QDocDatabase::resolveTarget(const QString& target,
}
else {
QStringList path = target.split("::");
int flags = Tree::SearchBaseClasses | Tree::SearchEnumValues | Tree::NonFunction;
int flags = SearchBaseClasses | SearchEnumValues | NonFunction;
node = tree_->findNode(path, relative, flags, self);
}
return node;
}
/*!
zzz
Is the atom necessary?
Finds the node that will generate the documentation that
contains the \a target and returns a pointer to it.
*/
const Node* QDocDatabase::findNodeForTarget(const QString& target,
const Node* relative,
const Atom* atom)
const Node* QDocDatabase::findNodeForTarget(const QString& target, const Node* relative)
{
const Node* node = 0;
if (target.isEmpty())
@ -626,13 +627,244 @@ const Node* QDocDatabase::findNodeForTarget(const QString& target,
else {
node = resolveTarget(target, relative);
if (!node)
node = tree_->findDocNodeByTitle(target, relative);
if (!node && atom) {
qDebug() << "USING ATOM!";
node = tree_->findUnambiguousTarget(target, *const_cast<Atom**>(&atom), relative);
}
node = findDocNodeByTitle(target, relative);
}
return node;
}
/*!
Inserts a new target into the target table with the specified
\a name, \a node, and \a priority.
*/
void QDocDatabase::insertTarget(const QString& name, Node* node, int priority)
{
Target target;
target.node = node;
target.priority = priority;
target.atom = new Atom(Atom::Target, name);
targetHash_.insert(name, target);
}
static const int NumSuffixes = 3;
static const char* const suffixes[NumSuffixes] = { "", "s", "es" };
/*!
This function searches for a \a target anchor node. If it
finds one, it sets \a atom from the found node and returns
the found node.
*/
const Node*
QDocDatabase::findUnambiguousTarget(const QString& target, Atom *&atom, const Node* relative) const
{
Target bestTarget = {0, 0, INT_MAX};
int numBestTargets = 0;
QList<Target> bestTargetList;
for (int pass = 0; pass < NumSuffixes; ++pass) {
TargetHash::const_iterator i = targetHash_.constFind(Doc::canonicalTitle(target + suffixes[pass]));
if (i != targetHash_.constEnd()) {
TargetHash::const_iterator j = i;
do {
const Target& candidate = j.value();
if (candidate.priority < bestTarget.priority) {
bestTarget = candidate;
bestTargetList.clear();
bestTargetList.append(candidate);
numBestTargets = 1;
} else if (candidate.priority == bestTarget.priority) {
bestTargetList.append(candidate);
++numBestTargets;
}
++j;
} while (j != targetHash_.constEnd() && j.key() == i.key());
if (numBestTargets == 1) {
atom = bestTarget.atom;
return bestTarget.node;
}
else if (bestTargetList.size() > 1) {
if (relative && !relative->qmlModuleIdentifier().isEmpty()) {
for (int i=0; i<bestTargetList.size(); ++i) {
const Node* n = bestTargetList.at(i).node;
if (n && relative->qmlModuleIdentifier() == n->qmlModuleIdentifier()) {
atom = bestTargetList.at(i).atom;
return n;
}
}
}
}
}
}
return 0;
}
/*!
This function searches for a node with the specified \a title.
If \a relative node is provided, it is used to disambiguate if
it has a QML module identifier.
*/
const DocNode* QDocDatabase::findDocNodeByTitle(const QString& title, const Node* relative) const
{
for (int pass = 0; pass < NumSuffixes; ++pass) {
DocNodeHash::const_iterator i = docNodesByTitle_.constFind(Doc::canonicalTitle(title + suffixes[pass]));
if (i != docNodesByTitle_.constEnd()) {
if (relative && !relative->qmlModuleIdentifier().isEmpty()) {
const DocNode* dn = i.value();
InnerNode* parent = dn->parent();
if (parent && parent->type() == Node::Document && parent->subType() == Node::Collision) {
const NodeList& nl = parent->childNodes();
NodeList::ConstIterator it = nl.constBegin();
while (it != nl.constEnd()) {
if ((*it)->qmlModuleIdentifier() == relative->qmlModuleIdentifier()) {
/*
By returning here, we avoid printing all the duplicate
header warnings, which are not really duplicates now,
because of the QML module identifier being used as a
namespace qualifier.
*/
dn = static_cast<const DocNode*>(*it);
return dn;
}
++it;
}
}
}
/*
Reporting all these duplicate section titles is probably
overkill. We should report the duplicate file and let
that suffice.
*/
DocNodeHash::const_iterator j = i;
++j;
if (j != docNodesByTitle_.constEnd() && j.key() == i.key()) {
QList<Location> internalLocations;
while (j != docNodesByTitle_.constEnd()) {
if (j.key() == i.key() && j.value()->url().isEmpty())
internalLocations.append(j.value()->location());
++j;
}
if (internalLocations.size() > 0) {
i.value()->location().warning(tr("This page exists in more than one file: \"%1\"").arg(title));
foreach (const Location &location, internalLocations)
location.warning(tr("[It also exists here]"));
}
}
return i.value();
}
}
return 0;
}
/*!
This function searches for a node with a canonical title
constructed from \a target and each of the possible suffixes.
If the node it finds is \a node, it returns the Atom from that
node. Otherwise it returns null.
*/
Atom* QDocDatabase::findTarget(const QString& target, const Node* node) const
{
for (int pass = 0; pass < NumSuffixes; ++pass) {
QString key = Doc::canonicalTitle(target + suffixes[pass]);
TargetHash::const_iterator i = targetHash_.constFind(key);
if (i != targetHash_.constEnd()) {
do {
if (i.value().node == node)
return i.value().atom;
++i;
} while (i != targetHash_.constEnd() && i.key() == key);
}
}
return 0;
}
/*!
*/
void QDocDatabase::resolveTargets(InnerNode* root)
{
// need recursion
foreach (Node* child, root->childNodes()) {
if (child->type() == Node::Document) {
DocNode* node = static_cast<DocNode*>(child);
if (!node->title().isEmpty())
docNodesByTitle_.insert(Doc::canonicalTitle(node->title()), node);
if (node->subType() == Node::Collision) {
resolveTargets(node);
}
}
if (child->doc().hasTableOfContents()) {
const QList<Atom*>& toc = child->doc().tableOfContents();
Target target;
target.node = child;
target.priority = 3;
for (int i = 0; i < toc.size(); ++i) {
target.atom = toc.at(i);
QString title = Text::sectionHeading(target.atom).toString();
if (!title.isEmpty())
targetHash_.insert(Doc::canonicalTitle(title), target);
}
}
if (child->doc().hasKeywords()) {
const QList<Atom*>& keywords = child->doc().keywords();
Target target;
target.node = child;
target.priority = 1;
for (int i = 0; i < keywords.size(); ++i) {
target.atom = keywords.at(i);
targetHash_.insert(Doc::canonicalTitle(target.atom->string()), target);
}
}
if (child->doc().hasTargets()) {
const QList<Atom*>& toc = child->doc().targets();
Target target;
target.node = child;
target.priority = 2;
for (int i = 0; i < toc.size(); ++i) {
target.atom = toc.at(i);
targetHash_.insert(Doc::canonicalTitle(target.atom->string()), target);
}
}
}
}
/*!
Generates a tag file and writes it to \a name.
*/
void QDocDatabase::generateTagFile(const QString& name, Generator* g)
{
if (!name.isEmpty()) {
QDocTagFiles::qdocTagFiles()->generateTagFile(name, g);
QDocTagFiles::destroyQDocTagFiles();
}
}
/*!
Reads and parses the qdoc index files listed in \a indexFiles.
*/
void QDocDatabase::readIndexes(const QStringList& indexFiles)
{
QDocIndexFiles::qdocIndexFiles()->readIndexes(indexFiles);
QDocIndexFiles::destroyQDocIndexFiles();
}
/*!
Generates a qdoc index file and write it to \a fileName. The
index file is generated with the parameters \a url, \a title,
\a g, and \a generateInternalNodes.
*/
void QDocDatabase::generateIndex(const QString& fileName,
const QString& url,
const QString& title,
Generator* g,
bool generateInternalNodes)
{
QDocIndexFiles::qdocIndexFiles()->generateIndex(fileName, url, title, g, generateInternalNodes);
QDocIndexFiles::destroyQDocIndexFiles();
}
QT_END_NAMESPACE

71
src/tools/qdoc/qdocdatabase.h
View File

@ -54,10 +54,29 @@ typedef QMap<QString, NodeMap> NodeMapMap;
typedef QMap<QString, NodeMultiMap> NodeMultiMapMap;
typedef QMultiMap<QString, Node*> QDocMultiMap;
typedef QMap<Text, const Node*> TextToNodeMap;
typedef QMultiHash<QString, DocNode*> DocNodeHash;
class Atom;
class Generator;
enum FindFlag {
SearchBaseClasses = 0x1,
SearchEnumValues = 0x2,
NonFunction = 0x4
};
class QDocDatabase
{
public:
struct Target
{
Node* node;
Atom* atom;
int priority;
};
typedef QMultiHash<QString, Target> TargetHash;
public:
static QDocDatabase* qdocDB();
static void destroyQdocDB();
~QDocDatabase();
@ -97,19 +116,16 @@ class QDocDatabase
const NodeMultiMap& getSinceMap(const QString& key) const;
const Node* resolveTarget(const QString& target, const Node* relative, const Node* self=0);
const Node* findNodeForTarget(const QString& target, const Node* relative, const Atom* atom=0);
const Node* findNodeForTarget(const QString& target, const Node* relative);
void insertTarget(const QString& name, Node* node, int priority);
/* convenience functions
Many of these will be either eliminated or replaced.
*/
Tree* tree() { return tree_; }
QString version() const { return tree_->version(); }
NamespaceNode* treeRoot() { return tree_->root(); }
void setVersion(const QString& version) { tree_->setVersion(version); }
void resolveInheritance() { tree_->resolveInheritance(); }
void readIndexes(const QStringList& indexFiles) { tree_->readIndexes(indexFiles); }
void resolveIssues();
void generateTagFile(const QString& name) { if (!name.isEmpty()) tree_->generateTagFile(name); }
void addToGroup(Node* node, const QString& group) { tree_->addToGroup(node, group); }
void addToPublicGroup(Node* node, const QString& group) { tree_->addToPublicGroup(node, group); }
void fixInheritance() { tree_->fixInheritance(); }
@ -124,22 +140,11 @@ class QDocDatabase
return tree_->findCollisionNode(name);
}
const DocNode* findDocNodeByTitle(const QString& title, const Node* relative=0) const {
return tree_->findDocNodeByTitle(title, relative);
}
const Node* findUnambiguousTarget(const QString& target, Atom* &atom, const Node* relative) const {
return tree_->findUnambiguousTarget(target, atom, relative);
}
Atom* findTarget(const QString& target, const Node* node) const {
return tree_->findTarget(target, node);
}
void generateIndex(const QString& fileName,
const QString& url,
const QString& title,
Generator* g,
bool generateInternalNodes = false) {
tree_->generateIndex(fileName, url, title, g, generateInternalNodes);
}
const DocNode* findDocNodeByTitle(const QString& title, const Node* relative = 0) const;
const Node *findUnambiguousTarget(const QString &target, Atom *&atom, const Node* relative) const;
Atom *findTarget(const QString &target, const Node *node) const;
void resolveTargets(InnerNode* root);
FunctionNode* findFunctionNode(const QStringList& parentPath, const FunctionNode* clone) {
return tree_->findFunctionNode(parentPath, clone);
}
@ -162,10 +167,29 @@ class QDocDatabase
tree_->addPropertyFunction(property, funcName, funcRole);
}
void setVersion(const QString& v) { version_ = v; }
QString version() const { return version_; }
void generateTagFile(const QString& name, Generator* g);
void readIndexes(const QStringList& indexFiles);
void generateIndex(const QString& fileName,
const QString& url,
const QString& title,
Generator* g,
bool generateInternalNodes = false);
/* debugging functions */
void printModules() const;
void printQmlModules() const;
private:
friend class QDocIndexFiles;
friend class QDocTagFiles;
const Node* findNode(const QStringList& path, const Node* relative, int findFlags) {
return tree_->findNode(path, relative, findFlags);
}
private:
QDocDatabase();
QDocDatabase(QDocDatabase const& ) { }; // copy constructor is private
@ -173,6 +197,7 @@ class QDocDatabase
private:
static QDocDatabase* qdocDB_;
QString version_;
QDocMultiMap masterMap_;
Tree* tree_;
DocNodeMap modules_;
@ -191,6 +216,8 @@ class QDocDatabase
NodeMultiMapMap newSinceMaps_;
NodeMapMap funcIndex_;
TextToNodeMap legaleseTexts_;
TargetHash targetHash_;
DocNodeHash docNodesByTitle_;
};
QT_END_NAMESPACE

1070
src/tools/qdoc/qdocindexfiles.cpp Normal file
View File

File diff suppressed because it is too large Load Diff

91
src/tools/qdoc/qdocindexfiles.h Normal file
View File

@ -0,0 +1,91 @@
/****************************************************************************
**
** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/legal
**
** This file is part of the tools applications of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** 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 Digia. For licensing terms and
** conditions see http://qt.digia.com/licensing. For further information
** use the contact form at http://qt.digia.com/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 2.1 requirements
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Digia gives you certain additional
** rights. These rights are described in the Digia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3.0 as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL included in the
** packaging of this file. Please review the following information to
** ensure the GNU General Public License version 3.0 requirements will be
** met: http://www.gnu.org/copyleft/gpl.html.
**
**
** $QT_END_LICENSE$
**
****************************************************************************/
#ifndef QDOCINDEXFILES_H
#define QDOCINDEXFILES_H
#include "node.h"
QT_BEGIN_NAMESPACE
class Atom;
class Generator;
class QStringList;
class QDocDatabase;
class QDomElement;
class QXmlStreamWriter;
class QDocIndexFiles
{
friend class QDocDatabase;
private:
static QDocIndexFiles* qdocIndexFiles();
static void destroyQDocIndexFiles();
QDocIndexFiles();
~QDocIndexFiles();
void readIndexes(const QStringList& indexFiles);
void generateIndex(const QString& fileName,
const QString& url,
const QString& title,
Generator* g,
bool generateInternalNodes = false);
void readIndexFile(const QString& path);
void readIndexSection(const QDomElement& element, InnerNode* parent, const QString& indexUrl);
void resolveIndex();
bool generateIndexSection(QXmlStreamWriter& writer, Node* node, bool generateInternalNodes = false);
void generateIndexSections(QXmlStreamWriter& writer, Node* node, bool generateInternalNodes = false);
private:
static QDocIndexFiles* qdocIndexFiles_;
QDocDatabase* qdb_;
Generator* gen_;
QList<QPair<ClassNode*,QString> > basesList_;
QList<QPair<FunctionNode*,QString> > relatedList_;
};
QT_END_NAMESPACE
#endif

404
src/tools/qdoc/qdoctagfiles.cpp Normal file
View File

@ -0,0 +1,404 @@
/****************************************************************************
**
** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/legal
**
** This file is part of the tools applications of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** 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 Digia. For licensing terms and
** conditions see http://qt.digia.com/licensing. For further information
** use the contact form at http://qt.digia.com/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 2.1 requirements
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Digia gives you certain additional
** rights. These rights are described in the Digia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3.0 as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL included in the
** packaging of this file. Please review the following information to
** ensure the GNU General Public License version 3.0 requirements will be
** met: http://www.gnu.org/copyleft/gpl.html.
**
**
** $QT_END_LICENSE$
**
****************************************************************************/
#include "node.h"
#include "qdoctagfiles.h"
#include "qdocdatabase.h"
#include "qdom.h"
#include "atom.h"
#include "doc.h"
#include "htmlgenerator.h"
#include "location.h"
#include "node.h"
#include "text.h"
#include <limits.h>
#include <qdebug.h>
QT_BEGIN_NAMESPACE
/*!
\class QDocTagFiles
This class handles the generation of the qdoc tag file.
*/
QDocTagFiles* QDocTagFiles::qdocTagFiles_ = NULL;
/*!
Constructs the singleton. \a qdb is the pointer to the
qdoc database that is used when reading and writing the
index files.
*/
QDocTagFiles::QDocTagFiles()
{
qdb_ = QDocDatabase::qdocDB();
}
/*!
Destroys the singleton QDocTagFiles.
*/
QDocTagFiles::~QDocTagFiles()
{
qdb_ = 0;
}
/*!
Creates the singleton. Allows only one instance of the class
to be created. Returns a pointer to the singleton.
*/
QDocTagFiles* QDocTagFiles::qdocTagFiles()
{
if (!qdocTagFiles_)
qdocTagFiles_ = new QDocTagFiles;
return qdocTagFiles_;
}
/*!
Destroys the singleton.
*/
void QDocTagFiles::destroyQDocTagFiles()
{
if (qdocTagFiles_) {
delete qdocTagFiles_;
qdocTagFiles_ = 0;
}
}
/*!
Generate the tag file section with the given \a writer for the \a node
specified, returning true if an element was written; otherwise returns
false.
*/
void QDocTagFiles::generateTagFileCompounds(QXmlStreamWriter& writer, const InnerNode* inner)
{
foreach (const Node* node, inner->childNodes()) {
if (!node->url().isEmpty())
continue;
QString kind;
switch (node->type()) {
case Node::Namespace:
kind = "namespace";
break;
case Node::Class:
kind = "class";
break;
case Node::Enum:
case Node::Typedef:
case Node::Property:
case Node::Function:
case Node::Variable:
default:
continue;
}
QString access;
switch (node->access()) {
case Node::Public:
access = "public";
break;
case Node::Protected:
access = "protected";
break;
case Node::Private:
default:
continue;
}
QString objName = node->name();
// Special case: only the root node should have an empty name.
if (objName.isEmpty() && node != qdb_->treeRoot())
continue;
// *** Write the starting tag for the element here. ***
writer.writeStartElement("compound");
writer.writeAttribute("kind", kind);
if (node->type() == Node::Class) {
writer.writeTextElement("name", node->fullDocumentName());
writer.writeTextElement("filename", gen_->fullDocumentLocation(node,true));
// Classes contain information about their base classes.
const ClassNode* classNode = static_cast<const ClassNode*>(node);
QList<RelatedClass> bases = classNode->baseClasses();
foreach (const RelatedClass& related, bases) {
ClassNode* baseClassNode = related.node;
writer.writeTextElement("base", baseClassNode->name());
}
// Recurse to write all members.
generateTagFileMembers(writer, static_cast<const InnerNode*>(node));
writer.writeEndElement();
// Recurse to write all compounds.
generateTagFileCompounds(writer, static_cast<const InnerNode*>(node));
}
else {
writer.writeTextElement("name", node->fullDocumentName());
writer.writeTextElement("filename", gen_->fullDocumentLocation(node,true));
// Recurse to write all members.
generateTagFileMembers(writer, static_cast<const InnerNode*>(node));
writer.writeEndElement();
// Recurse to write all compounds.
generateTagFileCompounds(writer, static_cast<const InnerNode*>(node));
}
}
}
/*!
Writes all the members of the \a inner node with the \a writer.
The node represents a C++ class, namespace, etc.
*/
void QDocTagFiles::generateTagFileMembers(QXmlStreamWriter& writer, const InnerNode* inner)
{
foreach (const Node* node, inner->childNodes()) {
if (!node->url().isEmpty())
continue;
QString nodeName;
QString kind;
switch (node->type()) {
case Node::Enum:
nodeName = "member";
kind = "enum";
break;
case Node::Typedef:
nodeName = "member";
kind = "typedef";
break;
case Node::Property:
nodeName = "member";
kind = "property";
break;
case Node::Function:
nodeName = "member";
kind = "function";
break;
case Node::Namespace:
nodeName = "namespace";
break;
case Node::Class:
nodeName = "class";
break;
case Node::Variable:
default:
continue;
}
QString access;
switch (node->access()) {
case Node::Public:
access = "public";
break;
case Node::Protected:
access = "protected";
break;
case Node::Private:
default:
continue;
}
QString objName = node->name();
// Special case: only the root node should have an empty name.
if (objName.isEmpty() && node != qdb_->treeRoot())
continue;
// *** Write the starting tag for the element here. ***
writer.writeStartElement(nodeName);
if (!kind.isEmpty())
writer.writeAttribute("kind", kind);
switch (node->type()) {
case Node::Class:
writer.writeCharacters(node->fullDocumentName());
writer.writeEndElement();
break;
case Node::Namespace:
writer.writeCharacters(node->fullDocumentName());
writer.writeEndElement();
break;
case Node::Function:
{
/*
Function nodes contain information about
the type of function being described.
*/
const FunctionNode* functionNode = static_cast<const FunctionNode*>(node);
writer.writeAttribute("protection", access);
switch (functionNode->virtualness()) {
case FunctionNode::NonVirtual:
writer.writeAttribute("virtualness", "non");
break;
case FunctionNode::ImpureVirtual:
writer.writeAttribute("virtualness", "virtual");
break;
case FunctionNode::PureVirtual:
writer.writeAttribute("virtual", "pure");
break;
default:
break;
}
writer.writeAttribute("static", functionNode->isStatic() ? "yes" : "no");
if (functionNode->virtualness() == FunctionNode::NonVirtual)
writer.writeTextElement("type", functionNode->returnType());
else
writer.writeTextElement("type", "virtual " + functionNode->returnType());
writer.writeTextElement("name", objName);
QStringList pieces = gen_->fullDocumentLocation(node,true).split(QLatin1Char('#'));
writer.writeTextElement("anchorfile", pieces[0]);
writer.writeTextElement("anchor", pieces[1]);
// Write a signature attribute for convenience.
QStringList signatureList;
foreach (const Parameter& parameter, functionNode->parameters()) {
QString leftType = parameter.leftType();
const Node* leftNode = qdb_->findNode(parameter.leftType().split("::"),
0,
SearchBaseClasses|NonFunction);
if (!leftNode || leftNode->type() != Node::Typedef) {
leftNode = qdb_->findNode(parameter.leftType().split("::"),
node->parent(),
SearchBaseClasses|NonFunction);
}
if (leftNode && leftNode->type() == Node::Typedef) {
const TypedefNode* typedefNode = static_cast<const TypedefNode*>(leftNode);
if (typedefNode->associatedEnum()) {
leftType = "QFlags<" + typedefNode->associatedEnum()->fullDocumentName() +
QLatin1Char('>');
}
}
signatureList.append(leftType + QLatin1Char(' ') + parameter.name());
}
QString signature = QLatin1Char('(')+signatureList.join(", ")+QLatin1Char(')');
if (functionNode->isConst())
signature += " const";
if (functionNode->virtualness() == FunctionNode::PureVirtual)
signature += " = 0";
writer.writeTextElement("arglist", signature);
}
writer.writeEndElement(); // member
break;
case Node::Property:
{
const PropertyNode* propertyNode = static_cast<const PropertyNode*>(node);
writer.writeAttribute("type", propertyNode->dataType());
writer.writeTextElement("name", objName);
QStringList pieces = gen_->fullDocumentLocation(node,true).split(QLatin1Char('#'));
writer.writeTextElement("anchorfile", pieces[0]);
writer.writeTextElement("anchor", pieces[1]);
writer.writeTextElement("arglist", QString());
}
writer.writeEndElement(); // member
break;
case Node::Enum:
{
const EnumNode* enumNode = static_cast<const EnumNode*>(node);
writer.writeTextElement("name", objName);
QStringList pieces = gen_->fullDocumentLocation(node).split(QLatin1Char('#'));
writer.writeTextElement("anchor", pieces[1]);
writer.writeTextElement("arglist", QString());
writer.writeEndElement(); // member
for (int i = 0; i < enumNode->items().size(); ++i) {
EnumItem item = enumNode->items().value(i);
writer.writeStartElement("member");
writer.writeAttribute("name", item.name());
writer.writeTextElement("anchor", pieces[1]);
writer.writeTextElement("arglist", QString());
writer.writeEndElement(); // member
}
}
break;
case Node::Typedef:
{
const TypedefNode* typedefNode = static_cast<const TypedefNode*>(node);
if (typedefNode->associatedEnum())
writer.writeAttribute("type", typedefNode->associatedEnum()->fullDocumentName());
else
writer.writeAttribute("type", QString());
writer.writeTextElement("name", objName);
QStringList pieces = gen_->fullDocumentLocation(node,true).split(QLatin1Char('#'));
writer.writeTextElement("anchorfile", pieces[0]);
writer.writeTextElement("anchor", pieces[1]);
writer.writeTextElement("arglist", QString());
}
writer.writeEndElement(); // member
break;
case Node::Variable:
default:
break;
}
}
}
/*!
Writes a tag file named \a fileName.
*/
void QDocTagFiles::generateTagFile(const QString& fileName, Generator* g)
{
QFile file(fileName);
if (!file.open(QFile::WriteOnly | QFile::Text))
return ;
gen_ = g;
QXmlStreamWriter writer(&file);
writer.setAutoFormatting(true);
writer.writeStartDocument();
writer.writeStartElement("tagfile");
generateTagFileCompounds(writer, qdb_->treeRoot());
writer.writeEndElement(); // tagfile
writer.writeEndDocument();
file.close();
}
QT_END_NAMESPACE

76
src/tools/qdoc/qdoctagfiles.h Normal file
View File

@ -0,0 +1,76 @@
/****************************************************************************
**
** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/legal
**
** This file is part of the tools applications of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** 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 Digia. For licensing terms and
** conditions see http://qt.digia.com/licensing. For further information
** use the contact form at http://qt.digia.com/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 2.1 requirements
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Digia gives you certain additional
** rights. These rights are described in the Digia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3.0 as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL included in the
** packaging of this file. Please review the following information to
** ensure the GNU General Public License version 3.0 requirements will be
** met: http://www.gnu.org/copyleft/gpl.html.
**
**
** $QT_END_LICENSE$
**
****************************************************************************/
#ifndef QDOCTAGFILES_H
#define QDOCTAGFILES_H
#include "qxmlstream.h"
QT_BEGIN_NAMESPACE
class InnerNode;
class QDocDatabase;
class Generator;
class QDocTagFiles
{
friend class QDocDatabase;
private:
static QDocTagFiles* qdocTagFiles();
static void destroyQDocTagFiles();
QDocTagFiles();
~QDocTagFiles();
void generateTagFileCompounds(QXmlStreamWriter& writer, const InnerNode* inner);
void generateTagFileMembers(QXmlStreamWriter& writer, const InnerNode* inner);
void generateTagFile(const QString& fileName, Generator* g);
private:
static QDocTagFiles* qdocTagFiles_;
QDocDatabase* qdb_;
Generator* gen_;
};
QT_END_NAMESPACE
#endif

1625
src/tools/qdoc/tree.cpp
View File

File diff suppressed because it is too large Load Diff

58
src/tools/qdoc/tree.h
View File

@ -47,14 +47,10 @@
#define TREE_H
#include "node.h"
#include <qdom.h>
#include <qxmlstream.h>
QT_BEGIN_NAMESPACE
class Generator;
class QStringList;
class TreePrivate;
class QDocDatabase;
class Tree
@ -62,9 +58,25 @@ class Tree
private:
friend class QDocDatabase;
enum FindFlag { SearchBaseClasses = 0x1,
SearchEnumValues = 0x2,
NonFunction = 0x4 };
typedef QMap<PropertyNode::FunctionRole, QString> RoleMap;
typedef QMap<PropertyNode*, RoleMap> PropertyMap;
struct InheritanceBound
{
Node::Access access;
QStringList basePath;
QString dataTypeWithTemplateArgs;
InnerNode* parent;
InheritanceBound() : access(Node::Public) { }
InheritanceBound(Node::Access access0,
const QStringList& basePath0,
const QString& dataTypeWithTemplateArgs0,
InnerNode* parent)
: access(access0), basePath(basePath0),
dataTypeWithTemplateArgs(dataTypeWithTemplateArgs0),
parent(parent) { }
};
Tree(QDocDatabase* qdb);
~Tree();
@ -125,12 +137,9 @@ class Tree
void resolveInheritance(NamespaceNode *rootNode = 0);
void resolveProperties();
void resolveGroups();
void resolveTargets(InnerNode* root);
void resolveCppToQmlLinks();
void fixInheritance(NamespaceNode *rootNode = 0);
void setVersion(const QString &version) { vers = version; }
NamespaceNode *root() { return &root_; }
QString version() const { return vers; }
const FunctionNode *findFunctionNode(const QStringList &path,
const Node *relative = 0,
@ -139,42 +148,21 @@ class Tree
const FunctionNode *clone,
const Node *relative = 0,
int findFlags = 0) const;
const DocNode *findDocNodeByTitle(const QString &title, const Node* relative = 0) const;
const Node *findUnambiguousTarget(const QString &target, Atom *&atom, const Node* relative) const;
Atom *findTarget(const QString &target, const Node *node) const;
const NamespaceNode *root() const { return &root_; }
void readIndexes(const QStringList &indexFiles);
bool generateIndexSection(QXmlStreamWriter& writer, Node* node, bool generateInternalNodes = false);
void generateIndexSections(QXmlStreamWriter& writer, Node* node, bool generateInternalNodes = false);
void generateIndex(const QString &fileName,
const QString &url,
const QString &title,
Generator* g,
bool generateInternalNodes = false);
void generateTagFileCompounds(QXmlStreamWriter &writer,
const InnerNode *inner);
void generateTagFileMembers(QXmlStreamWriter &writer,
const InnerNode *inner);
void generateTagFile(const QString &fileName);
void addExternalLink(const QString &url, const Node *relative);
void resolveInheritance(int pass, ClassNode *classe);
FunctionNode *findVirtualFunctionInBaseClasses(ClassNode *classe,
FunctionNode *clone);
void fixPropertyUsingBaseClasses(ClassNode *classe, PropertyNode *property);
NodeList allBaseClasses(const ClassNode *classe) const;
void readIndexFile(const QString &path);
void readIndexSection(const QDomElement &element, InnerNode *parent,
const QString &indexUrl);
QString readIndexText(const QDomElement &element);
void resolveIndex();
private:
QDocDatabase* qdb_;
NamespaceNode root_;
QString vers;
Generator* gen_;
TreePrivate *priv;
QMap<ClassNode* , QList<InheritanceBound> > unresolvedInheritanceMap;
PropertyMap unresolvedPropertyMap;
NodeMultiMap groupMap;
QMultiMap<QString, QString> publicGroupMap;
};
QT_END_NAMESPACE