qt3/tools/designer/interfaces/languageinterface.h

 /**********************************************************************
** Copyright (C) 2000-2008 Trolltech ASA.  All rights reserved.
**
** This file is part of Qt Designer.
**
** 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 files LICENSE.GPL2
** and LICENSE.GPL3 included in the packaging of this file.
** Alternatively you may (at your option) use any later version
** of the GNU General Public License if such license has been
** publicly approved by Trolltech ASA (or its successors, if any)
** and the KDE Free Qt Foundation.
**
** Please review the following information to ensure GNU General
** Public Licensing requirements will be met:
** http://trolltech.com/products/qt/licenses/licensing/opensource/.
** If you are unsure which license is appropriate for your use, please
** review the following information:
** http://trolltech.com/products/qt/licenses/licensing/licensingoverview
** or contact the sales department at sales@trolltech.com.
**
** Licensees holding valid Qt Commercial licenses may use this file in
** accordance with the Qt Commercial License Agreement provided with
** the Software.
**
** This file is provided "AS IS" with NO WARRANTY OF ANY KIND,
** INCLUDING THE WARRANTIES OF DESIGN, MERCHANTABILITY AND FITNESS FOR
** A PARTICULAR PURPOSE. Trolltech reserves all rights not granted
** herein.
**
**********************************************************************/

#ifndef LANGUAGEINTERFACE_H
#define LANGUAGEINTERFACE_H

//
//  W A R N I N G  --  PRIVATE INTERFACES
//  --------------------------------------
//
// This file and the interfaces declared in the file are not
// public. It exists for internal purpose. This header file and
// interfaces may change from version to version (even binary
// incompatible) without notice, or even be removed.
//
// We mean it.
//
//

#include <private/qcom_p.h>
#include <qvaluelist.h>
#include <qstringlist.h>
#include <qmap.h>
#include <qstrlist.h>

// {f208499a-6f69-4883-9219-6e936e55a330}
#ifndef IID_Language
#define IID_Language QUuid( 0xf208499a, 0x6f69, 0x4883, 0x92, 0x19, 0x6e, 0x93, 0x6e, 0x55, 0xa3, 0x30 )
#endif

struct LanguageInterface : public QUnknownInterface
{
    struct Function
    {
	QString name;
	QString body;
	QString returnType;
	QString comments;
	int start;
	int end;
	QString access;
	bool operator==( const Function &f ) const {
	    return ( name == f.name &&
		     body == f.body &&
		     returnType == f.returnType &&
		     comments == f.comments );
	}
    };

    struct Connection
    {
	QString sender;
	QString signal;
	QString slot;
	bool operator==( const Connection &c ) const {
	    return ( sender == c.sender &&
		     signal == c.signal &&
		     slot == c.slot );
	}
    };

    enum Support
    {
	ReturnType,
	ConnectionsToCustomSlots,
	CompressProject
    };

    virtual void functions( const QString &code, QValueList<Function> *funcs ) const = 0;
    virtual void connections( const QString &code, QValueList<Connection> *connections ) const = 0;
    virtual QString createFunctionStart( const QString &className, const QString &func,
					 const QString &returnType, const QString &access ) = 0;
    virtual QString createArguments( const QString &cpp_signature ) = 0;
    virtual QString createEmptyFunction() = 0;
    virtual QStringList definitions() const = 0;
    virtual QStringList definitionEntries( const QString &definition, QUnknownInterface *designerIface ) const = 0;
    virtual void setDefinitionEntries( const QString &definition, const QStringList &entries, QUnknownInterface *designerIface ) = 0;
    virtual bool supports( Support s ) const = 0;
    virtual QStringList fileFilterList() const = 0;
    virtual QStringList fileExtensionList() const = 0;
    virtual void preferedExtensions( QMap<QString, QString> &extensionMap ) const = 0;
    virtual QString projectKeyForExtension( const QString &extension ) const = 0;
    virtual void sourceProjectKeys( QStringList &keys ) const = 0;
    virtual QString cleanSignature( const QString &sig ) = 0;
    virtual void loadFormCode( const QString &form, const QString &filename,
			       QValueList<Function> &functions,
			       QStringList &vars,
			       QValueList<Connection> &connections ) = 0;
    virtual QString formCodeExtension() const = 0;

    virtual bool canConnect( const QString &signal, const QString &slot ) = 0;

    virtual 	void compressProject( const QString &projectFile, const QString &compressedFile,
				      bool withWarning ) = 0;
    virtual QString uncompressProject( const QString &projectFile, const QString &destDir ) = 0;
    virtual QString aboutText() const = 0;

    virtual void addConnection( const QString &sender, const QString &signal,
				const QString &receiver, const QString &slot,
				QString *code ) = 0;
    virtual void removeConnection( const QString &sender, const QString &signal,
				   const QString &receiver, const QString &slot,
				   QString *code ) = 0;
    virtual QStrList signalNames( QObject *obj ) const = 0;

};

#endif