123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327 |
- package org
-
- import (
- "fmt"
- "strings"
- "unicode"
- "unicode/utf8"
- )
-
- // OrgWriter export an org document into pretty printed org document.
- type OrgWriter struct {
- ExtendingWriter Writer
- TagsColumn int
-
- strings.Builder
- indent string
- }
-
- var emphasisOrgBorders = map[string][]string{
- "_": []string{"_", "_"},
- "*": []string{"*", "*"},
- "/": []string{"/", "/"},
- "+": []string{"+", "+"},
- "~": []string{"~", "~"},
- "=": []string{"=", "="},
- "_{}": []string{"_{", "}"},
- "^{}": []string{"^{", "}"},
- }
-
- func NewOrgWriter() *OrgWriter {
- return &OrgWriter{
- TagsColumn: 77,
- }
- }
-
- func (w *OrgWriter) WriterWithExtensions() Writer {
- if w.ExtendingWriter != nil {
- return w.ExtendingWriter
- }
- return w
- }
-
- func (w *OrgWriter) Before(d *Document) {}
- func (w *OrgWriter) After(d *Document) {}
-
- func (w *OrgWriter) WriteNodesAsString(nodes ...Node) string {
- builder := w.Builder
- w.Builder = strings.Builder{}
- WriteNodes(w, nodes...)
- out := w.String()
- w.Builder = builder
- return out
- }
-
- func (w *OrgWriter) WriteHeadline(h Headline) {
- start := w.Len()
- w.WriteString(strings.Repeat("*", h.Lvl))
- if h.Status != "" {
- w.WriteString(" " + h.Status)
- }
- if h.Priority != "" {
- w.WriteString(" [#" + h.Priority + "]")
- }
- w.WriteString(" ")
- WriteNodes(w, h.Title...)
- if len(h.Tags) != 0 {
- tString := ":" + strings.Join(h.Tags, ":") + ":"
- if n := w.TagsColumn - len(tString) - (w.Len() - start); n > 0 {
- w.WriteString(strings.Repeat(" ", n) + tString)
- } else {
- w.WriteString(" " + tString)
- }
- }
- w.WriteString("\n")
- if len(h.Children) != 0 {
- w.WriteString(w.indent)
- }
- if h.Properties != nil {
- WriteNodes(w, *h.Properties)
- }
- WriteNodes(w, h.Children...)
- }
-
- func (w *OrgWriter) WriteBlock(b Block) {
- w.WriteString(w.indent + "#+BEGIN_" + b.Name)
- if len(b.Parameters) != 0 {
- w.WriteString(" " + strings.Join(b.Parameters, " "))
- }
- w.WriteString("\n")
- if isRawTextBlock(b.Name) {
- w.WriteString(w.indent)
- }
- WriteNodes(w, b.Children...)
- if !isRawTextBlock(b.Name) {
- w.WriteString(w.indent)
- }
- w.WriteString("#+END_" + b.Name + "\n")
- }
-
- func (w *OrgWriter) WriteDrawer(d Drawer) {
- w.WriteString(w.indent + ":" + d.Name + ":\n")
- WriteNodes(w, d.Children...)
- w.WriteString(w.indent + ":END:\n")
- }
-
- func (w *OrgWriter) WritePropertyDrawer(d PropertyDrawer) {
- w.WriteString(":PROPERTIES:\n")
- for _, kvPair := range d.Properties {
- k, v := kvPair[0], kvPair[1]
- if v != "" {
- v = " " + v
- }
- w.WriteString(fmt.Sprintf(":%s:%s\n", k, v))
- }
- w.WriteString(":END:\n")
- }
-
- func (w *OrgWriter) WriteFootnoteDefinition(f FootnoteDefinition) {
- w.WriteString(fmt.Sprintf("[fn:%s]", f.Name))
- content := w.WriteNodesAsString(f.Children...)
- if content != "" && !unicode.IsSpace(rune(content[0])) {
- w.WriteString(" ")
- }
- w.WriteString(content)
- }
-
- func (w *OrgWriter) WriteParagraph(p Paragraph) {
- content := w.WriteNodesAsString(p.Children...)
- if len(content) > 0 && content[0] != '\n' {
- w.WriteString(w.indent)
- }
- w.WriteString(content + "\n")
- }
-
- func (w *OrgWriter) WriteExample(e Example) {
- for _, n := range e.Children {
- w.WriteString(w.indent + ":")
- if content := w.WriteNodesAsString(n); content != "" {
- w.WriteString(" " + content)
- }
- w.WriteString("\n")
- }
- }
-
- func (w *OrgWriter) WriteKeyword(k Keyword) {
- w.WriteString(w.indent + "#+" + k.Key + ":")
- if k.Value != "" {
- w.WriteString(" " + k.Value)
- }
- w.WriteString("\n")
- }
-
- func (w *OrgWriter) WriteInclude(i Include) {
- w.WriteKeyword(i.Keyword)
- }
-
- func (w *OrgWriter) WriteNodeWithMeta(n NodeWithMeta) {
- for _, ns := range n.Meta.Caption {
- w.WriteString("#+CAPTION: ")
- WriteNodes(w, ns...)
- w.WriteString("\n")
- }
- for _, attributes := range n.Meta.HTMLAttributes {
- w.WriteString("#+ATTR_HTML: ")
- w.WriteString(strings.Join(attributes, " ") + "\n")
- }
- WriteNodes(w, n.Node)
- }
-
- func (w *OrgWriter) WriteNodeWithName(n NodeWithName) {
- w.WriteString(fmt.Sprintf("#+NAME: %s\n", n.Name))
- WriteNodes(w, n.Node)
- }
-
- func (w *OrgWriter) WriteComment(c Comment) {
- w.WriteString(w.indent + "#" + c.Content + "\n")
- }
-
- func (w *OrgWriter) WriteList(l List) { WriteNodes(w, l.Items...) }
-
- func (w *OrgWriter) WriteListItem(li ListItem) {
- originalBuilder, originalIndent := w.Builder, w.indent
- w.Builder, w.indent = strings.Builder{}, w.indent+strings.Repeat(" ", len(li.Bullet)+1)
- WriteNodes(w, li.Children...)
- content := strings.TrimPrefix(w.String(), w.indent)
- w.Builder, w.indent = originalBuilder, originalIndent
- w.WriteString(w.indent + li.Bullet)
- if li.Status != "" {
- w.WriteString(fmt.Sprintf(" [%s]", li.Status))
- }
- if len(content) > 0 && content[0] == '\n' {
- w.WriteString(content)
- } else {
- w.WriteString(" " + content)
- }
- }
-
- func (w *OrgWriter) WriteDescriptiveListItem(di DescriptiveListItem) {
- w.WriteString(w.indent + di.Bullet)
- if di.Status != "" {
- w.WriteString(fmt.Sprintf(" [%s]", di.Status))
- }
- indent := w.indent + strings.Repeat(" ", len(di.Bullet)+1)
- if len(di.Term) != 0 {
- term := w.WriteNodesAsString(di.Term...)
- w.WriteString(" " + term + " ::")
- indent = indent + strings.Repeat(" ", len(term)+4)
- }
- originalBuilder, originalIndent := w.Builder, w.indent
- w.Builder, w.indent = strings.Builder{}, indent
- WriteNodes(w, di.Details...)
- details := strings.TrimPrefix(w.String(), w.indent)
- w.Builder, w.indent = originalBuilder, originalIndent
- if len(details) > 0 && details[0] == '\n' {
- w.WriteString(details)
- } else {
- w.WriteString(" " + details)
- }
- }
-
- func (w *OrgWriter) WriteTable(t Table) {
- for _, row := range t.Rows {
- w.WriteString(w.indent)
- if len(row.Columns) == 0 {
- w.WriteString(`|`)
- for i := 0; i < len(t.ColumnInfos); i++ {
- w.WriteString(strings.Repeat("-", t.ColumnInfos[i].Len+2))
- if i < len(t.ColumnInfos)-1 {
- w.WriteString("+")
- }
- }
- w.WriteString(`|`)
-
- } else {
- w.WriteString(`|`)
- for _, column := range row.Columns {
- w.WriteString(` `)
- content := w.WriteNodesAsString(column.Children...)
- if content == "" {
- content = " "
- }
- n := column.Len - utf8.RuneCountInString(content)
- if n < 0 {
- n = 0
- }
- if column.Align == "center" {
- if n%2 != 0 {
- w.WriteString(" ")
- }
- w.WriteString(strings.Repeat(" ", n/2) + content + strings.Repeat(" ", n/2))
- } else if column.Align == "right" {
- w.WriteString(strings.Repeat(" ", n) + content)
- } else {
- w.WriteString(content + strings.Repeat(" ", n))
- }
- w.WriteString(` |`)
- }
- }
- w.WriteString("\n")
- }
- }
-
- func (w *OrgWriter) WriteHorizontalRule(hr HorizontalRule) {
- w.WriteString(w.indent + "-----\n")
- }
-
- func (w *OrgWriter) WriteText(t Text) { w.WriteString(t.Content) }
-
- func (w *OrgWriter) WriteEmphasis(e Emphasis) {
- borders, ok := emphasisOrgBorders[e.Kind]
- if !ok {
- panic(fmt.Sprintf("bad emphasis %#v", e))
- }
- w.WriteString(borders[0])
- WriteNodes(w, e.Content...)
- w.WriteString(borders[1])
- }
-
- func (w *OrgWriter) WriteLatexFragment(l LatexFragment) {
- w.WriteString(l.OpeningPair)
- WriteNodes(w, l.Content...)
- w.WriteString(l.ClosingPair)
- }
-
- func (w *OrgWriter) WriteStatisticToken(s StatisticToken) {
- w.WriteString(fmt.Sprintf("[%s]", s.Content))
- }
-
- func (w *OrgWriter) WriteLineBreak(l LineBreak) {
- w.WriteString(strings.Repeat("\n"+w.indent, l.Count))
- }
-
- func (w *OrgWriter) WriteExplicitLineBreak(l ExplicitLineBreak) {
- w.WriteString(`\\` + "\n" + w.indent)
- }
-
- func (w *OrgWriter) WriteTimestamp(t Timestamp) {
- w.WriteString("<")
- if t.IsDate {
- w.WriteString(t.Time.Format(datestampFormat))
- } else {
- w.WriteString(t.Time.Format(timestampFormat))
- }
- if t.Interval != "" {
- w.WriteString(" " + t.Interval)
- }
- w.WriteString(">")
- }
-
- func (w *OrgWriter) WriteFootnoteLink(l FootnoteLink) {
- w.WriteString("[fn:" + l.Name)
- if l.Definition != nil {
- w.WriteString(":")
- WriteNodes(w, l.Definition.Children[0].(Paragraph).Children...)
- }
- w.WriteString("]")
- }
-
- func (w *OrgWriter) WriteRegularLink(l RegularLink) {
- if l.AutoLink {
- w.WriteString(l.URL)
- } else if l.Description == nil {
- w.WriteString(fmt.Sprintf("[[%s]]", l.URL))
- } else {
- w.WriteString(fmt.Sprintf("[[%s][%s]]", l.URL, w.WriteNodesAsString(l.Description...)))
- }
- }
|