mirror of
https://gerrit.wikimedia.org/r/mediawiki/extensions/VisualEditor
synced 2024-11-05 14:12:53 +00:00
8f05cdbf70
Not having a description yet is fine, but they should at least be indexed as blocks so that they are searchable and listed in the jsduck generated pages. jsduck defaults to @method + name of prototype property. And it even guesses parameters sometimes. Search: \n\n([a-zA-Z\.]+\.prototype\.[a-zA-Z]+) Where: modules/ve,modules/ve-mw Where-Not: modules/ve/test Replace: \n\n/** */\n$1 Added @return in a few places where it was easy to add. Change-Id: I830c94cc7dbc261bd7a077391f930cbfff165f9d
245 lines
7.4 KiB
JavaScript
245 lines
7.4 KiB
JavaScript
/*!
|
|
* VisualEditor DataModel MWReferenceNode class.
|
|
*
|
|
* @copyright 2011-2013 VisualEditor Team and others; see AUTHORS.txt
|
|
* @license The MIT License (MIT); see LICENSE.txt
|
|
*/
|
|
|
|
/**
|
|
* DataModel MediaWiki reference node.
|
|
*
|
|
* @class
|
|
* @extends ve.dm.LeafNode
|
|
* @constructor
|
|
* @param {number} [length] Length of content data in document; ignored and overridden to 0
|
|
* @param {Object} [element] Reference to element in linear model
|
|
*/
|
|
ve.dm.MWReferenceNode = function VeDmMWReferenceNode( length, element ) {
|
|
// Parent constructor
|
|
ve.dm.LeafNode.call( this, 0, element );
|
|
|
|
// Event handlers
|
|
this.connect( this, {
|
|
'root': 'onRoot',
|
|
'unroot': 'onUnroot'
|
|
} );
|
|
};
|
|
|
|
/* Inheritance */
|
|
|
|
ve.inheritClass( ve.dm.MWReferenceNode, ve.dm.LeafNode );
|
|
|
|
/* Static members */
|
|
|
|
ve.dm.MWReferenceNode.static.name = 'mwReference';
|
|
|
|
ve.dm.MWReferenceNode.static.matchTagNames = null;
|
|
|
|
ve.dm.MWReferenceNode.static.matchRdfaTypes = [ 'mw:Extension/ref' ];
|
|
|
|
ve.dm.MWReferenceNode.static.isContent = true;
|
|
|
|
ve.dm.MWReferenceNode.static.toDataElement = function ( domElements, converter ) {
|
|
var dataElement,
|
|
mwDataJSON = domElements[0].getAttribute( 'data-mw' ),
|
|
mwData = mwDataJSON ? JSON.parse( mwDataJSON ) : {},
|
|
body = mwData.body ? mwData.body.html : '',
|
|
refGroup = mwData.attrs && mwData.attrs.group || '',
|
|
listGroup = this.name + '/' + refGroup,
|
|
listKey = mwData.attrs && mwData.attrs.name !== undefined ? mwData.attrs.name : null,
|
|
queueResult = converter.internalList.queueItemHtml( listGroup, listKey, body ),
|
|
listIndex = queueResult.index,
|
|
contentsUsed = ( body !== '' && queueResult.isNew );
|
|
|
|
dataElement = {
|
|
'type': this.name,
|
|
'attributes': {
|
|
'mw': mwData,
|
|
'originalMw': mwDataJSON,
|
|
'childDomElements': ve.copy( Array.prototype.slice.apply( domElements[0].childNodes ) ),
|
|
'listIndex': listIndex,
|
|
'listGroup': listGroup,
|
|
'listKey': listKey,
|
|
'refGroup': refGroup,
|
|
'contentsUsed': contentsUsed
|
|
}
|
|
};
|
|
return dataElement;
|
|
};
|
|
|
|
ve.dm.MWReferenceNode.static.toDomElements = function ( dataElement, doc, converter ) {
|
|
var itemNodeHtml, originalHtml, mwData, i, iLen, keyedNodes, setContents, contentsAlreadySet,
|
|
originalMw, childDomElements,
|
|
el = doc.createElement( 'span' ),
|
|
itemNodeWrapper = doc.createElement( 'div' ),
|
|
itemNode = converter.internalList.getItemNode( dataElement.attributes.listIndex ),
|
|
itemNodeRange = itemNode.getRange();
|
|
|
|
el.setAttribute( 'typeof', 'mw:Extension/ref' );
|
|
|
|
mwData = dataElement.attributes.mw ? ve.copy( dataElement.attributes.mw ) : {};
|
|
mwData.name = 'ref';
|
|
|
|
setContents = dataElement.attributes.contentsUsed || dataElement.attributes.listKey === null;
|
|
|
|
keyedNodes = converter.internalList
|
|
.getNodeGroup( dataElement.attributes.listGroup )
|
|
.keyedNodes[dataElement.attributes.listKey];
|
|
if ( setContents ) {
|
|
// Check if a previous node has already set the content. If so, we don't overwrite this
|
|
// node's contents.
|
|
contentsAlreadySet = false;
|
|
if ( keyedNodes ) {
|
|
for ( i = 0, iLen = keyedNodes.length; i < iLen; i++ ) {
|
|
if ( keyedNodes[i].element === dataElement ) {
|
|
break;
|
|
}
|
|
if ( keyedNodes[i].element.attributes.contentsUsed ) {
|
|
contentsAlreadySet = true;
|
|
break;
|
|
}
|
|
}
|
|
}
|
|
} else {
|
|
// Check if any other nodes with this key provided content. If not
|
|
// then we attach the contents to the first reference with this key
|
|
|
|
// Check that this the first reference with its key
|
|
if ( keyedNodes && dataElement === keyedNodes[0].element ) {
|
|
setContents = true;
|
|
// Check no other reference originally defined the contents
|
|
// As this is keyedNodes[0] we can start at 1
|
|
for ( i = 1, iLen = keyedNodes.length; i < iLen; i++ ) {
|
|
if ( keyedNodes[i].element.attributes.contentsUsed ) {
|
|
setContents = false;
|
|
break;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
if ( setContents && !contentsAlreadySet ) {
|
|
converter.getDomSubtreeFromData(
|
|
itemNode.getDocument().getFullData( new ve.Range( itemNodeRange.start, itemNodeRange.end ), true ),
|
|
itemNodeWrapper
|
|
);
|
|
itemNodeHtml = $( itemNodeWrapper ).html(); // Returns '' if itemNodeWrapper is empty
|
|
originalHtml = ve.getProp( mwData, 'body', 'html' ) || '';
|
|
// Only set body.html if itemNodeHtml and originalHtml are actually different
|
|
if ( !$( '<div>' ).html( originalHtml ).get( 0 ).isEqualNode( itemNodeWrapper ) ) {
|
|
ve.setProp( mwData, 'body', 'html', itemNodeHtml );
|
|
}
|
|
}
|
|
|
|
// Set or clear key
|
|
if ( dataElement.attributes.listKey !== null ) {
|
|
ve.setProp( mwData, 'attrs', 'name', dataElement.attributes.listKey );
|
|
} else if ( mwData.attrs ) {
|
|
delete mwData.attrs.listKey;
|
|
}
|
|
// Set or clear group
|
|
if ( dataElement.attributes.refGroup !== '' ) {
|
|
ve.setProp( mwData, 'attrs', 'group', dataElement.attributes.refGroup );
|
|
} else if ( mwData.attrs ) {
|
|
delete mwData.attrs.refGroup;
|
|
}
|
|
|
|
// If mwAttr and originalMw are the same, use originalMw to prevent reserialization.
|
|
// Reserialization has the potential to reorder keys and so change the DOM unnecessarily
|
|
originalMw = dataElement.attributes.originalMw;
|
|
if ( originalMw && ve.compare( mwData, JSON.parse( originalMw ) ) ) {
|
|
el.setAttribute( 'data-mw', originalMw );
|
|
|
|
// Restore the span's childNodes to prevent unnecessary DOM diffs
|
|
childDomElements = ve.copyDomElements( dataElement.attributes.childDomElements, doc );
|
|
for ( i = 0, iLen = childDomElements.length; i < iLen; i++ ) {
|
|
el.appendChild( childDomElements[i] );
|
|
}
|
|
} else {
|
|
el.setAttribute( 'data-mw', JSON.stringify( mwData ) );
|
|
}
|
|
|
|
return [ el ];
|
|
};
|
|
|
|
ve.dm.MWReferenceNode.static.remapInternalListIndexes = function ( dataElement, mapping ) {
|
|
dataElement.attributes.listIndex = mapping[dataElement.attributes.listIndex];
|
|
};
|
|
|
|
/* Methods */
|
|
|
|
/**
|
|
* Don't allow reference nodes to be inspected if we can't find their contents.
|
|
*
|
|
* @inheritdoc
|
|
*/
|
|
ve.dm.MWReferenceNode.prototype.isInspectable = function () {
|
|
var internalItem = this.getInternalItem();
|
|
return internalItem && internalItem.getLength() > 0;
|
|
};
|
|
|
|
/**
|
|
* Gets the internal item node associated with this node
|
|
* @method
|
|
* @returns {ve.dm.InternalItemNode} Item node
|
|
*/
|
|
ve.dm.MWReferenceNode.prototype.getInternalItem = function () {
|
|
return this.getDocument().getInternalList().getItemNode( this.getAttribute( 'listIndex' ) );
|
|
};
|
|
|
|
/**
|
|
* Handle the node being attached to the root
|
|
* @method
|
|
*/
|
|
ve.dm.MWReferenceNode.prototype.onRoot = function () {
|
|
this.addToInternalList();
|
|
};
|
|
|
|
/**
|
|
* Handle the node being detatched from the root
|
|
* @method
|
|
*/
|
|
ve.dm.MWReferenceNode.prototype.onUnroot = function () {
|
|
this.removeFromInternalList();
|
|
};
|
|
|
|
/**
|
|
* Register the node with the internal list
|
|
* @method
|
|
*/
|
|
ve.dm.MWReferenceNode.prototype.addToInternalList = function () {
|
|
if ( this.getRoot() === this.getDocument().getDocumentNode() ) {
|
|
this.getDocument().getInternalList().addNode(
|
|
this.element.attributes.listGroup,
|
|
this.element.attributes.listKey,
|
|
this.element.attributes.listIndex,
|
|
this
|
|
);
|
|
}
|
|
};
|
|
|
|
/**
|
|
* Unregister the node from the internal list
|
|
* @method
|
|
*/
|
|
ve.dm.MWReferenceNode.prototype.removeFromInternalList = function () {
|
|
this.getDocument().getInternalList().removeNode(
|
|
this.element.attributes.listGroup,
|
|
this.element.attributes.listKey,
|
|
this.element.attributes.listIndex,
|
|
this
|
|
);
|
|
};
|
|
|
|
/** */
|
|
ve.dm.MWReferenceNode.prototype.getClonedElement = function () {
|
|
var clone = ve.dm.LeafNode.prototype.getClonedElement.call( this );
|
|
delete clone.attributes.contentsUsed;
|
|
delete clone.attributes.originalMw;
|
|
return clone;
|
|
};
|
|
|
|
/* Registration */
|
|
|
|
ve.dm.modelRegistry.register( ve.dm.MWReferenceNode );
|