-/*
-recfile -- GNU recutils'es recfiles parser on pure Go
-Copyright (C) 2020 Sergey Matveev <stargrave@stargrave.org>
-
-This program is free software: you can redistribute it and/or modify
-it under the terms of the GNU General Public License as published by
-the Free Software Foundation, version 3 of the License.
-
-This program is distributed in the hope that it will be useful,
-but WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-GNU General Public License for more details.
-
-You should have received a copy of the GNU General Public License
-along with this program. If not, see <http://www.gnu.org/licenses/>.
-*/
+// recfile -- GNU recutils'es recfiles parser on pure Go
+// Copyright (C) 2020-2024 Sergey Matveev <stargrave@stargrave.org>
+//
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, version 3 of the License.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with this program. If not, see <http://www.gnu.org/licenses/>.
package recfile
"bufio"
"errors"
"io"
- "regexp"
"strings"
)
scanner *bufio.Scanner
}
+// Create Reader for iterating through the records. It uses
+// bufio.Scanner, so can read more than currently parsed records take.
func NewReader(r io.Reader) *Reader {
return &Reader{bufio.NewScanner(r)}
}
-type Field struct {
- Name string
- Value string
+func getKeyValue(text string) (string, string) {
+ cols := strings.SplitN(text, ":", 2)
+ if len(cols) != 2 {
+ return "", ""
+ }
+ k := cols[0]
+ if len(k) == 0 {
+ return "", ""
+ }
+ if !((k[0] == '%') ||
+ ('a' <= k[0] && k[0] <= 'z') ||
+ ('A' <= k[0] && k[0] <= 'Z')) {
+ return "", ""
+ }
+ for _, c := range k[1:] {
+ if !((c == '_') ||
+ ('a' <= c && c <= 'z') ||
+ ('A' <= c && c <= 'Z') ||
+ ('0' <= c && c <= '9')) {
+ return "", ""
+ }
+ }
+ return k, strings.TrimPrefix(cols[1], " ")
}
-var KeyValRe = regexp.MustCompile(`([a-zA-Z%][a-zA-Z0-9_]*):\s*(.*)$`)
-
+// Get next record. Each record is just a collection of fields. io.EOF
+// is returned if there is nothing to read more.
func (r *Reader) Next() ([]Field, error) {
fields := make([]Field, 0, 1)
var text string
text = r.scanner.Text()
if continuation {
- if text[len(text)-1] == '\\' {
+ if len(text) == 0 {
+ continuation = false
+ } else if text[len(text)-1] == '\\' {
lines = append(lines, text[:len(text)-1])
} else {
lines = append(lines, text)
break
}
- matches := KeyValRe.FindStringSubmatch(text)
- if len(matches) == 0 {
+ name, line = getKeyValue(text)
+ if name == "" {
return fields, errors.New("invalid field format")
}
- name = matches[1]
- line = matches[2]
if len(line) > 0 && line[len(line)-1] == '\\' {
continuation = true
}
return fields, nil
}
+
+// Same as Next(), but with unique keys and last value.
+func (r *Reader) NextMap() (map[string]string, error) {
+ fields, err := r.Next()
+ if err != nil {
+ return nil, err
+ }
+ m := make(map[string]string, len(fields))
+ for _, f := range fields {
+ m[f.Name] = f.Value
+ }
+ return m, nil
+}
+
+// Same as Next(), but with unique keys and slices of values.
+func (r *Reader) NextMapWithSlice() (map[string][]string, error) {
+ fields, err := r.Next()
+ if err != nil {
+ return nil, err
+ }
+ m := make(map[string][]string)
+ for _, f := range fields {
+ m[f.Name] = append(m[f.Name], f.Value)
+ }
+ return m, nil
+}