Changeset 561 for trunk/tools/qdoc3/htmlgenerator.h

Timestamp:

Feb 11, 2010, 11:19:06 PM (15 years ago)

Author:

Dmitry A. Kuminov

Message:

trunk: Merged in qt 4.6.1 sources.

Location:

trunk

Files:

• . (modified) (1 prop)
• tools/qdoc3/htmlgenerator.h (modified) (12 diffs)

trunk/tools/qdoc3/htmlgenerator.h

@@ -2 +2 @@
 **
 ** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
-** Contact: Qt Software Information (qt-info@nokia.com)
+** All rights reserved.
+** Contact: Nokia Corporation (qt-info@nokia.com)
 **
 ** This file is part of the tools applications of the Qt Toolkit.
@@ -21 +22 @@
 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
 **
-** In addition, as a special exception, Nokia gives you certain
-** additional rights. These rights are described in the Nokia Qt LGPL
-** Exception version 1.0, included in the file LGPL_EXCEPTION.txt in this
-** package.
+** In addition, as a special exception, Nokia gives you certain additional
+** rights.  These rights are described in the Nokia Qt LGPL Exception
+** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
 **
 ** GNU General Public License Usage
@@ -34 +34 @@
 ** met: http://www.gnu.org/copyleft/gpl.html.
 **
-** If you are unsure which license is appropriate for your use, please
-** contact the sales department at qt-sales@nokia.com.
+** If you have questions regarding the use of this file, please contact
+** Nokia at qt-info@nokia.com.
 ** $QT_END_LICENSE$
 **
@@ -46 +46 @@
 #ifndef HTMLGENERATOR_H
 #define HTMLGENERATOR_H
+
+#define QDOC_NAME_ALIGNMENT
 
 #include <qmap.h>
@@ -66 +68 @@
 #endif
 
+typedef QMultiMap<QString, Node*> NodeMultiMap;
+typedef QMap<QString, NodeMultiMap> NewSinceMaps;
+typedef QMap<Node*, NodeMultiMap> ParentMaps;
+typedef QMap<QString, const Node*> NodeMap;
+typedef QMap<QString, NodeMap> NewClassMaps;
+
 class HelpProjectWriter;
 
 class HtmlGenerator : public PageGenerator
 {
+ public:
+    enum SinceType { 
+        Namespace, 
+        Class, 
+        MemberFunction,
+        NamespaceFunction,
+        GlobalFunction,
+        Macro,
+        Enum, 
+        Typedef, 
+        Property,
+        Variable, 
+        QmlProperty,
+        QmlSignal,
+        QmlMethod,
+        LastSinceType
+    };
+
  public:
     HtmlGenerator();
@@ -81 +107 @@
     static QString protect(const QString& string);
     static QString cleanRef(const QString& ref);
+    static QString sinceTitle(int i) { return sinceTitles[i]; }
 
  protected:
@@ -130 +157 @@
     void generateClassHierarchy(const Node *relative, 
                                 CodeMarker *marker,
-                                const QMap<QString,const Node *> &classMap);
+                                const NodeMap &classMap);
     void generateAnnotatedList(const Node *relative, 
                                CodeMarker *marker,
-                               const QMap<QString, const Node *> &nodeMap);
+                               const NodeMap &nodeMap);
     void generateCompactList(const Node *relative, 
                              CodeMarker *marker,
-                             const QMap<QString, const Node *> &classMap);
+                             const NodeMap &classMap,
+                             QString commonPrefix = QString());
     void generateFunctionIndex(const Node *relative, CodeMarker *marker);
     void generateLegaleseList(const Node *relative, CodeMarker *marker);
     void generateOverviewList(const Node *relative, CodeMarker *marker);
+    void generateSectionList(const Section& section, 
+                             const Node *relative,
+                             CodeMarker *marker, 
+                             CodeMarker::SynopsisStyle style);
+#ifdef QDOC_QML
+    void generateQmlSummary(const Section& section,
+                            const Node *relative,
+                            CodeMarker *marker);
+    void generateQmlItem(const Node *node,
+                         const Node *relative,
+                         CodeMarker *marker,
+                         bool summary);
+    void generateDetailedQmlMember(const Node *node,
+                                   const InnerNode *relative,
+                                   CodeMarker *marker);
+    void generateQmlInherits(const QmlClassNode* cn, CodeMarker* marker);
+    void generateQmlInstantiates(const QmlClassNode* qcn, CodeMarker* marker);
+    void generateInstantiatedBy(const ClassNode* cn, CodeMarker* marker);
+#endif
+#ifdef QDOC_NAME_ALIGNMENT
+    void generateSection(const NodeList& nl,
+                         const Node *relative,
+                         CodeMarker *marker,
+                         CodeMarker::SynopsisStyle style);
+    void generateSynopsis(const Node *node, 
+                          const Node *relative, 
+                          CodeMarker *marker,
+                          CodeMarker::SynopsisStyle style,
+                          bool nameAlignment = false);
+    void generateSectionInheritedList(const Section& section, 
+                                      const Node *relative,
+                                      CodeMarker *marker,
+                                      bool nameAlignment = false);
+    QString highlightedCode(const QString& markedCode, 
+                            CodeMarker *marker, 
+                            const Node *relative,
+                            CodeMarker::SynopsisStyle style = CodeMarker::Accessors,
+                            bool nameAlignment = false);
+#else
     void generateSynopsis(const Node *node, 
                           const Node *relative, 
                           CodeMarker *marker,
                           CodeMarker::SynopsisStyle style);
-    void generateSectionList(const Section& section, 
-                             const Node *relative,
-                             CodeMarker *marker, 
-                             CodeMarker::SynopsisStyle style);
     void generateSectionInheritedList(const Section& section, 
                                       const Node *relative,
                                       CodeMarker *marker);
+    QString highlightedCode(const QString& markedCode, 
+                            CodeMarker *marker, 
+                            const Node *relative);
+#endif
     void generateFullName(const Node *apparentNode, 
                           const Node *relative, 
                           CodeMarker *marker,
                           const Node *actualNode = 0);
-    void generateDetailedMember(const Node *node, const InnerNode *relative, CodeMarker *marker);
-    void generateLink(const Atom *atom, const Node *relative, CodeMarker *marker);
+    void generateDetailedMember(const Node *node, 
+                                const InnerNode *relative, 
+                                CodeMarker *marker);
+    void generateLink(const Atom *atom, 
+                      const Node *relative, 
+                      CodeMarker *marker);
     void generateStatus(const Node *node, CodeMarker *marker);
     
     QString registerRef(const QString& ref);
-    QString highlightedCode(const QString& markedCode, CodeMarker *marker, const Node *relative);
     QString fileBase(const Node *node);
 #if 0
@@ -173 +243 @@
     void findAllQmlClasses(const InnerNode *node);
 #endif
+    void findAllSince(const InnerNode *node);
     static int hOffset(const Node *node);
     static bool isThreeColumnEnumValueTable(const Atom *atom);
@@ -178 +249 @@
                             const Node *relative, 
                             CodeMarker *marker, 
-                            const Node *node = 0);
+                            const Node** node);
     virtual void generateDcf(const QString &fileBase, 
                              const QString &startPage,
@@ -206 +277 @@
     HelpProjectWriter *helpProjectWriter;
     bool inLink;
+    bool inObsoleteLink;
     bool inContents;
     bool inSectionHeading;
@@ -225 +297 @@
     QStringList stylesheets;
     QStringList customHeadElements;
-    const Tree *tre;
+    const Tree *myTree;
     bool slow;
-    QMap<QString, QMap<QString, const Node *> > moduleClassMap;
-    QMap<QString, QMap<QString, const Node *> > moduleNamespaceMap;
-    QMap<QString, const Node *> nonCompatClasses;
-    QMap<QString, const Node *> mainClasses;
-    QMap<QString, const Node *> compatClasses;
-    QMap<QString, const Node *> namespaceIndex;
-    QMap<QString, const Node *> serviceClasses;
+    bool obsoleteLinks;
+    QMap<QString, NodeMap > moduleClassMap;
+    QMap<QString, NodeMap > moduleNamespaceMap;
+    NodeMap nonCompatClasses;
+    NodeMap mainClasses;
+    NodeMap compatClasses;
+    NodeMap obsoleteClasses;
+    NodeMap namespaceIndex;
+    NodeMap serviceClasses;
 #ifdef QDOC_QML    
-    QMap<QString, const Node *> qmlClasses;
-#endif
-    QMap<QString, QMap<QString, const Node *> > funcIndex;
+    NodeMap qmlClasses;
+#endif
+    QMap<QString, NodeMap > funcIndex;
     QMap<Text, const Node *> legaleseTexts;
+    NewSinceMaps newSinceMaps;
+    static QString sinceTitles[];
+    NewClassMaps newClassMaps;
 };
 
@@ -252 +329 @@
 
 #endif
+