JasonWoof Got questions, comments, patches, etc.? Contact Jason Woofenden
vanilla ckeditor-3.6.6.1
[ckeditor.git] / _source / core / tools.js
index 6fb417b..a529c6a 100644 (file)
@@ -1,5 +1,5 @@
 /*\r
-Copyright (c) 2003-2010, CKSource - Frederico Knabben. All rights reserved.\r
+Copyright (c) 2003-2013, CKSource - Frederico Knabben. All rights reserved.\r
 For licensing, see LICENSE.html or http://ckeditor.com/license\r
 */\r
 \r
@@ -12,6 +12,11 @@ For licensing, see LICENSE.html or http://ckeditor.com/license
 {\r
        var functions = [];\r
 \r
+       CKEDITOR.on( 'reset', function()\r
+               {\r
+                       functions = [];\r
+               });\r
+\r
        /**\r
         * Utility functions.\r
         * @namespace\r
@@ -215,6 +220,10 @@ For licensing, see LICENSE.html or http://ckeditor.com/license
                        return ( !!object && object instanceof Array );\r
                },\r
 \r
+               /**\r
+                * Whether the object contains no properties of it's own.\r
+                * @param object\r
+                */\r
                isEmpty : function ( object )\r
                {\r
                        for ( var i in object )\r
@@ -224,6 +233,7 @@ For licensing, see LICENSE.html or http://ckeditor.com/license
                        }\r
                        return true;\r
                },\r
+\r
                /**\r
                 * Transforms a CSS property name to its relative DOM style name.\r
                 * @param {String} cssName The CSS property name.\r
@@ -255,7 +265,7 @@ For licensing, see LICENSE.html or http://ckeditor.com/license
                } )(),\r
 \r
                /**\r
-                * Build the HTML snippet of a set of <style>/<link>.\r
+                * Build the HTML snippet of a set of &lt;style>/&lt;link>.\r
                 * @param css {String|Array} Each of which are url (absolute) of a CSS file or\r
                 * a trunk of style text.\r
                 */\r
@@ -323,16 +333,16 @@ For licensing, see LICENSE.html or http://ckeditor.com/license
                },\r
 \r
                /**\r
-                * Replace characters can't be represented through CSS Selectors string\r
-                * by CSS Escape Notation where the character escape sequence consists\r
-                * of a backslash character (\) followed by the orginal characters.\r
-                * Ref: http://www.w3.org/TR/css3-selectors/#grammar\r
-                * @param cssSelectText\r
-                * @return the escaped selector text.\r
+                * Replace special HTML characters in HTMLElement's attribute with their relative HTML entity values.\r
+                * @param {String} The attribute's value to be encoded.\r
+                * @returns {String} The encode value.\r
+                * @example\r
+                * element.setAttribute( 'title', '<a " b >' );\r
+                * alert( CKEDITOR.tools.htmlEncodeAttr( element.getAttribute( 'title' ) );  // "&gt;a &quot; b &lt;"\r
                 */\r
-               escapeCssSelector : function( cssSelectText )\r
+               htmlEncodeAttr : function( text )\r
                {\r
-                       return cssSelectText.replace( /[\s#:.,$*^\[\]()~=+>]/g, '\\$&' );\r
+                       return text.replace( /"/g, '&quot;' ).replace( /</g, '&lt;' ).replace( />/g, '&gt;' );\r
                },\r
 \r
                /**\r
@@ -354,6 +364,20 @@ For licensing, see LICENSE.html or http://ckeditor.com/license
                })(),\r
 \r
                /**\r
+                * Gets a unique ID for CKEditor's interface elements. It returns a\r
+                * string with the "cke_" prefix and a progressive number.\r
+                * @function\r
+                * @returns {String} A unique ID.\r
+                * @example\r
+                * alert( CKEDITOR.tools.<b>getNextId()</b> );  // "cke_1" (e.g.)\r
+                * alert( CKEDITOR.tools.<b>getNextId()</b> );  // "cke_2"\r
+                */\r
+               getNextId : function()\r
+               {\r
+                       return 'cke_' + this.getNextNumber();\r
+               },\r
+\r
+               /**\r
                 * Creates a function override.\r
                 * @param {Function} originalFunction The function to be overridden.\r
                 * @param {Function} functionBuilder A function that returns the new\r
@@ -540,7 +564,7 @@ For licensing, see LICENSE.html or http://ckeditor.com/license
                 * <li> Public (prototype) fields </li>\r
                 * <li> Chainable base class constructor </li>\r
                 * </ul>\r
-                * @param {Object} definiton The class definiton object.\r
+                * @param {Object} definition The class definition object.\r
                 * @returns {Function} A class-like JavaScript function.\r
                 */\r
                createClass : function( definition )\r
@@ -614,11 +638,21 @@ For licensing, see LICENSE.html or http://ckeditor.com/license
                {\r
                        return functions.push( function()\r
                                {\r
-                                       fn.apply( scope || this, arguments );\r
+                                       return fn.apply( scope || this, arguments );\r
                                }) - 1;\r
                },\r
 \r
                /**\r
+                * Removes the function reference created with {@see CKEDITOR.tools.addFunction}.\r
+                * @param {Number} ref The function reference created with\r
+                *              CKEDITOR.tools.addFunction.\r
+                */\r
+               removeFunction : function( ref )\r
+               {\r
+                       functions[ ref ] = null;\r
+               },\r
+\r
+               /**\r
                 * Executes a function based on the reference created with\r
                 * CKEDITOR.tools.addFunction.\r
                 * @param {Number} ref The function reference created with\r
@@ -640,20 +674,62 @@ For licensing, see LICENSE.html or http://ckeditor.com/license
                        return fn && fn.apply( window, Array.prototype.slice.call( arguments, 1 ) );\r
                },\r
 \r
+               /**\r
+                * Append the 'px' length unit to the size if it's missing.\r
+                * @param length\r
+                */\r
                cssLength : (function()\r
                {\r
-                       var decimalRegex = /^\d+(?:\.\d+)?$/;\r
                        return function( length )\r
                        {\r
-                               return length + ( decimalRegex.test( length ) ? 'px' : '' );\r
+                               return length + ( !length || isNaN( Number( length ) ) ? '' : 'px' );\r
                        };\r
                })(),\r
 \r
+               /**\r
+                * Convert the specified CSS length value to the calculated pixel length inside this page.\r
+                * <strong>Note:</strong> Percentage based value is left intact.\r
+                * @param {String} cssLength CSS length value.\r
+                */\r
+               convertToPx : ( function ()\r
+                       {\r
+                               var calculator;\r
+\r
+                               return function( cssLength )\r
+                               {\r
+                                       if ( !calculator )\r
+                                       {\r
+                                               calculator = CKEDITOR.dom.element.createFromHtml(\r
+                                                               '<div style="position:absolute;left:-9999px;' +\r
+                                                               'top:-9999px;margin:0px;padding:0px;border:0px;"' +\r
+                                                               '></div>', CKEDITOR.document );\r
+                                               CKEDITOR.document.getBody().append( calculator );\r
+                                       }\r
+\r
+                                       if ( !(/%$/).test( cssLength ) )\r
+                                       {\r
+                                               calculator.setStyle( 'width', cssLength );\r
+                                               return calculator.$.clientWidth;\r
+                                       }\r
+\r
+                                       return cssLength;\r
+                               };\r
+                       } )(),\r
+\r
+               /**\r
+                * String specified by {@param str} repeats {@param times} times.\r
+                * @param str\r
+                * @param times\r
+                */\r
                repeat : function( str, times )\r
                {\r
                        return new Array( times + 1 ).join( str );\r
                },\r
 \r
+               /**\r
+                * Return the first successfully executed function's return value that\r
+                * doesn't throw any exception.\r
+                */\r
                tryThese : function()\r
                {\r
                        var returnValue;\r
@@ -668,7 +744,94 @@ For licensing, see LICENSE.html or http://ckeditor.com/license
                                catch (e) {}\r
                        }\r
                        return returnValue;\r
+               },\r
+\r
+               /**\r
+                * Generate a combined key from a series of params.\r
+                * @param {String} subKey One or more string used as sub keys.\r
+                * @example\r
+                * var key = CKEDITOR.tools.genKey( 'key1', 'key2', 'key3' );\r
+                * alert( key );                // "key1-key2-key3".\r
+                */\r
+               genKey : function()\r
+               {\r
+                       return Array.prototype.slice.call( arguments ).join( '-' );\r
+               },\r
+\r
+               /**\r
+                * Try to avoid differences in the style attribute.\r
+                *\r
+                * @param {String} styleText The style data to be normalized.\r
+                * @param {Boolean} [nativeNormalize=false] Parse the data using the browser.\r
+                * @returns {String} The normalized value.\r
+                */\r
+               normalizeCssText: function( styleText, nativeNormalize ) {\r
+                       var props = [],\r
+                               name,\r
+                               parsedProps = CKEDITOR.tools.parseCssText( styleText, true, nativeNormalize );\r
+\r
+                       for ( name in parsedProps )\r
+                               props.push( name + ':' + parsedProps[ name ] );\r
+\r
+                       props.sort();\r
+\r
+                       return props.length ? ( props.join( ';' ) + ';' ) : '';\r
+               },\r
+\r
+               /**\r
+                * Find and convert <code>rgb(x,x,x)</code> colors definition to hexadecimal notation.\r
+                * @param {String} styleText The style data (or just a string containing rgb colors) to be converted.\r
+                * @returns {String} The style data with rgb colors converted to hexadecimal equivalents.\r
+                */\r
+               convertRgbToHex: function( styleText ) {\r
+                       return styleText.replace( /(?:rgb\(\s*(\d+)\s*,\s*(\d+)\s*,\s*(\d+)\s*\))/gi, function( match, red, green, blue ) {\r
+                               var color = [ red, green, blue ];\r
+                               // Add padding zeros if the hex value is less than 0x10.\r
+                               for ( var i = 0; i < 3; i++ )\r
+                                       color[ i ] = ( '0' + parseInt( color[ i ], 10 ).toString( 16 ) ).slice( -2 );\r
+                               return '#' + color.join( '' );\r
+                       });\r
+               },\r
+\r
+               /**\r
+                * Turn inline style text properties into one hash.\r
+                *\r
+                * @param {String} styleText The style data to be parsed.\r
+                * @param {Boolean} [normalize=false] Normalize properties and values\r
+                * (e.g. trim spaces, convert to lower case).\r
+                * @param {Boolean} [nativeNormalize=false] Parse the data using the browser.\r
+                * @returns {String} The object containing parsed properties.\r
+                */\r
+               parseCssText: function( styleText, normalize, nativeNormalize ) {\r
+                       var retval = {};\r
+\r
+                       if ( nativeNormalize ) {\r
+                               // Injects the style in a temporary span object, so the browser parses it,\r
+                               // retrieving its final format.\r
+                               var temp = new CKEDITOR.dom.element( 'span' );\r
+                               temp.setAttribute( 'style', styleText );\r
+                               styleText = CKEDITOR.tools.convertRgbToHex( temp.getAttribute( 'style' ) || '' );\r
+                       }\r
+\r
+                       // IE will leave a single semicolon when failed to parse the style text. (#3891)\r
+                       if ( !styleText || styleText == ';' )\r
+                               return retval;\r
+\r
+                       styleText.replace( /&quot;/g, '"' ).replace( /\s*([^:;\s]+)\s*:\s*([^;]+)\s*(?=;|$)/g, function( match, name, value ) {\r
+                               if ( normalize ) {\r
+                                       name = name.toLowerCase();\r
+                                       // Normalize font-family property, ignore quotes and being case insensitive. (#7322)\r
+                                       // http://www.w3.org/TR/css3-fonts/#font-family-the-font-family-property\r
+                                       if ( name == 'font-family' )\r
+                                               value = value.toLowerCase().replace( /["']/g, '' ).replace( /\s*,\s*/g, ',' );\r
+                                       value = CKEDITOR.tools.trim( value );\r
+                               }\r
+\r
+                               retval[ name ] = value;\r
+                       });\r
+                       return retval;\r
                }\r
+\r
        };\r
 })();\r
 \r