| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373 |
- /**
- * @license Copyright (c) 2003-2017, CKSource - Frederico Knabben. All rights reserved.
- * For licensing, see LICENSE.md.
- */
- import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror';
- import ObservableMixin from '@ckeditor/ckeditor5-utils/src/observablemixin';
- import mix from '@ckeditor/ckeditor5-utils/src/mix';
- /**
- * @module engine/model/schema
- */
- /**
- * @mixes module:utils/emittermixin~ObservableMixin
- */
- export default class Schema {
- constructor() {
- this._sourceRules = {};
- // TODO events
- this.decorate( 'checkChild' );
- this.decorate( 'checkAttribute' );
- this.on( 'checkAttribute', ( evt, args ) => {
- args[ 0 ] = normalizeContext( args[ 0 ] );
- }, { priority: 'highest' } );
- this.on( 'checkChild', ( evt, args ) => {
- args[ 0 ] = normalizeContext( args[ 0 ] );
- }, { priority: 'highest' } );
- }
- register( itemName, rules ) {
- if ( this._sourceRules[ itemName ] ) {
- // TODO docs
- throw new CKEditorError( 'schema-cannot-register-item-twice: A single item cannot be registered twice in the schema.' );
- }
- this._sourceRules[ itemName ] = [
- Object.assign( {}, rules )
- ];
- this._clearCache();
- }
- extend( itemName, rules ) {
- // TODO it should not throw if we want to allow e.g. adding attrs before element is registered
- // (which may be done by another feature).
- if ( !this._sourceRules[ itemName ] ) {
- // TODO docs
- throw new CKEditorError( 'schema-cannot-extend-missing-item: Cannot extend an item which was not registered yet.' );
- }
- this._sourceRules[ itemName ].push( Object.assign( {}, rules ) );
- this._clearCache();
- }
- getRules() {
- if ( !this._compiledRules ) {
- this._compile();
- }
- return this._compiledRules;
- }
- /**
- * @param {module:engine/model/node~Node|String} item
- */
- getRule( item ) {
- let itemName;
- if ( typeof item == 'string' ) {
- itemName = item;
- } else if ( item.is && item.is( 'text' ) ) {
- itemName = '$text';
- }
- // Element or context item.
- else {
- itemName = item.name;
- }
- return this.getRules()[ itemName ];
- }
- isRegistered( itemName ) {
- return !!this.getRule( itemName );
- }
- isBlock( itemName ) {
- const rule = this.getRule( itemName );
- return !!( rule && rule.isBlock );
- }
- isLimit( itemName ) {
- const rule = this.getRule( itemName );
- return !!( rule && rule.isLimit );
- }
- isObject( itemName ) {
- const rule = this.getRule( itemName );
- return !!( rule && rule.isObject );
- }
- /**
- * @param {module:engine/model/element~Element|module:engine/model/position~Position|Array.<String>} context
- * @param {module:engine/model/node~Node|String}
- */
- checkChild( context, child ) {
- const rule = this.getRule( child );
- if ( !rule ) {
- return false;
- }
- return this._checkContextMatch( rule, context );
- }
- /**
- * @param {module:engine/model/node~Node} context
- * @param {String}
- */
- checkAttribute( context, attributeName ) {
- const rule = this.getRule( context[ context.length - 1 ] );
- if ( !rule ) {
- return false;
- }
- return rule.allowAttributes.includes( attributeName );
- }
- /**
- * Returns the lowest {@link module:engine/model/schema~Schema#isLimit limit element} containing the entire
- * selection or the root otherwise.
- *
- * @param {module:engine/model/selection~Selection} selection Selection which returns the common ancestor.
- * @returns {module:engine/model/element~Element}
- */
- getLimitElement( selection ) {
- // Find the common ancestor for all selection's ranges.
- let element = Array.from( selection.getRanges() )
- .reduce( ( node, range ) => {
- if ( !node ) {
- return range.getCommonAncestor();
- }
- return node.getCommonAncestor( range.getCommonAncestor() );
- }, null );
- while ( !this.isLimit( element.name ) ) {
- if ( element.parent ) {
- element = element.parent;
- } else {
- break;
- }
- }
- return element;
- }
- removeDisallowedAttributes() {
- // TODO
- }
- _clearCache() {
- this._compiledRules = null;
- }
- _compile() {
- const compiledRules = {};
- const sourceRules = this._sourceRules;
- const itemNames = Object.keys( sourceRules );
- for ( const itemName of itemNames ) {
- compiledRules[ itemName ] = compileBaseItemRule( sourceRules[ itemName ], itemName );
- }
- for ( const itemName of itemNames ) {
- compileAllowContentOf( compiledRules, itemName );
- }
- for ( const itemName of itemNames ) {
- compileAllowWhere( compiledRules, itemName );
- }
- for ( const itemName of itemNames ) {
- compileAllowAttributesOf( compiledRules, itemName );
- }
- for ( const itemName of itemNames ) {
- cleanUpAllowIn( compiledRules, itemName );
- cleanUpAllowAttributes( compiledRules, itemName );
- }
- this._compiledRules = compiledRules;
- }
- _checkContextMatch( rule, context, contextItemIndex = context.length - 1 ) {
- const contextItem = context[ contextItemIndex ];
- if ( rule.allowIn.includes( contextItem.name ) ) {
- if ( contextItemIndex == 0 ) {
- return true;
- } else {
- const parentRule = this.getRule( contextItem );
- return this._checkContextMatch( parentRule, context, contextItemIndex - 1 );
- }
- } else {
- return false;
- }
- }
- }
- mix( Schema, ObservableMixin );
- function compileBaseItemRule( sourceItemRules, itemName ) {
- const itemRule = {
- name: itemName,
- allowIn: [],
- allowContentOf: [],
- allowWhere: [],
- allowAttributes: [],
- allowAttributesOf: []
- };
- copyTypes( sourceItemRules, itemRule );
- copyProperty( sourceItemRules, itemRule, 'allowIn' );
- copyProperty( sourceItemRules, itemRule, 'allowContentOf' );
- copyProperty( sourceItemRules, itemRule, 'allowWhere' );
- copyProperty( sourceItemRules, itemRule, 'allowAttributes' );
- copyProperty( sourceItemRules, itemRule, 'allowAttributesOf' );
- makeInheritAllWork( sourceItemRules, itemRule );
- return itemRule;
- }
- function compileAllowContentOf( compiledRules, itemName ) {
- for ( const allowContentOfItemName of compiledRules[ itemName ].allowContentOf ) {
- // The allowContentOf property may point to an unregistered element.
- if ( compiledRules[ allowContentOfItemName ] ) {
- const allowedChildren = getAllowedChildren( compiledRules, allowContentOfItemName );
- allowedChildren.forEach( allowedItem => {
- allowedItem.allowIn.push( itemName );
- } );
- }
- }
- delete compiledRules[ itemName ].allowContentOf;
- }
- function compileAllowWhere( compiledRules, itemName ) {
- for ( const allowWhereItemName of compiledRules[ itemName ].allowWhere ) {
- const inheritFrom = compiledRules[ allowWhereItemName ];
- // The allowWhere property may point to an unregistered element.
- if ( inheritFrom ) {
- const allowedIn = inheritFrom.allowIn;
- compiledRules[ itemName ].allowIn.push( ...allowedIn );
- }
- }
- delete compiledRules[ itemName ].allowWhere;
- }
- function compileAllowAttributesOf( compiledRules, itemName ) {
- for ( const allowAttributeOfItem of compiledRules[ itemName ].allowAttributesOf ) {
- const inheritFrom = compiledRules[ allowAttributeOfItem ];
- if ( inheritFrom ) {
- const inheritAttributes = inheritFrom.allowAttributes;
- compiledRules[ itemName ].allowAttributes.push( ...inheritAttributes );
- }
- }
- delete compiledRules[ itemName ].allowAttributesOf;
- }
- // Remove items which weren't registered (because it may break some checks or we'd need to complicate them).
- // Make sure allowIn doesn't contain repeated values.
- function cleanUpAllowIn( compiledRules, itemName ) {
- const itemRule = compiledRules[ itemName ];
- const existingItems = itemRule.allowIn.filter( itemToCheck => compiledRules[ itemToCheck ] );
- itemRule.allowIn = Array.from( new Set( existingItems ) );
- }
- function cleanUpAllowAttributes( compiledRules, itemName ) {
- const itemRule = compiledRules[ itemName ];
- itemRule.allowAttributes = Array.from( new Set( itemRule.allowAttributes ) );
- }
- function copyTypes( sourceItemRules, itemRule ) {
- for ( const sourceItemRule of sourceItemRules ) {
- const typeNames = Object.keys( sourceItemRule ).filter( name => name.startsWith( 'is' ) );
- for ( const name of typeNames ) {
- itemRule[ name ] = sourceItemRule[ name ];
- }
- }
- }
- function copyProperty( sourceItemRules, itemRule, propertyName ) {
- for ( const sourceItemRule of sourceItemRules ) {
- if ( typeof sourceItemRule[ propertyName ] == 'string' ) {
- itemRule[ propertyName ].push( sourceItemRule[ propertyName ] );
- } else if ( Array.isArray( sourceItemRule[ propertyName ] ) ) {
- itemRule[ propertyName ].push( ...sourceItemRule[ propertyName ] );
- }
- }
- }
- function makeInheritAllWork( sourceItemRules, itemRule ) {
- for ( const sourceItemRule of sourceItemRules ) {
- const inheritFrom = sourceItemRule.inheritAllFrom;
- if ( inheritFrom ) {
- itemRule.allowContentOf.push( inheritFrom );
- itemRule.allowWhere.push( inheritFrom );
- itemRule.allowAttributesOf.push( inheritFrom );
- }
- }
- }
- function getAllowedChildren( compiledRules, itemName ) {
- const itemRule = compiledRules[ itemName ];
- return getValues( compiledRules ).filter( rule => rule.allowIn.includes( itemRule.name ) );
- }
- function normalizeContext( ctx ) {
- if ( Array.isArray( ctx ) ) {
- return ctx.map( mapContextItem );
- }
- // Item or position (PS. It's ok that Position#getAncestors() doesn't accept params).
- else {
- return ctx.getAncestors( { includeSelf: true } ).map( mapContextItem );
- }
- }
- function mapContextItem( ctxItem ) {
- if ( typeof ctxItem == 'string' ) {
- return {
- name: ctxItem,
- * getAttributes() {}
- };
- } else {
- return {
- name: ctxItem.is( 'text' ) ? '$text' : ctxItem.name,
- * getAttributes() {
- yield* ctxItem.getAttributes();
- }
- };
- }
- }
- function getValues( obj ) {
- return Object.keys( obj ).map( key => obj[ key ] );
- }
|