1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95
|
/*
* This file is part of qmljs, the QML/JS language support plugin for KDevelop
* Copyright (c) 2014 Denis Steckelmacher <steckdenis@yahoo.fr>
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License as
* published by the Free Software Foundation; either version 2 of
* the License or (at your option) version 3 or any later version
* accepted by the membership of KDE e.V. (or its successor approved
* by the membership of KDE e.V.), which shall act as a proxy
* defined in Section 14 of version 3 of the license.
*
* This program 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 General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
*/
#ifndef __FUNCTIONDECLARATION_H__
#define __FUNCTIONDECLARATION_H__
#include "duchainexport.h"
#include <language/duchain/functiondeclaration.h>
#include <language/duchain/indexedducontext.h>
#include <language/duchain/duchainregister.h>
namespace QmlJS {
class KDEVQMLJSDUCHAIN_EXPORT FunctionDeclarationData : public KDevelop::FunctionDeclarationData
{
public:
KDevelop::IndexedDUContext m_prototypeContext;
};
/**
* @brief Function declaration keeping track of a "prototype" context
*
* The prototype of a function can be used, in Javascript, to add methods and
* members to the objects instantiated by calling the function.
*
* The prototype is also used to resolve "this". If a function is assigned to
* an object member, its "prototype" becomes the internal context of the object.
* This way, functions assigned to members of the prototype of a class can use
* "this" to refer to the object on which they are called.
*
* @code
* function Class() { this.name = "Me"; }
*
* Class.prototype.print = function() { console.log(this.name) }
* @endcode
*/
class KDEVQMLJSDUCHAIN_EXPORT FunctionDeclaration : public KDevelop::FunctionDeclaration
{
public:
FunctionDeclaration(const FunctionDeclaration &rhs);
FunctionDeclaration(const KDevelop::RangeInRevision &range, KDevelop::DUContext *context);
explicit FunctionDeclaration(FunctionDeclarationData &data);
~FunctionDeclaration() override;
/**
* @brief Return the context representing the prototype of this function
*
* The returned context, if not null, contains the declarations of the members
* of the prototype.
*
* @note The DUChain must be read-locked
*/
KDevelop::DUContext* prototypeContext() const;
/**
* @brief Set the prototype context of this function
*
* @note The DUChain must be write-locked
*/
void setPrototypeContext(KDevelop::DUContext* context);
enum {
Identity = 112
};
using Ptr = KDevelop::DUChainPointer<FunctionDeclaration>;
private:
DUCHAIN_DECLARE_DATA(FunctionDeclaration)
};
}
DUCHAIN_DECLARE_TYPE(QmlJS::FunctionDeclaration)
#endif
|