Roll out r108309, r108323, and r108326
[WebKit-https.git] / Source / JavaScriptCore / runtime / JSTypeInfo.h
1 // -*- mode: c++; c-basic-offset: 4 -*-
2 /*
3  * Copyright (C) 2008 Apple Inc. All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
15  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
17  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
18  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
19  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
20  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
21  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
22  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
24  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
25  */
26
27 #ifndef JSTypeInfo_h
28 #define JSTypeInfo_h
29
30 // This file would be called TypeInfo.h, but that conflicts with <typeinfo.h>
31 // in the STL on systems without case-sensitive file systems. 
32
33 #include "JSType.h"
34
35 namespace JSC {
36
37     static const unsigned MasqueradesAsUndefined = 1; // WebCore uses MasqueradesAsUndefined to make document.all undetectable.
38     static const unsigned ImplementsHasInstance = 1 << 1;
39     static const unsigned OverridesHasInstance = 1 << 2;
40     static const unsigned ImplementsDefaultHasInstance = 1 << 3;
41     static const unsigned IsEnvironmentRecord = 1 << 4;
42     static const unsigned OverridesGetOwnPropertySlot = 1 << 5;
43     static const unsigned OverridesVisitChildren = 1 << 6;
44     static const unsigned OverridesGetPropertyNames = 1 << 7;
45     static const unsigned ProhibitsPropertyCaching = 1 << 8;
46
47     class TypeInfo {
48     public:
49         TypeInfo(JSType type, unsigned flags = 0)
50             : m_type(type)
51             , m_flags(flags & 0xff)
52             , m_flags2(flags >> 8)
53         {
54             ASSERT(flags <= 0x3ff);
55             ASSERT(type <= 0xff);
56             ASSERT(type >= CompoundType || !(flags & OverridesVisitChildren));
57             // No object that doesn't ImplementsHasInstance should override it!
58             ASSERT((m_flags & (ImplementsHasInstance | OverridesHasInstance)) != OverridesHasInstance);
59             // ImplementsDefaultHasInstance means (ImplementsHasInstance & !OverridesHasInstance)
60             if ((m_flags & (ImplementsHasInstance | OverridesHasInstance)) == ImplementsHasInstance)
61                 m_flags |= ImplementsDefaultHasInstance;
62         }
63
64         JSType type() const { return static_cast<JSType>(m_type); }
65         bool isObject() const { return type() >= ObjectType; }
66         bool isFinalObject() const { return type() == FinalObjectType; }
67         bool isNumberObject() const { return type() == NumberObjectType; }
68
69         bool masqueradesAsUndefined() const { return isSetOnFlags1(MasqueradesAsUndefined); }
70         bool implementsHasInstance() const { return isSetOnFlags1(ImplementsHasInstance); }
71         bool isEnvironmentRecord() const { return isSetOnFlags1(IsEnvironmentRecord); }
72         bool overridesHasInstance() const { return isSetOnFlags1(OverridesHasInstance); }
73         bool implementsDefaultHasInstance() const { return isSetOnFlags1(ImplementsDefaultHasInstance); }
74         bool overridesGetOwnPropertySlot() const { return isSetOnFlags1(OverridesGetOwnPropertySlot); }
75         bool overridesVisitChildren() const { return isSetOnFlags1(OverridesVisitChildren); }
76         bool overridesGetPropertyNames() const { return isSetOnFlags1(OverridesGetPropertyNames); }
77         bool prohibitsPropertyCaching() const { return isSetOnFlags2(ProhibitsPropertyCaching); }
78
79         static ptrdiff_t flagsOffset()
80         {
81             return OBJECT_OFFSETOF(TypeInfo, m_flags);
82         }
83
84         static ptrdiff_t typeOffset()
85         {
86             return OBJECT_OFFSETOF(TypeInfo, m_type);
87         }
88
89     private:
90         bool isSetOnFlags1(unsigned flag) const { ASSERT(flag <= (1 << 7)); return m_flags & flag; }
91         bool isSetOnFlags2(unsigned flag) const { ASSERT(flag >= (1 << 8)); return m_flags2 & (flag >> 8); }
92
93         unsigned char m_type;
94         unsigned char m_flags;
95         unsigned char m_flags2;
96     };
97
98 }
99
100 #endif // JSTypeInfo_h