language/duchain/functiondefinition.h

   1 /* This file is part of KDevelop
   2     Copyright 2008 David Nolden <david.nolden.kdevelop@art-master.de>
   3
   4    This library is free software; you can redistribute it and/or
   5    modify it under the terms of the GNU Library General Public
   6    License version 2 as published by the Free Software Foundation.
   7
   8    This library is distributed in the hope that it will be useful,
   9    but WITHOUT ANY WARRANTY; without even the implied warranty of
  10    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  11    Library General Public License for more details.
  12
  13    You should have received a copy of the GNU Library General Public License
  14    along with this library; see the file COPYING.LIB.  If not, write to
  15    the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  16    Boston, MA 02110-1301, USA.
  17 */
  18 #ifndef CLASSFUNCTIONDEFINITION_H
  19 #define CLASSFUNCTIONDEFINITION_H
  20
  21 #include "functiondeclaration.h"
  22 #include "../languageexport.h"
  23
  24 using namespace KDevelop;
  25
  26 namespace KDevelop {
  27   struct KDEVPLATFORMLANGUAGE_EXPORT FunctionDefinitionData : public FunctionDeclarationData {
  28     //Holds the declaration id for this definition, if this is a definition with separate declaration
  29     DeclarationId m_declaration;
  30   };
  31   ///A FunctionDefinition represents a function-definition that is assigned to a separate function-declaration.
  32   ///It allows mapping from definition to declaration and from declaration to definition.
  33   class KDEVPLATFORMLANGUAGE_EXPORT FunctionDefinition : public FunctionDeclaration {
  34     public:
  35     FunctionDefinition(const SimpleRange& range, DUContext* context);
  36     FunctionDefinition(FunctionDefinitionData& data);
  37     ~FunctionDefinition();
  38
  39     /**
  40     * Find the declaration for this definition, if one exists.
  41     *
  42     * @param topContext the top-context from which to search
  43     * \returns the declaration matching this definition, otherwise null if no matching declaration has been found.
  44     * */
  45     Declaration* declaration(TopDUContext* topContext = 0) const;
  46
  47     ///Returns true if a Declaration has been assigned to this Definition
  48     bool hasDeclaration() const;
  49
  50     ///Attaches this definition to the given declaration persistently.
  51     void setDeclaration(Declaration* declaration);
  52
  53     enum {
  54       Identity = 21
  55     };
  56
  57     /**
  58     * Find the definition for the given declaration, if one exists.
  59     *
  60     * \returns the definition matching this declaration, otherwise null if no matching definition has been found.
  61     * */
  62     static FunctionDefinition* definition(const Declaration* decl);
  63
  64   protected:
  65     FunctionDefinition (const FunctionDefinition& rhs);
  66   private:
  67     virtual Declaration* clonePrivate() const;
  68     DUCHAIN_DECLARE_DATA(FunctionDefinition)
  69   };
  70 }
  71
  72 #endif