or <apiName> writeCharacters(name); xmlWriter().writeEndElement(); //

detailSections; detailSections = marker->sections(inner, CodeMarker::Detailed, CodeMarker::Okay); s = detailSections.begin(); while (s != detailSections.end()) { if ((*s).name == "Classes") { writeNestedClasses((*s),fn); break; } ++s; } s = detailSections.begin(); while (s != detailSections.end()) { if ((*s).name == "Function Documentation") { writeFunctions((*s),fn,marker); } else if ((*s).name == "Type Documentation") { writeEnumerations((*s),marker); writeTypedefs((*s),marker); } else if ((*s).name == "Namespaces") { qDebug() << "Nested namespaces" << outFileName(); } else if ((*s).name == "Macro Documentation") { writeMacros((*s),marker); } ++s; } generateLowStatusMembers(inner,marker,CodeMarker::Obsolete); generateLowStatusMembers(inner,marker,CodeMarker::Compat); xmlWriter().writeEndElement(); // } else if ((inner->type() == Node::Fake) && (inner->subType() == Node::QmlClass)) { const QmlClassNode* qcn = const_cast(static_cast(inner)); const ClassNode* cn = qcn->classNode(); rawTitle = marker->plainName(inner); fullTitle = marker->plainFullName(inner); title = rawTitle + " Element Reference"; //QString fullTitle = fake->fullTitle(); //QString htmlTitle = fullTitle; generateHeader(inner, fullTitle); generateBrief(inner, marker); // // not included: xmlWriter().writeStartElement(CXXCLASSDETAIL); xmlWriter().writeStartElement("apiDesc"); xmlWriter().writeAttribute("spectitle",title); Text brief = qcn->doc().briefText(); // zzz if (!brief.isEmpty()) { xmlWriter().writeStartElement("p"); generateText(brief, qcn, marker); xmlWriter().writeEndElement(); //

} generateQmlInstantiates(qcn, marker); generateQmlInherits(qcn, marker); generateQmlInheritedBy(qcn, marker); generateSince(qcn, marker); xmlWriter().writeEndElement(); // QList

summarySections; summarySections = marker->qmlSections(qcn,CodeMarker::Summary,0); s = summarySections.begin(); while (s != summarySections.end()) { QString attr; if (!s->members.isEmpty()) { xmlWriter().writeStartElement("section"); attr = cleanRef((*s).name).toLower() + " redundant"; xmlWriter().writeAttribute("outputclass",attr); xmlWriter().writeStartElement("title"); xmlWriter().writeAttribute("outputclass","h2"); writeCharacters(protectEnc((*s).name)); xmlWriter().writeEndElement(); // generateQmlSummary(*s,qcn,marker); //generateSection(s->members, inner, marker, CodeMarker::Summary); //generateSectionInheritedList(*s, inner, marker); xmlWriter().writeEndElement(); //

} ++s; } writeDetailedDescription(qcn, marker, false, QString("Detailed Description")); if (cn) generateQmlText(cn->doc().body(), cn, marker, qcn->name()); QList

detailSections; detailSections = marker->qmlSections(qcn,CodeMarker::Detailed,0); s = detailSections.begin(); while (s != detailSections.end()) { if (!s->members.isEmpty()) { QString attr; inSection = true; xmlWriter().writeStartElement("section"); attr = cleanRef((*s).name).toLower(); xmlWriter().writeAttribute("outputclass",attr); xmlWriter().writeStartElement("title"); xmlWriter().writeAttribute("outputclass","h2"); writeCharacters(protectEnc((*s).name)); xmlWriter().writeEndElement(); // NodeList::ConstIterator m = (*s).members.begin(); while (m != (*s).members.end()) { generateDetailedQmlMember(*m, qcn, marker); ++m; } xmlWriter().writeEndElement(); //

inSection = false; } ++s; } xmlWriter().writeEndElement(); // xmlWriter().writeEndElement(); // } } /*! Write a list item for a \a link with the given \a text. */ void DitaXmlGenerator::writeXrefListItem(const QString& link, const QString& text) { xmlWriter().writeStartElement("li"); xmlWriter().writeStartElement("xref"); xmlWriter().writeAttribute("href",link); writeCharacters(text); xmlWriter().writeEndElement(); // xmlWriter().writeEndElement(); // } /*! Generate the html page for a qdoc file that doesn't map to an underlying c++ file. */ void DitaXmlGenerator::generateFakeNode(const FakeNode* fake, CodeMarker* marker) { SubTitleSize subTitleSize = LargeSubTitle; QList

sections; QList

::const_iterator s; QString fullTitle = fake->fullTitle(); QString htmlTitle = fullTitle; if (fake->subType() == Node::File && !fake->subTitle().isEmpty()) { subTitleSize = SmallSubTitle; htmlTitle += " (" + fake->subTitle() + ")"; } else if (fake->subType() == Node::QmlBasicType) { fullTitle = "QML Basic Type: " + fullTitle; htmlTitle = fullTitle; } generateHeader(fake, fullTitle); generateBrief(fake, marker); // xmlWriter().writeStartElement("body"); if (fake->subType() == Node::Module) { generateStatus(fake, marker); if (moduleNamespaceMap.contains(fake->name())) { xmlWriter().writeStartElement("section"); xmlWriter().writeAttribute("outputclass","namespaces"); xmlWriter().writeStartElement("title"); xmlWriter().writeAttribute("outputclass","h2"); xmlWriter().writeCharacters("Namespaces"); xmlWriter().writeEndElement(); // generateAnnotatedList(fake, marker, moduleNamespaceMap[fake->name()]); xmlWriter().writeEndElement(); //

} if (moduleClassMap.contains(fake->name())) { xmlWriter().writeStartElement("section"); xmlWriter().writeAttribute("outputclass","classes"); xmlWriter().writeStartElement("title"); xmlWriter().writeAttribute("outputclass","h2"); xmlWriter().writeCharacters("Classes"); xmlWriter().writeEndElement(); // generateAnnotatedList(fake, marker, moduleClassMap[fake->name()]); xmlWriter().writeEndElement(); //

} } if (fake->doc().isEmpty()) { if (fake->subType() == Node::File) { Text text; Quoter quoter; xmlWriter().writeStartElement("p"); xmlWriter().writeAttribute("outputclass", "small-subtitle"); text << fake->subTitle(); generateText(text, fake, marker); xmlWriter().writeEndElement(); //

Doc::quoteFromFile(fake->doc().location(), quoter, fake->name()); QString code = quoter.quoteTo(fake->location(), "", ""); text.clear(); text << Atom(Atom::Code, code); generateText(text, fake, marker); } } else { if (fake->subType() == Node::Module) { writeDetailedDescription(fake, marker, false, QString("Detailed Description")); } else writeDetailedDescription(fake, marker, false, QString()); generateAlsoList(fake, marker); if (!fake->groupMembers().isEmpty()) { NodeMap groupMembersMap; foreach (const Node *node, fake->groupMembers()) { if (node->type() == Node::Class || node->type() == Node::Namespace) groupMembersMap[node->name()] = node; } generateAnnotatedList(fake, marker, groupMembersMap); } } xmlWriter().writeEndElement(); // writeRelatedLinks(fake, marker); xmlWriter().writeEndElement(); // } /*! This function writes a \e{} element inside a \e{} element. \sa writeRelatedLinks() */ void DitaXmlGenerator::writeLink(const Node* node, const QString& text, const QString& role) { if (node) { QString link = fileName(node) + "#" + node->guid(); xmlWriter().writeStartElement("link"); xmlWriter().writeAttribute("href", link); xmlWriter().writeAttribute("role", role); xmlWriter().writeStartElement("linktext"); writeCharacters(text); xmlWriter().writeEndElement(); // xmlWriter().writeEndElement(); // } } /*! This function writes a \e{} element, which contains the \c{next}, \c{previous}, and \c{start} links for topic pages that have them. Note that the value of the \e role attribute is \c{parent} for the \c{start} link. */ void DitaXmlGenerator::writeRelatedLinks(const FakeNode* node, CodeMarker* marker) { const Node* linkNode = 0; QPair linkPair; if (node && !node->links().empty()) { xmlWriter().writeStartElement("related-links"); if (node->links().contains(Node::PreviousLink)) { linkPair = node->links()[Node::PreviousLink]; linkNode = findNodeForTarget(linkPair.first, node, marker); writeLink(linkNode, linkPair.second, "previous"); } if (node->links().contains(Node::NextLink)) { linkPair = node->links()[Node::NextLink]; linkNode = findNodeForTarget(linkPair.first, node, marker); writeLink(linkNode, linkPair.second, "next"); } if (node->links().contains(Node::StartLink)) { linkPair = node->links()[Node::StartLink]; linkNode = findNodeForTarget(linkPair.first, node, marker); writeLink(linkNode, linkPair.second, "parent"); } xmlWriter().writeEndElement(); // } } /*! Returns "xml" for this subclass of class Generator. */ QString DitaXmlGenerator::fileExtension(const Node * /* node */) const { return "xml"; } /*! Writes an XML file header to the current XML stream. This depends on which kind of DITA XML file is being generated, which is determined by the \a node type and subtype and the \a subpage flag. If the \subpage flag is true, a \c{} header is written, regardless of the type of \a node. */ void DitaXmlGenerator::generateHeader(const Node* node, const QString& name, bool subpage) { if (!node) return; QString doctype; QString mainElement; QString nameElement; QString dtd; QString base; QString version; QString outputclass; if (node->type() == Node::Class) { mainElement = "cxxClass"; nameElement = "apiName"; dtd = "dtd/cxxClass.dtd"; version = "0.6.0"; doctype = ""; } else if (node->type() == Node::Namespace) { mainElement = "cxxClass"; nameElement = "apiName"; dtd = "dtd/cxxClass.dtd"; version = "0.6.0"; doctype = ""; outputclass = "namespace"; } else if (node->type() == Node::Fake || subpage) { if (node->subType() == Node::HeaderFile) { mainElement = "cxxClass"; nameElement = "apiName"; dtd = "dtd/cxxClass.dtd"; version = "0.6.0"; doctype = ""; outputclass = "headerfile"; } else if (node->subType() == Node::QmlClass) { mainElement = "cxxClass"; nameElement = "apiName"; dtd = "dtd/cxxClass.dtd"; version = "0.6.0"; doctype = ""; outputclass = "QML-class"; } else { mainElement = "topic"; nameElement = "title"; dtd = "dtd/topic.dtd"; doctype = ""; switch (node->subType()) { case Node::Page: outputclass = "page"; break; case Node::Group: outputclass = "group"; break; case Node::Example: outputclass = "example"; break; case Node::File: outputclass = "file"; break; case Node::Image: // not used outputclass = "image"; break; case Node::Module: outputclass = "module"; break; case Node::ExternalPage: // not used outputclass = "externalpage"; break; default: outputclass = "page"; } } } xmlWriter().writeDTD(doctype); xmlWriter().writeComment(node->doc().location().fileName()); xmlWriter().writeStartElement(mainElement); xmlWriter().writeAttribute("id",node->guid()); if (!outputclass.isEmpty()) xmlWriter().writeAttribute("outputclass",outputclass); xmlWriter().writeStartElement(nameElement); // or <apiName> writeCharacters(name); xmlWriter().writeEndElement(); // or } /*! Outputs the \e brief command as a element. */ void DitaXmlGenerator::generateBrief(const Node* node, CodeMarker* marker) { Text brief = node->doc().briefText(true); // zzz if (!brief.isEmpty()) { generateText(brief, node, marker); } } /*! Writes the \c {#include ...} required to include the class or namespace in a compilation. */ void DitaXmlGenerator::generateIncludes(const InnerNode* inner, CodeMarker* marker) { if (!inner->includes().isEmpty()) { xmlWriter().writeStartElement("codeblock"); writeText(marker->markedUpIncludes(inner->includes()), marker, inner); xmlWriter().writeEndElement(); // } } /*! zzz Generates a table of contents beginning at \a node. Currently just returns without writing anything. */ void DitaXmlGenerator::generateTableOfContents(const Node* node, CodeMarker* marker, Doc::SectioningUnit sectioningUnit, int numColumns, const Node* relative) { return; if (!node->doc().hasTableOfContents()) return; QList toc = node->doc().tableOfContents(); if (toc.isEmpty()) return; QString nodeName = ""; if (node != relative) nodeName = node->name(); QStringList sectionNumber; int columnSize = 0; QString tdTag; if (numColumns > 1) { tdTag = ""; /* width=\"" + QString::number((100 + numColumns - 1) / numColumns) + "%\">";*/ out() << "\n" << tdTag << "\n"; } // disable nested links in table of contents inContents = true; inLink = true; for (int i = 0; i < toc.size(); ++i) { Atom *atom = toc.at(i); int nextLevel = atom->string().toInt(); if (nextLevel > (int)sectioningUnit) continue; if (sectionNumber.size() < nextLevel) { do { out() << "

"; sectionNumber.append("1"); } while (sectionNumber.size() < nextLevel); } else { while (sectionNumber.size() > nextLevel) { out() << "\n"; sectionNumber.removeLast(); } sectionNumber.last() = QString::number(sectionNumber.last().toInt() + 1); } int numAtoms; Text headingText = Text::sectionHeading(atom); if (sectionNumber.size() == 1 && columnSize > toc.size() / numColumns) { out() << "" << tdTag << "

"; out() << ""; generateAtomList(headingText.firstAtom(), node, marker, true, numAtoms); out() << "

\n"; sectionNumber.removeLast(); } if (numColumns > 1) out() << "

\n"; inContents = false; inLink = false; } /*! zzz Revised for the new doc format. Generates a table of contents beginning at \a node. */ void DitaXmlGenerator::generateTableOfContents(const Node* node, CodeMarker* marker, QList

* sections) { QList toc; if (node->doc().hasTableOfContents()) toc = node->doc().tableOfContents(); if (toc.isEmpty() && !sections && (node->subType() != Node::Module)) return; QStringList sectionNumber; int detailsBase = 0; // disable nested links in table of contents inContents = true; inLink = true; out() << "

\n"; out() << "

\n"; sectionNumber.append("1"); out() << "

Namespaces
Classes
Detailed Description

::ConstIterator s = sections->begin(); while (s != sections->end()) { if (!s->members.isEmpty() || !s->reimpMembers.isEmpty()) { out() << "

" << (*s).name << "

\n"; } ++s; } out() << "

Detailed Description

\n"; for (int i = 0; i < toc.size(); ++i) { if (toc.at(i)->string().toInt() == 1) { detailsBase = 1; break; } } } for (int i = 0; i < toc.size(); ++i) { Atom *atom = toc.at(i); int nextLevel = atom->string().toInt() + detailsBase; if (sectionNumber.size() < nextLevel) { do { sectionNumber.append("1"); } while (sectionNumber.size() < nextLevel); } else { while (sectionNumber.size() > nextLevel) { sectionNumber.removeLast(); } sectionNumber.last() = QString::number(sectionNumber.last().toInt() + 1); } int numAtoms; Text headingText = Text::sectionHeading(atom); QString s = headingText.toString(); out() << "

"; out() << ""; generateAtomList(headingText.firstAtom(), node, marker, true, numAtoms); out() << "

\n"; } while (!sectionNumber.isEmpty()) { sectionNumber.removeLast(); } out() << "

\n"; out() << "

\n"; inContents = false; inLink = false; } void DitaXmlGenerator::generateLowStatusMembers(const InnerNode* inner, CodeMarker* marker, CodeMarker::Status status) { QString attribute; if (status == CodeMarker::Compat) attribute = "Qt3-support"; else if (status == CodeMarker::Obsolete) attribute = "obsolete"; else return; QList

sections = marker->sections(inner, CodeMarker::Detailed, status); QMutableListIterator

j(sections); while (j.hasNext()) { if (j.next().members.size() == 0) j.remove(); } if (sections.isEmpty()) return; QList

::ConstIterator s = sections.begin(); while (s != sections.end()) { if ((*s).name == "Member Function Documentation") { writeFunctions((*s),inner,marker,attribute); } else if ((*s).name == "Member Type Documentation") { writeEnumerations((*s),marker,attribute); writeTypedefs((*s),marker,attribute); } else if ((*s).name == "Member Variable Documentation") { writeDataMembers((*s),marker,attribute); } else if ((*s).name == "Property Documentation") { writeProperties((*s),marker,attribute); } else if ((*s).name == "Macro Documentation") { writeMacros((*s),marker,attribute); } ++s; } } /*! Write the XML for the class hierarchy to the current XML stream. */ void DitaXmlGenerator::generateClassHierarchy(const Node* relative, CodeMarker* marker, const QMap& classMap) { if (classMap.isEmpty()) return; NodeMap topLevel; NodeMap::ConstIterator c = classMap.begin(); while (c != classMap.end()) { const ClassNode* classe = static_cast(*c); if (classe->baseClasses().isEmpty()) topLevel.insert(classe->name(), classe); ++c; } QStack stack; stack.push(topLevel); xmlWriter().writeStartElement("ul"); while (!stack.isEmpty()) { if (stack.top().isEmpty()) { stack.pop(); xmlWriter().writeEndElement(); // if (!stack.isEmpty()) xmlWriter().writeEndElement(); // } else { const ClassNode *child = static_cast(*stack.top().begin()); xmlWriter().writeStartElement("li"); generateFullName(child, relative, marker); xmlWriter().writeEndElement(); // stack.top().erase(stack.top().begin()); NodeMap newTop; foreach (const RelatedClass &d, child->derivedClasses()) { if (d.access != Node::Private && !d.node->doc().isEmpty()) newTop.insert(d.node->name(), d.node); } if (!newTop.isEmpty()) { stack.push(newTop); xmlWriter().writeStartElement("li"); xmlWriter().writeStartElement("ul"); } } } } /*! Write XML for the contents of the \a nodeMap to the current XML stream. */ void DitaXmlGenerator::generateAnnotatedList(const Node* relative, CodeMarker* marker, const NodeMap& nodeMap) { if (nodeMap.isEmpty()) return; xmlWriter().writeStartElement("table"); xmlWriter().writeAttribute("outputclass","annotated"); xmlWriter().writeStartElement("tgroup"); xmlWriter().writeAttribute("cols","2"); xmlWriter().writeStartElement("tbody"); foreach (const QString& name, nodeMap.keys()) { const Node* node = nodeMap[name]; if (node->status() == Node::Obsolete) continue; xmlWriter().writeStartElement("row"); xmlWriter().writeStartElement("entry"); xmlWriter().writeStartElement("p"); generateFullName(node, relative, marker); xmlWriter().writeEndElement(); //

xmlWriter().writeEndElement(); // if (!(node->type() == Node::Fake)) { Text brief = node->doc().trimmedBriefText(name); if (!brief.isEmpty()) { xmlWriter().writeStartElement("entry"); xmlWriter().writeStartElement("p"); generateText(brief, node, marker); xmlWriter().writeEndElement(); //

xmlWriter().writeEndElement(); // } } else { xmlWriter().writeStartElement("entry"); xmlWriter().writeStartElement("p"); writeCharacters(protectEnc(node->doc().briefText().toString())); // zzz xmlWriter().writeEndElement(); //

xmlWriter().writeEndElement(); // } xmlWriter().writeEndElement(); // } xmlWriter().writeEndElement(); // xmlWriter().writeEndElement(); // xmlWriter().writeEndElement(); // } /*! This function finds the common prefix of the names of all the classes in \a classMap and then generates a compact list of the class names alphabetized on the part of the name not including the common prefix. You can tell the function to use \a comonPrefix as the common prefix, but normally you let it figure it out itself by looking at the name of the first and last classes in \a classMap. */ void DitaXmlGenerator::generateCompactList(const Node* relative, CodeMarker* marker, const NodeMap& classMap, bool includeAlphabet, QString commonPrefix) { const int NumParagraphs = 37; // '0' to '9', 'A' to 'Z', '_' if (classMap.isEmpty()) return; /* If commonPrefix is not empty, then the caller knows what the common prefix is and has passed it in, so just use that one. */ int commonPrefixLen = commonPrefix.length(); if (commonPrefixLen == 0) { QString first; QString last; /* The caller didn't pass in a common prefix, so get the common prefix by looking at the class names of the first and last classes in the class map. Discard any namespace names and just use the bare class names. For Qt, the prefix is "Q". Note that the algorithm used here to derive the common prefix from the first and last classes in alphabetical order (QAccel and QXtWidget in Qt 2.1), fails if either class name does not begin with Q. */ NodeMap::const_iterator iter = classMap.begin(); while (iter != classMap.end()) { if (!iter.key().contains("::")) { first = iter.key(); break; } ++iter; } if (first.isEmpty()) first = classMap.begin().key(); iter = classMap.end(); while (iter != classMap.begin()) { --iter; if (!iter.key().contains("::")) { last = iter.key(); break; } } if (last.isEmpty()) last = classMap.begin().key(); if (classMap.size() > 1) { while (commonPrefixLen < first.length() + 1 && commonPrefixLen < last.length() + 1 && first[commonPrefixLen] == last[commonPrefixLen]) ++commonPrefixLen; } commonPrefix = first.left(commonPrefixLen); } /* Divide the data into 37 paragraphs: 0, ..., 9, A, ..., Z, underscore (_). QAccel will fall in paragraph 10 (A) and QXtWidget in paragraph 33 (X). This is the only place where we assume that NumParagraphs is 37. Each paragraph is a NodeMap. */ NodeMap paragraph[NumParagraphs+1]; QString paragraphName[NumParagraphs+1]; QSet usedParagraphNames; NodeMap::ConstIterator c = classMap.begin(); while (c != classMap.end()) { QStringList pieces = c.key().split("::"); QString key; int idx = commonPrefixLen; if (!pieces.last().startsWith(commonPrefix)) idx = 0; if (pieces.size() == 1) key = pieces.last().mid(idx).toLower(); else key = pieces.last().toLower(); int paragraphNr = NumParagraphs - 1; if (key[0].digitValue() != -1) { paragraphNr = key[0].digitValue(); } else if (key[0] >= QLatin1Char('a') && key[0] <= QLatin1Char('z')) { paragraphNr = 10 + key[0].unicode() - 'a'; } paragraphName[paragraphNr] = key[0].toUpper(); usedParagraphNames.insert(key[0].toLower().cell()); paragraph[paragraphNr].insert(key, c.value()); ++c; } /* Each paragraph j has a size: paragraph[j].count(). In the discussion, we will assume paragraphs 0 to 5 will have sizes 3, 1, 4, 1, 5, 9. We now want to compute the paragraph offset. Paragraphs 0 to 6 start at offsets 0, 3, 4, 8, 9, 14, 23. */ int paragraphOffset[NumParagraphs + 1]; // 37 + 1 paragraphOffset[0] = 0; for (int i=0; i cmap; /* Output the alphabet as a row of links. */ if (includeAlphabet) { xmlWriter().writeStartElement("p"); xmlWriter().writeAttribute("outputclass","alphabet"); for (int i = 0; i < 26; i++) { QChar ch('a' + i); if (usedParagraphNames.contains(char('a' + i))) { xmlWriter().writeStartElement("xref"); QString guid = lookupGuid(outFileName(),QString(ch)); QString attr = outFileName() + QString("#%1").arg(guid); xmlWriter().writeAttribute("href", attr); xmlWriter().writeCharacters(QString(ch.toUpper())); xmlWriter().writeEndElement(); // } } xmlWriter().writeEndElement(); //

} /* Output a

element to contain all the

elements. */ xmlWriter().writeStartElement("p"); xmlWriter().writeAttribute("outputclass","compactlist"); for (int i=0; i. */ if (curParOffset == 0) { if (i > 0) { xmlWriter().writeEndElement(); // xmlWriter().writeEndElement(); // } xmlWriter().writeStartElement("dl"); xmlWriter().writeStartElement("dlentry"); xmlWriter().writeStartElement("dt"); if (includeAlphabet) { QChar c = paragraphName[curParNr][0].toLower(); writeGuidAttribute(QString(c)); } xmlWriter().writeAttribute("outputclass","sublist-header"); xmlWriter().writeCharacters(paragraphName[curParNr]); xmlWriter().writeEndElement(); // } /* Output a

for the current offset in the current paragraph. */ xmlWriter().writeStartElement("dd"); if ((curParNr < NumParagraphs) && !paragraphName[curParNr].isEmpty()) { NodeMap::Iterator it; it = paragraph[curParNr].begin(); for (int i=0; isubType() == Node::QmlClass) pieces << it.value()->name(); else pieces = fullName(it.value(), relative, marker).split("::"); xmlWriter().writeCharacters(protectEnc(pieces.last())); xmlWriter().writeEndElement(); // if (pieces.size() > 1) { xmlWriter().writeCharacters(" ("); generateFullName(it.value()->parent(),relative,marker); xmlWriter().writeCharacters(")"); } } xmlWriter().writeEndElement(); //

curParOffset++; } xmlWriter().writeEndElement(); // xmlWriter().writeEndElement(); // xmlWriter().writeEndElement(); //

} /*! Write XML for a function index to the current XML stream. */ void DitaXmlGenerator::generateFunctionIndex(const Node* relative, CodeMarker* marker) { xmlWriter().writeStartElement("p"); xmlWriter().writeAttribute("outputclass","alphabet"); for (int i = 0; i < 26; i++) { QChar ch('a' + i); xmlWriter().writeStartElement("xref"); QString guid = lookupGuid(outFileName(),QString(ch)); QString attr = outFileName() + QString("#%1").arg(guid); xmlWriter().writeAttribute("href", attr); xmlWriter().writeCharacters(QString(ch.toUpper())); xmlWriter().writeEndElement(); // } xmlWriter().writeEndElement(); //

char nextLetter = 'a'; char currentLetter; xmlWriter().writeStartElement("ul"); QMap::ConstIterator f = funcIndex.begin(); while (f != funcIndex.end()) { xmlWriter().writeStartElement("li"); currentLetter = f.key()[0].unicode(); while (islower(currentLetter) && currentLetter >= nextLetter) { xmlWriter().writeStartElement("p"); writeGuidAttribute(QString(nextLetter)); xmlWriter().writeAttribute("outputclass","target"); xmlWriter().writeCharacters(QString(nextLetter)); xmlWriter().writeEndElement(); //

nextLetter++; } xmlWriter().writeCharacters(protectEnc(f.key())); xmlWriter().writeCharacters(":"); NodeMap::ConstIterator s = (*f).begin(); while (s != (*f).end()) { generateFullName((*s)->parent(), relative, marker, *s); ++s; } xmlWriter().writeEndElement(); // ++f; } xmlWriter().writeEndElement(); // } /*! Write the legalese texts as XML to the current XML stream. */ void DitaXmlGenerator::generateLegaleseList(const Node* relative, CodeMarker* marker) { QMap::ConstIterator it = legaleseTexts.begin(); while (it != legaleseTexts.end()) { Text text = it.key(); generateText(text, relative, marker); xmlWriter().writeStartElement("ul"); do { xmlWriter().writeStartElement("li"); generateFullName(it.value(), relative, marker); xmlWriter().writeEndElement(); // ++it; } while (it != legaleseTexts.end() && it.key() == text); xmlWriter().writeEndElement(); // } } /*! Generate the text for the QML item described by \a node and write it to the current XML stream. */ void DitaXmlGenerator::generateQmlItem(const Node* node, const Node* relative, CodeMarker* marker, bool summary) { QString marked = marker->markedUpQmlItem(node,summary); QRegExp tag("(<[^@>]*>)"); if (marked.indexOf(tag) != -1) { QString tmp = protectEnc(marked.mid(tag.pos(1), tag.cap(1).length())); marked.replace(tag.pos(1), tag.cap(1).length(), tmp); } marked.replace(QRegExp("<@param>([a-z]+)_([1-9n])"), "\\1_\\2"); marked.replace("<@param>", ""); marked.replace("", ""); if (summary) marked.replace("@name>", "b>"); marked.replace("<@extra>", ""); marked.replace("", ""); if (summary) { marked.replace("<@type>", ""); marked.replace("", ""); } writeText(marked, marker, relative); } /*! Writher the XML for the overview list to the current XML stream. */ void DitaXmlGenerator::generateOverviewList(const Node* relative, CodeMarker* /* marker */) { QMap > fakeNodeMap; QMap groupTitlesMap; QMap uncategorizedNodeMap; QRegExp singleDigit("\\b([0-9])\\b"); const NodeList children = myTree->root()->childNodes(); foreach (Node* child, children) { if (child->type() == Node::Fake && child != relative) { FakeNode* fakeNode = static_cast(child); // Check whether the page is part of a group or is the group // definition page. QString group; bool isGroupPage = false; if (fakeNode->doc().metaCommandsUsed().contains("group")) { group = fakeNode->doc().metaCommandArgs("group")[0]; isGroupPage = true; } // there are too many examples; they would clutter the list if (fakeNode->subType() == Node::Example) continue; // not interested either in individual (Qt Designer etc.) manual chapters if (fakeNode->links().contains(Node::ContentsLink)) continue; // Discard external nodes. if (fakeNode->subType() == Node::ExternalPage) continue; QString sortKey = fakeNode->fullTitle().toLower(); if (sortKey.startsWith("the ")) sortKey.remove(0, 4); sortKey.replace(singleDigit, "0\\1"); if (!group.isEmpty()) { if (isGroupPage) { // If we encounter a group definition page, we add all // the pages in that group to the list for that group. foreach (Node* member, fakeNode->groupMembers()) { if (member->type() != Node::Fake) continue; FakeNode* page = static_cast(member); if (page) { QString sortKey = page->fullTitle().toLower(); if (sortKey.startsWith("the ")) sortKey.remove(0, 4); sortKey.replace(singleDigit, "0\\1"); fakeNodeMap[const_cast(fakeNode)].insert(sortKey, page); groupTitlesMap[fakeNode->fullTitle()] = const_cast(fakeNode); } } } else if (!isGroupPage) { // If we encounter a page that belongs to a group then // we add that page to the list for that group. const FakeNode* groupNode = static_cast(myTree->root()->findNode(group, Node::Fake)); if (groupNode) fakeNodeMap[groupNode].insert(sortKey, fakeNode); //else // uncategorizedNodeMap.insert(sortKey, fakeNode); }// else // uncategorizedNodeMap.insert(sortKey, fakeNode); }// else // uncategorizedNodeMap.insert(sortKey, fakeNode); } } // We now list all the pages found that belong to groups. // If only certain pages were found for a group, but the definition page // for that group wasn't listed, the list of pages will be intentionally // incomplete. However, if the group definition page was listed, all the // pages in that group are listed for completeness. if (!fakeNodeMap.isEmpty()) { foreach (const QString& groupTitle, groupTitlesMap.keys()) { const FakeNode* groupNode = groupTitlesMap[groupTitle]; xmlWriter().writeStartElement("p"); xmlWriter().writeAttribute("outputclass","h3"); xmlWriter().writeStartElement("xref"); xmlWriter().writeAttribute("href",linkForNode(groupNode, relative)); writeCharacters(protectEnc(groupNode->fullTitle())); xmlWriter().writeEndElement(); // xmlWriter().writeEndElement(); //

if (fakeNodeMap[groupNode].count() == 0) continue; xmlWriter().writeStartElement("ul"); foreach (const FakeNode* fakeNode, fakeNodeMap[groupNode]) { QString title = fakeNode->fullTitle(); if (title.startsWith("The ")) title.remove(0, 4); xmlWriter().writeStartElement("li"); xmlWriter().writeStartElement("xref"); xmlWriter().writeAttribute("href",linkForNode(fakeNode, relative)); writeCharacters(protectEnc(title)); xmlWriter().writeEndElement(); // xmlWriter().writeEndElement(); // } xmlWriter().writeEndElement(); // } } if (!uncategorizedNodeMap.isEmpty()) { xmlWriter().writeStartElement("p"); xmlWriter().writeAttribute("outputclass","h3"); xmlWriter().writeCharacters("Miscellaneous"); xmlWriter().writeEndElement(); //

xmlWriter().writeStartElement("ul"); foreach (const FakeNode *fakeNode, uncategorizedNodeMap) { QString title = fakeNode->fullTitle(); if (title.startsWith("The ")) title.remove(0, 4); xmlWriter().writeStartElement("li"); xmlWriter().writeStartElement("xref"); xmlWriter().writeAttribute("href",linkForNode(fakeNode, relative)); writeCharacters(protectEnc(title)); xmlWriter().writeEndElement(); // xmlWriter().writeEndElement(); // } xmlWriter().writeEndElement(); // } } /*! Write the XML for a standard section of a page, e.g. "Public Functions" or "Protected Slots." The section is written too the current XML stream as a table. */ void DitaXmlGenerator::generateSection(const NodeList& nl, const Node* relative, CodeMarker* marker, CodeMarker::SynopsisStyle style) { if (!nl.isEmpty()) { xmlWriter().writeStartElement("ul"); NodeList::ConstIterator m = nl.begin(); while (m != nl.end()) { if ((*m)->access() != Node::Private) { xmlWriter().writeStartElement("li"); QString marked = getMarkedUpSynopsis(*m, relative, marker, style); writeText(marked, marker, relative); xmlWriter().writeEndElement(); // } ++m; } xmlWriter().writeEndElement(); // } } /*! Writes the "inherited from" list to the current XML stream. */ void DitaXmlGenerator::generateSectionInheritedList(const Section& section, const Node* relative, CodeMarker* marker) { if (section.inherited.isEmpty()) return; xmlWriter().writeStartElement("ul"); QList >::ConstIterator p = section.inherited.begin(); while (p != section.inherited.end()) { xmlWriter().writeStartElement("li"); QString text; text.setNum((*p).second); text += " "; if ((*p).second == 1) text += section.singularMember; else text += section.pluralMember; text += " inherited from "; writeCharacters(text); xmlWriter().writeStartElement("xref"); // zzz text = fileName((*p).first) + "#"; text += DitaXmlGenerator::cleanRef(section.name.toLower()); xmlWriter().writeAttribute("href",text); text = protectEnc(marker->plainFullName((*p).first, relative)); writeCharacters(text); xmlWriter().writeEndElement(); // xmlWriter().writeEndElement(); // ++p; } xmlWriter().writeEndElement(); // } /*! Get the synopsis from the \a node using the \a relative node if needed, and mark up the synopsis using \a marker. Use the style to decide which kind of sysnopsis to build, normally \c Summary or \c Detailed. Return the marked up string. */ QString DitaXmlGenerator::getMarkedUpSynopsis(const Node* node, const Node* relative, CodeMarker* marker, CodeMarker::SynopsisStyle style) { QString marked = marker->markedUpSynopsis(node, relative, style); QRegExp tag("(<[^@>]*>)"); if (marked.indexOf(tag) != -1) { QString tmp = protectEnc(marked.mid(tag.pos(1), tag.cap(1).length())); marked.replace(tag.pos(1), tag.cap(1).length(), tmp); } marked.replace(QRegExp("<@param>([a-z]+)_([1-9n])"), "\\1_\\2"); #if 0 marked.replace("<@param>",""); marked.replace("",""); #endif if (style == CodeMarker::Summary) { marked.replace("<@name>",""); // was "" marked.replace("",""); // was "" } if (style == CodeMarker::SeparateList) { QRegExp extraRegExp("<@extra>.*"); extraRegExp.setMinimal(true); marked.replace(extraRegExp,""); } #if 0 else { marked.replace("<@extra>",""); marked.replace("",""); } #endif if (style != CodeMarker::Detailed) { marked.replace("<@type>",""); marked.replace("",""); } return marked; } /*! Renamed from highlightedCode() in the html generator. Writes the \a markedCode to the current XML stream. */ void DitaXmlGenerator::writeText(const QString& markedCode, CodeMarker* marker, const Node* relative) { QString src = markedCode; QString html; QStringRef arg; QStringRef par1; const QChar charLangle = '<'; const QChar charAt = '@'; /* First strip out all the extraneous markup. The table below contains the markup we want to keep. Everything else that begins with "<@" or "", "<@type>", "<@headerfile>", "<@headerfile>", "<@func>", "<@func>", "<@param>", "<@param>", "<@extra>", "<@extra>", "", "", "", "", "", "", "", "", "", "", "", "" }; for (int i = 0, n = src.size(); i < n;) { if (src.at(i) == charLangle) { bool handled = false; for (int k = 0; k != 12; ++k) { const QString & tag = spanTags[2 * k]; if (tag == QStringRef(&src, i, tag.length())) { html += spanTags[2 * k + 1]; i += tag.length(); handled = true; break; } } if (!handled) { ++i; if (src.at(i) == charAt || (src.at(i) == QLatin1Char('/') && src.at(i + 1) == charAt)) { // drop 'our' unknown tags (the ones still containing '@') while (i < n && src.at(i) != QLatin1Char('>')) ++i; ++i; } else { // retain all others html += charLangle; } } } else { html += src.at(i); ++i; } } // replace all <@link> tags: "(<@link node=\"([^\"]+)\">).*()" // replace all "(<@(type|headerfile|func)(?: +[^>]*)?>)(.*)()" tags src = html; html = QString(); static const QString markTags[] = { // 0 1 2 3 4 5 "link", "type", "headerfile", "func", "param", "extra" }; for (int i = 0, n = src.size(); i < n;) { if (src.at(i) == charLangle && src.at(i + 1) == charAt) { i += 2; bool handled = false; for (int k = 0; k != 6; ++k) { if (parseArg(src, markTags[k], &i, n, &arg, &par1)) { const Node* n = 0; if (k == 0) { // <@link> if (!html.isEmpty()) { writeCharacters(html); html.clear(); } n = CodeMarker::nodeForString(par1.toString()); QString link = linkForNode(n, relative); addLink(link, arg); } else if (k == 4) { // <@param> if (!html.isEmpty()) { writeCharacters(html); html.clear(); } xmlWriter().writeStartElement("i"); writeCharacters(arg.toString()); xmlWriter().writeEndElement(); // } else if (k == 5) { // <@extra> if (!html.isEmpty()) { writeCharacters(html); html.clear(); } xmlWriter().writeStartElement("tt"); writeCharacters(arg.toString()); xmlWriter().writeEndElement(); // } else { if (!html.isEmpty()) { writeCharacters(html); html.clear(); } par1 = QStringRef(); QString link; n = marker->resolveTarget(arg.toString(), myTree, relative); if (n && n->subType() == Node::QmlBasicType) { if (relative && relative->subType() == Node::QmlClass) { link = linkForNode(n,relative); addLink(link, arg); } else { link = arg.toString(); } } else { // (zzz) Is this correct for all cases? link = linkForNode(n,relative); addLink(link, arg); } } handled = true; break; } } } else { html += src.at(i++); } } if (!html.isEmpty()) { writeCharacters(html); } } void DitaXmlGenerator::generateLink(const Atom* atom, const Node* /* relative */, CodeMarker* marker) { static QRegExp camelCase("[A-Z][A-Z][a-z]|[a-z][A-Z0-9]|_"); if (funcLeftParen.indexIn(atom->string()) != -1 && marker->recognizeLanguage("Cpp")) { // hack for C++: move () outside of link int k = funcLeftParen.pos(1); writeCharacters(protectEnc(atom->string().left(k))); if (link.isEmpty()) { if (showBrokenLinks) xmlWriter().writeEndElement(); // } else xmlWriter().writeEndElement(); // inLink = false; writeCharacters(protectEnc(atom->string().mid(k))); } else if (marker->recognizeLanguage("Java")) { // hack for Java: remove () and use when appropriate bool func = atom->string().endsWith("()"); bool tt = (func || atom->string().contains(camelCase)); if (tt) xmlWriter().writeStartElement("tt"); if (func) writeCharacters(protectEnc(atom->string().left(atom->string().length() - 2))); else writeCharacters(protectEnc(atom->string())); xmlWriter().writeEndElement(); // } else writeCharacters(protectEnc(atom->string())); } QString DitaXmlGenerator::cleanRef(const QString& ref) { QString clean; if (ref.isEmpty()) return clean; clean.reserve(ref.size() + 20); const QChar c = ref[0]; const uint u = c.unicode(); if ((u >= 'a' && u <= 'z') || (u >= 'A' && u <= 'Z') || (u >= '0' && u <= '9')) { clean += c; } else if (u == '~') { clean += "dtor."; } else if (u == '_') { clean += "underscore."; } else { clean += "A"; } for (int i = 1; i < (int) ref.length(); i++) { const QChar c = ref[i]; const uint u = c.unicode(); if ((u >= 'a' && u <= 'z') || (u >= 'A' && u <= 'Z') || (u >= '0' && u <= '9') || u == '-' || u == '_' || u == ':' || u == '.') { clean += c; } else if (c.isSpace()) { clean += "-"; } else if (u == '!') { clean += "-not"; } else if (u == '&') { clean += "-and"; } else if (u == '<') { clean += "-lt"; } else if (u == '=') { clean += "-eq"; } else if (u == '>') { clean += "-gt"; } else if (u == '#') { clean += "#"; } else { clean += "-"; clean += QString::number((int)u, 16); } } return clean; } QString DitaXmlGenerator::registerRef(const QString& ref) { QString clean = DitaXmlGenerator::cleanRef(ref); for (;;) { QString& prevRef = refMap[clean.toLower()]; if (prevRef.isEmpty()) { prevRef = ref; break; } else if (prevRef == ref) break; #if 0 else qDebug() << "PREVREF:" << prevRef; #endif clean += "x"; } return clean; } /*! Calls protect() with the \a string. Returns the result. */ QString DitaXmlGenerator::protectEnc(const QString& string) { return protect(string, outputEncoding); } QString DitaXmlGenerator::protect(const QString& string, const QString& outputEncoding) { #define APPEND(x) \ if (xml.isEmpty()) { \ xml = string; \ xml.truncate(i); \ } \ xml += (x); QString xml; int n = string.length(); for (int i = 0; i < n; ++i) { QChar ch = string.at(i); if (ch == QLatin1Char('&')) { APPEND("&"); } else if (ch == QLatin1Char('<')) { APPEND("<"); } else if (ch == QLatin1Char('>')) { APPEND(">"); } else if (ch == QLatin1Char('"')) { APPEND("""); } else if ((outputEncoding == "ISO-8859-1" && ch.unicode() > 0x007F) || (ch == QLatin1Char('*') && i + 1 < n && string.at(i) == QLatin1Char('/')) || (ch == QLatin1Char('.') && i > 2 && string.at(i - 2) == QLatin1Char('.'))) { // we escape '*/' and the last dot in 'e.g.' and 'i.e.' for the Javadoc generator APPEND("&#x"); xml += QString::number(ch.unicode(), 16); xml += QLatin1Char(';'); } else { if (!xml.isEmpty()) xml += ch; } } if (!xml.isEmpty()) return xml; return string; #undef APPEND } /*! Constructs a file name appropriate for the \a node and returns the file name. */ QString DitaXmlGenerator::fileBase(const Node* node) const { QString result; result = PageGenerator::fileBase(node); #if 0 if (!node->isInnerNode()) { switch (node->status()) { case Node::Compat: result += "-qt3"; break; case Node::Obsolete: result += "-obsolete"; break; default: ; } } #endif return result; } QString DitaXmlGenerator::refForNode(const Node* node) { const FunctionNode* func; const TypedefNode* tdn; QString ref; switch (node->type()) { case Node::Namespace: case Node::Class: default: break; case Node::Enum: ref = node->name() + "-enum"; break; case Node::Typedef: tdn = static_cast(node); if (tdn->associatedEnum()) { return refForNode(tdn->associatedEnum()); } else { ref = node->name() + "-typedef"; } break; case Node::Function: func = static_cast(node); if (func->associatedProperty()) { return refForNode(func->associatedProperty()); } else { ref = func->name(); if (func->overloadNumber() != 1) ref += "-" + QString::number(func->overloadNumber()); } break; case Node::Fake: if (node->subType() != Node::QmlPropertyGroup) break; case Node::QmlProperty: case Node::Property: ref = node->name() + "-prop"; break; case Node::QmlSignal: ref = node->name() + "-signal"; break; case Node::QmlMethod: ref = node->name() + "-method"; break; case Node::Variable: ref = node->name() + "-var"; break; case Node::Target: return protectEnc(node->name()); } return registerRef(ref); } QString DitaXmlGenerator::guidForNode(const Node* node) { switch (node->type()) { case Node::Namespace: case Node::Class: default: break; case Node::Enum: return node->guid(); case Node::Typedef: { const TypedefNode* tdn = static_cast(node); if (tdn->associatedEnum()) return guidForNode(tdn->associatedEnum()); } return node->guid(); case Node::Function: { const FunctionNode* fn = static_cast(node); if (fn->associatedProperty()) { return guidForNode(fn->associatedProperty()); } else { QString ref = fn->name(); if (fn->overloadNumber() != 1) { ref += "-" + QString::number(fn->overloadNumber()); //qDebug() << "guidForNode() overloaded function:" << outFileName() << ref; } } return fn->guid(); } case Node::Fake: if (node->subType() != Node::QmlPropertyGroup) break; case Node::QmlProperty: case Node::Property: return node->guid(); case Node::QmlSignal: return node->guid(); case Node::QmlMethod: return node->guid(); case Node::Variable: return node->guid(); case Node::Target: return node->guid(); } return QString(); } /*! Constructs a file name appropriate for the \a node and returns it. If the \a node is not a fake node, or if it is a fake node but it is neither an external page node nor an image node, call the PageGenerator::fileName() function. */ QString DitaXmlGenerator::fileName(const Node* node) { if (node->type() == Node::Fake) { if (static_cast(node)->subType() == Node::ExternalPage) return node->name(); if (static_cast(node)->subType() == Node::Image) return node->name(); } return PageGenerator::fileName(node); } QString DitaXmlGenerator::linkForNode(const Node* node, const Node* relative) { if (node == 0 || node == relative) return QString(); if (!node->url().isEmpty()) return node->url(); if (fileBase(node).isEmpty()) return QString(); if (node->access() == Node::Private) return QString(); QString fn = fileName(node); QString link = fn; if (!node->isInnerNode() || node->subType() == Node::QmlPropertyGroup) { QString guid = guidForNode(node); if (relative && fn == fileName(relative) && guid == guidForNode(relative)) { return QString(); } link += "#"; link += guid; } return link; } QString DitaXmlGenerator::refForAtom(Atom* atom, const Node* /* node */) { if (atom->type() == Atom::SectionLeft) return Doc::canonicalTitle(Text::sectionHeading(atom).toString()); if (atom->type() == Atom::Target) return Doc::canonicalTitle(atom->string()); return QString(); } void DitaXmlGenerator::generateFullName(const Node* apparentNode, const Node* relative, CodeMarker* marker, const Node* actualNode) { if (actualNode == 0) actualNode = apparentNode; xmlWriter().writeStartElement("xref"); QString href = linkForNode(actualNode, relative); xmlWriter().writeAttribute("href",href); writeCharacters(protectEnc(fullName(apparentNode, relative, marker))); xmlWriter().writeEndElement(); // } void DitaXmlGenerator::findAllClasses(const InnerNode* node) { NodeList::const_iterator c = node->childNodes().constBegin(); while (c != node->childNodes().constEnd()) { if ((*c)->access() != Node::Private && (*c)->url().isEmpty()) { if ((*c)->type() == Node::Class && !(*c)->doc().isEmpty()) { QString className = (*c)->name(); if ((*c)->parent() && (*c)->parent()->type() == Node::Namespace && !(*c)->parent()->name().isEmpty()) className = (*c)->parent()->name()+"::"+className; if (!(static_cast(*c))->hideFromMainList()) { if ((*c)->status() == Node::Compat) { compatClasses.insert(className, *c); } else if ((*c)->status() == Node::Obsolete) { obsoleteClasses.insert(className, *c); } else { nonCompatClasses.insert(className, *c); if ((*c)->status() == Node::Main) mainClasses.insert(className, *c); } } QString moduleName = (*c)->moduleName(); if (moduleName == "Qt3SupportLight") { moduleClassMap[moduleName].insert((*c)->name(), *c); moduleName = "Qt3Support"; } if (!moduleName.isEmpty()) moduleClassMap[moduleName].insert((*c)->name(), *c); QString serviceName = (static_cast(*c))->serviceName(); if (!serviceName.isEmpty()) serviceClasses.insert(serviceName, *c); } else if ((*c)->type() == Node::Fake && (*c)->subType() == Node::QmlClass && !(*c)->doc().isEmpty()) { QString qmlClassName = (*c)->name(); qmlClasses.insert(qmlClassName,*c); } else if ((*c)->isInnerNode()) { findAllClasses(static_cast(*c)); } } ++c; } } /*! For generating the "New Classes... in 4.x" section on the What's New in 4.x" page. */ void DitaXmlGenerator::findAllSince(const InnerNode* node) { NodeList::const_iterator child = node->childNodes().constBegin(); while (child != node->childNodes().constEnd()) { QString sinceVersion = (*child)->since(); if (((*child)->access() != Node::Private) && !sinceVersion.isEmpty()) { NewSinceMaps::iterator nsmap = newSinceMaps.find(sinceVersion); if (nsmap == newSinceMaps.end()) nsmap = newSinceMaps.insert(sinceVersion,NodeMultiMap()); NewClassMaps::iterator ncmap = newClassMaps.find(sinceVersion); if (ncmap == newClassMaps.end()) ncmap = newClassMaps.insert(sinceVersion,NodeMap()); NewClassMaps::iterator nqcmap = newQmlClassMaps.find(sinceVersion); if (nqcmap == newQmlClassMaps.end()) nqcmap = newQmlClassMaps.insert(sinceVersion,NodeMap()); if ((*child)->type() == Node::Function) { FunctionNode *func = static_cast(*child); if ((func->status() > Node::Obsolete) && (func->metaness() != FunctionNode::Ctor) && (func->metaness() != FunctionNode::Dtor)) { nsmap.value().insert(func->name(),(*child)); } } else if ((*child)->url().isEmpty()) { if ((*child)->type() == Node::Class && !(*child)->doc().isEmpty()) { QString className = (*child)->name(); if ((*child)->parent() && (*child)->parent()->type() == Node::Namespace && !(*child)->parent()->name().isEmpty()) className = (*child)->parent()->name()+"::"+className; nsmap.value().insert(className,(*child)); ncmap.value().insert(className,(*child)); } else if ((*child)->subType() == Node::QmlClass) { QString className = (*child)->name(); if ((*child)->parent() && (*child)->parent()->type() == Node::Namespace && !(*child)->parent()->name().isEmpty()) className = (*child)->parent()->name()+"::"+className; nsmap.value().insert(className,(*child)); nqcmap.value().insert(className,(*child)); } } else { QString name = (*child)->name(); if ((*child)->parent() && (*child)->parent()->type() == Node::Namespace && !(*child)->parent()->name().isEmpty()) name = (*child)->parent()->name()+"::"+name; nsmap.value().insert(name,(*child)); } if ((*child)->isInnerNode()) { findAllSince(static_cast(*child)); } } ++child; } } void DitaXmlGenerator::findAllFunctions(const InnerNode* node) { NodeList::ConstIterator c = node->childNodes().begin(); while (c != node->childNodes().end()) { if ((*c)->access() != Node::Private) { if ((*c)->isInnerNode() && (*c)->url().isEmpty()) { findAllFunctions(static_cast(*c)); } else if ((*c)->type() == Node::Function) { const FunctionNode* func = static_cast(*c); if ((func->status() > Node::Obsolete) && !func->isInternal() && (func->metaness() != FunctionNode::Ctor) && (func->metaness() != FunctionNode::Dtor)) { funcIndex[(*c)->name()].insert(myTree->fullDocumentName((*c)->parent()), *c); } } } ++c; } } void DitaXmlGenerator::findAllLegaleseTexts(const InnerNode* node) { NodeList::ConstIterator c = node->childNodes().begin(); while (c != node->childNodes().end()) { if ((*c)->access() != Node::Private) { if (!(*c)->doc().legaleseText().isEmpty()) legaleseTexts.insertMulti((*c)->doc().legaleseText(), *c); if ((*c)->isInnerNode()) findAllLegaleseTexts(static_cast(*c)); } ++c; } } void DitaXmlGenerator::findAllNamespaces(const InnerNode* node) { NodeList::ConstIterator c = node->childNodes().begin(); while (c != node->childNodes().end()) { if ((*c)->access() != Node::Private) { if ((*c)->isInnerNode() && (*c)->url().isEmpty()) { findAllNamespaces(static_cast(*c)); if ((*c)->type() == Node::Namespace) { const NamespaceNode *nspace = static_cast(*c); // Ensure that the namespace's name is not empty (the root // namespace has no name). if (!nspace->name().isEmpty()) { namespaceIndex.insert(nspace->name(), *c); QString moduleName = (*c)->moduleName(); if (moduleName == "Qt3SupportLight") { moduleNamespaceMap[moduleName].insert((*c)->name(), *c); moduleName = "Qt3Support"; } if (!moduleName.isEmpty()) moduleNamespaceMap[moduleName].insert((*c)->name(), *c); } } } } ++c; } } int DitaXmlGenerator::hOffset(const Node* node) { switch (node->type()) { case Node::Namespace: case Node::Class: return 2; case Node::Fake: return 1; case Node::Enum: case Node::Typedef: case Node::Function: case Node::Property: default: return 3; } } bool DitaXmlGenerator::isThreeColumnEnumValueTable(const Atom* atom) { while (atom != 0 && !(atom->type() == Atom::ListRight && atom->string() == ATOM_LIST_VALUE)) { if (atom->type() == Atom::ListItemLeft && !matchAhead(atom, Atom::ListItemRight)) return true; atom = atom->next(); } return false; } const Node* DitaXmlGenerator::findNodeForTarget(const QString& target, const Node* relative, CodeMarker* marker, const Atom* atom) { const Node* node = 0; if (target.isEmpty()) { node = relative; } else if (target.endsWith(".html")) { node = myTree->root()->findNode(target, Node::Fake); } else if (marker) { node = marker->resolveTarget(target, myTree, relative); if (!node) node = myTree->findFakeNodeByTitle(target); if (!node && atom) { node = myTree->findUnambiguousTarget(target, *const_cast(&atom)); } } if (!node) relative->doc().location().warning(tr("Cannot link to '%1'").arg(target)); return node; } const QPair DitaXmlGenerator::anchorForNode(const Node* node) { QPair anchorPair; anchorPair.first = PageGenerator::fileName(node); if (node->type() == Node::Fake) { const FakeNode *fakeNode = static_cast(node); anchorPair.second = fakeNode->title(); } return anchorPair; } QString DitaXmlGenerator::getLink(const Atom* atom, const Node* relative, CodeMarker* marker, const Node** node) { QString link; *node = 0; inObsoleteLink = false; if (atom->string().contains(":") && (atom->string().startsWith("file:") || atom->string().startsWith("http:") || atom->string().startsWith("https:") || atom->string().startsWith("ftp:") || atom->string().startsWith("mailto:"))) { link = atom->string(); } else { QStringList path; if (atom->string().contains('#')) path = atom->string().split('#'); else path.append(atom->string()); Atom* targetAtom = 0; QString first = path.first().trimmed(); if (first.isEmpty()) { *node = relative; } else if (first.endsWith(".html")) { *node = myTree->root()->findNode(first, Node::Fake); } else { *node = marker->resolveTarget(first, myTree, relative); if (!*node) { *node = myTree->findFakeNodeByTitle(first); } if (!*node) { *node = myTree->findUnambiguousTarget(first, targetAtom); } } if (*node) { if (!(*node)->url().isEmpty()) { return (*node)->url(); } else { path.removeFirst(); } } else { *node = relative; } if (*node && (*node)->status() == Node::Obsolete) { if (relative && (relative->parent() != *node) && (relative->status() != Node::Obsolete)) { bool porting = false; if (relative->type() == Node::Fake) { const FakeNode* fake = static_cast(relative); if (fake->title().startsWith("Porting")) porting = true; } QString name = marker->plainFullName(relative); if (!porting && !name.startsWith("Q3")) { if (obsoleteLinks) { relative->doc().location().warning(tr("Link to obsolete item '%1' in %2") .arg(atom->string()) .arg(name)); } inObsoleteLink = true; } } } while (!path.isEmpty()) { targetAtom = myTree->findTarget(path.first(), *node); if (targetAtom == 0) break; path.removeFirst(); } if (path.isEmpty()) { link = linkForNode(*node, relative); if (*node && (*node)->subType() == Node::Image) link = "images/used-in-examples/" + link; if (targetAtom) { if (link.isEmpty()) link = outFileName(); QString guid = lookupGuid(link,refForAtom(targetAtom,*node)); link += "#" + guid; } #if 0 else if (link.isEmpty() && *node) { link = outFileName() + "#" + (*node)->guid(); } #endif else if (!link.isEmpty() && *node && link.endsWith(".xml")) { link += "#" + (*node)->guid(); } } } if (!link.isEmpty() && link[0] == '#') { link.prepend(outFileName()); qDebug() << "LOCAL LINK:" << link; } return link; } void DitaXmlGenerator::generateIndex(const QString& fileBase, const QString& url, const QString& title) { myTree->generateIndex(outputDir() + "/" + fileBase + ".index", url, title); } void DitaXmlGenerator::generateStatus(const Node* node, CodeMarker* marker) { Text text; switch (node->status()) { case Node::Obsolete: if (node->isInnerNode()) Generator::generateStatus(node, marker); break; case Node::Compat: if (node->isInnerNode()) { text << Atom::ParaLeft << Atom(Atom::FormattingLeft,ATOM_FORMATTING_BOLD) << "This " << typeString(node) << " is part of the Qt 3 support library." << Atom(Atom::FormattingRight, ATOM_FORMATTING_BOLD) << " It is provided to keep old source code working. " << "We strongly advise against " << "using it in new code. See "; const FakeNode *fakeNode = myTree->findFakeNodeByTitle("Porting To Qt 4"); Atom *targetAtom = 0; if (fakeNode && node->type() == Node::Class) { QString oldName(node->name()); targetAtom = myTree->findTarget(oldName.replace("3",""),fakeNode); } if (targetAtom) { QString fn = fileName(fakeNode); QString guid = lookupGuid(fn,refForAtom(targetAtom,fakeNode)); text << Atom(Atom::GuidLink, fn + "#" + guid); } else text << Atom(Atom::Link, "Porting to Qt 4"); text << Atom(Atom::FormattingLeft, ATOM_FORMATTING_LINK) << Atom(Atom::String, "Porting to Qt 4") << Atom(Atom::FormattingRight, ATOM_FORMATTING_LINK) << " for more information." << Atom::ParaRight; } generateText(text, node, marker); break; default: Generator::generateStatus(node, marker); } } void DitaXmlGenerator::beginLink(const QString& link) { this->link = link; if (link.isEmpty()) return; xmlWriter().writeStartElement("xref"); xmlWriter().writeAttribute("href",link); inLink = true; } void DitaXmlGenerator::endLink() { if (inLink) { if (link.isEmpty()) { if (showBrokenLinks) xmlWriter().writeEndElement(); // } else { if (inObsoleteLink) { xmlWriter().writeStartElement("sup"); xmlWriter().writeCharacters("(obsolete)"); xmlWriter().writeEndElement(); // } xmlWriter().writeEndElement(); // } } inLink = false; inObsoleteLink = false; } /*! Generates the summary for the \a section. Only used for sections of QML element documentation. Currently handles only the QML property group. */ void DitaXmlGenerator::generateQmlSummary(const Section& section, const Node* relative, CodeMarker* marker) { if (!section.members.isEmpty()) { xmlWriter().writeStartElement("ul"); NodeList::ConstIterator m; m = section.members.begin(); while (m != section.members.end()) { xmlWriter().writeStartElement("li"); generateQmlItem(*m,relative,marker,true); xmlWriter().writeEndElement(); // ++m; } xmlWriter().writeEndElement(); // } } /*! zzz Outputs the html detailed documentation for a section on a QML element reference page. */ void DitaXmlGenerator::generateDetailedQmlMember(const Node* node, const InnerNode* relative, CodeMarker* marker) { QString marked; const QmlPropertyNode* qpn = 0; if (node->subType() == Node::QmlPropertyGroup) { const QmlPropGroupNode* qpgn = static_cast(node); NodeList::ConstIterator p = qpgn->childNodes().begin(); xmlWriter().writeStartElement("ul"); while (p != qpgn->childNodes().end()) { if ((*p)->type() == Node::QmlProperty) { qpn = static_cast(*p); xmlWriter().writeStartElement("li"); writeGuidAttribute((Node*)qpn); QString attr; if (!qpn->isWritable(myTree)) attr = "read-only"; if (qpgn->isDefault()) { if (!attr.isEmpty()) attr += " "; attr += "default"; } if (!attr.isEmpty()) xmlWriter().writeAttribute("outputclass",attr); generateQmlItem(qpn, relative, marker, false); xmlWriter().writeEndElement(); // } ++p; } xmlWriter().writeEndElement(); // } else if (node->type() == Node::QmlSignal) { Node* n = const_cast(node); xmlWriter().writeStartElement("ul"); xmlWriter().writeStartElement("li"); writeGuidAttribute(n); marked = getMarkedUpSynopsis(n, relative, marker, CodeMarker::Detailed); writeText(marked, marker, relative); xmlWriter().writeEndElement(); // xmlWriter().writeEndElement(); // } else if (node->type() == Node::QmlMethod) { Node* n = const_cast(node); xmlWriter().writeStartElement("ul"); xmlWriter().writeStartElement("li"); writeGuidAttribute(n); marked = getMarkedUpSynopsis(n, relative, marker, CodeMarker::Detailed); writeText(marked, marker, relative); xmlWriter().writeEndElement(); // xmlWriter().writeEndElement(); // } generateStatus(node, marker); generateBody(node, marker); generateThreadSafeness(node, marker); generateSince(node, marker); generateAlsoList(node, marker); } /*! Output the "Inherits" line for the QML element, if there should be one. */ void DitaXmlGenerator::generateQmlInherits(const QmlClassNode* cn, CodeMarker* marker) { if (cn && !cn->links().empty()) { if (cn->links().contains(Node::InheritsLink)) { QPair linkPair; linkPair = cn->links()[Node::InheritsLink]; QStringList strList(linkPair.first); const Node* n = myTree->findNode(strList,Node::Fake); if (n && n->subType() == Node::QmlClass) { const QmlClassNode* qcn = static_cast(n); xmlWriter().writeStartElement("p"); xmlWriter().writeAttribute("outputclass","inherits"); Text text; text << "[Inherits "; text << Atom(Atom::LinkNode,CodeMarker::stringForNode(qcn)); text << Atom(Atom::FormattingLeft, ATOM_FORMATTING_LINK); text << Atom(Atom::String, linkPair.second); text << Atom(Atom::FormattingRight, ATOM_FORMATTING_LINK); text << "]"; generateText(text, cn, marker); xmlWriter().writeEndElement(); //

} } } } /*! Output the "Inherit by" list for the QML element, if it is inherited by any other elements. */ void DitaXmlGenerator::generateQmlInheritedBy(const QmlClassNode* cn, CodeMarker* marker) { if (cn) { NodeList subs; QmlClassNode::subclasses(cn->name(),subs); if (!subs.isEmpty()) { Text text; text << Atom::ParaLeft << "Inherited by "; appendSortedQmlNames(text,cn,subs,marker); text << Atom::ParaRight; generateText(text, cn, marker); } } } /*! Output the "[Xxx instantiates the C++ class QmlGraphicsXxx]" line for the QML element, if there should be one. If there is no class node, or if the class node status is set to Node::Internal, do nothing. */ void DitaXmlGenerator::generateQmlInstantiates(const QmlClassNode* qcn, CodeMarker* marker) { const ClassNode* cn = qcn->classNode(); if (cn && (cn->status() != Node::Internal)) { xmlWriter().writeStartElement("p"); xmlWriter().writeAttribute("outputclass","instantiates"); Text text; text << "["; text << Atom(Atom::LinkNode,CodeMarker::stringForNode(qcn)); text << Atom(Atom::FormattingLeft, ATOM_FORMATTING_LINK); text << Atom(Atom::String, qcn->name()); text << Atom(Atom::FormattingRight, ATOM_FORMATTING_LINK); text << " instantiates the C++ class "; text << Atom(Atom::LinkNode,CodeMarker::stringForNode(cn)); text << Atom(Atom::FormattingLeft, ATOM_FORMATTING_LINK); text << Atom(Atom::String, cn->name()); text << Atom(Atom::FormattingRight, ATOM_FORMATTING_LINK); text << "]"; generateText(text, qcn, marker); xmlWriter().writeEndElement(); //

} } /*! Output the "[QmlGraphicsXxx is instantiated by QML element Xxx]" line for the class, if there should be one. If there is no QML element, or if the class node status is set to Node::Internal, do nothing. */ void DitaXmlGenerator::generateInstantiatedBy(const ClassNode* cn, CodeMarker* marker) { if (cn && cn->status() != Node::Internal && !cn->qmlElement().isEmpty()) { const Node* n = myTree->root()->findNode(cn->qmlElement(),Node::Fake); if (n && n->subType() == Node::QmlClass) { xmlWriter().writeStartElement("p"); xmlWriter().writeAttribute("outputclass","instantiated-by"); Text text; text << "["; text << Atom(Atom::LinkNode,CodeMarker::stringForNode(cn)); text << Atom(Atom::FormattingLeft, ATOM_FORMATTING_LINK); text << Atom(Atom::String, cn->name()); text << Atom(Atom::FormattingRight, ATOM_FORMATTING_LINK); text << " is instantiated by QML element "; text << Atom(Atom::LinkNode,CodeMarker::stringForNode(n)); text << Atom(Atom::FormattingLeft, ATOM_FORMATTING_LINK); text << Atom(Atom::String, n->name()); text << Atom(Atom::FormattingRight, ATOM_FORMATTING_LINK); text << "]"; generateText(text, cn, marker); xmlWriter().writeEndElement(); //

} } } /*! Return the full qualification of the node \a n, but without the name of \a n itself. e.g. A::B::C */ QString DitaXmlGenerator::fullQualification(const Node* n) { QString fq; InnerNode* in = n->parent(); while (in) { if ((in->type() == Node::Class) || (in->type() == Node::Namespace)) { if (in->name().isEmpty()) break; if (fq.isEmpty()) fq = in->name(); else fq = in->name() + "::" + fq; } else break; in = in->parent(); } return fq; } /*! Outputs the element. \code ... ... \endcode The element is: \code Base \endcode */ void DitaXmlGenerator::writeDerivations(const ClassNode* cn, CodeMarker* marker) { QList::ConstIterator r; int index; if (!cn->baseClasses().isEmpty()) { xmlWriter().writeStartElement(CXXCLASSDERIVATIONS); r = cn->baseClasses().begin(); index = 0; while (r != cn->baseClasses().end()) { xmlWriter().writeStartElement(CXXCLASSDERIVATION); xmlWriter().writeStartElement(CXXCLASSDERIVATIONACCESSSPECIFIER); xmlWriter().writeAttribute("value",(*r).accessString()); xmlWriter().writeEndElement(); // // not included: xmlWriter().writeStartElement(CXXCLASSBASECLASS); QString attr = fileName((*r).node) + "#" + (*r).node->guid(); xmlWriter().writeAttribute("href",attr); writeCharacters(marker->plainFullName((*r).node)); xmlWriter().writeEndElement(); // // not included: or xmlWriter().writeEndElement(); // // not included: ++r; } xmlWriter().writeEndElement(); // } } /*! Writes a element, depending on the type of the node \a n, which can be a class, function, enum, typedef, or property. */ void DitaXmlGenerator::writeLocation(const Node* n) { QString s1, s2, s3, s4, s5, s6; if (n->type() == Node::Class || n->type() == Node::Namespace) { s1 = CXXCLASSAPIITEMLOCATION; s2 = CXXCLASSDECLARATIONFILE; s3 = CXXCLASSDECLARATIONFILELINE; } else if (n->type() == Node::Function) { FunctionNode* fn = const_cast(static_cast(n)); if (fn->isMacro()) { s1 = CXXDEFINEAPIITEMLOCATION; s2 = CXXDEFINEDECLARATIONFILE; s3 = CXXDEFINEDECLARATIONFILELINE; } else { s1 = CXXFUNCTIONAPIITEMLOCATION; s2 = CXXFUNCTIONDECLARATIONFILE; s3 = CXXFUNCTIONDECLARATIONFILELINE; } } else if (n->type() == Node::Enum) { s1 = CXXENUMERATIONAPIITEMLOCATION; s2 = CXXENUMERATIONDECLARATIONFILE; s3 = CXXENUMERATIONDECLARATIONFILELINE; s4 = CXXENUMERATIONDEFINITIONFILE; s5 = CXXENUMERATIONDEFINITIONFILELINESTART; s6 = CXXENUMERATIONDEFINITIONFILELINEEND; } else if (n->type() == Node::Typedef) { s1 = CXXTYPEDEFAPIITEMLOCATION; s2 = CXXTYPEDEFDECLARATIONFILE; s3 = CXXTYPEDEFDECLARATIONFILELINE; } else if ((n->type() == Node::Property) || (n->type() == Node::Variable)) { s1 = CXXVARIABLEAPIITEMLOCATION; s2 = CXXVARIABLEDECLARATIONFILE; s3 = CXXVARIABLEDECLARATIONFILELINE; } xmlWriter().writeStartElement(s1); xmlWriter().writeStartElement(s2); xmlWriter().writeAttribute("name","filePath"); xmlWriter().writeAttribute("value",n->location().filePath()); xmlWriter().writeEndElement(); // DeclarationFile> xmlWriter().writeStartElement(s3); xmlWriter().writeAttribute("name","lineNumber"); QString lineNr; xmlWriter().writeAttribute("value",lineNr.setNum(n->location().lineNo())); xmlWriter().writeEndElement(); // DeclarationFileLine> if (!s4.isEmpty()) { // zzz This stuff is temporary, I think. xmlWriter().writeStartElement(s4); xmlWriter().writeAttribute("name","filePath"); xmlWriter().writeAttribute("value",n->location().filePath()); xmlWriter().writeEndElement(); // DefinitionFile> xmlWriter().writeStartElement(s5); xmlWriter().writeAttribute("name","lineNumber"); xmlWriter().writeAttribute("value",lineNr.setNum(n->location().lineNo())); xmlWriter().writeEndElement(); // DefinitionFileLineStart> xmlWriter().writeStartElement(s6); xmlWriter().writeAttribute("name","lineNumber"); xmlWriter().writeAttribute("value",lineNr.setNum(n->location().lineNo())); xmlWriter().writeEndElement(); // DefinitionFileLineEnd> } // not included: , , // and xmlWriter().writeEndElement(); // ApiItemLocation> } /*! Write the elements. */ void DitaXmlGenerator::writeFunctions(const Section& s, const Node* n, CodeMarker* marker, const QString& attribute) { NodeList::ConstIterator m = s.members.begin(); while (m != s.members.end()) { if ((*m)->type() == Node::Function) { FunctionNode* fn = const_cast(static_cast(*m)); xmlWriter().writeStartElement(CXXFUNCTION); xmlWriter().writeAttribute("id",fn->guid()); if (!attribute.isEmpty()) xmlWriter().writeAttribute("outputclass",attribute); xmlWriter().writeStartElement("apiName"); if (fn->metaness() == FunctionNode::Signal) xmlWriter().writeAttribute("class","signal"); else if (fn->metaness() == FunctionNode::Slot) xmlWriter().writeAttribute("class","slot"); writeCharacters(fn->name()); xmlWriter().writeEndElement(); // generateBrief(fn,marker); // not included: xmlWriter().writeStartElement(CXXFUNCTIONDETAIL); xmlWriter().writeStartElement(CXXFUNCTIONDEFINITION); xmlWriter().writeStartElement(CXXFUNCTIONACCESSSPECIFIER); xmlWriter().writeAttribute("value",fn->accessString()); xmlWriter().writeEndElement(); // // not included: if (fn->isStatic()) { xmlWriter().writeStartElement(CXXFUNCTIONSTORAGECLASSSPECIFIERSTATIC); xmlWriter().writeAttribute("name","static"); xmlWriter().writeAttribute("value","static"); xmlWriter().writeEndElement(); // } // not included: , if (fn->isConst()) { xmlWriter().writeStartElement(CXXFUNCTIONCONST); xmlWriter().writeAttribute("name","const"); xmlWriter().writeAttribute("value","const"); xmlWriter().writeEndElement(); // } // not included: // virtualness() != FunctionNode::NonVirtual) { xmlWriter().writeStartElement(CXXFUNCTIONVIRTUAL); xmlWriter().writeAttribute("name","virtual"); xmlWriter().writeAttribute("value","virtual"); xmlWriter().writeEndElement(); // if (fn->virtualness() == FunctionNode::PureVirtual) { xmlWriter().writeStartElement(CXXFUNCTIONPUREVIRTUAL); xmlWriter().writeAttribute("name","pure virtual"); xmlWriter().writeAttribute("value","pure virtual"); xmlWriter().writeEndElement(); // } } if (fn->name() == n->name()) { xmlWriter().writeStartElement(CXXFUNCTIONCONSTRUCTOR); xmlWriter().writeAttribute("name","constructor"); xmlWriter().writeAttribute("value","constructor"); xmlWriter().writeEndElement(); // } else if (fn->name()[0] == QChar('~')) { xmlWriter().writeStartElement(CXXFUNCTIONDESTRUCTOR); xmlWriter().writeAttribute("name","destructor"); xmlWriter().writeAttribute("value","destructor"); xmlWriter().writeEndElement(); // } else { xmlWriter().writeStartElement(CXXFUNCTIONDECLAREDTYPE); writeCharacters(fn->returnType()); xmlWriter().writeEndElement(); // } // not included: QString fq = fullQualification(fn); if (!fq.isEmpty()) { xmlWriter().writeStartElement(CXXFUNCTIONSCOPEDNAME); writeCharacters(fq); xmlWriter().writeEndElement(); // } xmlWriter().writeStartElement(CXXFUNCTIONPROTOTYPE); writeCharacters(fn->signature(true)); xmlWriter().writeEndElement(); // QString fnl = fn->signature(false); int idx = fnl.indexOf(' '); if (idx < 0) idx = 0; else ++idx; fnl = fn->parent()->name() + "::" + fnl.mid(idx); xmlWriter().writeStartElement(CXXFUNCTIONNAMELOOKUP); writeCharacters(fnl); xmlWriter().writeEndElement(); // if (!fn->isInternal() && fn->isReimp() && fn->reimplementedFrom() != 0) { FunctionNode* rfn = (FunctionNode*)fn->reimplementedFrom(); if (rfn && !rfn->isInternal()) { xmlWriter().writeStartElement(CXXFUNCTIONREIMPLEMENTED); xmlWriter().writeAttribute("href",rfn->ditaXmlHref()); writeCharacters(marker->plainFullName(rfn)); xmlWriter().writeEndElement(); // } } writeParameters(fn); writeLocation(fn); xmlWriter().writeEndElement(); // writeDetailedDescription(fn, marker, true, QString()); // generateAlsoList(inner, marker); // not included: or xmlWriter().writeEndElement(); // xmlWriter().writeEndElement(); // if (fn->metaness() == FunctionNode::Ctor || fn->metaness() == FunctionNode::Dtor || fn->overloadNumber() != 1) { } } ++m; } } /*! This function writes the element. */ void DitaXmlGenerator::writeParameters(const FunctionNode* fn) { const QList& parameters = fn->parameters(); if (!parameters.isEmpty()) { xmlWriter().writeStartElement(CXXFUNCTIONPARAMETERS); QList::ConstIterator p = parameters.begin(); while (p != parameters.end()) { xmlWriter().writeStartElement(CXXFUNCTIONPARAMETER); xmlWriter().writeStartElement(CXXFUNCTIONPARAMETERDECLAREDTYPE); writeCharacters((*p).leftType()); if (!(*p).rightType().isEmpty()) writeCharacters((*p).rightType()); xmlWriter().writeEndElement(); // xmlWriter().writeStartElement(CXXFUNCTIONPARAMETERDECLARATIONNAME); writeCharacters((*p).name()); xmlWriter().writeEndElement(); // // not included: if (!(*p).defaultValue().isEmpty()) { xmlWriter().writeStartElement(CXXFUNCTIONPARAMETERDEFAULTVALUE); writeCharacters((*p).defaultValue()); xmlWriter().writeEndElement(); // } // not included: xmlWriter().writeEndElement(); // ++p; } xmlWriter().writeEndElement(); // } } /*! This function writes the enum types. */ void DitaXmlGenerator::writeEnumerations(const Section& s, CodeMarker* marker, const QString& attribute) { NodeList::ConstIterator m = s.members.begin(); while (m != s.members.end()) { if ((*m)->type() == Node::Enum) { const EnumNode* en = static_cast(*m); xmlWriter().writeStartElement(CXXENUMERATION); xmlWriter().writeAttribute("id",en->guid()); if (!attribute.isEmpty()) xmlWriter().writeAttribute("outputclass",attribute); xmlWriter().writeStartElement("apiName"); writeCharacters(en->name()); xmlWriter().writeEndElement(); // generateBrief(en,marker); // not included xmlWriter().writeStartElement(CXXENUMERATIONDETAIL); xmlWriter().writeStartElement(CXXENUMERATIONDEFINITION); xmlWriter().writeStartElement(CXXENUMERATIONACCESSSPECIFIER); xmlWriter().writeAttribute("value",en->accessString()); xmlWriter().writeEndElement(); // QString fq = fullQualification(en); if (!fq.isEmpty()) { xmlWriter().writeStartElement(CXXENUMERATIONSCOPEDNAME); writeCharacters(fq); xmlWriter().writeEndElement(); // } const QList& items = en->items(); if (!items.isEmpty()) { xmlWriter().writeStartElement(CXXENUMERATIONPROTOTYPE); writeCharacters(en->name()); xmlWriter().writeCharacters(" = { "); QList::ConstIterator i = items.begin(); while (i != items.end()) { writeCharacters((*i).name()); if (!(*i).value().isEmpty()) { xmlWriter().writeCharacters(" = "); writeCharacters((*i).value()); } ++i; if (i != items.end()) xmlWriter().writeCharacters(", "); } xmlWriter().writeCharacters(" }"); xmlWriter().writeEndElement(); // } xmlWriter().writeStartElement(CXXENUMERATIONNAMELOOKUP); writeCharacters(en->parent()->name() + "::" + en->name()); xmlWriter().writeEndElement(); // // not included: if (!items.isEmpty()) { xmlWriter().writeStartElement(CXXENUMERATORS); QList::ConstIterator i = items.begin(); while (i != items.end()) { xmlWriter().writeStartElement(CXXENUMERATOR); xmlWriter().writeStartElement("apiName"); writeCharacters((*i).name()); xmlWriter().writeEndElement(); // QString fq = fullQualification(en->parent()); if (!fq.isEmpty()) { xmlWriter().writeStartElement(CXXENUMERATORSCOPEDNAME); writeCharacters(fq + "::" + (*i).name()); xmlWriter().writeEndElement(); // } xmlWriter().writeStartElement(CXXENUMERATORPROTOTYPE); writeCharacters((*i).name()); xmlWriter().writeEndElement(); // xmlWriter().writeStartElement(CXXENUMERATORNAMELOOKUP); writeCharacters(en->parent()->name() + "::" + (*i).name()); xmlWriter().writeEndElement(); // if (!(*i).value().isEmpty()) { xmlWriter().writeStartElement(CXXENUMERATORINITIALISER); xmlWriter().writeAttribute("value", (*i).value()); xmlWriter().writeEndElement(); // } // not included: if (!(*i).text().isEmpty()) { xmlWriter().writeStartElement("apiDesc"); generateText((*i).text(), en, marker); xmlWriter().writeEndElement(); // } xmlWriter().writeEndElement(); // ++i; } xmlWriter().writeEndElement(); // } writeLocation(en); xmlWriter().writeEndElement(); // writeDetailedDescription(en, marker, true, QString()); // not included: or xmlWriter().writeEndElement(); // // not included: xmlWriter().writeEndElement(); // } ++m; } } /*! This function writes the output for the \typedef commands. */ void DitaXmlGenerator::writeTypedefs(const Section& s, CodeMarker* marker, const QString& attribute) { NodeList::ConstIterator m = s.members.begin(); while (m != s.members.end()) { if ((*m)->type() == Node::Typedef) { const TypedefNode* tn = static_cast(*m); xmlWriter().writeStartElement(CXXTYPEDEF); xmlWriter().writeAttribute("id",tn->guid()); if (!attribute.isEmpty()) xmlWriter().writeAttribute("outputclass",attribute); xmlWriter().writeStartElement("apiName"); writeCharacters(tn->name()); xmlWriter().writeEndElement(); // generateBrief(tn,marker); // not included: xmlWriter().writeStartElement(CXXTYPEDEFDETAIL); xmlWriter().writeStartElement(CXXTYPEDEFDEFINITION); xmlWriter().writeStartElement(CXXTYPEDEFACCESSSPECIFIER); xmlWriter().writeAttribute("value",tn->accessString()); xmlWriter().writeEndElement(); // // not included: QString fq = fullQualification(tn); if (!fq.isEmpty()) { xmlWriter().writeStartElement(CXXTYPEDEFSCOPEDNAME); writeCharacters(fq); xmlWriter().writeEndElement(); // } // not included: xmlWriter().writeStartElement(CXXTYPEDEFNAMELOOKUP); writeCharacters(tn->parent()->name() + "::" + tn->name()); xmlWriter().writeEndElement(); // // not included: writeLocation(tn); xmlWriter().writeEndElement(); // writeDetailedDescription(tn, marker, true, QString()); // not included: or xmlWriter().writeEndElement(); // // not included: xmlWriter().writeEndElement(); // } ++m; } } /*! This function writes the output for the \property commands. This is the Q_PROPERTYs. */ void DitaXmlGenerator::writeProperties(const Section& s, CodeMarker* marker, const QString& attribute) { NodeList::ConstIterator m = s.members.begin(); while (m != s.members.end()) { if ((*m)->type() == Node::Property) { const PropertyNode* pn = static_cast(*m); xmlWriter().writeStartElement(CXXVARIABLE); xmlWriter().writeAttribute("id",pn->guid()); if (!attribute.isEmpty()) xmlWriter().writeAttribute("outputclass",attribute); xmlWriter().writeStartElement("apiName"); writeCharacters(pn->name()); xmlWriter().writeEndElement(); // generateBrief(pn,marker); // not included: xmlWriter().writeStartElement(CXXVARIABLEDETAIL); xmlWriter().writeStartElement(CXXVARIABLEDEFINITION); xmlWriter().writeStartElement(CXXVARIABLEACCESSSPECIFIER); xmlWriter().writeAttribute("value",pn->accessString()); xmlWriter().writeEndElement(); // // not included: , // , // , // , if (!pn->qualifiedDataType().isEmpty()) { xmlWriter().writeStartElement(CXXVARIABLEDECLAREDTYPE); writeCharacters(pn->qualifiedDataType()); xmlWriter().writeEndElement(); // } QString fq = fullQualification(pn); if (!fq.isEmpty()) { xmlWriter().writeStartElement(CXXVARIABLESCOPEDNAME); writeCharacters(fq); xmlWriter().writeEndElement(); // } xmlWriter().writeStartElement(CXXVARIABLEPROTOTYPE); xmlWriter().writeCharacters("Q_PROPERTY("); writeCharacters(pn->qualifiedDataType()); xmlWriter().writeCharacters(" "); writeCharacters(pn->name()); writePropertyParameter("READ",pn->getters()); writePropertyParameter("WRITE",pn->setters()); writePropertyParameter("RESET",pn->resetters()); writePropertyParameter("NOTIFY",pn->notifiers()); if (pn->isDesignable() != pn->designableDefault()) { xmlWriter().writeCharacters(" DESIGNABLE "); if (!pn->runtimeDesignabilityFunction().isEmpty()) writeCharacters(pn->runtimeDesignabilityFunction()); else xmlWriter().writeCharacters(pn->isDesignable() ? "true" : "false"); } if (pn->isScriptable() != pn->scriptableDefault()) { xmlWriter().writeCharacters(" SCRIPTABLE "); if (!pn->runtimeScriptabilityFunction().isEmpty()) writeCharacters(pn->runtimeScriptabilityFunction()); else xmlWriter().writeCharacters(pn->isScriptable() ? "true" : "false"); } if (pn->isWritable() != pn->writableDefault()) { xmlWriter().writeCharacters(" STORED "); xmlWriter().writeCharacters(pn->isStored() ? "true" : "false"); } if (pn->isUser() != pn->userDefault()) { xmlWriter().writeCharacters(" USER "); xmlWriter().writeCharacters(pn->isUser() ? "true" : "false"); } if (pn->isConstant()) xmlWriter().writeCharacters(" CONSTANT"); if (pn->isFinal()) xmlWriter().writeCharacters(" FINAL"); xmlWriter().writeCharacters(")"); xmlWriter().writeEndElement(); // xmlWriter().writeStartElement(CXXVARIABLENAMELOOKUP); writeCharacters(pn->parent()->name() + "::" + pn->name()); xmlWriter().writeEndElement(); // if (pn->overriddenFrom() != 0) { PropertyNode* opn = (PropertyNode*)pn->overriddenFrom(); xmlWriter().writeStartElement(CXXVARIABLEREIMPLEMENTED); xmlWriter().writeAttribute("href",opn->ditaXmlHref()); writeCharacters(marker->plainFullName(opn)); xmlWriter().writeEndElement(); // } writeLocation(pn); xmlWriter().writeEndElement(); // writeDetailedDescription(pn, marker, true, QString()); // not included: or xmlWriter().writeEndElement(); // // not included: xmlWriter().writeEndElement(); // } ++m; } } /*! This function outputs the nodes resulting from \variable commands. */ void DitaXmlGenerator::writeDataMembers(const Section& s, CodeMarker* marker, const QString& attribute) { NodeList::ConstIterator m = s.members.begin(); while (m != s.members.end()) { if ((*m)->type() == Node::Variable) { const VariableNode* vn = static_cast(*m); xmlWriter().writeStartElement(CXXVARIABLE); xmlWriter().writeAttribute("id",vn->guid()); if (!attribute.isEmpty()) xmlWriter().writeAttribute("outputclass",attribute); xmlWriter().writeStartElement("apiName"); writeCharacters(vn->name()); xmlWriter().writeEndElement(); // generateBrief(vn,marker); // not included: xmlWriter().writeStartElement(CXXVARIABLEDETAIL); xmlWriter().writeStartElement(CXXVARIABLEDEFINITION); xmlWriter().writeStartElement(CXXVARIABLEACCESSSPECIFIER); xmlWriter().writeAttribute("value",vn->accessString()); xmlWriter().writeEndElement(); // // not included: if (vn->isStatic()) { xmlWriter().writeStartElement(CXXVARIABLESTORAGECLASSSPECIFIERSTATIC); xmlWriter().writeAttribute("name","static"); xmlWriter().writeAttribute("value","static"); xmlWriter().writeEndElement(); // } // not included: , // , xmlWriter().writeStartElement(CXXVARIABLEDECLAREDTYPE); writeCharacters(vn->leftType()); if (!vn->rightType().isEmpty()) writeCharacters(vn->rightType()); xmlWriter().writeEndElement(); // QString fq = fullQualification(vn); if (!fq.isEmpty()) { xmlWriter().writeStartElement(CXXVARIABLESCOPEDNAME); writeCharacters(fq); xmlWriter().writeEndElement(); // } xmlWriter().writeStartElement(CXXVARIABLEPROTOTYPE); writeCharacters(vn->leftType() + " "); //writeCharacters(vn->parent()->name() + "::" + vn->name()); writeCharacters(vn->name()); if (!vn->rightType().isEmpty()) writeCharacters(vn->rightType()); xmlWriter().writeEndElement(); // xmlWriter().writeStartElement(CXXVARIABLENAMELOOKUP); writeCharacters(vn->parent()->name() + "::" + vn->name()); xmlWriter().writeEndElement(); // // not included: writeLocation(vn); xmlWriter().writeEndElement(); // writeDetailedDescription(vn, marker, true, QString()); // not included: or xmlWriter().writeEndElement(); // // not included: xmlWriter().writeEndElement(); // } ++m; } } /*! This function writes a \macro as a . */ void DitaXmlGenerator::writeMacros(const Section& s, CodeMarker* marker, const QString& attribute) { NodeList::ConstIterator m = s.members.begin(); while (m != s.members.end()) { if ((*m)->type() == Node::Function) { const FunctionNode* fn = static_cast(*m); if (fn->isMacro()) { xmlWriter().writeStartElement(CXXDEFINE); xmlWriter().writeAttribute("id",fn->guid()); if (!attribute.isEmpty()) xmlWriter().writeAttribute("outputclass",attribute); xmlWriter().writeStartElement("apiName"); writeCharacters(fn->name()); xmlWriter().writeEndElement(); // generateBrief(fn,marker); // not included: xmlWriter().writeStartElement(CXXDEFINEDETAIL); xmlWriter().writeStartElement(CXXDEFINEDEFINITION); xmlWriter().writeStartElement(CXXDEFINEACCESSSPECIFIER); xmlWriter().writeAttribute("value",fn->accessString()); xmlWriter().writeEndElement(); // xmlWriter().writeStartElement(CXXDEFINEPROTOTYPE); xmlWriter().writeCharacters("#define "); writeCharacters(fn->name()); if (fn->metaness() == FunctionNode::MacroWithParams) { QStringList params = fn->parameterNames(); if (!params.isEmpty()) { xmlWriter().writeCharacters("("); for (int i = 0; i < params.size(); ++i) { if (params[i].isEmpty()) xmlWriter().writeCharacters("..."); else writeCharacters(params[i]); if ((i+1) < params.size()) xmlWriter().writeCharacters(", "); } xmlWriter().writeCharacters(")"); } } xmlWriter().writeEndElement(); // xmlWriter().writeStartElement(CXXDEFINENAMELOOKUP); writeCharacters(fn->name()); xmlWriter().writeEndElement(); // if (fn->reimplementedFrom() != 0) { FunctionNode* rfn = (FunctionNode*)fn->reimplementedFrom(); xmlWriter().writeStartElement(CXXDEFINEREIMPLEMENTED); xmlWriter().writeAttribute("href",rfn->ditaXmlHref()); writeCharacters(marker->plainFullName(rfn)); xmlWriter().writeEndElement(); // } if (fn->metaness() == FunctionNode::MacroWithParams) { QStringList params = fn->parameterNames(); if (!params.isEmpty()) { xmlWriter().writeStartElement(CXXDEFINEPARAMETERS); for (int i = 0; i < params.size(); ++i) { xmlWriter().writeStartElement(CXXDEFINEPARAMETER); xmlWriter().writeStartElement(CXXDEFINEPARAMETERDECLARATIONNAME); writeCharacters(params[i]); xmlWriter().writeEndElement(); // // not included: xmlWriter().writeEndElement(); // } xmlWriter().writeEndElement(); // } } writeLocation(fn); xmlWriter().writeEndElement(); // writeDetailedDescription(fn, marker, true, QString()); // not included: or xmlWriter().writeEndElement(); // // not included: xmlWriter().writeEndElement(); // } } ++m; } } /*! This function writes one parameter of a Q_PROPERTY macro. The property is identified by \a tag ("READ" "WRIE" etc), and it is found in the 'a nlist. */ void DitaXmlGenerator::writePropertyParameter(const QString& tag, const NodeList& nlist) { NodeList::const_iterator n = nlist.begin(); while (n != nlist.end()) { xmlWriter().writeCharacters(" "); writeCharacters(tag); xmlWriter().writeCharacters(" "); writeCharacters((*n)->name()); ++n; } } /*! Calls beginSubPage() in the base class to open the file. Then creates a new XML stream writer using the IO device from opened file and pushes the XML writer onto a stackj. Creates the file named \a fileName in the output directory. Attaches a QTextStream to the created file, which is written to all over the place using out(). Finally, it sets some parameters in the XML writer and calls writeStartDocument(). */ void DitaXmlGenerator::beginSubPage(const Location& location, const QString& fileName) { PageGenerator::beginSubPage(location,fileName); (void) lookupGuidMap(fileName); QXmlStreamWriter* writer = new QXmlStreamWriter(out().device()); xmlWriterStack.push(writer); writer->setAutoFormatting(true); writer->setAutoFormattingIndent(4); writer->writeStartDocument(); } /*! Calls writeEndDocument() and then pops the XML stream writer off the stack and deletes it. Then it calls endSubPage() in the base class to close the device. */ void DitaXmlGenerator::endSubPage() { xmlWriter().writeEndDocument(); delete xmlWriterStack.pop(); PageGenerator::endSubPage(); } /*! Returns a reference to the XML stream writer currently in use. There is one XML stream writer open for each XML file being written, and they are kept on a stack. The one on top of the stack is the one being written to at the moment. */ QXmlStreamWriter& DitaXmlGenerator::xmlWriter() { return *xmlWriterStack.top(); } /*! Writes the \e {Detailed Description} section(s) for \a node to the current XML stream using the code \a marker. if the \a apiDesc flag is true, then the first section of the sequence of sections written will be an \c {apiDesc>} element with a \e {spectitle} attribute of \e {Detailed Description}. Otherwise, the first section will be a \c {

} element with a \c {} element of \e {Detailed Description}. This function calls the Generator::generateBody() function to write the XML for the section list. */ void DitaXmlGenerator::writeDetailedDescription(const Node* node, CodeMarker* marker, bool apiDesc, const QString& title) { if (!node->doc().isEmpty()) { inDetailedDescription = true; if (apiDesc) { inApiDesc = true; xmlWriter().writeStartElement("apiDesc"); if (!title.isEmpty()) { writeGuidAttribute(title); xmlWriter().writeAttribute("spectitle",title); } else writeGuidAttribute("Detailed Description"); xmlWriter().writeAttribute("outputclass","details"); } else { inSection = true; xmlWriter().writeStartElement("section"); if (!title.isEmpty()) { writeGuidAttribute(title); xmlWriter().writeAttribute("outputclass","details"); xmlWriter().writeStartElement("title"); xmlWriter().writeAttribute("outputclass","h2"); writeCharacters(title); xmlWriter().writeEndElement(); // } else { writeGuidAttribute("Detailed Description"); xmlWriter().writeAttribute("outputclass","details"); } } generateBody(node, marker); if (inApiDesc) { xmlWriter().writeEndElement(); // inApiDesc = false; } else if (inSection) { xmlWriter().writeEndElement(); //

inSection = false; } } inDetailedDescription = false; } /*! Write the nested class elements. */ void DitaXmlGenerator::writeNestedClasses(const Section& s, const Node* n) { if (s.members.isEmpty()) return; xmlWriter().writeStartElement("cxxClassNested"); xmlWriter().writeStartElement("cxxClassNestedDetail"); NodeList::ConstIterator m = s.members.begin(); while (m != s.members.end()) { if ((*m)->type() == Node::Class) { xmlWriter().writeStartElement("cxxClassNestedClass"); QString link = linkForNode((*m), n); xmlWriter().writeAttribute("href", link); QString name = n->name() + "::" + (*m)->name(); writeCharacters(name); xmlWriter().writeEndElement(); // } ++m; } xmlWriter().writeEndElement(); // xmlWriter().writeEndElement(); // } /*! Recursive writing of DITA XML files from the root \a node. */ void DitaXmlGenerator::generateInnerNode(const InnerNode* node) { if (!node->url().isNull()) return; if (node->type() == Node::Fake) { const FakeNode *fakeNode = static_cast(node); if (fakeNode->subType() == Node::ExternalPage) return; if (fakeNode->subType() == Node::Image) return; if (fakeNode->subType() == Node::QmlPropertyGroup) return; if (fakeNode->subType() == Node::Page) { if (node->count() > 0) qDebug("PAGE %s HAS CHILDREN", qPrintable(fakeNode->title())); } } /* Obtain a code marker for the source file. */ CodeMarker *marker = CodeMarker::markerForFileName(node->location().filePath()); if (node->parent() != 0) { beginSubPage(node->location(), fileName(node)); if (node->type() == Node::Namespace || node->type() == Node::Class) { generateClassLikeNode(node, marker); } else if (node->type() == Node::Fake) { if (node->subType() == Node::HeaderFile) generateClassLikeNode(node, marker); else if (node->subType() == Node::QmlClass) generateClassLikeNode(node, marker); else generateFakeNode(static_cast(node), marker); } endSubPage(); } NodeList::ConstIterator c = node->childNodes().begin(); while (c != node->childNodes().end()) { if ((*c)->isInnerNode() && (*c)->access() != Node::Private) generateInnerNode((const InnerNode*) *c); ++c; } } /*! Returns true if \a format is "XML" or "HTML" . */ bool DitaXmlGenerator::canHandleFormat(const QString& format) { return (format == "HTML") || (format == this->format()); } void DitaXmlGenerator::writeDitaMap() { beginSubPage(Location(),"qt-dita-map.xml"); QString doctype; doctype = ""; xmlWriter().writeDTD(doctype); xmlWriter().writeStartElement("cxxAPIMap"); xmlWriter().writeAttribute("id","Qt-DITA-Map"); xmlWriter().writeAttribute("title","Qt DITA Map"); xmlWriter().writeStartElement("topicmeta"); xmlWriter().writeStartElement("shortdesc"); xmlWriter().writeCharacters("The top level map for the Qt documentation"); xmlWriter().writeEndElement(); // xmlWriter().writeEndElement(); // GuidMaps::iterator i = guidMaps.begin(); while (i != guidMaps.end()) { xmlWriter().writeStartElement("topicref"); xmlWriter().writeAttribute("href",i.key()); xmlWriter().writeAttribute("type","topic"); xmlWriter().writeEndElement(); // ++i; } endSubPage(); } QT_END_NAMESPACE