mirror of
https://github.com/amyinspace/MagicSetEditor2.git
synced 2026-06-10 13:06:59 -04:00
twanvl
f1fe40b4ef
Added parameter to ScriptValue::next to recieve the key of the item. Finished Add Multiple Cards behaviour. git-svn-id: svn://svn.code.sf.net/p/magicseteditor/code/trunk@1147 0fc631ac-6414-0410-93d0-97cfa31319b6
126 lines
4.8 KiB
C++
126 lines
4.8 KiB
C++
//+----------------------------------------------------------------------------+
|
|
//| Description: Magic Set Editor - Program to make Magic (tm) cards |
|
|
//| Copyright: (C) 2001 - 2008 Twan van Laarhoven and "coppro" |
|
|
//| License: GNU General Public License 2 or later (see file COPYING) |
|
|
//+----------------------------------------------------------------------------+
|
|
|
|
#ifndef HEADER_SCRIPT_VALUE
|
|
#define HEADER_SCRIPT_VALUE
|
|
|
|
// ----------------------------------------------------------------------------- : Includes
|
|
|
|
#include <util/prec.hpp>
|
|
#include <gfx/color.hpp>
|
|
class Context;
|
|
class Dependency;
|
|
class ScriptClosure;
|
|
DECLARE_POINTER_TYPE(GeneratedImage);
|
|
|
|
// ----------------------------------------------------------------------------- : ScriptValue
|
|
|
|
DECLARE_POINTER_TYPE(ScriptValue);
|
|
|
|
enum ScriptType
|
|
{ SCRIPT_NIL
|
|
, SCRIPT_INT
|
|
, SCRIPT_BOOL
|
|
, SCRIPT_DOUBLE
|
|
, SCRIPT_STRING
|
|
, SCRIPT_COLOR
|
|
, SCRIPT_IMAGE
|
|
, SCRIPT_FUNCTION
|
|
, SCRIPT_OBJECT // Only ScriptObject
|
|
, SCRIPT_COLLECTION
|
|
, SCRIPT_REGEX
|
|
, SCRIPT_ITERATOR
|
|
, SCRIPT_DUMMY
|
|
, SCRIPT_ERROR
|
|
};
|
|
|
|
enum CompareWhat
|
|
{ COMPARE_NO
|
|
, COMPARE_AS_STRING
|
|
, COMPARE_AS_POINTER
|
|
};
|
|
|
|
/// A value that can be handled by the scripting engine.
|
|
/// Actual values are derived types
|
|
class ScriptValue : public IntrusivePtrBaseWithDelete {
|
|
public:
|
|
virtual ~ScriptValue() {}
|
|
|
|
/// Information on the type of this value
|
|
virtual ScriptType type() const = 0;
|
|
/// Name of the type of value
|
|
virtual String typeName() const = 0;
|
|
/// How to compare this object?
|
|
/** Returns 1 if the pointer should be used, 0 otherwise */
|
|
virtual CompareWhat compareAs(String& compare_str, void const*& compare_ptr) const;
|
|
|
|
/// Convert this value to a string
|
|
virtual operator String() const;
|
|
/// Convert this value to a double
|
|
virtual operator double() const;
|
|
/// Convert this value to an integer
|
|
virtual operator int() const;
|
|
/// Convert this value to a boolean
|
|
virtual operator bool() const;
|
|
/// Convert this value to a color
|
|
virtual operator AColor() const;
|
|
|
|
/// Script code to generate this value
|
|
virtual String toCode() const;
|
|
|
|
/// Explicit overload to convert to a string
|
|
/** This is sometimes necessary, because wxString has an int constructor,
|
|
* which confuses gcc. */
|
|
inline String toString() const { return *this; }
|
|
/// Convert this value to an image
|
|
virtual GeneratedImageP toImage(const ScriptValueP& thisP) const;
|
|
|
|
/// Get a member variable from this value
|
|
virtual ScriptValueP getMember(const String& name) const;
|
|
|
|
/// Signal that a script depends on this value itself
|
|
virtual void dependencyThis(const Dependency& dep);
|
|
/// Signal that a script depends on a member of this value
|
|
/** It is the abstract version of getMember*/
|
|
virtual ScriptValueP dependencyMember(const String& name, const Dependency&) const;
|
|
/// Signal that a script depends on a member of container, with the name of this
|
|
/** This function allows for a kind of visitor pattern over dependencyMember */
|
|
virtual ScriptValueP dependencyName(const ScriptValue& container, const Dependency&) const;
|
|
|
|
/// Evaluate this value (if it is a function)
|
|
virtual ScriptValueP eval(Context&) const;
|
|
/// Mark the scripts that this function depends on
|
|
/** Return value is an abstract version of the return value of eval */
|
|
virtual ScriptValueP dependencies(Context&, const Dependency&) const;
|
|
/// Simplify/optimize a default argument closure of this function.
|
|
/** Should return a simplification of the closure or null to keep the closure.
|
|
* Alternatively, the closure may be modified in place.
|
|
*/
|
|
virtual ScriptValueP simplifyClosure(ScriptClosure&) const;
|
|
|
|
/// Return an iterator for the current collection, an iterator is a value that has next()
|
|
/** thisP can be used to prevent destruction of the collection */
|
|
virtual ScriptValueP makeIterator(const ScriptValueP& thisP) const;
|
|
/// Return the next item for this iterator, or ScriptValueP() if there is no such item
|
|
/** If key_out != 0, then it will recieve the key of the item */
|
|
virtual ScriptValueP next(ScriptValueP* key_out = nullptr);
|
|
/// Return the number of items in this value (assuming it is a collection)
|
|
virtual int itemCount() const;
|
|
/// Get a member at the given index
|
|
virtual ScriptValueP getIndex(int index) const;
|
|
};
|
|
|
|
extern ScriptValueP script_nil; ///< The preallocated nil value
|
|
extern ScriptValueP script_true; ///< The preallocated true value
|
|
extern ScriptValueP script_false; ///< The preallocated false value
|
|
extern ScriptValueP dependency_dummy; ///< Dummy value used during dependency analysis
|
|
|
|
/// compare script values for equallity
|
|
bool equal(const ScriptValueP& a, const ScriptValueP& b);
|
|
|
|
// ----------------------------------------------------------------------------- : EOF
|
|
#endif
|