Update to 4.7.3

[perso/Immae/Projets/packagist/ludivine-ckeditor-component.git] / sources / plugins / htmlwriter / plugin.js

/**\r
 * @license Copyright (c) 2003-2017, CKSource - Frederico Knabben. All rights reserved.\r
 * For licensing, see LICENSE.md or http://ckeditor.com/license\r
 */\r
\r
CKEDITOR.plugins.add( 'htmlwriter', {\r
	init: function( editor ) {\r
		var writer = new CKEDITOR.htmlWriter();\r
\r
		writer.forceSimpleAmpersand = editor.config.forceSimpleAmpersand;\r
		writer.indentationChars = editor.config.dataIndentationChars || '\t';\r
\r
		// Overwrite default basicWriter initialized in hmtlDataProcessor constructor.\r
		editor.dataProcessor.writer = writer;\r
	}\r
} );\r
\r
/**\r
 * The class used to write HTML data.\r
 *\r
 *		var writer = new CKEDITOR.htmlWriter();\r
 *		writer.openTag( 'p' );\r
 *		writer.attribute( 'class', 'MyClass' );\r
 *		writer.openTagClose( 'p' );\r
 *		writer.text( 'Hello' );\r
 *		writer.closeTag( 'p' );\r
 *		alert( writer.getHtml() ); // '<p class="MyClass">Hello</p>'\r
 *\r
 * @class\r
 * @extends CKEDITOR.htmlParser.basicWriter\r
 */\r
CKEDITOR.htmlWriter = CKEDITOR.tools.createClass( {\r
	base: CKEDITOR.htmlParser.basicWriter,\r
\r
	/**\r
	 * Creates an `htmlWriter` class instance.\r
	 *\r
	 * @constructor\r
	 */\r
	$: function() {\r
		// Call the base contructor.\r
		this.base();\r
\r
		/**\r
		 * The characters to be used for each indentation step.\r
		 *\r
		 *		// Use tab for indentation.\r
		 *		editorInstance.dataProcessor.writer.indentationChars = '\t';\r
		 */\r
		this.indentationChars = '\t';\r
\r
		/**\r
		 * The characters to be used to close "self-closing" elements, like `<br>` or `<img>`.\r
		 *\r
		 *		// Use HTML4 notation for self-closing elements.\r
		 *		editorInstance.dataProcessor.writer.selfClosingEnd = '>';\r
		 */\r
		this.selfClosingEnd = ' />';\r
\r
		/**\r
		 * The characters to be used for line breaks.\r
		 *\r
		 *		// Use CRLF for line breaks.\r
		 *		editorInstance.dataProcessor.writer.lineBreakChars = '\r\n';\r
		 */\r
		this.lineBreakChars = '\n';\r
\r
		this.sortAttributes = 1;\r
\r
		this._.indent = 0;\r
		this._.indentation = '';\r
		// Indicate preformatted block context status. (http://dev.ckeditor.com/ticket/5789)\r
		this._.inPre = 0;\r
		this._.rules = {};\r
\r
		var dtd = CKEDITOR.dtd;\r
\r
		for ( var e in CKEDITOR.tools.extend( {}, dtd.$nonBodyContent, dtd.$block, dtd.$listItem, dtd.$tableContent ) ) {\r
			this.setRules( e, {\r
				indent: !dtd[ e ][ '#' ],\r
				breakBeforeOpen: 1,\r
				breakBeforeClose: !dtd[ e ][ '#' ],\r
				breakAfterClose: 1,\r
				needsSpace: ( e in dtd.$block ) && !( e in { li: 1, dt: 1, dd: 1 } )\r
			} );\r
		}\r
\r
		this.setRules( 'br', { breakAfterOpen: 1 } );\r
\r
		this.setRules( 'title', {\r
			indent: 0,\r
			breakAfterOpen: 0\r
		} );\r
\r
		this.setRules( 'style', {\r
			indent: 0,\r
			breakBeforeClose: 1\r
		} );\r
\r
		this.setRules( 'pre', {\r
			breakAfterOpen: 1, // Keep line break after the opening tag\r
			indent: 0 // Disable indentation on <pre>.\r
		} );\r
	},\r
\r
	proto: {\r
		/**\r
		 * Writes the tag opening part for an opener tag.\r
		 *\r
		 *		// Writes '<p'.\r
		 *		writer.openTag( 'p', { class : 'MyClass', id : 'MyId' } );\r
		 *\r
		 * @param {String} tagName The element name for this tag.\r
		 * @param {Object} attributes The attributes defined for this tag. The\r
		 * attributes could be used to inspect the tag.\r
		 */\r
		openTag: function( tagName ) {\r
			var rules = this._.rules[ tagName ];\r
\r
			if ( this._.afterCloser && rules && rules.needsSpace && this._.needsSpace )\r
				this._.output.push( '\n' );\r
\r
			if ( this._.indent )\r
				this.indentation();\r
			// Do not break if indenting.\r
			else if ( rules && rules.breakBeforeOpen ) {\r
				this.lineBreak();\r
				this.indentation();\r
			}\r
\r
			this._.output.push( '<', tagName );\r
\r
			this._.afterCloser = 0;\r
		},\r
\r
		/**\r
		 * Writes the tag closing part for an opener tag.\r
		 *\r
		 *		// Writes '>'.\r
		 *		writer.openTagClose( 'p', false );\r
		 *\r
		 *		// Writes ' />'.\r
		 *		writer.openTagClose( 'br', true );\r
		 *\r
		 * @param {String} tagName The element name for this tag.\r
		 * @param {Boolean} isSelfClose Indicates that this is a self-closing tag,\r
		 * like `<br>` or `<img>`.\r
		 */\r
		openTagClose: function( tagName, isSelfClose ) {\r
			var rules = this._.rules[ tagName ];\r
\r
			if ( isSelfClose ) {\r
				this._.output.push( this.selfClosingEnd );\r
\r
				if ( rules && rules.breakAfterClose )\r
					this._.needsSpace = rules.needsSpace;\r
			} else {\r
				this._.output.push( '>' );\r
\r
				if ( rules && rules.indent )\r
					this._.indentation += this.indentationChars;\r
			}\r
\r
			if ( rules && rules.breakAfterOpen )\r
				this.lineBreak();\r
			tagName == 'pre' && ( this._.inPre = 1 );\r
		},\r
\r
		/**\r
		 * Writes an attribute. This function should be called after opening the\r
		 * tag with {@link #openTagClose}.\r
		 *\r
		 *		// Writes ' class="MyClass"'.\r
		 *		writer.attribute( 'class', 'MyClass' );\r
		 *\r
		 * @param {String} attName The attribute name.\r
		 * @param {String} attValue The attribute value.\r
		 */\r
		attribute: function( attName, attValue ) {\r
\r
			if ( typeof attValue == 'string' ) {\r
				this.forceSimpleAmpersand && ( attValue = attValue.replace( /&amp;/g, '&' ) );\r
				// Browsers don't always escape special character in attribute values. (http://dev.ckeditor.com/ticket/4683, http://dev.ckeditor.com/ticket/4719).\r
				attValue = CKEDITOR.tools.htmlEncodeAttr( attValue );\r
			}\r
\r
			this._.output.push( ' ', attName, '="', attValue, '"' );\r
		},\r
\r
		/**\r
		 * Writes a closer tag.\r
		 *\r
		 *		// Writes '</p>'.\r
		 *		writer.closeTag( 'p' );\r
		 *\r
		 * @param {String} tagName The element name for this tag.\r
		 */\r
		closeTag: function( tagName ) {\r
			var rules = this._.rules[ tagName ];\r
\r
			if ( rules && rules.indent )\r
				this._.indentation = this._.indentation.substr( this.indentationChars.length );\r
\r
			if ( this._.indent )\r
				this.indentation();\r
			// Do not break if indenting.\r
			else if ( rules && rules.breakBeforeClose ) {\r
				this.lineBreak();\r
				this.indentation();\r
			}\r
\r
			this._.output.push( '</', tagName, '>' );\r
			tagName == 'pre' && ( this._.inPre = 0 );\r
\r
			if ( rules && rules.breakAfterClose ) {\r
				this.lineBreak();\r
				this._.needsSpace = rules.needsSpace;\r
			}\r
\r
			this._.afterCloser = 1;\r
		},\r
\r
		/**\r
		 * Writes text.\r
		 *\r
		 *		// Writes 'Hello Word'.\r
		 *		writer.text( 'Hello Word' );\r
		 *\r
		 * @param {String} text The text value\r
		 */\r
		text: function( text ) {\r
			if ( this._.indent ) {\r
				this.indentation();\r
				!this._.inPre && ( text = CKEDITOR.tools.ltrim( text ) );\r
			}\r
\r
			this._.output.push( text );\r
		},\r
\r
		/**\r
		 * Writes a comment.\r
		 *\r
		 *		// Writes "<!-- My comment -->".\r
		 *		writer.comment( ' My comment ' );\r
		 *\r
		 * @param {String} comment The comment text.\r
		 */\r
		comment: function( comment ) {\r
			if ( this._.indent )\r
				this.indentation();\r
\r
			this._.output.push( '<!--', comment, '-->' );\r
		},\r
\r
		/**\r
		 * Writes a line break. It uses the {@link #lineBreakChars} property for it.\r
		 *\r
		 *		// Writes '\n' (e.g.).\r
		 *		writer.lineBreak();\r
		 */\r
		lineBreak: function() {\r
			if ( !this._.inPre && this._.output.length > 0 )\r
				this._.output.push( this.lineBreakChars );\r
			this._.indent = 1;\r
		},\r
\r
		/**\r
		 * Writes the current indentation character. It uses the {@link #indentationChars}\r
		 * property, repeating it for the current indentation steps.\r
		 *\r
		 *		// Writes '\t' (e.g.).\r
		 *		writer.indentation();\r
		 */\r
		indentation: function() {\r
			if ( !this._.inPre && this._.indentation )\r
				this._.output.push( this._.indentation );\r
			this._.indent = 0;\r
		},\r
\r
		/**\r
		 * Empties the current output buffer. It also brings back the default\r
		 * values of the writer flags.\r
		 *\r
		 *		writer.reset();\r
		 */\r
		reset: function() {\r
			this._.output = [];\r
			this._.indent = 0;\r
			this._.indentation = '';\r
			this._.afterCloser = 0;\r
			this._.inPre = 0;\r
			this._.needsSpace = 0;\r
		},\r
\r
		/**\r
		 * Sets formatting rules for a given element. Possible rules are:\r
		 *\r
		 * * `indent` &ndash; indent the element content.\r
		 * * `breakBeforeOpen` &ndash; break line before the opener tag for this element.\r
		 * * `breakAfterOpen` &ndash; break line after the opener tag for this element.\r
		 * * `breakBeforeClose` &ndash; break line before the closer tag for this element.\r
		 * * `breakAfterClose` &ndash; break line after the closer tag for this element.\r
		 *\r
		 * All rules default to `false`. Each function call overrides rules that are\r
		 * already present, leaving the undefined ones untouched.\r
		 *\r
		 * By default, all elements available in the {@link CKEDITOR.dtd#$block},\r
		 * {@link CKEDITOR.dtd#$listItem}, and {@link CKEDITOR.dtd#$tableContent}\r
		 * lists have all the above rules set to `true`. Additionaly, the `<br>`\r
		 * element has the `breakAfterOpen` rule set to `true`.\r
		 *\r
		 *		// Break line before and after "img" tags.\r
		 *		writer.setRules( 'img', {\r
		 *			breakBeforeOpen: true\r
		 *			breakAfterOpen: true\r
		 *		} );\r
		 *\r
		 *		// Reset the rules for the "h1" tag.\r
		 *		writer.setRules( 'h1', {} );\r
		 *\r
		 * @param {String} tagName The name of the element for which the rules are set.\r
		 * @param {Object} rules An object containing the element rules.\r
		 */\r
		setRules: function( tagName, rules ) {\r
			var currentRules = this._.rules[ tagName ];\r
\r
			if ( currentRules )\r
				CKEDITOR.tools.extend( currentRules, rules, true );\r
			else\r
				this._.rules[ tagName ] = rules;\r
		}\r
	}\r
} );\r
\r
/**\r
 * Whether to force using `'&'` instead of `'&amp;'` in element attributes\r
 * values. It is not recommended to change this setting for compliance with the\r
 * W3C XHTML 1.0 standards ([C.12, XHTML 1.0](http://www.w3.org/TR/xhtml1/#C_12)).\r
 *\r
 *		// Use `'&'` instead of `'&amp;'`\r
 *		CKEDITOR.config.forceSimpleAmpersand = true;\r
 *\r
 * @cfg {Boolean} [forceSimpleAmpersand=false]\r
 * @member CKEDITOR.config\r
 */\r
\r
/**\r
 * The characters to be used for indenting HTML output produced by the editor.\r
 * Using characters different from `' '` (space) and `'\t'` (tab) is not recommended\r
 * as it will mess the code.\r
 *\r
 *		// No indentation.\r
 *		CKEDITOR.config.dataIndentationChars = '';\r
 *\r
 *		// Use two spaces for indentation.\r
 *		CKEDITOR.config.dataIndentationChars = '  ';\r
 *\r
 * @cfg {String} [dataIndentationChars='\t']\r
 * @member CKEDITOR.config\r
 */\r