[apple/javascriptcore.git] / bytecode / DataFormat.h

/*
 * Copyright (C) 2011 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. ``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
 * 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 DataFormat_h
#define DataFormat_h

#include <wtf/Assertions.h>

namespace JSC {

// === DataFormat ===
//
// This enum tracks the current representation in which a value is being held.
// Values may be unboxed primitives (int32, double, or cell), or boxed as a JSValue.
// For boxed values, we may know the type of boxing that has taken place.
// (May also need bool, array, object, string types!)
enum DataFormat {
    DataFormatNone = 0,
    DataFormatInt32 = 1,
    DataFormatInt52 = 2, // Int52's are left-shifted by 16 by default.
    DataFormatStrictInt52 = 3, // "Strict" Int52 means it's not shifted.
    DataFormatDouble = 4,
    DataFormatBoolean = 5,
    DataFormatCell = 6,
    DataFormatStorage = 7,
    DataFormatJS = 8,
    DataFormatJSInt32 = DataFormatJS | DataFormatInt32,
    DataFormatJSDouble = DataFormatJS | DataFormatDouble,
    DataFormatJSCell = DataFormatJS | DataFormatCell,
    DataFormatJSBoolean = DataFormatJS | DataFormatBoolean,
    
    // Marker deliminating ordinary data formats and OSR-only data formats.
    DataFormatOSRMarker = 32, 
    
    // Special data formats used only for OSR.
    DataFormatDead = 33, // Implies jsUndefined().
    DataFormatArguments = 34 // Implies that the arguments object must be reified.
};

inline const char* dataFormatToString(DataFormat dataFormat)
{
    switch (dataFormat) {
    case DataFormatNone:
        return "None";
    case DataFormatInt32:
        return "Int32";
    case DataFormatInt52:
        return "Int52";
    case DataFormatStrictInt52:
        return "StrictInt52";
    case DataFormatDouble:
        return "Double";
    case DataFormatCell:
        return "Cell";
    case DataFormatBoolean:
        return "Boolean";
    case DataFormatStorage:
        return "Storage";
    case DataFormatJS:
        return "JS";
    case DataFormatJSInt32:
        return "JSInt32";
    case DataFormatJSDouble:
        return "JSDouble";
    case DataFormatJSCell:
        return "JSCell";
    case DataFormatJSBoolean:
        return "JSBoolean";
    case DataFormatDead:
        return "Dead";
    case DataFormatArguments:
        return "Arguments";
    default:
        RELEASE_ASSERT_NOT_REACHED();
        return "Unknown";
    }
}

inline bool isJSFormat(DataFormat format, DataFormat expectedFormat)
{
    ASSERT(expectedFormat & DataFormatJS);
    return (format | DataFormatJS) == expectedFormat;
}

inline bool isJSInt32(DataFormat format)
{
    return isJSFormat(format, DataFormatJSInt32);
}

inline bool isJSDouble(DataFormat format)
{
    return isJSFormat(format, DataFormatJSDouble);
}

inline bool isJSCell(DataFormat format)
{
    return isJSFormat(format, DataFormatJSCell);
}

inline bool isJSBoolean(DataFormat format)
{
    return isJSFormat(format, DataFormatJSBoolean);
}

}

#endif // DataFormat_h
Commit	Line	Data
6fe7ccc8 A	1	/*
	2	* Copyright (C) 2011 Apple Inc. All rights reserved.
	3	*
	4	* Redistribution and use in source and binary forms, with or without
	5	* modification, are permitted provided that the following conditions
	6	* are met:
	7	* 1. Redistributions of source code must retain the above copyright
	8	* notice, this list of conditions and the following disclaimer.
	9	* 2. Redistributions in binary form must reproduce the above copyright
	10	* notice, this list of conditions and the following disclaimer in the
	11	* documentation and/or other materials provided with the distribution.
	12	*
	13	* THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
	14	* EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
	15	* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
	16	* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR
	17	* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
	18	* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
	19	* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
	20	* PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
	21	* OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
	22	* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
	23	* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
	24	*/
	25
	26	#ifndef DataFormat_h
	27	#define DataFormat_h
	28
	29	#include <wtf/Assertions.h>
	30
	31	namespace JSC {
	32
	33	// === DataFormat ===
	34	//
	35	// This enum tracks the current representation in which a value is being held.
	36	// Values may be unboxed primitives (int32, double, or cell), or boxed as a JSValue.
	37	// For boxed values, we may know the type of boxing that has taken place.
	38	// (May also need bool, array, object, string types!)
	39	enum DataFormat {
	40	DataFormatNone = 0,
81345200 A	41	DataFormatInt32 = 1,
	42	DataFormatInt52 = 2, // Int52's are left-shifted by 16 by default.
	43	DataFormatStrictInt52 = 3, // "Strict" Int52 means it's not shifted.
	44	DataFormatDouble = 4,
	45	DataFormatBoolean = 5,
	46	DataFormatCell = 6,
	47	DataFormatStorage = 7,
6fe7ccc8	48	DataFormatJS = 8,
81345200	49	DataFormatJSInt32 = DataFormatJS \| DataFormatInt32,
6fe7ccc8 A	50	DataFormatJSDouble = DataFormatJS \| DataFormatDouble,
6fe7ccc8 A	51	DataFormatJSCell = DataFormatJS \| DataFormatCell,
93a37866 A	52	DataFormatJSBoolean = DataFormatJS \| DataFormatBoolean,
	53
	54	// Marker deliminating ordinary data formats and OSR-only data formats.
	55	DataFormatOSRMarker = 32,
	56
	57	// Special data formats used only for OSR.
	58	DataFormatDead = 33, // Implies jsUndefined().
	59	DataFormatArguments = 34 // Implies that the arguments object must be reified.
6fe7ccc8 A	60	};
	61
	62	inline const char* dataFormatToString(DataFormat dataFormat)
	63	{
	64	switch (dataFormat) {
	65	case DataFormatNone:
	66	return "None";
81345200 A	67	case DataFormatInt32:
	68	return "Int32";
	69	case DataFormatInt52:
	70	return "Int52";
	71	case DataFormatStrictInt52:
	72	return "StrictInt52";
6fe7ccc8 A	73	case DataFormatDouble:
	74	return "Double";
	75	case DataFormatCell:
	76	return "Cell";
	77	case DataFormatBoolean:
	78	return "Boolean";
	79	case DataFormatStorage:
	80	return "Storage";
	81	case DataFormatJS:
	82	return "JS";
81345200 A	83	case DataFormatJSInt32:
81345200 A	84	return "JSInt32";
6fe7ccc8 A	85	case DataFormatJSDouble:
	86	return "JSDouble";
	87	case DataFormatJSCell:
	88	return "JSCell";
	89	case DataFormatJSBoolean:
	90	return "JSBoolean";
93a37866 A	91	case DataFormatDead:
	92	return "Dead";
	93	case DataFormatArguments:
	94	return "Arguments";
6fe7ccc8	95	default:
93a37866	96	RELEASE_ASSERT_NOT_REACHED();
6fe7ccc8 A	97	return "Unknown";
	98	}
	99	}
	100
6fe7ccc8 A	101	inline bool isJSFormat(DataFormat format, DataFormat expectedFormat)
	102	{
	103	ASSERT(expectedFormat & DataFormatJS);
	104	return (format \| DataFormatJS) == expectedFormat;
	105	}
	106
81345200	107	inline bool isJSInt32(DataFormat format)
6fe7ccc8	108	{
81345200	109	return isJSFormat(format, DataFormatJSInt32);
6fe7ccc8 A	110	}
	111
	112	inline bool isJSDouble(DataFormat format)
	113	{
	114	return isJSFormat(format, DataFormatJSDouble);
	115	}
	116
	117	inline bool isJSCell(DataFormat format)
	118	{
	119	return isJSFormat(format, DataFormatJSCell);
	120	}
	121
	122	inline bool isJSBoolean(DataFormat format)
	123	{
	124	return isJSFormat(format, DataFormatJSBoolean);
	125	}
	126
	127	}
	128
	129	#endif // DataFormat_h