codedescription.h

Go to the documentation of this file.

/*  This file is part of KDevelop
    Copyright 2012 Miha Čančula <miha@noughmad.eu>

    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Library General Public
    License as published by the Free Software Foundation; either
    version 2 of the License, or (at your option) any later version.

    This library is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    Library General Public License for more details.

    You should have received a copy of the GNU Library General Public License
    along with this library; see the file COPYING.LIB.  If not, write to
    the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
    Boston, MA 02110-1301, USA.
 */

#ifndef KDEVPLATFORM_CODEDESCRIPTION_H
#define KDEVPLATFORM_CODEDESCRIPTION_H

#include <language/languageexport.h>
#include <language/duchain/duchainpointer.h>

#include <QString>
#include <QVariant>
#include <QVector>

namespace KDevelop {
struct KDEVPLATFORMLANGUAGE_EXPORT VariableDescription
{
    VariableDescription();
    VariableDescription(const QString& type, const QString& name);
    explicit VariableDescription(const DeclarationPointer& declaration);

    QString name;
    QString type;
    QString access;
    QString value;
};

using VariableDescriptionList = QVector<VariableDescription>;

struct KDEVPLATFORMLANGUAGE_EXPORT FunctionDescription
{
    FunctionDescription();
    FunctionDescription(const QString& name,
                        const VariableDescriptionList& arguments,
                        const VariableDescriptionList& returnArguments);
    explicit FunctionDescription(const DeclarationPointer& declaration);

    QString returnType() const;

    QString name;
    QVector<VariableDescription> arguments;
    QVector<VariableDescription> returnArguments;
    QString access;

    bool isConstructor : 1;
    bool isDestructor : 1;
    bool isVirtual : 1;
    bool isAbstract : 1;
    bool isOverriding : 1;
    bool isFinal : 1;
    bool isStatic : 1;
    bool isSlot : 1;
    bool isSignal : 1;
    bool isConst : 1;
};

using FunctionDescriptionList = QVector<FunctionDescription>;

struct KDEVPLATFORMLANGUAGE_EXPORT InheritanceDescription
{
    QString inheritanceMode;
    QString baseType;
};

using InheritanceDescriptionList = QVector<InheritanceDescription>;

struct KDEVPLATFORMLANGUAGE_EXPORT ClassDescription
{
    ClassDescription();
    explicit ClassDescription(const QString& name);

    QString name;
    InheritanceDescriptionList baseClasses;
    VariableDescriptionList members;
    FunctionDescriptionList methods;
};

namespace CodeDescription {
template <class T> QVariant toVariantList(const QVector<T>& list)
{
    QVariantList ret;
    ret.reserve(list.size());
    for (const T& t : list) {
        ret << QVariant::fromValue<T>(t);
    }

    return QVariant::fromValue(ret);
}
}
}

Q_DECLARE_TYPEINFO(KDevelop::VariableDescription, Q_MOVABLE_TYPE);
Q_DECLARE_TYPEINFO(KDevelop::FunctionDescription, Q_MOVABLE_TYPE);
Q_DECLARE_TYPEINFO(KDevelop::InheritanceDescription, Q_MOVABLE_TYPE);
Q_DECLARE_TYPEINFO(KDevelop::ClassDescription, Q_MOVABLE_TYPE);

Q_DECLARE_METATYPE(KDevelop::VariableDescription)
Q_DECLARE_METATYPE(KDevelop::VariableDescriptionList)
Q_DECLARE_METATYPE(KDevelop::FunctionDescription)
Q_DECLARE_METATYPE(KDevelop::FunctionDescriptionList)
Q_DECLARE_METATYPE(KDevelop::InheritanceDescription)
Q_DECLARE_METATYPE(KDevelop::InheritanceDescriptionList)
Q_DECLARE_METATYPE(KDevelop::ClassDescription)

#endif // KDEVPLATFORM_CODEDESCRIPTION_H