juce/source/src/containers/juce_DynamicObject.h

   1 /*
   2   ==============================================================================
   3
   4    This file is part of the JUCE library - "Jules' Utility Class Extensions"
   5    Copyright 2004-11 by Raw Material Software Ltd.
   6
   7   ------------------------------------------------------------------------------
   8
   9    JUCE can be redistributed and/or modified under the terms of the GNU General
  10    Public License (Version 2), as published by the Free Software Foundation.
  11    A copy of the license is included in the JUCE distribution, or can be found
  12    online at www.gnu.org/licenses.
  13
  14    JUCE is distributed in the hope that it will be useful, but WITHOUT ANY
  15    WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
  16    A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
  17
  18   ------------------------------------------------------------------------------
  19
  20    To release a closed-source product which uses JUCE, commercial licenses are
  21    available: visit www.rawmaterialsoftware.com/juce for more information.
  22
  23   ==============================================================================
  24 */
  25
  26 #ifndef __JUCE_DYNAMICOBJECT_JUCEHEADER__
  27 #define __JUCE_DYNAMICOBJECT_JUCEHEADER__
  28
  29 #include "juce_NamedValueSet.h"
  30 #include "../memory/juce_ReferenceCountedObject.h"
  31
  32
  33 //==============================================================================
  34 /**
  35     Represents a dynamically implemented object.
  36
  37     This class is primarily intended for wrapping scripting language objects,
  38     but could be used for other purposes.
  39
  40     An instance of a DynamicObject can be used to store named properties, and
  41     by subclassing hasMethod() and invokeMethod(), you can give your object
  42     methods.
  43 */
  44 class JUCE_API  DynamicObject  : public ReferenceCountedObject
  45 {
  46 public:
  47     //==============================================================================
  48     DynamicObject();
  49
  50     /** Destructor. */
  51     virtual ~DynamicObject();
  52
  53     //==============================================================================
  54     /** Returns true if the object has a property with this name.
  55         Note that if the property is actually a method, this will return false.
  56     */
  57     virtual bool hasProperty (const Identifier& propertyName) const;
  58
  59     /** Returns a named property.
  60
  61         This returns a void if no such property exists.
  62     */
  63     virtual var getProperty (const Identifier& propertyName) const;
  64
  65     /** Sets a named property. */
  66     virtual void setProperty (const Identifier& propertyName, const var& newValue);
  67
  68     /** Removes a named property. */
  69     virtual void removeProperty (const Identifier& propertyName);
  70
  71     //==============================================================================
  72     /** Checks whether this object has the specified method.
  73
  74         The default implementation of this just checks whether there's a property
  75         with this name that's actually a method, but this can be overridden for
  76         building objects with dynamic invocation.
  77     */
  78     virtual bool hasMethod (const Identifier& methodName) const;
  79
  80     /** Invokes a named method on this object.
  81
  82         The default implementation looks up the named property, and if it's a method
  83         call, then it invokes it.
  84
  85         This method is virtual to allow more dynamic invocation to used for objects
  86         where the methods may not already be set as properies.
  87     */
  88     virtual var invokeMethod (const Identifier& methodName,
  89                               const var* parameters,
  90                               int numParameters);
  91
  92     /** Sets up a method.
  93
  94         This is basically the same as calling setProperty (methodName, (var::MethodFunction) myFunction), but
  95         helps to avoid accidentally invoking the wrong type of var constructor. It also makes
  96         the code easier to read,
  97
  98         The compiler will probably force you to use an explicit cast your method to a (var::MethodFunction), e.g.
  99         @code
 100         setMethod ("doSomething", (var::MethodFunction) &MyClass::doSomething);
 101         @endcode
 102     */
 103     void setMethod (const Identifier& methodName,
 104                     var::MethodFunction methodFunction);
 105
 106     //==============================================================================
 107     /** Removes all properties and methods from the object. */
 108     void clear();
 109
 110     /** Returns the NamedValueSet that holds the object's properties. */
 111     NamedValueSet& getProperties() noexcept     { return properties; }
 112
 113 private:
 114     //==============================================================================
 115     NamedValueSet properties;
 116
 117     JUCE_LEAK_DETECTOR (DynamicObject);
 118 };
 119
 120
 121
 122 #endif   // __JUCE_DYNAMICOBJECT_JUCEHEADER__