tools/qdoc3/cpptoqsconverter.cpp
changeset 0 1918ee327afb
child 4 3b1da2848fc7
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/tools/qdoc3/cpptoqsconverter.cpp	Mon Jan 11 14:00:40 2010 +0000
@@ -0,0 +1,415 @@
+/****************************************************************************
+**
+** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
+** All rights reserved.
+** Contact: Nokia Corporation (qt-info@nokia.com)
+**
+** This file is part of the tools applications of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:LGPL$
+** No Commercial Usage
+** This file contains pre-release code and may not be distributed.
+** You may use this file in accordance with the terms and conditions
+** contained in the Technology Preview License Agreement accompanying
+** this package.
+**
+** GNU Lesser General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU Lesser
+** General Public License version 2.1 as published by the Free Software
+** Foundation and appearing in the file LICENSE.LGPL included in the
+** packaging of this file.  Please review the following information to
+** ensure the GNU Lesser General Public License version 2.1 requirements
+** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
+**
+** In addition, as a special exception, 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.
+**
+** If you have questions regarding the use of this file, please contact
+** Nokia at qt-info@nokia.com.
+**
+**
+**
+**
+**
+**
+**
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+/*
+  cpptoqsconverter.cpp
+*/
+
+#include "config.h"
+#include "cpptoqsconverter.h"
+
+QT_BEGIN_NAMESPACE
+
+#define CONFIG_QUICK                    "quick"
+#define CONFIG_INDENTSIZE               "indentsize"
+
+void setTabSize( int size );
+void setIndentSize( int size );
+int columnForIndex( const QString& t, int index );
+int indentForBottomLine( const QStringList& program, QChar typedIn );
+
+static QString balancedParens = "(?:[^()]+|\\([^()]*\\))*";
+
+QRegExp CppToQsConverter::qClassRegExp;
+QRegExp CppToQsConverter::addressOperatorRegExp;
+QRegExp CppToQsConverter::gulbrandsenRegExp;
+int CppToQsConverter::tabSize;
+
+ClassNode *CppToQsConverter::findClassNode( Tree *qsTree,
+					    const QString& qtName )
+{
+    ClassNode *classe = (ClassNode *) qsTree->findNode( QStringList(qtName), Node::Class );
+    if ( classe == 0 )
+	classe = (ClassNode *) qsTree->findNode( QStringList(qtName.mid(1)), Node::Class );
+    return classe;
+}
+
+QString CppToQsConverter::convertedDataType( Tree *qsTree,
+					     const QString& leftType,
+					     const QString& /* rightType */ )
+{
+    QString s = leftType;
+
+    if ( s.startsWith("const ") )
+	s = s.mid( 6 );
+    while ( s.endsWith("*") || s.endsWith("&") || s.endsWith(" ") )
+	s.truncate( s.length() - 1 );
+
+    switch ( s[0].unicode() ) {
+    case 'Q':
+	if ( s == "QCString" ) {
+	    return "String";
+	} else {
+	    Node *node = findClassNode( qsTree, s );
+	    if ( node == 0 ) {
+		return "";
+	    } else {
+		return node->name();
+	    }
+	}
+	break;
+    case 'b':
+	if ( s == "bool" )
+	    return "Boolean";
+	break;
+    case 'c':
+	if ( s == "char" ) {
+	    if ( leftType == "const char *" ) {
+		return "String";
+	    } else {
+		return "Number";
+	    }
+	}
+	break;
+    case 'd':
+	if ( s == "double" )
+	    return "Number";
+	break;
+    case 'f':
+	if ( s == "float" )
+	    return "Number";
+    case 'i':
+	if ( s == "int" )
+	    return "Number";
+	break;
+    case 'l':
+	if ( s == "long" || s == "long int" || s == "long long" ||
+	     s == "long long int" || s == "long double" )
+	    return "Number";
+	break;
+    case 's':
+	if ( s == "short" || s == "short int" || s == "signed char" ||
+	     s == "signed short" || s == "signed short int" || s == "signed" ||
+	     s == "signed int" || s == "signed long" || s == "signed long int" )
+	    return "Number";
+	break;
+    case 'u':
+	if ( s == "uchar" || s == "unsigned" || s == "unsigned char" ||
+	     s == "ushort" || s == "unsigned short" ||
+	     s == "unsigned short int" || s == "uint" || s == "unsigned int" ||
+	     s == "ulong" || s == "unsigned long" || s == "unsigned long int" )
+	    return "Number";
+	break;
+    case 'v':
+	if ( s == "void" )
+	    return "";
+    }
+    return s;
+}
+
+QString CppToQsConverter::convertedCode( Tree *qsTree, const QString& code,
+					 const QSet<QString>& classesWithNoQ )
+{
+    QString result;
+    QStringList program;
+    QStringList comments;
+    int programWidth = 0;
+
+    QStringList originalLines = code.split("\n");
+    QStringList::ConstIterator ol = originalLines.begin();
+    while ( ol != originalLines.end() ) {
+	QString code = (*ol).trimmed();
+	QString comment;
+
+	int slashSlash = code.indexOf( "//" );
+	if ( slashSlash != -1 ) {
+	    comment = code.mid( slashSlash );
+	    code.truncate( slashSlash );
+	    code = code.trimmed();
+	}
+
+	code = convertCodeLine( qsTree, program, code, classesWithNoQ );
+	program.append( code );
+
+	comment = convertComment( qsTree, comment, classesWithNoQ );
+	comments.append( comment );
+
+	int n = indentForBottomLine( program, QChar::Null );
+	for ( int i = 0; i < n; i++ )
+	    program.last().prepend( " " );
+
+	int width = columnForIndex( program.last(), program.last().length() );
+	if ( !comment.isEmpty() && width > programWidth )
+	    programWidth = width;
+	++ol;
+    }
+
+    programWidth = ( (programWidth + (tabSize - 1) + 2) / tabSize ) * tabSize;
+
+    QStringList::ConstIterator p = program.begin();
+    QStringList::ConstIterator c = comments.begin();
+    while ( c != comments.end() ) {
+	if ( c != comments.begin() )
+	    result += "\n";
+
+	if ( (*p).trimmed().isEmpty() ) {
+	    if ( !(*c).isEmpty() )
+		result += *p;
+	} else {
+	    result += *p;
+	    if ( !(*c).isEmpty() ) {
+		int i = columnForIndex( *p, (*p).length() );
+		while ( i++ < programWidth )
+		    result += " ";
+	    }
+	}
+	result += *c;
+	++p;
+	++c;
+    }
+    return result;
+}
+
+void CppToQsConverter::initialize( const Config& config )
+{
+    qClassRegExp.setPattern( "\\bQ([A-Z][A-Za-z]+)\\b" );
+    addressOperatorRegExp.setPattern( "([(\\s])[*&]([a-zA-Z])" );
+    gulbrandsenRegExp.setPattern( "\\b::\\b|->" );
+
+    tabSize = config.getInt( CONFIG_TABSIZE );
+    setTabSize( tabSize );
+
+    int size = config.getInt( CONFIG_QUICK + Config::dot + CONFIG_INDENTSIZE );
+    if ( size > 0 )
+	setIndentSize( size );
+}
+
+void CppToQsConverter::terminate()
+{
+}
+
+QString CppToQsConverter::convertCodeLine( Tree *qsTree,
+					   const QStringList& program,
+					   const QString& code,
+					   const QSet<QString>& classesWithNoQ )
+{
+    static QString dataTypeFmt =
+	"(?!return)(?:const\\b\\s*)?[A-Za-z_]+(?:\\s*[*&])?";
+    static QRegExp funcPrototypeRegExp(
+	"(" + dataTypeFmt + ")\\s*\\b([A-Z][a-zA-Z_0-9]*::)?"
+	"([a-z][a-zA-Z_0-9]*)\\(([^);]*)(\\)?)(?:\\s*const)?" );
+    static QRegExp paramRegExp(
+	"^\\s*(" + dataTypeFmt + ")\\s*\\b([a-z][a-zA-Z_0-9]*)\\s*(,)?\\s*" );
+    static QRegExp uninitVarRegExp(
+	"(" + dataTypeFmt + ")\\s*\\b([a-z][a-zA-Z_0-9]*);" );
+    static QRegExp eqVarRegExp(
+	dataTypeFmt + "\\s*\\b([a-z][a-zA-Z_0-9]*)\\s*=(\\s*)(.*)" );
+    static QRegExp ctorVarRegExp(
+	"(" + dataTypeFmt + ")\\s*\\b([a-z][a-zA-Z_0-9]*)\\((.*)\\);" );
+    static QRegExp qdebugRegExp(
+	"q(?:Debug|Warning|Fatal)\\(\\s*(\"(?:\\\\.|[^\"])*\")\\s*"
+	"(?:,\\s*(\\S(?:[^,]*\\S)?))?\\s*\\);" );
+    static QRegExp coutRegExp( "c(?:out|err)\\b(.*);" );
+    static QRegExp lshiftRegExp( "\\s*<<\\s*" );
+    static QRegExp endlRegExp( "^endl$" );
+
+    if ( code.isEmpty() || code == "{" || code == "}" )
+	return code;
+
+    QString result;
+
+    if ( funcPrototypeRegExp.exactMatch(code) ) {
+	QString returnType = funcPrototypeRegExp.cap( 1 );
+	QString className = funcPrototypeRegExp.cap( 2 );
+	QString funcName = funcPrototypeRegExp.cap( 3 );
+	QString params = funcPrototypeRegExp.cap( 4 ).trimmed();
+	bool toBeContinued = funcPrototypeRegExp.cap( 5 ).isEmpty();
+        // ### unused
+        Q_UNUSED(toBeContinued);
+
+	className.replace( "::", "." );
+
+	result = "function " + className + funcName + "(";
+
+	if ( !params.isEmpty() && params != "void" ) {
+	    result += " ";
+	    int i = funcPrototypeRegExp.pos( 4 );
+	    while ( (i = paramRegExp.indexIn(code, i,
+					     QRegExp::CaretAtOffset)) != -1 ) {
+		QString dataType = paramRegExp.cap( 1 );
+		QString paramName = paramRegExp.cap( 2 );
+		QString comma = paramRegExp.cap( 3 );
+
+		result += paramName + " : " +
+			  convertedDataType( qsTree, dataType );
+		if ( comma.isEmpty() )
+		    break;
+		result += ", ";
+		i += paramRegExp.matchedLength();
+	    }
+	    result += " ";
+	}
+
+	result += ")";
+	returnType = convertedDataType( qsTree, returnType );
+	if ( !returnType.isEmpty() )
+	    result += " : " + returnType;
+    } else if ( uninitVarRegExp.exactMatch(code) ) {
+	QString dataType = uninitVarRegExp.cap( 1 );
+	QString varName = uninitVarRegExp.cap( 2 );
+
+	result = "var " + varName;
+	dataType = convertedDataType( qsTree, dataType );
+	if ( !dataType.isEmpty() )
+	    result += " : " + dataType;
+	result += ";";
+    } else if ( eqVarRegExp.exactMatch(code) ) {
+	QString varName = eqVarRegExp.cap( 1 );
+	QString value = eqVarRegExp.cap( 3 );
+
+	value = convertExpr( qsTree, value, classesWithNoQ );
+	result += "var " + varName + " = " + value;
+    } else if ( ctorVarRegExp.exactMatch(code) ) {
+	QString dataType = ctorVarRegExp.cap( 1 );
+	QString varName = ctorVarRegExp.cap( 2 );
+	QString value = ctorVarRegExp.cap( 3 ).trimmed();
+
+	result += "var " + varName + " = ";
+
+	dataType = convertedDataType( qsTree, dataType );
+	value = convertExpr( qsTree, value, classesWithNoQ );
+
+	if ( dataType.isEmpty() || dataType == "String" ) {
+	    if ( value.contains(",") ) {
+		result += "...";
+	    } else {
+		result += value;
+	    }
+	} else {
+	    result += "new " + dataType;
+	    if ( !value.isEmpty() )
+		result += "( " + value + " )";
+	}
+	result += ";";
+    } else if ( qdebugRegExp.exactMatch(code) ) {
+	QString fmt = qdebugRegExp.cap( 1 );
+	QString arg1 = qdebugRegExp.cap( 2 );
+
+	result += "println ";
+	int i = 0;
+	while ( i < (int) fmt.length() ) {
+	    if ( fmt[i] == '%' ) {
+		int percent = i;
+		i++;
+		while ( i < (int) fmt.length() &&
+			QString("diouxXeEfFgGaAcsCSpn%\"").indexOf(fmt[i]) == -1 )
+		    i++;
+		if ( fmt[i] == '%' ) {
+		    result += fmt[i++];
+		} else if ( fmt[i] != '"' ) {
+		    if ( percent == 1 ) {
+			result.truncate( result.length() - 1 );
+		    } else {
+			result += "\" + ";
+		    }
+		    i++;
+		    if ( arg1.endsWith(".latin1()") )
+			arg1.truncate( arg1.length() - 9 );
+		    result += arg1;
+		    if ( i == (int) fmt.length() - 1 ) {
+			i++;
+		    } else {
+			result += " + \"";
+		    }
+		}
+	    } else {
+		result += fmt[i++];
+	    }
+	}
+	result += ";";
+    } else if ( coutRegExp.exactMatch(code) &&
+		program.filter("var cout").isEmpty() ) {
+	QStringList args = coutRegExp.cap(1).split(lshiftRegExp);
+	args.replaceInStrings( endlRegExp, "\"\\n\"" );
+	if ( args.last() == "\"\\n\"" ) {
+	    args.erase( args.end() - 1 );
+	    if ( args.isEmpty() )
+		args << "\"\"";
+	    result += "println ";
+	} else {
+	    result += "print ";
+	}
+	result += args.join( " + " ) + ";";
+    } else {
+	result = convertExpr( qsTree, code, classesWithNoQ );
+    }
+    return result;
+}
+
+QString CppToQsConverter::convertComment( Tree * /* qsTree */,
+					  const QString& comment,
+					  const QSet<QString>& classesWithNoQ )
+
+{
+    QString result = comment;
+
+    result.replace( "TRUE", "true" );
+    result.replace( "FALSE", "false" );
+    result.replace( addressOperatorRegExp, "\\1\\2" );
+    result.replace( gulbrandsenRegExp, "." );
+
+    int i = 0;
+    while ( (i = result.indexOf(qClassRegExp, i)) != -1 ) {
+	if ( classesWithNoQ.contains(qClassRegExp.cap(1)) )
+	    result.remove( i, 1 );
+	i++;
+    }
+    return result;
+}
+
+QString CppToQsConverter::convertExpr( Tree *qsTree, const QString& expr,
+				       const QSet<QString>& classesWithNoQ )
+{
+    // suboptimal
+    return convertComment( qsTree, expr, classesWithNoQ );
+}
+
+QT_END_NAMESPACE