Merge pull request #23 from nickng/bibtex-comment

Bibtex comment support to make it play nice with JabRef

bibtex.y

@@ -24,7 +24,7 @@ var bib *BibTex // Only for holding current bib
 
 %token tCOMMENT tSTRING tPREAMBLE
 %token tATSIGN tCOLON tEQUAL tCOMMA tPOUND tLBRACE tRBRACE tDQUOTE tLPAREN tRPAREN
-%token <strval> tBAREIDENT tIDENT
+%token <strval> tBAREIDENT tIDENT tCOMMENTBODY
 %type <bibtex> bibtex
 %type <bibentry> bibentry
 %type <bibtag> tag stringentry
@@ -47,8 +47,7 @@ bibentry : tATSIGN tBAREIDENT tLBRACE tBAREIDENT tCOMMA tags tRBRACE { $$ = NewB
          | tATSIGN tBAREIDENT tLPAREN tBAREIDENT tCOMMA tags tRPAREN { $$ = NewBibEntry($2, $4); for _, t := range $6 { $$.AddField(t.key, t.val) } }
          ;
 
-commententry : tATSIGN tCOMMENT tLBRACE longstring tRBRACE {}
-             | tATSIGN tCOMMENT tLPAREN longstring tRBRACE {}
+commententry : tATSIGN tCOMMENT tCOMMENTBODY { }
              ;
 
 stringentry : tATSIGN tSTRING tLBRACE tBAREIDENT tEQUAL longstring tRBRACE { $$ = &bibTag{key: $4, val: $6 } }

bibtex_test.go

@@ -4,7 +4,7 @@ import (
 	"bytes"
 	"errors"
 	"fmt"
-	"io/ioutil"
+	"os"
 	"path/filepath"
 	"strings"
 	"testing"
@@ -71,7 +71,7 @@ func TestParser(t *testing.T) {
 
 	for _, ex := range examples {
 		t.Logf("Parsing example: %s", ex)
-		b, err := ioutil.ReadFile(ex)
+		b, err := os.ReadFile(ex)
 		if err != nil {
 			t.Errorf("Cannot read %s: %v", ex, err)
 		}
@@ -89,12 +89,13 @@ func TestMultiParse(t *testing.T) {
 		"example/simple.bib",
 		"example/simple.bib",
 		"example/simple.bib",
+		"example/simple2.bib", // simple but with comment
 	}
 
 	var bibs []*BibTex
 	for _, ex := range examples {
 		t.Logf("Parsing example: %s", ex)
-		b, err := ioutil.ReadFile(ex)
+		b, err := os.ReadFile(ex)
 		if err != nil {
 			t.Errorf("Cannot read %s: %v", ex, err)
 		}
@@ -122,7 +123,7 @@ func TestPrettyStringRoundTrip(t *testing.T) {
 
 	for _, ex := range examples {
 		// Read input.
-		b, err := ioutil.ReadFile(ex)
+		b, err := os.ReadFile(ex)
 		if err != nil {
 			t.Fatal(err)
 		}
@@ -148,7 +149,7 @@ func TestPrettyStringRoundTrip(t *testing.T) {
 
 func TestUnexpectedAtSign(t *testing.T) {
 	// Tests correct syntax but scanning error
-	b, err := ioutil.ReadFile("example/unexpected-at-sign.badbib")
+	b, err := os.ReadFile("example/unexpected-at-sign.badbib")
 	if err != nil {
 		t.Fatal(err)
 	}
@@ -191,7 +192,7 @@ func AssertEntriesEqual(t *testing.T, a, b *BibEntry) {
 }
 
 func BenchmarkStringPerformance(b *testing.B) {
-	exampleFileBytes, err := ioutil.ReadFile("example/biblatex-examples.bib")
+	exampleFileBytes, err := os.ReadFile("example/biblatex-examples.bib")
 	if err != nil {
 		b.Fatal(err)
 	}

docs.go

@@ -3,15 +3,15 @@
 // The package contains a simple parser and data structure to represent bibtex
 // records.
 //
-// Supported syntax
+// # Supported syntax
 //
 // The basic syntax is:
 //
-//     @BIBTYPE{IDENT,
-//         key1 = word,
-//         key2 = "quoted",
-//         key3 = {quoted},
-//     }
+//	@BIBTYPE{IDENT,
+//	    key1 = word,
+//	    key2 = "quoted",
+//	    key3 = {quoted},
+//	}
 //
 // where BIBTYPE is the type of document (e.g. inproceedings, article, etc.)
 // and IDENT is a string identifier.
@@ -20,5 +20,4 @@
 // found in the link below. If there are any problems, please file any issues
 // with a minimal working example at the GitHub repository.
 // http://maverick.inria.fr/~Xavier.Decoret/resources/xdkbibtex/bibtex_summary.html
-//
 package bibtex // import "github.com/nickng/bibtex"

example/simple2.bib

@@ -0,0 +1,16 @@
+@article{name,
+  year = 2016,
+  title = {SessionBasedBlah}
+}
+
+@comment{
+    this looks like an entry
+    but is actually a comment
+    even if the braces don't
+    balance it's still valid {}
+
+@inproceedings{ng2014,
+  title = "Blah",
+  author = "Me",
+  booktitle = "ABCD2014"
+}