OSDN Git Service

Version 0.6.169, add doc comment.
[pettanr/clientJs.git] / 0.6.x / js / 01_core / 04_XObject.js
index e9d96df..5791535 100644 (file)
@@ -1,7 +1,14 @@
-\r
-var X_Object_inObject = X_UA.IE < 5.5 ? // TODO JScript で判定\r
-       (function( name, obj ){\r
-               var p;\r
+/**\r
+ * name in object 構文が使えない環境で構文解析エラーを回避するためにこのメソッドを使用します。\r
+ * 但し for( name in object ) については構文解析エラーになる環境はありません。\r
+ * @alias X.Object.inObject\r
+ * @function\r
+ * @param {string|number} name \r
+ * @param {object} obj \r
+ * @return {boolean} name が定義されている(値が undefined や null でも) -> true\r
+ */\r
+var X_Object_inObject = X_UA[ 'IE' ] < 5.5 ? // TODO JScript で判定\r
+       (function( name, obj, p ){\r
                if( obj[ name ] ) return true; // quick\r
                name += ''; // 数値も許可\r
                for( p in obj ){\r
@@ -9,26 +16,49 @@ var X_Object_inObject = X_UA.IE < 5.5 ? // TODO JScript で判定
                };\r
                return false;\r
        }) :\r
-       new Function( 'a,b', 'return a in b' );// なぜか ie5 でもerror\r
+       new Function( 'a,b', 'return (""+a) in b' );\r
+\r
+\r
+// ------------------------------------------------------------------------- //\r
+// --- interface ----------------------------------------------------------- //\r
+// ------------------------------------------------------------------------- //\r
 \r
+/**\r
+ * Object に関する関数を集めたものです。\r
+ * @namespace X.Object\r
+ * @alias X.Object\r
+ */\r
+X[ 'Object' ] = {\r
 \r
-X.Object = {\r
-       clone      : X_Object_clone,\r
+       'copy'       : X_Object_copy,\r
        \r
-       override   : X_Object_override,\r
+       'deepCopy'   : X_Object_deepCopy,\r
        \r
-       deepCopy   : X_Object_deepCopy,\r
+       'override'   : X_Object_override,\r
        \r
-       cloneArray : X_Object_cloneArray,\r
+       'clear'      : X_Object_clear,\r
        \r
-       isEmpty    : X_Object_isEmpty,\r
+       'isEmpty'    : X_Object_isEmpty,\r
        \r
-       inObject   : X_Object_inObject\r
-};\r
+       'inObject'   : X_Object_inObject\r
        \r
-function X_Object_clone( src ){\r
+       // TODO hasOwnProperty\r
+};\r
+\r
+// ------------------------------------------------------------------------- //\r
+// --- implements ---------------------------------------------------------- //\r
+// ------------------------------------------------------------------------- //\r
+/**\r
+ * 単純なクローンでメンバーをコピーしたオブジェクトを返します。 k in null でエラーになる Opera7- に対策済。\r
+ * @alias X.Object.copy\r
+ * @param {object|Array} src コピー元のオブジェクトです。\r
+ * @return {object|Array}\r
+ */\r
+function X_Object_copy( src ){\r
        var ret, k;\r
-       if( typeof src !== 'object' ) return src;\r
+       \r
+       if( !src || !X_Type_isObject( src ) ) return src;\r
+       \r
        ret = {};\r
        for( k in src ){\r
                //if( X_EMPTY_OBJECT[ k ] ) continue;\r
@@ -37,9 +67,16 @@ function X_Object_clone( src ){
        return ret;\r
 };\r
 \r
+/**\r
+ * オブジェクトにオブジェトのメンバーをコピーします。同じ名前のメンバーは上書きされます。\r
+ * @alias X.Object.override\r
+ * @param {object} target コピーされるオブジェクトです。返り値はこのオブジェクトです。\r
+ * @param {object} src コピー元のオブジェクトです。\r
+ * @return {object} target が返る。\r
+ */\r
 function X_Object_override( target, src ){\r
        var k;\r
-       if( !X.Type.isObject( src ) ) return target;\r
+       if( !src || !X_Type_isObject( src ) ) return target;\r
        for( k in src ){\r
                //if( X_EMPTY_OBJECT[ k ] ) continue;\r
                target[ k ] = src[ k ];\r
@@ -47,22 +84,44 @@ function X_Object_override( target, src ){
        return target;\r
 };\r
 \r
+/**\r
+ * オブジェクトの全てのメンバーを破棄します。\r
+ * @alias X.Object.clear\r
+ * @param {object} obj。\r
+ */\r
+function X_Object_clear( obj, k ){\r
+       if( obj ){\r
+               for( k in obj ){\r
+                       delete obj[ k ];\r
+               };\r
+       };\r
+};\r
+\r
+\r
+/**\r
+ * オブジェクト(object, Array)のメンバーを探索して、ディープコピーしたオブジェクトを返します。\r
+ * オブジェクトが循環参照している場合は、既にコピーしているオブジェクトが現れた時点で、先に作成しているコピーの参照を返すので無限にループすることはありません。\r
+ * @alias X.Object.deepCopy\r
+ * @param {object|Array} src コピー元のオブジェクトです。\r
+ * @return {object|Array}\r
+ */\r
 function X_Object_deepCopy( src ){             \r
        return X_Object_deepCopy_( src, [], [], -1 );\r
 };\r
 \r
-function X_Object_deepCopy_( src, objSrc, objCopy, n ) {\r
+function X_Object_deepCopy_( src, objSrc, objCopy, n ){\r
        var ret, i, k;\r
+       \r
        if( !src ){ // 0, "", null, undefined, NaN, false\r
                return src;\r
        } else\r
-       if( X.Type.isArray( src ) ){\r
+       if( X_Type_isArray( src ) ){\r
                i = objSrc.indexOf( src );\r
                if( i !== -1 ) return objCopy[ i ];\r
                objSrc[ ++n ] = src;\r
                objCopy[ n ]  = ret = [];\r
        } else\r
-       if( X.Type.isObject( src ) ){\r
+       if( X_Type_isObject( src ) ){\r
                i = objSrc.indexOf( src );\r
                if( i !== -1 ) return objCopy[ i ];\r
                objSrc[ ++n ] = src;\r
@@ -73,35 +132,23 @@ function X_Object_deepCopy_( src, objSrc, objCopy, n ) {
        };\r
        for( k in src ){\r
                //if( X_EMPTY_OBJECT[ k ] ) continue;\r
-               ret[ k ] = clone( src[ k ], objSrc, objCopy, n );\r
+               ret[ k ] = X_Object_deepCopy_( src[ k ], objSrc, objCopy, n );\r
        };\r
        return ret;\r
 };\r
 \r
-function X_Object_cloneArray( ary ){\r
-       var ret = [],\r
-               i = ary.length;\r
-       if( !i ) return ret;\r
-       for( ; i; ){\r
-               ret[ --i ] = ary[ i ];\r
-       };\r
-       return ret;\r
-};\r
-       \r
+/**\r
+ * object が空か?調べます。 object でない場合、undefined が返る\r
+ * @alias X.Object.isEmpty\r
+ * @param {object} v \r
+ * @return {boolean|undefined}\r
+ */\r
 function X_Object_isEmpty( v ){\r
-       var k;\r
-       for( k in v ){\r
-               //if( X_EMPTY_OBJECT[ k ] ) continue;\r
+       if( !v ) return;\r
+       for( var k in v ){\r
+               //if( X_EMPTY_OBJECT[ _k ] ) continue;\r
                return false;//if( v.hasOwnProperty && v.hasOwnProperty( p ) ) return false; ie4 で動かない、、、\r
        };\r
        return true;\r
 };\r
 \r
-/*     \r
-X.matchTest = function( array1, array2 ){\r
-       var i = array2.length;\r
-       for( ; i; ){\r
-               if( array1.indexOf( array2[ --i ] ) === -1 ) return false;\r
-       };\r
-       return true;\r
-}; */\r