KJS::Object Class Reference

#include <object.h>

Inheritance diagram for KJS::Object:

KJS::Value List of all members.

Detailed Description

Represents an Object.

This is a wrapper for ObjectImp

Definition at line 82 of file object.h.


Public Member Functions

 Object ()
 Object (ObjectImp *v)
ObjectImpimp () const
const ClassInfoclassInfo () const
bool inherits (const ClassInfo *cinfo) const
Value prototype () const
UString className () const
Value get (ExecState *exec, const Identifier &propertyName) const
Value get (ExecState *exec, unsigned propertyName) const
void put (ExecState *exec, const Identifier &propertyName, const Value &value, int attr=None)
void put (ExecState *exec, unsigned propertyName, const Value &value, int attr=None)
bool canPut (ExecState *exec, const Identifier &propertyName) const
bool hasProperty (ExecState *exec, const Identifier &propertyName) const
bool hasProperty (ExecState *exec, unsigned propertyName) const
bool deleteProperty (ExecState *exec, const Identifier &propertyName)
bool deleteProperty (ExecState *exec, unsigned propertyName)
Value defaultValue (ExecState *exec, Type hint) const
bool implementsConstruct () const
Object construct (ExecState *exec, const List &args)
bool implementsCall () const
Value call (ExecState *exec, Object &thisObj, const List &args)
bool implementsHasInstance () const
Boolean hasInstance (ExecState *exec, const Value &value)
const ScopeChainscope () const
void setScope (const ScopeChain &s)
ReferenceList propList (ExecState *exec, bool recursive=true)
Value internalValue () const
void setInternalValue (const Value &v)

Static Public Member Functions

static Object dynamicCast (const Value &v)

Member Function Documentation

Value Object::call ( ExecState exec,
Object thisObj,
const List args 
)

Calls this object as if it is a function.

Note: This function should not be called if implementsCall() returns false, in which case it will result in an assertion failure.

See ECMA 8.6.2.3

Parameters:
exec The current execution state
thisObj The obj to be used as "this" within function execution. Note that in most cases this will be different from the C++ "this" object. For example, if the ECMAScript code "window.location.toString()" is executed, call() will be invoked on the C++ object which implements the toString method, with the thisObj being window.location
args List of arguments to be passed to the function
Returns:
The return value from the function

Definition at line 54 of file object.cpp.

bool KJS::Object::canPut ( ExecState exec,
const Identifier propertyName 
) const [inline]

Used to check whether or not a particular property is allowed to be set on an object.

See ECMA 8.6.2.3

Parameters:
exec The current execution state
propertyName The name of the property
Returns:
true if the property can be set, otherwise false

Definition at line 676 of file object.h.

UString KJS::Object::className (  )  const [inline]

Returns the class name of the object.

See ECMA 8.6.2

Returns:
The object's class name

Definition at line 661 of file object.h.

Object KJS::Object::construct ( ExecState exec,
const List args 
) [inline]

Creates a new object based on this object.

Typically this means the following: 1. A new object is created 2. The prototype of the new object is set to the value of this object's "prototype" property 3. The call() method of this object is called, with the new object passed as the this value 4. The new object is returned

In some cases, Host objects may differ from these semantics, although this is discouraged.

If an error occurs during construction, the execution state's exception will be set. This can be tested for with ExecState::hadException(). Under some circumstances, the exception object may also be returned.

Note: This function should not be called if implementsConstruct() returns false, in which case it will result in an assertion failure.

Parameters:
exec The current execution state
args The arguments to be passed to call() once the new object has been created
Returns:
The newly created & initialized object

Definition at line 697 of file object.h.

Value KJS::Object::defaultValue ( ExecState exec,
Type  hint 
) const [inline]

Converts the object into a primitive value.

The value return may differ depending on the supplied hint

See ECMA 8.6.2.6

Parameters:
exec The current execution state
hint The desired primitive type to convert to
Returns:
A primitive value converted from the objetc. Note that the type of primitive value returned may not be the same as the requested hint.

Definition at line 691 of file object.h.

bool KJS::Object::deleteProperty ( ExecState exec,
const Identifier propertyName 
) [inline]

Removes the specified property from the object.

See ECMA 8.6.2.5

Parameters:
exec The current execution state
propertyName The name of the property to delete
Returns:
true if the property was successfully deleted or did not exist on the object. false if deleting the specified property is not allowed.

Definition at line 685 of file object.h.

Object Object::dynamicCast ( const Value v  )  [static]

Converts a Value into an Object.

If the value's type is not ObjectType, a null object will be returned (i.e. one with it's internal pointer set to 0). If you do not know for sure whether the value is of type ObjectType, you should check the isValid() methods afterwards before calling any methods on the Object.

Returns:
The value converted to an object

Definition at line 46 of file object.cpp.

Value KJS::Object::get ( ExecState exec,
const Identifier propertyName 
) const [inline]

Retrieves the specified property from the object.

If neither the object or any other object in it's prototype chain have the property, this function will return Undefined.

See ECMA 8.6.2.1

Parameters:
exec The current execution state
propertyName The name of the property to retrieve
Returns:
The specified property, or Undefined

Definition at line 664 of file object.h.

Boolean KJS::Object::hasInstance ( ExecState exec,
const Value value 
) [inline]

Checks whether value delegates behavior to this object.

Used by the instanceof operator.

Parameters:
exec The current execution state
value The value to check
Returns:
true if value delegates behavior to this object, otherwise false

Definition at line 706 of file object.h.

bool KJS::Object::hasProperty ( ExecState exec,
const Identifier propertyName 
) const [inline]

Checks to see whether the object (or any object in it's prototype chain) has a property with the specified name.

See ECMA 8.6.2.4

Parameters:
exec The current execution state
propertyName The name of the property to check for
Returns:
true if the object has the property, otherwise false

Definition at line 679 of file object.h.

bool KJS::Object::implementsCall (  )  const [inline]

Whether or not the object implements the call() method.

If this returns false you should not call the call() method on this object (typically, an assertion will fail to indicate this).

Returns:
true if this object implements the call() method, otherwise false

Definition at line 700 of file object.h.

bool KJS::Object::implementsConstruct (  )  const [inline]

Whether or not the object implements the construct() method.

If this returns false you should not call the construct() method on this object (typically, an assertion will fail to indicate this).

Returns:
true if this object implements the construct() method, otherwise false

Definition at line 694 of file object.h.

bool KJS::Object::implementsHasInstance (  )  const [inline]

Whether or not the object implements the hasInstance() method.

If this returns false you should not call the hasInstance() method on this object (typically, an assertion will fail to indicate this).

Returns:
true if this object implements the hasInstance() method, otherwise false

Definition at line 703 of file object.h.

Value KJS::Object::internalValue (  )  const [inline]

Returns the internal value of the object.

This is used for objects such as String and Boolean which are wrappers for native types. The interal value is the actual value represented by the wrapper objects.

See also:
ECMA 8.6.2
Returns:
The internal value of the object

Definition at line 718 of file object.h.

ReferenceList KJS::Object::propList ( ExecState exec,
bool  recursive = true 
) [inline]

Returns a List of References to all the properties of the object.

Used in "for x in y" statements. The list is created new, so it can be freely modified without affecting the object's properties. It should be deleted by the caller.

Subclasses can override this method in ObjectImpl to provide the appearance of having extra properties other than those set specifically with put().

Parameters:
exec The current execution state
recursive Whether or not properties in the object's prototype chain should be included in the list.
Returns:
A List of References to properties of the object.

Definition at line 715 of file object.h.

Value KJS::Object::prototype (  )  const [inline]

Returns the prototype of this object.

Note that this is not the same as the "prototype" property.

See ECMA 8.6.2

Returns:
The object's prototype

Definition at line 658 of file object.h.

void KJS::Object::put ( ExecState exec,
const Identifier propertyName,
const Value value,
int  attr = None 
) [inline]

Sets the specified property.

See ECMA 8.6.2.2

Parameters:
exec The current execution state
propertyName The name of the property to set
value The value to set
attr The Attribute value for the property

Definition at line 670 of file object.h.

const ScopeChain & KJS::Object::scope (  )  const [inline]

Returns the scope of this object.

This is used when execution declared functions - the execution context for the function is initialized with extra object in it's scope. An example of this is functions declared inside other functions:

 function f() {

   function b() {
     return prototype;
   }

   var x = 4;
   // do some stuff
 }
 f.prototype = new String();

When the function f.b is executed, its scope will include properties of f. So in the example above the return value of f.b() would be the new String object that was assigned to f.prototype.

Returns:
The function's scope

Definition at line 709 of file object.h.

void KJS::Object::setInternalValue ( const Value v  )  [inline]

Sets the internal value of the object.

See also:
internalValue()
Parameters:
v The new internal value

Definition at line 721 of file object.h.


The documentation for this class was generated from the following files:
KDE Home | KDE Accessibility Home | Description of Access Keys