added a language handler for lispy languages

Author: mikesamuel

README.html

@@ -67,9 +67,17 @@ <h3>Which languages does it work for?</h3>
     should work on a number of languages including C and friends,
     Java, Python, Bash, SQL, HTML, XML, CSS, Javascript, and Makefiles.
     It works passably on Ruby, PHP and Awk and a decent subset of Perl, but,
-    because of commenting conventions, doesn't work on Smalltalk, Lisp-like, or
+    because of commenting conventions, doesn't work on Smalltalk, or
     CAML-like languages.</p>
 
+    <p>LISPy languages are supported via an extension:
+    <a href="http://code.google.com/p/google-code-prettify/source/browse/trunk/src/lang-lisp.js"
+     ><code>lang-lisp.js</code></a>.</p>
+
+    <p>If you'd like to add an extension for your favorite language, please
+    look at lang-lisp.js and file an <a href="http://code.google.com/p/google-code-prettify/issues/list">issue</a> including your language extension,
+    and a testcase.</p>
+
     <h3>How do I specify which language my code is in?</h3>
     <p>You don't need to specify the language since <code>prettyprint()</code>
     will guess.  You can specify a language by specifying the language extension

src/lang-lisp.js

@@ -0,0 +1,93 @@
+// Copyright (C) 2008 Google Inc.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+
+
+/**
+ * @fileoverview
+ * Registers a language handler for Common Lisp and related languages.
+ *
+ *
+ * To use, include prettify.js and this file in your HTML page.
+ * Then put your code in an HTML tag like
+ *      <pre class="prettyprint lang-lisp">(my lisp code)</pre>
+ * The lang-cl class identifies the language as common lisp.
+ * This file supports the following language extensions:
+ *     lang-cl - Common Lisp
+ *     lang-el - Emacs Lisp
+ *     lang-lisp - Lisp
+ *     lang-scm - Scheme
+ *
+ *
+ * I used http://www.devincook.com/goldparser/doc/meta-language/grammar-LISP.htm
+ * as the basis, but added line comments that start with ; and changed the atom
+ * production to disallow unquoted semicolons.
+ *
+ * "Name"    = 'LISP'
+ * "Author"  = 'John McCarthy'
+ * "Version" = 'Minimal'
+ * "About"   = 'LISP is an abstract language that organizes ALL'
+ *           | 'data around "lists".'
+ *
+ * "Start Symbol" = [s-Expression]
+ *
+ * {Atom Char}   = {Printable} - {Whitespace} - [()"\'']
+ *
+ * Atom = ( {Atom Char} | '\'{Printable} )+
+ *
+ * [s-Expression] ::= [Quote] Atom
+ *                  | [Quote] '(' [Series] ')'
+ *                  | [Quote] '(' [s-Expression] '.' [s-Expression] ')'
+ *
+ * [Series] ::= [s-Expression] [Series]
+ *            |
+ *
+ * [Quote]  ::= ''      !Quote = do not evaluate
+ *            |
+ *
+ *
+ * I used <a href="http://gigamonkeys.com/book/">Practical Common Lisp</a> as
+ * the basis for the reserved word list.
+ *
+ *
+ * @author [email protected]
+ */
+
+PR.registerLangHandler(
+    PR.createSimpleLexer(
+        [
+         ['opn',             /^\(/, null, '('],
+         ['clo',             /^\)/, null, ')'],
+         // A line comment that starts with ;
+         [PR.PR_COMMENT,     /^;[^\r\n]*/, null, ';'],
+         // Whitespace
+         [PR.PR_PLAIN,       /^[\t\n\r \xA0]+/, null, '\t\n\r \xA0'],
+         // A double quoted, possibly multi-line, string.
+         [PR.PR_STRING,      /^\"(?:[^\"\\]|\\[\s\S])*(?:\"|$)/, null, '"']
+        ],
+        [
+         [PR.PR_KEYWORD,     /^(?:block|c[ad]+r|catch|cons|defun|do|eq|eql|equal|equalp|eval-when|flet|format|go|if|labels|lambda|let|load-time-value|locally|macrolet|multiple-value-call|nil|progn|progv|quote|require|return-from|setq|symbol-macrolet|t|tagbody|the|throw|unwind)\b/, null],
+         [PR.PR_LITERAL,
+          /^[+\-]?(?:\d+\/\d+|(?:\.\d+|\d+(?:\.\d*)?)(?:[eEdD][+\-]?\d+)?)/],
+         // A single quote possibly followed by a word that optionally ends with
+         // = ! or ?.
+         [PR.PR_LITERAL,
+          /^\'(?:-*(?:\w|\\[\x21-\x7e])(?:[\w-]*|\\[\x21-\x7e])[=!?]?)?/],
+         // A word that optionally ends with = ! or ?.
+         [PR.PR_PLAIN,
+          /^-*(?:\w|\\[\x21-\x7e])(?:[\w-]*|\\[\x21-\x7e])[=!?]?/],
+         // A printable non-space non-special character
+         [PR.PR_PUNCTUATION, /^[^\w\t\n\r \xA0()\"\\\';]+/]
+        ]),
+    ['cl', 'el', 'lisp', 'scm']);

src/prettify.js

@@ -62,12 +62,10 @@ var PR_TAB_WIDTH = 8;
   */
 var PR_normalizedHtml;
 
-/** Register a language handler for the given file extensions.
-  * @param {function (sourceCode : string) : Array.<number|string>} a function
-  *     from source code to a list of decorations.
-  * @param {Array.<string>} fileExtensions
+/** Contains functions for creating and registering new language handlers.
+  * @namespace
   */
-var PR_registerLangHandler;
+var PR;
 
 /** Pretty print a chunk of code.
   *
@@ -655,14 +653,17 @@ function pr_isIE6() {
   function sourceDecorator(options) {
     var shortcutStylePatterns = [], fallthroughStylePatterns = [];
     if (options.tripleQuotedStrings) {
+      // '''multi-line-string''', 'single-line-string', and double-quoted
       shortcutStylePatterns.push(
           [PR_STRING,  /^(?:\'\'\'(?:[^\'\\]|\\[\s\S]|\'{1,2}(?=[^\']))*(?:\'\'\'|$)|\"\"\"(?:[^\"\\]|\\[\s\S]|\"{1,2}(?=[^\"]))*(?:\"\"\"|$)|\'(?:[^\\\']|\\[\s\S])*(?:\'|$)|\"(?:[^\\\"]|\\[\s\S])*(?:\"|$))/,
            null, '\'"']);
     } else if (options.multiLineStrings) {
+      // 'multi-line-string', "multi-line-string"
       shortcutStylePatterns.push(
           [PR_STRING,  /^(?:\'(?:[^\\\']|\\[\s\S])*(?:\'|$)|\"(?:[^\\\"]|\\[\s\S])*(?:\"|$)|\`(?:[^\\\`]|\\[\s\S])*(?:\`|$))/,
            null, '\'"`']);
     } else {
+      // 'single-line-string', "single-line-string"
       shortcutStylePatterns.push(
           [PR_STRING,
            /^(?:\'(?:[^\\\'\r\n]|\\.)*(?:\'|$)|\"(?:[^\\\"\r\n]|\\.)*(?:\"|$))/,
@@ -983,9 +984,19 @@ function pr_isIE6() {
 
   /** Maps language-specific file extensions to handlers. */
   var langHandlerRegistry = {};
+  /** Register a language handler for the given file extensions.
+    * @param {function (sourceCode : string) : Array.<number|string>} a function
+    *     from source code to a list of decorations.
+    * @param {Array.<string>} fileExtensions
+    */
   function registerLangHandler(handler, fileExtensions) {
     for (var i = fileExtensions.length; --i >= 0;) {
-      langHandlerRegistry[fileExtensions[i]] = handler;
+      var ext = fileExtensions[i];
+      if (!langHandlerRegistry.hasOwnProperty(ext)) {
+        langHandlerRegistry[ext] = handler;
+      } else if ('console' in window) {
+        console.log('cannot override language handler %s', ext);
+      }
     }
   }
   registerLangHandler(decorateSource, ['default-code']);
@@ -1175,5 +1186,21 @@ function pr_isIE6() {
   window.PR_normalizedHtml = normalizedHtml;
   window.prettyPrintOne = prettyPrintOne;
   window.prettyPrint = prettyPrint;
-  window.PR_registerLangHandler = registerLangHandler;
+  window.PR = {
+        createSimpleLexer: createSimpleLexer,
+        registerLangHandler: registerLangHandler,
+        sourceDecorator: sourceDecorator,
+        PR_ATTRIB_NAME: PR_ATTRIB_NAME,
+        PR_ATTRIB_VALUE: PR_ATTRIB_VALUE,
+        PR_COMMENT: PR_COMMENT,
+        PR_DECLARATION: PR_DECLARATION,
+        PR_KEYWORD: PR_KEYWORD,
+        PR_LITERAL: PR_LITERAL,
+        PR_PLAIN: PR_PLAIN,
+        PR_PUNCTUATION: PR_PUNCTUATION,
+        PR_SOURCE: PR_SOURCE,
+        PR_STRING: PR_STRING,
+        PR_TAG: PR_TAG,
+        PR_TYPE: PR_TYPE
+      };
 })();

tests/prettify_test.html

@@ -4,6 +4,8 @@
 <title>Code Prettifier</title>
 <script src="../src/prettify.js" type="text/javascript"
  onerror="alert('Error: failed to load ' + this.src)"></script>
+<script src="../src/lang-lisp.js" type="text/javascript"
+ onerror="alert('Error: failed to load ' + this.src)"></script>
 <script type="text/javascript">
 // get accurate timing
 PR_SHOULD_USE_CONTINUATION = false;
@@ -706,6 +708,46 @@ <h1>Bug 21 - code doesn't copy and paste well in IE</h1>
 <p>To test this bug, disable overriding of PR_isIE6 above, and copy and paste
 the above into Notepad.</p>
 
+<h1>Bug 42 - Lisp Syntax Highlighting</h1>
+<pre class="prettyprint lang-el" id="issue42"
+>; -*- mode: lisp -*-
+
+(defun back-six-lines () (interactive) (forward-line -6))
+(defun forward-six-lines () (interactive) (forward-line 6))
+
+(global-set-key "\M-l" 'goto-line)
+(global-set-key "\C-z" 'advertised-undo)
+(global-set-key [C-insert] 'clipboard-kill-ring-save)
+(global-set-key [S-insert] 'clipboard-yank)
+(global-set-key [C-up] 'back-six-lines)
+(global-set-key [C-down] 'forward-six-lines)
+
+(setq visible-bell t)
+(setq user-mail-address "[email protected]")
+(setq default-major-mode 'text-mode)
+
+(setenv "TERM" "emacs")
+(c-set-offset 'case-label 2)
+(setq c-basic-offset 2)
+(setq perl-indent-level 2)
+(setq delete-key-deletes-forward t)
+(setq indent-tabs-mode nil)
+
+;; Text mode
+(add-hook 'text-mode-hook 
+  '(lambda ()
+     (turn-on-auto-fill)
+   )
+)
+
+;; Fundamental mode
+(add-hook 'fundamental-mode-hook 
+  '(lambda ()
+     (turn-on-auto-fill)
+   )
+)
+</pre>
+
 </body>
 
 <script type="text/javascript">
@@ -1631,7 +1673,44 @@ <h1>Bug 21 - code doesn't copy and paste well in IE</h1>
       '&nbsp; &nbsp; `END`PUN&lt;`END`TAGtitle`END`PUN&gt;`END`PLNTest`END' +
           '`PUN&lt;/`END`TAGtitle`END`PUN&gt;`END`PLN<br>' +
       '&nbsp; `END`PUN&lt;/`END`TAGhead`END`PUN&gt;`END`PLN<br>' +
-      '`END`PUN&lt;/`END`TAGhtml`END`PUN&gt;`END')
+      '`END`PUN&lt;/`END`TAGhtml`END`PUN&gt;`END'),
+  issue42: (
+      '`COM; -*- mode: lisp -*-`END`PLN<br>' +
+      '<br>' +
+      '`END`OPN(`END`KWDdefun`END`PLN back-six-lines `END`OPN(`END`CLO)`END`PLN `END`OPN(`END`PLNinteractive`END`CLO)`END`PLN `END`OPN(`END`PLNforward-line `END`LIT-6`END`CLO))`END`PLN<br>' +
+      '`END`OPN(`END`KWDdefun`END`PLN forward-six-lines `END`OPN(`END`CLO)`END`PLN `END`OPN(`END`PLNinteractive`END`CLO)`END`PLN `END`OPN(`END`PLNforward-line `END`LIT6`END`CLO))`END`PLN<br>' +
+      '<br>' +
+      '`END`OPN(`END`PLNglobal-set-key `END`STR"\\M-l"`END`PLN `END`LIT\'goto-line`END`CLO)`END`PLN<br>' +
+      '`END`OPN(`END`PLNglobal-set-key `END`STR"\\C-z"`END`PLN `END`LIT\'advertised-undo`END`CLO)`END`PLN<br>' +
+      '`END`OPN(`END`PLNglobal-set-key `END`PUN[`END`PLNC-insert`END`PUN]`END`PLN `END`LIT\'clipboard-kill-ring-save`END`CLO)`END`PLN<br>' +
+      '`END`OPN(`END`PLNglobal-set-key `END`PUN[`END`PLNS-insert`END`PUN]`END`PLN `END`LIT\'clipboard-yank`END`CLO)`END`PLN<br>' +
+      '`END`OPN(`END`PLNglobal-set-key `END`PUN[`END`PLNC-up`END`PUN]`END`PLN `END`LIT\'back-six-lines`END`CLO)`END`PLN<br>' +
+      '`END`OPN(`END`PLNglobal-set-key `END`PUN[`END`PLNC-down`END`PUN]`END`PLN `END`LIT\'forward-six-lines`END`CLO)`END`PLN<br>' +
+      '<br>' +
+      '`END`OPN(`END`KWDsetq`END`PLN visible-bell `END`KWDt`END`CLO)`END`PLN<br>' +
+      '`END`OPN(`END`KWDsetq`END`PLN user-mail-address `END`STR"[email protected]"`END`CLO)`END`PLN<br>' +
+      '`END`OPN(`END`KWDsetq`END`PLN default-major-mode `END`LIT\'text-mode`END`CLO)`END`PLN<br>' +
+      '<br>' +
+      '`END`OPN(`END`PLNsetenv `END`STR"TERM"`END`PLN `END`STR"emacs"`END`CLO)`END`PLN<br>' +
+      '`END`OPN(`END`PLNc-set-offset `END`LIT\'case-label`END`PLN `END`LIT2`END`CLO)`END`PLN<br>' +
+      '`END`OPN(`END`KWDsetq`END`PLN c-basic-offset `END`LIT2`END`CLO)`END`PLN<br>' +
+      '`END`OPN(`END`KWDsetq`END`PLN perl-indent-level `END`LIT2`END`CLO)`END`PLN<br>' +
+      '`END`OPN(`END`KWDsetq`END`PLN delete-key-deletes-forward `END`KWDt`END`CLO)`END`PLN<br>' +
+      '`END`OPN(`END`KWDsetq`END`PLN indent-tabs-mode `END`KWDnil`END`CLO)`END`PLN<br>' +
+      '<br>' +
+      '`END`COM;; Text mode`END`PLN<br>' +
+      '`END`OPN(`END`PLNadd-hook `END`LIT\'text-mode-hook`END`PLN <br>' +
+      '&nbsp; `END`LIT\'`END`OPN(`END`KWDlambda`END`PLN `END`OPN(`END`CLO)`END`PLN<br>' +
+      '&nbsp; &nbsp; &nbsp;`END`OPN(`END`PLNturn-on-auto-fill`END`CLO)`END`PLN<br>' +
+      '&nbsp; &nbsp;`END`CLO)`END`PLN<br>' +
+      '`END`CLO)`END`PLN<br>' +
+      '<br>' +
+      '`END`COM;; Fundamental mode`END`PLN<br>' +
+      '`END`OPN(`END`PLNadd-hook `END`LIT\'fundamental-mode-hook`END`PLN <br>' +
+      '&nbsp; `END`LIT\'`END`OPN(`END`KWDlambda`END`PLN `END`OPN(`END`CLO)`END`PLN<br>' +
+      '&nbsp; &nbsp; &nbsp;`END`OPN(`END`PLNturn-on-auto-fill`END`CLO)`END`PLN<br>' +
+      '&nbsp; &nbsp;`END`CLO)`END`PLN<br>' +
+      '`END`CLO)`END')
 };