Merge pull request #21 from iafan/master

Add an ability to produce an `<ol>...</ol>`-wrapped list to display line numbers

Author: sqs

.travis.yml

@@ -1,8 +1,11 @@
 language: go
+go_import_path: github.com/sourcegraph/syntaxhighlight
 go:
-  - 1.4
+  - 1.6.x
+  - 1.7.x
+  - 1.8.x
+  - tip
 install:
-  - go get golang.org/x/tools/cmd/vet
   - go get -t -v ./...
 script:
   - diff -u <(echo -n) <(gofmt -d ./)

README.md

@@ -20,7 +20,7 @@ Remember you should set the environment variables correctly (GOPATH and PATH)
 
 ## Example usage
 
-The function [`AsHTML(src []byte) ([]byte, error)`](https://sourcegraph.com/sourcegraph.com/sourcegraph/syntaxhighlight@master/.GoPackage/sourcegraph.com/sourcegraph/syntaxhighlight/.def/AsHTML) returns an HTML-highlighted version of `src`. The input source code can be in any language; the lexer is language independent.
+The function [`AsHTML(src []byte, options ...Option) ([]byte, error)`](https://sourcegraph.com/sourcegraph.com/sourcegraph/syntaxhighlight@master/.GoPackage/sourcegraph.com/sourcegraph/syntaxhighlight/.def/AsHTML) returns an HTML-highlighted version of `src`. The input source code can be in any language; the lexer is language independent. An `OrderedList()` option can be passed to produce an `<ol>...</ol>`-wrapped list to display line numbers.
 
 ```go
 package syntaxhighlight_test

highlight.go

@@ -6,6 +6,7 @@ package syntaxhighlight
 import (
 	"bytes"
 	"io"
+	"strings"
 	"text/scanner"
 	"text/template"
 	"unicode"
@@ -18,6 +19,7 @@ import (
 // A syntax highlighting scheme (style) maps text style properties to each token kind.
 type Kind uint8
 
+// A set of supported highlighting kinds
 const (
 	Whitespace Kind = iota
 	String
@@ -36,6 +38,8 @@ const (
 
 //go:generate gostringer -type=Kind
 
+// Printer implements an interface to render highlighted output
+// (see HTMLPrinter for the implementation of this interface)
 type Printer interface {
 	Print(w io.Writer, kind Kind, tokText string) error
 }
@@ -56,8 +60,12 @@ type HTMLConfig struct {
 	HTMLAttrValue string
 	Decimal       string
 	Whitespace    string
+
+	AsOrderedList bool
 }
 
+// HTMLPrinter implements Printer interface and is used to produce
+// HTML-based highligher
 type HTMLPrinter HTMLConfig
 
 // Class returns the set class for a given token Kind.
@@ -91,7 +99,22 @@ func (c HTMLConfig) Class(kind Kind) string {
 	return ""
 }
 
+// Print is the function that emits highlighted source code using
+// <span class="...">...</span> wrapper tags
 func (p HTMLPrinter) Print(w io.Writer, kind Kind, tokText string) error {
+	if p.AsOrderedList {
+		if i := strings.Index(tokText, "\n"); i > -1 {
+			if err := p.Print(w, kind, tokText[:i]); err != nil {
+				return err
+			}
+			w.Write([]byte("</li>\n<li>"))
+			if err := p.Print(w, kind, tokText[i+1:]); err != nil {
+				return err
+			}
+			return nil
+		}
+	}
+
 	class := ((HTMLConfig)(p)).Class(kind)
 	if class != "" {
 		_, err := w.Write([]byte(`<span class="`))
@@ -137,7 +160,22 @@ func (a HTMLAnnotator) Annotate(start int, kind Kind, tokText string) (*annotate
 	return nil, nil
 }
 
-// DefaultHTMLConfig's class names match those of google-code-prettify
+// Option is a type of the function that can modify
+// one or more of the options in the HTMLConfig structure.
+type Option func(options *HTMLConfig)
+
+// OrderedList allows you to format the output as an ordered list
+// to have line numbers in the output.
+//
+// Example:
+// AsHTML(input, OrderedList())
+func OrderedList() Option {
+	return func(o *HTMLConfig) {
+		o.AsOrderedList = true
+	}
+}
+
+// DefaultHTMLConfig provides class names that match those of google-code-prettify
 // (https://code.google.com/p/google-code-prettify/).
 var DefaultHTMLConfig = HTMLConfig{
 	String:        "str",
@@ -195,9 +233,23 @@ func Annotate(src []byte, a Annotator) (annotate.Annotations, error) {
 	return anns, nil
 }
 
-func AsHTML(src []byte) ([]byte, error) {
+// AsHTML converts source code into an HTML-highlighted version;
+// It accepts optional configuration parameters to control rendering
+// (see OrderedList as one example)
+func AsHTML(src []byte, options ...Option) ([]byte, error) {
+	opt := DefaultHTMLConfig
+	for _, f := range options {
+		f(&opt)
+	}
+
 	var buf bytes.Buffer
-	err := Print(NewScanner(src), &buf, HTMLPrinter(DefaultHTMLConfig))
+	if opt.AsOrderedList {
+		buf.Write([]byte("<ol>\n<li>"))
+	}
+	err := Print(NewScanner(src), &buf, HTMLPrinter(opt))
+	if opt.AsOrderedList {
+		buf.Write([]byte("</li>\n</ol>"))
+	}
 	if err != nil {
 		return nil, err
 	}

highlight_test.go

@@ -16,6 +16,36 @@ import (
 var saveExp = flag.Bool("exp", false, "overwrite all expected output files with actual output (returning a failure)")
 var match = flag.String("m", "", "only run tests whose name contains this string")
 
+func testExpected(t *testing.T, fn, path, name, ext string, got []byte, err error) {
+	if err != nil {
+		t.Errorf("%s: %s: %s", fn, name, err)
+		return
+	}
+
+	expPath := path + ext
+	if *saveExp {
+		err = ioutil.WriteFile(expPath, got, 0700)
+		if err != nil {
+			t.Fatal(err)
+		}
+		return
+	}
+
+	want, err := ioutil.ReadFile(expPath)
+	if err != nil {
+		t.Fatal(err)
+	}
+
+	want = bytes.TrimSpace(want)
+	got = bytes.TrimSpace(got)
+
+	if !bytes.Equal(want, got) {
+		t.Errorf("%s: %s:\nwant ==========\n%q\ngot ===========\n%q", fn, name, want, got)
+		return
+	}
+	return
+}
+
 func TestAsHTML(t *testing.T) {
 	dir := "testdata"
 	tests, err := ioutil.ReadDir(dir)
@@ -43,32 +73,10 @@ func TestAsHTML(t *testing.T) {
 		}
 
 		got, err := AsHTML(input)
-		if err != nil {
-			t.Errorf("%s: AsHTML: %s", name, err)
-			continue
-		}
-
-		expPath := path + ".html"
-		if *saveExp {
-			err = ioutil.WriteFile(expPath, got, 0700)
-			if err != nil {
-				t.Fatal(err)
-			}
-			continue
-		}
+		testExpected(t, "AsHTML", path, name, ".html", got, err)
 
-		want, err := ioutil.ReadFile(expPath)
-		if err != nil {
-			t.Fatal(err)
-		}
-
-		want = bytes.TrimSpace(want)
-		got = bytes.TrimSpace(got)
-
-		if !bytes.Equal(want, got) {
-			t.Errorf("%s:\nwant ==========\n%q\ngot ===========\n%q", name, want, got)
-			continue
-		}
+		got, err = AsHTML(input, OrderedList())
+		testExpected(t, "AsOrderedListHTML", path, name, ".ol.html", got, err)
 	}
 
 	if *saveExp {

testdata/escaped_string.py.ol.html

@@ -0,0 +1,4 @@
+<ol>
+<li><span class="str">&#34;this string\&#34; continues to here&#34;</span></li>
+<li></li>
+</ol>

testdata/html_in_string.py.ol.html

@@ -0,0 +1,4 @@
+<ol>
+<li><span class="str">&#34;&lt;h1&gt;hello!&lt;/h1&gt;&#34;</span></li>
+<li></li>
+</ol>

testdata/no_ending_newline.js

@@ -0,0 +1 @@
+'test'

testdata/no_ending_newline.js.html

@@ -0,0 +1 @@
+<span class="str">&#39;test&#39;</span>

testdata/no_ending_newline.js.ol.html

@@ -0,0 +1,3 @@
+<ol>
+<li><span class="str">&#39;test&#39;</span></li>
+</ol>

testdata/simple.c.ol.html

@@ -0,0 +1,9 @@
+<ol>
+<li><span class="pun">#</span><span class="pln">include</span> <span class="pun">&lt;</span><span class="pln">stdio</span><span class="pun">.</span><span class="pln">h</span><span class="pun">&gt;</span></li>
+<li> </li>
+<li><span class="kwd">int</span> <span class="pln">main</span><span class="pun">(</span><span class="kwd">void</span><span class="pun">)</span></li>
+<li><span class="pun">{</span></li>
+<li>    <span class="pln">printf</span><span class="pun">(</span><span class="str">&#34;hello, world\n&#34;</span><span class="pun">)</span><span class="pun">;</span></li>
+<li><span class="pun">}</span></li>
+<li></li>
+</ol>