Refactor the CLI markup code to make it re-useable

tools/cli/markup/prettify.go

@@ -0,0 +1,189 @@
+// License: GPLv3 Copyright: 2022, Kovid Goyal, <kovid at kovidgoyal.net>
+
+package markup
+
+import (
+	"fmt"
+	"os"
+	"path/filepath"
+	"regexp"
+	"strings"
+
+	"kitty"
+	"kitty/tools/utils"
+	"kitty/tools/utils/style"
+)
+
+var _ = fmt.Print
+
+type Context struct {
+	fmt_ctx style.Context
+
+	Cyan, Green, Blue, BrightRed, Yellow, Italic, Bold, Title, Exe, Opt, Emph, Err, Code func(args ...interface{}) string
+	Url                                                                                  func(string, string) string
+}
+
+var (
+	fmt_ctx = style.Context{}
+)
+
+func New(allow_escape_codes bool) *Context {
+	ans := Context{}
+	ans.fmt_ctx.AllowEscapeCodes = allow_escape_codes
+	fmt_ctx := &ans.fmt_ctx
+
+	ans.Cyan = fmt_ctx.SprintFunc("fg=bright-cyan")
+	ans.Green = fmt_ctx.SprintFunc("fg=green")
+	ans.Blue = fmt_ctx.SprintFunc("fg=blue")
+	ans.BrightRed = fmt_ctx.SprintFunc("fg=bright-red")
+	ans.Yellow = fmt_ctx.SprintFunc("fg=bright-yellow")
+	ans.Italic = fmt_ctx.SprintFunc("italic")
+	ans.Bold = fmt_ctx.SprintFunc("bold")
+	ans.Title = fmt_ctx.SprintFunc("bold fg=blue")
+	ans.Exe = fmt_ctx.SprintFunc("bold fg=bright-yellow")
+	ans.Opt = ans.Green
+	ans.Emph = ans.BrightRed
+	ans.Err = fmt_ctx.SprintFunc("bold fg=bright-red")
+	ans.Code = ans.Cyan
+	ans.Url = fmt_ctx.UrlFunc("u=curly uc=cyan")
+
+	return &ans
+}
+
+func ReplaceAllStringSubmatchFunc(re *regexp.Regexp, str string, repl func([]string) string) string {
+	result := ""
+	lastIndex := 0
+
+	for _, v := range re.FindAllSubmatchIndex([]byte(str), -1) {
+		groups := []string{}
+		for i := 0; i < len(v); i += 2 {
+			if v[i] == -1 || v[i+1] == -1 {
+				groups = append(groups, "")
+			} else {
+				groups = append(groups, str[v[i]:v[i+1]])
+			}
+		}
+
+		result += str[lastIndex:v[0]] + repl(groups)
+		lastIndex = v[1]
+	}
+
+	return result + str[lastIndex:]
+}
+
+func website_url(doc string) string {
+	if doc != "" {
+		doc = strings.TrimSuffix(doc, "/")
+		if doc != "" {
+			doc += "/"
+		}
+	}
+	return kitty.WebsiteBaseURL + doc
+}
+
+var prettify_pat = regexp.MustCompile(":([a-z]+):`([^`]+)`")
+
+func (self *Context) hyperlink_for_url(url string, text string) string {
+	return self.Url(url, text)
+}
+
+func (self *Context) hyperlink_for_path(path string, text string) string {
+	if !fmt_ctx.AllowEscapeCodes {
+		return text
+	}
+	path = strings.ReplaceAll(utils.Abspath(path), string(os.PathSeparator), "/")
+	fi, err := os.Stat(path)
+	if err == nil && fi.IsDir() {
+		path = strings.TrimSuffix(path, "/") + "/"
+	}
+	host := utils.CachedHostname()
+	url := "file://" + host + path
+	return self.hyperlink_for_url(url, text)
+}
+
+func text_and_target(x string) (text string, target string) {
+	parts := strings.SplitN(x, "<", 2)
+	text = strings.TrimSpace(parts[0])
+	target = strings.TrimRight(parts[len(parts)-1], ">")
+	return
+}
+
+func (self *Context) ref_hyperlink(x string, prefix string) string {
+	text, target := text_and_target(x)
+	url := "kitty+doc://" + utils.CachedHostname() + "/#ref=" + prefix + target
+	text = ReplaceAllStringSubmatchFunc(prettify_pat, text, func(groups []string) string {
+		return groups[2]
+	})
+	return self.hyperlink_for_url(url, text)
+}
+
+func (self *Context) Prettify(text string) string {
+	return ReplaceAllStringSubmatchFunc(prettify_pat, text, func(groups []string) string {
+		val := groups[2]
+		switch groups[1] {
+		case "file":
+			if val == "kitty.conf" && self.fmt_ctx.AllowEscapeCodes {
+				path := filepath.Join(utils.ConfigDir(), val)
+				val = self.hyperlink_for_path(path, val)
+			}
+			return self.Italic(val)
+		case "env", "envvar":
+			return self.ref_hyperlink(val, "envvar-")
+		case "doc":
+			text, target := text_and_target(val)
+			if text == target {
+				target = strings.Trim(target, "/")
+				if title, ok := kitty.DocTitleMap[target]; ok {
+					val = title + " <" + target + ">"
+				}
+			}
+			return self.ref_hyperlink(val, "doc-")
+		case "iss":
+			return self.ref_hyperlink(val, "issues-")
+		case "pull":
+			return self.ref_hyperlink(val, "pull-")
+		case "disc":
+			return self.ref_hyperlink(val, "discussions-")
+		case "ref":
+			return self.ref_hyperlink(val, "")
+		case "ac":
+			return self.ref_hyperlink(val, "action-")
+		case "term":
+			return self.ref_hyperlink(val, "term-")
+		case "code":
+			return self.Code(val)
+		case "option":
+			idx := strings.LastIndex(val, "--")
+			if idx < 0 {
+				idx = strings.Index(val, "-")
+			}
+			if idx > -1 {
+				val = val[idx:]
+			}
+			return self.Bold(val)
+		case "opt":
+			return self.Bold(val)
+		case "yellow":
+			return self.Yellow(val)
+		case "blue":
+			return self.Blue(val)
+		case "green":
+			return self.Green(val)
+		case "cyan":
+			return self.Cyan(val)
+		case "emph":
+			return self.Italic(val)
+		default:
+			return val
+		}
+
+	})
+}
+
+func (self *Context) SetAllowEscapeCodes(allow_escape_codes bool) {
+	self.fmt_ctx.AllowEscapeCodes = allow_escape_codes
+}
+
+func (self *Context) EscapeCodesAllowed() bool {
+	return self.fmt_ctx.AllowEscapeCodes
+}