Index: api/api.go ================================================================== --- api/api.go +++ api/api.go @@ -15,11 +15,11 @@ package api // ZettelID contains the identifier of a zettel. It is a string with 14 digits. type ZettelID string -// InvalidZID is an invalif zettel identifier +// InvalidZID is an invalid zettel identifier const InvalidZID = "" // IsValid returns true, if the idenfifier contains 14 digits. func (zid ZettelID) IsValid() bool { if len(zid) != 14 { Index: api/const.go ================================================================== --- api/const.go +++ api/const.go @@ -16,64 +16,78 @@ import "fmt" // Predefined Zettel Identifier const ( // System zettel - ZidVersion = ZettelID("00000000000001") - ZidHost = ZettelID("00000000000002") - ZidOperatingSystem = ZettelID("00000000000003") - ZidLicense = ZettelID("00000000000004") - ZidAuthors = ZettelID("00000000000005") - ZidDependencies = ZettelID("00000000000006") - ZidLog = ZettelID("00000000000007") - ZidBoxManager = ZettelID("00000000000020") - ZidMetadataKey = ZettelID("00000000000090") - ZidParser = ZettelID("00000000000092") - ZidStartupConfiguration = ZettelID("00000000000096") - ZidConfiguration = ZettelID("00000000000100") + ZidVersion = ZettelID("00000000000001") // -> 0001 + ZidHost = ZettelID("00000000000002") // -> 0002 + ZidOperatingSystem = ZettelID("00000000000003") // -> 0003 + ZidLicense = ZettelID("00000000000004") // -> 0004 + ZidAuthors = ZettelID("00000000000005") // -> 0005 + ZidDependencies = ZettelID("00000000000006") // -> 0006 + ZidLog = ZettelID("00000000000007") // -> 0007 + ZidMemory = ZettelID("00000000000008") // -> 0008 + ZidSx = ZettelID("00000000000009") // -> 0009 + ZidHTTP = ZettelID("00000000000010") // -> 000a + ZidAPI = ZettelID("00000000000011") // -> 000b + ZidWebUI = ZettelID("00000000000012") // -> 000c + ZidConsole = ZettelID("00000000000013") // -> 000d + ZidBoxManager = ZettelID("00000000000020") // -> 000e + ZidZettel = ZettelID("00000000000021") // -> 000f + ZidIndex = ZettelID("00000000000022") // -> 000g + ZidQuery = ZettelID("00000000000023") // -> 000h + ZidMetadataKey = ZettelID("00000000000090") // -> 000i + ZidParser = ZettelID("00000000000092") // -> 000j + ZidStartupConfiguration = ZettelID("00000000000096") // -> 000k + ZidConfiguration = ZettelID("00000000000100") // -> 000l + ZidDirectory = ZettelID("00000000000101") // -> 000m + ZidWarnings = ZettelID("00000000000102") // -> 000n // WebUI HTML templates are in the range 10000..19999 - ZidBaseTemplate = ZettelID("00000000010100") - ZidLoginTemplate = ZettelID("00000000010200") - ZidListTemplate = ZettelID("00000000010300") - ZidZettelTemplate = ZettelID("00000000010401") - ZidInfoTemplate = ZettelID("00000000010402") - ZidFormTemplate = ZettelID("00000000010403") - ZidRenameTemplate = ZettelID("00000000010404") - ZidDeleteTemplate = ZettelID("00000000010405") - ZidErrorTemplate = ZettelID("00000000010700") + ZidBaseTemplate = ZettelID("00000000010100") // -> 000s + ZidLoginTemplate = ZettelID("00000000010200") // -> 000t + ZidListTemplate = ZettelID("00000000010300") // -> 000u + ZidZettelTemplate = ZettelID("00000000010401") // -> 000v + ZidInfoTemplate = ZettelID("00000000010402") // -> 000w + ZidFormTemplate = ZettelID("00000000010403") // -> 000x + ZidRenameTemplate = ZettelID("00000000010404") // -> 001z + ZidDeleteTemplate = ZettelID("00000000010405") // -> 000y + ZidErrorTemplate = ZettelID("00000000010700") // -> 000z // WebUI sxn code zettel are in the range 19000..19999 - ZidSxnStart = ZettelID("00000000019000") - ZidSxnBase = ZettelID("00000000019990") + ZidSxnStart = ZettelID("00000000019000") // -> 000q + ZidSxnBase = ZettelID("00000000019990") // -> 000r // CSS-related zettel are in the range 20000..29999 - ZidBaseCSS = ZettelID("00000000020001") - ZidUserCSS = ZettelID("00000000025001") + ZidBaseCSS = ZettelID("00000000020001") // -> 0010 + ZidUserCSS = ZettelID("00000000025001") // -> 0011 // WebUI JS zettel are in the range 30000..39999 // WebUI image zettel are in the range 40000..49999 - ZidEmoji = ZettelID("00000000040001") + ZidEmoji = ZettelID("00000000040001") // -> 000o // Other sxn code zettel are in the range 50000..59999 - ZidSxnPrelude = ZettelID("00000000059900") + ZidSxnPrelude = ZettelID("00000000059900") // -> 000p // Predefined Zettelmarkup zettel are in the range 60000..69999 - ZidRoleZettelZettel = ZettelID("00000000060010") - ZidRoleConfigurationZettel = ZettelID("00000000060020") - ZidRoleRoleZettel = ZettelID("00000000060030") - ZidRoleTagZettel = ZettelID("00000000060040") + ZidRoleZettelZettel = ZettelID("00000000060010") // -> 0012 + ZidRoleConfigurationZettel = ZettelID("00000000060020") // -> 0013 + ZidRoleRoleZettel = ZettelID("00000000060030") // -> 0014 + ZidRoleTagZettel = ZettelID("00000000060040") // -> 0015 // Range 90000...99999 is reserved for zettel templates - ZidTOCNewTemplate = ZettelID("00000000090000") - ZidTemplateNewZettel = ZettelID("00000000090001") - ZidTemplateNewRole = ZettelID("00000000090004") - ZidTemplateNewTag = ZettelID("00000000090003") - ZidTemplateNewUser = ZettelID("00000000090002") + ZidTOCNewTemplate = ZettelID("00000000090000") // -> 0016 + ZidTemplateNewZettel = ZettelID("00000000090001") // -> 0017 + ZidTemplateNewRole = ZettelID("00000000090004") // -> 001a + ZidTemplateNewTag = ZettelID("00000000090003") // -> 0019 + ZidTemplateNewUser = ZettelID("00000000090002") // -> 0018 - ZidDefaultHome = ZettelID("00010000000000") + ZidSession = ZettelID("00009999999997") // -> 00zx + ZidAppDirectory = ZettelID("00009999999998") // -> 00zy + ZidMapping = ZettelID("00009999999999") // -> 00zz + ZidDefaultHome = ZettelID("00010000000000") // -> 0100 ) // LengthZid factors the constant length of a zettel identifier const LengthZid = len(ZidDefaultHome) Index: api/urlbuilder.go ================================================================== --- api/urlbuilder.go +++ api/urlbuilder.go @@ -11,144 +11,75 @@ // SPDX-FileCopyrightText: 2020-present Detlef Stern //----------------------------------------------------------------------------- package api -import ( - "net/url" - "strings" -) - -type urlQuery struct{ key, val string } +import "t73f.de/r/webs/urlbuilder" // URLBuilder should be used to create zettelstore URLs. type URLBuilder struct { - prefix string - key byte - rawLocal string - path []string - query []urlQuery - fragment string + base urlbuilder.URLBuilder + prefix string } // NewURLBuilder creates a new URL builder with the given prefix and key. func NewURLBuilder(prefix string, key byte) *URLBuilder { - return &URLBuilder{prefix: prefix, key: key} + for len(prefix) > 0 && prefix[len(prefix)-1] == '/' { + prefix = prefix[0 : len(prefix)-1] + } + result := URLBuilder{prefix: prefix} + if key != '/' { + result.base.AddPath(string([]byte{key})) + } + return &result } // Clone an URLBuilder func (ub *URLBuilder) Clone() *URLBuilder { cpy := new(URLBuilder) - cpy.key = ub.key - if len(ub.path) > 0 { - cpy.path = make([]string, 0, len(ub.path)) - cpy.path = append(cpy.path, ub.path...) - } - if len(ub.query) > 0 { - cpy.query = make([]urlQuery, 0, len(ub.query)) - cpy.query = append(cpy.query, ub.query...) - } - cpy.fragment = ub.fragment + ub.base.Copy(&cpy.base) + cpy.prefix = ub.prefix return cpy } -// SetRawLocal sets everything that follows the prefix / key. -func (ub *URLBuilder) SetRawLocal(rawLocal string) *URLBuilder { - for len(rawLocal) > 0 && rawLocal[0] == '/' { - rawLocal = rawLocal[1:] - } - ub.rawLocal = rawLocal - ub.path = nil - ub.query = nil - ub.fragment = "" - return ub -} - // SetZid sets the zettel identifier. func (ub *URLBuilder) SetZid(zid ZettelID) *URLBuilder { - if len(ub.path) > 0 { - panic("Cannot add Zid") - } - ub.rawLocal = "" - ub.path = append(ub.path, string(zid)) + ub.base.AddPath(string(zid)) return ub } // AppendPath adds a new path element func (ub *URLBuilder) AppendPath(p string) *URLBuilder { - ub.rawLocal = "" - for len(p) > 0 && p[0] == '/' { - p = p[1:] - } - if p != "" { - ub.path = append(ub.path, p) - } + ub.base.AddPath(p) return ub } // AppendKVQuery adds a new key/value query parameter func (ub *URLBuilder) AppendKVQuery(key, value string) *URLBuilder { - ub.rawLocal = "" - ub.query = append(ub.query, urlQuery{key, value}) + ub.base.AddQuery(key, value) return ub } // AppendQuery adds a new query func (ub *URLBuilder) AppendQuery(value string) *URLBuilder { if value != "" { - ub.rawLocal = "" - ub.query = append(ub.query, urlQuery{QueryKeyQuery, value}) + ub.base.AddQuery(QueryKeyQuery, value) } return ub } // ClearQuery removes all query parameters. func (ub *URLBuilder) ClearQuery() *URLBuilder { - ub.rawLocal = "" - ub.query = nil - ub.fragment = "" + ub.base.RemoveQueries() return ub } // SetFragment stores the fragment func (ub *URLBuilder) SetFragment(s string) *URLBuilder { - ub.rawLocal = "" - ub.fragment = s + ub.base.SetFragment(s) return ub } // String produces a string value. func (ub *URLBuilder) String() string { - var sb strings.Builder - - sb.WriteString(ub.prefix) - if ub.key != '/' { - sb.WriteByte(ub.key) - } - if ub.rawLocal != "" { - sb.WriteString(ub.rawLocal) - return sb.String() - } - for i, p := range ub.path { - if i > 0 || ub.key != '/' { - sb.WriteByte('/') - } - sb.WriteString(url.PathEscape(p)) - } - if len(ub.fragment) > 0 { - sb.WriteByte('#') - sb.WriteString(ub.fragment) - } - for i, q := range ub.query { - if i == 0 { - sb.WriteByte('?') - } else { - sb.WriteByte('&') - } - sb.WriteString(q.key) - if val := q.val; val != "" { - sb.WriteByte('=') - sb.WriteString(url.QueryEscape(val)) - } - } - return sb.String() + return ub.prefix + ub.base.String() } Index: attrs/attrs.go ================================================================== --- attrs/attrs.go +++ attrs/attrs.go @@ -15,11 +15,11 @@ package attrs import ( "strings" - "zettelstore.de/client.fossil/maps" + "t73f.de/r/zsc/maps" ) // Attributes store additional information about some node types. type Attributes map[string]string Index: attrs/attrs_test.go ================================================================== --- attrs/attrs_test.go +++ attrs/attrs_test.go @@ -14,11 +14,11 @@ package attrs_test import ( "testing" - "zettelstore.de/client.fossil/attrs" + "t73f.de/r/zsc/attrs" ) func TestHasDefault(t *testing.T) { t.Parallel() attr := attrs.Attributes{} Index: client/client.go ================================================================== --- client/client.go +++ client/client.go @@ -25,15 +25,15 @@ "net/url" "strconv" "strings" "time" - "zettelstore.de/client.fossil/api" - "zettelstore.de/client.fossil/sexp" - "zettelstore.de/client.fossil/sz" - "zettelstore.de/sx.fossil" - "zettelstore.de/sx.fossil/sxreader" + "t73f.de/r/sx" + "t73f.de/r/sx/sxreader" + "t73f.de/r/zsc/api" + "t73f.de/r/zsc/sexp" + "t73f.de/r/zsc/sz" ) // Client contains all data to execute requests. type Client struct { base string @@ -55,13 +55,10 @@ myURL.ForceQuery = false myURL.RawQuery = "" myURL.Fragment = "" myURL.RawFragment = "" base := myURL.String() - if !strings.HasSuffix(base, "/") { - base += "/" - } c := Client{ base: base, client: http.Client{ Timeout: 10 * time.Second, Transport: &http.Transport{ @@ -192,16 +189,16 @@ } vals, err := sexp.ParseList(obj, "ssi") if err != nil { return err } - token := string(vals[1].(sx.String)) + token := vals[1].(sx.String).GetValue() if len(token) < 4 { return fmt.Errorf("no valid token found: %q", token) } c.token = token - c.tokenType = string(vals[0].(sx.String)) + c.tokenType = vals[0].(sx.String).GetValue() c.expires = time.Now().Add(time.Duration(vals[2].(sx.Int64)*9/10) * time.Second) return nil } func (c *Client) updateToken(ctx context.Context) error { @@ -655,10 +652,12 @@ } return nil } // RenameZettel renames a zettel. +// +// This function is deprecated and will be removed in v0.19 (or later). func (c *Client) RenameZettel(ctx context.Context, oldZid, newZid api.ZettelID) error { ub := c.NewURLBuilder('z').SetZid(oldZid) h := http.Header{ api.HeaderDestination: {c.NewURLBuilder('z').SetZid(newZid).String()}, } @@ -699,11 +698,11 @@ return statusToError(resp) } return nil } -// GetVersionInfo returns version information.. +// GetVersionInfo returns version information. func (c *Client) GetVersionInfo(ctx context.Context) (VersionInfo, error) { resp, err := c.buildAndExecuteRequest(ctx, http.MethodGet, c.NewURLBuilder('x'), nil, nil) if err != nil { return VersionInfo{}, err } @@ -717,12 +716,12 @@ if vals, errVals := sexp.ParseList(obj, "iiiss"); errVals == nil { return VersionInfo{ Major: int(vals[0].(sx.Int64)), Minor: int(vals[1].(sx.Int64)), Patch: int(vals[2].(sx.Int64)), - Info: string(vals[3].(sx.String)), - Hash: string(vals[4].(sx.String)), + Info: vals[3].(sx.String).GetValue(), + Hash: vals[4].(sx.String).GetValue(), }, nil } } return VersionInfo{}, err } @@ -733,10 +732,28 @@ Minor int Patch int Info string Hash string } + +// GetApplicationZid returns the zettel identifier used to configure client +// application with the given name. +func (c *Client) GetApplicationZid(ctx context.Context, appname string) (api.ZettelID, error) { + mr, err := c.GetMetaData(ctx, api.ZidAppDirectory) + if err != nil { + return api.InvalidZID, err + } + key := appname + "-zid" + val, found := mr.Meta[key] + if !found { + return api.InvalidZID, fmt.Errorf("no application registered: %v", appname) + } + if zid := api.ZettelID(val); zid.IsValid() { + return zid, nil + } + return api.InvalidZID, fmt.Errorf("invalid identifier for application %v: %v", appname, val) +} // Get executes a GET request to the given URL and returns the read data. func (c *Client) Get(ctx context.Context, ub *api.URLBuilder) ([]byte, error) { resp, err := c.buildAndExecuteRequest(ctx, http.MethodGet, ub, nil, nil) if err != nil { Index: client/client_test.go ================================================================== --- client/client_test.go +++ client/client_test.go @@ -18,12 +18,12 @@ "flag" "net/http" "net/url" "testing" - "zettelstore.de/client.fossil/api" - "zettelstore.de/client.fossil/client" + "t73f.de/r/zsc/api" + "t73f.de/r/zsc/client" ) func TestZettelList(t *testing.T) { c := getClient() _, err := c.QueryZettel(context.Background(), "") Index: go.mod ================================================================== --- go.mod +++ go.mod @@ -1,5 +1,9 @@ -module zettelstore.de/client.fossil +module t73f.de/r/zsc go 1.22 -require zettelstore.de/sx.fossil v0.0.0-20240304124557-67e0a1799d1d +require ( + t73f.de/r/sx v0.0.0-20240513163553-ec4fcc6539ca + t73f.de/r/sxwebs v0.0.0-20240613142113-66fc5a284245 + t73f.de/r/webs v0.0.0-20240617100047-8730e9917915 +) Index: go.sum ================================================================== --- go.sum +++ go.sum @@ -1,2 +1,6 @@ -zettelstore.de/sx.fossil v0.0.0-20240304124557-67e0a1799d1d h1:Gl5ZmdNV5wJsNMIQYjAd/sWLq2ng4NP+eglWU7lQP+I= -zettelstore.de/sx.fossil v0.0.0-20240304124557-67e0a1799d1d/go.mod h1:/iGHxFXoo6GSV04PUkwaLuFrrCa5LMorxD73iLMAruI= +t73f.de/r/sx v0.0.0-20240513163553-ec4fcc6539ca h1:vvDqiuUfBLf+t/gpiSyqIFAdvZ7FLigOH38bqMY+v8k= +t73f.de/r/sx v0.0.0-20240513163553-ec4fcc6539ca/go.mod h1:G9pD1j2R6y9ZkPBb81mSnmwaAvTOg7r6jKp/OF7WeFA= +t73f.de/r/sxwebs v0.0.0-20240613142113-66fc5a284245 h1:raE7KUgoGsp2DzXOko9dDXEsSJ/VvoXCDYeICx7i6uo= +t73f.de/r/sxwebs v0.0.0-20240613142113-66fc5a284245/go.mod h1:ErPBVUyE2fOktL/8M7lp/PR93wP/o9RawMajB1uSqj8= +t73f.de/r/webs v0.0.0-20240617100047-8730e9917915 h1:rwUaPBIH3shrUIkmw51f4RyCplsCU+ISZHailsLiHTE= +t73f.de/r/webs v0.0.0-20240617100047-8730e9917915/go.mod h1:UGAAtul0TK5ACeZ6zTS3SX6GqwMFXxlUpHiV8oqNq5w= Index: input/entity_test.go ================================================================== --- input/entity_test.go +++ input/entity_test.go @@ -14,11 +14,11 @@ package input_test import ( "testing" - "zettelstore.de/client.fossil/input" + "t73f.de/r/zsc/input" ) func TestScanEntity(t *testing.T) { t.Parallel() var testcases = []struct { Index: input/input_test.go ================================================================== --- input/input_test.go +++ input/input_test.go @@ -15,11 +15,11 @@ package input_test import ( "testing" - "zettelstore.de/client.fossil/input" + "t73f.de/r/zsc/input" ) func TestEatEOL(t *testing.T) { t.Parallel() inp := input.NewInput(nil) Index: maps/maps_test.go ================================================================== --- maps/maps_test.go +++ maps/maps_test.go @@ -14,11 +14,11 @@ package maps_test import ( "testing" - "zettelstore.de/client.fossil/maps" + "t73f.de/r/zsc/maps" ) func isSorted(seq []string) bool { for i := 1; i < len(seq); i++ { if seq[i] < seq[i-1] { Index: sexp/sexp.go ================================================================== --- sexp/sexp.go +++ sexp/sexp.go @@ -18,22 +18,22 @@ import ( "errors" "fmt" "sort" - "zettelstore.de/client.fossil/api" - "zettelstore.de/sx.fossil" + "t73f.de/r/sx" + "t73f.de/r/zsc/api" ) // EncodeZettel transforms zettel data into a sx object. func EncodeZettel(zettel api.ZettelData) sx.Object { return sx.MakeList( sx.MakeSymbol("zettel"), meta2sz(zettel.Meta), sx.MakeList(sx.MakeSymbol("rights"), sx.Int64(int64(zettel.Rights))), - sx.MakeList(sx.MakeSymbol("encoding"), sx.String(zettel.Encoding)), - sx.MakeList(sx.MakeSymbol("content"), sx.String(zettel.Content)), + sx.MakeList(sx.MakeSymbol("encoding"), sx.MakeString(zettel.Encoding)), + sx.MakeList(sx.MakeSymbol("content"), sx.MakeString(zettel.Content)), ) } func ParseZettel(obj sx.Object) (api.ZettelData, error) { vals, err := ParseList(obj, "ypppp") @@ -71,12 +71,12 @@ } return api.ZettelData{ Meta: meta, Rights: rights, - Encoding: string(encVals[1].(sx.String)), - Content: string(contentVals[1].(sx.String)), + Encoding: encVals[1].(sx.String).GetValue(), + Content: contentVals[1].(sx.String).GetValue(), }, nil } // EncodeMetaRights translates metadata/rights into a sx object. func EncodeMetaRights(mr api.MetaRights) *sx.Pair { @@ -94,11 +94,11 @@ for k := range m { keys = append(keys, k) } sort.Strings(keys) for _, k := range keys { - val := sx.MakeList(sx.MakeSymbol(k), sx.String(m[k])) + val := sx.MakeList(sx.MakeSymbol(k), sx.MakeString(m[k])) result.Add(val) } return result.List() } @@ -111,11 +111,11 @@ for node := pair.Tail(); node != nil; node = node.Tail() { mVals, err := ParseList(node.Car(), "ys") if err != nil { return nil, err } - res[(mVals[0].(*sx.Symbol)).GetValue()] = string(mVals[1].(sx.String)) + res[(mVals[0].(*sx.Symbol)).GetValue()] = mVals[1].(sx.String).GetValue() } return res, nil } // ParseRights returns the rights values of the given object. Index: sexp/sexp_test.go ================================================================== --- sexp/sexp_test.go +++ sexp/sexp_test.go @@ -14,16 +14,16 @@ package sexp_test import ( "testing" - "zettelstore.de/client.fossil/sexp" - "zettelstore.de/sx.fossil" + "t73f.de/r/sx" + "t73f.de/r/zsc/sexp" ) func TestParseObject(t *testing.T) { - if elems, err := sexp.ParseList(sx.String("a"), "s"); err == nil { + if elems, err := sexp.ParseList(sx.MakeString("a"), "s"); err == nil { t.Error("expected an error, but got: ", elems) } if elems, err := sexp.ParseList(sx.Nil(), ""); err != nil { t.Error(err) } else if len(elems) != 0 { @@ -31,27 +31,27 @@ } if elems, err := sexp.ParseList(sx.Nil(), "b"); err == nil { t.Error("expected error, but got: ", elems) } - if elems, err := sexp.ParseList(sx.MakeList(sx.String("a")), "ss"); err == nil { + if elems, err := sexp.ParseList(sx.MakeList(sx.MakeString("a")), "ss"); err == nil { t.Error("expected error, but got: ", elems) } - if elems, err := sexp.ParseList(sx.MakeList(sx.String("a")), ""); err == nil { + if elems, err := sexp.ParseList(sx.MakeList(sx.MakeString("a")), ""); err == nil { t.Error("expected error, but got: ", elems) } - if _, err := sexp.ParseList(sx.MakeList(sx.String("a")), "b"); err != nil { + if _, err := sexp.ParseList(sx.MakeList(sx.MakeString("a")), "b"); err != nil { t.Error("expected [1], but got error: ", err) } - if elems, err := sexp.ParseList(sx.Cons(sx.Nil(), sx.String("a")), "ps"); err == nil { + if elems, err := sexp.ParseList(sx.Cons(sx.Nil(), sx.MakeString("a")), "ps"); err == nil { t.Error("expected error, but got: ", elems) } - if elems, err := sexp.ParseList(sx.MakeList(sx.String("a")), "s"); err != nil { + if elems, err := sexp.ParseList(sx.MakeList(sx.MakeString("a")), "s"); err != nil { t.Error(err) } else if len(elems) != 1 { t.Error("length == 1, but got: ", elems) } else { _ = elems[0].(sx.String) } } Index: shtml/const.go ================================================================== --- shtml/const.go +++ shtml/const.go @@ -11,11 +11,11 @@ // SPDX-FileCopyrightText: 2024-present Detlef Stern //----------------------------------------------------------------------------- package shtml -import "zettelstore.de/sx.fossil" +import "t73f.de/r/sx" // Symbols for HTML header tags var ( SymBody = sx.MakeSymbol("body") SymHead = sx.MakeSymbol("head") Index: shtml/shtml.go ================================================================== --- shtml/shtml.go +++ shtml/shtml.go @@ -18,16 +18,16 @@ "fmt" "net/url" "strconv" "strings" - "zettelstore.de/client.fossil/api" - "zettelstore.de/client.fossil/attrs" - "zettelstore.de/client.fossil/sz" - "zettelstore.de/client.fossil/text" - "zettelstore.de/sx.fossil" - "zettelstore.de/sx.fossil/sxhtml" + "t73f.de/r/sx" + "t73f.de/r/sxwebs/sxhtml" + "t73f.de/r/zsc/api" + "t73f.de/r/zsc/attrs" + "t73f.de/r/zsc/sz" + "t73f.de/r/zsc/text" ) // Evaluator will transform a s-expression that encodes the zettel AST into an s-expression // that represents HTML. type Evaluator struct { @@ -67,11 +67,11 @@ plist := sx.Nil() keys := a.Keys() for i := len(keys) - 1; i >= 0; i-- { key := keys[i] if key != attrs.DefaultAttribute && tr.IsValidName(key) { - plist = plist.Cons(sx.Cons(sx.MakeSymbol(key), sx.String(a[key]))) + plist = plist.Cons(sx.Cons(sx.MakeSymbol(key), sx.MakeString(a[key]))) } } if plist == nil { return nil } @@ -122,32 +122,32 @@ return nil } var result sx.ListBuilder result.Add(SymOL) - result.Add(sx.Nil().Cons(sx.Cons(SymAttrClass, sx.String("zs-endnotes"))).Cons(sxhtml.SymAttr)) + result.Add(sx.Nil().Cons(sx.Cons(SymAttrClass, sx.MakeString("zs-endnotes"))).Cons(sxhtml.SymAttr)) for i, fni := range env.endnotes { noteNum := strconv.Itoa(i + 1) - attrs := fni.attrs.Cons(sx.Cons(SymAttrClass, sx.String("zs-endnote"))). - Cons(sx.Cons(SymAttrValue, sx.String(noteNum))). - Cons(sx.Cons(SymAttrId, sx.String("fn:"+fni.noteID))). - Cons(sx.Cons(SymAttrRole, sx.String("doc-endnote"))). + attrs := fni.attrs.Cons(sx.Cons(SymAttrClass, sx.MakeString("zs-endnote"))). + Cons(sx.Cons(SymAttrValue, sx.MakeString(noteNum))). + Cons(sx.Cons(SymAttrId, sx.MakeString("fn:"+fni.noteID))). + Cons(sx.Cons(SymAttrRole, sx.MakeString("doc-endnote"))). Cons(sxhtml.SymAttr) - backref := sx.Nil().Cons(sx.String("\u21a9\ufe0e")). + backref := sx.Nil().Cons(sx.MakeString("\u21a9\ufe0e")). Cons(sx.Nil(). - Cons(sx.Cons(SymAttrClass, sx.String("zs-endnote-backref"))). - Cons(sx.Cons(SymAttrHref, sx.String("#fnref:"+fni.noteID))). - Cons(sx.Cons(SymAttrRole, sx.String("doc-backlink"))). + Cons(sx.Cons(SymAttrClass, sx.MakeString("zs-endnote-backref"))). + Cons(sx.Cons(SymAttrHref, sx.MakeString("#fnref:"+fni.noteID))). + Cons(sx.Cons(SymAttrRole, sx.MakeString("doc-backlink"))). Cons(sxhtml.SymAttr)). Cons(SymA) var li sx.ListBuilder li.Add(SymLI) li.Add(attrs) li.ExtendBang(fni.noteHx) - li.Add(sx.String(" ")) + li.Add(sx.MakeString(" ")) li.Add(backref) result.Add(li.List()) } return result.List() } @@ -238,11 +238,11 @@ func (ev *Evaluator) bindMetadata() { ev.bind(sz.SymMeta, 0, ev.evalList) evalMetaString := func(args sx.Vector, env *Environment) sx.Object { a := make(attrs.Attributes, 2). Set("name", ev.getSymbol(args[0], env).GetValue()). - Set("content", string(getString(args[1], env))) + Set("content", getString(args[1], env).GetValue()) return ev.EvaluateMeta(a) } ev.bind(sz.SymTypeCredential, 2, evalMetaString) ev.bind(sz.SymTypeEmpty, 2, evalMetaString) ev.bind(sz.SymTypeID, 2, evalMetaString) @@ -254,11 +254,11 @@ evalMetaSet := func(args sx.Vector, env *Environment) sx.Object { var sb strings.Builder for elem := getList(args[1], env); elem != nil; elem = elem.Tail() { sb.WriteByte(' ') - sb.WriteString(string(getString(elem.Car(), env))) + sb.WriteString(getString(elem.Car(), env).GetValue()) } s := sb.String() if len(s) > 0 { s = s[1:] } @@ -297,21 +297,21 @@ headingSymbol := sx.MakeSymbol("h" + level) a := ev.GetAttributes(args[1], env) env.pushAttributes(a) defer env.popAttributes() - if fragment := string(getString(args[3], env)); fragment != "" { + if fragment := getString(args[3], env).GetValue(); fragment != "" { a = a.Set("id", ev.unique+fragment) } if result, _ := ev.EvaluateList(args[4:], env); result != nil { if len(a) > 0 { result = result.Cons(ev.EvaluateAttrbute(a)) } return result.Cons(headingSymbol) } - return sx.MakeList(headingSymbol, sx.String("")) + return sx.MakeList(headingSymbol, sx.MakeString("")) }) ev.bind(sz.SymThematic, 0, func(args sx.Vector, env *Environment) sx.Object { result := sx.Nil() if len(args) > 0 { if attrList := getList(args[0], env); attrList != nil { @@ -397,11 +397,11 @@ ev.bind(sz.SymRegionVerse, 2, ev.makeRegionFn(SymDIV, false)) ev.bind(sz.SymVerbatimComment, 1, func(args sx.Vector, env *Environment) sx.Object { if ev.GetAttributes(args[0], env).HasDefault() { if len(args) > 1 { - if s := getString(args[1], env); s != "" { + if s := getString(args[1], env); s.GetValue() != "" { return sx.Nil().Cons(s).Cons(sxhtml.SymBlockComment) } } } return nil @@ -415,11 +415,11 @@ }) ev.bind(sz.SymVerbatimProg, 2, func(args sx.Vector, env *Environment) sx.Object { a := ev.GetAttributes(args[0], env) content := getString(args[1], env) if a.HasDefault() { - content = sx.String(visibleReplacer.Replace(string(content))) + content = sx.MakeString(visibleReplacer.Replace(content.GetValue())) } return ev.evalVerbatim(a, content) }) ev.bind(sz.SymVerbatimZettel, 0, nilFn) ev.bind(sz.SymBLOB, 3, func(args sx.Vector, env *Environment) sx.Object { @@ -432,20 +432,20 @@ } refKind := ref.Car() if sx.IsNil(refKind) { return sx.Nil() } - if refValue := getString(ref.Tail().Car(), env); refValue != "" { + if refValue := getString(ref.Tail().Car(), env); refValue.GetValue() != "" { if refSym, isRefSym := sx.GetSymbol(refKind); isRefSym && refSym.IsEqual(sz.SymRefStateExternal) { - a := ev.GetAttributes(args[0], env).Set("src", string(refValue)).AddClass("external") + a := ev.GetAttributes(args[0], env).Set("src", refValue.GetValue()).AddClass("external") return sx.Nil().Cons(sx.Nil().Cons(ev.EvaluateAttrbute(a)).Cons(SymIMG)).Cons(SymP) } return sx.MakeList( sxhtml.SymInlineComment, - sx.String("transclude"), + sx.MakeString("transclude"), refKind, - sx.String("->"), + sx.MakeString("->"), refValue, ) } return ev.evalSlice(args, env) }) @@ -536,17 +536,11 @@ } func (ev *Evaluator) bindInlines() { ev.bind(sz.SymInline, 0, ev.evalList) ev.bind(sz.SymText, 1, func(args sx.Vector, env *Environment) sx.Object { return getString(args[0], env) }) - ev.bind(sz.SymSpace, 0, func(args sx.Vector, env *Environment) sx.Object { - if len(args) == 0 { - return sx.String(" ") - } - return getString(args[0], env) - }) - ev.bind(sz.SymSoft, 0, func(sx.Vector, *Environment) sx.Object { return sx.String(" ") }) + ev.bind(sz.SymSoft, 0, func(sx.Vector, *Environment) sx.Object { return sx.MakeString(" ") }) ev.bind(sz.SymHard, 0, func(sx.Vector, *Environment) sx.Object { return sx.Nil().Cons(symBR) }) ev.bind(sz.SymLinkInvalid, 2, func(args sx.Vector, env *Environment) sx.Object { a := ev.GetAttributes(args[0], env) env.pushAttributes(a) @@ -563,11 +557,11 @@ evalHREF := func(args sx.Vector, env *Environment) sx.Object { a := ev.GetAttributes(args[0], env) env.pushAttributes(a) defer env.popAttributes() refValue := getString(args[1], env) - return ev.evalLink(a.Set("href", string(refValue)), refValue, args[2:], env) + return ev.evalLink(a.Set("href", refValue.GetValue()), refValue, args[2:], env) } ev.bind(sz.SymLinkZettel, 2, evalHREF) ev.bind(sz.SymLinkSelf, 2, evalHREF) ev.bind(sz.SymLinkFound, 2, evalHREF) ev.bind(sz.SymLinkBroken, 2, func(args sx.Vector, env *Environment) sx.Object { @@ -582,29 +576,29 @@ ev.bind(sz.SymLinkQuery, 2, func(args sx.Vector, env *Environment) sx.Object { a := ev.GetAttributes(args[0], env) env.pushAttributes(a) defer env.popAttributes() refValue := getString(args[1], env) - query := "?" + api.QueryKeyQuery + "=" + url.QueryEscape(string(refValue)) + query := "?" + api.QueryKeyQuery + "=" + url.QueryEscape(refValue.GetValue()) return ev.evalLink(a.Set("href", query), refValue, args[2:], env) }) ev.bind(sz.SymLinkExternal, 2, func(args sx.Vector, env *Environment) sx.Object { a := ev.GetAttributes(args[0], env) env.pushAttributes(a) defer env.popAttributes() refValue := getString(args[1], env) - return ev.evalLink(a.Set("href", string(refValue)).AddClass("external"), refValue, args[2:], env) + return ev.evalLink(a.Set("href", refValue.GetValue()).AddClass("external"), refValue, args[2:], env) }) ev.bind(sz.SymEmbed, 3, func(args sx.Vector, env *Environment) sx.Object { ref := getList(args[1], env) - syntax := getString(args[2], env) + syntax := getString(args[2], env).GetValue() if syntax == api.ValueSyntaxSVG { embedAttr := sx.MakeList( sxhtml.SymAttr, - sx.Cons(SymAttrType, sx.String("image/svg+xml")), - sx.Cons(SymAttrSrc, sx.String("/"+string(getString(ref.Tail(), env))+".svg")), + sx.Cons(SymAttrType, sx.MakeString("image/svg+xml")), + sx.Cons(SymAttrSrc, sx.MakeString("/"+getString(ref.Tail(), env).GetValue()+".svg")), ) return sx.MakeList( SymFIGURE, sx.MakeList( SymEMBED, @@ -611,11 +605,11 @@ embedAttr, ), ) } a := ev.GetAttributes(args[0], env) - a = a.Set("src", string(getString(ref.Tail().Car(), env))) + a = a.Set("src", getString(ref.Tail().Car(), env).GetValue()) if len(args) > 3 { var sb strings.Builder flattenText(&sb, sx.MakeList(args[3:]...)) if d := sb.String(); d != "" { a = a.Set("alt", d) @@ -628,11 +622,11 @@ summary, hasSummary := a.Get(api.KeySummary) if !hasSummary { summary = "" } return ev.evalBLOB( - sx.MakeList(sxhtml.SymListSplice, sx.String(summary)), + sx.MakeList(sxhtml.SymListSplice, sx.MakeString(summary)), syntax, data, ) }) @@ -639,13 +633,13 @@ ev.bind(sz.SymCite, 2, func(args sx.Vector, env *Environment) sx.Object { a := ev.GetAttributes(args[0], env) env.pushAttributes(a) defer env.popAttributes() result := sx.Nil() - if key := getString(args[1], env); key != "" { + if key := getString(args[1], env); key.GetValue() != "" { if len(args) > 2 { - result = ev.evalSlice(args[2:], env).Cons(sx.String(", ")) + result = ev.evalSlice(args[2:], env).Cons(sx.MakeString(", ")) } result = result.Cons(key) } if len(a) > 0 { result = result.Cons(ev.EvaluateAttrbute(a)) @@ -656,12 +650,12 @@ return result.Cons(SymSPAN) }) ev.bind(sz.SymMark, 3, func(args sx.Vector, env *Environment) sx.Object { result := ev.evalSlice(args[3:], env) if !ev.noLinks { - if fragment := getString(args[2], env); fragment != "" { - a := attrs.Attributes{"id": string(fragment) + ev.unique} + if fragment := getString(args[2], env).GetValue(); fragment != "" { + a := attrs.Attributes{"id": fragment + ev.unique} return result.Cons(ev.EvaluateAttrbute(a)).Cons(SymA) } } return result.Cons(SymSPAN) }) @@ -678,16 +672,16 @@ noteNum := strconv.Itoa(len(env.endnotes) + 1) noteID := ev.unique + noteNum env.endnotes = append(env.endnotes, endnoteInfo{ noteID: noteID, noteAST: args[1:], noteHx: nil, attrs: attrPlist}) - hrefAttr := sx.Nil().Cons(sx.Cons(SymAttrRole, sx.String("doc-noteref"))). - Cons(sx.Cons(SymAttrHref, sx.String("#fn:"+noteID))). - Cons(sx.Cons(SymAttrClass, sx.String("zs-noteref"))). + hrefAttr := sx.Nil().Cons(sx.Cons(SymAttrRole, sx.MakeString("doc-noteref"))). + Cons(sx.Cons(SymAttrHref, sx.MakeString("#fn:"+noteID))). + Cons(sx.Cons(SymAttrClass, sx.MakeString("zs-noteref"))). Cons(sxhtml.SymAttr) - href := sx.Nil().Cons(sx.String(noteNum)).Cons(hrefAttr).Cons(SymA) - supAttr := sx.Nil().Cons(sx.Cons(SymAttrId, sx.String("fnref:"+noteID))).Cons(sxhtml.SymAttr) + href := sx.Nil().Cons(sx.MakeString(noteNum)).Cons(hrefAttr).Cons(SymA) + supAttr := sx.Nil().Cons(sx.Cons(SymAttrId, sx.MakeString("fnref:"+noteID))).Cons(sxhtml.SymAttr) return sx.Nil().Cons(href).Cons(supAttr).Cons(symSUP) }) ev.bind(sz.SymFormatDelete, 1, ev.makeFormatFn(symDEL)) ev.bind(sz.SymFormatEmph, 1, ev.makeFormatFn(symEM)) @@ -700,11 +694,11 @@ ev.bind(sz.SymFormatSuper, 1, ev.makeFormatFn(symSUP)) ev.bind(sz.SymLiteralComment, 1, func(args sx.Vector, env *Environment) sx.Object { if ev.GetAttributes(args[0], env).HasDefault() { if len(args) > 1 { - if s := getString(ev.Eval(args[1], env), env); s != "" { + if s := getString(ev.Eval(args[1], env), env); s.GetValue() != "" { return sx.Nil().Cons(s).Cons(sxhtml.SymInlineComment) } } } return sx.Nil() @@ -791,18 +785,18 @@ res := ev.evalSlice(args[1:], env) env.quoteNesting-- lastPair := res.LastPair() if lastPair.IsNil() { - res = sx.Cons(sx.MakeList(sxhtml.SymNoEscape, sx.String(leftQ), sx.String(rightQ)), sx.Nil()) + res = sx.Cons(sx.MakeList(sxhtml.SymNoEscape, sx.MakeString(leftQ), sx.MakeString(rightQ)), sx.Nil()) } else { if quotes.nbsp { - lastPair.AppendBang(sx.MakeList(sxhtml.SymNoEscape, sx.String(" "), sx.String(rightQ))) - res = res.Cons(sx.MakeList(sxhtml.SymNoEscape, sx.String(leftQ), sx.String(" "))) + lastPair.AppendBang(sx.MakeList(sxhtml.SymNoEscape, sx.MakeString(" "), sx.MakeString(rightQ))) + res = res.Cons(sx.MakeList(sxhtml.SymNoEscape, sx.MakeString(leftQ), sx.MakeString(" "))) } else { - lastPair.AppendBang(sx.MakeList(sxhtml.SymNoEscape, sx.String(rightQ))) - res = res.Cons(sx.MakeList(sxhtml.SymNoEscape, sx.String(leftQ))) + lastPair.AppendBang(sx.MakeList(sxhtml.SymNoEscape, sx.MakeString(rightQ))) + res = res.Cons(sx.MakeList(sxhtml.SymNoEscape, sx.MakeString(leftQ))) } } if len(a) > 0 { res = res.Cons(ev.EvaluateAttrbute(a)) return res.Cons(SymSPAN) @@ -815,16 +809,16 @@ func (ev *Evaluator) evalLiteral(args sx.Vector, a attrs.Attributes, sym *sx.Symbol, env *Environment) sx.Object { if a == nil { a = ev.GetAttributes(args[0], env) } a = setProgLang(a) - literal := string(getString(args[1], env)) + literal := getString(args[1], env).GetValue() if a.HasDefault() { a = a.RemoveDefault() literal = visibleReplacer.Replace(literal) } - res := sx.Nil().Cons(sx.String(literal)) + res := sx.Nil().Cons(sx.MakeString(literal)) if len(a) > 0 { res = res.Cons(ev.EvaluateAttrbute(a)) } return res.Cons(sym) } @@ -834,46 +828,41 @@ } return a } func (ev *Evaluator) evalHTML(args sx.Vector, env *Environment) sx.Object { - if s := getString(ev.Eval(args[1], env), env); s != "" && IsSafe(string(s)) { + if s := getString(ev.Eval(args[1], env), env); s.GetValue() != "" && IsSafe(s.GetValue()) { return sx.Nil().Cons(s).Cons(sxhtml.SymNoEscape) } return nil } func (ev *Evaluator) evalBLOB(description *sx.Pair, syntax, data sx.String) sx.Object { - if data == "" { + if data.GetValue() == "" { return sx.Nil() } - switch syntax { + switch syntax.GetValue() { case "": return sx.Nil() case api.ValueSyntaxSVG: return sx.Nil().Cons(sx.Nil().Cons(data).Cons(sxhtml.SymNoEscape)).Cons(SymP) default: - imgAttr := sx.Nil().Cons(sx.Cons(SymAttrSrc, sx.String("data:image/"+string(syntax)+";base64,"+string(data)))) + imgAttr := sx.Nil().Cons(sx.Cons(SymAttrSrc, sx.MakeString("data:image/"+syntax.GetValue()+";base64,"+data.GetValue()))) var sb strings.Builder flattenText(&sb, description) if d := sb.String(); d != "" { - imgAttr = imgAttr.Cons(sx.Cons(symAttrAlt, sx.String(d))) + imgAttr = imgAttr.Cons(sx.Cons(symAttrAlt, sx.MakeString(d))) } return sx.Nil().Cons(sx.Nil().Cons(imgAttr.Cons(sxhtml.SymAttr)).Cons(SymIMG)).Cons(SymP) } } func flattenText(sb *strings.Builder, lst *sx.Pair) { for elem := lst; elem != nil; elem = elem.Tail() { switch obj := elem.Car().(type) { case sx.String: - sb.WriteString(string(obj)) - case *sx.Symbol: - if obj.IsEqual(sz.SymSpace) { - sb.WriteByte(' ') - break - } + sb.WriteString(obj.GetValue()) case *sx.Pair: flattenText(sb, obj) } } } @@ -973,17 +962,17 @@ } return sx.MakeSymbol("???") } func getString(val sx.Object, env *Environment) sx.String { if env.err != nil { - return "" + return sx.String{} } if s, ok := sx.GetString(val); ok { return s } env.err = fmt.Errorf("%v/%T is not a string", val, val) - return "" + return sx.String{} } func getList(val sx.Object, env *Environment) *sx.Pair { if env.err == nil { if res, isPair := sx.GetPair(val); isPair { return res Index: sz/const.go ================================================================== --- sz/const.go +++ sz/const.go @@ -11,190 +11,98 @@ // SPDX-FileCopyrightText: 2022-present Detlef Stern //----------------------------------------------------------------------------- package sz -import "zettelstore.de/sx.fossil" +import "t73f.de/r/sx" // Various constants for Zettel data. Some of them are technically variables. -const ( - // Symbols for Metanodes - NameBlock = "BLOCK" - NameInline = "INLINE" - NameMeta = "META" - - // Symbols for Zettel noMakede types. - NameBLOB = "BLOB" - NameCell = "CELL" - NameCellCenter = "CELL-CENTER" - NameCellLeft = "CELL-LEFT" - NameCellRight = "CELL-RIGHT" - NameCite = "CITE" - NameDescription = "DESCRIPTION" - NameEmbed = "EMBED" - NameEmbedBLOB = "EMBED-BLOB" - NameEndnote = "ENDNOTE" - NameFormatEmph = "FORMAT-EMPH" - NameFormatDelete = "FORMAT-DELETE" - NameFormatInsert = "FORMAT-INSERT" - NameFormatMark = "FORMAT-MARK" - NameFormatQuote = "FORMAT-QUOTE" - NameFormatSpan = "FORMAT-SPAN" - NameFormatSub = "FORMAT-SUB" - NameFormatSuper = "FORMAT-SUPER" - NameFormatStrong = "FORMAT-STRONG" - NameHard = "HARD" - NameHeading = "HEADING" - NameLinkInvalid = "LINK-INVALID" - NameLinkZettel = "LINK-ZETTEL" - NameLinkSelf = "LINK-SELF" - NameLinkFound = "LINK-FOUND" - NameLinkBroken = "LINK-BROKEN" - NameLinkHosted = "LINK-HOSTED" - NameLinkBased = "LINK-BASED" - NameLinkQuery = "LINK-QUERY" - NameLinkExternal = "LINK-EXTERNAL" - NameListOrdered = "ORDERED" - NameListUnordered = "UNORDERED" - NameListQuote = "QUOTATION" - NameLiteralProg = "LITERAL-CODE" - NameLiteralComment = "LITERAL-COMMENT" - NameLiteralHTML = "LITERAL-HTML" - NameLiteralInput = "LITERAL-INPUT" - NameLiteralMath = "LITERAL-MATH" - NameLiteralOutput = "LITERAL-OUTPUT" - NameLiteralZettel = "LITERAL-ZETTEL" - NameMark = "MARK" - NamePara = "PARA" - NameRegionBlock = "REGION-BLOCK" - NameRegionQuote = "REGION-QUOTE" - NameRegionVerse = "REGION-VERSE" - NameSoft = "SOFT" - NameSpace = "SPACE" - NameTable = "TABLE" - NameText = "TEXT" - NameThematic = "THEMATIC" - NameTransclude = "TRANSCLUDE" - NameUnknown = "UNKNOWN-NODE" - NameVerbatimComment = "VERBATIM-COMMENT" - NameVerbatimEval = "VERBATIM-EVAL" - NameVerbatimHTML = "VERBATIM-HTML" - NameVerbatimMath = "VERBATIM-MATH" - NameVerbatimProg = "VERBATIM-CODE" - NameVerbatimZettel = "VERBATIM-ZETTEL" - - // Constant symbols for reference states. - NameRefStateInvalid = "INVALID" - NameRefStateZettel = "ZETTEL" - NameRefStateSelf = "SELF" - NameRefStateFound = "FOUND" - NameRefStateBroken = "BROKEN" - NameRefStateHosted = "HOSTED" - NameRefStateBased = "BASED" - NameRefStateQuery = "QUERY" - NameRefStateExternal = "EXTERNAL" - - // Symbols for metadata types. - NameTypeCredential = "CREDENTIAL" - NameTypeEmpty = "EMPTY-STRING" - NameTypeID = "ZID" - NameTypeIDSet = "ZID-SET" - NameTypeNumber = "NUMBER" - NameTypeString = "STRING" - NameTypeTagSet = "TAG-SET" - NameTypeTimestamp = "TIMESTAMP" - NameTypeURL = "URL" - NameTypeWord = "WORD" - NameTypeZettelmarkup = "ZETTELMARKUP" -) - -var ( - // Symbols for Metanodes - SymBlock = sx.MakeSymbol(NameBlock) - SymInline = sx.MakeSymbol(NameInline) - SymMeta = sx.MakeSymbol(NameMeta) - - // Symbols for Zettel noMakede types. - SymBLOB = sx.MakeSymbol(NameBLOB) - SymCell = sx.MakeSymbol(NameCell) - SymCellCenter = sx.MakeSymbol(NameCellCenter) - SymCellLeft = sx.MakeSymbol(NameCellLeft) - SymCellRight = sx.MakeSymbol(NameCellRight) - SymCite = sx.MakeSymbol(NameCite) - SymDescription = sx.MakeSymbol(NameDescription) - SymEmbed = sx.MakeSymbol(NameEmbed) - SymEmbedBLOB = sx.MakeSymbol(NameEmbedBLOB) - SymEndnote = sx.MakeSymbol(NameEndnote) - SymFormatEmph = sx.MakeSymbol(NameFormatEmph) - SymFormatDelete = sx.MakeSymbol(NameFormatDelete) - SymFormatInsert = sx.MakeSymbol(NameFormatInsert) - SymFormatMark = sx.MakeSymbol(NameFormatMark) - SymFormatQuote = sx.MakeSymbol(NameFormatQuote) - SymFormatSpan = sx.MakeSymbol(NameFormatSpan) - SymFormatSub = sx.MakeSymbol(NameFormatSub) - SymFormatSuper = sx.MakeSymbol(NameFormatSuper) - SymFormatStrong = sx.MakeSymbol(NameFormatStrong) - SymHard = sx.MakeSymbol(NameHard) - SymHeading = sx.MakeSymbol(NameHeading) - SymLinkInvalid = sx.MakeSymbol(NameLinkInvalid) - SymLinkZettel = sx.MakeSymbol(NameLinkZettel) - SymLinkSelf = sx.MakeSymbol(NameLinkSelf) - SymLinkFound = sx.MakeSymbol(NameLinkFound) - SymLinkBroken = sx.MakeSymbol(NameLinkBroken) - SymLinkHosted = sx.MakeSymbol(NameLinkHosted) - SymLinkBased = sx.MakeSymbol(NameLinkBased) - SymLinkQuery = sx.MakeSymbol(NameLinkQuery) - SymLinkExternal = sx.MakeSymbol(NameLinkExternal) - SymListOrdered = sx.MakeSymbol(NameListOrdered) - SymListUnordered = sx.MakeSymbol(NameListUnordered) - SymListQuote = sx.MakeSymbol(NameListQuote) - SymLiteralProg = sx.MakeSymbol(NameLiteralProg) - SymLiteralComment = sx.MakeSymbol(NameLiteralComment) - SymLiteralHTML = sx.MakeSymbol(NameLiteralHTML) - SymLiteralInput = sx.MakeSymbol(NameLiteralInput) - SymLiteralMath = sx.MakeSymbol(NameLiteralMath) - SymLiteralOutput = sx.MakeSymbol(NameLiteralOutput) - SymLiteralZettel = sx.MakeSymbol(NameLiteralZettel) - SymMark = sx.MakeSymbol(NameMark) - SymPara = sx.MakeSymbol(NamePara) - SymRegionBlock = sx.MakeSymbol(NameRegionBlock) - SymRegionQuote = sx.MakeSymbol(NameRegionQuote) - SymRegionVerse = sx.MakeSymbol(NameRegionVerse) - SymSoft = sx.MakeSymbol(NameSoft) - SymSpace = sx.MakeSymbol(NameSpace) - SymTable = sx.MakeSymbol(NameTable) - SymText = sx.MakeSymbol(NameText) - SymThematic = sx.MakeSymbol(NameThematic) - SymTransclude = sx.MakeSymbol(NameTransclude) - SymUnknown = sx.MakeSymbol(NameUnknown) - SymVerbatimComment = sx.MakeSymbol(NameVerbatimComment) - SymVerbatimEval = sx.MakeSymbol(NameVerbatimEval) - SymVerbatimHTML = sx.MakeSymbol(NameVerbatimHTML) - SymVerbatimMath = sx.MakeSymbol(NameVerbatimMath) - SymVerbatimProg = sx.MakeSymbol(NameVerbatimProg) - SymVerbatimZettel = sx.MakeSymbol(NameVerbatimZettel) - - // Constant symbols for reference states. - SymRefStateInvalid = sx.MakeSymbol(NameRefStateInvalid) - SymRefStateZettel = sx.MakeSymbol(NameRefStateZettel) - SymRefStateSelf = sx.MakeSymbol(NameRefStateSelf) - SymRefStateFound = sx.MakeSymbol(NameRefStateFound) - SymRefStateBroken = sx.MakeSymbol(NameRefStateBroken) - SymRefStateHosted = sx.MakeSymbol(NameRefStateHosted) - SymRefStateBased = sx.MakeSymbol(NameRefStateBased) - SymRefStateQuery = sx.MakeSymbol(NameRefStateQuery) - SymRefStateExternal = sx.MakeSymbol(NameRefStateExternal) - - // Symbols for metadata types. - SymTypeCredential = sx.MakeSymbol(NameTypeCredential) - SymTypeEmpty = sx.MakeSymbol(NameTypeEmpty) - SymTypeID = sx.MakeSymbol(NameTypeID) - SymTypeIDSet = sx.MakeSymbol(NameTypeIDSet) - SymTypeNumber = sx.MakeSymbol(NameTypeNumber) - SymTypeString = sx.MakeSymbol(NameTypeString) - SymTypeTagSet = sx.MakeSymbol(NameTypeTagSet) - SymTypeTimestamp = sx.MakeSymbol(NameTypeTimestamp) - SymTypeURL = sx.MakeSymbol(NameTypeURL) - SymTypeWord = sx.MakeSymbol(NameTypeWord) - SymTypeZettelmarkup = sx.MakeSymbol(NameTypeZettelmarkup) +var ( + // Symbols for Metanodes + SymBlock = sx.MakeSymbol("BLOCK") + SymInline = sx.MakeSymbol("INLINE") + SymMeta = sx.MakeSymbol("META") + + // Symbols for Zettel noMakede types. + SymBLOB = sx.MakeSymbol("BLOB") + SymCell = sx.MakeSymbol("CELL") + SymCellCenter = sx.MakeSymbol("CELL-CENTER") + SymCellLeft = sx.MakeSymbol("CELL-LEFT") + SymCellRight = sx.MakeSymbol("CELL-RIGHT") + SymCite = sx.MakeSymbol("CITE") + SymDescription = sx.MakeSymbol("DESCRIPTION") + SymEmbed = sx.MakeSymbol("EMBED") + SymEmbedBLOB = sx.MakeSymbol("EMBED-BLOB") + SymEndnote = sx.MakeSymbol("ENDNOTE") + SymFormatEmph = sx.MakeSymbol("FORMAT-EMPH") + SymFormatDelete = sx.MakeSymbol("FORMAT-DELETE") + SymFormatInsert = sx.MakeSymbol("FORMAT-INSERT") + SymFormatMark = sx.MakeSymbol("FORMAT-MARK") + SymFormatQuote = sx.MakeSymbol("FORMAT-QUOTE") + SymFormatSpan = sx.MakeSymbol("FORMAT-SPAN") + SymFormatSub = sx.MakeSymbol("FORMAT-SUB") + SymFormatSuper = sx.MakeSymbol("FORMAT-SUPER") + SymFormatStrong = sx.MakeSymbol("FORMAT-STRONG") + SymHard = sx.MakeSymbol("HARD") + SymHeading = sx.MakeSymbol("HEADING") + SymLinkInvalid = sx.MakeSymbol("LINK-INVALID") + SymLinkZettel = sx.MakeSymbol("LINK-ZETTEL") + SymLinkSelf = sx.MakeSymbol("LINK-SELF") + SymLinkFound = sx.MakeSymbol("LINK-FOUND") + SymLinkBroken = sx.MakeSymbol("LINK-BROKEN") + SymLinkHosted = sx.MakeSymbol("LINK-HOSTED") + SymLinkBased = sx.MakeSymbol("LINK-BASED") + SymLinkQuery = sx.MakeSymbol("LINK-QUERY") + SymLinkExternal = sx.MakeSymbol("LINK-EXTERNAL") + SymListOrdered = sx.MakeSymbol("ORDERED") + SymListUnordered = sx.MakeSymbol("UNORDERED") + SymListQuote = sx.MakeSymbol("QUOTATION") + SymLiteralProg = sx.MakeSymbol("LITERAL-CODE") + SymLiteralComment = sx.MakeSymbol("LITERAL-COMMENT") + SymLiteralHTML = sx.MakeSymbol("LITERAL-HTML") + SymLiteralInput = sx.MakeSymbol("LITERAL-INPUT") + SymLiteralMath = sx.MakeSymbol("LITERAL-MATH") + SymLiteralOutput = sx.MakeSymbol("LITERAL-OUTPUT") + SymLiteralZettel = sx.MakeSymbol("LITERAL-ZETTEL") + SymMark = sx.MakeSymbol("MARK") + SymPara = sx.MakeSymbol("PARA") + SymRegionBlock = sx.MakeSymbol("REGION-BLOCK") + SymRegionQuote = sx.MakeSymbol("REGION-QUOTE") + SymRegionVerse = sx.MakeSymbol("REGION-VERSE") + SymSoft = sx.MakeSymbol("SOFT") + SymTable = sx.MakeSymbol("TABLE") + SymText = sx.MakeSymbol("TEXT") + SymThematic = sx.MakeSymbol("THEMATIC") + SymTransclude = sx.MakeSymbol("TRANSCLUDE") + SymUnknown = sx.MakeSymbol("UNKNOWN-NODE") + SymVerbatimComment = sx.MakeSymbol("VERBATIM-COMMENT") + SymVerbatimEval = sx.MakeSymbol("VERBATIM-EVAL") + SymVerbatimHTML = sx.MakeSymbol("VERBATIM-HTML") + SymVerbatimMath = sx.MakeSymbol("VERBATIM-MATH") + SymVerbatimProg = sx.MakeSymbol("VERBATIM-CODE") + SymVerbatimZettel = sx.MakeSymbol("VERBATIM-ZETTEL") + + // Constant symbols for reference states. + SymRefStateInvalid = sx.MakeSymbol("INVALID") + SymRefStateZettel = sx.MakeSymbol("ZETTEL") + SymRefStateSelf = sx.MakeSymbol("SELF") + SymRefStateFound = sx.MakeSymbol("FOUND") + SymRefStateBroken = sx.MakeSymbol("BROKEN") + SymRefStateHosted = sx.MakeSymbol("HOSTED") + SymRefStateBased = sx.MakeSymbol("BASED") + SymRefStateQuery = sx.MakeSymbol("QUERY") + SymRefStateExternal = sx.MakeSymbol("EXTERNAL") + + // Symbols for metadata types. + SymTypeCredential = sx.MakeSymbol("CREDENTIAL") + SymTypeEmpty = sx.MakeSymbol("EMPTY-STRING") + SymTypeID = sx.MakeSymbol("ZID") + SymTypeIDSet = sx.MakeSymbol("ZID-SET") + SymTypeNumber = sx.MakeSymbol("NUMBER") + SymTypeString = sx.MakeSymbol("STRING") + SymTypeTagSet = sx.MakeSymbol("TAG-SET") + SymTypeTimestamp = sx.MakeSymbol("TIMESTAMP") + SymTypeURL = sx.MakeSymbol("URL") + SymTypeWord = sx.MakeSymbol("WORD") + SymTypeZettelmarkup = sx.MakeSymbol("ZETTELMARKUP") ) ADDED sz/parser.go Index: sz/parser.go ================================================================== --- /dev/null +++ sz/parser.go @@ -0,0 +1,67 @@ +//----------------------------------------------------------------------------- +// Copyright (c) 2024-present Detlef Stern +// +// This file is part of zettelstore-client. +// +// Zettelstore client is licensed under the latest version of the EUPL +// (European Union Public License). Please see file LICENSE.txt for your rights +// and obligations under this license. +// +// SPDX-License-Identifier: EUPL-1.2 +// SPDX-FileCopyrightText: 2024-present Detlef Stern +//----------------------------------------------------------------------------- + +package sz + +import ( + "t73f.de/r/sx" + "t73f.de/r/zsc/api" + "t73f.de/r/zsc/input" +) + +// --- Contains some simple parsers + +// ---- Syntax: none + +// ParseNoneBlocks parses no block. +func ParseNoneBlocks(*input.Input) *sx.Pair { return nil } + +// ParseNoneInlines skips to the end of line and parses no inline. +func ParseNoneInlines(inp *input.Input) *sx.Pair { + inp.SkipToEOL() + return nil +} + +// ---- Some plain text syntaxes + +// ParsePlainBlocks parses the block as plain text with the given syntax. +func ParsePlainBlocks(inp *input.Input, syntax string) *sx.Pair { + var sym *sx.Symbol + if syntax == api.ValueSyntaxHTML { + sym = SymVerbatimHTML + } else { + sym = SymVerbatimProg + } + return sx.MakeList( + sym, + sx.MakeList(sx.Cons(sx.MakeString(""), sx.MakeString(syntax))), + sx.MakeString(string(inp.ScanLineContent())), + ) +} + +// ParsePlainInlines parses the inline as plain text with the given syntax. +func ParsePlainInlines(inp *input.Input, syntax string) *sx.Pair { + var sym *sx.Symbol + if syntax == api.ValueSyntaxHTML { + sym = SymLiteralHTML + } else { + sym = SymLiteralProg + } + pos := inp.Pos + inp.SkipToEOL() + return sx.MakeList( + sym, + sx.MakeList(sx.Cons(sx.MakeString(""), sx.MakeString(syntax))), + sx.MakeString(string(inp.Src[pos:inp.Pos])), + ) +} ADDED sz/parser_test.go Index: sz/parser_test.go ================================================================== --- /dev/null +++ sz/parser_test.go @@ -0,0 +1,72 @@ +//----------------------------------------------------------------------------- +// Copyright (c) 2024-present Detlef Stern +// +// This file is part of zettelstore-client. +// +// Zettelstore client is licensed under the latest version of the EUPL +// (European Union Public License). Please see file LICENSE.txt for your rights +// and obligations under this license. +// +// SPDX-License-Identifier: EUPL-1.2 +// SPDX-FileCopyrightText: 2024-present Detlef Stern +//----------------------------------------------------------------------------- + +package sz_test + +import ( + "testing" + + "t73f.de/r/zsc/input" + "t73f.de/r/zsc/sz" +) + +func TestParseNone(t *testing.T) { + if got := sz.ParseNoneBlocks(nil); got != nil { + t.Error("GOTB", got) + } + + inp := input.NewInput([]byte("1234\n6789")) + if got := sz.ParseNoneInlines(inp); got != nil { + t.Error("GOTI", got) + } + if got := inp.Pos; got != 4 { + t.Errorf("input should be on position 4, but is %d", got) + } + if got := inp.Ch; got != '\n' { + t.Errorf("input character should be 10, but is %d", got) + } +} + +func TestParsePlani(t *testing.T) { + testcases := []struct { + src string + syntax string + expBlocks string + expInlines string + }{ + {"abc", "html", + "(VERBATIM-HTML ((\"\" . \"html\")) \"abc\")", + "(LITERAL-HTML ((\"\" . \"html\")) \"abc\")"}, + {"abc\ndef", "html", + "(VERBATIM-HTML ((\"\" . \"html\")) \"abc\\ndef\")", + "(LITERAL-HTML ((\"\" . \"html\")) \"abc\")"}, + {"abc", "text", + "(VERBATIM-CODE ((\"\" . \"text\")) \"abc\")", + "(LITERAL-CODE ((\"\" . \"text\")) \"abc\")"}, + {"abc\nDEF", "text", + "(VERBATIM-CODE ((\"\" . \"text\")) \"abc\\nDEF\")", + "(LITERAL-CODE ((\"\" . \"text\")) \"abc\")"}, + } + for i, tc := range testcases { + t.Run(tc.syntax+":"+tc.src, func(t *testing.T) { + inp := input.NewInput([]byte(tc.src)) + if got := sz.ParsePlainBlocks(inp, tc.syntax).String(); tc.expBlocks != got { + t.Errorf("%d: %q/%v\nexpected: %q\ngot : %q", i, tc.src, tc.syntax, tc.expBlocks, got) + } + inp.SetPos(0) + if got := sz.ParsePlainInlines(inp, tc.syntax).String(); tc.expInlines != got { + t.Errorf("%d: %q/%v\nexpected: %q\ngot : %q", i, tc.src, tc.syntax, tc.expInlines, got) + } + }) + } +} Index: sz/sz.go ================================================================== --- sz/sz.go +++ sz/sz.go @@ -9,15 +9,16 @@ // // SPDX-License-Identifier: EUPL-1.2 // SPDX-FileCopyrightText: 2022-present Detlef Stern //----------------------------------------------------------------------------- +// Package sz contains zettel data handling as sx expressions. package sz import ( - "zettelstore.de/client.fossil/attrs" - "zettelstore.de/sx.fossil" + "t73f.de/r/sx" + "t73f.de/r/zsc/attrs" ) // GetAttributes traverses a s-expression list and returns an attribute structure. func GetAttributes(seq *sx.Pair) (result attrs.Attributes) { for elem := seq; elem != nil; elem = elem.Tail() { @@ -43,13 +44,13 @@ // GoValue returns the string value of the sx.Object suitable for Go processing. func GoValue(obj sx.Object) string { switch o := obj.(type) { case sx.String: - return string(o) + return o.GetValue() case *sx.Symbol: - return o.GoString() + return o.GetValue() } return obj.String() } // GetMetaContent returns the metadata and the content of a sz encoded zettel. @@ -123,5 +124,34 @@ return pair } } return nil } + +// MapRefStateToLinkEmbed maps a reference state symbol to a link symbol or to +// an embed symbol, depending on 'forLink'. +func MapRefStateToLinkEmbed(symRefState *sx.Symbol, forLink bool) *sx.Symbol { + if !forLink { + return SymEmbed + } + if sym, found := mapRefStateLink[symRefState]; found { + return sym + } + return SymLinkInvalid +} + +var mapRefStateLink = map[*sx.Symbol]*sx.Symbol{ + SymRefStateInvalid: SymLinkInvalid, + SymRefStateZettel: SymLinkZettel, + SymRefStateSelf: SymLinkSelf, + SymRefStateFound: SymLinkFound, + SymRefStateBroken: SymLinkBroken, + SymRefStateHosted: SymLinkHosted, + SymRefStateBased: SymLinkBased, + SymRefStateQuery: SymLinkQuery, + SymRefStateExternal: SymLinkExternal, +} + +// IsBreakSym return true if the object is either a soft or a hard break symbol. +func IsBreakSym(obj sx.Object) bool { + return SymSoft.IsEqual(obj) || SymHard.IsEqual(obj) +} ADDED sz/walk.go Index: sz/walk.go ================================================================== --- /dev/null +++ sz/walk.go @@ -0,0 +1,204 @@ +//----------------------------------------------------------------------------- +// Copyright (c) 2024-present Detlef Stern +// +// This file is part of zettelstore-client. +// +// Zettelstore client is licensed under the latest version of the EUPL +// (European Union Public License). Please see file LICENSE.txt for your rights +// and obligations under this license. +// +// SPDX-License-Identifier: EUPL-1.2 +// SPDX-FileCopyrightText: 2024-present Detlef Stern +//----------------------------------------------------------------------------- + +package sz + +import "t73f.de/r/sx" + +// Visitor is walking the sx-based AST. +type Visitor interface { + Visit(node *sx.Pair, env *sx.Pair) sx.Object +} + +// Walk a sx-based AST through a Visitor. +func Walk(v Visitor, node *sx.Pair, env *sx.Pair) *sx.Pair { + if node == nil { + return nil + } + if result, isPair := sx.GetPair(v.Visit(node, env)); isPair { + return result + } + + if sym, isSymbol := sx.GetSymbol(node.Car()); isSymbol { + if fn, found := mapChildrenWalk[sym]; found { + return fn(v, node, env) + } + return node + } + panic(node) +} + +var mapChildrenWalk map[*sx.Symbol]func(Visitor, *sx.Pair, *sx.Pair) *sx.Pair + +func init() { + mapChildrenWalk = map[*sx.Symbol]func(Visitor, *sx.Pair, *sx.Pair) *sx.Pair{ + SymBlock: walkChildrenTail, + SymPara: walkChildrenTail, + SymRegionBlock: walkChildrenRegion, + SymRegionQuote: walkChildrenRegion, + SymRegionVerse: walkChildrenRegion, + SymHeading: walkChildrenHeading, + SymListOrdered: walkChildrenTail, + SymListUnordered: walkChildrenTail, + SymListQuote: walkChildrenTail, + SymDescription: walkChildrenDescription, + SymTable: walkChildrenTable, + + SymInline: walkChildrenTail, + SymEndnote: walkChildrenInlines3, + SymMark: walkChildrenMark, + SymLinkBased: walkChildrenInlines4, + SymLinkBroken: walkChildrenInlines4, + SymLinkExternal: walkChildrenInlines4, + SymLinkFound: walkChildrenInlines4, + SymLinkHosted: walkChildrenInlines4, + SymLinkInvalid: walkChildrenInlines4, + SymLinkQuery: walkChildrenInlines4, + SymLinkSelf: walkChildrenInlines4, + SymLinkZettel: walkChildrenInlines4, + SymEmbed: walkChildrenInlines4, + SymCite: walkChildrenInlines4, + SymFormatDelete: walkChildrenInlines3, + SymFormatEmph: walkChildrenInlines3, + SymFormatInsert: walkChildrenInlines3, + SymFormatMark: walkChildrenInlines3, + SymFormatQuote: walkChildrenInlines3, + SymFormatStrong: walkChildrenInlines3, + SymFormatSpan: walkChildrenInlines3, + SymFormatSub: walkChildrenInlines3, + SymFormatSuper: walkChildrenInlines3, + } +} + +func walkChildrenTail(v Visitor, node *sx.Pair, env *sx.Pair) *sx.Pair { + hasNil := false + for n := node.Tail(); n != nil; n = n.Tail() { + obj := Walk(v, n.Head(), env) + if sx.IsNil(obj) { + hasNil = true + } + n.SetCar(obj) + } + if !hasNil { + return node + } + for n := node; ; { + next := n.Tail() + if next == nil { + break + } + if sx.IsNil(next.Car()) { + n.SetCdr(next.Cdr()) + continue + } + n = next + } + return node +} + +func walkChildrenList(v Visitor, lst *sx.Pair, env *sx.Pair) *sx.Pair { + hasNil := false + for n := lst; n != nil; n = n.Tail() { + obj := Walk(v, n.Head(), env) + if sx.IsNil(obj) { + hasNil = true + } + n.SetCar(obj) + } + if !hasNil { + return lst + } + var result sx.ListBuilder + for n := lst; n != nil; n = n.Tail() { + obj := n.Car() + if !sx.IsNil(obj) { + result.Add(obj) + } + } + return result.List() +} + +func walkChildrenRegion(v Visitor, node *sx.Pair, env *sx.Pair) *sx.Pair { + // sym := node.Car() + next := node.Tail() + // attrs := next.Car() + next = next.Tail() + next.SetCar(walkChildrenList(v, next.Head(), env)) + next.SetCdr(walkChildrenList(v, next.Tail(), env)) + return node +} + +func walkChildrenHeading(v Visitor, node *sx.Pair, env *sx.Pair) *sx.Pair { + // sym := node.Car() + next := node.Tail() + // level := next.Car() + next = next.Tail() + // attrs := next.Car() + next = next.Tail() + // slug := next.Car() + next = next.Tail() + // fragment := next.Car() + next.SetCdr(walkChildrenList(v, next.Tail(), env)) + return node +} + +func walkChildrenDescription(v Visitor, dn *sx.Pair, env *sx.Pair) *sx.Pair { + for n := dn.Tail(); n != nil; n = n.Tail() { + n.SetCar(walkChildrenList(v, n.Head(), env)) + n = n.Tail() + if n == nil { + break + } + n.SetCar(Walk(v, n.Head(), env)) + } + return dn +} + +func walkChildrenTable(v Visitor, tn *sx.Pair, env *sx.Pair) *sx.Pair { + header := tn.Tail() + header.SetCar(walkChildrenList(v, header.Tail(), env)) + for row := header.Tail(); row != nil; row = row.Tail() { + row.SetCar(walkChildrenList(v, row.Head(), env)) + } + return tn +} + +func walkChildrenMark(v Visitor, mn *sx.Pair, env *sx.Pair) *sx.Pair { + // sym := mn.Car() + next := mn.Tail() + // mark := next.Car() + next = next.Tail() + // slug := next.Car() + next = next.Tail() + // fragment := next.Car() + next.SetCdr(walkChildrenList(v, next.Tail(), env)) + return mn +} + +func walkChildrenInlines4(v Visitor, ln *sx.Pair, env *sx.Pair) *sx.Pair { + // sym := ln.Car() + next := ln.Tail() + // attrs := next.Car() + next = next.Tail() + // val3 := next.Car() + next.SetCdr(walkChildrenList(v, next.Tail(), env)) + return ln +} + +func walkChildrenInlines3(v Visitor, node *sx.Pair, env *sx.Pair) *sx.Pair { + // sym := node.Car() + next := node.Tail() // Attrs + // attrs := next.Car() + next.SetCdr(walkChildrenList(v, next.Tail(), env)) + return node +} ADDED sz/zmk/block.go Index: sz/zmk/block.go ================================================================== --- /dev/null +++ sz/zmk/block.go @@ -0,0 +1,719 @@ +//----------------------------------------------------------------------------- +// Copyright (c) 2020-present Detlef Stern +// +// This file is part of zettelstore-client. +// +// Zettelstore client is licensed under the latest version of the EUPL +// (European Union Public License). Please see file LICENSE.txt for your rights +// and obligations under this license. +// +// SPDX-License-Identifier: EUPL-1.2 +// SPDX-FileCopyrightText: 2020-present Detlef Stern +//----------------------------------------------------------------------------- + +package zmk + +import ( + "fmt" + + "t73f.de/r/sx" + "t73f.de/r/zsc/input" + "t73f.de/r/zsc/sz" +) + +// parseBlock parses one block. +func (cp *zmkP) parseBlock(lastPara *sx.Pair) (res *sx.Pair, cont bool) { + inp := cp.inp + pos := inp.Pos + if cp.nestingLevel <= maxNestingLevel { + cp.nestingLevel++ + defer func() { cp.nestingLevel-- }() + + var bn *sx.Pair + success := false + + switch inp.Ch { + case input.EOS: + return nil, false + case '\n', '\r': + inp.EatEOL() + cp.cleanupListsAfterEOL() + return nil, false + case ':': + bn, success = cp.parseColon() + case '@', '`', runeModGrave, '%', '~', '$': + cp.clearStacked() + bn, success = cp.parseVerbatim() + case '"', '<': + cp.clearStacked() + bn, success = cp.parseRegion() + case '=': + cp.clearStacked() + bn, success = cp.parseHeading() + case '-': + cp.clearStacked() + bn, success = cp.parseHRule() + case '*', '#', '>': + cp.lastRow = nil + cp.descrl = nil + bn, success = cp.parseNestedList() + case ';': + cp.lists = nil + cp.lastRow = nil + bn, success = cp.parseDefTerm() + case ' ': + cp.lastRow = nil + bn, success = nil, cp.parseIndent() + case '|': + cp.lists = nil + cp.descrl = nil + bn, success = cp.parseRow(), true + case '{': + cp.clearStacked() + bn, success = cp.parseTransclusion() + } + + if success { + return bn, false + } + } + inp.SetPos(pos) + cp.clearStacked() + ins := cp.parsePara() + if startsWithSpaceSoftBreak(ins) { + ins = ins[2:] + } else if lastPara != nil { + lastPair := lastPara.LastPair() + lastPair.ExtendBang(sx.MakeList(ins...)) + return nil, true + } + return sx.MakeList(ins...).Cons(sz.SymPara), false +} + +func startsWithSpaceSoftBreak(ins sx.Vector) bool { + if len(ins) < 2 { + return false + } + pair0, isPair0 := sx.GetPair(ins[0]) + pair1, isPair1 := sx.GetPair(ins[0]) + if !isPair0 || !isPair1 { + return false + } + if pair0.Car().IsEqual(sz.SymText) && sz.IsBreakSym(pair1.Car()) { + if args := pair0.Tail(); args != nil { + if val, isString := sx.GetString(args.Car()); isString { + for _, ch := range val.GetValue() { + if !input.IsSpace(ch) { + return false + } + } + return true + } + } + } + return false +} + +var symSeparator = sx.MakeSymbol("sEpArAtOr") + +func (cp *zmkP) cleanupListsAfterEOL() { + for _, l := range cp.lists { + l.LastPair().Head().LastPair().AppendBang(sx.Cons(symSeparator, nil)) + } + if descrl := cp.descrl; descrl != nil { + if lastPair, pos := lastPairPos(descrl); pos > 1 && pos%2 == 0 { + lastPair.Head().LastPair().AppendBang(sx.Cons(symSeparator, nil)) + } + } +} + +// parseColon determines which element should be parsed. +func (cp *zmkP) parseColon() (*sx.Pair, bool) { + inp := cp.inp + if inp.PeekN(1) == ':' { + cp.clearStacked() + return cp.parseRegion() + } + return cp.parseDefDescr() +} + +// parsePara parses paragraphed inline material as a sx.Vector. +func (cp *zmkP) parsePara() (result sx.Vector) { + for { + in := cp.parseInline() + if in == nil { + return result + } + result = append(result, in) + if sz.IsBreakSym(in.Car()) { + ch := cp.inp.Ch + switch ch { + // Must contain all cases from above switch in parseBlock. + case input.EOS, '\n', '\r', '@', '`', runeModGrave, '%', '~', '$', '"', '<', '=', '-', '*', '#', '>', ';', ':', ' ', '|', '{': + return result + } + } + } +} + +// countDelim read from input until a non-delimiter is found and returns number of delimiter chars. +func (cp *zmkP) countDelim(delim rune) int { + inp := cp.inp + cnt := 0 + for inp.Ch == delim { + cnt++ + inp.Next() + } + return cnt +} + +// parseVerbatim parses a verbatim block. +func (cp *zmkP) parseVerbatim() (rn *sx.Pair, success bool) { + inp := cp.inp + fch := inp.Ch + cnt := cp.countDelim(fch) + if cnt < 3 { + return nil, false + } + attrs := cp.parseBlockAttributes() + inp.SkipToEOL() + if inp.Ch == input.EOS { + return nil, false + } + var sym *sx.Symbol + switch fch { + case '@': + sym = sz.SymVerbatimZettel + case '`', runeModGrave: + sym = sz.SymVerbatimProg + case '%': + sym = sz.SymVerbatimComment + case '~': + sym = sz.SymVerbatimEval + case '$': + sym = sz.SymVerbatimMath + default: + panic(fmt.Sprintf("%q is not a verbatim char", fch)) + } + content := make([]byte, 0, 512) + for { + inp.EatEOL() + posL := inp.Pos + switch inp.Ch { + case fch: + if cp.countDelim(fch) >= cnt { + inp.SkipToEOL() + rn = sx.MakeList(sym, attrs, sx.MakeString(string(content))) + return rn, true + } + inp.SetPos(posL) + case input.EOS: + return nil, false + } + inp.SkipToEOL() + if len(content) > 0 { + content = append(content, '\n') + } + content = append(content, inp.Src[posL:inp.Pos]...) + } +} + +// parseRegion parses a block region. +func (cp *zmkP) parseRegion() (rn *sx.Pair, success bool) { + inp := cp.inp + fch := inp.Ch + cnt := cp.countDelim(fch) + if cnt < 3 { + return nil, false + } + + var sym *sx.Symbol + oldInVerse := cp.inVerse + defer func() { cp.inVerse = oldInVerse }() + switch fch { + case ':': + sym = sz.SymRegionBlock + case '<': + sym = sz.SymRegionQuote + case '"': + sym = sz.SymRegionVerse + cp.inVerse = true + default: + panic(fmt.Sprintf("%q is not a region char", fch)) + } + attrs := cp.parseBlockAttributes() + inp.SkipToEOL() + if inp.Ch == input.EOS { + return nil, false + } + var blocksBuilder sx.ListBuilder + var lastPara *sx.Pair + inp.EatEOL() + for { + posL := inp.Pos + switch inp.Ch { + case fch: + if cp.countDelim(fch) >= cnt { + ins := cp.parseRegionLastLine() + rn = ins.Cons(blocksBuilder.List()).Cons(attrs).Cons(sym) + return rn, true + } + inp.SetPos(posL) + case input.EOS: + return nil, false + } + bn, cont := cp.parseBlock(lastPara) + if bn != nil { + blocksBuilder.Add(bn) + } + if !cont { + lastPara = bn + } + } +} + +// parseRegionLastLine parses the last line of a region and returns its inline text. +func (cp *zmkP) parseRegionLastLine() *sx.Pair { + cp.clearStacked() // remove any lists defined in the region + cp.skipSpace() + var region sx.ListBuilder + for { + switch cp.inp.Ch { + case input.EOS, '\n', '\r': + return region.List() + } + in := cp.parseInline() + if in == nil { + return region.List() + } + region.Add(in) + } +} + +// parseHeading parses a head line. +func (cp *zmkP) parseHeading() (hn *sx.Pair, success bool) { + inp := cp.inp + delims := cp.countDelim(inp.Ch) + if delims < 3 { + return nil, false + } + if inp.Ch != ' ' { + return nil, false + } + inp.Next() + cp.skipSpace() + if delims > 7 { + delims = 7 + } + level := int64(delims - 2) + var attrs *sx.Pair + var text sx.ListBuilder + for { + if input.IsEOLEOS(inp.Ch) { + return createHeading(level, attrs, text.List()), true + } + in := cp.parseInline() + if in == nil { + return createHeading(level, attrs, text.List()), true + } + text.Add(in) + if inp.Ch == '{' && inp.Peek() != '{' { + attrs = cp.parseBlockAttributes() + inp.SkipToEOL() + return createHeading(level, attrs, text.List()), true + } + } +} +func createHeading(level int64, attrs, text *sx.Pair) *sx.Pair { + return text. + Cons(sx.MakeString("")). // Fragment + Cons(sx.MakeString("")). // Slug + Cons(attrs). + Cons(sx.Int64(level)). + Cons(sz.SymHeading) +} + +// parseHRule parses a horizontal rule. +func (cp *zmkP) parseHRule() (hn *sx.Pair, success bool) { + inp := cp.inp + if cp.countDelim(inp.Ch) < 3 { + return nil, false + } + + attrs := cp.parseBlockAttributes() + inp.SkipToEOL() + return sx.MakeList(sz.SymThematic, attrs), true +} + +// parseNestedList parses a list. +func (cp *zmkP) parseNestedList() (res *sx.Pair, success bool) { + kinds := cp.parseNestedListKinds() + if len(kinds) == 0 { + return nil, false + } + cp.skipSpace() + if !kinds[len(kinds)-1].IsEqual(sz.SymListQuote) && input.IsEOLEOS(cp.inp.Ch) { + return nil, false + } + + if len(kinds) < len(cp.lists) { + cp.lists = cp.lists[:len(kinds)] + } + ln, newLnCount := cp.buildNestedList(kinds) + pv := cp.parseLinePara() + bn := sx.Cons(sz.SymBlock, nil) + if len(pv) != 0 { + bn.AppendBang(pv.MakeList().Cons(sz.SymPara)) + } + lastItemPair := ln.LastPair() + lastItemPair.AppendBang(bn) + return cp.cleanupParsedNestedList(newLnCount) +} + +func (cp *zmkP) parseNestedListKinds() []*sx.Symbol { + inp := cp.inp + result := make([]*sx.Symbol, 0, 8) + for { + var sym *sx.Symbol + switch inp.Ch { + case '*': + sym = sz.SymListUnordered + case '#': + sym = sz.SymListOrdered + case '>': + sym = sz.SymListQuote + default: + panic(fmt.Sprintf("%q is not a region char", inp.Ch)) + } + result = append(result, sym) + switch inp.Next() { + case '*', '#', '>': + case ' ', input.EOS, '\n', '\r': + return result + default: + return nil + } + } +} + +func (cp *zmkP) buildNestedList(kinds []*sx.Symbol) (ln *sx.Pair, newLnCount int) { + for i, kind := range kinds { + if i < len(cp.lists) { + if !cp.lists[i].Car().IsEqual(kind) { + ln = sx.Cons(kind, nil) + newLnCount++ + cp.lists[i] = ln + cp.lists = cp.lists[:i+1] + } else { + ln = cp.lists[i] + } + } else { + ln = sx.Cons(kind, nil) + newLnCount++ + cp.lists = append(cp.lists, ln) + } + } + return ln, newLnCount +} + +func (cp *zmkP) cleanupParsedNestedList(newLnCount int) (res *sx.Pair, success bool) { + childPos := len(cp.lists) - 1 + parentPos := childPos - 1 + for i := 0; i < newLnCount; i++ { + if parentPos < 0 { + return cp.lists[0], true + } + parentLn := cp.lists[parentPos] + childLn := cp.lists[childPos] + if firstParent := parentLn.Tail(); firstParent != nil { + // Add list to last item of the parent list + lastParent := firstParent.LastPair() + lastParent.Head().LastPair().AppendBang(childLn) + } else { + // Set list to first child of parent. + childBlock := sx.MakeList(sz.SymBlock, cp.lists[childPos]) + parentLn.LastPair().AppendBang(childBlock) + } + childPos-- + parentPos-- + } + return nil, true +} + +// parseDefTerm parses a term of a definition list. +func (cp *zmkP) parseDefTerm() (res *sx.Pair, success bool) { + inp := cp.inp + if inp.Next() != ' ' { + return nil, false + } + inp.Next() + cp.skipSpace() + descrl := cp.descrl + if descrl == nil { + descrl = sx.Cons(sz.SymDescription, nil) + cp.descrl = descrl + res = descrl + } + lastPair, pos := lastPairPos(descrl) + for { + in := cp.parseInline() + if in == nil { + if pos%2 == 0 { + // lastPair is either the empty description list or the last block of definitions + return nil, false + } + // lastPair is the definition term + return res, true + } + if pos%2 == 0 { + // lastPair is either the empty description list or the last block of definitions + lastPair = lastPair.AppendBang(sx.Cons(in, nil)) + pos++ + } else { + // lastPair is the term part and we need to append the inline list just read + lastPair.Head().LastPair().AppendBang(in) + } + if sz.IsBreakSym(in.Car()) { + return res, true + } + } +} + +// parseDefDescr parses a description of a definition list. +func (cp *zmkP) parseDefDescr() (res *sx.Pair, success bool) { + inp := cp.inp + if inp.Next() != ' ' { + return nil, false + } + inp.Next() + cp.skipSpace() + descrl := cp.descrl + lastPair, pos := lastPairPos(descrl) + if descrl == nil || pos <= 0 { + // No term given + return nil, false + } + + pn := cp.parseLinePara() + if len(pn) == 0 { + return nil, false + } + + newDef := sx.MakeList(sz.SymBlock, pn.MakeList().Cons(sz.SymPara)) + if pos%2 == 1 { + // Just a term, but no definitions + lastPair.AppendBang(sx.MakeList(sz.SymBlock, newDef)) + } else { + // lastPara points a the last definition + lastPair.Head().LastPair().AppendBang(newDef) + } + return nil, true +} + +func lastPairPos(p *sx.Pair) (*sx.Pair, int) { + cnt := 0 + for node := p; node != nil; { + next := node.Tail() + if next == nil { + return node, cnt + } + node = next + cnt++ + } + return nil, -1 +} + +// parseIndent parses initial spaces to continue a list. +func (cp *zmkP) parseIndent() bool { + inp := cp.inp + cnt := 0 + for { + if inp.Next() != ' ' { + break + } + cnt++ + } + if cp.lists != nil { + return cp.parseIndentForList(cnt) + } + if cp.descrl != nil { + return cp.parseIndentForDescription(cnt) + } + return false +} + +func (cp *zmkP) parseIndentForList(cnt int) bool { + if len(cp.lists) < cnt { + cnt = len(cp.lists) + } + cp.lists = cp.lists[:cnt] + if cnt == 0 { + return false + } + pv := cp.parseLinePara() + if len(pv) == 0 { + return false + } + ln := cp.lists[cnt-1] + lbn := ln.LastPair().Head() + lpn := lbn.LastPair().Head() + pvList := pv.MakeList() + if lpn.Car().IsEqual(sz.SymPara) { + lpn.LastPair().SetCdr(pvList) + } else { + lbn.LastPair().AppendBang(pvList.Cons(sz.SymPara)) + } + return true +} + +func (cp *zmkP) parseIndentForDescription(cnt int) bool { + descrl := cp.descrl + lastPair, pos := lastPairPos(descrl) + if cnt < 1 || pos < 1 { + return false + } + if pos%2 == 1 { + // Continuation of a definition term + for { + in := cp.parseInline() + if in == nil { + return true + } + lastPair.Head().LastPair().AppendBang(in) + if sz.IsBreakSym(in.Car()) { + return true + } + } + } + + // Continuation of a definition description + pn := cp.parseLinePara() + if len(pn) == 0 { + return false + } + bn := lastPair.Head() + para := bn.LastPair().Head().LastPair().Head() + pnList := pn.MakeList() + if para.Car().IsEqual(sz.SymPara) { + para.LastPair().SetCdr(pnList) + } else { + bn.LastPair().AppendBang(pnList.Cons(sz.SymPara)) + } + return true +} + +// parseLinePara parses one paragraph of inline material. +func (cp *zmkP) parseLinePara() sx.Vector { + var ins sx.Vector + for { + in := cp.parseInline() + if in == nil { + return ins + } + ins = append(ins, in) + if sz.IsBreakSym(in.Car()) { + return ins + } + } +} + +// parseRow parse one table row. +func (cp *zmkP) parseRow() *sx.Pair { + inp := cp.inp + if inp.Peek() == '%' { + inp.SkipToEOL() + return nil + } + //var row, curr *sx.Pair + var row sx.ListBuilder + for { + inp.Next() + cell := cp.parseCell() + if cell != nil { + row.Add(cell) + } + switch inp.Ch { + case '\n', '\r': + inp.EatEOL() + fallthrough + case input.EOS: + // add to table + if cp.lastRow == nil { + if row.IsEmpty() { + return nil + } + cp.lastRow = sx.Cons(row.List(), nil) + return cp.lastRow.Cons(nil).Cons(sz.SymTable) + } + cp.lastRow = cp.lastRow.AppendBang(row.List()) + return nil + } + // inp.Ch must be '|' + } +} + +// parseCell parses one single cell of a table row. +func (cp *zmkP) parseCell() *sx.Pair { + inp := cp.inp + var cell sx.ListBuilder + for { + if input.IsEOLEOS(inp.Ch) { + if cell.IsEmpty() { + return nil + } + return cell.List().Cons(sz.SymCell) + } + if inp.Ch == '|' { + return cell.List().Cons(sz.SymCell) + } + + in := cp.parseInline() + cell.Add(in) + } +} + +// parseTransclusion parses '{' '{' '{' ZID '}' '}' '}' +func (cp *zmkP) parseTransclusion() (*sx.Pair, bool) { + if cp.countDelim('{') != 3 { + return nil, false + } + inp := cp.inp + posA, posE := inp.Pos, 0 + +loop: + + for { + switch inp.Ch { + case input.EOS: + return nil, false + case '\n', '\r', ' ', '\t': + if !hasQueryPrefix(inp.Src[posA:]) { + return nil, false + } + case '\\': + switch inp.Next() { + case input.EOS, '\n', '\r': + return nil, false + } + case '}': + posE = inp.Pos + if posA >= posE { + return nil, false + } + if inp.Next() != '}' { + continue + } + if inp.Next() != '}' { + continue + } + break loop + } + inp.Next() + } + inp.Next() // consume last '}' + a := cp.parseBlockAttributes() + inp.SkipToEOL() + refText := string(inp.Src[posA:posE]) + ref := ParseReference(refText) + return sx.MakeList(sz.SymTransclude, a, ref), true +} ADDED sz/zmk/inline.go Index: sz/zmk/inline.go ================================================================== --- /dev/null +++ sz/zmk/inline.go @@ -0,0 +1,513 @@ +//----------------------------------------------------------------------------- +// Copyright (c) 2020-present Detlef Stern +// +// This file is part of zettelstore-client. +// +// Zettelstore client is licensed under the latest version of the EUPL +// (European Union Public License). Please see file LICENSE.txt for your rights +// and obligations under this license. +// +// SPDX-License-Identifier: EUPL-1.2 +// SPDX-FileCopyrightText: 2020-present Detlef Stern +//----------------------------------------------------------------------------- + +package zmk + +import ( + "fmt" + "strings" + + "t73f.de/r/sx" + "t73f.de/r/zsc/api" + "t73f.de/r/zsc/input" + "t73f.de/r/zsc/sz" +) + +func (cp *zmkP) parseInline() *sx.Pair { + inp := cp.inp + pos := inp.Pos + if cp.nestingLevel <= maxNestingLevel { + cp.nestingLevel++ + defer func() { cp.nestingLevel-- }() + + var in *sx.Pair + success := false + switch inp.Ch { + case input.EOS: + return nil + case '\n', '\r': + return cp.parseSoftBreak() + case '[': + switch inp.Next() { + case '[': + in, success = cp.parseLinkEmbed('[', ']', true) + case '@': + in, success = cp.parseCite() + case '^': + in, success = cp.parseEndnote() + case '!': + in, success = cp.parseMark() + } + case '{': + if inp.Next() == '{' { + in, success = cp.parseLinkEmbed('{', '}', false) + } + case '%': + in, success = cp.parseComment() + case '_', '*', '>', '~', '^', ',', '"', '#', ':': + in, success = cp.parseFormat() + case '@', '\'', '`', '=', runeModGrave: + in, success = cp.parseLiteral() + case '$': + in, success = cp.parseLiteralMath() + case '\\': + return cp.parseBackslash() + case '-': + in, success = cp.parseNdash() + case '&': + in, success = cp.parseEntity() + } + if success { + return in + } + } + inp.SetPos(pos) + return cp.parseText() +} + +func (cp *zmkP) parseText() *sx.Pair { + return sx.MakeList(sz.SymText, cp.parseString()) +} + +func (cp *zmkP) parseString() sx.String { + inp := cp.inp + pos := inp.Pos + if inp.Ch == '\\' { + cp.inp.Next() + return cp.parseBackslashRest() + } + for { + switch inp.Next() { + // The following case must contain all runes that occur in parseInline! + // Plus the closing brackets ] and } and ) and the middle | + case input.EOS, '\n', '\r', '[', ']', '{', '}', '(', ')', '|', '%', '_', '*', '>', '~', '^', ',', '"', '#', ':', '\'', '@', '`', runeModGrave, '$', '=', '\\', '-', '&': + return sx.MakeString(string(inp.Src[pos:inp.Pos])) + } + } +} + +func (cp *zmkP) parseBackslash() *sx.Pair { + inp := cp.inp + switch inp.Next() { + case '\n', '\r': + inp.EatEOL() + return sx.MakeList(sz.SymHard) + default: + return sx.MakeList(sz.SymText, cp.parseBackslashRest()) + } +} + +func (cp *zmkP) parseBackslashRest() sx.String { + inp := cp.inp + if input.IsEOLEOS(inp.Ch) { + return sx.MakeString("\\") + } + if inp.Ch == ' ' { + inp.Next() + return sx.MakeString("\u00a0") + } + pos := inp.Pos + inp.Next() + return sx.MakeString(string(inp.Src[pos:inp.Pos])) +} + +func (cp *zmkP) parseSoftBreak() *sx.Pair { + cp.inp.EatEOL() + return sx.MakeList(sz.SymSoft) +} + +func (cp *zmkP) parseLinkEmbed(openCh, closeCh rune, forLink bool) (*sx.Pair, bool) { + if refString, text, ok := cp.parseReference(openCh, closeCh); ok { + attrs := cp.parseInlineAttributes() + if len(refString) > 0 { + ref := ParseReference(refString) + refSym, _ := sx.GetSymbol(ref.Car()) + sym := sz.MapRefStateToLinkEmbed(refSym, forLink) + ln := text. + Cons(ref.Tail().Car()). // reference value + Cons(attrs). + Cons(sym) + return ln, true + } + } + return nil, false +} + +func hasQueryPrefix(src []byte) bool { + return len(src) > len(api.QueryPrefix) && string(src[:len(api.QueryPrefix)]) == api.QueryPrefix +} + +func (cp *zmkP) parseReference(openCh, closeCh rune) (ref string, text *sx.Pair, _ bool) { + inp := cp.inp + inp.Next() + cp.skipSpace() + if inp.Ch == openCh { + // Additional opening chars result in a fail + return "", nil, false + } + var is sx.Vector + pos := inp.Pos + if !hasQueryPrefix(inp.Src[pos:]) { + hasSpace, ok := cp.readReferenceToSep(closeCh) + if !ok { + return "", nil, false + } + if inp.Ch == '|' { // First part must be inline text + if pos == inp.Pos { // [[| or {{| + return "", nil, false + } + cp.inp = input.NewInput(inp.Src[pos:inp.Pos]) + for { + in := cp.parseInline() + if in == nil { + break + } + is = append(is, in) + } + cp.inp = inp + inp.Next() + } else { + if hasSpace { + return "", nil, false + } + inp.SetPos(pos) + } + } + + cp.skipSpace() + pos = inp.Pos + if !cp.readReferenceToClose(closeCh) { + return "", nil, false + } + ref = strings.TrimSpace(string(inp.Src[pos:inp.Pos])) + if inp.Next() != closeCh { + return "", nil, false + } + inp.Next() + if len(is) == 0 { + return ref, nil, true + } + return ref, sx.MakeList(is...), true +} + +func (cp *zmkP) readReferenceToSep(closeCh rune) (bool, bool) { + hasSpace := false + inp := cp.inp + for { + switch inp.Ch { + case input.EOS: + return false, false + case '\n', '\r', ' ': + hasSpace = true + case '|': + return hasSpace, true + case '\\': + switch inp.Next() { + case input.EOS: + return false, false + case '\n', '\r': + hasSpace = true + } + case '%': + if inp.Next() == '%' { + inp.SkipToEOL() + } + continue + case closeCh: + if inp.Next() == closeCh { + return hasSpace, true + } + continue + } + inp.Next() + } +} + +func (cp *zmkP) readReferenceToClose(closeCh rune) bool { + inp := cp.inp + pos := inp.Pos + for { + switch inp.Ch { + case input.EOS: + return false + case '\t', '\r', '\n', ' ': + if !hasQueryPrefix(inp.Src[pos:]) { + return false + } + case '\\': + switch inp.Next() { + case input.EOS, '\n', '\r': + return false + } + case closeCh: + return true + } + inp.Next() + } +} + +func (cp *zmkP) parseCite() (*sx.Pair, bool) { + inp := cp.inp + switch inp.Next() { + case ' ', ',', '|', ']', '\n', '\r': + return nil, false + } + pos := inp.Pos +loop: + for { + switch inp.Ch { + case input.EOS: + return nil, false + case ' ', ',', '|', ']', '\n', '\r': + break loop + } + inp.Next() + } + posL := inp.Pos + switch inp.Ch { + case ' ', ',', '|': + inp.Next() + } + ins, ok := cp.parseLinkLikeRest() + if !ok { + return nil, false + } + attrs := cp.parseInlineAttributes() + cn := ins.Cons(sx.MakeString(string(inp.Src[pos:posL]))).Cons(attrs).Cons(sz.SymCite) + return cn, true +} + +func (cp *zmkP) parseEndnote() (*sx.Pair, bool) { + cp.inp.Next() + ins, ok := cp.parseLinkLikeRest() + if !ok { + return nil, false + } + attrs := cp.parseInlineAttributes() + return ins.Cons(attrs).Cons(sz.SymEndnote), true +} + +func (cp *zmkP) parseMark() (*sx.Pair, bool) { + inp := cp.inp + inp.Next() + pos := inp.Pos + for inp.Ch != '|' && inp.Ch != ']' { + if !isNameRune(inp.Ch) { + return nil, false + } + inp.Next() + } + mark := inp.Src[pos:inp.Pos] + var ins *sx.Pair + if inp.Ch == '|' { + inp.Next() + var ok bool + ins, ok = cp.parseLinkLikeRest() + if !ok { + return nil, false + } + } else { + inp.Next() + } + mn := ins. + Cons(sx.MakeString("")). // Fragment + Cons(sx.MakeString("")). // Slug + Cons(sx.MakeString(string(mark))). + Cons(sz.SymMark) + return mn, true + // Problematisch ist, dass hier noch nicht mn.Fragment und mn.Slug gesetzt werden. + // Evtl. muss es ein PreMark-Symbol geben +} + +func (cp *zmkP) parseLinkLikeRest() (*sx.Pair, bool) { + cp.skipSpace() + var ins sx.Vector + inp := cp.inp + for inp.Ch != ']' { + in := cp.parseInline() + if in == nil { + return nil, false + } + ins = append(ins, in) + if input.IsEOLEOS(inp.Ch) && sz.IsBreakSym(in.Car()) { + return nil, false + } + } + inp.Next() + if len(ins) == 0 { + return nil, true + } + return sx.MakeList(ins...), true +} + +func (cp *zmkP) parseComment() (res *sx.Pair, success bool) { + inp := cp.inp + if inp.Next() != '%' { + return nil, false + } + for inp.Ch == '%' { + inp.Next() + } + attrs := cp.parseInlineAttributes() + cp.skipSpace() + pos := inp.Pos + for { + if input.IsEOLEOS(inp.Ch) { + return sx.MakeList( + sz.SymLiteralComment, + attrs, + sx.MakeString(string(inp.Src[pos:inp.Pos])), + ), true + } + inp.Next() + } +} + +var mapRuneFormat = map[rune]*sx.Symbol{ + '_': sz.SymFormatEmph, + '*': sz.SymFormatStrong, + '>': sz.SymFormatInsert, + '~': sz.SymFormatDelete, + '^': sz.SymFormatSuper, + ',': sz.SymFormatSub, + '"': sz.SymFormatQuote, + '#': sz.SymFormatMark, + ':': sz.SymFormatSpan, +} + +func (cp *zmkP) parseFormat() (res *sx.Pair, success bool) { + inp := cp.inp + fch := inp.Ch + symFormat, ok := mapRuneFormat[fch] + if !ok { + panic(fmt.Sprintf("%q is not a formatting char", fch)) + } + // read 2nd formatting character + if inp.Next() != fch { + return nil, false + } + inp.Next() + var inlines sx.Vector + for { + if inp.Ch == input.EOS { + return nil, false + } + if inp.Ch == fch { + if inp.Next() == fch { + inp.Next() + attrs := cp.parseInlineAttributes() + fn := sx.MakeList(inlines...).Cons(attrs).Cons(symFormat) + return fn, true + } + inlines = append(inlines, sx.MakeList(sz.SymText, sx.MakeString(string(fch)))) + } else if in := cp.parseInline(); in != nil { + if input.IsEOLEOS(inp.Ch) && sz.IsBreakSym(in.Car()) { + return nil, false + } + inlines = append(inlines, in) + } + } +} + +var mapRuneLiteral = map[rune]*sx.Symbol{ + '@': sz.SymLiteralZettel, + '`': sz.SymLiteralProg, + runeModGrave: sz.SymLiteralProg, + '\'': sz.SymLiteralInput, + '=': sz.SymLiteralOutput, + // No '$': sz.SymLiteralMath, because pairing literal math is a little different +} + +func (cp *zmkP) parseLiteral() (res *sx.Pair, success bool) { + inp := cp.inp + fch := inp.Ch + symLiteral, ok := mapRuneLiteral[fch] + if !ok { + panic(fmt.Sprintf("%q is not a formatting char", fch)) + } + // read 2nd formatting character + if inp.Next() != fch { + return nil, false + } + inp.Next() + var sb strings.Builder + for { + if inp.Ch == input.EOS { + return nil, false + } + if inp.Ch == fch { + if inp.Peek() == fch { + inp.Next() + inp.Next() + return createLiteralNode(symLiteral, cp.parseInlineAttributes(), sb.String()), true + } + sb.WriteRune(fch) + inp.Next() + } else { + s := cp.parseString() + sb.WriteString(s.GetValue()) + } + } +} + +func createLiteralNode(sym *sx.Symbol, attrs *sx.Pair, content string) *sx.Pair { + if sym.IsEqual(sz.SymLiteralZettel) { + if p := attrs.Assoc(sx.MakeString("")); p != nil { + if val, isString := sx.GetString(p.Cdr()); isString && val.GetValue() == api.ValueSyntaxHTML { + sym = sz.SymLiteralHTML + attrs = attrs.RemoveAssoc(sx.MakeString("")) + } + } + } + return sx.MakeList(sym, attrs, sx.MakeString(content)) +} + +func (cp *zmkP) parseLiteralMath() (res *sx.Pair, success bool) { + inp := cp.inp + // read 2nd formatting character + if inp.Next() != '$' { + return nil, false + } + inp.Next() + pos := inp.Pos + for { + if inp.Ch == input.EOS { + return nil, false + } + if inp.Ch == '$' && inp.Peek() == '$' { + content := append([]byte{}, inp.Src[pos:inp.Pos]...) + inp.Next() + inp.Next() + fn := sx.MakeList(sz.SymLiteralMath, cp.parseInlineAttributes(), sx.MakeString(string(content))) + return fn, true + } + inp.Next() + } +} + +func (cp *zmkP) parseNdash() (res *sx.Pair, success bool) { + inp := cp.inp + if inp.Peek() != inp.Ch { + return nil, false + } + inp.Next() + inp.Next() + return sx.MakeList(sz.SymText, sx.MakeString("\u2013")), true +} + +func (cp *zmkP) parseEntity() (res *sx.Pair, success bool) { + if text, ok := cp.inp.ScanEntity(); ok { + return sx.MakeList(sz.SymText, sx.MakeString(text)), true + } + return nil, false +} ADDED sz/zmk/post-processor.go Index: sz/zmk/post-processor.go ================================================================== --- /dev/null +++ sz/zmk/post-processor.go @@ -0,0 +1,569 @@ +//----------------------------------------------------------------------------- +// Copyright (c) 2020-present Detlef Stern +// +// This file is part of zettelstore-client. +// +// Zettelstore client is licensed under the latest version of the EUPL +// (European Union Public License). Please see file LICENSE.txt for your rights +// and obligations under this license. +// +// SPDX-License-Identifier: EUPL-1.2 +// SPDX-FileCopyrightText: 2020-present Detlef Stern +//----------------------------------------------------------------------------- + +package zmk + +import ( + "strings" + + "t73f.de/r/sx" + "t73f.de/r/zsc/sz" +) + +var symInVerse = sx.MakeSymbol("in-verse") +var symNoBlock = sx.MakeSymbol("no-block") + +type postProcessor struct{} + +func (pp *postProcessor) Visit(lst *sx.Pair, env *sx.Pair) sx.Object { + if lst == nil { + return nil + } + sym, isSym := sx.GetSymbol(lst.Car()) + if !isSym { + panic(lst) + } + if fn, found := symMap[sym]; found { + return fn(pp, lst, env) + } + return sx.Int64(0) +} + +func (pp *postProcessor) visitPairList(lst *sx.Pair, env *sx.Pair) *sx.Pair { + var pList sx.ListBuilder + for node := lst; node != nil; node = node.Tail() { + if elem := sz.Walk(pp, node.Head(), env); elem != nil { + pList.Add(elem) + } + } + return pList.List() +} + +var symMap map[*sx.Symbol]func(*postProcessor, *sx.Pair, *sx.Pair) *sx.Pair + +func init() { + symMap = map[*sx.Symbol]func(*postProcessor, *sx.Pair, *sx.Pair) *sx.Pair{ + sz.SymBlock: postProcessBlockList, + sz.SymPara: postProcessInlineList, + sz.SymRegionBlock: postProcessRegion, + sz.SymRegionQuote: postProcessRegion, + sz.SymRegionVerse: postProcessRegionVerse, + sz.SymVerbatimComment: postProcessVerbatim, + sz.SymVerbatimEval: postProcessVerbatim, + sz.SymVerbatimMath: postProcessVerbatim, + sz.SymVerbatimProg: postProcessVerbatim, + sz.SymVerbatimZettel: postProcessVerbatim, + sz.SymHeading: postProcessHeading, + sz.SymListOrdered: postProcessItemList, + sz.SymListUnordered: postProcessItemList, + sz.SymListQuote: postProcessQuoteList, + sz.SymDescription: postProcessDescription, + sz.SymTable: postProcessTable, + + sz.SymInline: postProcessInlineList, + sz.SymText: postProcessText, + sz.SymSoft: postProcessSoft, + sz.SymEndnote: postProcessEndnote, + sz.SymMark: postProcessMark, + sz.SymLinkBased: postProcessInlines4, + sz.SymLinkBroken: postProcessInlines4, + sz.SymLinkExternal: postProcessInlines4, + sz.SymLinkFound: postProcessInlines4, + sz.SymLinkHosted: postProcessInlines4, + sz.SymLinkInvalid: postProcessInlines4, + sz.SymLinkQuery: postProcessInlines4, + sz.SymLinkSelf: postProcessInlines4, + sz.SymLinkZettel: postProcessInlines4, + sz.SymEmbed: postProcessInlines4, + sz.SymCite: postProcessInlines4, + sz.SymFormatDelete: postProcessFormat, + sz.SymFormatEmph: postProcessFormat, + sz.SymFormatInsert: postProcessFormat, + sz.SymFormatMark: postProcessFormat, + sz.SymFormatQuote: postProcessFormat, + sz.SymFormatStrong: postProcessFormat, + sz.SymFormatSpan: postProcessFormat, + sz.SymFormatSub: postProcessFormat, + sz.SymFormatSuper: postProcessFormat, + + symSeparator: ignoreProcess, + } +} + +func ignoreProcess(*postProcessor, *sx.Pair, *sx.Pair) *sx.Pair { return nil } + +func postProcessBlockList(pp *postProcessor, lst *sx.Pair, env *sx.Pair) *sx.Pair { + result := pp.visitPairList(lst.Tail(), env) + if result == nil { + if noBlockPair := env.Assoc(symNoBlock); noBlockPair == nil || sx.IsTrue(noBlockPair.Cdr()) { + return nil + } + } + return result.Cons(lst.Car()) +} + +func postProcessInlineList(pp *postProcessor, lst *sx.Pair, env *sx.Pair) *sx.Pair { + sym := lst.Car() + if rest := pp.visitInlines(lst.Tail(), env); rest != nil { + return rest.Cons(sym) + } + return nil +} + +func postProcessRegion(pp *postProcessor, rn *sx.Pair, env *sx.Pair) *sx.Pair { + return doPostProcessRegion(pp, rn, env, env) +} + +func postProcessRegionVerse(pp *postProcessor, rn *sx.Pair, env *sx.Pair) *sx.Pair { + return doPostProcessRegion(pp, rn, env.Cons(sx.Cons(symInVerse, nil)), env) +} + +func doPostProcessRegion(pp *postProcessor, rn *sx.Pair, envBlock, envInline *sx.Pair) *sx.Pair { + + sym := rn.Car() + next := rn.Tail() + attrs := next.Car() + next = next.Tail() + blocks := pp.visitPairList(next.Head(), envBlock) + text := pp.visitInlines(next.Tail(), envInline) + if blocks == nil && text == nil { + return nil + } + return text.Cons(blocks).Cons(attrs).Cons(sym) +} + +func postProcessVerbatim(_ *postProcessor, verb *sx.Pair, _ *sx.Pair) *sx.Pair { + if content, isString := sx.GetString(verb.Tail().Tail().Car()); isString && content.GetValue() != "" { + return verb + } + return nil +} + +func postProcessHeading(pp *postProcessor, hn *sx.Pair, env *sx.Pair) *sx.Pair { + sym := hn.Car() + next := hn.Tail() + level := next.Car() + next = next.Tail() + attrs := next.Car() + next = next.Tail() + slug := next.Car() + next = next.Tail() + fragment := next.Car() + if text := pp.visitInlines(next.Tail(), env); text != nil { + return text.Cons(fragment).Cons(slug).Cons(attrs).Cons(level).Cons(sym) + } + return nil +} + +func postProcessItemList(pp *postProcessor, ln *sx.Pair, env *sx.Pair) *sx.Pair { + elems := pp.visitListElems(ln, env) + if elems == nil { + return nil + } + return elems.Cons(ln.Car()) +} + +func postProcessQuoteList(pp *postProcessor, ln *sx.Pair, env *sx.Pair) *sx.Pair { + elems := pp.visitListElems(ln, env.Cons(sx.Cons(symNoBlock, nil))) + + // Collect multiple paragraph items into one item. + + var newElems sx.ListBuilder + var newPara sx.ListBuilder + + addtoParagraph := func() { + if !newPara.IsEmpty() { + newElems.Add(sx.MakeList(sz.SymBlock, newPara.List().Cons(sz.SymPara))) + } + } + for node := elems; node != nil; node = node.Tail() { + item := node.Head() + if !item.Car().IsEqual(sz.SymBlock) { + continue + } + itemTail := item.Tail() + if itemTail == nil || itemTail.Tail() != nil { + addtoParagraph() + newElems.Add(item) + continue + } + if pn := itemTail.Head(); pn.Car().IsEqual(sz.SymPara) { + if !newPara.IsEmpty() { + newPara.Add(sx.Cons(sz.SymSoft, nil)) + } + newPara.ExtendBang(pn.Tail()) + continue + } + addtoParagraph() + newElems.Add(item) + } + addtoParagraph() + return newElems.List().Cons(ln.Car()) +} + +func (pp *postProcessor) visitListElems(ln *sx.Pair, env *sx.Pair) *sx.Pair { + var pList sx.ListBuilder + for node := ln.Tail(); node != nil; node = node.Tail() { + if elem := sz.Walk(pp, node.Head(), env); elem != nil { + pList.Add(elem) + } + } + return pList.List() +} + +func postProcessDescription(pp *postProcessor, dl *sx.Pair, env *sx.Pair) *sx.Pair { + var dList sx.ListBuilder + isTerm := false + for node := dl.Tail(); node != nil; node = node.Tail() { + isTerm = !isTerm + if isTerm { + dList.Add(pp.visitInlines(node.Head(), env)) + } else { + dList.Add(sz.Walk(pp, node.Head(), env)) + } + } + return dList.List().Cons(dl.Car()) +} + +func postProcessTable(pp *postProcessor, tbl *sx.Pair, env *sx.Pair) *sx.Pair { + sym := tbl.Car() + next := tbl.Tail() + header := next.Head() + if header != nil { + // Already post-processed + return tbl + } + rows, width := pp.visitRows(next.Tail(), env) + if rows == nil { + // Header and row are nil -> no table + return nil + } + header, rows, align := splitTableHeader(rows, width) + alignRow(header, align) + for node := rows; node != nil; node = node.Tail() { + alignRow(node.Head(), align) + } + return rows.Cons(header).Cons(sym) +} + +func (pp *postProcessor) visitRows(rows *sx.Pair, env *sx.Pair) (*sx.Pair, int) { + maxWidth := 0 + var pRows sx.ListBuilder + for node := rows; node != nil; node = node.Tail() { + row := node.Head() + row, width := pp.visitCells(row, env) + if maxWidth < width { + maxWidth = width + } + pRows.Add(row) + } + return pRows.List(), maxWidth +} + +func (pp *postProcessor) visitCells(cells *sx.Pair, env *sx.Pair) (*sx.Pair, int) { + width := 0 + var pCells sx.ListBuilder + for node := cells; node != nil; node = node.Tail() { + cell := node.Head() + ins := pp.visitInlines(cell.Tail(), env) + newCell := ins.Cons(cell.Car()) + pCells.Add(newCell) + width++ + } + return pCells.List(), width +} + +func splitTableHeader(rows *sx.Pair, width int) (header, realRows *sx.Pair, align []*sx.Symbol) { + align = make([]*sx.Symbol, width) + + foundHeader := false + cellCount := 0 + + // assert: rows != nil (checked in postProcessTable) + for node := rows.Head(); node != nil; node = node.Tail() { + cellCount++ + cell := node.Head() + cellTail := cell.Tail() + if cellTail == nil { + continue + } + + // elem is first cell inline element + elem := cellTail.Head() + if elem.Car().IsEqual(sz.SymText) { + if s, isString := sx.GetString(elem.Tail().Car()); isString && s.GetValue() != "" { + str := s.GetValue() + if str[0] == '=' { + foundHeader = true + elem.SetCdr(sx.Cons(sx.MakeString(str[1:]), nil)) + } + } + } + + // move to the last cell inline element + for { + next := cellTail.Tail() + if next == nil { + break + } + cellTail = next + } + + elem = cellTail.Head() + if elem.Car().IsEqual(sz.SymText) { + if s, isString := sx.GetString(elem.Tail().Car()); isString && s.GetValue() != "" { + str := s.GetValue() + cellAlign := getCellAlignment(str[len(str)-1]) + if !cellAlign.IsEqual(sz.SymCell) { + elem.SetCdr(sx.Cons(sx.MakeString(str[0:len(str)-1]), nil)) + } + align[cellCount-1] = cellAlign + cell.SetCar(cellAlign) + } + } + } + + if !foundHeader { + for i := 0; i < width; i++ { + align[i] = sz.SymCell // Default alignment + } + return nil, rows, align + } + + for i := 0; i < width; i++ { + if align[i] == nil { + align[i] = sz.SymCell // Default alignment + } + } + return rows.Head(), rows.Tail(), align +} + +func alignRow(row *sx.Pair, align []*sx.Symbol) { + if row == nil { + return + } + var lastCellNode *sx.Pair + cellCount := 0 + for node := row; node != nil; node = node.Tail() { + lastCellNode = node + cell := node.Head() + cell.SetCar(align[cellCount]) + cellCount++ + cellTail := cell.Tail() + if cellTail == nil { + continue + } + + // elem is first cell inline element + elem := cellTail.Head() + if elem.Car().IsEqual(sz.SymText) { + if s, isString := sx.GetString(elem.Tail().Car()); isString && s.GetValue() != "" { + str := s.GetValue() + cellAlign := getCellAlignment(str[0]) + if !cellAlign.IsEqual(sz.SymCell) { + elem.SetCdr(sx.Cons(sx.MakeString(str[1:]), nil)) + cell.SetCar(cellAlign) + } + } + } + } + + for cellCount < len(align) { + lastCellNode = lastCellNode.AppendBang(sx.Cons(align[cellCount], nil)) + cellCount++ + } +} + +func getCellAlignment(ch byte) *sx.Symbol { + switch ch { + case ':': + return sz.SymCellCenter + case '<': + return sz.SymCellLeft + case '>': + return sz.SymCellRight + default: + return sz.SymCell + } +} + +func (pp *postProcessor) visitInlines(lst *sx.Pair, env *sx.Pair) *sx.Pair { + length := lst.Length() + if length <= 0 { + return nil + } + inVerse := env.Assoc(symInVerse) != nil + vector := make([]*sx.Pair, 0, length) + // 1st phase: process all childs, ignore ' ' / '\t' at start, and merge some elements + for node := lst; node != nil; node = node.Tail() { + elem := sz.Walk(pp, node.Head(), env) + if elem == nil { + continue + } + elemSym := elem.Car() + if len(vector) == 0 { + // If the 1st element is a TEXT, remove all ' ', '\t' at the beginning, if outside a verse block. + if inVerse || !elemSym.IsEqual(sz.SymText) { + vector = append(vector, elem) + continue + } + + elemTail := elem.Tail() + elemText := elemTail.Car().(sx.String).GetValue() + if elemText != "" && (elemText[0] == ' ' || elemText[0] == '\t') { + for elemText != "" { + if ch := elemText[0]; ch != ' ' && ch != '\t' { + break + } + elemText = elemText[1:] + } + elemTail.SetCar(sx.MakeString(elemText)) + } + if elemText != "" { + vector = append(vector, elem) + } + continue + } + last := vector[len(vector)-1] + lastSym := last.Car() + + if lastSym.IsEqual(sz.SymText) && elemSym.IsEqual(sz.SymText) { + // Merge two TEXT elements into one + lastText := last.Tail().Car().(sx.String).GetValue() + elemText := elem.Tail().Car().(sx.String).GetValue() + last.SetCdr(sx.Cons(sx.MakeString(lastText+elemText), sx.Nil())) + continue + } + + if lastSym.IsEqual(sz.SymText) && elemSym.IsEqual(sz.SymSoft) { + // Merge (TEXT "... ") (SOFT) to (TEXT "...") (HARD) + lastTail := last.Tail() + if lastText := lastTail.Car().(sx.String).GetValue(); strings.HasSuffix(lastText, " ") { + newText := removeTrailingSpaces(lastText) + if newText == "" { + vector[len(vector)-1] = sx.Cons(sz.SymHard, sx.Nil()) + continue + } + lastTail.SetCar(sx.MakeString(newText)) + elemSym = sz.SymHard + elem.SetCar(elemSym) + } + } + + vector = append(vector, elem) + } + if len(vector) == 0 { + return nil + } + + // 2nd phase: remove (SOFT), (HARD) at the end, remove trailing spaces in (TEXT "...") + lastPos := len(vector) - 1 + for lastPos >= 0 { + elem := vector[lastPos] + elemSym := elem.Car() + if elemSym.IsEqual(sz.SymText) { + elemTail := elem.Tail() + elemText := elemTail.Car().(sx.String).GetValue() + newText := removeTrailingSpaces(elemText) + if newText != "" { + elemTail.SetCar(sx.MakeString(newText)) + break + } + lastPos-- + } else if sz.IsBreakSym(elemSym) { + lastPos-- + } else { + break + } + } + if lastPos < 0 { + return nil + } + + result := sx.Cons(vector[0], nil) + curr := result + for i := 1; i <= lastPos; i++ { + curr = curr.AppendBang(vector[i]) + } + return result +} + +func removeTrailingSpaces(s string) string { + for len(s) > 0 { + if ch := s[len(s)-1]; ch != ' ' && ch != '\t' { + return s + } + s = s[0 : len(s)-1] + } + return "" +} + +func postProcessText(_ *postProcessor, txt *sx.Pair, _ *sx.Pair) *sx.Pair { + if tail := txt.Tail(); tail != nil { + if content, isString := sx.GetString(tail.Car()); isString && content.GetValue() != "" { + return txt + } + } + return nil +} + +func postProcessSoft(_ *postProcessor, sn *sx.Pair, env *sx.Pair) *sx.Pair { + if env.Assoc(symInVerse) == nil { + return sn + } + return sx.Cons(sz.SymHard, nil) +} + +func postProcessEndnote(pp *postProcessor, en *sx.Pair, env *sx.Pair) *sx.Pair { + sym := en.Car() + next := en.Tail() + attrs := next.Car() + if text := pp.visitInlines(next.Tail(), env); text != nil { + return text.Cons(attrs).Cons(sym) + } + return sx.MakeList(sym, attrs) +} + +func postProcessMark(pp *postProcessor, en *sx.Pair, env *sx.Pair) *sx.Pair { + sym := en.Car() + next := en.Tail() + mark := next.Car() + next = next.Tail() + slug := next.Car() + next = next.Tail() + fragment := next.Car() + text := pp.visitInlines(next.Tail(), env) + return text.Cons(fragment).Cons(slug).Cons(mark).Cons(sym) +} + +func postProcessInlines4(pp *postProcessor, ln *sx.Pair, env *sx.Pair) *sx.Pair { + sym := ln.Car() + next := ln.Tail() + attrs := next.Car() + next = next.Tail() + val3 := next.Car() + text := pp.visitInlines(next.Tail(), env) + return text.Cons(val3).Cons(attrs).Cons(sym) +} + +func postProcessFormat(pp *postProcessor, fn *sx.Pair, env *sx.Pair) *sx.Pair { + symFormat := fn.Car() + next := fn.Tail() // Attrs + attrs := next.Car() + next = next.Tail() // Possible inlines + if next == nil { + return fn + } + inlines := pp.visitInlines(next, env) + return inlines.Cons(attrs).Cons(symFormat) +} ADDED sz/zmk/ref.go Index: sz/zmk/ref.go ================================================================== --- /dev/null +++ sz/zmk/ref.go @@ -0,0 +1,106 @@ +// ----------------------------------------------------------------------------- +// Copyright (c) 2020-present Detlef Stern +// +// This file is part of zettelstore-client. +// +// Zettelstore client is licensed under the latest version of the EUPL +// (European Union Public License). Please see file LICENSE.txt for your rights +// and obligations under this license. +// +// SPDX-License-Identifier: EUPL-1.2 +// SPDX-FileCopyrightText: 2020-present Detlef Stern +// ----------------------------------------------------------------------------- +package zmk + +import ( + "net/url" + "strings" + + "t73f.de/r/sx" + "t73f.de/r/zsc/api" + "t73f.de/r/zsc/sz" +) + +// ParseReference parses a string and returns a reference. +func ParseReference(s string) *sx.Pair { + if invalidReference(s) { + return makePairRef(sz.SymRefStateInvalid, s) + } + if strings.HasPrefix(s, api.QueryPrefix) { + return makePairRef(sz.SymRefStateQuery, s[len(api.QueryPrefix):]) + } + if state, ok := localState(s); ok { + if state.IsEqual(sz.SymRefStateBased) { + s = s[1:] + } + _, err := url.Parse(s) + if err == nil { + return makePairRef(state, s) + } + } + u, err := url.Parse(s) + if err != nil { + return makePairRef(sz.SymRefStateInvalid, s) + } + if !externalURL(u) { + zid := api.ZettelID(u.Path) + if zid.IsValid() { + return makePairRef(sz.SymRefStateZettel, s) + } + if u.Path == "" && u.Fragment != "" { + return makePairRef(sz.SymRefStateSelf, s) + } + } + return makePairRef(sz.SymRefStateExternal, s) +} +func makePairRef(sym *sx.Symbol, val string) *sx.Pair { + return sx.MakeList(sym, sx.MakeString(val)) +} + +func invalidReference(s string) bool { return s == "" || s == "00000000000000" } + +func externalURL(u *url.URL) bool { + return u.Scheme != "" || u.Opaque != "" || u.Host != "" || u.User != nil +} + +func localState(path string) (*sx.Symbol, bool) { + if len(path) > 0 && path[0] == '/' { + if len(path) > 1 && path[1] == '/' { + return sz.SymRefStateBased, true + } + return sz.SymRefStateHosted, true + } + if len(path) > 1 && path[0] == '.' { + if len(path) > 2 && path[1] == '.' && path[2] == '/' { + return sz.SymRefStateHosted, true + } + return sz.SymRefStateHosted, path[1] == '/' + } + return sz.SymRefStateInvalid, false +} + +// ReferenceIsValid returns true if reference is valid +func ReferenceIsValid(ref *sx.Pair) bool { + return !ref.Car().IsEqual(sz.SymRefStateInvalid) +} + +// ReferenceIsZettel returns true if it is a reference to a local zettel. +func ReferenceIsZettel(ref *sx.Pair) bool { + state := ref.Car() + return state.IsEqual(sz.SymRefStateZettel) || + state.IsEqual(sz.SymRefStateSelf) || + state.IsEqual(sz.SymRefStateFound) || + state.IsEqual(sz.SymRefStateBroken) +} + +// ReferenceIsLocal returns true if reference is local +func ReferenceIsLocal(ref *sx.Pair) bool { + state := ref.Car() + return state.IsEqual(sz.SymRefStateHosted) || + state.IsEqual(sz.SymRefStateBased) +} + +// ReferenceIsExternal returns true if it is a reference to external material. +func ReferenceIsExternal(ref *sx.Pair) bool { + return ref.Car().IsEqual(sz.SymRefStateExternal) +} ADDED sz/zmk/ref_test.go Index: sz/zmk/ref_test.go ================================================================== --- /dev/null +++ sz/zmk/ref_test.go @@ -0,0 +1,99 @@ +// ----------------------------------------------------------------------------- +// Copyright (c) 2020-present Detlef Stern +// +// This file is part of zettelstore-client. +// +// Zettelstore client is licensed under the latest version of the EUPL +// (European Union Public License). Please see file LICENSE.txt for your rights +// and obligations under this license. +// +// SPDX-License-Identifier: EUPL-1.2 +// SPDX-FileCopyrightText: 2020-present Detlef Stern +// ----------------------------------------------------------------------------- +package zmk_test + +import ( + "testing" + + "t73f.de/r/zsc/sz/zmk" +) + +func TestParseReference(t *testing.T) { + t.Parallel() + testcases := []struct { + link string + err bool + exp string + }{ + {"", true, ""}, + {"12345678901234", false, "(ZETTEL \"12345678901234\")"}, + {"123", false, "(EXTERNAL \"123\")"}, + {",://", true, ""}, + } + + for i, tc := range testcases { + got := zmk.ParseReference(tc.link) + gotIsValid := zmk.ReferenceIsValid(got) + if gotIsValid == tc.err { + t.Errorf( + "TC=%d, expected parse error of %q: %v, but got %q", i, tc.link, tc.err, got) + } + if gotIsValid && got.String() != tc.exp { + t.Errorf("TC=%d, Reference of %q is %q, but got %q", i, tc.link, tc.exp, got) + } + } +} + +func TestReferenceIsZettelMaterial(t *testing.T) { + t.Parallel() + testcases := []struct { + link string + isZettel bool + isExternal bool + isLocal bool + }{ + {"", false, false, false}, + {"00000000000000", false, false, false}, + {"http://zettelstore.de/z/ast", false, true, false}, + {"12345678901234", true, false, false}, + {"12345678901234#local", true, false, false}, + {"http://12345678901234", false, true, false}, + {"http://zettelstore.de/z/12345678901234", false, true, false}, + {"http://zettelstore.de/12345678901234", false, true, false}, + {"/12345678901234", false, false, true}, + {"//12345678901234", false, false, true}, + {"./12345678901234", false, false, true}, + {"../12345678901234", false, false, true}, + {".../12345678901234", false, true, false}, + } + + for i, tc := range testcases { + ref := zmk.ParseReference(tc.link) + isZettel := zmk.ReferenceIsZettel(ref) + if isZettel != tc.isZettel { + t.Errorf( + "TC=%d, Reference %q isZettel=%v expected, but got %v", + i, + tc.link, + tc.isZettel, + isZettel) + } + isLocal := zmk.ReferenceIsLocal(ref) + if isLocal != tc.isLocal { + t.Errorf( + "TC=%d, Reference %q isLocal=%v expected, but got %v", + i, + tc.link, + tc.isLocal, isLocal) + } + isExternal := zmk.ReferenceIsExternal(ref) + if isExternal != tc.isExternal { + t.Errorf( + "TC=%d, Reference %q isExternal=%v expected, but got %v", + i, + tc.link, + tc.isExternal, + isExternal) + } + } +} ADDED sz/zmk/zmk.go Index: sz/zmk/zmk.go ================================================================== --- /dev/null +++ sz/zmk/zmk.go @@ -0,0 +1,286 @@ +//----------------------------------------------------------------------------- +// Copyright (c) 2020-present Detlef Stern +// +// This file is part of zettelstore-client. +// +// Zettelstore client is licensed under the latest version of the EUPL +// (European Union Public License). Please see file LICENSE.txt for your rights +// and obligations under this license. +// +// SPDX-License-Identifier: EUPL-1.2 +// SPDX-FileCopyrightText: 2020-present Detlef Stern +//----------------------------------------------------------------------------- + +// Package zmk provides a parser for zettelmarkup. +package zmk + +import ( + "slices" + "strings" + "unicode" + + "t73f.de/r/sx" + "t73f.de/r/zsc/input" + "t73f.de/r/zsc/sz" +) + +func ParseBlocks(inp *input.Input) *sx.Pair { + parser := zmkP{inp: inp} + + var lastPara *sx.Pair + var blkBuild sx.ListBuilder + for inp.Ch != input.EOS { + bn, cont := parser.parseBlock(lastPara) + if bn != nil { + blkBuild.Add(bn) + } + if !cont { + if bn.Car().IsEqual(sz.SymPara) { + lastPara = bn + } else { + lastPara = nil + } + } + } + if parser.nestingLevel != 0 { + panic("Nesting level was not decremented") + } + + bnl := blkBuild.List() + var pp postProcessor + if bs := pp.visitPairList(bnl, nil); bs != nil { + return bs.Cons(sz.SymBlock) + } + return nil +} + +func ParseInlines(inp *input.Input) *sx.Pair { + parser := zmkP{inp: inp} + var ins sx.Vector + for inp.Ch != input.EOS { + in := parser.parseInline() + if in == nil { + break + } + ins = append(ins, in) + } + + inl := ins.MakeList().Cons(sz.SymInline) + var pp postProcessor + return sz.Walk(&pp, inl, nil) +} + +type zmkP struct { + inp *input.Input // Input stream + lists []*sx.Pair // Stack of lists + lastRow *sx.Pair // Last row of table, or nil if not in table. + descrl *sx.Pair // Current description list + nestingLevel int // Count nesting of block and inline elements + + inVerse bool // Currently in a vers region? +} + +// runeModGrave is Unicode code point U+02CB (715) called "MODIFIER LETTER +// GRAVE ACCENT". On the iPad it is much more easier to type in this code point +// than U+0060 (96) "Grave accent" (aka backtick). Therefore, U+02CB will be +// considered equivalent to U+0060. +const runeModGrave = 'ˋ' // This is NOT '`'! + +const maxNestingLevel = 50 + +// clearStacked removes all multi-line nodes from parser. +func (cp *zmkP) clearStacked() { + cp.lists = nil + cp.lastRow = nil + cp.descrl = nil +} + +type attrMap map[string]string + +func (attrs attrMap) updateAttrs(key, val string) { + if prevVal := attrs[key]; len(prevVal) > 0 { + attrs[key] = prevVal + " " + val + } else { + attrs[key] = val + } +} + +func (attrs attrMap) asPairAssoc() *sx.Pair { + names := make([]string, 0, len(attrs)) + for n := range attrs { + names = append(names, n) + } + slices.Sort(names) + var assoc *sx.Pair = nil + for i := len(names) - 1; i >= 0; i-- { + n := names[i] + assoc = assoc.Cons(sx.Cons(sx.MakeString(n), sx.MakeString(attrs[n]))) + } + return assoc +} + +func (cp *zmkP) parseNormalAttribute(attrs attrMap) bool { + inp := cp.inp + posK := inp.Pos + for isNameRune(inp.Ch) { + inp.Next() + } + if posK == inp.Pos { + return false + } + key := string(inp.Src[posK:inp.Pos]) + if inp.Ch != '=' { + attrs[key] = "" + return true + } + return cp.parseAttributeValue(key, attrs) +} + +func (cp *zmkP) parseAttributeValue(key string, attrs attrMap) bool { + inp := cp.inp + if inp.Next() == '"' { + return cp.parseQuotedAttributeValue(key, attrs) + } + posV := inp.Pos + for { + switch inp.Ch { + case input.EOS: + return false + case '\n', '\r', ' ', ',', '}': + attrs.updateAttrs(key, string(inp.Src[posV:inp.Pos])) + return true + } + inp.Next() + } +} + +func (cp *zmkP) parseQuotedAttributeValue(key string, attrs attrMap) bool { + inp := cp.inp + inp.Next() + var sb strings.Builder + for { + switch inp.Ch { + case input.EOS: + return false + case '"': + attrs.updateAttrs(key, sb.String()) + inp.Next() + return true + case '\\': + switch inp.Next() { + case input.EOS, '\n', '\r': + return false + } + fallthrough + default: + sb.WriteRune(inp.Ch) + inp.Next() + } + } + +} + +func (cp *zmkP) parseBlockAttributes() *sx.Pair { + inp := cp.inp + pos := inp.Pos + for isNameRune(inp.Ch) { + inp.Next() + } + if pos < inp.Pos { + return attrMap{"": string(inp.Src[pos:inp.Pos])}.asPairAssoc() + } + + // No immediate name: skip spaces + cp.skipSpace() + return cp.parseInlineAttributes() +} + +func (cp *zmkP) parseInlineAttributes() *sx.Pair { + inp := cp.inp + pos := inp.Pos + if attrs, success := cp.doParseAttributes(); success { + return attrs + } + inp.SetPos(pos) + return nil +} + +// doParseAttributes reads attributes. +func (cp *zmkP) doParseAttributes() (res *sx.Pair, success bool) { + inp := cp.inp + if inp.Ch != '{' { + return nil, false + } + inp.Next() + a := attrMap{} + if !cp.parseAttributeValues(a) { + return nil, false + } + inp.Next() + return a.asPairAssoc(), true +} + +func (cp *zmkP) parseAttributeValues(a attrMap) bool { + inp := cp.inp + for { + cp.skipSpaceLine() + switch inp.Ch { + case input.EOS: + return false + case '}': + return true + case '.': + inp.Next() + posC := inp.Pos + for isNameRune(inp.Ch) { + inp.Next() + } + if posC == inp.Pos { + return false + } + a.updateAttrs("class", string(inp.Src[posC:inp.Pos])) + case '=': + delete(a, "") + if !cp.parseAttributeValue("", a) { + return false + } + default: + if !cp.parseNormalAttribute(a) { + return false + } + } + + switch inp.Ch { + case '}': + return true + case '\n', '\r': + case ' ', ',': + inp.Next() + default: + return false + } + } +} + +func (cp *zmkP) skipSpaceLine() { + for inp := cp.inp; ; { + switch inp.Ch { + case ' ': + inp.Next() + case '\n', '\r': + inp.EatEOL() + default: + return + } + } +} + +func (cp *zmkP) skipSpace() { + for inp := cp.inp; inp.Ch == ' '; { + inp.Next() + } +} + +func isNameRune(ch rune) bool { + return unicode.IsLetter(ch) || unicode.IsDigit(ch) || ch == '-' || ch == '_' +} ADDED sz/zmk/zmk_fuzz_test.go Index: sz/zmk/zmk_fuzz_test.go ================================================================== --- /dev/null +++ sz/zmk/zmk_fuzz_test.go @@ -0,0 +1,29 @@ +//----------------------------------------------------------------------------- +// Copyright (c) 2022-present Detlef Stern +// +// This file is part of zettelstore-client. +// +// Zettelstore client is licensed under the latest version of the EUPL +// (European Union Public License). Please see file LICENSE.txt for your rights +// and obligations under this license. +// +// SPDX-License-Identifier: EUPL-1.2 +// SPDX-FileCopyrightText: 2022-present Detlef Stern +//----------------------------------------------------------------------------- + +package zmk_test + +import ( + "testing" + + "t73f.de/r/zsc/input" + "t73f.de/r/zsc/sz/zmk" +) + +func FuzzParseBlocks(f *testing.F) { + f.Fuzz(func(t *testing.T, src []byte) { + t.Parallel() + inp := input.NewInput(src) + zmk.ParseBlocks(inp) + }) +} ADDED sz/zmk/zmk_test.go Index: sz/zmk/zmk_test.go ================================================================== --- /dev/null +++ sz/zmk/zmk_test.go @@ -0,0 +1,859 @@ +//----------------------------------------------------------------------------- +// Copyright (c) 2020-present Detlef Stern +// +// This file is part of zettelstore-client. +// +// Zettelstore client is licensed under the latest version of the EUPL +// (European Union Public License). Please see file LICENSE.txt for your rights +// and obligations under this license. +// +// SPDX-License-Identifier: EUPL-1.2 +// SPDX-FileCopyrightText: 2020-present Detlef Stern +//----------------------------------------------------------------------------- + +// Package zmk_test provides some tests for the zettelmarkup parser. +package zmk_test + +import ( + "fmt" + "strings" + "testing" + + "t73f.de/r/sx" + "t73f.de/r/zsc/input" + "t73f.de/r/zsc/sz" + "t73f.de/r/zsc/sz/zmk" +) + +type TestCase struct{ source, want string } +type TestCases []TestCase +type symbolMap map[string]*sx.Symbol + +func replace(s string, sm symbolMap, tcs TestCases) TestCases { + var sym string + if len(sm) > 0 { + sym = sm[s].GetValue() + } + var testCases TestCases + for _, tc := range tcs { + source := strings.ReplaceAll(tc.source, "$", s) + want := tc.want + if sym != "" { + want = strings.ReplaceAll(want, "$%", sym) + } + want = strings.ReplaceAll(want, "$", s) + testCases = append(testCases, TestCase{source, want}) + } + return testCases +} + +func checkTcs(t *testing.T, isBlock bool, tcs TestCases) { + t.Helper() + + for tcn, tc := range tcs { + t.Run(fmt.Sprintf("TC=%02d,src=%q", tcn, tc.source), func(st *testing.T) { + st.Helper() + ast := parseInput(tc.source, isBlock) + got := ast.String() + if tc.want != got { + st.Errorf("\nwant=%q\n got=%q", tc.want, got) + } + }) + } +} +func parseInput(src string, asBlock bool) sx.Sequence { + inp := input.NewInput([]byte(src)) + if asBlock { + bl := zmk.ParseBlocks(inp) + return bl + } + il := zmk.ParseInlines(inp) + return il +} + +func TestEOL(t *testing.T) { + t.Parallel() + for _, isBlock := range []bool{true, false} { + checkTcs(t, isBlock, TestCases{ + {"", "()"}, + {"\n", "()"}, + {"\r", "()"}, + {"\r\n", "()"}, + {"\n\n", "()"}, + }) + } +} + +func TestText(t *testing.T) { + t.Parallel() + checkTcs(t, false, TestCases{ + {"abcd", "(INLINE (TEXT \"abcd\"))"}, + {"ab cd", "(INLINE (TEXT \"ab cd\"))"}, + {"abcd ", "(INLINE (TEXT \"abcd\"))"}, + {" abcd", "(INLINE (TEXT \"abcd\"))"}, + {"\\", "(INLINE (TEXT \"\\\\\"))"}, + {"\\\n", "()"}, + {"\\\ndef", "(INLINE (HARD) (TEXT \"def\"))"}, + {"\\\r", "()"}, + {"\\\rdef", "(INLINE (HARD) (TEXT \"def\"))"}, + {"\\\r\n", "()"}, + {"\\\r\ndef", "(INLINE (HARD) (TEXT \"def\"))"}, + {"\\a", "(INLINE (TEXT \"a\"))"}, + {"\\aa", "(INLINE (TEXT \"aa\"))"}, + {"a\\a", "(INLINE (TEXT \"aa\"))"}, + {"\\+", "(INLINE (TEXT \"+\"))"}, + {"\\ ", "(INLINE (TEXT \"\u00a0\"))"}, + {"http://a, http://b", "(INLINE (TEXT \"http://a, http://b\"))"}, + }) +} + +func TestSpace(t *testing.T) { + t.Parallel() + for _, isBlock := range []bool{true, false} { + checkTcs(t, isBlock, TestCases{ + {" ", "()"}, + {"\t", "()"}, + {" ", "()"}, + }) + } +} + +func TestSoftBreak(t *testing.T) { + t.Parallel() + checkTcs(t, false, TestCases{ + {"x\ny", "(INLINE (TEXT \"x\") (SOFT) (TEXT \"y\"))"}, + {"z\n", "(INLINE (TEXT \"z\"))"}, + {" \n ", "()"}, + {" \n", "()"}, + }) +} + +func TestHardBreak(t *testing.T) { + t.Parallel() + checkTcs(t, false, TestCases{ + {"x \ny", "(INLINE (TEXT \"x\") (HARD) (TEXT \"y\"))"}, + {"z \n", "(INLINE (TEXT \"z\"))"}, + {" \n ", "()"}, + {" \n", "()"}, + }) +} + +func TestLink(t *testing.T) { + t.Parallel() + checkTcs(t, false, TestCases{ + {"[", "(INLINE (TEXT \"[\"))"}, + {"[[", "(INLINE (TEXT \"[[\"))"}, + {"[[|", "(INLINE (TEXT \"[[|\"))"}, + {"[[]", "(INLINE (TEXT \"[[]\"))"}, + {"[[|]", "(INLINE (TEXT \"[[|]\"))"}, + {"[[]]", "(INLINE (TEXT \"[[]]\"))"}, + {"[[|]]", "(INLINE (TEXT \"[[|]]\"))"}, + {"[[ ]]", "(INLINE (TEXT \"[[ ]]\"))"}, + {"[[\n]]", "(INLINE (TEXT \"[[\") (SOFT) (TEXT \"]]\"))"}, + {"[[ a]]", "(INLINE (LINK-EXTERNAL () \"a\"))"}, + {"[[a ]]", "(INLINE (TEXT \"[[a ]]\"))"}, + {"[[a\n]]", "(INLINE (TEXT \"[[a\") (SOFT) (TEXT \"]]\"))"}, + {"[[a]]", "(INLINE (LINK-EXTERNAL () \"a\"))"}, + {"[[12345678901234]]", "(INLINE (LINK-ZETTEL () \"12345678901234\"))"}, + {"[[a]", "(INLINE (TEXT \"[[a]\"))"}, + {"[[|a]]", "(INLINE (TEXT \"[[|a]]\"))"}, + {"[[b|]]", "(INLINE (TEXT \"[[b|]]\"))"}, + {"[[b|a]]", "(INLINE (LINK-EXTERNAL () \"a\" (TEXT \"b\")))"}, + {"[[b| a]]", "(INLINE (LINK-EXTERNAL () \"a\" (TEXT \"b\")))"}, + {"[[b%c|a]]", "(INLINE (LINK-EXTERNAL () \"a\" (TEXT \"b%c\")))"}, + {"[[b%%c|a]]", "(INLINE (TEXT \"[[b\") (LITERAL-COMMENT () \"c|a]]\"))"}, + {"[[b|a]", "(INLINE (TEXT \"[[b|a]\"))"}, + {"[[b\nc|a]]", "(INLINE (LINK-EXTERNAL () \"a\" (TEXT \"b\") (SOFT) (TEXT \"c\")))"}, + {"[[b c|a#n]]", "(INLINE (LINK-EXTERNAL () \"a#n\" (TEXT \"b c\")))"}, + {"[[a]]go", "(INLINE (LINK-EXTERNAL () \"a\") (TEXT \"go\"))"}, + {"[[b|a]]{go}", "(INLINE (LINK-EXTERNAL ((\"go\" . \"\")) \"a\" (TEXT \"b\")))"}, + {"[[[[a]]|b]]", "(INLINE (TEXT \"[[\") (LINK-EXTERNAL () \"a\") (TEXT \"|b]]\"))"}, + {"[[a[b]c|d]]", "(INLINE (LINK-EXTERNAL () \"d\" (TEXT \"a[b]c\")))"}, + {"[[[b]c|d]]", "(INLINE (TEXT \"[\") (LINK-EXTERNAL () \"d\" (TEXT \"b]c\")))"}, + {"[[a[]c|d]]", "(INLINE (LINK-EXTERNAL () \"d\" (TEXT \"a[]c\")))"}, + {"[[a[b]|d]]", "(INLINE (LINK-EXTERNAL () \"d\" (TEXT \"a[b]\")))"}, + {"[[\\|]]", "(INLINE (LINK-EXTERNAL () \"\\\\|\"))"}, + {"[[\\||a]]", "(INLINE (LINK-EXTERNAL () \"a\" (TEXT \"|\")))"}, + {"[[b\\||a]]", "(INLINE (LINK-EXTERNAL () \"a\" (TEXT \"b|\")))"}, + {"[[b\\|c|a]]", "(INLINE (LINK-EXTERNAL () \"a\" (TEXT \"b|c\")))"}, + {"[[\\]]]", "(INLINE (LINK-EXTERNAL () \"\\\\]\"))"}, + {"[[\\]|a]]", "(INLINE (LINK-EXTERNAL () \"a\" (TEXT \"]\")))"}, + {"[[b\\]|a]]", "(INLINE (LINK-EXTERNAL () \"a\" (TEXT \"b]\")))"}, + {"[[\\]\\||a]]", "(INLINE (LINK-EXTERNAL () \"a\" (TEXT \"]|\")))"}, + {"[[http://a]]", "(INLINE (LINK-EXTERNAL () \"http://a\"))"}, + {"[[http://a|http://a]]", "(INLINE (LINK-EXTERNAL () \"http://a\" (TEXT \"http://a\")))"}, + {"[[[[a]]]]", "(INLINE (TEXT \"[[\") (LINK-EXTERNAL () \"a\") (TEXT \"]]\"))"}, + {"[[query:title]]", "(INLINE (LINK-QUERY () \"title\"))"}, + {"[[query:title syntax]]", "(INLINE (LINK-QUERY () \"title syntax\"))"}, + {"[[query:title | action]]", "(INLINE (LINK-QUERY () \"title | action\"))"}, + {"[[Text|query:title]]", "(INLINE (LINK-QUERY () \"title\" (TEXT \"Text\")))"}, + {"[[Text|query:title syntax]]", "(INLINE (LINK-QUERY () \"title syntax\" (TEXT \"Text\")))"}, + {"[[Text|query:title | action]]", "(INLINE (LINK-QUERY () \"title | action\" (TEXT \"Text\")))"}, + }) +} + +func TestEmbed(t *testing.T) { + t.Parallel() + checkTcs(t, false, TestCases{ + {"{", "(INLINE (TEXT \"{\"))"}, + {"{{", "(INLINE (TEXT \"{{\"))"}, + {"{{|", "(INLINE (TEXT \"{{|\"))"}, + {"{{}", "(INLINE (TEXT \"{{}\"))"}, + {"{{|}", "(INLINE (TEXT \"{{|}\"))"}, + {"{{}}", "(INLINE (TEXT \"{{}}\"))"}, + {"{{|}}", "(INLINE (TEXT \"{{|}}\"))"}, + {"{{ }}", "(INLINE (TEXT \"{{ }}\"))"}, + {"{{\n}}", "(INLINE (TEXT \"{{\") (SOFT) (TEXT \"}}\"))"}, + {"{{a }}", "(INLINE (TEXT \"{{a }}\"))"}, + {"{{a\n}}", "(INLINE (TEXT \"{{a\") (SOFT) (TEXT \"}}\"))"}, + {"{{a}}", "(INLINE (EMBED () \"a\"))"}, + {"{{12345678901234}}", "(INLINE (EMBED () \"12345678901234\"))"}, + {"{{ a}}", "(INLINE (EMBED () \"a\"))"}, + {"{{a}", "(INLINE (TEXT \"{{a}\"))"}, + {"{{|a}}", "(INLINE (TEXT \"{{|a}}\"))"}, + {"{{b|}}", "(INLINE (TEXT \"{{b|}}\"))"}, + {"{{b|a}}", "(INLINE (EMBED () \"a\" (TEXT \"b\")))"}, + {"{{b| a}}", "(INLINE (EMBED () \"a\" (TEXT \"b\")))"}, + {"{{b|a}", "(INLINE (TEXT \"{{b|a}\"))"}, + {"{{b\nc|a}}", "(INLINE (EMBED () \"a\" (TEXT \"b\") (SOFT) (TEXT \"c\")))"}, + {"{{b c|a#n}}", "(INLINE (EMBED () \"a#n\" (TEXT \"b c\")))"}, + {"{{a}}{go}", "(INLINE (EMBED ((\"go\" . \"\")) \"a\"))"}, + {"{{{{a}}|b}}", "(INLINE (TEXT \"{{\") (EMBED () \"a\") (TEXT \"|b}}\"))"}, + {"{{\\|}}", "(INLINE (EMBED () \"\\\\|\"))"}, + {"{{\\||a}}", "(INLINE (EMBED () \"a\" (TEXT \"|\")))"}, + {"{{b\\||a}}", "(INLINE (EMBED () \"a\" (TEXT \"b|\")))"}, + {"{{b\\|c|a}}", "(INLINE (EMBED () \"a\" (TEXT \"b|c\")))"}, + {"{{\\}}}", "(INLINE (EMBED () \"\\\\}\"))"}, + {"{{\\}|a}}", "(INLINE (EMBED () \"a\" (TEXT \"}\")))"}, + {"{{b\\}|a}}", "(INLINE (EMBED () \"a\" (TEXT \"b}\")))"}, + {"{{\\}\\||a}}", "(INLINE (EMBED () \"a\" (TEXT \"}|\")))"}, + {"{{http://a}}", "(INLINE (EMBED () \"http://a\"))"}, + {"{{http://a|http://a}}", "(INLINE (EMBED () \"http://a\" (TEXT \"http://a\")))"}, + {"{{{{a}}}}", "(INLINE (TEXT \"{{\") (EMBED () \"a\") (TEXT \"}}\"))"}, + }) +} + +func TestCite(t *testing.T) { + t.Parallel() + checkTcs(t, false, TestCases{ + {"[@", "(INLINE (TEXT \"[@\"))"}, + {"[@]", "(INLINE (TEXT \"[@]\"))"}, + {"[@a]", "(INLINE (CITE () \"a\"))"}, + {"[@ a]", "(INLINE (TEXT \"[@ a]\"))"}, + {"[@a ]", "(INLINE (CITE () \"a\"))"}, + {"[@a\n]", "(INLINE (CITE () \"a\"))"}, + {"[@a\nx]", "(INLINE (CITE () \"a\" (SOFT) (TEXT \"x\")))"}, + {"[@a\n\n]", "(INLINE (TEXT \"[@a\") (SOFT) (SOFT) (TEXT \"]\"))"}, + {"[@a,\n]", "(INLINE (CITE () \"a\"))"}, + {"[@a,n]", "(INLINE (CITE () \"a\" (TEXT \"n\")))"}, + {"[@a| n]", "(INLINE (CITE () \"a\" (TEXT \"n\")))"}, + {"[@a|n ]", "(INLINE (CITE () \"a\" (TEXT \"n\")))"}, + {"[@a,[@b]]", "(INLINE (CITE () \"a\" (CITE () \"b\")))"}, + {"[@a]{color=green}", "(INLINE (CITE ((\"color\" . \"green\")) \"a\"))"}, + }) + checkTcs(t, true, TestCases{ + {"[@a\n\n]", "(BLOCK (PARA (TEXT \"[@a\")) (PARA (TEXT \"]\")))"}, + }) +} + +func TestEndnote(t *testing.T) { + t.Parallel() + checkTcs(t, false, TestCases{ + {"[^", "(INLINE (TEXT \"[^\"))"}, + {"[^]", "(INLINE (ENDNOTE ()))"}, + {"[^abc]", "(INLINE (ENDNOTE () (TEXT \"abc\")))"}, + {"[^abc ]", "(INLINE (ENDNOTE () (TEXT \"abc\")))"}, + {"[^abc\ndef]", "(INLINE (ENDNOTE () (TEXT \"abc\") (SOFT) (TEXT \"def\")))"}, + {"[^abc\n\ndef]", "(INLINE (TEXT \"[^abc\") (SOFT) (SOFT) (TEXT \"def]\"))"}, + {"[^abc[^def]]", "(INLINE (ENDNOTE () (TEXT \"abc\") (ENDNOTE () (TEXT \"def\"))))"}, + {"[^abc]{-}", "(INLINE (ENDNOTE ((\"-\" . \"\")) (TEXT \"abc\")))"}, + }) + checkTcs(t, true, TestCases{ + {"[^abc\n\ndef]", "(BLOCK (PARA (TEXT \"[^abc\")) (PARA (TEXT \"def]\")))"}, + }) +} + +func TestMark(t *testing.T) { + t.Parallel() + checkTcs(t, false, TestCases{ + {"[!", "(INLINE (TEXT \"[!\"))"}, + {"[!\n", "(INLINE (TEXT \"[!\"))"}, + {"[!]", "(INLINE (MARK \"\" \"\" \"\"))"}, + {"[!][!]", "(INLINE (MARK \"\" \"\" \"\") (MARK \"\" \"\" \"\"))"}, + {"[! ]", "(INLINE (TEXT \"[! ]\"))"}, + {"[!a]", "(INLINE (MARK \"a\" \"\" \"\"))"}, + {"[!a][!a]", "(INLINE (MARK \"a\" \"\" \"\") (MARK \"a\" \"\" \"\"))"}, + {"[!a ]", "(INLINE (TEXT \"[!a ]\"))"}, + {"[!a_]", "(INLINE (MARK \"a_\" \"\" \"\"))"}, + {"[!a_][!a]", "(INLINE (MARK \"a_\" \"\" \"\") (MARK \"a\" \"\" \"\"))"}, + {"[!a-b]", "(INLINE (MARK \"a-b\" \"\" \"\"))"}, + {"[!a|b]", "(INLINE (MARK \"a\" \"\" \"\" (TEXT \"b\")))"}, + {"[!a|]", "(INLINE (MARK \"a\" \"\" \"\"))"}, + {"[!|b]", "(INLINE (MARK \"\" \"\" \"\" (TEXT \"b\")))"}, + {"[!|b ]", "(INLINE (MARK \"\" \"\" \"\" (TEXT \"b\")))"}, + {"[!|b c]", "(INLINE (MARK \"\" \"\" \"\" (TEXT \"b c\")))"}, + }) +} + +func TestComment(t *testing.T) { + t.Parallel() + checkTcs(t, false, TestCases{ + {"%", "(INLINE (TEXT \"%\"))"}, + {"%%", "(INLINE (LITERAL-COMMENT () \"\"))"}, + {"%\n", "(INLINE (TEXT \"%\"))"}, + {"%%\n", "(INLINE (LITERAL-COMMENT () \"\"))"}, + {"%%a", "(INLINE (LITERAL-COMMENT () \"a\"))"}, + {"%%%a", "(INLINE (LITERAL-COMMENT () \"a\"))"}, + {"%% a", "(INLINE (LITERAL-COMMENT () \"a\"))"}, + {"%%% a", "(INLINE (LITERAL-COMMENT () \"a\"))"}, + {"%% % a", "(INLINE (LITERAL-COMMENT () \"% a\"))"}, + {"%%a", "(INLINE (LITERAL-COMMENT () \"a\"))"}, + {"a%%b", "(INLINE (TEXT \"a\") (LITERAL-COMMENT () \"b\"))"}, + {"a %%b", "(INLINE (TEXT \"a \") (LITERAL-COMMENT () \"b\"))"}, + {" %%b", "(INLINE (LITERAL-COMMENT () \"b\"))"}, + {"%%b ", "(INLINE (LITERAL-COMMENT () \"b \"))"}, + {"100%", "(INLINE (TEXT \"100%\"))"}, + {"%%{=}a", "(INLINE (LITERAL-COMMENT ((\"\" . \"\")) \"a\"))"}, + }) +} + +func TestFormat(t *testing.T) { + symMap := symbolMap{ + "_": sz.SymFormatEmph, + "*": sz.SymFormatStrong, + ">": sz.SymFormatInsert, + "~": sz.SymFormatDelete, + "^": sz.SymFormatSuper, + ",": sz.SymFormatSub, + "#": sz.SymFormatMark, + ":": sz.SymFormatSpan, + } + t.Parallel() + // Not for Insert / '>', because collision with quoted list + // Not for Quote / '"', because escaped representation. + for _, ch := range []string{"_", "*", "~", "^", ",", "#", ":"} { + checkTcs(t, false, replace(ch, symMap, TestCases{ + {"$", "(INLINE (TEXT \"$\"))"}, + {"$$", "(INLINE (TEXT \"$$\"))"}, + {"$$$", "(INLINE (TEXT \"$$$\"))"}, + {"$$$$", "(INLINE ($% ()))"}, + })) + } + // Not for Quote / '"', because escaped representation. + for _, ch := range []string{"_", "*", ">", "~", "^", ",", "#", ":"} { + checkTcs(t, false, replace(ch, symMap, TestCases{ + {"$$a$$", "(INLINE ($% () (TEXT \"a\")))"}, + {"$$a$$$", "(INLINE ($% () (TEXT \"a\")) (TEXT \"$\"))"}, + {"$$$a$$", "(INLINE ($% () (TEXT \"$a\")))"}, + {"$$$a$$$", "(INLINE ($% () (TEXT \"$a\")) (TEXT \"$\"))"}, + {"$\\$", "(INLINE (TEXT \"$$\"))"}, + {"$\\$$", "(INLINE (TEXT \"$$$\"))"}, + {"$$\\$", "(INLINE (TEXT \"$$$\"))"}, + {"$$a\\$$", "(INLINE (TEXT \"$$a$$\"))"}, + {"$$a$\\$", "(INLINE (TEXT \"$$a$$\"))"}, + {"$$a\\$$$", "(INLINE ($% () (TEXT \"a$\")))"}, + {"$$a\na$$", "(INLINE ($% () (TEXT \"a\") (SOFT) (TEXT \"a\")))"}, + {"$$a\n\na$$", "(INLINE (TEXT \"$$a\") (SOFT) (SOFT) (TEXT \"a$$\"))"}, + {"$$a$${go}", "(INLINE ($% ((\"go\" . \"\")) (TEXT \"a\")))"}, + })) + checkTcs(t, true, replace(ch, symMap, TestCases{ + {"$$a\n\na$$", "(BLOCK (PARA (TEXT \"$$a\")) (PARA (TEXT \"a$$\")))"}, + })) + } + checkTcs(t, false, replace(`"`, symbolMap{`"`: sz.SymFormatQuote}, TestCases{ + {"$", "(INLINE (TEXT \"\\\"\"))"}, + {"$$", "(INLINE (TEXT \"\\\"\\\"\"))"}, + {"$$$", "(INLINE (TEXT \"\\\"\\\"\\\"\"))"}, + {"$$$$", "(INLINE ($% ()))"}, + + {"$$a$$", "(INLINE ($% () (TEXT \"a\")))"}, + {"$$a$$$", "(INLINE ($% () (TEXT \"a\")) (TEXT \"\\\"\"))"}, + {"$$$a$$", "(INLINE ($% () (TEXT \"\\\"a\")))"}, + {"$$$a$$$", "(INLINE ($% () (TEXT \"\\\"a\")) (TEXT \"\\\"\"))"}, + {"$\\$", "(INLINE (TEXT \"\\\"\\\"\"))"}, + {"$\\$$", "(INLINE (TEXT \"\\\"\\\"\\\"\"))"}, + {"$$\\$", "(INLINE (TEXT \"\\\"\\\"\\\"\"))"}, + {"$$a\\$$", "(INLINE (TEXT \"\\\"\\\"a\\\"\\\"\"))"}, + {"$$a$\\$", "(INLINE (TEXT \"\\\"\\\"a\\\"\\\"\"))"}, + {"$$a\\$$$", "(INLINE ($% () (TEXT \"a\\\"\")))"}, + {"$$a\na$$", "(INLINE ($% () (TEXT \"a\") (SOFT) (TEXT \"a\")))"}, + {"$$a\n\na$$", "(INLINE (TEXT \"\\\"\\\"a\") (SOFT) (SOFT) (TEXT \"a\\\"\\\"\"))"}, + {"$$a$${go}", "(INLINE ($% ((\"go\" . \"\")) (TEXT \"a\")))"}, + })) + checkTcs(t, false, TestCases{ + {"__****__", "(INLINE (FORMAT-EMPH () (FORMAT-STRONG ())))"}, + {"__**a**__", "(INLINE (FORMAT-EMPH () (FORMAT-STRONG () (TEXT \"a\"))))"}, + {"__**__**", "(INLINE (TEXT \"__\") (FORMAT-STRONG () (TEXT \"__\")))"}, + }) +} + +func TestLiteral(t *testing.T) { + symMap := symbolMap{ + "@": sz.SymLiteralZettel, + "`": sz.SymLiteralProg, + "'": sz.SymLiteralInput, + "=": sz.SymLiteralOutput, + } + t.Parallel() + for _, ch := range []string{"@", "`", "'", "="} { + checkTcs(t, false, replace(ch, symMap, TestCases{ + {"$", "(INLINE (TEXT \"$\"))"}, + {"$$", "(INLINE (TEXT \"$$\"))"}, + {"$$$", "(INLINE (TEXT \"$$$\"))"}, + {"$$$$", "(INLINE ($% () \"\"))"}, + {"$$a$$", "(INLINE ($% () \"a\"))"}, + {"$$a$$$", "(INLINE ($% () \"a\") (TEXT \"$\"))"}, + {"$$$a$$", "(INLINE ($% () \"$a\"))"}, + {"$$$a$$$", "(INLINE ($% () \"$a\") (TEXT \"$\"))"}, + {"$\\$", "(INLINE (TEXT \"$$\"))"}, + {"$\\$$", "(INLINE (TEXT \"$$$\"))"}, + {"$$\\$", "(INLINE (TEXT \"$$$\"))"}, + {"$$a\\$$", "(INLINE (TEXT \"$$a$$\"))"}, + {"$$a$\\$", "(INLINE (TEXT \"$$a$$\"))"}, + {"$$a\\$$$", "(INLINE ($% () \"a$\"))"}, + {"$$a$${go}", "(INLINE ($% ((\"go\" . \"\")) \"a\"))"}, + })) + } + checkTcs(t, false, TestCases{ + {"''````''", "(INLINE (LITERAL-INPUT () \"````\"))"}, + {"''``a``''", "(INLINE (LITERAL-INPUT () \"``a``\"))"}, + {"''``''``", "(INLINE (LITERAL-INPUT () \"``\") (TEXT \"``\"))"}, + {"''\\'''", "(INLINE (LITERAL-INPUT () \"'\"))"}, + }) + checkTcs(t, false, TestCases{ + {"@@HTML@@{=html}", "(INLINE (LITERAL-HTML () \"HTML\"))"}, + {"@@HTML@@{=html lang=en}", "(INLINE (LITERAL-HTML ((\"lang\" . \"en\")) \"HTML\"))"}, + {"@@HTML@@{=html,lang=en}", "(INLINE (LITERAL-HTML ((\"lang\" . \"en\")) \"HTML\"))"}, + }) +} + +func TestLiteralMath(t *testing.T) { + t.Parallel() + checkTcs(t, false, TestCases{ + {"$", "(INLINE (TEXT \"$\"))"}, + {"$$", "(INLINE (TEXT \"$$\"))"}, + {"$$$", "(INLINE (TEXT \"$$$\"))"}, + {"$$$$", "(INLINE (LITERAL-MATH () \"\"))"}, + {"$$a$$", "(INLINE (LITERAL-MATH () \"a\"))"}, + {"$$a$$$", "(INLINE (LITERAL-MATH () \"a\") (TEXT \"$\"))"}, + {"$$$a$$", "(INLINE (LITERAL-MATH () \"$a\"))"}, + {"$$$a$$$", "(INLINE (LITERAL-MATH () \"$a\") (TEXT \"$\"))"}, + {`$\$`, "(INLINE (TEXT \"$$\"))"}, + {`$\$$`, "(INLINE (TEXT \"$$$\"))"}, + {`$$\$`, "(INLINE (TEXT \"$$$\"))"}, + {`$$a\$$`, "(INLINE (LITERAL-MATH () \"a\\\\\"))"}, + {`$$a$\$`, "(INLINE (TEXT \"$$a$$\"))"}, + {`$$a\$$$`, "(INLINE (LITERAL-MATH () \"a\\\\\") (TEXT \"$\"))"}, + {"$$a$${go}", "(INLINE (LITERAL-MATH ((\"go\" . \"\")) \"a\"))"}, + }) +} + +func TestMixFormatCode(t *testing.T) { + t.Parallel() + checkTcs(t, false, TestCases{ + {"__abc__\n**def**", "(INLINE (FORMAT-EMPH () (TEXT \"abc\")) (SOFT) (FORMAT-STRONG () (TEXT \"def\")))"}, + {"''abc''\n==def==", "(INLINE (LITERAL-INPUT () \"abc\") (SOFT) (LITERAL-OUTPUT () \"def\"))"}, + {"__abc__\n==def==", "(INLINE (FORMAT-EMPH () (TEXT \"abc\")) (SOFT) (LITERAL-OUTPUT () \"def\"))"}, + {"__abc__\n``def``", "(INLINE (FORMAT-EMPH () (TEXT \"abc\")) (SOFT) (LITERAL-CODE () \"def\"))"}, + { + "\"\"ghi\"\"\n::abc::\n``def``\n", + "(INLINE (FORMAT-QUOTE () (TEXT \"ghi\")) (SOFT) (FORMAT-SPAN () (TEXT \"abc\")) (SOFT) (LITERAL-CODE () \"def\"))", + }, + }) +} + +func TestNDash(t *testing.T) { + t.Parallel() + checkTcs(t, false, TestCases{ + {"--", "(INLINE (TEXT \"\u2013\"))"}, + {"a--b", "(INLINE (TEXT \"a\u2013b\"))"}, + }) +} + +func TestEntity(t *testing.T) { + t.Parallel() + checkTcs(t, false, TestCases{ + {"&", "(INLINE (TEXT \"&\"))"}, + {"&;", "(INLINE (TEXT \"&;\"))"}, + {"&#;", "(INLINE (TEXT \"&#;\"))"}, + {"a;", "(INLINE (TEXT \"a;\"))"}, + {"&#x;", "(INLINE (TEXT \"&#x;\"))"}, + {"�z;", "(INLINE (TEXT \"�z;\"))"}, + {"&1;", "(INLINE (TEXT \"&1;\"))"}, + {" ", "(INLINE (TEXT \" \"))"}, // Numeric entities below space are not allowed. + {"", "(INLINE (TEXT \"\"))"}, + + // Good cases + {"<", "(INLINE (TEXT \"<\"))"}, + {"0", "(INLINE (TEXT \"0\"))"}, + {"J", "(INLINE (TEXT \"J\"))"}, + {"J", "(INLINE (TEXT \"J\"))"}, + {"…", "(INLINE (TEXT \"\u2026\"))"}, + {" ", "(INLINE (TEXT \"\u00a0\"))"}, + {"E: &,?;c.", "(INLINE (TEXT \"E: &,?;c.\"))"}, + }) +} + +func TestVerbatimZettel(t *testing.T) { + t.Parallel() + checkTcs(t, true, TestCases{ + {"@@@\n@@@", "()"}, + {"@@@\nabc\n@@@", "(BLOCK (VERBATIM-ZETTEL () \"abc\"))"}, + {"@@@@def\nabc\n@@@@", "(BLOCK (VERBATIM-ZETTEL ((\"\" . \"def\")) \"abc\"))"}, + }) +} + +func TestVerbatimCode(t *testing.T) { + t.Parallel() + checkTcs(t, true, TestCases{ + {"```\n```", "()"}, + {"```\nabc\n```", "(BLOCK (VERBATIM-CODE () \"abc\"))"}, + {"```\nabc\n````", "(BLOCK (VERBATIM-CODE () \"abc\"))"}, + {"````\nabc\n````", "(BLOCK (VERBATIM-CODE () \"abc\"))"}, + {"````\nabc\n```\n````", "(BLOCK (VERBATIM-CODE () \"abc\\n```\"))"}, + {"````go\nabc\n````", "(BLOCK (VERBATIM-CODE ((\"\" . \"go\")) \"abc\"))"}, + }) +} + +func TestVerbatimEval(t *testing.T) { + t.Parallel() + checkTcs(t, true, TestCases{ + {"~~~\n~~~", "()"}, + {"~~~\nabc\n~~~", "(BLOCK (VERBATIM-EVAL () \"abc\"))"}, + {"~~~\nabc\n~~~~", "(BLOCK (VERBATIM-EVAL () \"abc\"))"}, + {"~~~~\nabc\n~~~~", "(BLOCK (VERBATIM-EVAL () \"abc\"))"}, + {"~~~~\nabc\n~~~\n~~~~", "(BLOCK (VERBATIM-EVAL () \"abc\\n~~~\"))"}, + {"~~~~go\nabc\n~~~~", "(BLOCK (VERBATIM-EVAL ((\"\" . \"go\")) \"abc\"))"}, + }) +} + +func TestVerbatimMath(t *testing.T) { + t.Parallel() + checkTcs(t, true, TestCases{ + {"$$$\n$$$", "()"}, + {"$$$\nabc\n$$$", "(BLOCK (VERBATIM-MATH () \"abc\"))"}, + {"$$$\nabc\n$$$$", "(BLOCK (VERBATIM-MATH () \"abc\"))"}, + {"$$$$\nabc\n$$$$", "(BLOCK (VERBATIM-MATH () \"abc\"))"}, + {"$$$$\nabc\n$$$\n$$$$", "(BLOCK (VERBATIM-MATH () \"abc\\n$$$\"))"}, + {"$$$$go\nabc\n$$$$", "(BLOCK (VERBATIM-MATH ((\"\" . \"go\")) \"abc\"))"}, + }) +} + +func TestVerbatimComment(t *testing.T) { + t.Parallel() + checkTcs(t, true, TestCases{ + {"%%%\n%%%", "()"}, + {"%%%\nabc\n%%%", "(BLOCK (VERBATIM-COMMENT () \"abc\"))"}, + {"%%%%go\nabc\n%%%%", "(BLOCK (VERBATIM-COMMENT ((\"\" . \"go\")) \"abc\"))"}, + }) +} + +func TestPara(t *testing.T) { + t.Parallel() + checkTcs(t, true, TestCases{ + {"a\n\nb", "(BLOCK (PARA (TEXT \"a\")) (PARA (TEXT \"b\")))"}, + {"a\n \nb", "(BLOCK (PARA (TEXT \"a\") (SOFT) (HARD) (TEXT \"b\")))"}, + }) +} + +func TestSpanRegion(t *testing.T) { + t.Parallel() + checkTcs(t, true, TestCases{ + {":::\n:::", "()"}, + {":::\nabc\n:::", "(BLOCK (REGION-BLOCK () ((PARA (TEXT \"abc\")))))"}, + {":::\nabc\n::::", "(BLOCK (REGION-BLOCK () ((PARA (TEXT \"abc\")))))"}, + {"::::\nabc\n::::", "(BLOCK (REGION-BLOCK () ((PARA (TEXT \"abc\")))))"}, + {"::::\nabc\n:::\ndef\n:::\n::::", "(BLOCK (REGION-BLOCK () ((PARA (TEXT \"abc\")) (REGION-BLOCK () ((PARA (TEXT \"def\")))))))"}, + {":::{go}\n:::a", "(BLOCK (REGION-BLOCK ((\"go\" . \"\")) () (TEXT \"a\")))"}, + {":::\nabc\n::: def ", "(BLOCK (REGION-BLOCK () ((PARA (TEXT \"abc\"))) (TEXT \"def\")))"}, + }) +} + +func TestQuoteRegion(t *testing.T) { + t.Parallel() + checkTcs(t, true, TestCases{ + {"<<<\n<<<", "()"}, + {"<<<\nabc\n<<<", "(BLOCK (REGION-QUOTE () ((PARA (TEXT \"abc\")))))"}, + {"<<<\nabc\n<<<<", "(BLOCK (REGION-QUOTE () ((PARA (TEXT \"abc\")))))"}, + {"<<<<\nabc\n<<<<", "(BLOCK (REGION-QUOTE () ((PARA (TEXT \"abc\")))))"}, + {"<<<<\nabc\n<<<\ndef\n<<<\n<<<<", "(BLOCK (REGION-QUOTE () ((PARA (TEXT \"abc\")) (REGION-QUOTE () ((PARA (TEXT \"def\")))))))"}, + {"<<" in the following, because quotation lists may have empty items. + for _, ch := range []string{"*", "#"} { + checkTcs(t, true, replace(ch, nil, TestCases{ + {"$", "(BLOCK (PARA (TEXT \"$\")))"}, + {"$$", "(BLOCK (PARA (TEXT \"$$\")))"}, + {"$$$", "(BLOCK (PARA (TEXT \"$$$\")))"}, + {"$ ", "(BLOCK (PARA (TEXT \"$\")))"}, + {"$$ ", "(BLOCK (PARA (TEXT \"$$\")))"}, + {"$$$ ", "(BLOCK (PARA (TEXT \"$$$\")))"}, + })) + } + checkTcs(t, true, TestCases{ + {"* abc", "(BLOCK (UNORDERED (BLOCK (PARA (TEXT \"abc\")))))"}, + {"** abc", "(BLOCK (UNORDERED (BLOCK (UNORDERED (BLOCK (PARA (TEXT \"abc\")))))))"}, + {"*** abc", "(BLOCK (UNORDERED (BLOCK (UNORDERED (BLOCK (UNORDERED (BLOCK (PARA (TEXT \"abc\")))))))))"}, + {"**** abc", "(BLOCK (UNORDERED (BLOCK (UNORDERED (BLOCK (UNORDERED (BLOCK (UNORDERED (BLOCK (PARA (TEXT \"abc\")))))))))))"}, + {"** abc\n**** def", "(BLOCK (UNORDERED (BLOCK (UNORDERED (BLOCK (PARA (TEXT \"abc\")) (UNORDERED (BLOCK (UNORDERED (BLOCK (PARA (TEXT \"def\")))))))))))"}, + {"* abc\ndef", "(BLOCK (UNORDERED (BLOCK (PARA (TEXT \"abc\")))) (PARA (TEXT \"def\")))"}, + {"* abc\n def", "(BLOCK (UNORDERED (BLOCK (PARA (TEXT \"abc\")))) (PARA (TEXT \"def\")))"}, + {"* abc\n* def", "(BLOCK (UNORDERED (BLOCK (PARA (TEXT \"abc\"))) (BLOCK (PARA (TEXT \"def\")))))"}, + {"* abc\n def", "(BLOCK (UNORDERED (BLOCK (PARA (TEXT \"abc\") (SOFT) (TEXT \"def\")))))"}, + {"* abc\n def", "(BLOCK (UNORDERED (BLOCK (PARA (TEXT \"abc\") (SOFT) (TEXT \"def\")))))"}, + {"* abc\n\ndef", "(BLOCK (UNORDERED (BLOCK (PARA (TEXT \"abc\")))) (PARA (TEXT \"def\")))"}, + {"* abc\n\n def", "(BLOCK (UNORDERED (BLOCK (PARA (TEXT \"abc\")))) (PARA (TEXT \"def\")))"}, + {"* abc\n\n def", "(BLOCK (UNORDERED (BLOCK (PARA (TEXT \"abc\")) (PARA (TEXT \"def\")))))"}, + {"* abc\n\n def", "(BLOCK (UNORDERED (BLOCK (PARA (TEXT \"abc\")) (PARA (TEXT \"def\")))))"}, + {"* abc\n** def", "(BLOCK (UNORDERED (BLOCK (PARA (TEXT \"abc\")) (UNORDERED (BLOCK (PARA (TEXT \"def\")))))))"}, + {"* abc\n** def\n* ghi", "(BLOCK (UNORDERED (BLOCK (PARA (TEXT \"abc\")) (UNORDERED (BLOCK (PARA (TEXT \"def\"))))) (BLOCK (PARA (TEXT \"ghi\")))))"}, + {"* abc\n\n def\n* ghi", "(BLOCK (UNORDERED (BLOCK (PARA (TEXT \"abc\")) (PARA (TEXT \"def\"))) (BLOCK (PARA (TEXT \"ghi\")))))"}, + {"* abc\n** def\n ghi\n jkl", "(BLOCK (UNORDERED (BLOCK (PARA (TEXT \"abc\")) (UNORDERED (BLOCK (PARA (TEXT \"def\") (SOFT) (TEXT \"ghi\")))) (PARA (TEXT \"jkl\")))))"}, + + // A list does not last beyond a region + {":::\n# abc\n:::\n# def", "(BLOCK (REGION-BLOCK () ((ORDERED (BLOCK (PARA (TEXT \"abc\")))))) (ORDERED (BLOCK (PARA (TEXT \"def\")))))"}, + + // A HRule creates a new list + {"* abc\n---\n* def", "(BLOCK (UNORDERED (BLOCK (PARA (TEXT \"abc\")))) (THEMATIC ()) (UNORDERED (BLOCK (PARA (TEXT \"def\")))))"}, + + // Changing list type adds a new list + {"* abc\n# def", "(BLOCK (UNORDERED (BLOCK (PARA (TEXT \"abc\")))) (ORDERED (BLOCK (PARA (TEXT \"def\")))))"}, + + // Quotation lists may have empty items + {">", "(BLOCK (QUOTATION (BLOCK)))"}, + + // Empty continuation + {"* abc\n ", "(BLOCK (UNORDERED (BLOCK (PARA (TEXT \"abc\")))))"}, + }) +} + +func TestQuoteList(t *testing.T) { + t.Parallel() + checkTcs(t, true, TestCases{ + {"> w1 w2", "(BLOCK (QUOTATION (BLOCK (PARA (TEXT \"w1 w2\")))))"}, + {"> w1\n> w2", "(BLOCK (QUOTATION (BLOCK (PARA (TEXT \"w1\") (SOFT) (TEXT \"w2\")))))"}, + {"> w1\n>w2", "(BLOCK (QUOTATION (BLOCK (PARA (TEXT \"w1\")))) (PARA (TEXT \">w2\")))"}, + {"> w1\n>\n>w2", "(BLOCK (QUOTATION (BLOCK (PARA (TEXT \"w1\"))) (BLOCK)) (PARA (TEXT \">w2\")))"}, + {"> w1\n> \n> w2", "(BLOCK (QUOTATION (BLOCK (PARA (TEXT \"w1\"))) (BLOCK) (BLOCK (PARA (TEXT \"w2\")))))"}, + }) +} + +func TestEnumAfterPara(t *testing.T) { + t.Parallel() + checkTcs(t, true, TestCases{ + {"abc\n* def", "(BLOCK (PARA (TEXT \"abc\")) (UNORDERED (BLOCK (PARA (TEXT \"def\")))))"}, + {"abc\n*def", "(BLOCK (PARA (TEXT \"abc\") (SOFT) (TEXT \"*def\")))"}, + }) +} + +func TestDefinition(t *testing.T) { + t.Parallel() + checkTcs(t, true, TestCases{ + {";", "(BLOCK (PARA (TEXT \";\")))"}, + {"; ", "(BLOCK (PARA (TEXT \";\")))"}, + {"; abc", "(BLOCK (DESCRIPTION ((TEXT \"abc\"))))"}, + {"; abc\ndef", "(BLOCK (DESCRIPTION ((TEXT \"abc\"))) (PARA (TEXT \"def\")))"}, + {"; abc\n def", "(BLOCK (DESCRIPTION ((TEXT \"abc\"))) (PARA (TEXT \"def\")))"}, + {"; abc\n def", "(BLOCK (DESCRIPTION ((TEXT \"abc\") (SOFT) (TEXT \"def\"))))"}, + {"; abc\n def\n ghi", "(BLOCK (DESCRIPTION ((TEXT \"abc\") (SOFT) (TEXT \"def\") (SOFT) (TEXT \"ghi\"))))"}, + {":", "(BLOCK (PARA (TEXT \":\")))"}, + {": ", "(BLOCK (PARA (TEXT \":\")))"}, + {": abc", "(BLOCK (PARA (TEXT \": abc\")))"}, + {"; abc\n: def", "(BLOCK (DESCRIPTION ((TEXT \"abc\")) (BLOCK (BLOCK (PARA (TEXT \"def\"))))))"}, + {"; abc\n: def\nghi", "(BLOCK (DESCRIPTION ((TEXT \"abc\")) (BLOCK (BLOCK (PARA (TEXT \"def\"))))) (PARA (TEXT \"ghi\")))"}, + {"; abc\n: def\n ghi", "(BLOCK (DESCRIPTION ((TEXT \"abc\")) (BLOCK (BLOCK (PARA (TEXT \"def\"))))) (PARA (TEXT \"ghi\")))"}, + {"; abc\n: def\n ghi", "(BLOCK (DESCRIPTION ((TEXT \"abc\")) (BLOCK (BLOCK (PARA (TEXT \"def\") (SOFT) (TEXT \"ghi\"))))))"}, + {"; abc\n: def\n\n ghi", "(BLOCK (DESCRIPTION ((TEXT \"abc\")) (BLOCK (BLOCK (PARA (TEXT \"def\"))) (PARA (TEXT \"ghi\")))))"}, + {"; abc\n:", "(BLOCK (DESCRIPTION ((TEXT \"abc\"))) (PARA (TEXT \":\")))"}, + {"; abc\n: def\n: ghi", "(BLOCK (DESCRIPTION ((TEXT \"abc\")) (BLOCK (BLOCK (PARA (TEXT \"def\"))) (BLOCK (PARA (TEXT \"ghi\"))))))"}, + {"; abc\n: def\n; ghi\n: jkl", "(BLOCK (DESCRIPTION ((TEXT \"abc\")) (BLOCK (BLOCK (PARA (TEXT \"def\")))) ((TEXT \"ghi\")) (BLOCK (BLOCK (PARA (TEXT \"jkl\"))))))"}, + + // Empty description + {"; abc\n: ", "(BLOCK (DESCRIPTION ((TEXT \"abc\"))) (PARA (TEXT \":\")))"}, + // Empty continuation of definition + {"; abc\n: def\n ", "(BLOCK (DESCRIPTION ((TEXT \"abc\")) (BLOCK (BLOCK (PARA (TEXT \"def\"))))))"}, + }) +} + +func TestTable(t *testing.T) { + t.Parallel() + checkTcs(t, true, TestCases{ + {"|", "()"}, + {"||", "(BLOCK (TABLE () ((CELL))))"}, + {"| |", "(BLOCK (TABLE () ((CELL))))"}, + {"|a", "(BLOCK (TABLE () ((CELL (TEXT \"a\")))))"}, + {"|a|", "(BLOCK (TABLE () ((CELL (TEXT \"a\")))))"}, + {"|a| ", "(BLOCK (TABLE () ((CELL (TEXT \"a\")) (CELL))))"}, + {"|a|b", "(BLOCK (TABLE () ((CELL (TEXT \"a\")) (CELL (TEXT \"b\")))))"}, + {"|a\n|b", "(BLOCK (TABLE () ((CELL (TEXT \"a\"))) ((CELL (TEXT \"b\")))))"}, + {"|a|b\n|c|d", "(BLOCK (TABLE () ((CELL (TEXT \"a\")) (CELL (TEXT \"b\"))) ((CELL (TEXT \"c\")) (CELL (TEXT \"d\")))))"}, + {"|%", "()"}, + {"|=a", "(BLOCK (TABLE ((CELL (TEXT \"a\")))))"}, + {"|=a\n|b", "(BLOCK (TABLE ((CELL (TEXT \"a\"))) ((CELL (TEXT \"b\")))))"}, + {"|a|b\n|%---\n|c|d", "(BLOCK (TABLE () ((CELL (TEXT \"a\")) (CELL (TEXT \"b\"))) ((CELL (TEXT \"c\")) (CELL (TEXT \"d\")))))"}, + {"|a|b\n|c", "(BLOCK (TABLE () ((CELL (TEXT \"a\")) (CELL (TEXT \"b\"))) ((CELL (TEXT \"c\")) (CELL))))"}, + {"|=\n|b|c", "(BLOCK (TABLE ((CELL-LEFT (TEXT \"a\")) (CELL)) ((CELL-RIGHT (TEXT \"b\")) (CELL (TEXT \"c\")))))"}, + {"|=\n||", "(BLOCK (TABLE ((CELL-LEFT (TEXT \"a\")) (CELL-RIGHT (TEXT \"b\"))) ((CELL) (CELL-RIGHT))))"}, + }) +} + +func TestTransclude(t *testing.T) { + t.Parallel() + checkTcs(t, true, TestCases{ + {"{{{a}}}", "(BLOCK (TRANSCLUDE () (EXTERNAL \"a\")))"}, + {"{{{a}}}b", "(BLOCK (TRANSCLUDE ((\"\" . \"b\")) (EXTERNAL \"a\")))"}, + {"{{{a}}}}", "(BLOCK (TRANSCLUDE () (EXTERNAL \"a\")))"}, + {"{{{a\\}}}}", "(BLOCK (TRANSCLUDE () (EXTERNAL \"a\\\\}\")))"}, + {"{{{a\\}}}}b", "(BLOCK (TRANSCLUDE ((\"\" . \"b\")) (EXTERNAL \"a\\\\}\")))"}, + {"{{{a}}", "(BLOCK (PARA (TEXT \"{\") (EMBED () \"a\")))"}, + {"{{{a}}}{go=b}", "(BLOCK (TRANSCLUDE ((\"go\" . \"b\")) (EXTERNAL \"a\")))"}, + }) +} + +func TestBlockAttr(t *testing.T) { + t.Parallel() + checkTcs(t, true, TestCases{ + {":::go\na\n:::", "(BLOCK (REGION-BLOCK ((\"\" . \"go\")) ((PARA (TEXT \"a\")))))"}, + {":::go=\na\n:::", "(BLOCK (REGION-BLOCK ((\"\" . \"go\")) ((PARA (TEXT \"a\")))))"}, + {":::{}\na\n:::", "(BLOCK (REGION-BLOCK () ((PARA (TEXT \"a\")))))"}, + {":::{ }\na\n:::", "(BLOCK (REGION-BLOCK () ((PARA (TEXT \"a\")))))"}, + {":::{.go}\na\n:::", "(BLOCK (REGION-BLOCK ((\"class\" . \"go\")) ((PARA (TEXT \"a\")))))"}, + {":::{=go}\na\n:::", "(BLOCK (REGION-BLOCK ((\"\" . \"go\")) ((PARA (TEXT \"a\")))))"}, + {":::{go}\na\n:::", "(BLOCK (REGION-BLOCK ((\"go\" . \"\")) ((PARA (TEXT \"a\")))))"}, + {":::{go=py}\na\n:::", "(BLOCK (REGION-BLOCK ((\"go\" . \"py\")) ((PARA (TEXT \"a\")))))"}, + {":::{.go=py}\na\n:::", "(BLOCK (REGION-BLOCK () ((PARA (TEXT \"a\")))))"}, + {":::{go=}\na\n:::", "(BLOCK (REGION-BLOCK ((\"go\" . \"\")) ((PARA (TEXT \"a\")))))"}, + {":::{.go=}\na\n:::", "(BLOCK (REGION-BLOCK () ((PARA (TEXT \"a\")))))"}, + {":::{go py}\na\n:::", "(BLOCK (REGION-BLOCK ((\"go\" . \"\") (\"py\" . \"\")) ((PARA (TEXT \"a\")))))"}, + {":::{go\npy}\na\n:::", "(BLOCK (REGION-BLOCK ((\"go\" . \"\") (\"py\" . \"\")) ((PARA (TEXT \"a\")))))"}, + {":::{.go py}\na\n:::", "(BLOCK (REGION-BLOCK ((\"class\" . \"go\") (\"py\" . \"\")) ((PARA (TEXT \"a\")))))"}, + {":::{go .py}\na\n:::", "(BLOCK (REGION-BLOCK ((\"class\" . \"py\") (\"go\" . \"\")) ((PARA (TEXT \"a\")))))"}, + {":::{.go py=3}\na\n:::", "(BLOCK (REGION-BLOCK ((\"class\" . \"go\") (\"py\" . \"3\")) ((PARA (TEXT \"a\")))))"}, + {"::: { go } \na\n:::", "(BLOCK (REGION-BLOCK ((\"go\" . \"\")) ((PARA (TEXT \"a\")))))"}, + {"::: { .go } \na\n:::", "(BLOCK (REGION-BLOCK ((\"class\" . \"go\")) ((PARA (TEXT \"a\")))))"}, + }) + checkTcs(t, true, replace("\"", nil, TestCases{ + {":::{py=3}\na\n:::", "(BLOCK (REGION-BLOCK ((\"py\" . \"3\")) ((PARA (TEXT \"a\")))))"}, + {":::{py=$2 3$}\na\n:::", "(BLOCK (REGION-BLOCK ((\"py\" . \"2 3\")) ((PARA (TEXT \"a\")))))"}, + {":::{py=$2\\$3$}\na\n:::", "(BLOCK (REGION-BLOCK ((\"py\" . \"2\\\"3\")) ((PARA (TEXT \"a\")))))"}, + {":::{py=2$3}\na\n:::", "(BLOCK (REGION-BLOCK ((\"py\" . \"2\\\"3\")) ((PARA (TEXT \"a\")))))"}, + {":::{py=$2\n3$}\na\n:::", "(BLOCK (REGION-BLOCK ((\"py\" . \"2\\n3\")) ((PARA (TEXT \"a\")))))"}, + {":::{py=$2 3}\na\n:::", "(BLOCK (REGION-BLOCK () ((PARA (TEXT \"a\")))))"}, + {":::{py=2 py=3}\na\n:::", "(BLOCK (REGION-BLOCK ((\"py\" . \"2 3\")) ((PARA (TEXT \"a\")))))"}, + {":::{.go .py}\na\n:::", "(BLOCK (REGION-BLOCK ((\"class\" . \"go py\")) ((PARA (TEXT \"a\")))))"}, + {":::{go go}\na\n:::", "(BLOCK (REGION-BLOCK ((\"go\" . \"\")) ((PARA (TEXT \"a\")))))"}, + {":::{=py =go}\na\n:::", "(BLOCK (REGION-BLOCK ((\"\" . \"go\")) ((PARA (TEXT \"a\")))))"}, + })) +} + +func TestInlineAttr(t *testing.T) { + t.Parallel() + checkTcs(t, true, TestCases{ + {"::a::{}", "(BLOCK (PARA (FORMAT-SPAN () (TEXT \"a\"))))"}, + {"::a::{ }", "(BLOCK (PARA (FORMAT-SPAN () (TEXT \"a\"))))"}, + {"::a::{.go}", "(BLOCK (PARA (FORMAT-SPAN ((\"class\" . \"go\")) (TEXT \"a\"))))"}, + {"::a::{=go}", "(BLOCK (PARA (FORMAT-SPAN ((\"\" . \"go\")) (TEXT \"a\"))))"}, + {"::a::{go}", "(BLOCK (PARA (FORMAT-SPAN ((\"go\" . \"\")) (TEXT \"a\"))))"}, + {"::a::{go=py}", "(BLOCK (PARA (FORMAT-SPAN ((\"go\" . \"py\")) (TEXT \"a\"))))"}, + {"::a::{.go=py}", "(BLOCK (PARA (FORMAT-SPAN () (TEXT \"a\")) (TEXT \"{.go=py}\")))"}, + {"::a::{go=}", "(BLOCK (PARA (FORMAT-SPAN ((\"go\" . \"\")) (TEXT \"a\"))))"}, + {"::a::{.go=}", "(BLOCK (PARA (FORMAT-SPAN () (TEXT \"a\")) (TEXT \"{.go=}\")))"}, + {"::a::{go py}", "(BLOCK (PARA (FORMAT-SPAN ((\"go\" . \"\") (\"py\" . \"\")) (TEXT \"a\"))))"}, + {"::a::{go\npy}", "(BLOCK (PARA (FORMAT-SPAN ((\"go\" . \"\") (\"py\" . \"\")) (TEXT \"a\"))))"}, + {"::a::{.go py}", "(BLOCK (PARA (FORMAT-SPAN ((\"class\" . \"go\") (\"py\" . \"\")) (TEXT \"a\"))))"}, + {"::a::{go .py}", "(BLOCK (PARA (FORMAT-SPAN ((\"class\" . \"py\") (\"go\" . \"\")) (TEXT \"a\"))))"}, + {"::a::{ \n go \n .py\n \n}", "(BLOCK (PARA (FORMAT-SPAN ((\"class\" . \"py\") (\"go\" . \"\")) (TEXT \"a\"))))"}, + {"::a::{ \n go \n .py\n\n}", "(BLOCK (PARA (FORMAT-SPAN ((\"class\" . \"py\") (\"go\" . \"\")) (TEXT \"a\"))))"}, + {"::a::{\ngo\n}", "(BLOCK (PARA (FORMAT-SPAN ((\"go\" . \"\")) (TEXT \"a\"))))"}, + }) + checkTcs(t, true, TestCases{ + {"::a::{py=3}", "(BLOCK (PARA (FORMAT-SPAN ((\"py\" . \"3\")) (TEXT \"a\"))))"}, + {"::a::{py=\"2 3\"}", "(BLOCK (PARA (FORMAT-SPAN ((\"py\" . \"2 3\")) (TEXT \"a\"))))"}, + {"::a::{py=\"2\\\"3\"}", "(BLOCK (PARA (FORMAT-SPAN ((\"py\" . \"2\\\"3\")) (TEXT \"a\"))))"}, + {"::a::{py=2\"3}", "(BLOCK (PARA (FORMAT-SPAN ((\"py\" . \"2\\\"3\")) (TEXT \"a\"))))"}, + {"::a::{py=\"2\n3\"}", "(BLOCK (PARA (FORMAT-SPAN ((\"py\" . \"2\\n3\")) (TEXT \"a\"))))"}, + {"::a::{py=\"2 3}", "(BLOCK (PARA (FORMAT-SPAN () (TEXT \"a\")) (TEXT \"{py=\\\"2 3}\")))"}, + }) + checkTcs(t, true, TestCases{ + {"::a::{py=2 py=3}", "(BLOCK (PARA (FORMAT-SPAN ((\"py\" . \"2 3\")) (TEXT \"a\"))))"}, + {"::a::{.go .py}", "(BLOCK (PARA (FORMAT-SPAN ((\"class\" . \"go py\")) (TEXT \"a\"))))"}, + }) +} + +func TestTemp(t *testing.T) { + t.Parallel() + checkTcs(t, true, TestCases{ + {"", "()"}, + }) +} Index: text/text.go ================================================================== --- text/text.go +++ text/text.go @@ -15,12 +15,13 @@ package text import ( "strings" - "zettelstore.de/client.fossil/sz" - "zettelstore.de/sx.fossil" + "t73f.de/r/sx" + "t73f.de/r/zsc/input" + "t73f.de/r/zsc/sz" ) // Encoder is the structure to hold relevant data to execute the encoding. type Encoder struct { sb strings.Builder @@ -63,15 +64,26 @@ args := cmd.Tail() if args == nil { return } if val, isString := sx.GetString(args.Car()); isString { - enc.sb.WriteString(string(val)) + hadSpace := false + for _, ch := range val.GetValue() { + if input.IsSpace(ch) { + if !hadSpace { + enc.sb.WriteByte(' ') + hadSpace = true + } + } else { + enc.sb.WriteRune(ch) + hadSpace = false + } + } } - } else if sym.IsEqual(sz.SymSpace) || sym.IsEqual(sz.SymSoft) { + } else if sym.IsEqual(sz.SymSoft) { enc.sb.WriteByte(' ') } else if sym.IsEqual(sz.SymHard) { enc.sb.WriteByte('\n') } else if !sym.IsEqual(sx.SymbolQuote) { enc.executeList(cmd.Tail()) } } Index: text/text_test.go ================================================================== --- text/text_test.go +++ text/text_test.go @@ -15,23 +15,24 @@ import ( "strings" "testing" - "zettelstore.de/client.fossil/text" - "zettelstore.de/sx.fossil" - "zettelstore.de/sx.fossil/sxreader" + "t73f.de/r/sx" + "t73f.de/r/sx/sxreader" + "t73f.de/r/zsc/text" ) func TestSzText(t *testing.T) { testcases := []struct { src string exp string }{ {"()", ""}, {`(INLINE (TEXT "a"))`, "a"}, - {`(INLINE (SPACE "a"))`, " "}, + {`(INLINE (TEXT " "))`, " "}, + {`(INLINE (TEXT " "))`, " "}, } for i, tc := range testcases { sval, err := sxreader.MakeReader(strings.NewReader(tc.src)).Read() if err != nil { t.Error(err) Index: www/changes.wiki ================================================================== --- www/changes.wiki +++ www/changes.wiki @@ -1,9 +1,18 @@ Change Log + +

Changes for Version 0.19.0 (pending)

+ -

Changes for Version 0.18.0 (pending)

+

Changes for Version 0.18.0 (2024-07-11)

+ * Add client method GetApplicationZid to retrieve the zettel + identifier of an configuration zettel for a specific application. + * Rename to be package t73f.de/r/zsc + * Reserve some zettel identifier for future use + * Mark client.Client.RenameZettel as deprecated + * Remove space node from (Sx-) AST

Changes for Version 0.17.0 (2024-03-04)

* Generic GET method for HTTP client. * Adapt to sz changes; see manual for current syntax. Index: www/index.wiki ================================================================== --- www/index.wiki +++ www/index.wiki @@ -1,16 +1,16 @@ Home This repository contains Go client software to access [https://zettelstore.de|Zettelstore] via its API. -

Latest Release: 0.17.0 (2024-03-04)

- * [./changes.wiki#0_17|Change summary] - * [/timeline?p=v0.17.0&bt=v0.16.0&y=ci|Check-ins for version 0.17.0], - [/vdiff?to=v0.17.0&from=v0.16.0|content diff] - * [/timeline?df=v0.17.0&y=ci|Check-ins derived from the 0.17.0 release], - [/vdiff?from=v0.17.0&to=trunk|content diff] +

Latest Release: 0.18.0 (2024-07-11)

+ * [./changes.wiki#0_18|Change summary] + * [/timeline?p=v0.18.0&bt=v0.17.0&y=ci|Check-ins for version 0.18.0], + [/vdiff?to=v0.18.0&from=v0.17.0|content diff] + * [/timeline?df=v0.18.0&y=ci|Check-ins derived from the 0.18.0 release], + [/vdiff?from=v0.18.0&to=trunk|content diff] * [/timeline?t=release|Timeline of all past releases]

Use instructions

If you want to import this library into your own [https://go.dev/|Go] software, @@ -24,13 +24,12 @@ it is in your search path for commands. How you can execute the following Go command to retrieve a given version of this library: -GOVCS=zettelstore.de:fossil go get -x -zettelstore.de/client.fossil@HASH +GOVCS=zettelstore.de:fossil go get -x t73f.de/r/zsc@HASH where HASH is the hash value of the commit you want to use. Go currently seems not to support software versions when the software is managed by Fossil. This explains the need for the hash value. However, this methods works and you can use the client software to access a Zettelstore.