language/duchain/uses.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
  19 #ifndef USES_H
  20 #define USES_H
  21
  22 #include "../languageexport.h"
  23 #include "declarationid.h"
  24
  25
  26 namespace KDevelop {
  27
  28   class DeclarationId;
  29   class IndexedTopDUContext;
  30
  31 /**
  32  * Global mapping of Declaration-Ids to top-contexts, protected through DUChainLock.
  33  *
  34  * To retrieve the actual uses, query the duchain for the files.
  35  * */
  36   class KDEVPLATFORMLANGUAGE_EXPORT Uses {
  37     public:
  38     /// Constructor.
  39     Uses();
  40     /// Destructor.
  41     ~Uses();
  42     /**
  43      * Adds a top-context to the users-list of the given id
  44      * */
  45     void addUse(const DeclarationId& id, const IndexedTopDUContext& use);
  46     /**
  47      * Removes the given top-context from the list of uses
  48      * */
  49     void removeUse(const DeclarationId& id, const IndexedTopDUContext& use);
  50
  51     ///Gets the top-contexts of all users assigned to the declaration-id
  52     KDevVarLengthArray<IndexedTopDUContext> uses(const DeclarationId& id) const;
  53
  54     private:
  55       class UsesPrivate* d;
  56   };
  57 }
  58
  59 #endif
  60