NOBUG: Fixed file access permissions
[moodle.git] / lib / yuilib / 3.13.0 / stylesheet / stylesheet-debug.js
blob3a12b59ca05b9bb3b5f60579dc735d7f5c936601
1 /*
2 YUI 3.13.0 (build 508226d)
3 Copyright 2013 Yahoo! Inc. All rights reserved.
4 Licensed under the BSD License.
5 http://yuilibrary.com/license/
6 */
8 YUI.add('stylesheet', function (Y, NAME) {
10 /**
11  * The StyleSheet component is a module for creating and modifying CSS
12  * stylesheets.
13  *
14  * @module stylesheet
15  */
16 var d      = Y.config.doc,
17     p      = d.createElement('p'), // Have to hold the node (see notes)
18     workerStyle = p.style, // worker style collection
19     isString = Y.Lang.isString,
20     selectors = {},
21     sheets = {},
22     floatAttr = ('cssFloat' in workerStyle) ? 'cssFloat' : 'styleFloat',
23     _toCssText,
24     _unsetOpacity,
25     _unsetProperty,
26     OPACITY = 'opacity',
27     FLOAT   = 'float',
28     EMPTY   = '';
30 // Normalizes the removal of an assigned style for opacity.  IE uses the filter
31 // property.
32 _unsetOpacity = (OPACITY in workerStyle) ?
33     function (style) { style.opacity = EMPTY; } :
34     function (style) { style.filter = EMPTY; };
36 // Normalizes the removal of an assigned style for a given property.  Expands
37 // shortcut properties if necessary and handles the various names for the float
38 // property.
39 workerStyle.border = "1px solid red";
40 workerStyle.border = EMPTY; // IE doesn't unset child properties
41 _unsetProperty = workerStyle.borderLeft ?
42     function (style,prop) {
43         var p;
44         if (prop !== floatAttr && prop.toLowerCase().indexOf(FLOAT) != -1) {
45             prop = floatAttr;
46         }
47         if (isString(style[prop])) {
48             switch (prop) {
49                 case OPACITY:
50                 case 'filter' : _unsetOpacity(style); break;
51                 case 'font'   :
52                     style.font       = style.fontStyle = style.fontVariant =
53                     style.fontWeight = style.fontSize  = style.lineHeight  =
54                     style.fontFamily = EMPTY;
55                     break;
56                 default       :
57                     for (p in style) {
58                         if (p.indexOf(prop) === 0) {
59                             style[p] = EMPTY;
60                         }
61                     }
62             }
63         }
64     } :
65     function (style,prop) {
66         if (prop !== floatAttr && prop.toLowerCase().indexOf(FLOAT) != -1) {
67             prop = floatAttr;
68         }
69         if (isString(style[prop])) {
70             if (prop === OPACITY) {
71                 _unsetOpacity(style);
72             } else {
73                 style[prop] = EMPTY;
74             }
75         }
76     };
78 /**
79  * Create an instance of StyleSheet to encapsulate a css stylesheet.
80  * The constructor can be called using function or constructor syntax.
81  * <pre><code>var sheet = Y.StyleSheet(..);</pre></code>
82  * or
83  * <pre><code>var sheet = new Y.StyleSheet(..);</pre></code>
84  *
85  * The first parameter passed can be any of the following things:
86  * <ul>
87  *   <li>The desired string name to register a new empty sheet</li>
88  *   <li>The string name of an existing StyleSheet instance</li>
89  *   <li>The unique guid generated for an existing StyleSheet instance</li>
90  *   <li>The id of an existing <code>&lt;link&gt;</code> or <code>&lt;style&gt;</code> node</li>
91  *   <li>The node reference for an existing <code>&lt;link&gt;</code> or <code>&lt;style&gt;</code> node</li>
92  *   <li>The Y.Node instance wrapping an existing <code>&lt;link&gt;</code> or <code>&lt;style&gt;</code> node</li>
93  *   <li>A chunk of css text to create a new stylesheet from</li>
94  * </ul>
95  *
96  * <p>If a string is passed, StyleSheet will first look in its static name
97  * registry for an existing sheet, then in the DOM for an element with that id.
98  * If neither are found and the string contains the { character, it will be
99  * used as a the initial cssText for a new StyleSheet.  Otherwise, a new empty
100  * StyleSheet is created, assigned the string value as a name, and registered
101  * statically by that name.</p>
103  * <p>The optional second parameter is a string name to register the sheet as.
104  * This param is largely useful when providing a node id/ref or chunk of css
105  * text to create a populated instance.</p>
107  * @class StyleSheet
108  * @constructor
109  * @param seed {String|HTMLElement|Node} a style or link node, its id, or a
110  *              name or guid of a StyleSheet, or a string of css text
111  * @param name {String} (optional) name to register instance for future static
112  *              access
113  */
114 function StyleSheet(seed, name) {
115     var head,
116         node,
117         sheet,
118         cssRules = {},
119         _rules,
120         _insertRule,
121         _deleteRule,
122         i,r,sel;
124     // Factory or constructor
125     if (!(Y.instanceOf(this, StyleSheet))) {
126         return new StyleSheet(seed,name);
127     }
129     // Extract the DOM node from Node instances
130     if (seed) {
131         if (Y.Node && seed instanceof Y.Node) {
132             node = seed._node;
133         } else if (seed.nodeName) {
134             node = seed;
135         // capture the DOM node if the string is an id
136         } else if (isString(seed)) {
137             if (seed && sheets[seed]) {
138                 return sheets[seed];
139             }
140             node = d.getElementById(seed.replace(/^#/,EMPTY));
141         }
143         // Check for the StyleSheet in the static registry
144         if (node && sheets[Y.stamp(node)]) {
145             return sheets[Y.stamp(node)];
146         }
147     }
150     // Create a style node if necessary
151     if (!node || !/^(?:style|link)$/i.test(node.nodeName)) {
152         node = d.createElement('style');
153         node.type = 'text/css';
154     }
156     if (isString(seed)) {
157         // Create entire sheet from seed cssText
158         if (seed.indexOf('{') != -1) {
159             // Not a load-time fork because low run-time impact and IE fails
160             // test for s.styleSheet at page load time (oddly)
161             if (node.styleSheet) {
162                 node.styleSheet.cssText = seed;
163             } else {
164                 node.appendChild(d.createTextNode(seed));
165             }
166         } else if (!name) {
167             name = seed;
168         }
169     }
171     // Make sure the node is attached to the appropriate head element
172     if (!node.parentNode || node.parentNode.nodeName.toLowerCase() !== 'head') {
173         head = (node.ownerDocument || d).getElementsByTagName('head')[0];
174         // styleSheet isn't available on the style node in FF2 until appended
175         // to the head element.  style nodes appended to body do not affect
176         // change in Safari.
177         head.appendChild(node);
178     }
180     // Begin setting up private aliases to the important moving parts
181     // 1. The stylesheet object
182     // IE stores StyleSheet under the "styleSheet" property
183     // Safari doesn't populate sheet for xdomain link elements
184     sheet = node.sheet || node.styleSheet;
186     // 2. The style rules collection
187     // IE stores the rules collection under the "rules" property
188     _rules = sheet && ('cssRules' in sheet) ? 'cssRules' : 'rules';
190     // 3. The method to remove a rule from the stylesheet
191     // IE supports removeRule
192     _deleteRule = ('deleteRule' in sheet) ?
193         function (i) { sheet.deleteRule(i); } :
194         function (i) { sheet.removeRule(i); };
196     // 4. The method to add a new rule to the stylesheet
197     // IE supports addRule with different signature
198     _insertRule = ('insertRule' in sheet) ?
199         function (sel,css,i) { sheet.insertRule(sel+' {'+css+'}',i); } :
200         function (sel,css,i) { sheet.addRule(sel,css,i); };
202     // 5. Initialize the cssRules map from the node
203     // xdomain link nodes forbid access to the cssRules collection, so this
204     // will throw an error.
205     // TODO: research alternate stylesheet, @media
206     for (i = sheet[_rules].length - 1; i >= 0; --i) {
207         r   = sheet[_rules][i];
208         sel = r.selectorText;
210         if (cssRules[sel]) {
211             cssRules[sel].style.cssText += ';' + r.style.cssText;
212             _deleteRule(i);
213         } else {
214             cssRules[sel] = r;
215         }
216     }
218     // Cache the instance by the generated Id
219     StyleSheet.register(Y.stamp(node),this);
221     // Register the instance by name if provided or defaulted from seed
222     if (name) {
223         StyleSheet.register(name,this);
224     }
226     // Public API
227     Y.mix(this,{
228         /**
229          * Get the unique stamp for this StyleSheet instance
230          *
231          * @method getId
232          * @return {Number} the static id
233          */
234         getId : function () { return Y.stamp(node); },
236         /**
237          * Enable all the rules in the sheet
238          *
239          * @method enable
240          * @return {StyleSheet}
241          * @chainable
242          */
243         enable : function () { sheet.disabled = false; return this; },
245         /**
246          * Disable all the rules in the sheet.  Rules may be changed while the
247          * StyleSheet is disabled.
248          *
249          * @method disable
250          * @return {StyleSheet}
251          * @chainable
252          */
253         disable : function () { sheet.disabled = true; return this; },
255         /**
256          * Returns false if the StyleSheet is disabled.  Otherwise true.
257          *
258          * @method isEnabled
259          * @return {Boolean}
260          */
261         isEnabled : function () { return !sheet.disabled; },
263         /**
264          * <p>Set style properties for a provided selector string.
265          * If the selector includes commas, it will be split into individual
266          * selectors and applied accordingly.  If the selector string does not
267          * have a corresponding rule in the sheet, it will be added.</p>
268          *
269          * <p>The object properties in the second parameter must be the JavaScript
270          * names of style properties.  E.g. fontSize rather than font-size.</p>
271          *
272          * <p>The float style property will be set by any of &quot;float&quot;,
273          * &quot;styleFloat&quot;, or &quot;cssFloat&quot;.</p>
274          *
275          * @method set
276          * @param sel {String} the selector string to apply the changes to
277          * @param css {Object} Object literal of style properties and new values
278          * @return {StyleSheet}
279          * @chainable
280          */
281         set : function (sel,css) {
282             var rule = cssRules[sel],
283                 multi = sel.split(/\s*,\s*/),i,
284                 idx;
286             // IE's addRule doesn't support multiple comma delimited selectors
287             if (multi.length > 1) {
288                 for (i = multi.length - 1; i >= 0; --i) {
289                     this.set(multi[i], css);
290                 }
291                 return this;
292             }
294             // Some selector values can cause IE to hang
295             if (!StyleSheet.isValidSelector(sel)) {
296                 Y.log("Invalid selector '"+sel+"' passed to set (ignoring).",'error','StyleSheet');
297                 return this;
298             }
300             // Opera throws an error if there's a syntax error in assigned
301             // cssText. Avoid this using a worker style collection, then
302             // assigning the resulting cssText.
303             if (rule) {
304                 rule.style.cssText = StyleSheet.toCssText(css,rule.style.cssText);
305             } else {
306                 idx = sheet[_rules].length;
307                 css = StyleSheet.toCssText(css);
309                 // IE throws an error when attempting to addRule(sel,'',n)
310                 // which would crop up if no, or only invalid values are used
311                 if (css) {
312                     _insertRule(sel, css, idx);
314                     // Safari replaces the rules collection, but maintains the
315                     // rule instances in the new collection when rules are
316                     // added/removed
317                     cssRules[sel] = sheet[_rules][idx];
318                 }
319             }
320             return this;
321         },
323         /**
324          * <p>Unset style properties for a provided selector string, removing
325          * their effect from the style cascade.</p>
326          *
327          * <p>If the selector includes commas, it will be split into individual
328          * selectors and applied accordingly.  If there are no properties
329          * remaining in the rule after unsetting, the rule is removed.</p>
330          *
331          * <p>The style property or properties in the second parameter must be the
332          * JavaScript style property names. E.g. fontSize rather than font-size.</p>
333          *
334          * <p>The float style property will be unset by any of &quot;float&quot;,
335          * &quot;styleFloat&quot;, or &quot;cssFloat&quot;.</p>
336          *
337          * @method unset
338          * @param sel {String} the selector string to apply the changes to
339          * @param css {String|Array} style property name or Array of names
340          * @return {StyleSheet}
341          * @chainable
342          */
343         unset : function (sel,css) {
344             var rule = cssRules[sel],
345                 multi = sel.split(/\s*,\s*/),
346                 remove = !css,
347                 rules, i;
349             // IE's addRule doesn't support multiple comma delimited selectors
350             // so rules are mapped internally by atomic selectors
351             if (multi.length > 1) {
352                 for (i = multi.length - 1; i >= 0; --i) {
353                     this.unset(multi[i], css);
354                 }
355                 return this;
356             }
358             if (rule) {
359                 if (!remove) {
360                     css = Y.Array(css);
362                     workerStyle.cssText = rule.style.cssText;
363                     for (i = css.length - 1; i >= 0; --i) {
364                         _unsetProperty(workerStyle,css[i]);
365                     }
367                     if (workerStyle.cssText) {
368                         rule.style.cssText = workerStyle.cssText;
369                     } else {
370                         remove = true;
371                     }
372                 }
374                 if (remove) { // remove the rule altogether
375                     rules = sheet[_rules];
376                     for (i = rules.length - 1; i >= 0; --i) {
377                         if (rules[i] === rule) {
378                             delete cssRules[sel];
379                             _deleteRule(i);
380                             break;
381                         }
382                     }
383                 }
384             }
385             return this;
386         },
388         /**
389          * Get the current cssText for a rule or the entire sheet.  If the
390          * selector param is supplied, only the cssText for that rule will be
391          * returned, if found.  If the selector string targets multiple
392          * selectors separated by commas, the cssText of the first rule only
393          * will be returned.  If no selector string, the stylesheet's full
394          * cssText will be returned.
395          *
396          * @method getCssText
397          * @param sel {String} Selector string
398          * @return {String}
399          */
400         getCssText : function (sel) {
401             var rule, css, selector;
403             if (isString(sel)) {
404                 // IE's addRule doesn't support multiple comma delimited
405                 // selectors so rules are mapped internally by atomic selectors
406                 rule = cssRules[sel.split(/\s*,\s*/)[0]];
408                 return rule ? rule.style.cssText : null;
409             } else {
410                 css = [];
411                 for (selector in cssRules) {
412                     if (cssRules.hasOwnProperty(selector)) {
413                         rule = cssRules[selector];
414                         css.push(rule.selectorText+" {"+rule.style.cssText+"}");
415                     }
416                 }
417                 return css.join("\n");
418             }
419         }
420     });
424 _toCssText = function (css,base) {
425     var f    = css.styleFloat || css.cssFloat || css[FLOAT],
426         trim = Y.Lang.trim,
427         prop;
429     // A very difficult to repro/isolate IE 9 beta (and Platform Preview 7) bug
430     // was reduced to this line throwing the error:
431     // "Invalid this pointer used as target for method call"
432     // It appears that the style collection is corrupted. The error is
433     // catchable, so in a best effort to work around it, replace the
434     // p and workerStyle and try the assignment again.
435     try {
436         workerStyle.cssText = base || EMPTY;
437     } catch (e) {
438         Y.log("Worker style collection corrupted. Replacing.", "warn", "StyleSheet");
439         p = d.createElement('p');
440         workerStyle = p.style;
441         workerStyle.cssText = base || EMPTY;
442     }
444     if (f && !css[floatAttr]) {
445         css = Y.merge(css);
446         delete css.styleFloat; delete css.cssFloat; delete css[FLOAT];
447         css[floatAttr] = f;
448     }
450     for (prop in css) {
451         if (css.hasOwnProperty(prop)) {
452             try {
453                 // IE throws Invalid Value errors and doesn't like whitespace
454                 // in values ala ' red' or 'red '
455                 workerStyle[prop] = trim(css[prop]);
456             }
457             catch (ex) {
458                 Y.log('Error assigning property "'+prop+'" to "'+css[prop]+
459                           "\" (ignored):\n"+ex.message,'warn','StyleSheet');
460             }
461         }
462     }
463     return workerStyle.cssText;
466 Y.mix(StyleSheet, {
467     /**
468      * <p>Converts an object literal of style properties and values into a string
469      * of css text.  This can then be assigned to el.style.cssText.</p>
470      *
471      * <p>The optional second parameter is a cssText string representing the
472      * starting state of the style prior to alterations.  This is most often
473      * extracted from the eventual target's current el.style.cssText.</p>
474      *
475      * @method toCssText
476      * @param css {Object} object literal of style properties and values
477      * @param cssText {String} (optional) starting cssText value
478      * @return {String} the resulting cssText string
479      * @static
480      */
481     toCssText : ((OPACITY in workerStyle) ? _toCssText :
482         // Wrap IE's toCssText to catch opacity.  The copy/merge is to preserve
483         // the input object's integrity, but if float and opacity are set, the
484         // input will be copied twice in IE.  Is there a way to avoid this
485         // without increasing the byte count?
486         function (css, cssText) {
487             if (OPACITY in css) {
488                 css = Y.merge(css,{
489                         filter: 'alpha(opacity='+(css.opacity*100)+')'
490                       });
491                 delete css.opacity;
492             }
493             return _toCssText(css,cssText);
494         }),
496     /**
497      * Registers a StyleSheet instance in the static registry by the given name
498      *
499      * @method register
500      * @param name {String} the name to assign the StyleSheet in the registry
501      * @param sheet {StyleSheet} The StyleSheet instance
502      * @return {Boolean} false if no name or sheet is not a StyleSheet
503      *              instance. true otherwise.
504      * @static
505      */
506     register : function (name,sheet) {
507         return !!(name && sheet instanceof StyleSheet &&
508                   !sheets[name] && (sheets[name] = sheet));
509     },
511     /**
512      * <p>Determines if a selector string is safe to use.  Used internally
513      * in set to prevent IE from locking up when attempting to add a rule for a
514      * &quot;bad selector&quot;.</p>
515      *
516      * <p>Bad selectors are considered to be any string containing unescaped
517      * `~!@$%^&()+=|{}[];'"?< or space. Also forbidden are . or # followed by
518      * anything other than an alphanumeric.  Additionally -abc or .-abc or
519      * #_abc or '# ' all fail.  There are likely more failure cases, so
520      * please file a bug if you encounter one.</p>
521      *
522      * @method isValidSelector
523      * @param sel {String} the selector string
524      * @return {Boolean}
525      * @static
526      */
527     isValidSelector : function (sel) {
528         var valid = false;
530         if (sel && isString(sel)) {
532             if (!selectors.hasOwnProperty(sel)) {
533                 // TEST: there should be nothing but white-space left after
534                 // these destructive regexs
535                 selectors[sel] = !/\S/.test(
536                     // combinators
537                     sel.replace(/\s+|\s*[+~>]\s*/g,' ').
538                     // attribute selectors (contents not validated)
539                     replace(/([^ ])\[.*?\]/g,'$1').
540                     // pseudo-class|element selectors (contents of parens
541                     // such as :nth-of-type(2) or :not(...) not validated)
542                     replace(/([^ ])::?[a-z][a-z\-]+[a-z](?:\(.*?\))?/ig,'$1').
543                     // element tags
544                     replace(/(?:^| )[a-z0-6]+/ig,' ').
545                     // escaped characters
546                     replace(/\\./g,EMPTY).
547                     // class and id identifiers
548                     replace(/[.#]\w[\w\-]*/g,EMPTY));
549             }
551             valid = selectors[sel];
552         }
554         return valid;
555     }
556 },true);
558 Y.StyleSheet = StyleSheet;
562 NOTES
563  * Style node must be added to the head element.  Safari does not honor styles
564    applied to StyleSheet objects on style nodes in the body.
565  * StyleSheet object is created on the style node when the style node is added
566    to the head element in Firefox 2 (and maybe 3?)
567  * The cssRules collection is replaced after insertRule/deleteRule calls in
568    Safari 3.1.  Existing Rules are used in the new collection, so the collection
569    cannot be cached, but the rules can be.
570  * Opera requires that the index be passed with insertRule.
571  * Same-domain restrictions prevent modifying StyleSheet objects attached to
572    link elements with remote href (or "about:blank" or "javascript:false")
573  * Same-domain restrictions prevent reading StyleSheet cssRules/rules
574    collection of link elements with remote href (or "about:blank" or
575    "javascript:false")
576  * Same-domain restrictions result in Safari not populating node.sheet property
577    for link elements with remote href (et.al)
578  * IE names StyleSheet related properties and methods differently (see code)
579  * IE converts tag names to upper case in the Rule's selectorText
580  * IE converts empty string assignment to complex properties to value settings
581    for all child properties.  E.g. style.background = '' sets non-'' values on
582    style.backgroundPosition, style.backgroundColor, etc.  All else clear
583    style.background and all child properties.
584  * IE assignment style.filter = '' will result in style.cssText == 'FILTER:'
585  * All browsers support Rule.style.cssText as a read/write property, leaving
586    only opacity needing to be accounted for.
587  * Benchmarks of style.property = value vs style.cssText += 'property: value'
588    indicate cssText is slightly slower for single property assignment.  For
589    multiple property assignment, cssText speed stays relatively the same where
590    style.property speed decreases linearly by the number of properties set.
591    Exception being Opera 9.27, where style.property is always faster than
592    style.cssText.
593  * Opera 9.5b throws a syntax error when assigning cssText with a syntax error.
594  * Opera 9.5 doesn't honor rule.style.cssText = ''.  Previous style persists.
595    You have to remove the rule altogether.
596  * Stylesheet properties set with !important will trump inline style set on an
597    element or in el.style.property.
598  * Creating a worker style collection like document.createElement('p').style;
599    will fail after a time in FF (~5secs of inactivity).  Property assignments
600    will not alter the property or cssText.  It may be the generated node is
601    garbage collected and the style collection becomes inert (speculation).
602  * IE locks up when attempting to add a rule with a selector including at least
603    characters {[]}~`!@%^&*()+=|? (unescaped) and leading _ or -
604    such as addRule('-foo','{ color: red }') or addRule('._abc','{...}')
605  * IE's addRule doesn't support comma separated selectors such as
606    addRule('.foo, .bar','{..}')
607  * IE throws an error on valid values with leading/trailing white space.
608  * When creating an entire sheet at once, only FF2/3 & Opera allow creating a
609    style node, setting its innerHTML and appending to head.
610  * When creating an entire sheet at once, Safari requires the style node to be
611    created with content in innerHTML of another element.
612  * When creating an entire sheet at once, IE requires the style node content to
613    be set via node.styleSheet.cssText
614  * When creating an entire sheet at once in IE, styleSheet.cssText can't be
615    written until node.type = 'text/css'; is performed.
616  * When creating an entire sheet at once in IE, load-time fork on
617    var styleNode = d.createElement('style'); _method = styleNode.styleSheet ?..
618    fails (falsey).  During run-time, the test for .styleSheet works fine
619  * Setting complex properties in cssText will SOMETIMES allow child properties
620    to be unset
621    set         unset              FF2  FF3  S3.1  IE6  IE7  Op9.27  Op9.5
622    ----------  -----------------  ---  ---  ----  ---  ---  ------  -----
623    border      -top               NO   NO   YES   YES  YES  YES     YES
624                -top-color         NO   NO   YES             YES     YES
625                -color             NO   NO   NO              NO      NO
626    background  -color             NO   NO   YES             YES     YES
627                -position          NO   NO   YES             YES     YES
628                -position-x        NO   NO   NO              NO      NO
629    font        line-height        YES  YES  NO    NO   NO   NO      YES
630                -style             YES  YES  NO              YES     YES
631                -size              YES  YES  NO              YES     YES
632                -size-adjust       ???  ???  n/a   n/a  n/a  ???     ???
633    padding     -top               NO   NO   YES             YES     YES
634    margin      -top               NO   NO   YES             YES     YES
635    list-style  -type              YES  YES  YES             YES     YES
636                -position          YES  YES  YES             YES     YES
637    overflow    -x                 NO   NO   YES             n/a     YES
639    ??? - unsetting font-size-adjust has the same effect as unsetting font-size
640  * FireFox and WebKit populate rule.cssText as "SELECTOR { CSSTEXT }", but
641    Opera and IE do not.
642  * IE6 and IE7 silently ignore the { and } if passed into addRule('.foo','{
643    color:#000}',0).  IE8 does not and creates an empty rule.
644  * IE6-8 addRule('.foo','',n) throws an error.  Must supply *some* cssText
649 }, '3.13.0', {"requires": ["yui-base"]});