%s
", "sso", strings.Join(append(path, "sso"), "/"), html.EscapeString(v.Text)) default: fmt.Fprintf(w, "%s
\n", v.Type, strings.Join(append(path, v.Type), "/"), html.EscapeString(v.Text)) } } if documentFN != "" { base := filepath.Base(documentFN) base = base[:len(base)-len(".n")] + ".html" w.WriteString("\n") ofn := filepath.Join(tempDir, base) if err := os.WriteFile(ofn, w.Bytes(), 0660); err != nil { panic(err) } htmlFiles = append(htmlFiles, ofn) } return htmlFiles } func walk(lvl int, n *html.Node, visitor func(n *html.Node) (dive bool)) { for ; n != nil; n = n.NextSibling { if visitor(n) { walk(lvl+1, n.FirstChild, visitor) } } } func class(n *html.Node) string { for _, v := range n.Attr { if v.Key == "class" { return v.Val } } return "" } type document struct { fn string root *html.Node sh []*html.Node shx map[string]*html.Node so []*html.Node } type option struct { docs []string goName string tclName string xref map[string]struct{} isWidgetOption bool } type job struct { documents []*document files []string o *bytes.Buffer optionsDoc *document optionsByTclName map[string]*option ttkOptionsDoc *document } func newJob(o *bytes.Buffer, files []string) *job { return &job{ files: files, o: o, optionsByTclName: map[string]*option{}, } } func (j *job) registerOption(tclName string, docs []string, xref string) (r *option) { switch { case strings.HasPrefix(xref, "[."): xref = "[Window." + xref[len("[."):] } r = j.optionsByTclName[tclName] if r == nil { r = &option{ tclName: tclName, goName: tclOptName2GoName(tclName), docs: docs, xref: map[string]struct{}{}, } j.optionsByTclName[tclName] = r } if xref != "" { r.xref[xref] = struct{}{} } return r } func (j *job) w(s string, args ...any) { fmt.Fprintf(j.o, s, args...) } func (j *job) analyze(file string) { f, err := os.Open(file) if err != nil { panic(err) } defer f.Close() n, err := html.Parse(f) if err != nil { panic(err) } d := &document{ fn: file, root: n, shx: map[string]*html.Node{}, } switch filepath.Base(file) { case "options.html": j.optionsDoc = d case "ttk_widget.html": j.ttkOptionsDoc = d } j.documents = append(j.documents, d) walk(0, n, func(n *html.Node) (dive bool) { switch n.Type { case html.ElementNode: switch n.Data { case "p": switch class(n) { case "SH": s := strings.TrimSpace(n.FirstChild.Data) if d.shx[s] != nil { panic("internal error") } d.shx[s] = n d.sh = append(d.sh, n) } case "div": switch class(n) { case "SO": d.so = append(d.so, n) } } } return true }) } func base(fn string) (r string) { x := strings.Index(fn, "/") r = fn[x+1:] return r[:len(r)-len(".html")] } func (j *job) main() { for _, v := range j.files { j.analyze(v) } for _, v := range j.documents { var a []string for k := range v.shx { a = append(a, k) } slices.Sort(a) if len(v.so) != 0 { a = append(a, fmt.Sprintf("len(so)=%v", len(v.so))) } // fmt.Printf("%s %v\n", v.fn, a) base := base(v.fn) if nfo := pageInfos[base]; nfo == nil && len(v.so) != 0 { pageInfos[base] = &pageInfo{widget: true} } } var fail bool for _, fn := range j.files { base := base(fn) nfo := pageInfos[base] switch { case nfo == nil: fmt.Printf("%s: missing page info\n", base) case nfo.ignore, nfo.manual, nfo.widget: // ok default: fmt.Printf("%s: missing classificaiotn\n", base) fail = true } } if fail { return } for i, fn := range j.files { base := base(fn) nfo := pageInfos[base] switch { case nfo.widget: j.widget(fn, j.documents[i]) if len(nfo.commands) != 0 { j.manual(fn, j.documents[i], nfo) } case nfo.manual: j.manual(fn, j.documents[i], nfo) } } j.stdOptions() j.ttkStdOptions() var a []string for k := range j.optionsByTclName { a = append(a, k) } slices.Sort(a) for _, k := range a { v := j.optionsByTclName[k] if hideOpts[v.goName] || hideOptMethods[v.goName] { continue } j.w("\n\n// %s option.", v.goName) if handlers[v.goName] { j.w("\n//\n// See also [Event handlers].") } if len(v.docs) != 0 { j.w("\n//\n// %s", strings.Join(v.docs, "\n//")) } if len(v.xref) != 0 { j.w("\n//\n// Known uses:") var a []string for k := range v.xref { a = append(a, k) } slices.Sort(a) for _, v := range a { j.w("\n// - %s", v) } } switch ok := handlers[v.goName]; { case ok: j.w("\n//\n// [Event handlers]: https://pkg.go.dev/modernc.org/tk9.0#hdr-Event_handlers") j.w("\nfunc %s(handler any) Opt {", v.goName) j.w("\n\treturn newEventHandler(%q, handler)", v.tclName) j.w("\n}") default: j.w("\nfunc %s(val any) Opt {", v.goName) j.w("\nreturn rawOption(fmt.Sprintf(`%s %%s`, optionString(val)))", v.tclName) j.w("\n}") if !v.isWidgetOption { break } j.w("\n\n// %s — Get the configured option value.", v.goName) if len(v.xref) != 0 { j.w("\n//\n// Known uses:") var a []string for k := range v.xref { a = append(a, k) } slices.Sort(a) for _, v := range a { if !strings.Contains(v, "command specific") { j.w("\n// - %s", v) } } } j.w("\nfunc (w *Window) %s() string {", v.goName) j.w("\nreturn evalErr(fmt.Sprintf(`%%s cget %s`, w))", v.tclName) j.w("\n}") } } } func (j *job) ttkStdOptions() { walk(0, j.ttkOptionsDoc.root, func(n *html.Node) (dive bool) { if nodeIs(n, "OP") { tclName := strings.TrimSpace(n.FirstChild.Data) a := strings.Fields(tclName) tclName = strings.TrimLeft(a[0], `"\`) var docs []string for n := n.NextSibling; n != nil; n = n.NextSibling { if nodeIs(n, "OP") || nodeIs(n, "SH") { break } if !nodeIs(n, "text") { continue } s := strings.TrimSpace(plain(n.FirstChild.Data)) docs = append(docs, s) } o := j.registerOption(tclName, nil, "") o.isWidgetOption = true if len(o.docs) == 0 { o.docs = docs } } return true }) } func (j *job) stdOptions() { walk(0, j.optionsDoc.root, func(n *html.Node) (dive bool) { if nodeIs(n, "OP") { tclName := strings.TrimSpace(n.FirstChild.Data) a := strings.Fields(tclName) tclName = strings.TrimLeft(a[0], `"\`) var docs []string for n := n.NextSibling; n != nil; n = n.NextSibling { if nodeIs(n, "OP") || nodeIs(n, "SH") { break } if !nodeIs(n, "text") { continue } s := strings.TrimSpace(plain(n.FirstChild.Data)) docs = append(docs, s) } o := j.registerOption(tclName, nil, "") o.isWidgetOption = true o.docs = docs } return true }) } func nodeIs(n *html.Node, pathSuffix string) bool { for _, v := range n.Attr { if v.Key == "title" && strings.HasSuffix(v.Val, pathSuffix) { return true } } return false } func (j *job) widgetStdOpts(xref string, doc *document) (r []string) { m := map[string]struct{}{} walk(0, doc.root, func(n *html.Node) (dive bool) { if nodeIs(n, "SO/text") { s := strings.TrimSpace(n.FirstChild.Data) a := strings.Fields(s) for _, v := range a { s := strings.TrimSpace(v) if s[0] == '\\' { s = s[1:] } j.registerOption(s, nil, xref).isWidgetOption = true s = tclOptName2GoName(s) m[s] = struct{}{} } } return true }) for k := range m { r = append(r, k) } slices.Sort(r) return r } func (j *job) widgetStylingOptions(doc *document) (r []string) { for _, n := range doc.sh { if ch := n.FirstChild; ch != nil && strings.Contains(ch.Data, "STYLING OPTIONS") { for n := n.NextSibling; n != nil; n = n.NextSibling { if hasClass(n, "SH") { break } if hasClass(n, "PP") { r = append(r, "") continue } if ch := n.FirstChild; ch != nil { s := strings.TrimSpace(plain(ch.Data)) if strings.HasPrefix(s, "-") { s = s[1:] a := strings.Fields(s) s = fmt.Sprintf(" - [%s] %s", capitalize(a[0]), strings.Join(a[1:], " ")) for len(r) != 0 && r[len(r)-1] == "" { r = r[:len(r)-1] } } r = append(r, s) } } break } } return r } func capitalize(s string) string { return strings.ToUpper(string(s[0])) + s[1:] } func (j *job) widgetStdStyles(doc *document) (r []string) { for _, n := range doc.sh { if ch := n.FirstChild; ch != nil && strings.Contains(ch.Data, "STANDARD STYLES") { for n := n.NextSibling; n != nil; n = n.NextSibling { if hasClass(n, "SH") { break } if hasClass(n, "PP") { r = append(r, "") continue } if ch := n.FirstChild; ch != nil { r = append(r, strings.TrimSpace(plain(ch.Data))) } } break } } return r } func (j *job) widgetSpecificOpts(xref string, doc *document) (r []*option) { ok := false walk(0, doc.root, func(n *html.Node) (dive bool) { if nodeIs(n, "SH") { s := strings.ToLower(n.FirstChild.Data) // Reject options within section headings like "TAB OPTIONS". ok = strings.Contains(s, "widget") && strings.Contains(s, "specific") && strings.Contains(s, "options") } if ok && nodeIs(n, "OP") { tclName := strings.TrimSpace(n.FirstChild.Data) a := strings.Fields(tclName) tclName = strings.TrimLeft(a[0], `"\`) var docs []string for n := n.NextSibling; n != nil; n = n.NextSibling { if nodeIs(n, "OP") || nodeIs(n, "SH") { break } if !nodeIs(n, "text") { continue } s := strings.TrimSpace(plain(n.FirstChild.Data)) docs = append(docs, s) } o := j.registerOption(tclName, nil, xref) o.isWidgetOption = true p := *o p.docs = docs r = append(r, &p) } return true }) return r } func tclOptName2GoName(s string) (r string) { s = strings.TrimSpace(s) if strings.HasPrefix(s, "\\") { s = s[1:] } if strings.HasPrefix(s, "-") { s = s[1:] } r = export(s) if x := replaceOpt[r]; x != "" { r = x } return r } func (j *job) pageLink(page string) { if page == "" { return } page = page[:len(page)-len(".html")] j.w("\n//\n// More information might be available at the [Tcl/Tk %s] page.", page) j.w("\n//\n// [Tcl/Tk %s]: https://www.tcl-lang.org/man/tcl9.0/TkCmd/%[1]s.html", page) } func (j *job) manual(fn string, doc *document, nfo *pageInfo) { for nm, options := range nfo.commands { for _, option := range options { j.registerOption(option, nil, fmt.Sprintf("[%s] (command specific)", nm)) } } } func (j *job) widget(fn string, doc *document) { shNameNode := doc.shx["NAME"] txtNode := shNameNode.NextSibling.NextSibling.FirstChild txt := txtNode.Data txt = strings.TrimSpace(txt[strings.Index(txt, "-")+1:]) txt = strings.ToUpper(txt[:1]) + txt[1:] base := base(fn) gnm := tclName2GoName(base) doc0 := []string{fmt.Sprintf("\n\n// %s — %s", gnm, txt)} doc0 = append(doc0, j.description(doc.shx["DESCRIPTION"])...) j.w("%s", strings.Join(doc0, "\n// ")) j.w("\n//\n// Use [Window.%s] to create a %[1]s with a particular parent.", gnm) j.pageLink(fn[len(tempDir)+1:]) if opts := j.widgetStdOpts(fmt.Sprintf("[%s]", gnm), doc); len(opts) != 0 { j.w("\n//\n// # Standard options\n//") for _, v := range opts { if hideOpts[v] { continue } j.w("\n// - [%s]", v) } } if sos := j.widgetSpecificOpts(fmt.Sprintf("[%s] (widget specific)", gnm), doc); len(sos) != 0 { j.w("\n//\n// # Widget specific options") for _, v := range sos { j.w("\n//\n// [%s]", v.goName) j.w("\n//\n// %s", strings.Join(v.docs, "\n// ")) } } if ss := j.widgetStdStyles(doc); len(ss) != 0 { j.w("\n//\n// # Standard styles\n//") for _, v := range ss { j.w("\n// %s", v) } } if sos := j.widgetStylingOptions(doc); len(sos) != 0 { j.w("\n//\n// # Styling options\n//") for _, v := range sos { j.w("\n// %s", v) } } j.w("\nfunc %s(options ...Opt) *%[1]sWidget {", gnm) j.w("\nreturn App.%s(options...)", gnm) j.w("\n}") j.w("%s", doc0[0]) j.w("\n//\n// The resulting [Window] is a child of 'w'") j.w("\n//\n// For details please see [%s]", gnm) j.w("\nfunc (w *Window) %s(options ...Opt) *%[1]sWidget {", gnm) cmd := strings.Replace(base, "ttk_", "ttk::", 1) j.w("\nreturn &%sWidget{w.newChild(%q, options...)}", gnm, cmd) j.w("\n}") j.w("\n\n// %sWidget represents the Tcl/Tk %s widget/window", gnm, base) j.w("\ntype %sWidget struct {", gnm) j.w("\n*Window") j.w("\n}") } func (j *job) description(n *html.Node) (r []string) { if n == nil { return nil } r = append(r, "", "# Description\n//") stop := false walk(0, n.NextSibling, func(n *html.Node) (dive bool) { if stop { return false } if hasClass(n, "SH") { stop = true return false } if hasClass(n, "PP") { r = append(r, "") return false } switch n.Type { case html.TextNode: if s := strings.TrimSpace(plain(n.Data)); s != "" && !strings.HasPrefix(s, `\"`) && !strings.HasPrefix(s, "-") { r = append(r, s) } } return true }) return r } func hasClass(n *html.Node, cls string) bool { for _, v := range n.Attr { if v.Key == "class" && v.Val == cls { return true } } return false } func plain(s string) (r string) { r = s r = strings.ReplaceAll(r, "\\-", "-") r = strings.ReplaceAll(r, "\\fB", "") r = strings.ReplaceAll(r, "\\fI", "") r = strings.ReplaceAll(r, "\\fP", "") r = strings.ReplaceAll(r, "\\fR", "") return r } func tclName2GoName(s string) string { switch { case strings.HasPrefix(s, "ttk_"): return "T" + export(s[len("ttk_"):]) default: return export(s) } } func export(s string) (r string) { a := strings.Split(s, "_") for i, v := range a { a[i] = strings.ToUpper(v[:1]) + v[1:] } return strings.Join(a, "") } // origin returns caller's short position, skipping skip frames. // //lint:ignore U1000 debug helper func origin(skip int) string { pc, fn, fl, _ := runtime.Caller(skip) f := runtime.FuncForPC(pc) var fns string if f != nil { fns = f.Name() if x := strings.LastIndex(fns, "."); x > 0 { fns = fns[x+1:] } if strings.HasPrefix(fns, "func") { num := true for _, c := range fns[len("func"):] { if c < '0' || c > '9' { num = false break } } if num { return origin(skip + 2) } } } return fmt.Sprintf("%s:%d:%s", filepath.Base(fn), fl, fns) } // todo prints and return caller's position and an optional message tagged with TODO. Output goes to stderr. // //lint:ignore U1000 debug helper func todo(s string, args ...interface{}) string { switch { case s == "": s = fmt.Sprintf(strings.Repeat("%v ", len(args)), args...) default: s = fmt.Sprintf(s, args...) } r := fmt.Sprintf("%s\n\tTODO %s", origin(2), s) // fmt.Fprintf(os.Stderr, "%s\n", r) // os.Stdout.Sync() return r } // trc prints and return caller's position and an optional message tagged with TRC. Output goes to stderr. // //lint:ignore U1000 debug helper func trc(s string, args ...interface{}) string { switch { case s == "": s = fmt.Sprintf(strings.Repeat("%v ", len(args)), args...) default: s = fmt.Sprintf(s, args...) } r := fmt.Sprintf("%s: TRC %s", origin(2), s) fmt.Fprintf(os.Stderr, "%s\n", r) os.Stderr.Sync() return r } func hashes() { filepath.WalkDir(".", func(path string, d fs.DirEntry, err error) error { if err != nil { panic(err) } base := filepath.Base(path) if d.IsDir() || !strings.HasSuffix(base, ".zip") { return nil } r, err := zip.OpenReader(path) if err != nil { panic(err) } defer r.Close() fmt.Printf("// %s\n", path) for _, f := range r.File { // fmt.Printf("Contents of %s:\n", f.Name) r, err := f.Open() if err != nil { panic(err) } h := sha256.New() _, err = io.Copy(h, r) r.Close() if err != nil { panic(err) } fmt.Printf("%q: \"%0x\",\n", f.Name, h.Sum(nil)) } return nil }) fmt.Printf("// other\n") fmt.Printf("%q: \"%0x\",\n", "tcl_library.zip", sha256.Sum256([]byte(tcllib.Zip))) fmt.Printf("%q: \"%0x\",\n", "tk_library.zip", sha256.Sum256([]byte(tklib.Zip))) }