OSDN Git Service

Version 0.6.134, add comments for closure compiler.
[pettanr/clientJs.git] / 0.6.x / js / 01_core / 04_XObject.js
index 8c8b82e..1dcde48 100644 (file)
@@ -1,8 +1,16 @@
-\r
-var X_Object_inObject = X_UA.IE < 5.5 ? // TODO JScript で判定\r
+/**\r
+ * name in object 構文が使えない環境で構文解析エラーを回避するためにこのメソッドを使用します。\r
+ * 但し for( name in object ) については構文解析エラーになる環境はありません。\r
+ * @alias X.Object.inObject\r
+ * @function\r
+ * @param {string} 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 ){\r
                var p;\r
-               if( obj[ name ] ) return true;\r
+               if( obj[ name ] ) return true; // quick\r
                name += ''; // 数値も許可\r
                for( p in obj ){\r
                        if( p === name ) return true;\r
@@ -12,45 +20,93 @@ var X_Object_inObject = X_UA.IE < 5.5 ? // TODO JScript で判定
        new Function( 'a,b', 'return a in b' );// なぜか ie5 でもerror\r
 \r
 \r
-X.Object = {\r
+// ------------------------------------------------------------------------- //\r
+// --- interface ----------------------------------------------------------- //\r
+// ------------------------------------------------------------------------- //\r
+\r
+/**\r
+ * Object に関するメソッドを集めたものです。\r
+ * @namespace X.Object\r
+ * @alias X.Object\r
+ */\r
+X[ 'Object' ] = {\r
+       // TODO rename to copy\r
+       'clone'      : X_Object_clone,\r
        \r
-       clone      : X_Object_clone,\r
+       'override'   : X_Object_override,\r
        \r
-       deepCopy   : X_Object_deepCopy,\r
+       'deepCopy'   : X_Object_deepCopy,\r
        \r
-       cloneArray : X_Object_cloneArray,\r
+       // TODO rename to X.Array.copy\r
+       'cloneArray' : X_Object_cloneArray,\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
+       // TODO hasOwnProperty\r
+};\r
+\r
+// ------------------------------------------------------------------------- //\r
+// --- implements ---------------------------------------------------------- //\r
+// ------------------------------------------------------------------------- //\r
+/**\r
+ * 単純なクローンでメンバーをコピーしたオブジェクトを返します。\r
+ * @alias X.Object.clone\r
+ * @param {object|Array} src コピー元のオブジェクトです。\r
+ * @return {object|Array}\r
+ */\r
 function X_Object_clone( src ){\r
        var ret, k;\r
        if( typeof src !== 'object' ) return src;\r
        ret = {};\r
        for( k in src ){\r
+               //if( X_EMPTY_OBJECT[ k ] ) continue;\r
                ret[ k ] = src[ k ];\r
        };\r
        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
+       for( k in src ){\r
+               //if( X_EMPTY_OBJECT[ k ] ) continue;\r
+               target[ k ] = src[ k ];\r
+       };\r
+       return target;\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
-       var ret, i, key;\r
+       var ret, i, k;\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
@@ -59,24 +115,39 @@ function X_Object_deepCopy_( src, objSrc, objCopy, n ) {
                // string, number, true\r
                return src;\r
        };\r
-       for( key in src ){\r
-               ret[ key ] = clone( src[ key ], 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
        };\r
        return ret;\r
 };\r
 \r
+/**\r
+ * 単純にメンバーをコピーした Array を返します。\r
+ * @alias X.Object.cloneArray\r
+ * @param {Array} ary コピー元のオブジェクトです。\r
+ * @return {Array}\r
+ */\r
 function X_Object_cloneArray( ary ){\r
-       var ret = [], i = ary.length;\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
+/**\r
+ * object が空か?調べます。\r
+ * @alias X.Object.isEmpty\r
+ * @param {object} v \r
+ * @return {boolean}\r
+ */\r
 function X_Object_isEmpty( v ){\r
-       var p;\r
-       for( p in v ){\r
+       var k;\r
+       for( 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