api_doc_builder.odin 1.8 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970
  1. package karl2d_api_doc_builder
  2. import os "core:os/os2"
  3. import os1 "core:os"
  4. import vmem "core:mem/virtual"
  5. import "core:log"
  6. import "core:fmt"
  7. import "core:odin/parser"
  8. import "core:odin/ast"
  9. import "core:strings"
  10. import "core:slice"
  11. import "core:hash"
  12. main :: proc() {
  13. arena: vmem.Arena
  14. context.allocator = vmem.arena_allocator(&arena)
  15. context.temp_allocator = context.allocator
  16. context.logger = log.create_console_logger()
  17. plug_ast, plug_ast_ok := parser.parse_package_from_path(".")
  18. log.ensuref(plug_ast_ok, "Could not generate AST for package")
  19. b := strings.builder_make()
  20. strings.write_string(&b, "// This file is purely documentational and never built.\n")
  21. strings.write_string(&b, "#+ignore\n")
  22. strings.write_string(&b, "package karl2d\n\n")
  23. for n, &f in plug_ast.files {
  24. if !strings.ends_with(n, "karl2d.odin") {
  25. continue
  26. }
  27. decl_loop: for &d in f.decls {
  28. #partial switch &dd in d.derived {
  29. case ^ast.Value_Decl:
  30. val: string
  31. for v, vi in dd.values {
  32. #partial switch vd in v.derived {
  33. case ^ast.Proc_Lit:
  34. name := f.src[dd.names[vi].pos.offset:dd.names[vi].end.offset]
  35. type := f.src[vd.type.pos.offset:vd.type.end.offset]
  36. docs := dd.docs == nil ? "" : f.src[dd.docs.pos.offset:dd.docs.end.offset]
  37. val = fmt.tprintf("%v :: %v", name, type)
  38. }
  39. }
  40. if val == "" {
  41. val = f.src[dd.pos.offset:dd.end.offset]
  42. }
  43. if val == "API_END :: true" {
  44. break decl_loop
  45. }
  46. if dd.docs != nil {
  47. strings.write_string(&b, f.src[dd.docs.pos.offset:dd.docs.end.offset])
  48. strings.write_rune(&b, '\n')
  49. }
  50. strings.write_string(&b, val)
  51. strings.write_rune(&b, '\n')
  52. strings.write_rune(&b, '\n')
  53. }
  54. }
  55. }
  56. _ = os.write_entire_file("karl2d.doc.odin", transmute([]u8)(strings.to_string(b)))
  57. }