urho3d/Engine/Script/RegisterArray.h

//
// Urho3D Engine
// Copyright (c) 2008-2011 Lasse Öörni
//
// 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.
//

#ifndef SCRIPT_REGISTERARRAY_H
#define SCRIPT_REGISTERARRAY_H

#include <angelscript.h>

// Adapted from Angelscript's scriptarray add-on

struct SArrayBuffer;

//! A script array type
class CScriptArray
{
public:
    CScriptArray(asUINT length, asIObjectType* ot);
    CScriptArray(asUINT length, void* defVal, asIObjectType* ot);
    virtual ~CScriptArray();
    
    void AddRef() const;
    void Release() const;
    
    // Type information
    asIObjectType* GetArrayObjectType() const;
    int GetArrayTypeId() const;
    int GetElementTypeId() const;
    
    void Resize(asUINT numElements);
    asUINT GetSize() const;
    
    // Get a pointer to an element. Returns 0 if out of bounds
    void* At(asUINT index);
    
    CScriptArray& operator = (const CScriptArray&);
    
    // TODO: Add methods Sort, Reverse, Find, etc
    void InsertAt(asUINT index, void *value);
    void RemoveAt(asUINT index);
    void InsertLast(void *value);
    void RemoveLast();
    
    // 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;
    bool isArrayOfHandles;
    int elementSize;
    
    bool CheckMaxSize(asUINT numElements);
    
    void Resize(int delta, asUINT at);
    void SetValue(asUINT index, void *value);
    
    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);
};

//! Register the array type to script
void registerArray(asIScriptEngine* engine);

#endif // SCRIPT_REGISTERARRAY_H