OrgWiki/go-org-orgwiki
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Export WriteNodesAsString on writer interface

Browse source 
WriteNodesAsString is simple enough to implement but exposing it is helpful in
the implementation of extending writers and we don't aim to keep writer a small
interface so let's expose it.
This commit is contained in:
Niklas Fasching 2019-10-30 22:05:06 +01:00
parent c9d11e1556
commit 9a0a9c11eb
13 changed files with 42 additions and 41 deletions
Download patch file Download diff file Expand all files Collapse all files

4
org/block.go
View file

@ -80,5 +80,5 @@ func trimIndentUpTo(max int) func(string) string {
} }
} }
func (n Example) String() string { return orgWriter.nodesAsString(n) } func (n Example) String() string { return orgWriter.WriteNodesAsString(n) }
func (n Block) String() string { return orgWriter.nodesAsString(n) } func (n Block) String() string { return orgWriter.WriteNodesAsString(n) }

2
org/document.go
View file

@ -90,7 +90,7 @@ func New() *Configuration {
} }
// String returns the pretty printed Org mode string for the given nodes (see OrgWriter). // String returns the pretty printed Org mode string for the given nodes (see OrgWriter).
func String(nodes []Node) string { return orgWriter.nodesAsString(nodes...) } func String(nodes []Node) string { return orgWriter.WriteNodesAsString(nodes...) }
// Write is called after with an instance of the Writer interface to export a parsed Document into another format. // Write is called after with an instance of the Writer interface to export a parsed Document into another format.
func (d *Document) Write(w Writer) (out string, err error) { func (d *Document) Write(w Writer) (out string, err error) {

4
org/drawer.go
View file

@ -93,5 +93,5 @@ func (d *PropertyDrawer) Get(key string) (string, bool) {
return "", false return "", false
} }
func (n Drawer) String() string { return orgWriter.nodesAsString(n) } func (n Drawer) String() string { return orgWriter.WriteNodesAsString(n) }
func (n PropertyDrawer) String() string { return orgWriter.nodesAsString(n) } func (n PropertyDrawer) String() string { return orgWriter.WriteNodesAsString(n) }

2
org/footnote.go
View file

@ -32,4 +32,4 @@ func (d *Document) parseFootnoteDefinition(i int, parentStop stopFn) (int, Node)
return consumed, definition return consumed, definition
} }
func (n FootnoteDefinition) String() string { return orgWriter.nodesAsString(n) } func (n FootnoteDefinition) String() string { return orgWriter.WriteNodesAsString(n) }

2
org/headline.go
View file

@ -98,4 +98,4 @@ func (parent *Section) add(current *Section) {
} }
} }
func (n Headline) String() string { return orgWriter.nodesAsString(n) } func (n Headline) String() string { return orgWriter.WriteNodesAsString(n) }

14
org/html_writer.go
View file

@ -69,7 +69,7 @@ func NewHTMLWriter() *HTMLWriter {
} }
} }
func (w *HTMLWriter) nodesAsString(nodes ...Node) string { func (w *HTMLWriter) WriteNodesAsString(nodes ...Node) string {
original := w.Builder original := w.Builder
w.Builder = strings.Builder{} w.Builder = strings.Builder{}
WriteNodes(w, nodes...) WriteNodes(w, nodes...)
@ -108,7 +108,7 @@ func (w *HTMLWriter) WriteBlock(b Block) {
w.Builder, w.htmlEscape = builder, htmlEscape w.Builder, w.htmlEscape = builder, htmlEscape
content = strings.TrimRightFunc(out, unicode.IsSpace) content = strings.TrimRightFunc(out, unicode.IsSpace)
} else { } else {
content = w.nodesAsString(b.Children...) content = w.WriteNodesAsString(b.Children...)
} }
switch name := b.Name; { switch name := b.Name; {
case name == "SRC": case name == "SRC":
@ -193,7 +193,7 @@ func (w *HTMLWriter) writeSection(section *Section) {
// NOTE: To satisfy hugo ExtractTOC() check we cannot use `<li>\n` here. Doesn't really matter, just a note. // NOTE: To satisfy hugo ExtractTOC() check we cannot use `<li>\n` here. Doesn't really matter, just a note.
w.WriteString("<li>") w.WriteString("<li>")
h := section.Headline h := section.Headline
title := cleanHeadlineTitleForHTMLAnchorRegexp.ReplaceAllString(w.nodesAsString(h.Title...), "") title := cleanHeadlineTitleForHTMLAnchorRegexp.ReplaceAllString(w.WriteNodesAsString(h.Title...), "")
w.WriteString(fmt.Sprintf("<a href=\"#%s\">%s</a>\n", h.ID(), title)) w.WriteString(fmt.Sprintf("<a href=\"#%s\">%s</a>\n", h.ID(), title))
if len(section.Children) != 0 { if len(section.Children) != 0 {
w.WriteString("<ul>\n") w.WriteString("<ul>\n")
@ -305,7 +305,7 @@ func (w *HTMLWriter) WriteRegularLink(l RegularLink) {
} }
description := url description := url
if l.Description != nil { if l.Description != nil {
description = w.nodesAsString(l.Description...) description = w.WriteNodesAsString(l.Description...)
} }
switch l.Kind() { switch l.Kind() {
case "image": case "image":
@ -383,10 +383,10 @@ func (w *HTMLWriter) WriteHorizontalRule(h HorizontalRule) {
} }
func (w *HTMLWriter) WriteNodeWithMeta(n NodeWithMeta) { func (w *HTMLWriter) WriteNodeWithMeta(n NodeWithMeta) {
out := w.nodesAsString(n.Node) out := w.WriteNodesAsString(n.Node)
if p, ok := n.Node.(Paragraph); ok { if p, ok := n.Node.(Paragraph); ok {
if len(p.Children) == 1 && isImageOrVideoLink(p.Children[0]) { if len(p.Children) == 1 && isImageOrVideoLink(p.Children[0]) {
out = w.nodesAsString(p.Children[0]) out = w.WriteNodesAsString(p.Children[0])
} }
} }
for _, attributes := range n.Meta.HTMLAttributes { for _, attributes := range n.Meta.HTMLAttributes {
@ -398,7 +398,7 @@ func (w *HTMLWriter) WriteNodeWithMeta(n NodeWithMeta) {
if i != 0 { if i != 0 {
caption += " " caption += " "
} }
caption += w.nodesAsString(ns...) caption += w.WriteNodesAsString(ns...)
} }
out = fmt.Sprintf("<figure>\n%s<figcaption>\n%s\n</figcaption>\n</figure>\n", out, caption) out = fmt.Sprintf("<figure>\n%s<figcaption>\n%s\n</figcaption>\n</figure>\n", out, caption)
} }

18
org/inline.go
View file

@ -346,12 +346,12 @@ func (l RegularLink) Kind() string {
return "regular" return "regular"
} }
func (n Text) String() string { return orgWriter.nodesAsString(n) } func (n Text) String() string { return orgWriter.WriteNodesAsString(n) }
func (n LineBreak) String() string { return orgWriter.nodesAsString(n) } func (n LineBreak) String() string { return orgWriter.WriteNodesAsString(n) }
func (n ExplicitLineBreak) String() string { return orgWriter.nodesAsString(n) } func (n ExplicitLineBreak) String() string { return orgWriter.WriteNodesAsString(n) }
func (n StatisticToken) String() string { return orgWriter.nodesAsString(n) } func (n StatisticToken) String() string { return orgWriter.WriteNodesAsString(n) }
func (n Emphasis) String() string { return orgWriter.nodesAsString(n) } func (n Emphasis) String() string { return orgWriter.WriteNodesAsString(n) }
func (n LatexFragment) String() string { return orgWriter.nodesAsString(n) } func (n LatexFragment) String() string { return orgWriter.WriteNodesAsString(n) }
func (n FootnoteLink) String() string { return orgWriter.nodesAsString(n) } func (n FootnoteLink) String() string { return orgWriter.WriteNodesAsString(n) }
func (n RegularLink) String() string { return orgWriter.nodesAsString(n) } func (n RegularLink) String() string { return orgWriter.WriteNodesAsString(n) }
func (n Timestamp) String() string { return orgWriter.nodesAsString(n) } func (n Timestamp) String() string { return orgWriter.WriteNodesAsString(n) }

10
org/keyword.go
View file

@ -177,8 +177,8 @@ func (d *Document) loadSetupFile(k Keyword) (int, Node) {
return 1, k return 1, k
} }
func (n Comment) String() string { return orgWriter.nodesAsString(n) } func (n Comment) String() string { return orgWriter.WriteNodesAsString(n) }
func (n Keyword) String() string { return orgWriter.nodesAsString(n) } func (n Keyword) String() string { return orgWriter.WriteNodesAsString(n) }
func (n NodeWithMeta) String() string { return orgWriter.nodesAsString(n) } func (n NodeWithMeta) String() string { return orgWriter.WriteNodesAsString(n) }
func (n NodeWithName) String() string { return orgWriter.nodesAsString(n) } func (n NodeWithName) String() string { return orgWriter.WriteNodesAsString(n) }
func (n Include) String() string { return orgWriter.nodesAsString(n) } func (n Include) String() string { return orgWriter.WriteNodesAsString(n) }

6
org/list.go
View file

@ -109,6 +109,6 @@ func (d *Document) parseListItem(l List, i int, parentStop stopFn) (int, Node) {
return i - start, ListItem{bullet, status, nodes} return i - start, ListItem{bullet, status, nodes}
} }
func (n List) String() string { return orgWriter.nodesAsString(n) } func (n List) String() string { return orgWriter.WriteNodesAsString(n) }
func (n ListItem) String() string { return orgWriter.nodesAsString(n) } func (n ListItem) String() string { return orgWriter.WriteNodesAsString(n) }
func (n DescriptiveListItem) String() string { return orgWriter.nodesAsString(n) } func (n DescriptiveListItem) String() string { return orgWriter.WriteNodesAsString(n) }

14
org/org_writer.go
View file

@ -43,7 +43,7 @@ func (w *OrgWriter) WriterWithExtensions() Writer {
func (w *OrgWriter) Before(d *Document) {} func (w *OrgWriter) Before(d *Document) {}
func (w *OrgWriter) After(d *Document) {} func (w *OrgWriter) After(d *Document) {}
func (w *OrgWriter) nodesAsString(nodes ...Node) string { func (w *OrgWriter) WriteNodesAsString(nodes ...Node) string {
builder := w.Builder builder := w.Builder
w.Builder = strings.Builder{} w.Builder = strings.Builder{}
WriteNodes(w, nodes...) WriteNodes(w, nodes...)
@ -117,7 +117,7 @@ func (w *OrgWriter) WritePropertyDrawer(d PropertyDrawer) {
func (w *OrgWriter) WriteFootnoteDefinition(f FootnoteDefinition) { func (w *OrgWriter) WriteFootnoteDefinition(f FootnoteDefinition) {
w.WriteString(fmt.Sprintf("[fn:%s]", f.Name)) w.WriteString(fmt.Sprintf("[fn:%s]", f.Name))
content := w.nodesAsString(f.Children...) content := w.WriteNodesAsString(f.Children...)
if content != "" && !unicode.IsSpace(rune(content[0])) { if content != "" && !unicode.IsSpace(rune(content[0])) {
w.WriteString(" ") w.WriteString(" ")
} }
@ -125,7 +125,7 @@ func (w *OrgWriter) WriteFootnoteDefinition(f FootnoteDefinition) {
} }
func (w *OrgWriter) WriteParagraph(p Paragraph) { func (w *OrgWriter) WriteParagraph(p Paragraph) {
content := w.nodesAsString(p.Children...) content := w.WriteNodesAsString(p.Children...)
if len(content) > 0 && content[0] != '\n' { if len(content) > 0 && content[0] != '\n' {
w.WriteString(w.indent) w.WriteString(w.indent)
} }
@ -135,7 +135,7 @@ func (w *OrgWriter) WriteParagraph(p Paragraph) {
func (w *OrgWriter) WriteExample(e Example) { func (w *OrgWriter) WriteExample(e Example) {
for _, n := range e.Children { for _, n := range e.Children {
w.WriteString(w.indent + ":") w.WriteString(w.indent + ":")
if content := w.nodesAsString(n); content != "" { if content := w.WriteNodesAsString(n); content != "" {
w.WriteString(" " + content) w.WriteString(" " + content)
} }
w.WriteString("\n") w.WriteString("\n")
@ -202,7 +202,7 @@ func (w *OrgWriter) WriteDescriptiveListItem(di DescriptiveListItem) {
} }
indent := w.indent + strings.Repeat(" ", len(di.Bullet)+1) indent := w.indent + strings.Repeat(" ", len(di.Bullet)+1)
if len(di.Term) != 0 { if len(di.Term) != 0 {
term := w.nodesAsString(di.Term...) term := w.WriteNodesAsString(di.Term...)
w.WriteString(" " + term + " ::") w.WriteString(" " + term + " ::")
indent = indent + strings.Repeat(" ", len(term)+4) indent = indent + strings.Repeat(" ", len(term)+4)
} }
@ -235,7 +235,7 @@ func (w *OrgWriter) WriteTable(t Table) {
w.WriteString(`|`) w.WriteString(`|`)
for _, column := range row.Columns { for _, column := range row.Columns {
w.WriteString(` `) w.WriteString(` `)
content := w.nodesAsString(column.Children...) content := w.WriteNodesAsString(column.Children...)
if content == "" { if content == "" {
content = " " content = " "
} }
@ -322,6 +322,6 @@ func (w *OrgWriter) WriteRegularLink(l RegularLink) {
} else if l.Description == nil { } else if l.Description == nil {
w.WriteString(fmt.Sprintf("[[%s]]", l.URL)) w.WriteString(fmt.Sprintf("[[%s]]", l.URL))
} else { } else {
w.WriteString(fmt.Sprintf("[[%s][%s]]", l.URL, w.nodesAsString(l.Description...))) w.WriteString(fmt.Sprintf("[[%s][%s]]", l.URL, w.WriteNodesAsString(l.Description...)))
} }
} }

4
org/paragraph.go
View file

@ -42,5 +42,5 @@ func (d *Document) parseHorizontalRule(i int, parentStop stopFn) (int, Node) {
return 1, HorizontalRule{} return 1, HorizontalRule{}
} }
func (n Paragraph) String() string { return orgWriter.nodesAsString(n) } func (n Paragraph) String() string { return orgWriter.WriteNodesAsString(n) }
func (n HorizontalRule) String() string { return orgWriter.nodesAsString(n) } func (n HorizontalRule) String() string { return orgWriter.WriteNodesAsString(n) }

2
org/table.go
View file

@ -127,4 +127,4 @@ func isSpecialRow(rawColumns []string) bool {
return isAlignRow return isAlignRow
} }
func (n Table) String() string { return orgWriter.nodesAsString(n) } func (n Table) String() string { return orgWriter.WriteNodesAsString(n) }

1
org/writer.go
View file

@ -9,6 +9,7 @@ type Writer interface {
String() string // String is called at the very end to retrieve the final output. String() string // String is called at the very end to retrieve the final output.
WriterWithExtensions() Writer WriterWithExtensions() Writer
WriteNodesAsString(...Node) string
WriteKeyword(Keyword) WriteKeyword(Keyword)
WriteInclude(Include) WriteInclude(Include)