Changeset 70

Timestamp:

07/04/07 08:37:24 (1 year ago)

Author:

dan.lewis

Message:

Comment modifications to enhance DDoc output for Global and Object methods.

Files:

• branches/1.9/documentation/methods.html (modified) (3 diffs)
• branches/1.9/source/methods.d (modified) (9 diffs)

branches/1.9/documentation/methods.html

@@ -20 +20 @@
-<dl><dt><big>static Value  <u>Global_init</u>();
-</big></dt>
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-<br><br>
-
@@ -26 +220 @@
-<dt><big>static Value  <u>Global_Object</u>(inout Value <i>self</i>, inout Value <i>cc</i>, Value [] <i>arguments</i>...);
-</big></dt>
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-<br><br>
-
@@ -32 +338 @@
-<dt><big>static Value  <u>Global_Function</u>(inout Value <i>self</i>, inout Value <i>cc</i>, Value [] <i>arguments</i>...);
-</big></dt>
-
-
-
+
-<br><br>
-

branches/1.9/source/methods.d

@@ -20 +20 @@
-
-
-
+
+
+
+
+
+
+
+
-static Value Global_init(){
-    /**
-        The Global_init() can be used to call any initialization
-        code that needs to be executed before the source code is
-        evaluated.
-    
-        By default, Walnut provides most of the initial program
-        structure in the structure.d file which doesn't require
-        initialization code.
-    */
-    return Global;
-}
+
+/**
+    Bugs: incomplete!
+    Standards: ECMA 15.1.2.1
+    Arguments: [0] = string to be evaluated
+    Throws: EvalError
+    Returns: Value result of evaluated expression.
+    Synopsis: Global_eval is called to evaluate a buffer of source code.  The method is used even to evaluate file contents; the main script.
+*/
-static Value Global_eval(inout Value self, inout Value cc, Value[] arguments ...) {
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
-static Value Global_parseInt(inout Value self, inout Value cc, Value[] arguments ...) {
-    /// ECMA 15.1.2.2
-    // BUG: this currently assumes a decimal value
-    if(arguments.length) {
-        return cast(Value) arguments[0].toInteger();
@@ -50 +58 @@
-    return NAN;
-}
+
+/**
+    Bugs: Does not yet allow a non-decimal radix, or E notation.
+    Standards: ECMA 15.1.2.3
+    Arguments: [0] = string to be parsed
+    Returns: double Value or NaN if the value is not a valid integer.
+    Synopsis: Global_parseFloat is called to cast a string into a double.
+*/
-static Value Global_parseFloat(inout Value self, inout Value cc, Value[] arguments ...) {
-    /// ECMA 15.1.2.3
-    // BUG: this currently assumes a decimal value
-    if(arguments.length) {
-        return cast(Value) arguments[0].toDouble();
@@ -58 +72 @@
-    return NAN;
-}
+
+/**
+    Bugs: Incomplete!
+    Standards: non-standard.
+    Arguments: [0] = string to be escaped
+    Returns: string with any characters needing an escape sequence converted to their escaped equivalent.
+    Synopsis: 
+*/
-static Value Global_escape(inout Value self, inout Value cc, Value[] arguments ...) {
-
-
-
+
+
+
+
+
+
+
+
+
+
-static Value Global_unescape(inout Value self, inout Value cc, Value[] arguments ...) {
-
-
-
+
+
+
+
+
+
+
+
+
-static Value Global_isNaN(inout Value self, inout Value cc, Value[] arguments ...) {
-
-
-
+
+
+
+
+
+
+
+
+
-static Value Global_isFinite(inout Value self, inout Value cc, Value[] arguments ...) {
-    /// ECMA 15.1.2.5
-    return cast(Value) (arguments.length && isfinite(arguments[0].toDouble)? true : false );
-}
+
+/**
+    Standards: ECMA 15.1.3.1
+    Arguments: [0] = URI string to be decoded
+    Returns:
+    Synopsis: 
+*/
-static Value Global_decodeURI(inout Value self, inout Value cc, Value[] arguments ...) {
-    /// ECMA 15.1.3.1
-    scope(failure) return UNDEFINED;
-    return cast(Value) decode(arguments[0].toString());
-}
+
+/**
+    Standards: ECMA 15.1.3.2
+    Arguments: [0] = URI component string to be decoded
+    Returns:
+    Synopsis: 
+*/
-static Value Global_decodeURIComponent(inout Value self, inout Value cc, Value[] arguments ...) {
-    /// ECMA 15.1.3.2
-    scope(failure) return UNDEFINED;
-    return cast(Value) decodeComponent(arguments[0].toString());
-}
+
+/**
+    Standards: ECMA 15.1.3.3
+    Arguments: [0] = URI string to be encoded.
+    Returns:
+    Synopsis: 
+*/
-static Value Global_encodeURI(inout Value self, inout Value cc, Value[] arguments ...) {
-    /// ECMA 15.1.3.3
-    scope(failure) return UNDEFINED;
-    return cast(Value) encode(arguments[0].toString());
-}
+
+/**
+    Standards: ECMA 15.1.3.4
+    Arguments: [0] = URI component string to be encoded
+    Returns:
+    Synopsis: 
+*/
-static Value Global_encodeURIComponent(inout Value self, inout Value cc, Value[] arguments ...) {
-    /// ECMA 15.1.3.4
-    scope(failure) return UNDEFINED;
-    return cast(Value) encodeComponent(arguments[0].toString());
-}
-
-
-
-
+
+
+
+
+
+
-static Value Global_Object(inout Value self, inout Value cc, Value[] arguments ...) {
-    /// ECMA 15.2.1.1
-    Value v;
-    return v;
-}
+
+/**
+    Standards: ECMA 15.2.2
+    Arguments: any Value
+    Returns: The Object form of any Value, or a new Object when called without arguments.
+    Synopsis: Is perfectly equivalent to "new Object()"
+*/
-static Value Object_prototype_constructor(inout Value self, inout Value cc, Value[] arguments ...) {
-    /// ECMA 15.2.2
-    Value v;
-    return v;
-}
+
+/**
+    Standards ECMA 15.2.4.2, 15.2.4.3
+    Arguments: any Value
+    Returns: The string form of that Value
+    Synopsis: According to 15.2.4.3, calls to Object_prototype_toLocaleString() are to be directed to
+    Object_prototype_toString(), and the duplication kept for completeness so that toLocaleString() can be called
+    on all types.
+*/
-static Value Object_prototype_toString(inout Value self, inout Value cc, Value[] arguments ...) {
-        /// ECMA 15.2.4.2
-    return cast(Value) self.toString();
-}
+
+/**
+    Standards non-standard
+    Arguments: none
+    Returns: Source code which, when eval'd will result in the creation of the equivalent Object
+    Synopsis:
+*/
-static Value Object_prototype_toSource(inout Value self, inout Value cc, Value[] arguments ...) {
-    /// not specified in ECMA 3rd Edition, but allowed in conformant implementations
-    char[] buffer = "{";
-    bool any = false;
@@ -127 +213 @@
-    return cast(Value) buffer;
-}
+
+/**
+    Standards ECMA 15.2.4.4
+    Arguments: none
+    Returns: The primitive value of the Object.  For non-primitive Objects, this will return the argument itself.
+    Synopsis:
+*/
-static Value Object_prototype_valueOf(inout Value self, inout Value cc, Value[] arguments ...) {
-
-
-
+
+
+
+
+
+
+
+
+
-static Value Object_prototype_hasOwnProperty(inout Value self, inout Value cc, Value[] arguments ...) {
-    /// ECMA 15.2.4.5
-    if(!arguments.length)
-        return FALSE;
-    return cast(Value) (arguments[0].toString() in self);
-}
+
+/**
+    Standards ECMA 15.2.4.6
+    Arguments: [0] = any Object
+    Returns: boolean of whether [0] is in this Object's prototype chain.
+    Synopsis:
+*/
-static Value Object_prototype_isPrototypeOf(inout Value self, inout Value cc, Value[] arguments ...) {
-    /// ECMA 15.2.4.6
-    if(self.type == TYPE.OBJECT && arguments.length) {
-        Value current = arguments[0];
@@ -149 +253 @@
-    return FALSE;
-}
+
+/**
+    Standards ECMA 15.2.4.7
+    Arguments: [0] = String containing the property name to be examined
+    Returns: boolean of whether [0] is enumerable on this Object
+    Synopsis:
+*/
-static Value Object_prototype_propertyIsEnumerable(inout Value self, inout Value cc, Value[] arguments ...) {
-    /// ECMA 15.2.4.7
-    if(!arguments.length)
-        return FALSE;
-    return cast(Value) (self[arguments[0].toString()].access & ACCESS.ENUMERATE);
-}
-///     ECMA 15.2.4.3: Object_prototype_toLocaleString() = Object_prototype_toString()
-
-
@@ -164 +273 @@
-    return Function_prototype_constructor(self,cc,arguments);
-}
+
-static Value Function_prototype_constructor(inout Value self, inout Value cc, Value[] arguments ...) {
-    /// ECMA 15.3.2.1
-    return UNDEFINED;
-}
+
-static Value Function_prototype_apply(inout Value self, inout Value cc, Value[] arguments ...) {
-    /// ECMA 15.3.4.3
-    return UNDEFINED;
-}
+
-static Value Function_prototype_call(inout Value self, inout Value cc, Value[] arguments ...) {
-    /// ECMA 15.3.4.4
@@ -184 +296 @@
-    return Array_prototype_constructor(self,cc,arguments);
-}
+
-static Value Array_prototype_constructor(inout Value self, inout Value cc, Value[] arguments ...) {
-    /// ECMA 15.4.2
-    return UNDEFINED;
-}
+
-static Value Array_prototype_toLocaleString(inout Value self, inout Value cc, Value[] arguments ...) {
-    /// ECMA 15.4.4.3
-    return UNDEFINED;
-}
+
-static Value Array_prototype_toSource(inout Value self, inout Value cc, Value[] arguments ...) {
-    /// not specified in ECMA 262 3rd Edition, but valid in a conformant implementation
-    return UNDEFINED;
-}
+
-static Value Array_prototype_concat(inout Value self, inout Value cc, Value[] arguments ...) {
-    /// ECMA 15.4.4.4
-    return UNDEFINED;
-}
+
-static Value Array_prototype_join(inout Value self, inout Value cc, Value[] arguments ...) {
-    /// ECMA 15.4.4.3
-    return UNDEFINED;
-}
+
-static Value Array_prototype_pop(inout Value self, inout Value cc, Value[] arguments ...) {
-    /// ECMA 15.4.4.6
-    return UNDEFINED;
-}
+
-static Value Array_prototype_push(inout Value self, inout Value cc, Value[] arguments ...) {
-    /// ECMA 15.4.4.7
-    return UNDEFINED;
-}
+
-static Value Array_prototype_reverse(inout Value self, inout Value cc, Value[] arguments ...) {
-    /// ECMA 15.4.4.8
-    return UNDEFINED;
-}
+
-static Value Array_prototype_shift(inout Value self, inout Value cc, Value[] arguments ...) {
-    /// ECMA 15.4.4.9
-    return UNDEFINED;
-}
+
-static Value Array_prototype_slice(inout Value self, inout Value cc, Value[] arguments ...) {
-    /// ECMA 15.4.4.10
-    return UNDEFINED;
-}
+
-static Value Array_prototype_sort(inout Value self, inout Value cc, Value[] arguments ...) {
-    /// ECMA 15.4.4.11
-    return UNDEFINED;
-}
+
-static Value Array_prototype_splice(inout Value self, inout Value cc, Value[] arguments ...) {
-    /// ECMA 15.4.4.12
-    return UNDEFINED;
-}
+
-static Value Array_prototype_unshift(inout Value self, inout Value cc, Value[] arguments ...) {
-    /// ECMA 15.4.4.13
-    return UNDEFINED;
-}
-
-
-
-///     String
@@ -244 +367 @@
-    return UNDEFINED;
-}
+
-static Value String_prototype_constructor(inout Value self, inout Value cc, Value[] arguments ...) {
-    /// ECMA 15.5.2.1
-    return UNDEFINED;
-}
+
-static Value String_fromCharCode(inout Value self, inout Value cc, Value[] arguments ...) {
-    /// ECMA 15.5.3.2
-    return UNDEFINED;
-}
+
-static Value String_prototype_charAt(inout Value self, inout Value cc, Value[] arguments ...) {
-    /// ECMA 15.5.4.4
-    return UNDEFINED;
-}
+
-static Value String_prototype_charCodeAt(inout Value self, inout Value cc, Value[] arguments ...) {
-    /// ECMA 15.5.4.5
-    return UNDEFINED;
-}
+
-static Value String_prototype_concat(inout Value self, inout Value cc, Value[] arguments ...) {
-    /// ECMA 15.5.4.6
-    return UNDEFINED;
-}
+
-static Value String_prototype_indexOf(inout Value self, inout Value cc, Value[] arguments ...) {
-    /// ECMA 15.5.4.7
-    return UNDEFINED;
-}
+
-static Value String_prototype_lastIndexOf(inout Value self, inout Value cc, Value[] arguments ...) {
-    /// ECMA 15.5.4.8
-    return UNDEFINED;
-}
+
-static Value String_prototype_localeCompare(inout Value self, inout Value cc, Value[] arguments ...) {
-    /// ECMA 15.5.4.9
-    return UNDEFINED;
-}
+
-static Value String_prototype_match(inout Value self, inout Value cc, Value[] arguments ...) {
-    /// ECMA 15.5.4.10
-    return UNDEFINED;
-}
+
-static Value String_prototype_replace(inout Value self, inout Value cc, Value[] arguments ...) {
-    /// ECMA 15.5.4.11
-    return UNDEFINED;
-}
+
-static Value String_prototype_search(inout Value self, inout Value cc, Value[] arguments ...) {
-    /// ECMA 15.5.4.12
-    return UNDEFINED;
-}
+
-static Value String_prototype_slice(inout Value self, inout Value cc, Value[] arguments ...) {
-    /// ECMA 15.5.4.13
-    return UNDEFINED;
-}
+
-static Value String_prototype_split(inout Value self, inout Value cc, Value[] arguments ...) {
-    /// ECMA 15.5.4.14
-    return UNDEFINED;
-}
+
-static Value String_prototype_substr(inout Value self, inout Value cc, Value[] arguments ...) {
-    /// ECMA
-    return UNDEFINED;
-}
+
-static Value String_prototype_substring(inout Value self, inout Value cc, Value[] arguments ...) {
-    /// ECMA 15.5.4.15
-    return UNDEFINED;
-}
+
-static Value String_prototype_toLowerCase(inout Value self, inout Value cc, Value[] arguments ...) {
-    /// ECMA 15.5.4.16
-    return UNDEFINED;
-}
+
-static Value String_prototype_toLocaleLowerCase(inout Value self, inout Value cc, Value[] arguments ...) {
-    /// ECMA 15.5.4.17
-    return UNDEFINED;
-}
+
-static Value String_prototype_toUpperCase(inout Value self, inout Value cc, Value[] arguments ...) {
-    /// ECMA 15.5.4.18
-    return UNDEFINED;
-}
+
-static Value String_prototype_toLocaleUpperCase(inout Value self, inout Value cc, Value[] arguments ...) {
-    /// ECMA 15.5.4.19
@@ -328 +470 @@
-    return (arguments.length && arguments[0].b)? TRUE : FALSE;
-}
+
-static Value Boolean_prototype_constructor(inout Value self, inout Value cc, Value[] arguments ...){
-    /// ECMA 15.6.2