language/duchain/parsingenvironment.h

   1 /*
   2    Copyright 2007 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 PARSINGENVIRONMENT_H
  20 #define PARSINGENVIRONMENT_H
  21
  22 #include <QtCore/QDateTime>
  23 #include <QtCore/QString>
  24
  25 #include <ksharedptr.h>
  26 #include <kurl.h>
  27
  28 #include "indexedstring.h"
  29
  30 #include "../editor/hashedstring.h"
  31 #include "../languageexport.h"
  32 #include "duchainbase.h"
  33 #include "topducontext.h"
  34
  35 namespace KDevelop
  36 {
  37
  38 class ModificationRevision; //Can be found in  editorintegrator.h
  39 class IndexedTopDUContext;
  40 /**
  41  * Just an enumeration of a few parsing-environment types.
  42  * Enumerate a few possible future parsing-environment types.
  43  * A parsing-environment could also have a type not in this enumeration,
  44  * the only important thing is that it's unique for the type.
  45  *
  46  * The type is needed to match ParsingEnvironment, ParsingEnvironmentFile, and ParsingEnvironmentManager together so they fit.
  47  * For example the c++-versions would have their specific type.
  48  *
  49  * The type must be unique(no other language may have the same type),
  50  * and the type must be persistent.(it must be same after restarting kdevelop)
  51  *
  52  * */
  53 enum ParsingEnvironmentType
  54 {
  55   StandardParsingEnvironment /**< a basic standard parsing environment */,
  56   CppParsingEnvironment      /**< a C++ parsing environment */,
  57   PythonParsingEnvironment   /**< a python parsing environment */,
  58   CMakeParsingEnvironment    /**< a CMake parsing environment */,
  59   CSharpParsingEnvironment   /**< a CSharp parsing environment */,
  60   JavaParsingEnvironment     /**< a JAva parsing environment */,
  61   RubyParsingEnvironment     /**< a Ruby parsing environment */,
  62   PhpParsingEnvironment      /**< a PHP parsing environment */
  63 };
  64
  65 /**
  66  * Use this as base-class to define new parsing-environments.
  67  *
  68  * Parsing-environments are needed for languages that create different
  69  * parsing-results depending on the environment. For example in c++,
  70  * the environment mainly consists of macros. The include-path can
  71  * be considered to be a part of the parsing-environment too, because
  72  * different files may be included using another include-path.
  73  *
  74  * The classes have to use the serialization scheme from the duchain.
  75  * Each class must be registered using REGISTER_DUCHAIN_ITEM with a unique id.
  76  *
  77  * \warning Access to this class must be serialized through du-chain locking
  78  * */
  79 class KDEVPLATFORMLANGUAGE_EXPORT ParsingEnvironment
  80 {
  81   public:
  82     ParsingEnvironment();
  83     virtual ~ParsingEnvironment();
  84
  85     ///@see ParsingEnvironmentType
  86     virtual int type() const;
  87 };
  88
  89 ///The data class used for storing. Use this as base-class of your custom data classes for classes derived from
  90 ///ParsingEnvironmentFile
  91 class KDEVPLATFORMLANGUAGE_EXPORT ParsingEnvironmentFileData : public DUChainBaseData {
  92   public:
  93   ParsingEnvironmentFileData() : m_isProxyContext(false), m_features(TopDUContext::VisibleDeclarationsAndContexts) {
  94   }
  95   bool m_isProxyContext;
  96   TopDUContext::Features m_features;
  97 };
  98
  99 /**
 100  * This represents all information about a specific parsed file that is needed
 101  * to match the file to a parsing-environment.
 102  *
 103  * It is KShared because it is embedded into top-du-contexts and at the same time
 104  * references may be held by ParsingEnvironmentManager.
 105  *
 106  * \warning Access to this class must be serialized through du-chain locking
 107  * */
 108 class KDEVPLATFORMLANGUAGE_EXPORT ParsingEnvironmentFile : public DUChainBase, public KShared
 109 {
 110   public:
 111     virtual ~ParsingEnvironmentFile();
 112     ParsingEnvironmentFile();
 113     ParsingEnvironmentFile(ParsingEnvironmentFileData& data);
 114
 115     ///@see ParsingEnvironmentType
 116     virtual int type() const;
 117
 118     ///Convenience-function that returns the top-context
 119     virtual TopDUContext* topContext() const;
 120
 121     ///Should return the indexed version of the top-context
 122     virtual KDevelop::IndexedTopDUContext indexedTopContext() const = 0;
 123
 124     ///Should return a correctly filled ModificationRevision of the source it was created from.
 125     virtual ModificationRevision modificationRevision() const = 0;
 126
 127     ///Should return whether this file matches into the given environment
 128     virtual bool matchEnvironment(const ParsingEnvironment* environment) const = 0;
 129
 130     ///Should use language-specific information to decide whether the top-context that has this data attached needs to be reparsed
 131     virtual bool needsUpdate() const = 0;
 132
 133     /**
 134      * A language-specific flag used by C++ to mark one context as a proxy of another.
 135      * If this flag is set on a context, the first imported context should be used for any computations
 136      * like searches, listing, etc. instead of using this context.
 137      *
 138      * The problems should be stored within the proxy-contexts, and optionally there may be
 139      * any count of imported proxy-contexts imported behind the content-context(This can be used for tracking problems)
 140      *
 141      * Note: This flag does not directly change the behavior of the language-independent du-chain.
 142      */
 143     bool isProxyContext() const;
 144
 145     ///Sets the flag
 146     void setIsProxyContext(bool);
 147
 148     ///The features of the attached top-context. They are automatically replicated here by the top-context, so they
 149     ///are accessible even without the top-context loaded.
 150     TopDUContext::Features features() const;
 151
 152     DUCHAIN_DECLARE_DATA(ParsingEnvironmentFile)
 153
 154   private:
 155     friend class TopDUContext;
 156     void setFeatures(TopDUContext::Features);
 157 };
 158
 159 typedef KSharedPtr<ParsingEnvironmentFile> ParsingEnvironmentFilePointer;
 160 }
 161
 162 #endif
 163