diff generator/docparser.cpp @ 1:e78566595089

initial import
author mandel
date Mon, 11 May 2009 16:01:50 +0000
parents
children
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/generator/docparser.cpp	Mon May 11 16:01:50 2009 +0000
@@ -0,0 +1,200 @@
+/****************************************************************************
+**
+** Copyright (C) 1992-2008 Nokia. All rights reserved.
+**
+** This file is part of Qt Jambi.
+**
+** * Commercial Usage
+* Licensees holding valid Qt Commercial licenses may use this file in
+* accordance with the Qt Commercial License Agreement provided with the
+* Software or, alternatively, in accordance with the terms contained in
+* a written agreement between you and Nokia.
+*
+*
+* GNU General Public License Usage
+* Alternatively, this file may be used under the terms of the GNU
+* General Public License versions 2.0 or 3.0 as published by the Free
+* Software Foundation and appearing in the file LICENSE.GPL included in
+* the packaging of this file.  Please review the following information
+* to ensure GNU General Public Licensing requirements will be met:
+* http://www.fsf.org/licensing/licenses/info/GPLv2.html and
+* http://www.gnu.org/copyleft/gpl.html.  In addition, as a special
+* exception, Nokia gives you certain additional rights. These rights
+* are described in the Nokia Qt GPL Exception version 1.2, included in
+* the file GPL_EXCEPTION.txt in this package.
+* 
+* Qt for Windows(R) Licensees
+* As a special exception, Nokia, as the sole copyright holder for Qt
+* Designer, grants users of the Qt/Eclipse Integration plug-in the
+* right for the Qt/Eclipse Integration to link to functionality
+* provided by Qt Designer and its related libraries.
+*
+*
+* If you are unsure which license is appropriate for your use, please
+* contact the sales department at qt-sales@nokia.com.
+
+**
+** This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
+** WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
+**
+****************************************************************************/
+
+#include "docparser.h"
+
+#include "metajava.h"
+#include "reporthandler.h"
+
+#include <QtCore/QFileInfo>
+#include <QtCore/QFile>
+
+#include <QtXml>
+
+DocParser::DocParser(const QString &name)
+    : m_doc_file(name),
+      m_dom(0)
+{
+    build();
+}
+
+DocParser::~DocParser()
+{
+    delete m_dom;
+}
+
+QString DocParser::documentation(const AbstractMetaClass *meta_class) const
+{
+    if (!m_dom)
+        return QString();
+
+    QDomElement root_node = m_dom->documentElement();
+
+    QString class_name = root_node.attribute("name");
+    QString doc = root_node.attribute("doc");
+
+    if (class_name != meta_class->name()) {
+        ReportHandler::warning("Documentelement file contains unexpected class: " + class_name + ", file=" + m_doc_file);
+    }
+
+    return doc;
+}
+
+QString DocParser::documentationForFunction(const QString &signature, const QString &tag) const
+{
+    if (!m_dom)
+        return QString();
+
+    QDomElement root_node = m_dom->documentElement();
+    QDomNodeList functions = root_node.elementsByTagName(tag);
+
+    for (int i=0; i<functions.size(); ++i) {
+        QDomNode node = functions.item(i);
+
+        QDomElement *e = (QDomElement *) &node;
+
+        Q_ASSERT(e->isElement());
+
+        if (e->attribute("name") == signature)
+            return e->attribute("doc");
+    }
+
+    return QString();
+}
+
+
+QString DocParser::documentationForSignal(const QString &signature) const
+{
+    return documentationForFunction(signature, "signal");
+}
+
+QString DocParser::documentationForFunction(const QString &signature) const
+{
+    return documentationForFunction(signature, "method");
+}
+
+QString DocParser::documentation(const AbstractMetaEnum *java_enum) const
+{
+    if (!m_dom)
+        return QString();
+
+    QDomElement root_node = m_dom->documentElement();
+
+    QDomNodeList enums = root_node.elementsByTagName("enum");
+
+    for (int i=0; i<enums.size(); ++i) {
+        QDomNode node = enums.item(i);
+        QDomElement *e = (QDomElement *) &node;
+
+        Q_ASSERT(e->isElement());
+
+        if (e->attribute("name") == java_enum->name()) {
+            return e->attribute("doc");
+        }
+    }
+
+    return QString();
+}
+
+
+QString DocParser::documentation(const AbstractMetaEnumValue *java_enum_value) const
+{
+    if (!m_dom)
+        return QString();
+
+    QDomElement root_node = m_dom->documentElement();
+
+    QDomNodeList enums = root_node.elementsByTagName("enum");
+
+    for (int i=0; i<enums.size(); ++i) {
+        QDomNode node = enums.item(i);
+        QDomElement *e = (QDomElement *) &node;
+        Q_ASSERT(e->isElement());
+
+        QDomNodeList enumValues = e->elementsByTagName("enum-value");
+        for (int j=0; j<enumValues.size(); ++j) {
+            QDomNode node = enumValues.item(j);
+            QDomElement *ev = (QDomElement *) &node;
+            if (ev->attribute("name") == java_enum_value->name()) {
+                return ev->attribute("doc");
+            }
+        }
+    }
+
+    return QString();
+}
+
+
+
+void DocParser::build()
+{
+    if (!QFileInfo(m_doc_file).exists()) {
+        ReportHandler::warning("Missing documentation file: " + m_doc_file);
+        return;
+    }
+
+    QFile f(m_doc_file);
+    if (!f.open(QFile::ReadOnly | QFile::Text)) {
+        ReportHandler::warning("Failed to open documentation file: " + m_doc_file);
+        return;
+    }
+
+    m_dom = new QDomDocument();
+
+    QString error;
+    int line, column;
+
+    if (!m_dom->setContent(&f, &error, &line, &column)) {
+         ReportHandler::warning(QString("Failed to parse the documentation file:"
+                                        " '%1' %2 line=%3 column=%4")
+                                .arg(m_doc_file)
+                                .arg(error)
+                                .arg(line)
+                                .arg(column));
+
+        delete m_dom;
+        m_dom = 0;
+
+        return;
+    }
+
+
+}