Changeset 561 for trunk/tools/qdoc3/node.cpp

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/node.cpp (modified) (30 diffs)

trunk/tools/qdoc3/node.cpp

@@ -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$
 **
@@ -44 +44 @@
 */
 
+#include <QtCore>
 #include "node.h"
 
@@ -50 +51 @@
 /*!
   \class Node
-  \brief A node in a Tree.
- */
-
-/*!
+  \brief The Node class is a node in the Tree.
+
+  A Node represents a class or function or something else
+  from the source code..
+ */
+
+/*!
+  When this Node is destroyed, if it has a parent Node, it
+  removes itself from the parent node's child list.
  */
 Node::~Node()
@@ -64 +70 @@
 
 /*!
+  Sets this Node's Doc to \a doc. If \a replace is false and
+  this Node already has a Doc, a warning is reported that the
+  Doc is being overridden, and it reports where the previous
+  Doc was found. If \a replace is true, the Doc is replaced
+  silently.
  */
 void Node::setDoc(const Doc& doc, bool replace)
@@ -114 +125 @@
 
 /*!
+  This function creates a pair that describes a link.
+  The pair is composed from \a link and \a desc. The
+  \a linkType is the map index the pair is filed under.
  */
 void Node::setLink(LinkType linkType, const QString &link, const QString &desc)
@@ -205 +219 @@
 
 /*!
+  Find the function node in this node for the function named \a name.
  */
 FunctionNode *InnerNode::findFunctionNode(const QString& name)
@@ -212 +227 @@
 
 /*!
+  Find the function node in this node that has the same name as \a clone.
  */
 FunctionNode *InnerNode::findFunctionNode(const FunctionNode *clone)
@@ -232 +248 @@
     }
     return 0;
+}
+
+/*!
+  Returns the list of keys from the primary function map.
+ */
+QStringList InnerNode::primaryKeys()
+{
+    QStringList t;
+    QMap<QString, Node*>::iterator i = primaryFunctionMap.begin();
+    while (i != primaryFunctionMap.end()) {
+        t.append(i.key());
+        ++i;
+    }
+    return t;
+}
+
+/*!
+  Returns the list of keys from the secondary function map.
+ */
+QStringList InnerNode::secondaryKeys()
+{
+    QStringList t;
+    QMap<QString, NodeList>::iterator i = secondaryFunctionMap.begin();
+    while (i != secondaryFunctionMap.end()) {
+        t.append(i.key());
+        ++i;
+    }
+    return t;
 }
 
@@ -379 +423 @@
 
 /*!
+  Find the function node in this node that has the given \a name. 
  */
 const FunctionNode *InnerNode::findFunctionNode(const QString& name) const
@@ -387 +432 @@
 
 /*!
- */
-const FunctionNode *InnerNode::findFunctionNode(
-        const FunctionNode *clone) const
+  Find the function node in this node that has the same name as \a clone.
+ */
+const FunctionNode *InnerNode::findFunctionNode(const FunctionNode *clone) const
 {
     InnerNode *that = (InnerNode *) this;
@@ -507 +552 @@
 {
     children.append(child);
-    if (child->type() == Function) {
+    if ((child->type() == Function) || (child->type() == QmlMethod)) {
         FunctionNode *func = (FunctionNode *) child;
         if (!primaryFunctionMap.contains(func->name())) {
@@ -624 +669 @@
 
 /*!
-  Returns false because this is an InnerNode.
+  Returns false because this is a LeafNode.
  */
 bool LeafNode::isInnerNode() const
@@ -714 +759 @@
 
 /*!
- */
-FakeNode::FakeNode(InnerNode *parent, const QString& name, SubType subType)
-    : InnerNode(Fake, parent, name), sub(subType)
-{
-}
-
-/*!
+  The type of a FakeNode is Fake, and it has a \a subtype,
+  which specifies the type of FakeNode.
+ */
+FakeNode::FakeNode(InnerNode *parent, const QString& name, SubType subtype)
+    : InnerNode(Fake, parent, name), sub(subtype)
+{
+}
+
+/*!
+  Returns the fake node's full title, which is usually
+  just title(), but for some SubType values is different
+  from title()
  */
 QString FakeNode::fullTitle() const
@@ -730 +780 @@
             return title();
     }
+    else if (sub == Image) {
+        if (title().isEmpty())
+            return name().mid(name().lastIndexOf('/') + 1) + " Image File";
+        else
+            return title();
+    }
     else if (sub == HeaderFile) {
         if (title().isEmpty())
@@ -742 +798 @@
 
 /*!
+  Returns the subtitle.
  */
 QString FakeNode::subTitle() const
@@ -748 +805 @@
         return stle;
 
-    if (sub == File) {
+    if ((sub == File) || (sub == Image)) {
         if (title().isEmpty() && name().contains("/"))
             return name();
@@ -818 +875 @@
 /*!
   \class Parameter
- */
-
-/*!
+  \brief The class Parameter contains one parameter.
+
+  A parameter can be a function parameter or a macro
+  parameter.
+ */
+
+/*!
+  Constructs this parameter from the left and right types
+  \a leftType and rightType, the parameter \a name, and the
+  \a defaultValue. In practice, \a rightType is not used,
+  and I don't know what is was meant for.
  */
 Parameter::Parameter(const QString& leftType,
@@ -831 +896 @@
 
 /*!
+  The standard copy constructor copies the strings from \a p.
  */
 Parameter::Parameter(const Parameter& p)
@@ -838 +904 @@
 
 /*!
+  Assigning Parameter \a p to this Parameter copies the
+  strings across. 
  */
 Parameter& Parameter::operator=(const Parameter& p)
@@ -849 +917 @@
 
 /*!
+  Reconstructs the text describing the parameter and
+  returns it. If \a value is true, the default value
+  will be included, if there is one.
+ */
+QString Parameter::reconstruct(bool value) const
+{
+    QString p = lef + rig;
+    if (!p.endsWith(QChar('*')) && !p.endsWith(QChar('&')) && !p.endsWith(QChar(' ')))
+        p += " ";
+    p += nam;
+    if (value)
+        p += def;
+    return p;
+}
+
+
+/*!
   \class FunctionNode
  */
 
 /*!
+  Construct a function node for a C++ function. It's parent
+  is \a parent, and it's name is \a name.
  */
 FunctionNode::FunctionNode(InnerNode *parent, const QString& name)
-    : LeafNode(Function, parent, name), met(Plain), vir(NonVirtual),
-      con(false), sta(false), ove(false), rf(0), ap(0)
-{
+    : LeafNode(Function, parent, name),
+      met(Plain),
+      vir(NonVirtual),
+      con(false),
+      sta(false),
+      ove(false),
+      att(false),
+      rf(0),
+      ap(0)
+{
+    // nothing.
+}
+
+/*!
+  Construct a function node for a QML method or signal, specified
+  by \a type. It's parent is \a parent, and it's name is \a name.
+  If \a attached is true, it is an attached method or signal.
+ */
+FunctionNode::FunctionNode(Type type, InnerNode *parent, const QString& name, bool attached)
+    : LeafNode(type, parent, name),
+      met(Plain),
+      vir(NonVirtual),
+      con(false),
+      sta(false),
+      ove(false),
+      att(attached),
+      rf(0),
+      ap(0)
+{
+    // nothing.
 }
 
@@ -866 +980 @@
     parent()->setOverload(this, overlode);
     ove = overlode;
+}
+
+/*!
+  Sets the function node's reimplementation flag to \a r.
+  When \a r is true, it is supposed to mean that this function
+  is a reimplementation of a virtual function in a base class,
+  but it really just means the \e reimp command was seen in the
+  qdoc comment.
+ */
+void FunctionNode::setReimp(bool r)
+{
+    reimp = r;
 }
 
@@ -890 +1016 @@
 
 /*!
+  If this function is a reimplementation, \a from points
+  to the FunctionNode of the function being reimplemented.
  */
 void FunctionNode::setReimplementedFrom(FunctionNode *from)
@@ -898 +1026 @@
 
 /*!
+  Sets the "associated" property to \a property. The function
+  might be the setter or getter for a property, for example.
  */
 void FunctionNode::setAssociatedProperty(PropertyNode *property)
@@ -905 +1035 @@
 
 /*!
+  Returns the overload number for this function obtained
+  from the parent.
  */
 int FunctionNode::overloadNumber() const
@@ -912 +1044 @@
 
 /*!
+  Returns the number of times this function name has been
+  overloaded, obtained from the parent.
  */
 int FunctionNode::numOverloads() const
@@ -919 +1053 @@
 
 /*!
+  Returns the list of parameter names.
  */
 QStringList FunctionNode::parameterNames() const
@@ -929 +1064 @@
     }
     return names;
+}
+
+/*!
+  Returns the list of reconstructed parameters. If \a values
+  is true, the default values are included, if any are present.
+ */
+QStringList FunctionNode::reconstructParams(bool values) const
+{
+    QStringList params;
+    QList<Parameter>::ConstIterator p = parameters().begin();
+    while (p != parameters().end()) {
+        params << (*p).reconstruct(values);
+        ++p;
+    }
+    return params;
+}
+
+/*!
+  Reconstructs and returns the function's signature. If \a values
+  is true, the default values of the parameters are included, if
+  present.
+ */
+QString FunctionNode::signature(bool values) const
+{
+    QString s;
+    if (!returnType().isEmpty())
+        s = returnType() + " ";
+    s += name() + "(";
+    QStringList params = reconstructParams(values);
+    int p = params.size();
+    if (p > 0) {
+        for (int i=0; i<p; i++) {
+            s += params[i];
+            if (i < (p-1))
+                s += ", ";
+        }
+    }
+    s += ")";
+    return s;
+}
+
+/*!
+  Print some debugging stuff.
+ */
+void FunctionNode::debug() const
+{
+    qDebug() << "QML METHOD" << name() << "rt" << rt << "pp" << pp;
 }
 
@@ -1022 +1204 @@
 }
 
+#ifdef QDOC_QML
+bool QmlClassNode::qmlOnly = false;
+
+/*!
+  Constructor for the Qml class node.
+ */
+QmlClassNode::QmlClassNode(InnerNode *parent,
+                           const QString& name,
+                           const ClassNode* cn)
+    : FakeNode(parent, name, QmlClass), cnode(cn)
+{
+    setTitle((qmlOnly ? "" : "QML ") + name + " Element Reference");
+}
+
+/*!
+  The base file name for this kind of node has "qml_"
+  prepended to it.
+
+  But not yet. Still testing.
+ */
+QString QmlClassNode::fileBase() const
+{
+#if 0    
+    if (Node::fileBase() == "item")
+        qDebug() << "FILEBASE: qmlitem" << name();
+    return "qml_" + Node::fileBase();
+#endif
+    return Node::fileBase();
+}
+
+/*!
+  Constructor for the Qml property group node. \a parent is
+  always a QmlClassNode. 
+ */
+QmlPropGroupNode::QmlPropGroupNode(QmlClassNode* parent,
+                                   const QString& name,
+                                   bool attached)
+    : FakeNode(parent, name, QmlPropertyGroup),
+      isdefault(false),
+      att(attached)
+{
+    // nothing.
+}
+
+/*!
+  Constructor for the QML property node.
+ */
+QmlPropertyNode::QmlPropertyNode(QmlPropGroupNode *parent,
+                                 const QString& name,
+                                 const QString& type,
+                                 bool attached)
+    : LeafNode(QmlProperty, parent, name),
+      dt(type),
+      sto(Trool_Default),
+      des(Trool_Default),
+      att(attached)
+{
+    // nothing.
+}
+
+/*!
+  I don't know what this is.
+ */
+QmlPropertyNode::Trool QmlPropertyNode::toTrool(bool boolean)
+{
+    return boolean ? Trool_True : Trool_False;
+}
+
+/*!
+  I don't know what this is either.
+ */
+bool QmlPropertyNode::fromTrool(Trool troolean, bool defaultValue)
+{
+    switch (troolean) {
+    case Trool_True:
+        return true;
+    case Trool_False:
+        return false;
+    default:
+        return defaultValue;
+    }
+}
+#endif
+
 QT_END_NAMESPACE