language handler for WikiText

Author: mikesamuel

CHANGES.html

@@ -59,7 +59,7 @@ <h2>14 Jul 2008</h2>
     </ul>
     <h2>6 Jan 2009</h2>
     <ul>
-      <li>Language handlers for Visual Basic and Haskell</li>
+      <li>Language handlers for Visual Basic, Haskell, and WikiText</li>
     </ul>
   </body>
 </html>

README.html

@@ -65,10 +65,10 @@ <h2>FAQ</h2>
     <h3>Which languages does it work for?</h3>
     <p>The comments in <tt>prettify.js</tt> are authoritative but the lexer
     should work on a number of languages including C and friends,
-    Java, Python, Bash, VB, 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, or
-    CAML-like languages.</p>
+    Java, Python, Bash, SQL, HTML, XML, CSS, Javascript, and Makefiles.
+    It works passably on Ruby, PHP, VB, and Awk and a decent subset of Perl
+    and Ruby, but, 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"
@@ -80,9 +80,11 @@ <h3>Which languages does it work for?</h3>
      <a href="http://code.google.com/p/google-code-prettify/source/browse/trunk/src/lang-vb.js"
      ><code>Visual Basic</code></a>,
      <a href="http://code.google.com/p/google-code-prettify/source/browse/trunk/src/lang-sql.js"
-     ><code>SQL</code></a>, and
+     ><code>SQL</code></a>,
      <a href="http://code.google.com/p/google-code-prettify/source/browse/trunk/src/lang-proto.js"
-     ><code>Protocol Buffers</code></a>.
+     ><code>Protocol Buffers</code></a>, and
+     <a href="http://code.google.com/p/google-code-prettify/source/browse/trunk/src/lang-wiki.js"
+     ><code>WikiText</code></a>..
 
     <p>If you'd like to add an extension for your favorite language, please
     look at <tt>src/lang-lisp.js</tt> and file an

src/lang-wiki.js

@@ -0,0 +1,49 @@
+// Copyright (C) 2009 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 Wiki pages.
+ *
+ * Based on WikiSyntax at http://code.google.com/p/support/wiki/WikiSyntax
+ *
+ * @author [email protected]
+ */
+
+PR.registerLangHandler(
+    PR.createSimpleLexer(
+        [
+         // Whitespace
+         [PR.PR_PLAIN,       /^[\t\n\r \xA0a-gi-z0-9]+/, null,
+          '\t\n\r \xA0abcdefgijklmnopqrstuvwxyz0123456789'],
+         // Wiki formatting
+         [PR.PR_PUNCTUATION, /^[=*~\^\[\]]+/, null, '=*~^[]']
+        ],
+        [
+         // Meta-info like #summary, #labels, etc.
+         [PR.PR_KEYWORD,     /^#[a-z]+\b/, /(?:^|[\r\n])$/],
+         // A WikiWord
+         [PR.PR_LITERAL,     /^(?:[A-Z][a-z][a-z0-9]+[A-Z][a-z][a-zA-Z0-9]+)\b/
+          ],
+         // A preformatted block in an unknown language
+         ['lang-',           /^\{\{\{([\s\S]*?)\}\}\}/],
+         // A block of source code in an unknown language
+         ['lang-',           /^`([^\r\n`]+)`/],
+         // An inline URL.
+         [PR.PR_STRING,
+          /^https?:\/\/[^/?#\s]*(?:\/[^?#\s]*)?(?:\?[^#\s]*)?(?:#\S*)?/i],
+         [PR.PR_PLAIN,       /^[\s\S][^#=*~^A-Zh\{`\[]+/]
+        ]),
+    ['wiki']);

src/prettify.js

@@ -519,8 +519,13 @@ function _pr_isIE6() {
     *
     * The stylePatterns is a list whose elements have the form
     * [style : string, pattern : RegExp, context : RegExp, shortcut : string].
-    &
-    * Style is a style constant like PR_PLAIN.
+    *
+    * Style is a style constant like PR_PLAIN, or can be a string of the
+    * form 'lang-FOO', where FOO is a language extension describing the
+    * language of the portion of the token in $1 after pattern executes.
+    * E.g., if style is 'lang-lisp', and group 1 contains the text
+    * '(hello (world))', then that portion of the token will be passed to the
+    * registered lisp handler for formatting.
     *
     * Pattern must only match prefixes, and if it matches a prefix and context
     * is null or matches the last non-comment token parsed, then that match is
@@ -598,7 +603,32 @@ function _pr_isIE6() {
           }
         }
 
-        decorations.push(opt_basePos + pos, style);
+        if (!match || !match[1] || 'lang-' !== style.substring(0, 5)) {
+          decorations.push(opt_basePos + pos, style);
+        } else {  // Treat group 1 as an embedded block of source code.
+          var lang = style.substring(5);
+          var embeddedSource = match[1];
+          var embeddedSourceStart = token.indexOf(embeddedSource);
+          var embeddedSourceEnd = embeddedSourceStart + embeddedSource.length;
+          if (embeddedSourceStart) {
+            decorations.push(opt_basePos + pos, PR_SOURCE);
+          }
+          if (!langHandlerRegistry.hasOwnProperty(lang)) {
+            lang = /^\s*</.test(embeddedSource)
+                ? 'default-markup'
+                : 'default-code'
+          }
+          var delegate = langHandlerRegistry[lang];
+          var embeddedOffset = opt_basePos + pos + embeddedSourceStart;
+          var embeddedDecorations = delegate.call({}, embeddedSource);
+          for (var i = 0, n = embeddedDecorations.length; i < n; i += 2) {
+            decorations.push(embeddedOffset + embeddedDecorations[i],
+                             embeddedDecorations[i + 1]);
+          }
+          if (embeddedSourceEnd < token.length) {
+            decorations.push(opt_basePos + pos + embeddedSourceEnd, PR_SOURCE);
+          }
+        }
         pos += token.length;
         tail = tail.substring(token.length);
         if (style !== PR_COMMENT && notWs.test(token)) { lastToken = token; }
@@ -969,7 +999,7 @@ function _pr_isIE6() {
     var newlineRe = /\r\n?|\n/g;
     var trailingSpaceRe = /[ \r\n]$/;
     var lastWasSpace = true;  // the last text chunk emitted ended with a space.
-    
+
     // A helper function that is responsible for opening sections of decoration
     // and outputing properly escaped chunks of source
     function emitTextUpTo(sourceIdx) {

tests/prettify_test.html

@@ -16,6 +16,8 @@
  onerror="alert('Error: failed to load ' + this.src)"></script>
 <script src="../src/lang-sql.js" type="text/javascript"
  onerror="alert('Error: failed to load ' + this.src)"></script>
+<script src="../src/lang-wiki.js" type="text/javascript"
+ onerror="alert('Error: failed to load ' + this.src)"></script>
 <script src="../src/lang-vb.js" type="text/javascript"
  onerror="alert('Error: failed to load ' + this.src)"></script>
 <script type="text/javascript">
@@ -803,46 +805,6 @@ <h1>Bug 24 - LUA Syntax Highlighting</h1>
   return shellsort
 end</pre>
 
-<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>
-
 <h1>Bug 27 - VBScript w/ language specified</h1>
 <pre class="prettyprint lang-vb" id="issue27">
 Imports System
@@ -911,7 +873,7 @@ <h1>Bug 30 - Haskell w/ language specified</h1>
   Nil :: Foo a b c
   Cons :: a b c -> Foo abc -> Foo a b c
 
-str = "Foo\\Bar"
+str = &quot;Foo\\Bar"
 char = 'x'
 Not.A.Char = 'too long'  -- Don't barf.  Show that 't is a lexical error.
 
@@ -940,6 +902,46 @@ <h1>Bug 33 - OCaml and F#</h1>
 </pre>
 <p>Still TODO: handle nested <code>(* (* comments *) *)</code> properly.</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>
+
 <h1>Bug 45 - Square brackets in strings</h1>
 <pre class="prettyprint" id="issue45">
 throw new RuntimeException("Element [" + element.getName() + 
@@ -965,6 +967,32 @@ <h1>Protocol Buffers</h1>
   optional Corpus corpus = 4 [default = UNIVERSAL];
 }</pre>
 
+<h1>Wiki syntax w/ language specified</h1>
+<pre class="prettyprint lang-wiki" id="wiki">
+#summary hello world
+#labels HelloWorld WikiWord Hiya
+
+[http://www.google.com/?q=WikiSyntax+site:code.google.com WikiSyntax]
+
+Lorem Ipsum `while (1) print("blah blah");`
+
+   * Bullet
+   * Points
+      * NestedBullet
+
+==DroningOnAndOn==
+{{{
+  // Some EmbeddedSourceCode
+  void main() {
+    Print('hello world');
+  }
+}}}
+
+{{{
+  &lt;!-- Embedded XML --&gt;
+  &lt;foo bar="baz"&gt;&lt;boo /&gt;&lt;foo&gt;
+}}}
+</pre>
 </body>
 
 <script type="text/javascript">
@@ -2244,7 +2272,42 @@ <h1>Protocol Buffers</h1>
       '&nbsp; `END`KWDoptional`END`PLN `END`TYPCorpus`END`PLN corpus `END' +
            '`PUN=`END`PLN `END`LIT4`END`PLN `END`PUN[`END`KWDdefault`END' +
            '`PLN `END`PUN=`END`PLN UNIVERSAL`END`PUN];`END`PLN<br>' +
-      '`END`PUN}`END')
+      '`END`PUN}`END'),
+  wiki: (
+      '`KWD#summary`END`PLN hello world<br>' +
+      '`END`KWD#labels`END`PLN `END`LITHelloWorld`END`PLN `END' +
+           '`LITWikiWord`END`PLN Hiya<br>' +
+      '<br>' +
+      '`END`PUN[`END' +
+           '`STRhttp://www.google.com/?q=WikiSyntax+site:code.google.com`END' +
+           '`PLN `END`LITWikiSyntax`END`PUN]`END`PLN<br>' +
+      '<br>' +
+      'Lorem Ipsum `END`SRC``END`KWDwhile`END`PLN `END`PUN(`END`LIT1`END' +
+           '`PUN)`END`PLN `END`KWDprint`END`PUN(`END`STR"blah blah"`END' +
+           '`PUN);`END`SRC``END`PLN<br>' +
+      '<br>' +
+      '&nbsp; &nbsp;`END`PUN*`END`PLN Bullet<br>' +
+      '&nbsp; &nbsp;`END`PUN*`END`PLN Points<br>' +
+      '&nbsp; &nbsp; &nbsp; `END`PUN*`END`PLN `END`LITNestedBullet`END' +
+           '`PLN<br>' +
+      '<br>' +
+      '`END`PUN==`END`LITDroningOnAndOn`END`PUN==`END`PLN<br>' +
+      '`END`SRC{{{`END`PLN<br>' +
+      '&nbsp; `END`COM// Some EmbeddedSourceCode`END`PLN<br>' +
+      '&nbsp; `END`KWDvoid`END`PLN main`END`PUN()`END`PLN `END`PUN{`END' +
+           '`PLN<br>' +
+      '&nbsp; &nbsp; `END`TYPPrint`END`PUN(`END`STR\'hello world\'`END' +
+           '`PUN);`END`PLN<br>' +
+      '&nbsp; `END`PUN}`END`PLN<br>' +
+      '`END`SRC}}}`END`PLN<br>' +
+      '<br>' +
+      '`END`SRC{{{`END`PLN<br>' +
+      '&nbsp; `END`COM&lt;!-- Embedded XML --&gt;`END`PLN<br>' +
+      '&nbsp; `END`PUN&lt;`END`TAGfoo`END`PLN `END`ATNbar`END`PUN=`END' +
+           '`ATV"baz"`END`PUN&gt;&lt;`END`TAGboo`END`PLN `END' +
+           '`PUN/&gt;&lt;`END`TAGfoo`END`PUN&gt;`END`PLN<br>' +
+      '`END`SRC}}}`END'
+      )
 };