editors/sc-ide/core/sc_introspection.hpp

   1 /*
   2     SuperCollider Qt IDE
   3     Copyright (c) 2012 Jakob Leben & Tim Blechmann
   4     http://www.audiosynth.com
   5
   6     This program is free software; you can redistribute it and/or modify
   7     it under the terms of the GNU General Public License as published by
   8     the Free Software Foundation; either version 2 of the License, or
   9     (at your option) any later version.
  10
  11     This program is distributed in the hope that it will be useful,
  12     but WITHOUT ANY WARRANTY; without even the implied warranty of
  13     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14     GNU General Public License for more details.
  15
  16     You should have received a copy of the GNU General Public License
  17     along with this program; if not, write to the Free Software
  18     Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301  USA
  19 */
  20
  21 #ifndef SCIDE_CORE_SC_INTROSPECTION_HPP_INCLUDED
  22 #define SCIDE_CORE_SC_INTROSPECTION_HPP_INCLUDED
  23
  24 #include <QHash>
  25 #include <QList>
  26 #include <QMap>
  27 #include <QMetaType>
  28 #include <QSharedPointer>
  29 #include <QString>
  30 #include <QVector>
  31
  32 #include <string>
  33 #include <map>
  34
  35 #include <boost/flyweight.hpp>
  36
  37
  38 static inline std::size_t hash_value(QString const& b)
  39 {
  40     return qHash(b);
  41 }
  42
  43 namespace ScIDE {
  44
  45 namespace ScLanguage {
  46
  47 typedef boost::flyweight<QString> FlyweightString;
  48
  49 typedef std::map<QString, QSharedPointer<class Class> > ClassMap;
  50 typedef std::multimap<QString, QSharedPointer<class Method> > MethodMap;
  51 typedef QVector<class Argument> ArgumentVector;
  52 typedef QVector<class Method*> MethodVector;
  53
  54 struct Argument {
  55     FlyweightString name;
  56     FlyweightString defaultValue;
  57 };
  58
  59 struct Class {
  60     FlyweightString name;
  61     Class *metaClass;
  62     Class *superClass;
  63     MethodVector methods;
  64     struct {
  65         FlyweightString path;
  66         int position;
  67     } definition;
  68 };
  69
  70 struct Method {
  71     Class *ownerClass;
  72     FlyweightString name;
  73     ArgumentVector arguments;
  74     struct {
  75         FlyweightString path;
  76         int position;
  77     } definition;
  78 };
  79
  80 class Introspection
  81 {
  82 public:
  83     Introspection();
  84     ~Introspection();
  85
  86     typedef QMap< QString, QList<Method*> > ClassMethodMap; // maps Path to List of Methods
  87
  88     bool parse(const QString & yamlString );
  89
  90     const ClassMap & classMap() const { return mClassMap; }
  91     const MethodMap & methodMap() const { return mMethodMap; }
  92
  93     const Class * findClass( QString const & className ) const;
  94     ClassMethodMap constructMethodMap( const Class * klass ) const;
  95     ClassMethodMap constructMethodMap( QString const & className ) const
  96     {
  97         return constructMethodMap(findClass(className));
  98     }
  99
 100     QString const & classLibraryPath() const
 101     {
 102         return mClassLibraryPath;
 103     }
 104
 105     // remove class library path, userExtensionDir and systemExtensionDir
 106     QString compactLibraryPath(QString const & path) const;
 107
 108 private:
 109     void inferClassLibraryPath();
 110
 111     void clear()
 112     {
 113         mClassMap.clear();
 114         mMethodMap.clear();
 115         mClassLibraryPath.clear();
 116     }
 117
 118     ClassMap mClassMap;
 119     MethodMap mMethodMap;
 120     QString mClassLibraryPath;
 121     QString mUserExtensionDir;
 122     QString mSystemExtensionDir;
 123 };
 124
 125 } // namespace ScLanguage
 126
 127 } // namespace ScIDE
 128
 129 Q_DECLARE_METATYPE(ScIDE::ScLanguage::Class*)
 130 Q_DECLARE_METATYPE(const ScIDE::ScLanguage::Method*)
 131
 132 #endif // SCIDE_CORE_SC_INTROSPECTION_HPP_INCLUDED