Skip to content

Normalize (consolidate) tokens of the same kind #23

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion example_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ function b() {
// <span class="kwd">var</span> <span class="pln">a</span> <span class="pun">=</span> <span class="dec">3</span><span class="pun">;</span>
//
// <span class="com">// b is a cool function</span>
// <span class="kwd">function</span> <span class="pln">b</span><span class="pun">(</span><span class="pun">)</span> <span class="pun">{</span>
// <span class="kwd">function</span> <span class="pln">b</span><span class="pun">()</span> <span class="pun">{</span>
// <span class="kwd">return</span> <span class="dec">7</span><span class="pun">;</span>
// <span class="pun">}</span>
}
52 changes: 42 additions & 10 deletions highlight.go
Original file line number Diff line number Diff line change
Expand Up @@ -194,17 +194,31 @@ var DefaultHTMLConfig = HTMLConfig{
}

func Print(s *scanner.Scanner, w io.Writer, p Printer) error {
accum := ""
lastKind := Whitespace
tok := s.Scan()
for tok != scanner.EOF {
tokText := s.TokenText()
err := p.Print(w, tokenKind(tok, tokText), tokText)
if err != nil {
return err
text := s.TokenText()
kind := tokenKind(tok, text)
if kind != lastKind {
if accum != "" {
if err := p.Print(w, lastKind, accum); err != nil {
return err
}
accum = ""
}
lastKind = kind
}

accum += text
tok = s.Scan()
}

if accum != "" {
if err := p.Print(w, lastKind, accum); err != nil {
return err
}
}

return nil
}

Expand All @@ -214,20 +228,38 @@ func Annotate(src []byte, a Annotator) (annotate.Annotations, error) {
var anns annotate.Annotations
read := 0

accum := ""
lastKind := Whitespace
tok := s.Scan()
for tok != scanner.EOF {
tokText := s.TokenText()
text := s.TokenText()
kind := tokenKind(tok, text)
if kind != lastKind {
if accum != "" {
ann, err := a.Annotate(read, lastKind, accum)
if err != nil {
return nil, err
}
read += len(accum)
if ann != nil {
anns = append(anns, ann)
}
accum = ""
}
lastKind = kind
}
accum += text
tok = s.Scan()
}

ann, err := a.Annotate(read, tokenKind(tok, tokText), tokText)
if accum != "" {
ann, err := a.Annotate(read, lastKind, accum)
if err != nil {
return nil, err
}
read += len(tokText)
if ann != nil {
anns = append(anns, ann)
}

tok = s.Scan()
}

return anns, nil
Expand Down
3 changes: 1 addition & 2 deletions highlight_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -88,8 +88,7 @@ func TestAnnotate(t *testing.T) {
src := []byte(`a:=2`)
want := annotate.Annotations{
{Start: 0, End: 1, Left: []byte(`<span class="pln">`), Right: []byte("</span>")},
{Start: 1, End: 2, Left: []byte(`<span class="pun">`), Right: []byte("</span>")},
{Start: 2, End: 3, Left: []byte(`<span class="pun">`), Right: []byte("</span>")},
{Start: 1, End: 3, Left: []byte(`<span class="pun">`), Right: []byte("</span>")},
{Start: 3, End: 4, Left: []byte(`<span class="dec">`), Right: []byte("</span>")},
}
got, err := Annotate(src, HTMLAnnotator(DefaultHTMLConfig))
Expand Down
1 change: 1 addition & 0 deletions testdata/consolidate_tokens.js
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
>=
1 change: 1 addition & 0 deletions testdata/consolidate_tokens.js.html
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
<span class="pun">&gt;=</span>
3 changes: 3 additions & 0 deletions testdata/consolidate_tokens.js.ol.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
<ol>
<li><span class="pun">&gt;=</span></li>
</ol>
2 changes: 1 addition & 1 deletion testdata/simple.c.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@

<span class="kwd">int</span> <span class="pln">main</span><span class="pun">(</span><span class="kwd">void</span><span class="pun">)</span>
<span class="pun">{</span>
<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>
<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>
2 changes: 1 addition & 1 deletion testdata/simple.c.ol.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<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="pln">printf</span><span class="pun">(</span><span class="str">&#34;hello, world\n&#34;</span><span class="pun">);</span></li>
<li><span class="pun">}</span></li>
<li></li>
</ol>
4 changes: 2 additions & 2 deletions testdata/simple.go.html
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
<span class="com">// +build ignore</span>
<span class="kwd">package</span> <span class="pln">foo</span>

<span class="kwd">func</span> <span class="typ">Bar</span><span class="pun">(</span><span class="pln">baz</span> <span class="pln">string</span><span class="pun">,</span> <span class="pln">qux</span> <span class="pun">*</span><span class="typ">Zip</span><span class="pun">)</span> <span class="pun">(</span><span class="pun">*</span><span class="typ">Zap</span><span class="pun">,</span> <span class="typ">Zop</span><span class="pun">)</span> <span class="pun">{</span>
<span class="pln">ziz</span> <span class="pun">:</span><span class="pun">=</span> <span class="pln">mop</span><span class="pun">(</span><span class="dec">3</span><span class="pun">,</span> <span class="str">&#34;hello world&#34;</span><span class="pun">)</span>
<span class="kwd">func</span> <span class="typ">Bar</span><span class="pun">(</span><span class="pln">baz</span> <span class="pln">string</span><span class="pun">,</span> <span class="pln">qux</span> <span class="pun">*</span><span class="typ">Zip</span><span class="pun">)</span> <span class="pun">(*</span><span class="typ">Zap</span><span class="pun">,</span> <span class="typ">Zop</span><span class="pun">)</span> <span class="pun">{</span>
<span class="pln">ziz</span> <span class="pun">:=</span> <span class="pln">mop</span><span class="pun">(</span><span class="dec">3</span><span class="pun">,</span> <span class="str">&#34;hello world&#34;</span><span class="pun">)</span>
<span class="pun">}</span>

<span class="kwd">type</span> <span class="typ">Qaz</span> <span class="kwd">struct</span> <span class="pun">{</span>
Expand Down
4 changes: 2 additions & 2 deletions testdata/simple.go.ol.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
<li><span class="com">// +build ignore</span></li>
<li><span class="kwd">package</span> <span class="pln">foo</span></li>
<li></li>
<li><span class="kwd">func</span> <span class="typ">Bar</span><span class="pun">(</span><span class="pln">baz</span> <span class="pln">string</span><span class="pun">,</span> <span class="pln">qux</span> <span class="pun">*</span><span class="typ">Zip</span><span class="pun">)</span> <span class="pun">(</span><span class="pun">*</span><span class="typ">Zap</span><span class="pun">,</span> <span class="typ">Zop</span><span class="pun">)</span> <span class="pun">{</span></li>
<li> <span class="pln">ziz</span> <span class="pun">:</span><span class="pun">=</span> <span class="pln">mop</span><span class="pun">(</span><span class="dec">3</span><span class="pun">,</span> <span class="str">&#34;hello world&#34;</span><span class="pun">)</span></li>
<li><span class="kwd">func</span> <span class="typ">Bar</span><span class="pun">(</span><span class="pln">baz</span> <span class="pln">string</span><span class="pun">,</span> <span class="pln">qux</span> <span class="pun">*</span><span class="typ">Zip</span><span class="pun">)</span> <span class="pun">(*</span><span class="typ">Zap</span><span class="pun">,</span> <span class="typ">Zop</span><span class="pun">)</span> <span class="pun">{</span></li>
<li> <span class="pln">ziz</span> <span class="pun">:=</span> <span class="pln">mop</span><span class="pun">(</span><span class="dec">3</span><span class="pun">,</span> <span class="str">&#34;hello world&#34;</span><span class="pun">)</span></li>
<li><span class="pun">}</span></li>
<li></li>
<li><span class="kwd">type</span> <span class="typ">Qaz</span> <span class="kwd">struct</span> <span class="pun">{</span></li>
Expand Down
6 changes: 3 additions & 3 deletions testdata/simple.js.html
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
<span class="com">// foo is a cool function</span>
<span class="kwd">function</span> <span class="pln">foo</span><span class="pun">(</span><span class="pun">)</span> <span class="pun">{</span><span class="pun">}</span>
<span class="kwd">function</span> <span class="pln">foo</span><span class="pun">()</span> <span class="pun">{}</span>

<span class="com">/* bar is a cool var */</span>
<span class="kwd">var</span> <span class="pln">bar</span> <span class="pun">=</span> <span class="dec">3</span><span class="pun">;</span>

<span class="typ">A</span><span class="pun">.</span><span class="pln">prototype</span><span class="pun">.</span><span class="pln">foo</span> <span class="pun">=</span> <span class="kwd">function</span><span class="pun">(</span><span class="pun">)</span> <span class="pun">{</span>
<span class="kwd">this</span><span class="pun">.</span><span class="pln">noise</span> <span class="pun">|</span><span class="pun">|</span> <span class="str">&#39;&lt;chirp&gt;&#39;</span><span class="pun">;</span>
<span class="typ">A</span><span class="pun">.</span><span class="pln">prototype</span><span class="pun">.</span><span class="pln">foo</span> <span class="pun">=</span> <span class="kwd">function</span><span class="pun">()</span> <span class="pun">{</span>
<span class="kwd">this</span><span class="pun">.</span><span class="pln">noise</span> <span class="pun">||</span> <span class="str">&#39;&lt;chirp&gt;&#39;</span><span class="pun">;</span>
<span class="kwd">return</span> <span class="str">&#39;Hello from &#39;</span> <span class="pun">+</span> <span class="kwd">this</span><span class="pun">.</span><span class="pln">name</span><span class="pun">;</span>
<span class="pun">}</span>
6 changes: 3 additions & 3 deletions testdata/simple.js.ol.html
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
<ol>
<li><span class="com">// foo is a cool function</span></li>
<li><span class="kwd">function</span> <span class="pln">foo</span><span class="pun">(</span><span class="pun">)</span> <span class="pun">{</span><span class="pun">}</span></li>
<li><span class="kwd">function</span> <span class="pln">foo</span><span class="pun">()</span> <span class="pun">{}</span></li>
<li></li>
<li><span class="com">/* bar is a cool var */</span></li>
<li><span class="kwd">var</span> <span class="pln">bar</span> <span class="pun">=</span> <span class="dec">3</span><span class="pun">;</span></li>
<li></li>
<li><span class="typ">A</span><span class="pun">.</span><span class="pln">prototype</span><span class="pun">.</span><span class="pln">foo</span> <span class="pun">=</span> <span class="kwd">function</span><span class="pun">(</span><span class="pun">)</span> <span class="pun">{</span></li>
<li> <span class="kwd">this</span><span class="pun">.</span><span class="pln">noise</span> <span class="pun">|</span><span class="pun">|</span> <span class="str">&#39;&lt;chirp&gt;&#39;</span><span class="pun">;</span></li>
<li><span class="typ">A</span><span class="pun">.</span><span class="pln">prototype</span><span class="pun">.</span><span class="pln">foo</span> <span class="pun">=</span> <span class="kwd">function</span><span class="pun">()</span> <span class="pun">{</span></li>
<li> <span class="kwd">this</span><span class="pun">.</span><span class="pln">noise</span> <span class="pun">||</span> <span class="str">&#39;&lt;chirp&gt;&#39;</span><span class="pun">;</span></li>
<li> <span class="kwd">return</span> <span class="str">&#39;Hello from &#39;</span> <span class="pun">+</span> <span class="kwd">this</span><span class="pun">.</span><span class="pln">name</span><span class="pun">;</span></li>
<li><span class="pun">}</span></li>
<li></li>
Expand Down
2 changes: 1 addition & 1 deletion testdata/simple.py.html
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<span class="kwd">from</span> <span class="pln">foo</span> <span class="kwd">import</span> <span class="pln">bar</span>

<span class="kwd">def</span> <span class="pln">f</span><span class="pun">(</span><span class="kwd">self</span><span class="pun">,</span> <span class="pln">a</span><span class="pun">,</span> <span class="pln">b</span><span class="pun">)</span><span class="pun">:</span>
<span class="kwd">def</span> <span class="pln">f</span><span class="pun">(</span><span class="kwd">self</span><span class="pun">,</span> <span class="pln">a</span><span class="pun">,</span> <span class="pln">b</span><span class="pun">):</span>
<span class="kwd">print</span><span class="pun">(</span><span class="str">&#39;hello!&#39;</span><span class="pun">)</span>
2 changes: 1 addition & 1 deletion testdata/simple.py.ol.html
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<ol>
<li><span class="kwd">from</span> <span class="pln">foo</span> <span class="kwd">import</span> <span class="pln">bar</span></li>
<li></li>
<li><span class="kwd">def</span> <span class="pln">f</span><span class="pun">(</span><span class="kwd">self</span><span class="pun">,</span> <span class="pln">a</span><span class="pun">,</span> <span class="pln">b</span><span class="pun">)</span><span class="pun">:</span></li>
<li><span class="kwd">def</span> <span class="pln">f</span><span class="pun">(</span><span class="kwd">self</span><span class="pun">,</span> <span class="pln">a</span><span class="pun">,</span> <span class="pln">b</span><span class="pun">):</span></li>
<li> <span class="kwd">print</span><span class="pun">(</span><span class="str">&#39;hello!&#39;</span><span class="pun">)</span></li>
<li></li>
</ol>
2 changes: 1 addition & 1 deletion testdata/simple.rb.html
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,5 @@

<span class="kwd">def</span> <span class="pln">foo</span><span class="pun">(</span><span class="pln">a</span><span class="pun">,</span> <span class="pln">b</span><span class="pun">)</span>
<span class="pln">puts</span> <span class="pln">a</span>
<span class="typ">A</span><span class="pun">:</span><span class="pun">:</span><span class="typ">B</span>
<span class="typ">A</span><span class="pun">::</span><span class="typ">B</span>
<span class="kwd">end</span>
2 changes: 1 addition & 1 deletion testdata/simple.rb.ol.html
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
<li></li>
<li><span class="kwd">def</span> <span class="pln">foo</span><span class="pun">(</span><span class="pln">a</span><span class="pun">,</span> <span class="pln">b</span><span class="pun">)</span></li>
<li> <span class="pln">puts</span> <span class="pln">a</span></li>
<li> <span class="typ">A</span><span class="pun">:</span><span class="pun">:</span><span class="typ">B</span></li>
<li> <span class="typ">A</span><span class="pun">::</span><span class="typ">B</span></li>
<li><span class="kwd">end</span></li>
<li></li>
</ol>
4 changes: 2 additions & 2 deletions testdata/underscore.go.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

<span class="kwd">package</span> <span class="pln">foo_bar</span>

<span class="kwd">func</span> <span class="pln">foo</span><span class="pun">(</span><span class="pun">)</span> <span class="pun">{</span>
<span class="kwd">for</span> <span class="pln">_</span><span class="pun">,</span> <span class="pln">a</span> <span class="pun">:</span><span class="pun">=</span> <span class="pln">range</span> <span class="pln">foo</span> <span class="pun">{</span>
<span class="kwd">func</span> <span class="pln">foo</span><span class="pun">()</span> <span class="pun">{</span>
<span class="kwd">for</span> <span class="pln">_</span><span class="pun">,</span> <span class="pln">a</span> <span class="pun">:=</span> <span class="pln">range</span> <span class="pln">foo</span> <span class="pun">{</span>
<span class="pun">}</span>
<span class="pun">}</span>
4 changes: 2 additions & 2 deletions testdata/underscore.go.ol.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
<li></li>
<li><span class="kwd">package</span> <span class="pln">foo_bar</span></li>
<li></li>
<li><span class="kwd">func</span> <span class="pln">foo</span><span class="pun">(</span><span class="pun">)</span> <span class="pun">{</span></li>
<li> <span class="kwd">for</span> <span class="pln">_</span><span class="pun">,</span> <span class="pln">a</span> <span class="pun">:</span><span class="pun">=</span> <span class="pln">range</span> <span class="pln">foo</span> <span class="pun">{</span></li>
<li><span class="kwd">func</span> <span class="pln">foo</span><span class="pun">()</span> <span class="pun">{</span></li>
<li> <span class="kwd">for</span> <span class="pln">_</span><span class="pun">,</span> <span class="pln">a</span> <span class="pun">:=</span> <span class="pln">range</span> <span class="pln">foo</span> <span class="pun">{</span></li>
<li> <span class="pun">}</span></li>
<li><span class="pun">}</span></li>
<li></li>
Expand Down
2 changes: 1 addition & 1 deletion testdata/utf8.go.html
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,6 @@
<span class="com">// ᚷᛁᚠ᛫ᚻᛖ᛫ᚹᛁᛚᛖ᛫ᚠᚩᚱ᛫ᛞᚱᛁᚻᛏᚾᛖ᛫ᛞᚩᛗᛖᛋ᛫ᚻᛚᛇᛏᚪᚾ᛬</span>
<span class="kwd">var</span> <span class="typ">B</span> <span class="pun">=</span> <span class="str">&#34;Τὴ γλῶσσα μοῦ ἔδωσαν ἑλληνικὴ&#34;</span>

<span class="kwd">func</span> <span class="typ">F</span><span class="pun">(</span><span class="pun">)</span> <span class="pun">{</span>
<span class="kwd">func</span> <span class="typ">F</span><span class="pun">()</span> <span class="pun">{</span>
<span class="pln">fmt</span><span class="pun">.</span><span class="typ">Println</span><span class="pun">(</span><span class="typ">A</span><span class="pun">,</span> <span class="typ">B</span><span class="pun">)</span>
<span class="pun">}</span>
2 changes: 1 addition & 1 deletion testdata/utf8.go.ol.html
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
<li><span class="com">// ᚷᛁᚠ᛫ᚻᛖ᛫ᚹᛁᛚᛖ᛫ᚠᚩᚱ᛫ᛞᚱᛁᚻᛏᚾᛖ᛫ᛞᚩᛗᛖᛋ᛫ᚻᛚᛇᛏᚪᚾ᛬</span></li>
<li><span class="kwd">var</span> <span class="typ">B</span> <span class="pun">=</span> <span class="str">&#34;Τὴ γλῶσσα μοῦ ἔδωσαν ἑλληνικὴ&#34;</span></li>
<li></li>
<li><span class="kwd">func</span> <span class="typ">F</span><span class="pun">(</span><span class="pun">)</span> <span class="pun">{</span></li>
<li><span class="kwd">func</span> <span class="typ">F</span><span class="pun">()</span> <span class="pun">{</span></li>
<li> <span class="pln">fmt</span><span class="pun">.</span><span class="typ">Println</span><span class="pun">(</span><span class="typ">A</span><span class="pun">,</span> <span class="typ">B</span><span class="pun">)</span></li>
<li><span class="pun">}</span></li>
<li></li>
Expand Down