// -*- mode: c++; c-basic-offset: 4 -*-
/*
 * Copyright (C) 2008 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 COMPUTER, INC. ``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 COMPUTER, INC. OR
 * 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 PutPropertySlot_h
#define PutPropertySlot_h

#include "JSCJSValue.h"
#include "PropertySlot.h"

#include <wtf/Assertions.h>

namespace JSC {
    
class JSObject;
class JSFunction;

class PutPropertySlot {
public:
	enum Type { Uncachable, ExistingProperty, NewProperty, SetterProperty, CustomValue, CustomAccessor  };
	enum Context { UnknownContext, PutById, PutByIdEval };
	typedef bool (*PutValueFunc)(ExecState*, EncodedJSValue thisObject, EncodedJSValue value);

	ALWAYS_INLINE PutPropertySlot(JSValue thisValue, bool isStrictMode = false, Context context = UnknownContext, bool isInitialization = false)
		: m_type(Uncachable)
		, m_base(0)
    	, m_thisValue(thisValue)
    	, m_offset(invalidOffset)
		, m_isStrictMode(isStrictMode)
    	, m_isInitialization(isInitialization)
		, m_context(context)
		, m_cacheability(CachingAllowed)
    	, m_putFunction(0)
	{
	}

	ALWAYS_INLINE void setExistingProperty(JSObject* base, PropertyOffset offset)
	{
		m_type = ExistingProperty;
		m_base = base;
		m_offset = offset;
	}

	ALWAYS_INLINE void setNewProperty(JSObject* base, PropertyOffset offset)
	{
		m_type = NewProperty;
		m_base = base;
		m_offset = offset;
	}

    void setCustomValue(JSObject* base, PutValueFunc function)
    {
        m_type = CustomValue;
        m_base = base;
        m_putFunction = function;
    }

    void setCustomAccessor(JSObject* base, PutValueFunc function)
    {
        m_type = CustomAccessor;
        m_base = base;
        m_putFunction = function;
    }

    void setCacheableSetter(JSObject* base, PropertyOffset offset)
    {
        m_type = SetterProperty;
        m_base = base;
        m_offset = offset;
    }

    PutValueFunc customSetter() const
    {
        ASSERT(isCacheableCustom());
        return m_putFunction;
    }

	ALWAYS_INLINE Context context() const { return static_cast<Context>(m_context); }

    ALWAYS_INLINE Type type() const { return m_type; }
	ALWAYS_INLINE JSObject* base() const { return m_base; }
    JSValue thisValue() const { return m_thisValue; }

	ALWAYS_INLINE bool isStrictMode() const { return m_isStrictMode; }
	ALWAYS_INLINE bool isCacheablePut() const { return isCacheable() && (m_type == NewProperty || m_type == ExistingProperty); }
	ALWAYS_INLINE bool isCacheableSetter() const { return isCacheable() && m_type == SetterProperty; }
	ALWAYS_INLINE bool isCacheableCustom() const { return isCacheable() && (m_type == CustomValue || m_type == CustomAccessor); }
	ALWAYS_INLINE bool isCustomAccessor() const { return isCacheable() && m_type == CustomAccessor; }
	bool isInitialization() const { return m_isInitialization; }

	ALWAYS_INLINE PropertyOffset cachedOffset() const
	{
		return m_offset;
	}

    void disableCaching()
    {
        m_cacheability = CachingDisallowed;
    }

private:
    ALWAYS_INLINE bool isCacheable() const { return m_cacheability == CachingAllowed; }

	Type m_type;
	JSObject* m_base;
    JSValue m_thisValue;
	PropertyOffset m_offset;
	bool m_isStrictMode;
    bool m_isInitialization;
    uint8_t m_context;
    CacheabilityType m_cacheability;
    PutValueFunc m_putFunction;
};

} // namespace JSC

#endif // PutPropertySlot_h
