go_code.py 37 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001
  1. #!./kitty/launcher/kitty +launch
  2. # License: GPLv3 Copyright: 2022, Kovid Goyal <kovid at kovidgoyal.net>
  3. import argparse
  4. import bz2
  5. import io
  6. import json
  7. import os
  8. import re
  9. import shlex
  10. import struct
  11. import subprocess
  12. import sys
  13. import tarfile
  14. from collections.abc import Iterator, Sequence
  15. from contextlib import contextmanager, suppress
  16. from functools import lru_cache
  17. from itertools import chain
  18. from typing import (
  19. Any,
  20. BinaryIO,
  21. NamedTuple,
  22. Optional,
  23. TextIO,
  24. Union,
  25. )
  26. import kitty.constants as kc
  27. from kittens.tui.operations import Mode
  28. from kittens.tui.spinners import spinners
  29. from kitty.actions import get_all_actions
  30. from kitty.cli import (
  31. CompletionSpec,
  32. GoOption,
  33. go_options_for_seq,
  34. parse_option_spec,
  35. serialize_as_go_string,
  36. )
  37. from kitty.conf.generate import gen_go_code
  38. from kitty.conf.types import Definition
  39. from kitty.config import commented_out_default_config
  40. from kitty.guess_mime_type import known_extensions, text_mimes
  41. from kitty.key_encoding import config_mod_map
  42. from kitty.key_names import character_key_name_aliases, functional_key_name_aliases
  43. from kitty.options.types import Options
  44. from kitty.rc.base import RemoteCommand, all_command_names, command_for_name
  45. from kitty.remote_control import global_options_spec
  46. from kitty.rgb import color_names
  47. if __name__ == '__main__' and not __package__:
  48. import __main__
  49. __main__.__package__ = 'gen'
  50. sys.path.insert(0, os.path.dirname(os.path.dirname(os.path.abspath(__file__))))
  51. changed: list[str] = []
  52. def newer(dest: str, *sources: str) -> bool:
  53. try:
  54. dtime = os.path.getmtime(dest)
  55. except OSError:
  56. return True
  57. for s in chain(sources, (__file__,)):
  58. with suppress(FileNotFoundError):
  59. if os.path.getmtime(s) >= dtime:
  60. return True
  61. return False
  62. # Utils {{{
  63. def serialize_go_dict(x: Union[dict[str, int], dict[int, str], dict[int, int], dict[str, str]]) -> str:
  64. ans = []
  65. def s(x: Union[int, str]) -> str:
  66. if isinstance(x, int):
  67. return str(x)
  68. return f'"{serialize_as_go_string(x)}"'
  69. for k, v in x.items():
  70. ans.append(f'{s(k)}: {s(v)}')
  71. return '{' + ', '.join(ans) + '}'
  72. def replace(template: str, **kw: str) -> str:
  73. for k, v in kw.items():
  74. template = template.replace(k, v)
  75. return template
  76. # }}}
  77. # {{{ Stringer
  78. @lru_cache(maxsize=1)
  79. def enum_parser() -> argparse.ArgumentParser:
  80. p = argparse.ArgumentParser()
  81. p.add_argument('--from-string-func-name')
  82. return p
  83. def stringify_file(path: str) -> None:
  84. with open(path) as f:
  85. src = f.read()
  86. types = {}
  87. constant_name_maps = {}
  88. for m in re.finditer(r'^type +(\S+) +\S+ +// *enum *(.*?)$', src, re.MULTILINE):
  89. args = m.group(2)
  90. types[m.group(1)] = enum_parser().parse_args(args=shlex.split(args) if args else [])
  91. def get_enum_def(src: str) -> None:
  92. type_name = q = ''
  93. constants = {}
  94. for line in src.splitlines():
  95. line = line.strip()
  96. if not line:
  97. continue
  98. parts = line.split()
  99. if not type_name:
  100. if len(parts) < 2 or parts[1] not in types:
  101. return
  102. type_name = parts[1]
  103. q = type_name + '_'
  104. constant_name = parts[0]
  105. a, sep, b = line.partition('//')
  106. if sep:
  107. string_val = b.strip()
  108. else:
  109. string_val = constant_name
  110. if constant_name.startswith(q):
  111. string_val = constant_name[len(q):]
  112. constants[constant_name] = serialize_as_go_string(string_val)
  113. if constants and type_name:
  114. constant_name_maps[type_name] = constants
  115. for m in re.finditer(r'^const +\((.+?)^\)', src, re.MULTILINE|re.DOTALL):
  116. get_enum_def(m.group(1))
  117. with replace_if_needed(path.replace('.go', '_stringer_generated.go')):
  118. print('package', os.path.basename(os.path.dirname(path)))
  119. print ('import "fmt"')
  120. print ('import "encoding/json"')
  121. print()
  122. for type_name, constant_map in constant_name_maps.items():
  123. print(f'func (self {type_name}) String() string ''{')
  124. print('switch self {')
  125. is_first = True
  126. for constant_name, string_val in constant_map.items():
  127. if is_first:
  128. print(f'default: return "{string_val}"')
  129. is_first = False
  130. else:
  131. print(f'case {constant_name}: return "{string_val}"')
  132. print('}}')
  133. print(f'func (self {type_name}) MarshalJSON() ([]byte, error) {{ return json.Marshal(self.String()) }}')
  134. fsname = types[type_name].from_string_func_name or (type_name + '_from_string')
  135. print(f'func {fsname}(x string) (ans {type_name}, err error) ''{')
  136. print('switch x {')
  137. for constant_name, string_val in constant_map.items():
  138. print(f'case "{string_val}": return {constant_name}, nil')
  139. print('}')
  140. print(f'err = fmt.Errorf("unknown value for enum {type_name}: %#v", x)')
  141. print('return')
  142. print('}')
  143. print(f'func (self *{type_name}) SetString(x string) error ''{')
  144. print(f's, err := {fsname}(x); if err == nil {{ *self = s }}; return err''}')
  145. print(f'func (self *{type_name}) UnmarshalJSON(data []byte) (err error)''{')
  146. print('var x string')
  147. print('if err = json.Unmarshal(data, &x); err != nil {return err}')
  148. print('return self.SetString(x)}')
  149. def stringify() -> None:
  150. for path in (
  151. 'tools/tui/graphics/command.go',
  152. 'tools/rsync/algorithm.go',
  153. 'kittens/transfer/ftc.go',
  154. ):
  155. stringify_file(path)
  156. # }}}
  157. # {{{ Bitfields
  158. class BitField(NamedTuple):
  159. name: str
  160. bits: int
  161. def typename_for_bitsize(bits: int) -> str:
  162. if bits <= 8:
  163. return 'uint8'
  164. if bits <= 16:
  165. return 'uint16'
  166. if bits <= 32:
  167. return 'uint32'
  168. return 'uint64'
  169. def make_bitfield(dest: str, typename: str, *fields_: str) -> None:
  170. output_path = os.path.join(dest, f'{typename.lower()}_generated.go')
  171. ans = [f'package {os.path.basename(dest)}', '']
  172. a = ans.append
  173. def fieldify(spec: str) -> BitField:
  174. name, num = spec.partition(' ')[::2]
  175. return BitField(name, int(num))
  176. fields = tuple(map(fieldify, fields_))
  177. total_size = sum(x.bits for x in fields)
  178. if total_size > 64:
  179. raise ValueError(f'Total size of bit fields: {total_size} for {typename} is larger than 64 bits')
  180. a(f'// Total number of bits used: {total_size}')
  181. itype = typename_for_bitsize(total_size)
  182. a(f'type {typename} {itype}')
  183. a('')
  184. shift = 0
  185. for bf in reversed(fields):
  186. tn = typename_for_bitsize(bf.bits)
  187. mask = '0b' + '1' * bf.bits
  188. a(f'func (s {typename}) {bf.name.capitalize()}() {tn} {{') # }}
  189. if shift:
  190. a(f' return {tn}((s >> {shift}) & {mask})')
  191. else:
  192. a(f' return {tn}(s & {mask})')
  193. a('}')
  194. a('')
  195. a(f'func (s *{typename}) Set{bf.name.capitalize()}(val {tn}) {{') # }}
  196. if shift:
  197. a(f' *s &^= {mask} << {shift}')
  198. a(f' *s |= {typename}(val&{mask}) << {shift}')
  199. else:
  200. a(f' *s &^= {mask}')
  201. a(f' *s |= {typename}(val & {mask})')
  202. a('}')
  203. a('')
  204. shift += bf.bits
  205. with replace_if_needed(output_path) as buf:
  206. print('\n'.join(ans), file=buf)
  207. def make_bitfields() -> None:
  208. from kitty.fast_data_types import SCALE_BITS, SUBSCALE_BITS, WIDTH_BITS
  209. make_bitfield(
  210. 'tools/vt', 'CellAttrs',
  211. 'decoration 3', 'bold 1', 'italic 1', 'reverse 1', 'strike 1', 'dim 1', 'hyperlink_id 16',
  212. )
  213. make_bitfield('tools/vt', 'Ch', 'is_idx 1', 'ch_or_idx 31')
  214. make_bitfield(
  215. 'tools/vt', 'MultiCell',
  216. 'is_multicell 1', 'natural_width 1', f'scale {SCALE_BITS}', f'subscale_n {SUBSCALE_BITS}', f'subscale_d {SUBSCALE_BITS}',
  217. f'width {WIDTH_BITS}', f'x {WIDTH_BITS + SCALE_BITS + 1}', f'y {SCALE_BITS + 1}', 'vertical_align 3',
  218. )
  219. make_bitfield('tools/vt', 'CellColor', 'is_idx 1', 'red 8', 'green 8', 'blue 8')
  220. make_bitfield('tools/vt', 'LineAttrs', 'prompt_kind 2',)
  221. # }}}
  222. # Completions {{{
  223. @lru_cache
  224. def kitten_cli_docs(kitten: str) -> Any:
  225. from kittens.runner import get_kitten_cli_docs
  226. return get_kitten_cli_docs(kitten)
  227. @lru_cache
  228. def go_options_for_kitten(kitten: str) -> tuple[Sequence[GoOption], Optional[CompletionSpec]]:
  229. kcd = kitten_cli_docs(kitten)
  230. if kcd:
  231. ospec = kcd['options']
  232. return (tuple(go_options_for_seq(parse_option_spec(ospec())[0])), kcd.get('args_completion'))
  233. return (), None
  234. def generate_kittens_completion() -> None:
  235. from kittens.runner import all_kitten_names, get_kitten_wrapper_of
  236. for kitten in sorted(all_kitten_names()):
  237. kn = 'kitten_' + kitten
  238. print(f'{kn} := plus_kitten.AddSubCommand(&cli.Command{{Name:"{kitten}", Group: "Kittens"}})')
  239. wof = get_kitten_wrapper_of(kitten)
  240. if wof:
  241. print(f'{kn}.ArgCompleter = cli.CompletionForWrapper("{serialize_as_go_string(wof)}")')
  242. print(f'{kn}.OnlyArgsAllowed = true')
  243. continue
  244. gopts, ac = go_options_for_kitten(kitten)
  245. if gopts or ac:
  246. for opt in gopts:
  247. print(opt.as_option(kn))
  248. if ac is not None:
  249. print(''.join(ac.as_go_code(kn + '.ArgCompleter', ' = ')))
  250. else:
  251. print(f'{kn}.HelpText = ""')
  252. @lru_cache
  253. def clone_safe_launch_opts() -> Sequence[GoOption]:
  254. from kitty.launch import clone_safe_opts, options_spec
  255. ans = []
  256. allowed = clone_safe_opts()
  257. for o in go_options_for_seq(parse_option_spec(options_spec())[0]):
  258. if o.obj_dict['name'] in allowed:
  259. ans.append(o)
  260. return tuple(ans)
  261. def completion_for_launch_wrappers(*names: str) -> None:
  262. for o in clone_safe_launch_opts():
  263. for name in names:
  264. print(o.as_option(name))
  265. def generate_completions_for_kitty() -> None:
  266. print('package completion\n')
  267. print('import "kitty/tools/cli"')
  268. print('import "kitty/tools/cmd/tool"')
  269. print('import "kitty/tools/cmd/at"')
  270. print('func kitty(root *cli.Command) {')
  271. # The kitty exe
  272. print('k := root.AddSubCommand(&cli.Command{'
  273. 'Name:"kitty", SubCommandIsOptional: true, ArgCompleter: cli.CompleteExecutableFirstArg, SubCommandMustBeFirst: true })')
  274. print('kt := root.AddSubCommand(&cli.Command{Name:"kitten", SubCommandMustBeFirst: true })')
  275. print('tool.KittyToolEntryPoints(kt)')
  276. for opt in go_options_for_seq(parse_option_spec()[0]):
  277. print(opt.as_option('k'))
  278. # kitty +
  279. print('plus := k.AddSubCommand(&cli.Command{Name:"+", Group:"Entry points", ShortDescription: "Various special purpose tools and kittens"})')
  280. # kitty +launch
  281. print('plus_launch := plus.AddSubCommand(&cli.Command{'
  282. 'Name:"launch", Group:"Entry points", ShortDescription: "Launch Python scripts", ArgCompleter: complete_plus_launch})')
  283. print('k.AddClone("", plus_launch).Name = "+launch"')
  284. # kitty +list-fonts
  285. print('plus_list_fonts := plus.AddSubCommand(&cli.Command{'
  286. 'Name:"list-fonts", Group:"Entry points", ShortDescription: "List all available monospaced fonts"})')
  287. print('k.AddClone("", plus_list_fonts).Name = "+list-fonts"')
  288. # kitty +runpy
  289. print('plus_runpy := plus.AddSubCommand(&cli.Command{'
  290. 'Name: "runpy", Group:"Entry points", ArgCompleter: complete_plus_runpy, ShortDescription: "Run Python code"})')
  291. print('k.AddClone("", plus_runpy).Name = "+runpy"')
  292. # kitty +open
  293. print('plus_open := plus.AddSubCommand(&cli.Command{'
  294. 'Name:"open", Group:"Entry points", ArgCompleter: complete_plus_open, ShortDescription: "Open files and URLs"})')
  295. print('for _, og := range k.OptionGroups { plus_open.OptionGroups = append(plus_open.OptionGroups, og.Clone(plus_open)) }')
  296. print('k.AddClone("", plus_open).Name = "+open"')
  297. # kitty +kitten
  298. print('plus_kitten := plus.AddSubCommand(&cli.Command{Name:"kitten", Group:"Kittens", SubCommandMustBeFirst: true})')
  299. generate_kittens_completion()
  300. print('k.AddClone("", plus_kitten).Name = "+kitten"')
  301. # @
  302. print('at.EntryPoint(k)')
  303. # clone-in-kitty, edit-in-kitty
  304. print('cik := root.AddSubCommand(&cli.Command{Name:"clone-in-kitty"})')
  305. completion_for_launch_wrappers('cik')
  306. print('}')
  307. print('func init() {')
  308. print('cli.RegisterExeForCompletion(kitty)')
  309. print('}')
  310. # }}}
  311. # rc command wrappers {{{
  312. json_field_types: dict[str, str] = {
  313. 'bool': 'bool', 'str': 'escaped_string', 'list.str': '[]escaped_string', 'dict.str': 'map[escaped_string]escaped_string', 'float': 'float64', 'int': 'int',
  314. 'scroll_amount': 'any', 'spacing': 'any', 'colors': 'any',
  315. }
  316. def go_field_type(json_field_type: str) -> str:
  317. json_field_type = json_field_type.partition('=')[0]
  318. q = json_field_types.get(json_field_type)
  319. if q:
  320. return q
  321. if json_field_type.startswith('choices.'):
  322. return 'string'
  323. if '.' in json_field_type:
  324. p, r = json_field_type.split('.', 1)
  325. p = {'list': '[]', 'dict': 'map[string]'}[p]
  326. return p + go_field_type(r)
  327. raise TypeError(f'Unknown JSON field type: {json_field_type}')
  328. class JSONField:
  329. def __init__(self, line: str, field_to_option_map: dict[str, str], option_map: dict[str, GoOption]) -> None:
  330. field_def = line.split(':', 1)[0]
  331. self.required = False
  332. self.field, self.field_type = field_def.split('/', 1)
  333. self.go_option_name = field_to_option_map.get(self.field, self.field)
  334. self.go_option_name = ''.join(x.capitalize() for x in self.go_option_name.split('_'))
  335. self.omitempty = True
  336. if fo := option_map.get(self.go_option_name):
  337. if fo.type in ('int', 'float') and float(fo.default or 0) != 0:
  338. self.omitempty = False
  339. self.field_type, self.special_parser = self.field_type.partition('=')[::2]
  340. if self.field.endswith('+'):
  341. self.required = True
  342. self.field = self.field[:-1]
  343. self.struct_field_name = self.field[0].upper() + self.field[1:]
  344. def go_declaration(self) -> str:
  345. omitempty = ',omitempty' if self.omitempty else ''
  346. return self.struct_field_name + ' ' + go_field_type(self.field_type) + f'`json:"{self.field}{omitempty}"`'
  347. def go_code_for_remote_command(name: str, cmd: RemoteCommand, template: str) -> str:
  348. template = '\n' + template[len('//go:build exclude'):]
  349. af: list[str] = []
  350. a = af.append
  351. af.extend(cmd.args.as_go_completion_code('ans'))
  352. od: list[str] = []
  353. option_map: dict[str, GoOption] = {}
  354. for o in rc_command_options(name):
  355. option_map[o.go_var_name] = o
  356. a(o.as_option('ans'))
  357. if o.go_var_name in ('NoResponse', 'ResponseTimeout'):
  358. continue
  359. od.append(o.struct_declaration())
  360. jd: list[str] = []
  361. json_fields = []
  362. field_types: dict[str, str] = {}
  363. for line in cmd.protocol_spec.splitlines():
  364. line = line.strip()
  365. if ':' not in line:
  366. continue
  367. f = JSONField(line, cmd.field_to_option_map or {}, option_map)
  368. json_fields.append(f)
  369. field_types[f.field] = f.field_type
  370. jd.append(f.go_declaration())
  371. jc: list[str] = []
  372. handled_fields: set[str] = set()
  373. jc.extend(cmd.args.as_go_code(name, field_types, handled_fields))
  374. unhandled = {}
  375. used_options = set()
  376. for field in json_fields:
  377. if field.go_option_name in option_map:
  378. o = option_map[field.go_option_name]
  379. used_options.add(field.go_option_name)
  380. optstring = f'options_{name}.{o.go_var_name}'
  381. if field.special_parser:
  382. optstring = f'{field.special_parser}({optstring})'
  383. if field.field_type == 'str':
  384. jc.append(f'payload.{field.struct_field_name} = escaped_string({optstring})')
  385. elif field.field_type == 'list.str':
  386. jc.append(f'payload.{field.struct_field_name} = escape_list_of_strings({optstring})')
  387. elif field.field_type == 'dict.str':
  388. jc.append(f'payload.{field.struct_field_name} = escape_dict_of_strings({optstring})')
  389. else:
  390. jc.append(f'payload.{field.struct_field_name} = {optstring}')
  391. elif field.field in handled_fields:
  392. pass
  393. else:
  394. unhandled[field.field] = field
  395. for x in tuple(unhandled):
  396. if x == 'match_window' and 'Match' in option_map and 'Match' not in used_options:
  397. used_options.add('Match')
  398. o = option_map['Match']
  399. field = unhandled[x]
  400. if field.field_type == 'str':
  401. jc.append(f'payload.{field.struct_field_name} = escaped_string(options_{name}.{o.go_var_name})')
  402. else:
  403. jc.append(f'payload.{field.struct_field_name} = options_{name}.{o.go_var_name}')
  404. del unhandled[x]
  405. if unhandled:
  406. raise SystemExit(f'Cant map fields: {", ".join(unhandled)} for cmd: {name}')
  407. if name != 'send_text':
  408. unused_options = set(option_map) - used_options - {'NoResponse', 'ResponseTimeout'}
  409. if unused_options:
  410. raise SystemExit(f'Unused options: {", ".join(unused_options)} for command: {name}')
  411. argspec = cmd.args.spec
  412. if argspec:
  413. argspec = ' ' + argspec
  414. NO_RESPONSE = 'true' if cmd.disallow_responses else 'false'
  415. ans = replace(
  416. template,
  417. CMD_NAME=name, __FILE__=__file__, CLI_NAME=name.replace('_', '-'),
  418. SHORT_DESC=serialize_as_go_string(cmd.short_desc),
  419. LONG_DESC=serialize_as_go_string(cmd.desc.strip()),
  420. IS_ASYNC='true' if cmd.is_asynchronous else 'false',
  421. NO_RESPONSE_BASE=NO_RESPONSE, ADD_FLAGS_CODE='\n'.join(af),
  422. WAIT_TIMEOUT=str(cmd.response_timeout),
  423. OPTIONS_DECLARATION_CODE='\n'.join(od),
  424. JSON_DECLARATION_CODE='\n'.join(jd),
  425. JSON_INIT_CODE='\n'.join(jc), ARGSPEC=argspec,
  426. STRING_RESPONSE_IS_ERROR='true' if cmd.string_return_is_error else 'false',
  427. STREAM_WANTED='true' if cmd.reads_streaming_data else 'false',
  428. )
  429. return ans
  430. # }}}
  431. # kittens {{{
  432. @lru_cache
  433. def wrapped_kittens() -> tuple[str, ...]:
  434. with open('shell-integration/ssh/kitty') as f:
  435. for line in f:
  436. if line.startswith(' wrapped_kittens="'):
  437. val = line.strip().partition('"')[2][:-1]
  438. return tuple(sorted(filter(None, val.split())))
  439. raise Exception('Failed to read wrapped kittens from kitty wrapper script')
  440. def generate_conf_parser(kitten: str, defn: Definition) -> None:
  441. with replace_if_needed(f'kittens/{kitten}/conf_generated.go'):
  442. print(f'package {kitten}')
  443. print(gen_go_code(defn))
  444. def generate_extra_cli_parser(name: str, spec: str) -> None:
  445. print('import "kitty/tools/cli"')
  446. go_opts = tuple(go_options_for_seq(parse_option_spec(spec)[0]))
  447. print(f'type {name}_options struct ''{')
  448. for opt in go_opts:
  449. print(opt.struct_declaration())
  450. print('}')
  451. print(f'func parse_{name}_args(args []string) (*{name}_options, []string, error) ''{')
  452. print(f'root := cli.Command{{Name: `{name}` }}')
  453. for opt in go_opts:
  454. print(opt.as_option('root'))
  455. print('cmd, err := root.ParseArgs(args)')
  456. print('if err != nil { return nil, nil, err }')
  457. print(f'var opts {name}_options')
  458. print('err = cmd.GetOptionValues(&opts)')
  459. print('if err != nil { return nil, nil, err }')
  460. print('return &opts, cmd.Args, nil')
  461. print('}')
  462. def kittens_needing_cli_parsers() -> Iterator[str]:
  463. for d in os.scandir('kittens'):
  464. if not d.is_dir(follow_symlinks=False):
  465. continue
  466. if os.path.exists(os.path.join(d.path, 'main.py')) and os.path.exists(os.path.join(d.path, 'main.go')):
  467. with open(os.path.join(d.path, 'main.py')) as f:
  468. raw = f.read()
  469. if 'options' in raw:
  470. yield d.name
  471. def kitten_clis() -> None:
  472. from kittens.runner import get_kitten_conf_docs, get_kitten_extra_cli_parsers
  473. for kitten in kittens_needing_cli_parsers():
  474. defn = get_kitten_conf_docs(kitten)
  475. if defn is not None:
  476. generate_conf_parser(kitten, defn)
  477. ecp = get_kitten_extra_cli_parsers(kitten)
  478. if ecp:
  479. for name, spec in ecp.items():
  480. with replace_if_needed(f'kittens/{kitten}/{name}_cli_generated.go'):
  481. print(f'package {kitten}')
  482. generate_extra_cli_parser(name, spec)
  483. with replace_if_needed(f'kittens/{kitten}/cli_generated.go'):
  484. od = []
  485. kcd = kitten_cli_docs(kitten)
  486. has_underscore = '_' in kitten
  487. print(f'package {kitten}')
  488. print('import "kitty/tools/cli"')
  489. print('func create_cmd(root *cli.Command, run_func func(*cli.Command, *Options, []string)(int, error)) {')
  490. print('ans := root.AddSubCommand(&cli.Command{')
  491. print(f'Name: "{kitten}",')
  492. if kcd:
  493. print(f'ShortDescription: "{serialize_as_go_string(kcd["short_desc"])}",')
  494. if kcd['usage']:
  495. print(f'Usage: "[options] {serialize_as_go_string(kcd["usage"])}",')
  496. print(f'HelpText: "{serialize_as_go_string(kcd["help_text"])}",')
  497. print('Run: func(cmd *cli.Command, args []string) (int, error) {')
  498. print('opts := Options{}')
  499. print('err := cmd.GetOptionValues(&opts)')
  500. print('if err != nil { return 1, err }')
  501. print('return run_func(cmd, &opts, args)},')
  502. if has_underscore:
  503. print('Hidden: true,')
  504. print('})')
  505. gopts, ac = go_options_for_kitten(kitten)
  506. for opt in gopts:
  507. print(opt.as_option('ans'))
  508. od.append(opt.struct_declaration())
  509. if ac is not None:
  510. print(''.join(ac.as_go_code('ans.ArgCompleter', ' = ')))
  511. if not kcd:
  512. print('specialize_command(ans)')
  513. if has_underscore:
  514. print("clone := root.AddClone(ans.Group, ans)")
  515. print('clone.Hidden = false')
  516. print(f'clone.Name = "{serialize_as_go_string(kitten.replace("_", "-"))}"')
  517. print('}')
  518. print('type Options struct {')
  519. print('\n'.join(od))
  520. print('}')
  521. # }}}
  522. # Constants {{{
  523. def generate_spinners() -> str:
  524. ans = ['package tui', 'import "time"', 'func NewSpinner(name string) *Spinner {', 'var ans *Spinner', 'switch name {']
  525. a = ans.append
  526. for name, spinner in spinners.items():
  527. a(f'case "{serialize_as_go_string(name)}":')
  528. a('ans = &Spinner{')
  529. a(f'Name: "{serialize_as_go_string(name)}",')
  530. a(f'interval: {spinner["interval"]},')
  531. frames = ', '.join(f'"{serialize_as_go_string(x)}"' for x in spinner['frames'])
  532. a(f'frames: []string{{{frames}}},')
  533. a('}')
  534. a('}')
  535. a('if ans != nil {')
  536. a('ans.interval *= time.Millisecond')
  537. a('ans.current_frame = -1')
  538. a('ans.last_change_at = time.Now().Add(-ans.interval)')
  539. a('}')
  540. a('return ans}')
  541. return '\n'.join(ans)
  542. def generate_color_names() -> str:
  543. selfg = "" if Options.selection_foreground is None else Options.selection_foreground.as_sharp
  544. selbg = "" if Options.selection_background is None else Options.selection_background.as_sharp
  545. cursor = "" if Options.cursor is None else Options.cursor.as_sharp
  546. return 'package style\n\nvar ColorNames = map[string]RGBA{' + '\n'.join(
  547. f'\t"{name}": RGBA{{ Red:{val.red}, Green:{val.green}, Blue:{val.blue} }},'
  548. for name, val in color_names.items()
  549. ) + '\n}' + '\n\nvar ColorTable = [256]uint32{' + ', '.join(
  550. f'{x}' for x in Options.color_table) + '}\n' + f'''
  551. var DefaultColors = struct {{
  552. Foreground, Background, Cursor, SelectionFg, SelectionBg string
  553. }}{{
  554. Foreground: "{Options.foreground.as_sharp}",
  555. Background: "{Options.background.as_sharp}",
  556. Cursor: "{cursor}",
  557. SelectionFg: "{selfg}",
  558. SelectionBg: "{selbg}",
  559. }}
  560. '''
  561. def load_ref_map() -> dict[str, dict[str, str]]:
  562. with open('kitty/docs_ref_map_generated.h') as f:
  563. raw = f.read()
  564. raw = raw.split('{', 1)[1].split('}', 1)[0]
  565. data = json.loads(bytes(bytearray(json.loads(f'[{raw}]'))))
  566. return data # type: ignore
  567. def generate_constants() -> str:
  568. from kittens.hints.main import DEFAULT_REGEX
  569. from kittens.query_terminal.main import all_queries
  570. from kitty.colors import ThemeFile
  571. from kitty.config import option_names_for_completion
  572. from kitty.fast_data_types import FILE_TRANSFER_CODE
  573. from kitty.options.utils import allowed_shell_integration_values, url_style_map
  574. del sys.modules['kittens.hints.main']
  575. del sys.modules['kittens.query_terminal.main']
  576. ref_map = load_ref_map()
  577. with open('kitty/data-types.h') as dt:
  578. m = re.search(r'^#define IMAGE_PLACEHOLDER_CHAR (\S+)', dt.read(), flags=re.M)
  579. assert m is not None
  580. placeholder_char = int(m.group(1), 16)
  581. dp = ", ".join(map(lambda x: f'"{serialize_as_go_string(x)}"', kc.default_pager_for_help))
  582. url_prefixes = ','.join(f'"{x}"' for x in Options.url_prefixes)
  583. option_names = '`' + '\n'.join(option_names_for_completion()) + '`'
  584. url_style = {v:k for k, v in url_style_map.items()}[Options.url_style]
  585. query_names = ', '.join(f'"{name}"' for name in all_queries)
  586. return f'''\
  587. package kitty
  588. type VersionType struct {{
  589. Major, Minor, Patch int
  590. }}
  591. const VersionString string = "{kc.str_version}"
  592. const WebsiteBaseURL string = "{kc.website_base_url}"
  593. const FileTransferCode int = {FILE_TRANSFER_CODE}
  594. const ImagePlaceholderChar rune = {placeholder_char}
  595. const SSHControlMasterTemplate = "{kc.ssh_control_master_template}"
  596. const RC_ENCRYPTION_PROTOCOL_VERSION string = "{kc.RC_ENCRYPTION_PROTOCOL_VERSION}"
  597. var VCSRevision string = ""
  598. var IsFrozenBuild string = ""
  599. var IsStandaloneBuild string = ""
  600. const HandleTermiosSignals = {Mode.HANDLE_TERMIOS_SIGNALS.value[0]}
  601. const HintsDefaultRegex = `{DEFAULT_REGEX}`
  602. const DefaultTermName = `{Options.term}`
  603. const DefaultUrlStyle = `{url_style}`
  604. const DefaultUrlColor = `{Options.url_color.as_sharp}`
  605. var Version VersionType = VersionType{{Major: {kc.version.major}, Minor: {kc.version.minor}, Patch: {kc.version.patch},}}
  606. var DefaultPager []string = []string{{ {dp} }}
  607. var FunctionalKeyNameAliases = map[string]string{serialize_go_dict(functional_key_name_aliases)}
  608. var CharacterKeyNameAliases = map[string]string{serialize_go_dict(character_key_name_aliases)}
  609. var ConfigModMap = map[string]uint16{serialize_go_dict(config_mod_map)}
  610. var RefMap = map[string]string{serialize_go_dict(ref_map['ref'])}
  611. var DocTitleMap = map[string]string{serialize_go_dict(ref_map['doc'])}
  612. var AllowedShellIntegrationValues = []string{{ {str(sorted(allowed_shell_integration_values))[1:-1].replace("'", '"')} }}
  613. var QueryNames = []string{{ {query_names} }}
  614. var CommentedOutDefaultConfig = "{serialize_as_go_string(commented_out_default_config())}"
  615. var KittyConfigDefaults = struct {{
  616. Term, Shell_integration, Select_by_word_characters, Url_excluded_characters, Shell string
  617. Wheel_scroll_multiplier int
  618. Url_prefixes []string
  619. }}{{
  620. Term: "{Options.term}", Shell_integration: "{' '.join(Options.shell_integration)}", Url_prefixes: []string{{ {url_prefixes} }},
  621. Select_by_word_characters: `{Options.select_by_word_characters}`, Wheel_scroll_multiplier: {Options.wheel_scroll_multiplier},
  622. Shell: "{Options.shell}", Url_excluded_characters: "{Options.url_excluded_characters}",
  623. }}
  624. const OptionNames = {option_names}
  625. const DarkThemeFileName = "{ThemeFile.dark.value}"
  626. const LightThemeFileName = "{ThemeFile.light.value}"
  627. const NoPreferenceThemeFileName = "{ThemeFile.no_preference.value}"
  628. ''' # }}}
  629. # Boilerplate {{{
  630. @contextmanager
  631. def replace_if_needed(path: str, show_diff: bool = False) -> Iterator[io.StringIO]:
  632. buf = io.StringIO()
  633. origb = sys.stdout
  634. sys.stdout = buf
  635. try:
  636. yield buf
  637. finally:
  638. sys.stdout = origb
  639. orig = ''
  640. with suppress(FileNotFoundError), open(path) as f:
  641. orig = f.read()
  642. new = buf.getvalue()
  643. new = f'// Code generated by {os.path.basename(__file__)}; DO NOT EDIT.\n\n' + new
  644. if orig != new:
  645. changed.append(path)
  646. if show_diff:
  647. with open(path + '.new', 'w') as f:
  648. f.write(new)
  649. subprocess.run(['diff', '-Naurp', path, f.name], stdout=open('/dev/tty', 'w'))
  650. os.remove(f.name)
  651. with open(path, 'w') as f:
  652. f.write(new)
  653. @lru_cache(maxsize=256)
  654. def rc_command_options(name: str) -> tuple[GoOption, ...]:
  655. cmd = command_for_name(name)
  656. return tuple(go_options_for_seq(parse_option_spec(cmd.options_spec or '\n\n')[0]))
  657. def update_at_commands() -> None:
  658. with open('tools/cmd/at/template.go') as f:
  659. template = f.read()
  660. for name in all_command_names():
  661. cmd = command_for_name(name)
  662. code = go_code_for_remote_command(name, cmd, template)
  663. dest = f'tools/cmd/at/cmd_{name}_generated.go'
  664. with replace_if_needed(dest) as f:
  665. f.write(code)
  666. struct_def = []
  667. opt_def = []
  668. for o in go_options_for_seq(parse_option_spec(global_options_spec())[0]):
  669. struct_def.append(o.struct_declaration())
  670. opt_def.append(o.as_option(depth=1, group="Global options"))
  671. sdef = '\n'.join(struct_def)
  672. odef = '\n'.join(opt_def)
  673. code = f'''
  674. package at
  675. import "kitty/tools/cli"
  676. type rc_global_options struct {{
  677. {sdef}
  678. }}
  679. var rc_global_opts rc_global_options
  680. func add_rc_global_opts(cmd *cli.Command) {{
  681. {odef}
  682. }}
  683. '''
  684. with replace_if_needed('tools/cmd/at/global_opts_generated.go') as f:
  685. f.write(code)
  686. def update_completion() -> None:
  687. with replace_if_needed('tools/cmd/completion/kitty_generated.go'):
  688. generate_completions_for_kitty()
  689. with replace_if_needed('tools/cmd/at/kitty_actions_generated.go'):
  690. print("package at")
  691. print("const KittyActionNames = `", end='')
  692. for grp, actions in get_all_actions().items():
  693. for ac in actions:
  694. print(ac.name)
  695. print('`')
  696. with replace_if_needed('tools/cmd/edit_in_kitty/launch_generated.go'):
  697. print('package edit_in_kitty')
  698. print('import "kitty/tools/cli"')
  699. print('func AddCloneSafeOpts(cmd *cli.Command) {')
  700. completion_for_launch_wrappers('cmd')
  701. print(''.join(CompletionSpec.from_string('type:file mime:text/* group:"Text files"').as_go_code('cmd.ArgCompleter', ' = ')))
  702. print('}')
  703. def define_enum(package_name: str, type_name: str, items: str, underlying_type: str = 'uint') -> str:
  704. actions = []
  705. for x in items.splitlines():
  706. x = x.strip()
  707. if x:
  708. actions.append(x)
  709. ans = [f'package {package_name}', 'import "strconv"', f'type {type_name} {underlying_type}', 'const (']
  710. stringer = [f'func (ac {type_name}) String() string ''{', 'switch(ac) {']
  711. for i, ac in enumerate(actions):
  712. stringer.append(f'case {ac}: return "{ac}"')
  713. if i == 0:
  714. ac = ac + f' {type_name} = iota'
  715. ans.append(ac)
  716. ans.append(')')
  717. stringer.append('}\nreturn strconv.Itoa(int(ac)) }')
  718. return '\n'.join(ans + stringer)
  719. def generate_readline_actions() -> str:
  720. return define_enum('readline', 'Action', '''\
  721. ActionNil
  722. ActionBackspace
  723. ActionDelete
  724. ActionMoveToStartOfLine
  725. ActionMoveToEndOfLine
  726. ActionMoveToStartOfDocument
  727. ActionMoveToEndOfDocument
  728. ActionMoveToEndOfWord
  729. ActionMoveToStartOfWord
  730. ActionCursorLeft
  731. ActionCursorRight
  732. ActionEndInput
  733. ActionAcceptInput
  734. ActionCursorUp
  735. ActionHistoryPreviousOrCursorUp
  736. ActionCursorDown
  737. ActionHistoryNextOrCursorDown
  738. ActionHistoryNext
  739. ActionHistoryPrevious
  740. ActionHistoryFirst
  741. ActionHistoryLast
  742. ActionHistoryIncrementalSearchBackwards
  743. ActionHistoryIncrementalSearchForwards
  744. ActionTerminateHistorySearchAndApply
  745. ActionTerminateHistorySearchAndRestore
  746. ActionClearScreen
  747. ActionAddText
  748. ActionAbortCurrentLine
  749. ActionStartKillActions
  750. ActionKillToEndOfLine
  751. ActionKillToStartOfLine
  752. ActionKillNextWord
  753. ActionKillPreviousWord
  754. ActionKillPreviousSpaceDelimitedWord
  755. ActionEndKillActions
  756. ActionYank
  757. ActionPopYank
  758. ActionNumericArgumentDigit0
  759. ActionNumericArgumentDigit1
  760. ActionNumericArgumentDigit2
  761. ActionNumericArgumentDigit3
  762. ActionNumericArgumentDigit4
  763. ActionNumericArgumentDigit5
  764. ActionNumericArgumentDigit6
  765. ActionNumericArgumentDigit7
  766. ActionNumericArgumentDigit8
  767. ActionNumericArgumentDigit9
  768. ActionNumericArgumentDigitMinus
  769. ActionCompleteForward
  770. ActionCompleteBackward
  771. ''')
  772. def generate_mimetypes() -> str:
  773. import mimetypes
  774. if not mimetypes.inited:
  775. mimetypes.init()
  776. ans = ['package utils', 'import "sync"', 'var only_once sync.Once', 'var builtin_types_map map[string]string',
  777. 'func set_builtins() {', 'builtin_types_map = map[string]string{',]
  778. for k, v in mimetypes.types_map.items():
  779. ans.append(f' "{serialize_as_go_string(k)}": "{serialize_as_go_string(v)}",')
  780. ans.append('}}')
  781. return '\n'.join(ans)
  782. def generate_textual_mimetypes() -> str:
  783. ans = ['package utils', 'var KnownTextualMimes = map[string]bool{',]
  784. for k in text_mimes:
  785. ans.append(f' "{serialize_as_go_string(k)}": true,')
  786. ans.append('}')
  787. ans.append('var KnownExtensions = map[string]string{')
  788. for k, v in known_extensions.items():
  789. ans.append(f' ".{serialize_as_go_string(k)}": "{serialize_as_go_string(v)}",')
  790. ans.append('}')
  791. return '\n'.join(ans)
  792. def write_compressed_data(data: bytes, d: BinaryIO) -> None:
  793. d.write(struct.pack('<I', len(data)))
  794. d.write(bz2.compress(data))
  795. def generate_unicode_names(src: TextIO, dest: BinaryIO) -> None:
  796. num_names, num_of_words = map(int, next(src).split())
  797. gob = io.BytesIO()
  798. gob.write(struct.pack('<II', num_names, num_of_words))
  799. for line in src:
  800. line = line.strip()
  801. if line:
  802. a, aliases = line.partition('\t')[::2]
  803. cp, name = a.partition(' ')[::2]
  804. ename = name.encode()
  805. record = struct.pack('<IH', int(cp), len(ename)) + ename
  806. if aliases:
  807. record += aliases.encode()
  808. gob.write(struct.pack('<H', len(record)) + record)
  809. write_compressed_data(gob.getvalue(), dest)
  810. def generate_ssh_kitten_data() -> None:
  811. files = {
  812. 'terminfo/kitty.terminfo', 'terminfo/x/' + Options.term,
  813. }
  814. for dirpath, dirnames, filenames in os.walk('shell-integration'):
  815. for f in filenames:
  816. path = os.path.join(dirpath, f)
  817. files.add(path.replace(os.sep, '/'))
  818. dest = 'tools/tui/shell_integration/data_generated.bin'
  819. def normalize(t: tarfile.TarInfo) -> tarfile.TarInfo:
  820. t.uid = t.gid = 0
  821. t.uname = t.gname = ''
  822. t.mtime = 0
  823. return t
  824. if newer(dest, *files):
  825. buf = io.BytesIO()
  826. with tarfile.open(fileobj=buf, mode='w') as tf:
  827. for f in sorted(files):
  828. tf.add(f, filter=normalize)
  829. with open(dest, 'wb') as d:
  830. write_compressed_data(buf.getvalue(), d)
  831. def start_simdgen() -> 'subprocess.Popen[bytes]':
  832. return subprocess.Popen(['go', 'run', 'generate.go'], cwd='tools/simdstring', stdout=subprocess.PIPE, stderr=subprocess.PIPE)
  833. def main(args: list[str]=sys.argv) -> None:
  834. simdgen_process = start_simdgen()
  835. with replace_if_needed('constants_generated.go') as f:
  836. f.write(generate_constants())
  837. with replace_if_needed('tools/utils/style/color-names_generated.go') as f:
  838. f.write(generate_color_names())
  839. with replace_if_needed('tools/tui/readline/actions_generated.go') as f:
  840. f.write(generate_readline_actions())
  841. with replace_if_needed('tools/tui/spinners_generated.go') as f:
  842. f.write(generate_spinners())
  843. with replace_if_needed('tools/utils/mimetypes_generated.go') as f:
  844. f.write(generate_mimetypes())
  845. with replace_if_needed('tools/utils/mimetypes_textual_generated.go') as f:
  846. f.write(generate_textual_mimetypes())
  847. if newer('tools/unicode_names/data_generated.bin', 'tools/unicode_names/names.txt'):
  848. with open('tools/unicode_names/data_generated.bin', 'wb') as dest, open('tools/unicode_names/names.txt') as src:
  849. generate_unicode_names(src, dest)
  850. generate_ssh_kitten_data()
  851. update_completion()
  852. update_at_commands()
  853. kitten_clis()
  854. stringify()
  855. make_bitfields()
  856. print(json.dumps(changed, indent=2))
  857. stdout, stderr = simdgen_process.communicate()
  858. if simdgen_process.wait() != 0:
  859. print('Failed to generate SIMD ASM', file=sys.stderr)
  860. sys.stdout.buffer.write(stdout)
  861. sys.stderr.buffer.write(stderr)
  862. raise SystemExit(simdgen_process.returncode)
  863. if __name__ == '__main__':
  864. import runpy
  865. m = runpy.run_path(os.path.dirname(os.path.abspath(__file__)))
  866. m['main']([sys.executable, 'go-code'])
  867. # }}}