123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617 |
- /*jshint curly:true, eqeqeq:true, laxbreak:true, noempty:false */
- /*
- The MIT License (MIT)
- Copyright (c) 2007-2013 Einar Lielmanis and contributors.
- Permission is hereby granted, free of charge, to any person
- obtaining a copy of this software and associated documentation files
- (the "Software"), to deal in the Software without restriction,
- including without limitation the rights to use, copy, modify, merge,
- publish, distribute, sublicense, and/or sell copies of the Software,
- and to permit persons to whom the Software is furnished to do so,
- subject to the following conditions:
- The above copyright notice and this permission notice shall be
- included in all copies or substantial portions of the Software.
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
- EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
- MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
- NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
- BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
- ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
- CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- SOFTWARE.
- Style HTML
- ---------------
- Written by Nochum Sossonko, (nsossonko@hotmail.com)
- Based on code initially developed by: Einar Lielmanis, <elfz@laacz.lv>
- http://jsbeautifier.org/
- Usage:
- style_html(html_source);
- style_html(html_source, options);
- The options are:
- indent_size (default 4) — indentation size,
- indent_char (default space) — character to indent with,
- max_char (default 250) - maximum amount of characters per line (0 = disable)
- brace_style (default "collapse") - "collapse" | "expand" | "end-expand"
- put braces on the same line as control statements (default), or put braces on own line (Allman / ANSI style), or just put end braces on own line.
- unformatted (defaults to inline tags) - list of tags, that shouldn't be reformatted
- indent_scripts (default normal) - "keep"|"separate"|"normal"
- e.g.
- style_html(html_source, {
- 'indent_size': 2,
- 'indent_char': ' ',
- 'max_char': 78,
- 'brace_style': 'expand',
- 'unformatted': ['a', 'sub', 'sup', 'b', 'i', 'u']
- });
- */
- (function() {
- function style_html(html_source, options, js_beautify, css_beautify) {
- //Wrapper function to invoke all the necessary constructors and deal with the output.
- var multi_parser,
- indent_size,
- indent_character,
- max_char,
- brace_style,
- unformatted;
- options = options || {};
- indent_size = options.indent_size || 4;
- indent_character = options.indent_char || ' ';
- brace_style = options.brace_style || 'collapse';
- max_char = options.max_char === 0 ? Infinity : options.max_char || 250;
- unformatted = options.unformatted || ['a', 'span', 'bdo', 'em', 'strong', 'dfn', 'code', 'samp', 'kbd', 'var', 'cite', 'abbr', 'acronym', 'q', 'sub', 'sup', 'tt', 'i', 'b', 'big', 'small', 'u', 's', 'strike', 'font', 'ins', 'del', 'pre', 'address', 'dt', 'h1', 'h2', 'h3', 'h4', 'h5', 'h6'];
- function Parser() {
- this.pos = 0; //Parser position
- this.token = '';
- this.current_mode = 'CONTENT'; //reflects the current Parser mode: TAG/CONTENT
- this.tags = { //An object to hold tags, their position, and their parent-tags, initiated with default values
- parent: 'parent1',
- parentcount: 1,
- parent1: ''
- };
- this.tag_type = '';
- this.token_text = this.last_token = this.last_text = this.token_type = '';
- this.Utils = { //Uilities made available to the various functions
- whitespace: "\n\r\t ".split(''),
- single_token: 'br,input,link,meta,!doctype,basefont,base,area,hr,wbr,param,img,isindex,?xml,embed,?php,?,?='.split(','), //all the single tags for HTML
- extra_liners: 'head,body,/html'.split(','), //for tags that need a line of whitespace before them
- in_array: function (what, arr) {
- for (var i=0; i<arr.length; i++) {
- if (what === arr[i]) {
- return true;
- }
- }
- return false;
- }
- };
- this.get_content = function () { //function to capture regular content between tags
- var input_char = '',
- content = [],
- space = false; //if a space is needed
- while (this.input.charAt(this.pos) !== '<') {
- if (this.pos >= this.input.length) {
- return content.length?content.join(''):['', 'TK_EOF'];
- }
- input_char = this.input.charAt(this.pos);
- this.pos++;
- this.line_char_count++;
- if (this.Utils.in_array(input_char, this.Utils.whitespace)) {
- if (content.length) {
- space = true;
- }
- this.line_char_count--;
- continue; //don't want to insert unnecessary space
- }
- else if (space) {
- if (this.line_char_count >= this.max_char) { //insert a line when the max_char is reached
- content.push('\n');
- for (var i=0; i<this.indent_level; i++) {
- content.push(this.indent_string);
- }
- this.line_char_count = 0;
- }
- else{
- content.push(' ');
- this.line_char_count++;
- }
- space = false;
- }
- content.push(input_char); //letter at-a-time (or string) inserted to an array
- }
- return content.length?content.join(''):'';
- };
- this.get_contents_to = function (name) { //get the full content of a script or style to pass to js_beautify
- if (this.pos === this.input.length) {
- return ['', 'TK_EOF'];
- }
- var input_char = '';
- var content = '';
- var reg_match = new RegExp('</' + name + '\\s*>', 'igm');
- reg_match.lastIndex = this.pos;
- var reg_array = reg_match.exec(this.input);
- var end_script = reg_array?reg_array.index:this.input.length; //absolute end of script
- if(this.pos < end_script) { //get everything in between the script tags
- content = this.input.substring(this.pos, end_script);
- this.pos = end_script;
- }
- return content;
- };
- this.record_tag = function (tag){ //function to record a tag and its parent in this.tags Object
- if (this.tags[tag + 'count']) { //check for the existence of this tag type
- this.tags[tag + 'count']++;
- this.tags[tag + this.tags[tag + 'count']] = this.indent_level; //and record the present indent level
- }
- else { //otherwise initialize this tag type
- this.tags[tag + 'count'] = 1;
- this.tags[tag + this.tags[tag + 'count']] = this.indent_level; //and record the present indent level
- }
- this.tags[tag + this.tags[tag + 'count'] + 'parent'] = this.tags.parent; //set the parent (i.e. in the case of a div this.tags.div1parent)
- this.tags.parent = tag + this.tags[tag + 'count']; //and make this the current parent (i.e. in the case of a div 'div1')
- };
- this.retrieve_tag = function (tag) { //function to retrieve the opening tag to the corresponding closer
- if (this.tags[tag + 'count']) { //if the openener is not in the Object we ignore it
- var temp_parent = this.tags.parent; //check to see if it's a closable tag.
- while (temp_parent) { //till we reach '' (the initial value);
- if (tag + this.tags[tag + 'count'] === temp_parent) { //if this is it use it
- break;
- }
- temp_parent = this.tags[temp_parent + 'parent']; //otherwise keep on climbing up the DOM Tree
- }
- if (temp_parent) { //if we caught something
- this.indent_level = this.tags[tag + this.tags[tag + 'count']]; //set the indent_level accordingly
- this.tags.parent = this.tags[temp_parent + 'parent']; //and set the current parent
- }
- delete this.tags[tag + this.tags[tag + 'count'] + 'parent']; //delete the closed tags parent reference...
- delete this.tags[tag + this.tags[tag + 'count']]; //...and the tag itself
- if (this.tags[tag + 'count'] === 1) {
- delete this.tags[tag + 'count'];
- }
- else {
- this.tags[tag + 'count']--;
- }
- }
- };
- this.get_tag = function (peek) { //function to get a full tag and parse its type
- var input_char = '',
- content = [],
- comment = '',
- space = false,
- tag_start, tag_end,
- orig_pos = this.pos,
- orig_line_char_count = this.line_char_count;
- peek = peek !== undefined ? peek : false;
- do {
- if (this.pos >= this.input.length) {
- if (peek) {
- this.pos = orig_pos;
- this.line_char_count = orig_line_char_count;
- }
- return content.length?content.join(''):['', 'TK_EOF'];
- }
- input_char = this.input.charAt(this.pos);
- this.pos++;
- this.line_char_count++;
- if (this.Utils.in_array(input_char, this.Utils.whitespace)) { //don't want to insert unnecessary space
- space = true;
- this.line_char_count--;
- continue;
- }
- if (input_char === "'" || input_char === '"') {
- if (!content[1] || content[1] !== '!') { //if we're in a comment strings don't get treated specially
- input_char += this.get_unformatted(input_char);
- space = true;
- }
- }
- if (input_char === '=') { //no space before =
- space = false;
- }
- if (content.length && content[content.length-1] !== '=' && input_char !== '>' && space) {
- //no space after = or before >
- if (this.line_char_count >= this.max_char) {
- this.print_newline(false, content);
- this.line_char_count = 0;
- }
- else {
- content.push(' ');
- this.line_char_count++;
- }
- space = false;
- }
- if (input_char === '<') {
- tag_start = this.pos - 1;
- }
- content.push(input_char); //inserts character at-a-time (or string)
- } while (input_char !== '>');
- var tag_complete = content.join('');
- var tag_index;
- if (tag_complete.indexOf(' ') !== -1) { //if there's whitespace, thats where the tag name ends
- tag_index = tag_complete.indexOf(' ');
- }
- else { //otherwise go with the tag ending
- tag_index = tag_complete.indexOf('>');
- }
- var tag_check = tag_complete.substring(1, tag_index).toLowerCase();
- if (tag_complete.charAt(tag_complete.length-2) === '/' ||
- this.Utils.in_array(tag_check, this.Utils.single_token)) { //if this tag name is a single tag type (either in the list or has a closing /)
- if ( ! peek) {
- this.tag_type = 'SINGLE';
- }
- }
- else if (tag_check === 'script') { //for later script handling
- if ( ! peek) {
- this.record_tag(tag_check);
- this.tag_type = 'SCRIPT';
- }
- }
- else if (tag_check === 'style') { //for future style handling (for now it justs uses get_content)
- if ( ! peek) {
- this.record_tag(tag_check);
- this.tag_type = 'STYLE';
- }
- }
- else if (this.is_unformatted(tag_check, unformatted)) { // do not reformat the "unformatted" tags
- comment = this.get_unformatted('</'+tag_check+'>', tag_complete); //...delegate to get_unformatted function
- content.push(comment);
- // Preserve collapsed whitespace either before or after this tag.
- if (tag_start > 0 && this.Utils.in_array(this.input.charAt(tag_start - 1), this.Utils.whitespace)){
- content.splice(0, 0, this.input.charAt(tag_start - 1));
- }
- tag_end = this.pos - 1;
- if (this.Utils.in_array(this.input.charAt(tag_end + 1), this.Utils.whitespace)){
- content.push(this.input.charAt(tag_end + 1));
- }
- this.tag_type = 'SINGLE';
- }
- else if (tag_check.charAt(0) === '!') { //peek for <!-- comment
- if (tag_check.indexOf('[if') !== -1) { //peek for <!--[if conditional comment
- if (tag_complete.indexOf('!IE') !== -1) { //this type needs a closing --> so...
- comment = this.get_unformatted('-->', tag_complete); //...delegate to get_unformatted
- content.push(comment);
- }
- if ( ! peek) {
- this.tag_type = 'START';
- }
- }
- else if (tag_check.indexOf('[endif') !== -1) {//peek for <!--[endif end conditional comment
- this.tag_type = 'END';
- this.unindent();
- }
- else if (tag_check.indexOf('[cdata[') !== -1) { //if it's a <[cdata[ comment...
- comment = this.get_unformatted(']]>', tag_complete); //...delegate to get_unformatted function
- content.push(comment);
- if ( ! peek) {
- this.tag_type = 'SINGLE'; //<![CDATA[ comments are treated like single tags
- }
- }
- else {
- comment = this.get_unformatted('-->', tag_complete);
- content.push(comment);
- this.tag_type = 'SINGLE';
- }
- }
- else if ( ! peek) {
- if (tag_check.charAt(0) === '/') { //this tag is a double tag so check for tag-ending
- this.retrieve_tag(tag_check.substring(1)); //remove it and all ancestors
- this.tag_type = 'END';
- }
- else { //otherwise it's a start-tag
- this.record_tag(tag_check); //push it on the tag stack
- this.tag_type = 'START';
- }
- if (this.Utils.in_array(tag_check, this.Utils.extra_liners)) { //check if this double needs an extra line
- this.print_newline(true, this.output);
- }
- }
- if (peek) {
- this.pos = orig_pos;
- this.line_char_count = orig_line_char_count;
- }
- return content.join(''); //returns fully formatted tag
- };
- this.get_unformatted = function (delimiter, orig_tag) { //function to return unformatted content in its entirety
- if (orig_tag && orig_tag.toLowerCase().indexOf(delimiter) !== -1) {
- return '';
- }
- var input_char = '';
- var content = '';
- var space = true;
- do {
- if (this.pos >= this.input.length) {
- return content;
- }
- input_char = this.input.charAt(this.pos);
- this.pos++;
- if (this.Utils.in_array(input_char, this.Utils.whitespace)) {
- if (!space) {
- this.line_char_count--;
- continue;
- }
- if (input_char === '\n' || input_char === '\r') {
- content += '\n';
- /* Don't change tab indention for unformatted blocks. If using code for html editing, this will greatly affect <pre> tags if they are specified in the 'unformatted array'
- for (var i=0; i<this.indent_level; i++) {
- content += this.indent_string;
- }
- space = false; //...and make sure other indentation is erased
- */
- this.line_char_count = 0;
- continue;
- }
- }
- content += input_char;
- this.line_char_count++;
- space = true;
- } while (content.toLowerCase().indexOf(delimiter) === -1);
- return content;
- };
- this.get_token = function () { //initial handler for token-retrieval
- var token;
- if (this.last_token === 'TK_TAG_SCRIPT' || this.last_token === 'TK_TAG_STYLE') { //check if we need to format javascript
- var type = this.last_token.substr(7);
- token = this.get_contents_to(type);
- if (typeof token !== 'string') {
- return token;
- }
- return [token, 'TK_' + type];
- }
- if (this.current_mode === 'CONTENT') {
- token = this.get_content();
- if (typeof token !== 'string') {
- return token;
- }
- else {
- return [token, 'TK_CONTENT'];
- }
- }
- if (this.current_mode === 'TAG') {
- token = this.get_tag();
- if (typeof token !== 'string') {
- return token;
- }
- else {
- var tag_name_type = 'TK_TAG_' + this.tag_type;
- return [token, tag_name_type];
- }
- }
- };
- this.get_full_indent = function (level) {
- level = this.indent_level + level || 0;
- if (level < 1) {
- return '';
- }
- return Array(level + 1).join(this.indent_string);
- };
- this.is_unformatted = function(tag_check, unformatted) {
- //is this an HTML5 block-level link?
- if (!this.Utils.in_array(tag_check, unformatted)){
- return false;
- }
- if (tag_check.toLowerCase() !== 'a' || !this.Utils.in_array('a', unformatted)){
- return true;
- }
- //at this point we have an tag; is its first child something we want to remain
- //unformatted?
- var next_tag = this.get_tag(true /* peek. */);
- // tets next_tag to see if it is just html tag (no external content)
- var tag = (next_tag || "").match(/^\s*<\s*\/?([a-z]*)\s*[^>]*>\s*$/);
- // if next_tag comes back but is not an isolated tag, then
- // let's treat the 'a' tag as having content
- // and respect the unformatted option
- if (!tag || this.Utils.in_array(tag, unformatted)){
- return true;
- } else {
- return false;
- }
- };
- this.printer = function (js_source, indent_character, indent_size, max_char, brace_style) { //handles input/output and some other printing functions
- this.input = js_source || ''; //gets the input for the Parser
- this.output = [];
- this.indent_character = indent_character;
- this.indent_string = '';
- this.indent_size = indent_size;
- this.brace_style = brace_style;
- this.indent_level = 0;
- this.max_char = max_char;
- this.line_char_count = 0; //count to see if max_char was exceeded
- for (var i=0; i<this.indent_size; i++) {
- this.indent_string += this.indent_character;
- }
- this.print_newline = function (ignore, arr) {
- this.line_char_count = 0;
- if (!arr || !arr.length) {
- return;
- }
- if (!ignore) { //we might want the extra line
- while (this.Utils.in_array(arr[arr.length-1], this.Utils.whitespace)) {
- arr.pop();
- }
- }
- arr.push('\n');
- for (var i=0; i<this.indent_level; i++) {
- arr.push(this.indent_string);
- }
- };
- this.print_token = function (text) {
- this.output.push(text);
- };
- this.indent = function () {
- this.indent_level++;
- };
- this.unindent = function () {
- if (this.indent_level > 0) {
- this.indent_level--;
- }
- };
- };
- return this;
- }
- /*_____________________--------------------_____________________*/
- multi_parser = new Parser(); //wrapping functions Parser
- multi_parser.printer(html_source, indent_character, indent_size, max_char, brace_style); //initialize starting values
- while (true) {
- var t = multi_parser.get_token();
- multi_parser.token_text = t[0];
- multi_parser.token_type = t[1];
- if (multi_parser.token_type === 'TK_EOF') {
- break;
- }
- switch (multi_parser.token_type) {
- case 'TK_TAG_START':
- multi_parser.print_newline(false, multi_parser.output);
- multi_parser.print_token(multi_parser.token_text);
- multi_parser.indent();
- multi_parser.current_mode = 'CONTENT';
- break;
- case 'TK_TAG_STYLE':
- case 'TK_TAG_SCRIPT':
- multi_parser.print_newline(false, multi_parser.output);
- multi_parser.print_token(multi_parser.token_text);
- multi_parser.current_mode = 'CONTENT';
- break;
- case 'TK_TAG_END':
- //Print new line only if the tag has no content and has child
- if (multi_parser.last_token === 'TK_CONTENT' && multi_parser.last_text === '') {
- var tag_name = multi_parser.token_text.match(/\w+/)[0];
- var tag_extracted_from_last_output = multi_parser.output[multi_parser.output.length -1].match(/<\s*(\w+)/);
- if (tag_extracted_from_last_output === null || tag_extracted_from_last_output[1] !== tag_name) {
- multi_parser.print_newline(true, multi_parser.output);
- }
- }
- multi_parser.print_token(multi_parser.token_text);
- multi_parser.current_mode = 'CONTENT';
- break;
- case 'TK_TAG_SINGLE':
- // Don't add a newline before elements that should remain unformatted.
- var tag_check = multi_parser.token_text.match(/^\s*<([a-z]+)/i);
- if (!tag_check || !multi_parser.Utils.in_array(tag_check[1], unformatted)){
- multi_parser.print_newline(false, multi_parser.output);
- }
- multi_parser.print_token(multi_parser.token_text);
- multi_parser.current_mode = 'CONTENT';
- break;
- case 'TK_CONTENT':
- if (multi_parser.token_text !== '') {
- multi_parser.print_token(multi_parser.token_text);
- }
- multi_parser.current_mode = 'TAG';
- break;
- case 'TK_STYLE':
- case 'TK_SCRIPT':
- if (multi_parser.token_text !== '') {
- multi_parser.output.push('\n');
- var text = multi_parser.token_text,
- _beautifier,
- script_indent_level = 1;
- if (multi_parser.token_type === 'TK_SCRIPT') {
- _beautifier = typeof js_beautify === 'function' && js_beautify;
- } else if (multi_parser.token_type === 'TK_STYLE') {
- _beautifier = typeof css_beautify === 'function' && css_beautify;
- }
- if (options.indent_scripts === "keep") {
- script_indent_level = 0;
- } else if (options.indent_scripts === "separate") {
- script_indent_level = -multi_parser.indent_level;
- }
- var indentation = multi_parser.get_full_indent(script_indent_level);
- if (_beautifier) {
- // call the Beautifier if avaliable
- text = _beautifier(text.replace(/^\s*/, indentation), options);
- } else {
- // simply indent the string otherwise
- var white = text.match(/^\s*/)[0];
- var _level = white.match(/[^\n\r]*$/)[0].split(multi_parser.indent_string).length - 1;
- var reindent = multi_parser.get_full_indent(script_indent_level -_level);
- text = text.replace(/^\s*/, indentation)
- .replace(/\r\n|\r|\n/g, '\n' + reindent)
- .replace(/\s*$/, '');
- }
- if (text) {
- multi_parser.print_token(text);
- multi_parser.print_newline(true, multi_parser.output);
- }
- }
- multi_parser.current_mode = 'TAG';
- break;
- }
- multi_parser.last_token = multi_parser.token_type;
- multi_parser.last_text = multi_parser.token_text;
- }
- return multi_parser.output.join('');
- }
- // If we're running a web page and don't have either of the above, add our one global
- window.html_beautify = function(html_source, options) {
- return style_html(html_source, options, window.js_beautify, window.css_beautify);
- };
- }());
|