| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381 |
- /**
- * @license Copyright (c) 2003-2017, CKSource - Frederico Knabben. All rights reserved.
- * For licensing, see LICENSE.md.
- */
- /**
- * @module engine/view/matcher
- */
- /**
- * View matcher class.
- * Instance of this class can be used to find {@link module:engine/view/element~Element elements} that match given pattern.
- */
- export default class Matcher {
- /**
- * Creates new instance of Matcher.
- *
- * @param {String|RegExp|Object} [pattern] Match patterns. See {@link module:engine/view/matcher~Matcher#add add method} for
- * more information.
- */
- constructor( ...pattern ) {
- this._patterns = [];
- this.add( ...pattern );
- }
- /**
- * Adds pattern or patterns to matcher instance.
- *
- * Example patterns matching element's name:
- *
- * // String.
- * matcher.add( 'div' );
- * matcher.add( { name: 'div' } );
- *
- * // Regular expression.
- * matcher.add( /^\w/ );
- * matcher.add( { name: /^\w/ } );
- *
- * Example pattern matching element's attributes:
- *
- * matcher.add( {
- * attribute: {
- * title: 'foobar',
- * foo: /^\w+/
- * }
- * } );
- *
- * Example patterns matching element's classes:
- *
- * // Single class.
- * matcher.add( {
- * class: 'foobar'
- * } );
- *
- * // Single class using regular expression.
- * matcher.add( {
- * class: /foo.../
- * } );
- *
- * // Multiple classes to match.
- * matcher.add( {
- * class: [ 'baz', 'bar', /foo.../ ]
- * } ):
- *
- * Example pattern matching element's styles:
- *
- * matcher.add( {
- * style: {
- * position: 'absolute',
- * color: /^\w*blue$/
- * }
- * } );
- *
- * Example function pattern:
- *
- * matcher.add( ( element ) => {
- * // Result of this function will be included in `match`
- * // property of the object returned from matcher.match() call.
- * if ( element.name === 'div' && element.childCount > 0 ) {
- * return { name: true };
- * }
- *
- * return null;
- * } );
- *
- * Multiple patterns can be added in one call:
- *
- * matcher.add( 'div', { class: 'foobar' } );
- *
- * @param {Object|String|RegExp|Function} pattern Object describing pattern details. If string or regular expression
- * is provided it will be used to match element's name. Pattern can be also provided in a form
- * of a function - then this function will be called with each {@link module:engine/view/element~Element element} as a parameter.
- * Function's return value will be stored under `match` key of the object returned from
- * {@link module:engine/view/matcher~Matcher#match match} or {@link module:engine/view/matcher~Matcher#matchAll matchAll} methods.
- * @param {String|RegExp} [pattern.name] Name or regular expression to match element's name.
- * @param {Object} [pattern.attribute] Object with key-value pairs representing attributes to match. Each object key
- * represents attribute name. Value under that key can be either a string or a regular expression and it will be
- * used to match attribute value.
- * @param {String|RegExp|Array} [pattern.class] Class name or array of class names to match. Each name can be
- * provided in a form of string or regular expression.
- * @param {Object} [pattern.style] Object with key-value pairs representing styles to match. Each object key
- * represents style name. Value under that key can be either a string or a regular expression and it will be used
- * to match style value.
- */
- add( ...pattern ) {
- for ( let item of pattern ) {
- // String or RegExp pattern is used as element's name.
- if ( typeof item == 'string' || item instanceof RegExp ) {
- item = { name: item };
- }
- // Single class name/RegExp can be provided.
- if ( item.class && ( typeof item.class == 'string' || item.class instanceof RegExp ) ) {
- item.class = [ item.class ];
- }
- this._patterns.push( item );
- }
- }
- /**
- * Matches elements for currently stored patterns. Returns match information about first found
- * {@link module:engine/view/element~Element element}, otherwise returns `null`.
- *
- * Example of returned object:
- *
- * {
- * element: <instance of found element>,
- * pattern: <pattern used to match found element>,
- * match: {
- * name: true,
- * attribute: [ 'title', 'href' ],
- * class: [ 'foo' ],
- * style: [ 'color', 'position' ]
- * }
- * }
- *
- * @see module:engine/view/matcher~Matcher#add
- * @see module:engine/view/matcher~Matcher#matchAll
- * @param {...module:engine/view/element~Element} element View element to match against stored patterns.
- * @returns {Object|null} result
- * @returns {module:engine/view/element~Element} result.element Matched view element.
- * @returns {Object|String|RegExp|Function} result.pattern Pattern that was used to find matched element.
- * @returns {Object} result.match Object representing matched element parts.
- * @returns {Boolean} [result.match.name] True if name of the element was matched.
- * @returns {Array} [result.match.attribute] Array with matched attribute names.
- * @returns {Array} [result.match.class] Array with matched class names.
- * @returns {Array} [result.match.style] Array with matched style names.
- */
- match( ...element ) {
- for ( const singleElement of element ) {
- for ( const pattern of this._patterns ) {
- const match = isElementMatching( singleElement, pattern );
- if ( match ) {
- return {
- element: singleElement,
- pattern,
- match
- };
- }
- }
- }
- return null;
- }
- /**
- * Matches elements for currently stored patterns. Returns array of match information with all found
- * {@link module:engine/view/element~Element elements}. If no element is found - returns `null`.
- *
- * @see module:engine/view/matcher~Matcher#add
- * @see module:engine/view/matcher~Matcher#match
- * @param {...module:engine/view/element~Element} element View element to match against stored patterns.
- * @returns {Array.<Object>|null} Array with match information about found elements or `null`. For more information
- * see {@link module:engine/view/matcher~Matcher#match match method} description.
- */
- matchAll( ...element ) {
- const results = [];
- for ( const singleElement of element ) {
- for ( const pattern of this._patterns ) {
- const match = isElementMatching( singleElement, pattern );
- if ( match ) {
- results.push( {
- element: singleElement,
- pattern,
- match
- } );
- }
- }
- }
- return results.length > 0 ? results : null;
- }
- /**
- * Returns the name of the element to match if there is exactly one pattern added to the matcher instance
- * and it matches element name defined by `string` (not `RegExp`). Otherwise, returns `null`.
- *
- * @returns {String|null} Element name trying to match.
- */
- getElementName() {
- if ( this._patterns.length !== 1 ) {
- return null;
- }
- const pattern = this._patterns[ 0 ];
- const name = pattern.name;
- return ( typeof pattern != 'function' && name && !( name instanceof RegExp ) ) ? name : null;
- }
- }
- // Returns match information if {@link module:engine/view/element~Element element} is matching provided pattern.
- // If element cannot be matched to provided pattern - returns `null`.
- //
- // @param {module:engine/view/element~Element} element
- // @param {Object|String|RegExp|Function} pattern
- // @returns {Object|null} Returns object with match information or null if element is not matching.
- function isElementMatching( element, pattern ) {
- // If pattern is provided as function - return result of that function;
- if ( typeof pattern == 'function' ) {
- return pattern( element );
- }
- const match = {};
- // Check element's name.
- if ( pattern.name ) {
- match.name = matchName( pattern.name, element.name );
- if ( !match.name ) {
- return null;
- }
- }
- // Check element's attributes.
- if ( pattern.attribute ) {
- match.attribute = matchAttributes( pattern.attribute, element );
- if ( !match.attribute ) {
- return null;
- }
- }
- // Check element's classes.
- if ( pattern.class ) {
- match.class = matchClasses( pattern.class, element );
- if ( !match.class ) {
- return false;
- }
- }
- // Check element's styles.
- if ( pattern.style ) {
- match.style = matchStyles( pattern.style, element );
- if ( !match.style ) {
- return false;
- }
- }
- return match;
- }
- // Checks if name can be matched by provided pattern.
- //
- // @param {String|RegExp} pattern
- // @param {String} name
- // @returns {Boolean} Returns `true` if name can be matched, `false` otherwise.
- function matchName( pattern, name ) {
- // If pattern is provided as RegExp - test against this regexp.
- if ( pattern instanceof RegExp ) {
- return pattern.test( name );
- }
- return pattern === name;
- }
- // Checks if attributes of provided element can be matched against provided patterns.
- //
- // @param {Object} patterns Object with information about attributes to match. Each key of the object will be
- // used as attribute name. Value of each key can be a string or regular expression to match against attribute value.
- // @param {module:engine/view/element~Element} element Element which attributes will be tested.
- // @returns {Array|null} Returns array with matched attribute names or `null` if no attributes were matched.
- function matchAttributes( patterns, element ) {
- const match = [];
- for ( const name in patterns ) {
- const pattern = patterns[ name ];
- if ( element.hasAttribute( name ) ) {
- const attribute = element.getAttribute( name );
- if ( pattern instanceof RegExp ) {
- if ( pattern.test( attribute ) ) {
- match.push( name );
- } else {
- return null;
- }
- } else if ( attribute === pattern ) {
- match.push( name );
- } else {
- return null;
- }
- } else {
- return null;
- }
- }
- return match;
- }
- // Checks if classes of provided element can be matched against provided patterns.
- //
- // @param {Array.<String|RegExp>} patterns Array of strings or regular expressions to match against element's classes.
- // @param {module:engine/view/element~Element} element Element which classes will be tested.
- // @returns {Array|null} Returns array with matched class names or `null` if no classes were matched.
- function matchClasses( patterns, element ) {
- const match = [];
- for ( const pattern of patterns ) {
- if ( pattern instanceof RegExp ) {
- const classes = element.getClassNames();
- for ( const name of classes ) {
- if ( pattern.test( name ) ) {
- match.push( name );
- }
- }
- if ( match.length === 0 ) {
- return null;
- }
- } else if ( element.hasClass( pattern ) ) {
- match.push( pattern );
- } else {
- return null;
- }
- }
- return match;
- }
- // Checks if styles of provided element can be matched against provided patterns.
- //
- // @param {Object} patterns Object with information about styles to match. Each key of the object will be
- // used as style name. Value of each key can be a string or regular expression to match against style value.
- // @param {module:engine/view/element~Element} element Element which styles will be tested.
- // @returns {Array|null} Returns array with matched style names or `null` if no styles were matched.
- function matchStyles( patterns, element ) {
- const match = [];
- for ( const name in patterns ) {
- const pattern = patterns[ name ];
- if ( element.hasStyle( name ) ) {
- const style = element.getStyle( name );
- if ( pattern instanceof RegExp ) {
- if ( pattern.test( style ) ) {
- match.push( name );
- } else {
- return null;
- }
- } else if ( style === pattern ) {
- match.push( name );
- } else {
- return null;
- }
- } else {
- return null;
- }
- }
- return match;
- }
|