urho3d/Source/Engine/Script/Addons.h

//
// Copyright (c) 2008-2014 the Urho3D project.
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
//

#pragma once

#include "Urho3D.h"
#include "HashMap.h"
#include "Str.h"

#include <angelscript.h>

// Adapted from Angelscript's scriptarray, scriptdictionary & scriptstdstring add-ons, but with garbage collection disabled

namespace Urho3D
{

struct SArrayBuffer;
struct SArrayCache;

/// %Script array class.
class URHO3D_API CScriptArray
{
public:
    CScriptArray(asIObjectType *ot, void *buf);
    CScriptArray(asUINT length, asIObjectType *ot);
    CScriptArray(asUINT length, void *defVal, asIObjectType *ot);
    CScriptArray(const CScriptArray &other);
    virtual ~CScriptArray();

    void AddRef() const;
    void Release() const;

    // Type information
    asIObjectType *GetArrayObjectType() const;
    int GetArrayTypeId() const;
    int GetElementTypeId() const;

    void Reserve(asUINT maxElements);
    void Resize(asUINT numElements);
    asUINT GetSize() const;
    bool IsEmpty() const;

    // Get a pointer to an element. Returns 0 if out of bounds
    void *At(asUINT index);
    const void *At(asUINT index) const;

    // Set value of an element
    void SetValue(asUINT index, void *value);

    CScriptArray &operator=(const CScriptArray&);
    bool operator==(const CScriptArray &) const;

    void InsertAt(asUINT index, void *value);
    void RemoveAt(asUINT index);
    void InsertLast(void *value);
    void RemoveLast();
    void SortAsc();
    void SortDesc();
    void SortAsc(asUINT index, asUINT count);
    void SortDesc(asUINT index, asUINT count);
    void Sort(asUINT index, asUINT count, bool asc);
    void Reverse();
    int Find(void *value) const;
    int Find(asUINT index, void *value) const;

    // GC methods
    int GetRefCount();
    void SetFlag();
    bool GetFlag();
    void EnumReferences(asIScriptEngine *engine);
    void ReleaseAllHandles(asIScriptEngine *engine);

protected:
    mutable int refCount;
    mutable bool gcFlag;
    asIObjectType *objType;
    SArrayBuffer *buffer;
    int elementSize;
    int subTypeId;

    bool Less(const void *a, const void *b, bool asc, asIScriptContext *ctx, SArrayCache *cache);
    void *GetArrayItemPointer(int index);
    void *GetDataPointer(void *buffer);
    void Copy(void *dst, void *src);
    void Precache();
    bool CheckMaxSize(asUINT numElements);
    void Resize(int delta, asUINT at);
    void CreateBuffer(SArrayBuffer **buf, asUINT numElements);
    void DeleteBuffer(SArrayBuffer *buf);
    void CopyBuffer(SArrayBuffer *dst, SArrayBuffer *src);
    void Construct(SArrayBuffer *buf, asUINT start, asUINT end);
    void Destruct(SArrayBuffer *buf, asUINT start, asUINT end);
    bool Equals(const void *a, const void *b, asIScriptContext *ctx, SArrayCache *cache) const;
};

/// Script dictionary class
class CScriptDictionary
{
public:
    // Memory management
    CScriptDictionary(asIScriptEngine *engine);
    CScriptDictionary(asBYTE *buffer);
    void AddRef() const;
    void Release() const;

    CScriptDictionary &operator =(const CScriptDictionary &other);

    // Sets/Gets a variable type value for a key
    void Set(const String &key, void *value, int typeId);
    bool Get(const String &key, void *value, int typeId) const;

    // Sets/Gets an integer number value for a key
    void Set(const String &key, asINT64 &value);
    bool Get(const String &key, asINT64 &value) const;

    // Sets/Gets a real number value for a key
    void Set(const String &key, double &value);
    bool Get(const String &key, double &value) const;

    // Returns true if the key is set
    bool Exists(const String &key) const;
    bool IsEmpty() const;
    asUINT GetSize() const;

    // Deletes the key
    void Delete(const String &key);

    // Deletes all keys
    void DeleteAll();

    // Get an array of all keys
    CScriptArray *GetKeys() const;

    // Garbage collections behaviours
    int GetRefCount();
    void SetGCFlag();
    bool GetGCFlag();
    void EnumReferences(asIScriptEngine *engine);
    void ReleaseAllReferences(asIScriptEngine *engine);

protected:
    // The structure for holding the values
    struct valueStruct
    {
        union
        {
            asINT64 valueInt;
            double  valueFlt;
            void   *valueObj;
        };
        int   typeId;
    };

    // We don't want anyone to call the destructor directly, it should be called through the Release method
    virtual ~CScriptDictionary();

    // Helper methods
    void FreeValue(valueStruct &value);
    
    // Our properties
    asIScriptEngine *engine;
    mutable int refCount;
    mutable bool gcFlag;

    HashMap<String, valueStruct> dict;
};


/// Register the array type to script.
void RegisterArray(asIScriptEngine* engine);
/// Register the dictionary type to script.
void RegisterDictionary(asIScriptEngine* engine);
/// Register String to script.
void RegisterString(asIScriptEngine* engine);

}