123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282 |
- package md2man
- import (
- "bytes"
- "fmt"
- "html"
- "strings"
- "github.com/russross/blackfriday"
- )
- type roffRenderer struct{}
- var listCounter int
- func RoffRenderer(flags int) blackfriday.Renderer {
- return &roffRenderer{}
- }
- func (r *roffRenderer) GetFlags() int {
- return 0
- }
- func (r *roffRenderer) TitleBlock(out *bytes.Buffer, text []byte) {
- out.WriteString(".TH ")
- splitText := bytes.Split(text, []byte("\n"))
- for i, line := range splitText {
- line = bytes.TrimPrefix(line, []byte("% "))
- if i == 0 {
- line = bytes.Replace(line, []byte("("), []byte("\" \""), 1)
- line = bytes.Replace(line, []byte(")"), []byte("\" \""), 1)
- }
- line = append([]byte("\""), line...)
- line = append(line, []byte("\" ")...)
- out.Write(line)
- }
- out.WriteString("\n")
- // disable hyphenation
- out.WriteString(".nh\n")
- // disable justification (adjust text to left margin only)
- out.WriteString(".ad l\n")
- }
- func (r *roffRenderer) BlockCode(out *bytes.Buffer, text []byte, lang string) {
- out.WriteString("\n.PP\n.RS\n\n.nf\n")
- escapeSpecialChars(out, text)
- out.WriteString("\n.fi\n.RE\n")
- }
- func (r *roffRenderer) BlockQuote(out *bytes.Buffer, text []byte) {
- out.WriteString("\n.PP\n.RS\n")
- out.Write(text)
- out.WriteString("\n.RE\n")
- }
- func (r *roffRenderer) BlockHtml(out *bytes.Buffer, text []byte) {
- out.Write(text)
- }
- func (r *roffRenderer) Header(out *bytes.Buffer, text func() bool, level int, id string) {
- marker := out.Len()
- switch {
- case marker == 0:
- // This is the doc header
- out.WriteString(".TH ")
- case level == 1:
- out.WriteString("\n\n.SH ")
- case level == 2:
- out.WriteString("\n.SH ")
- default:
- out.WriteString("\n.SS ")
- }
- if !text() {
- out.Truncate(marker)
- return
- }
- }
- func (r *roffRenderer) HRule(out *bytes.Buffer) {
- out.WriteString("\n.ti 0\n\\l'\\n(.lu'\n")
- }
- func (r *roffRenderer) List(out *bytes.Buffer, text func() bool, flags int) {
- marker := out.Len()
- if flags&blackfriday.LIST_TYPE_ORDERED != 0 {
- listCounter = 1
- }
- if !text() {
- out.Truncate(marker)
- return
- }
- }
- func (r *roffRenderer) ListItem(out *bytes.Buffer, text []byte, flags int) {
- if flags&blackfriday.LIST_TYPE_ORDERED != 0 {
- out.WriteString(fmt.Sprintf(".IP \"%3d.\" 5\n", listCounter))
- listCounter += 1
- } else {
- out.WriteString(".IP \\(bu 2\n")
- }
- out.Write(text)
- out.WriteString("\n")
- }
- func (r *roffRenderer) Paragraph(out *bytes.Buffer, text func() bool) {
- marker := out.Len()
- out.WriteString("\n.PP\n")
- if !text() {
- out.Truncate(marker)
- return
- }
- if marker != 0 {
- out.WriteString("\n")
- }
- }
- // TODO: This might now work
- func (r *roffRenderer) Table(out *bytes.Buffer, header []byte, body []byte, columnData []int) {
- out.WriteString(".TS\nallbox;\n")
- out.Write(header)
- out.Write(body)
- out.WriteString("\n.TE\n")
- }
- func (r *roffRenderer) TableRow(out *bytes.Buffer, text []byte) {
- if out.Len() > 0 {
- out.WriteString("\n")
- }
- out.Write(text)
- out.WriteString("\n")
- }
- func (r *roffRenderer) TableHeaderCell(out *bytes.Buffer, text []byte, align int) {
- if out.Len() > 0 {
- out.WriteString(" ")
- }
- out.Write(text)
- out.WriteString(" ")
- }
- // TODO: This is probably broken
- func (r *roffRenderer) TableCell(out *bytes.Buffer, text []byte, align int) {
- if out.Len() > 0 {
- out.WriteString("\t")
- }
- out.Write(text)
- out.WriteString("\t")
- }
- func (r *roffRenderer) Footnotes(out *bytes.Buffer, text func() bool) {
- }
- func (r *roffRenderer) FootnoteItem(out *bytes.Buffer, name, text []byte, flags int) {
- }
- func (r *roffRenderer) AutoLink(out *bytes.Buffer, link []byte, kind int) {
- out.WriteString("\n\\[la]")
- out.Write(link)
- out.WriteString("\\[ra]")
- }
- func (r *roffRenderer) CodeSpan(out *bytes.Buffer, text []byte) {
- out.WriteString("\\fB\\fC")
- escapeSpecialChars(out, text)
- out.WriteString("\\fR")
- }
- func (r *roffRenderer) DoubleEmphasis(out *bytes.Buffer, text []byte) {
- out.WriteString("\\fB")
- out.Write(text)
- out.WriteString("\\fP")
- }
- func (r *roffRenderer) Emphasis(out *bytes.Buffer, text []byte) {
- out.WriteString("\\fI")
- out.Write(text)
- out.WriteString("\\fP")
- }
- func (r *roffRenderer) Image(out *bytes.Buffer, link []byte, title []byte, alt []byte) {
- }
- func (r *roffRenderer) LineBreak(out *bytes.Buffer) {
- out.WriteString("\n.br\n")
- }
- func (r *roffRenderer) Link(out *bytes.Buffer, link []byte, title []byte, content []byte) {
- out.Write(content)
- r.AutoLink(out, link, 0)
- }
- func (r *roffRenderer) RawHtmlTag(out *bytes.Buffer, tag []byte) {
- out.Write(tag)
- }
- func (r *roffRenderer) TripleEmphasis(out *bytes.Buffer, text []byte) {
- out.WriteString("\\s+2")
- out.Write(text)
- out.WriteString("\\s-2")
- }
- func (r *roffRenderer) StrikeThrough(out *bytes.Buffer, text []byte) {
- }
- func (r *roffRenderer) FootnoteRef(out *bytes.Buffer, ref []byte, id int) {
- }
- func (r *roffRenderer) Entity(out *bytes.Buffer, entity []byte) {
- out.WriteString(html.UnescapeString(string(entity)))
- }
- func processFooterText(text []byte) []byte {
- text = bytes.TrimPrefix(text, []byte("% "))
- newText := []byte{}
- textArr := strings.Split(string(text), ") ")
- for i, w := range textArr {
- if i == 0 {
- w = strings.Replace(w, "(", "\" \"", 1)
- w = fmt.Sprintf("\"%s\"", w)
- } else {
- w = fmt.Sprintf(" \"%s\"", w)
- }
- newText = append(newText, []byte(w)...)
- }
- newText = append(newText, []byte(" \"\"")...)
- return newText
- }
- func (r *roffRenderer) NormalText(out *bytes.Buffer, text []byte) {
- escapeSpecialChars(out, text)
- }
- func (r *roffRenderer) DocumentHeader(out *bytes.Buffer) {
- }
- func (r *roffRenderer) DocumentFooter(out *bytes.Buffer) {
- }
- func needsBackslash(c byte) bool {
- for _, r := range []byte("-_&\\~") {
- if c == r {
- return true
- }
- }
- return false
- }
- func escapeSpecialChars(out *bytes.Buffer, text []byte) {
- for i := 0; i < len(text); i++ {
- // escape initial apostrophe or period
- if len(text) >= 1 && (text[0] == '\'' || text[0] == '.') {
- out.WriteString("\\&")
- }
- // directly copy normal characters
- org := i
- for i < len(text) && !needsBackslash(text[i]) {
- i++
- }
- if i > org {
- out.Write(text[org:i])
- }
- // escape a character
- if i >= len(text) {
- break
- }
- out.WriteByte('\\')
- out.WriteByte(text[i])
- }
- }
|