2
* Code Syntax Highlighter.
4
* Copyright (C) 2004 Alex Gorbatchev.
5
* http://www.dreamprojections.com/syntaxhighlighter/
7
* This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General
8
* Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option)
11
* This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied
12
* warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
15
* You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to
16
* the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
25
Utils : {}, // dp.sh.Utils
26
Brushes : {}, // dp.sh.Brushes
33
AboutDialog : '<html><head><title>About...</title></head><body class="dp-about"><table cellspacing="0"><tr><td class="copy"><p class="title">dp.SyntaxHighlighter</div><div class="para">Version: {V}</p><p><a href="http://www.dreamprojections.com/syntaxhighlighter/?ref=about" target="_blank">http://www.dreamprojections.com/SyntaxHighlighter</a></p>©2004-2005 Alex Gorbatchev. All right reserved.</td></tr><tr><td class="footer"><input type="button" class="close" value="OK" onClick="window.close()"/></td></tr></table></body></html>',
36
ExpandCode : '+ expand code',
37
ViewPlain : 'view plain',
39
CopyToClipboard : 'copy to clipboard',
42
CopiedToClipboard : 'The code is in your clipboard now.'
45
dp.SyntaxHighlighter = dp.sh;
48
// Dialog and toolbar functions
51
dp.sh.Utils.Expand = function(sender)
56
// find the span in which the text label and pipe contained so we can hide it
57
while(span != null && span.tagName.toUpperCase() != 'SPAN')
58
span = span.parentNode;
61
while(table != null && table.tagName.toUpperCase() != 'TABLE')
62
table = table.parentNode;
64
// remove the 'expand code' button
65
span.parentNode.removeChild(span);
67
table.tBodies[0].className = 'show';
68
table.parentNode.style.height = '100%'; // containing div isn't getting updated properly when the TBODY is shown
71
// opens a new windows and puts the original unformatted source code inside.
72
dp.sh.Utils.ViewSource = function(sender)
74
var code = sender.parentNode.originalCode;
75
var wnd = window.open('', '_blank', 'width=750, height=400, location=0, resizable=1, menubar=0, scrollbars=1');
77
code = code.replace(/</g, '<');
79
wnd.document.write('<pre>' + code + '</pre>');
83
// copies the original source code in to the clipboard (IE only)
84
dp.sh.Utils.ToClipboard = function(sender)
86
var code = sender.parentNode.originalCode;
88
// This works only for IE. There's a way to make it work with Mozilla as well,
89
// but it requires security settings changed on the client, which isn't by
90
// default, so 99% of users won't have it working anyways.
91
if(window.clipboardData)
93
window.clipboardData.setData('text', code);
95
alert(dp.sh.Strings.CopiedToClipboard);
99
// creates an invisible iframe, puts the original source code inside and prints it
100
dp.sh.Utils.PrintSource = function(sender)
102
var td = sender.parentNode;
103
var code = td.processedCode;
104
var iframe = document.createElement('IFRAME');
108
// this hides the iframe
109
iframe.style.cssText = 'position:absolute; width:0px; height:0px; left:-5px; top:-5px;';
111
td.appendChild(iframe);
113
doc = iframe.contentWindow.document;
114
code = code.replace(/</g, '<');
117
doc.write('<pre>' + code + '</pre>');
120
iframe.contentWindow.focus();
121
iframe.contentWindow.print();
123
td.removeChild(iframe);
126
dp.sh.Utils.About = function()
128
var wnd = window.open('', '_blank', 'dialog,width=320,height=150,scrollbars=0');
129
var doc = wnd.document;
131
var styles = document.getElementsByTagName('style');
132
var links = document.getElementsByTagName('link');
134
doc.write(dp.sh.Strings.AboutDialog.replace('{V}', dp.sh.Version));
136
// copy over ALL the styles from the parent page
137
for(var i = 0; i < styles.length; i++)
138
doc.write('<style>' + styles[i].innerHTML + '</style>');
140
for(var i = 0; i < links.length; i++)
141
if(links[i].rel.toLowerCase() == 'stylesheet')
142
doc.write('<link type="text/css" rel="stylesheet" href="' + links[i].href + '"></link>');
151
dp.sh.Match = function(value, index, css)
155
this.length = value.length;
160
// Highlighter object
162
dp.sh.Highlighter = function()
164
this.addGutter = true;
165
this.addControls = true;
166
this.collapse = false;
167
this.tabsToSpaces = true;
170
// static callback for the match sorting
171
dp.sh.Highlighter.SortCallback = function(m1, m2)
173
// sort matches by index first
174
if(m1.index < m2.index)
176
else if(m1.index > m2.index)
180
// if index is the same, sort by length
181
if(m1.length < m2.length)
183
else if(m1.length > m2.length)
189
// gets a list of all matches for a given regular expression
190
dp.sh.Highlighter.prototype.GetMatches = function(regex, css)
195
while((match = regex.exec(this.code)) != null)
197
this.matches[this.matches.length] = new dp.sh.Match(match[0], match.index, css);
201
dp.sh.Highlighter.prototype.AddBit = function(str, css)
203
var span = document.createElement('span');
205
str = str.replace(/&/g, '&');
206
str = str.replace(/ /g, ' ');
207
str = str.replace(/</g, '<');
208
str = str.replace(/\n/gm, ' <br>');
210
// when adding a piece of code, check to see if it has line breaks in it
211
// and if it does, wrap individual line breaks with span tags
214
var regex = new RegExp('<br>', 'gi');
218
var lines = str.split(' <br>');
222
for(var i = 0; i < lines.length; i++)
224
span = document.createElement('SPAN');
225
span.className = css;
226
span.innerHTML = lines[i];
228
this.div.appendChild(span);
230
// don't add a <BR> for the last line
231
if(i + 1 < lines.length)
232
this.div.appendChild(document.createElement('BR'));
237
span.className = css;
238
span.innerHTML = str;
239
this.div.appendChild(span);
244
span.innerHTML = str;
245
this.div.appendChild(span);
249
// checks if one match is inside any other match
250
dp.sh.Highlighter.prototype.IsInside = function(match)
252
if(match == null || match.length == 0)
255
for(var i = 0; i < this.matches.length; i++)
257
var c = this.matches[i];
262
if((match.index > c.index) && (match.index <= c.index + c.length))
269
dp.sh.Highlighter.prototype.ProcessRegexList = function()
271
for(var i = 0; i < this.regexList.length; i++)
272
this.GetMatches(this.regexList[i].regex, this.regexList[i].css);
275
dp.sh.Highlighter.prototype.ProcessSmartTabs = function(code)
277
var lines = code.split('\n');
282
// This function inserts specified amount of spaces in the string
283
// where a tab is while removing that given tab.
284
function InsertSpaces(line, pos, count)
286
var left = line.substr(0, pos);
287
var right = line.substr(pos + 1, line.length); // pos + 1 will get rid of the tab
290
for(var i = 0; i < count; i++)
293
return left + spaces + right;
296
// This function process one line for 'smart tabs'
297
function ProcessLine(line, tabSize)
299
if(line.indexOf(tab) == -1)
304
while((pos = line.indexOf(tab)) != -1)
306
// This is pretty much all there is to the 'smart tabs' logic.
307
// Based on the position within the line and size of a tab,
308
// calculate the amount of spaces we need to insert.
309
var spaces = tabSize - pos % tabSize;
311
line = InsertSpaces(line, pos, spaces);
317
// Go through all the lines and do the 'smart tabs' magic.
318
for(var i = 0; i < lines.length; i++)
319
result += ProcessLine(lines[i], tabSize) + '\n';
324
dp.sh.Highlighter.prototype.SwitchToTable = function()
326
// thanks to Lachlan Donald from SitePoint.com for this <br/> tag fix.
327
var html = this.div.innerHTML.replace(/<(br)\/?>/gi, '\n');
328
var lines = html.split('\n');
335
// creates an anchor to a utility
336
function UtilHref(util, text)
338
return '<a href="#" onclick="dp.sh.Utils.' + util + '(this); return false;">' + text + '</a>';
341
tBody = document.createElement('TBODY'); // can be created and all others go to tBodies collection.
343
this.table.appendChild(tBody);
345
if(this.addGutter == true)
347
row = tBody.insertRow(-1);
348
cell = row.insertCell(-1);
349
cell.className = 'tools-corner';
352
if(this.addControls == true)
354
var tHead = document.createElement('THEAD'); // controls will be placed in here
355
this.table.appendChild(tHead);
357
row = tHead.insertRow(-1);
359
// add corner if there's a gutter
360
if(this.addGutter == true)
362
cell = row.insertCell(-1);
363
cell.className = 'tools-corner';
366
cell = row.insertCell(-1);
368
// preserve some variables for the controls
369
cell.originalCode = this.originalCode;
370
cell.processedCode = this.code;
371
cell.className = 'tools';
373
if(this.collapse == true)
375
tBody.className = 'hide';
376
cell.innerHTML += '<span><b>' + UtilHref('Expand', dp.sh.Strings.ExpandCode) + '</b>' + pipe + '</span>';
379
cell.innerHTML += UtilHref('ViewSource', dp.sh.Strings.ViewPlain) + pipe + UtilHref('PrintSource', dp.sh.Strings.Print);
381
// IE has this clipboard object which is easy enough to use
382
if(window.clipboardData)
383
cell.innerHTML += pipe + UtilHref('ToClipboard', dp.sh.Strings.CopyToClipboard);
385
cell.innerHTML += pipe + UtilHref('About', dp.sh.Strings.About);
388
for(var i = 0, lineIndex = this.firstLine; i < lines.length - 1; i++, lineIndex++)
390
row = tBody.insertRow(-1);
392
if(this.addGutter == true)
394
cell = row.insertCell(-1);
395
cell.className = 'gutter';
396
cell.innerHTML = lineIndex;
399
cell = row.insertCell(-1);
400
cell.className = 'line' + (i % 2 + 1); // uses .line1 and .line2 css styles for alternating lines
401
cell.innerHTML = lines[i];
404
this.div.innerHTML = '';
407
dp.sh.Highlighter.prototype.Highlight = function(code)
411
return str.replace(/^\s*(.*?)[\s\n]*$/g, '$1');
416
return str.replace(/\n*$/, '').replace(/^\n*/, '');
419
function Unindent(str)
421
var lines = str.split('\n');
422
var indents = new Array();
423
var regex = new RegExp('^\\s*', 'g');
426
// go through every line and check for common number of indents
427
for(var i = 0; i < lines.length && min > 0; i++)
429
if(Trim(lines[i]).length == 0)
432
var matches = regex.exec(lines[i]);
434
if(matches != null && matches.length > 0)
435
min = Math.min(matches[0].length, min);
438
// trim minimum common number of white space from the begining of every line
440
for(var i = 0; i < lines.length; i++)
441
lines[i] = lines[i].substr(min);
443
return lines.join('\n');
446
// This function returns a portions of the string from pos1 to pos2 inclusive
447
function Copy(string, pos1, pos2)
449
return string.substr(pos1, pos2 - pos1);
454
this.originalCode = code;
455
this.code = Chop(Unindent(code));
456
this.div = document.createElement('DIV');
457
this.table = document.createElement('TABLE');
458
this.matches = new Array();
460
if(this.CssClass != null)
461
this.table.className = this.CssClass;
463
// replace tabs with spaces
464
if(this.tabsToSpaces == true)
465
this.code = this.ProcessSmartTabs(this.code);
467
this.table.border = 0;
468
this.table.cellSpacing = 0;
469
this.table.cellPadding = 0;
471
this.ProcessRegexList();
473
// if no matches found, add entire code as plain text
474
if(this.matches.length == 0)
476
this.AddBit(this.code, null);
477
this.SwitchToTable();
482
this.matches = this.matches.sort(dp.sh.Highlighter.SortCallback);
484
// The following loop checks to see if any of the matches are inside
485
// of other matches. This process would get rid of highligting strings
486
// inside comments, keywords inside strings and so on.
487
for(var i = 0; i < this.matches.length; i++)
488
if(this.IsInside(this.matches[i]))
489
this.matches[i] = null;
491
// Finally, go through the final list of matches and pull the all
492
// together adding everything in between that isn't a match.
493
for(var i = 0; i < this.matches.length; i++)
495
var match = this.matches[i];
497
if(match == null || match.length == 0)
500
this.AddBit(Copy(this.code, pos, match.index), null);
501
this.AddBit(match.value, match.css);
503
pos = match.index + match.length;
506
this.AddBit(this.code.substr(pos), null);
508
this.SwitchToTable();
511
dp.sh.Highlighter.prototype.GetKeywords = function(str)
513
return '\\b' + str.replace(/ /g, '\\b|\\b') + '\\b';
516
// highlightes all elements identified by name and gets source code from specified property
517
dp.sh.HighlightAll = function(name, showGutter /* optional */, showControls /* optional */, collapseAll /* optional */, firstLine /* optional */)
523
for(var i = 0; i < a.length; i++)
528
if(typeof(a[i]) == 'string' && a[i] != '')
531
if(typeof(a[i]) == 'object' && a[i].value != '')
532
return a[i].value + '';
538
function IsOptionSet(value, list)
540
for(var i = 0; i < list.length; i++)
547
function GetOptionValue(name, list, defaultValue)
549
var regex = new RegExp('^' + name + '\\[(\\w+)\\]$', 'gi');
552
for(var i = 0; i < list.length; i++)
553
if((matches = regex.exec(list[i])) != null)
559
var elements = document.getElementsByName(name);
560
var highlighter = null;
561
var registered = new Object();
562
var propertyName = 'value';
564
// if no code blocks found, leave
568
// register all brushes
569
for(var brush in dp.sh.Brushes)
571
var aliases = dp.sh.Brushes[brush].Aliases;
576
for(var i = 0; i < aliases.length; i++)
577
registered[aliases[i]] = brush;
580
for(var i = 0; i < elements.length; i++)
582
var element = elements[i];
583
var options = FindValue(
584
element.attributes['class'], element.className,
585
element.attributes['language'], element.language
592
options = options.split(':');
594
language = options[0].toLowerCase();
596
if(registered[language] == null)
599
// instantiate a brush
600
highlighter = new dp.sh.Brushes[registered[language]]();
602
// hide the original element
603
element.style.display = 'none';
605
highlighter.addGutter = (showGutter == null) ? !IsOptionSet('nogutter', options) : showGutter;
606
highlighter.addControls = (showControls == null) ? !IsOptionSet('nocontrols', options) : showControls;
607
highlighter.collapse = (collapseAll == null) ? IsOptionSet('collapse', options) : collapseAll;
609
// first line idea comes from Andrew Collington, thanks!
610
highlighter.firstLine = (firstLine == null) ? parseInt(GetOptionValue('firstline', options, 1)) : firstLine;
612
highlighter.Highlight(element[propertyName]);
614
// place the result table inside a div
615
var div = document.createElement('DIV');
617
div.className = 'dp-highlighter';
618
div.appendChild(highlighter.table);
620
element.parentNode.insertBefore(div, element);