package textfmt import ( "bytes" "errors" "fmt" "io" "strings" ) func escapeTeletype(s string) string { r := []rune(s) for i := range r { if r[i] >= 0x00 && r[i] <= 0x1f && r[i] != '\n' && r[i] != '\t' { r[i] = 0xb7 } if r[i] >= 0x7f && r[i] <= 0x9f { r[i] = 0xb7 } } return string(r) } func ttyTextToString(text Txt) (string, error) { var b bytes.Buffer w := ttyWriter{w: &b, internal: true} renderTTYText(&w, text) if w.err != nil { return "", w.err } return b.String(), nil } func ttyDefinitionNames(d []DefinitionItem) ([]string, error) { var n []string for _, di := range d { name, err := ttyTextToString(di.name) if err != nil { return nil, err } n = append(n, name) } return n, nil } func renderTTYText(w writer, text Txt) { if len(text.cat) > 0 { for i, tc := range text.cat { if i > 0 { w.write(" ") } renderTTYText(w, tc) } return } text.text = singleLine(text.text) text.text = escapeTeletype(text.text) text.link = singleLine(text.link) text.link = escapeTeletype(text.link) if text.link != "" { if text.text != "" { w.write(text.text) w.write(" (") w.write(text.link) w.write(")") return } w.write(text.link) return } w.write(text.text) } func renderTTYTitle(w writer, e Entry) { w.write(timesn(" ", e.indent)) renderTTYText(w, e.text) } func renderTTYParagraph(w writer, e Entry) { txt, err := ttyTextToString(e.text) if err != nil { w.setErr(err) } indentFirst := e.indent + e.indentFirst if e.wrapWidth > 0 { txt = wrap(txt, e.wrapWidth, indentFirst, e.indent) } writeLines(w, txt, indentFirst, e.indent) } func renderTTYList(w writer, e Entry) { for i, item := range e.items { if i > 0 { w.write("\n") } p := itemToParagraph(e, item.text, "-") renderTTYParagraph(w, p) } } func renderTTYNumberedList(w writer, e Entry) { maxDigits := numDigits(len(e.items)) for i, item := range e.items { if i > 0 { w.write("\n") } p := itemToParagraph(e, item.text, padRight(fmt.Sprintf("%d.", i+1), maxDigits+1)) renderTTYParagraph(w, p) } } func renderTTYDefinitions(w writer, e Entry) { names, err := ttyDefinitionNames(e.definitions) if err != nil { w.setErr(err) return } maxNameLength := maxLength(names) for i, definition := range e.definitions { if i > 0 { w.write("\n") } p := itemToParagraph( e, definition.value, padRight(fmt.Sprintf("- %s:", names[i]), maxNameLength+3), ) renderTTYParagraph(w, p) } } func renderTTYNumberedDefinitions(w writer, e Entry) { names, err := ttyDefinitionNames(e.definitions) if err != nil { w.setErr(err) return } maxNameLength := maxLength(names) maxDigits := numDigits(len(e.definitions)) for i, definition := range e.definitions { if i > 0 { w.write("\n") } p := itemToParagraph( e, definition.value, padRight( fmt.Sprintf( "%s %s:", padRight(fmt.Sprintf("%d.", i+1), maxDigits+1), names[i], ), maxNameLength+maxDigits+3, ), ) renderTTYParagraph(w, p) } } func ttyCellTexts(rows []TableRow) ([][]string, error) { var cellTexts [][]string for _, row := range rows { var c []string for _, cell := range row.cells { txt, err := ttyTextToString(cell.text) if err != nil { return nil, err } c = append(c, txt) } cellTexts = append(cellTexts, c) } return cellTexts, nil } func renderTTYTable(w writer, e Entry) { if len(e.rows) == 0 { return } e.rows = normalizeTable(e.rows) if len(e.rows[0].cells) == 0 { return } cellTexts, err := ttyCellTexts(e.rows) if err != nil { w.setErr(err) } totalSeparatorWidth := (len(cellTexts[0]) - 1) * 3 if e.wrapWidth > 0 { allocatedWidth := e.wrapWidth - e.indent - totalSeparatorWidth columnWeights := columnWeights(cellTexts) targetColumnWidths := targetColumnWidths(allocatedWidth, columnWeights) for i := range cellTexts { for j := range cellTexts[i] { cellTexts[i][j] = wrap(cellTexts[i][j], targetColumnWidths[j], 0, 0) } } } columnWidths := columnWidths(cellTexts) totalWidth := totalSeparatorWidth for i := range columnWidths { totalWidth += columnWidths[i] } hasHeader := e.rows[0].header for i := range cellTexts { if i > 0 { sep := "-" if hasHeader && i == 1 { sep = "=" } w.write("\n") w.write(timesn(" ", e.indent), timesn(sep, totalWidth)) w.write("\n") } lines := make([][]string, len(cellTexts[i])) for j := range cellTexts[i] { lines[j] = strings.Split(cellTexts[i][j], "\n") } var maxLines int for j := range lines { if len(lines[j]) > maxLines { maxLines = len(lines[j]) } } for k := 0; k < maxLines; k++ { if k > 0 { w.write("\n") } for j := range lines { if j == 0 { w.write(timesn(" ", e.indent)) } else { w.write(" | ") } var l string if k < len(lines[j]) { l = lines[j][k] } w.write(padRight(l, columnWidths[j])) } } } if hasHeader && len(cellTexts) == 1 { w.write("\n", timesn("=", totalWidth)) } } func renderTTYCode(w writer, e Entry) { e.text.text = escapeTeletype(e.text.text) writeLines(w, e.text.text, e.indent, e.indent) } func renderTTYMultiple(w writer, s SyntaxItem) { s.topLevel = false s.multiple = false renderTTYSyntaxItem(w, s) w.write("...") } func renderTTYRequired(w writer, s SyntaxItem) { s.delimited = true s.topLevel = false s.required = false w.write("<") renderTTYSyntaxItem(w, s) w.write(">") } func renderTTYOptional(w writer, s SyntaxItem) { s.delimited = true s.topLevel = false s.optional = false w.write("[") renderTTYSyntaxItem(w, s) w.write("]") } func renderTTYSequence(w writer, s SyntaxItem) { if !s.delimited && !s.topLevel { w.write("(") } for i, item := range s.sequence { if i > 0 { w.write(" ") } item.delimited = false renderTTYSyntaxItem(w, item) } if !s.delimited && !s.topLevel { w.write(")") } } func renderTTYChoice(w writer, s SyntaxItem) { if !s.delimited && !s.topLevel { w.write("(") } for i, item := range s.choice { if i > 0 { separator := "|" if s.topLevel { separator = "\n" } w.write(separator) } item.delimited = false renderTTYSyntaxItem(w, item) } if !s.delimited && !s.topLevel { w.write(")") } } func renderTTYSymbol(w writer, s SyntaxItem) { w.write(escapeTeletype(s.symbol)) } func renderTTYSyntaxItem(w writer, s SyntaxItem) { switch { // foo... case s.multiple: renderTTYMultiple(w, s) // case s.required: renderTTYRequired(w, s) // [foo] case s.optional: renderTTYOptional(w, s) // foo bar baz or (foo bar baz) case len(s.sequence) > 0: renderTTYSequence(w, s) // foo|bar|baz or (foo|bar|baz) case len(s.choice) > 0: renderTTYChoice(w, s) // foo default: renderTTYSymbol(w, s) } } func renderTTYSyntax(w writer, e Entry) { s := e.syntax s.topLevel = true w.write(timesn(" ", e.indent+e.indentFirst)) renderTTYSyntaxItem(w, s) } func renderTeletype(out io.Writer, d Document) error { w := ttyWriter{w: out} for i, e := range d.entries { if i > 0 { w.write("\n\n") } switch e.typ { case invalid: return errors.New("invalid entry") case title: renderTTYTitle(&w, e) case paragraph: renderTTYParagraph(&w, e) case list: renderTTYList(&w, e) case numberedList: renderTTYNumberedList(&w, e) case definitions: renderTTYDefinitions(&w, e) case numberedDefinitions: renderTTYNumberedDefinitions(&w, e) case table: renderTTYTable(&w, e) case code: renderTTYCode(&w, e) case syntax: renderTTYSyntax(&w, e) } } if len(d.entries) > 0 { w.write("\n") } return w.err }