mediawiki-extensions-Visual.../modules/syntaxhighlight/ve.dm.MWSyntaxHighlightNode.js
Tongbo Sui 62ec9d92e2 SyntaxHighlight node support
Update: Switched to generic ve.ui.Toolbar and ve.ui.Tool for consistency
with VE in general. Changed searchbox to floating and hidden by default.
Call for search using shortcut key. Overriden ESC key.

Node handler for <syntaxhighlight>'s Rdfa type.
Embedded in VisualEditor.php with its own ResourceLoader module.
Use $wgVisualEditorEnableExperimentalCode in LocalSettings.php
to load the module.

Supported languages (for testing): text, javascript

Features:
(1) Internal mechanisms:
	(1.1) Tokenizer. Tokenize input code string.
	(1.2) Highlighter. Highlight based on predefined rules.
	(1.3) Syntax checker. Validate based on predefined rules.
(2) SimpleSurface:
	(2.1) Auto indenter. Works with (){}[] blocks.
	(2.2) Reformatter. Reformats spaces and remove trailing
	whitespaces.
	(2.3) Language selection dropdown.
	(2.4) Basic editing. Insert, deletion, selection.
	(2.5) Clipboard & edit history support.
		(2.5.1) Undo (Ctrl + Z), redo (Ctrl + Y)
		(2.5.2) Copy (Ctrl + C), cut (Ctrl + X), paste (Ctrl + V)
	(2.6) Search & replace. Ctrl + F to quickly move focus to search
	box.

Bug 47742

Change-Id: I4adede9e05fd2236cee50ce03f597e8ff6b1914d
2013-10-02 11:01:06 -07:00

89 lines
2.2 KiB
JavaScript

/*!
* VisualEditor DataModel MWSyntaxHighlightNode class.
*
* @copyright 2011-2013 VisualEditor Team and others; see AUTHORS.txt
* @license The MIT License (MIT); see LICENSE.txt
*/
/**
* DataModel MediaWiki syntaxhighlight 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.MWSyntaxHighlightNode = function VeDmMWSyntaxHighlightNode( length, element ) {
// Parent constructor
ve.dm.LeafNode.call( this, 0, element );
};
/* Inheritance */
ve.inheritClass( ve.dm.MWSyntaxHighlightNode, ve.dm.LeafNode );
/* Static members */
ve.dm.MWSyntaxHighlightNode.static.name = 'mwSyntaxHighlight';
ve.dm.MWSyntaxHighlightNode.static.matchTagNames = null;
ve.dm.MWSyntaxHighlightNode.static.matchRdfaTypes = [ 'mw:Extension/syntaxhighlight' ];
ve.dm.MWSyntaxHighlightNode.static.isContent = true;
ve.dm.MWSyntaxHighlightNode.static.enableAboutGrouping = true;
/* Methods */
/**
* DOM to model
*
* @method
* @param {Array} domElements DOM elements
* @returns {Object} Data model
*/
ve.dm.MWSyntaxHighlightNode.static.toDataElement = function ( domElements ) {
var mw = JSON.parse( domElements[0].getAttribute( 'data-mw' ) || '{}' ),
lang = mw.attrs.lang,
body = mw.body ? mw.body.extsrc : '',
dataElement = {
'type': this.name,
'attributes': {
'mw': mw,
'lang' : lang,
'body' : body
},
// DOM cache for clean round-tripping
'span': domElements[1],
'div': domElements[0]
};
return dataElement;
};
/**
* Model to DOM
*
* @method
* @param {Object} dataElement Data model
* @returns {Array} DOM elements
*/
ve.dm.MWSyntaxHighlightNode.static.toDomElements = function ( dataElement ) {
var mwAttr,
div = dataElement.div,
span = dataElement.span;
mwAttr = ( dataElement.attributes && dataElement.attributes.mw ) || {};
// Update node content
ve.setProp( mwAttr, 'body', 'extsrc', dataElement.attributes.body );
ve.setProp( mwAttr, 'attrs', 'lang', dataElement.attributes.lang );
div.setAttribute( 'data-mw', JSON.stringify( mwAttr ) );
return [ div, span ];
};
/* Registration */
ve.dm.modelRegistry.register( ve.dm.MWSyntaxHighlightNode );