kjs/JSWrapperObject.h

   1 // -*- mode: c++; c-basic-offset: 4 -*-
   2 /*
   3  *  Copyright (C) 2006 Maks Orlovich <maksim@kde.org>
   4  *  Copyright (C) 2006 Apple Computer, Inc.
   5  *
   6  *  This library is free software; you can redistribute it and/or
   7  *  modify it under the terms of the GNU Library General Public
   8  *  License as published by the Free Software Foundation; either
   9  *  version 2 of the License, or (at your option) any later version.
  10  *
  11  *  This library is distributed in the hope that it will be useful,
  12  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  *  Library General Public License for more details.
  15  *
  16  *  You should have received a copy of the GNU Library General Public License
  17  *  along with this library; see the file COPYING.LIB.  If not, write to
  18  *  the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  19  *  Boston, MA 02110-1301, USA.
  20  *
  21  */
  22
  23 #ifndef KJS_JSWrapperObject_h
  24 #define KJS_JSWrapperObject_h
  25
  26 #include "object.h"
  27
  28 namespace KJS {
  29
  30     /**
  31         This class is used as a base for classes such as String,
  32         Number, Boolean and Date which which are wrappers for primitive
  33        types. These classes stores the internal value, which is the
  34        actual value represented by the wrapper objects.
  35     */
  36     class JSWrapperObject : public JSObject {
  37     public:
  38         JSWrapperObject(JSValue* proto);
  39
  40         /**
  41          * Returns the internal value of the object. This is used for objects such
  42          * as String and Boolean which are wrappers for native types. The interal
  43          * value is the actual value represented by the wrapper objects.
  44          *
  45          * @see ECMA 8.6.2
  46          * @return The internal value of the object
  47          */
  48         JSValue* internalValue() const;
  49
  50         /**
  51          * Sets the internal value of the object
  52          *
  53          * @see internalValue()
  54          *
  55          * @param v The new internal value
  56          */
  57         void setInternalValue(JSValue* v);
  58
  59         virtual void mark();
  60
  61         /**
  62          * Returns the prototype this object had during construction
  63          */
  64         JSValue* originalProto() const;
  65     private:
  66         JSValue* m_internalValue;
  67         JSValue* m_originalProto;
  68     };
  69
  70     inline JSWrapperObject::JSWrapperObject(JSValue* proto)
  71         : JSObject(proto)
  72         , m_internalValue(0)
  73         , m_originalProto(proto)
  74     {
  75     }
  76
  77     inline JSValue* JSWrapperObject::internalValue() const
  78     {
  79         return m_internalValue;
  80     }
  81
  82     inline JSValue* JSWrapperObject::originalProto() const
  83     {
  84         return m_originalProto;
  85     }
  86
  87     inline void JSWrapperObject::setInternalValue(JSValue* v)
  88     {
  89         ASSERT(v);
  90         m_internalValue = v;
  91     }
  92
  93 } // namespace KJS
  94
  95 #endif // KJS_JSWrapperObject_h
  96 // kate: indent-width 4; replace-tabs on; tab-width 4; space-indent on; hl c++;