array.h

/*************************************************************************/
/*  array.h                                                              */
/*************************************************************************/
/*                       This file is part of:                           */
/*                           GODOT ENGINE                                */
/*                    http://www.godotengine.org                         */
/*************************************************************************/
/* Copyright (c) 2007-2016 Juan Linietsky, Ariel Manzur.                 */
/*                                                                       */
/* 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 ARRAY_H
#define ARRAY_H

#include "typedefs.h"
class Variant;
class ArrayPrivate;
class Object;
class StringName;

class Array {

    mutable ArrayPrivate *_p;
    void _ref(const Array& p_from) const;
    void _unref() const;

public:

    Variant& operator[](int p_idx);
    const Variant& operator[](int p_idx) const;

    void set(int p_idx,const Variant& p_value);
    const Variant& get(int p_idx) const;

    int size() const;
    bool empty() const;
    void clear();

    bool is_shared() const;

    bool operator==(const Array& p_array) const;

    uint32_t hash() const;
    void operator=(const Array& p_array);

    void push_back(const Variant& p_value);
    _FORCE_INLINE_ void append(const Variant& p_value) { push_back(p_value); } //for python compatibility
    Error resize(int p_new_size);

    void insert(int p_pos, const Variant& p_value);
    void remove(int p_pos);

    void sort();
    void sort_custom(Object *p_obj,const StringName& p_function);
    void invert();

    int find(const Variant& p_value) const;

    void erase(const Variant& p_value);

    void push_front(const Variant& p_value);
    void pop_back();
    void pop_front();

    Array(const Array& p_from);
    Array(bool p_shared=false);
    ~Array();

};

#endif // ARRAY_H