Source/WebKit2/Shared/ImmutableArray.h

/*
 * Copyright (C) 2010 Apple Inc. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
 * THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef ImmutableArray_h
#define ImmutableArray_h

#include "APIObject.h"
#include <wtf/PassOwnArrayPtr.h>
#include <wtf/PassRefPtr.h>
#include <wtf/Vector.h>

namespace WebKit {

// ImmutableArray - An immutable array type suitable for vending to an API.

class ImmutableArray : public APIObject {
public:
    static const Type APIType = TypeArray;

    static PassRefPtr<ImmutableArray> create()
    {
        return adoptRef(new ImmutableArray);
    }
    static PassRefPtr<ImmutableArray> create(APIObject** entries, size_t size)
    {
        return adoptRef(new ImmutableArray(entries, size));
    }
    static PassRefPtr<ImmutableArray> adopt(Vector<RefPtr<APIObject> >& entries)
    {
        return adoptRef(new ImmutableArray(entries));
    }

    virtual ~ImmutableArray();

    template<typename T>
    T* at(size_t i) { if (m_entries[i]->type() != T::APIType) return 0; return static_cast<T*>(m_entries[i].get()); }

    APIObject* at(size_t i) { return m_entries[i].get(); }
    size_t size() { return m_entries.size(); }

    virtual bool isMutable() { return false; }

protected:
    ImmutableArray();
    ImmutableArray(APIObject** entries, size_t size);
    ImmutableArray(Vector<RefPtr<APIObject> >& entries);

    virtual Type type() const { return APIType; }

    Vector<RefPtr<APIObject> > m_entries;
};

} // namespace WebKit

#endif // ImmutableArray_h