@gtkx/codegen 1.0.0-rc.1 → 1.0.0-rc.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (531) hide show
  1. package/dist/analysis/descriptor-render.d.ts +20 -11
  2. package/dist/analysis/descriptor-render.d.ts.map +1 -1
  3. package/dist/analysis/descriptor-render.js +296 -152
  4. package/dist/analysis/descriptor-render.js.map +1 -1
  5. package/dist/analysis/descriptor.d.ts +37 -34
  6. package/dist/analysis/descriptor.d.ts.map +1 -1
  7. package/dist/analysis/descriptor.js +34 -30
  8. package/dist/analysis/descriptor.js.map +1 -1
  9. package/dist/analysis/inheritance.d.ts +16 -16
  10. package/dist/analysis/inheritance.d.ts.map +1 -1
  11. package/dist/analysis/inheritance.js +139 -84
  12. package/dist/analysis/inheritance.js.map +1 -1
  13. package/dist/analysis/param-structure.d.ts +14 -13
  14. package/dist/analysis/param-structure.d.ts.map +1 -1
  15. package/dist/analysis/param-structure.js +104 -53
  16. package/dist/analysis/param-structure.js.map +1 -1
  17. package/dist/analysis/ts-type.d.ts +6 -5
  18. package/dist/analysis/ts-type.d.ts.map +1 -1
  19. package/dist/analysis/ts-type.js +71 -29
  20. package/dist/analysis/ts-type.js.map +1 -1
  21. package/dist/compile.d.ts +5 -5
  22. package/dist/compile.d.ts.map +1 -1
  23. package/dist/compile.js +70 -63
  24. package/dist/compile.js.map +1 -1
  25. package/dist/docs/api-reference.d.ts +12 -11
  26. package/dist/docs/api-reference.d.ts.map +1 -1
  27. package/dist/docs/api-reference.js +192 -123
  28. package/dist/docs/api-reference.js.map +1 -1
  29. package/dist/docs/element-page.d.ts +6 -9
  30. package/dist/docs/element-page.d.ts.map +1 -1
  31. package/dist/docs/element-page.js +69 -133
  32. package/dist/docs/element-page.js.map +1 -1
  33. package/dist/docs/pipeline.d.ts +10 -7
  34. package/dist/docs/pipeline.d.ts.map +1 -1
  35. package/dist/docs/pipeline.js +81 -53
  36. package/dist/docs/pipeline.js.map +1 -1
  37. package/dist/docs/render.d.ts +21 -19
  38. package/dist/docs/render.d.ts.map +1 -1
  39. package/dist/docs/render.js +80 -71
  40. package/dist/docs/render.js.map +1 -1
  41. package/dist/docs/symbol-page.d.ts +6 -6
  42. package/dist/docs/symbol-page.d.ts.map +1 -1
  43. package/dist/docs/symbol-page.js +126 -84
  44. package/dist/docs/symbol-page.js.map +1 -1
  45. package/dist/fingerprint.d.ts +29 -5
  46. package/dist/fingerprint.d.ts.map +1 -1
  47. package/dist/fingerprint.js +69 -13
  48. package/dist/fingerprint.js.map +1 -1
  49. package/dist/gi.d.ts +18 -0
  50. package/dist/gi.d.ts.map +1 -0
  51. package/dist/gi.js +23 -0
  52. package/dist/gi.js.map +1 -0
  53. package/dist/gir/ancestry.d.ts +4 -3
  54. package/dist/gir/ancestry.d.ts.map +1 -1
  55. package/dist/gir/ancestry.js +12 -15
  56. package/dist/gir/ancestry.js.map +1 -1
  57. package/dist/gir/callback.d.ts +6 -11
  58. package/dist/gir/callback.d.ts.map +1 -1
  59. package/dist/gir/callback.js +6 -7
  60. package/dist/gir/callback.js.map +1 -1
  61. package/dist/gir/class.d.ts +7 -5
  62. package/dist/gir/class.d.ts.map +1 -1
  63. package/dist/gir/class.js +14 -12
  64. package/dist/gir/class.js.map +1 -1
  65. package/dist/gir/enum.d.ts +3 -3
  66. package/dist/gir/enum.d.ts.map +1 -1
  67. package/dist/gir/enum.js +7 -6
  68. package/dist/gir/enum.js.map +1 -1
  69. package/dist/gir/field.d.ts +8 -3
  70. package/dist/gir/field.d.ts.map +1 -1
  71. package/dist/gir/field.js +30 -7
  72. package/dist/gir/field.js.map +1 -1
  73. package/dist/gir/function.d.ts +6 -3
  74. package/dist/gir/function.d.ts.map +1 -1
  75. package/dist/gir/function.js +23 -7
  76. package/dist/gir/function.js.map +1 -1
  77. package/dist/gir/gir-path.d.ts +2 -1
  78. package/dist/gir/gir-path.d.ts.map +1 -1
  79. package/dist/gir/gir-path.js +26 -10
  80. package/dist/gir/gir-path.js.map +1 -1
  81. package/dist/gir/libraries.d.ts +5 -3
  82. package/dist/gir/libraries.d.ts.map +1 -1
  83. package/dist/gir/libraries.js +41 -28
  84. package/dist/gir/libraries.js.map +1 -1
  85. package/dist/gir/library.d.ts +17 -11
  86. package/dist/gir/library.d.ts.map +1 -1
  87. package/dist/gir/library.js +116 -92
  88. package/dist/gir/library.js.map +1 -1
  89. package/dist/gir/namespace.d.ts +10 -10
  90. package/dist/gir/namespace.d.ts.map +1 -1
  91. package/dist/gir/namespace.js +21 -20
  92. package/dist/gir/namespace.js.map +1 -1
  93. package/dist/gir/nullable-overrides.d.ts +3 -0
  94. package/dist/gir/nullable-overrides.d.ts.map +1 -0
  95. package/dist/gir/nullable-overrides.js +5 -0
  96. package/dist/gir/nullable-overrides.js.map +1 -0
  97. package/dist/gir/parameter.d.ts +14 -12
  98. package/dist/gir/parameter.d.ts.map +1 -1
  99. package/dist/gir/parameter.js +27 -18
  100. package/dist/gir/parameter.js.map +1 -1
  101. package/dist/gir/parse.d.ts +12 -13
  102. package/dist/gir/parse.d.ts.map +1 -1
  103. package/dist/gir/parse.js +50 -40
  104. package/dist/gir/parse.js.map +1 -1
  105. package/dist/gir/primitives.d.ts +5 -4
  106. package/dist/gir/primitives.d.ts.map +1 -1
  107. package/dist/gir/primitives.js +4 -3
  108. package/dist/gir/primitives.js.map +1 -1
  109. package/dist/gir/property.d.ts +5 -4
  110. package/dist/gir/property.d.ts.map +1 -1
  111. package/dist/gir/property.js +10 -9
  112. package/dist/gir/property.js.map +1 -1
  113. package/dist/gir/record.d.ts +5 -4
  114. package/dist/gir/record.d.ts.map +1 -1
  115. package/dist/gir/record.js +13 -12
  116. package/dist/gir/record.js.map +1 -1
  117. package/dist/gir/size.d.ts +6 -5
  118. package/dist/gir/size.d.ts.map +1 -1
  119. package/dist/gir/size.js +49 -47
  120. package/dist/gir/size.js.map +1 -1
  121. package/dist/gir/type-id.d.ts +17 -15
  122. package/dist/gir/type-id.d.ts.map +1 -1
  123. package/dist/gir/type-id.js +5 -1
  124. package/dist/gir/type-id.js.map +1 -1
  125. package/dist/gir/type-ref.d.ts +3 -2
  126. package/dist/gir/type-ref.d.ts.map +1 -1
  127. package/dist/gir/type-ref.js +36 -25
  128. package/dist/gir/type-ref.js.map +1 -1
  129. package/dist/gir/type.d.ts +3 -2
  130. package/dist/gir/type.d.ts.map +1 -1
  131. package/dist/gir/type.js.map +1 -1
  132. package/dist/index.d.ts +3 -0
  133. package/dist/index.d.ts.map +1 -1
  134. package/dist/index.js +2 -0
  135. package/dist/index.js.map +1 -1
  136. package/dist/jsx.d.ts +28 -0
  137. package/dist/jsx.d.ts.map +1 -0
  138. package/dist/jsx.js +44 -0
  139. package/dist/jsx.js.map +1 -0
  140. package/dist/khronos/args.d.ts +7 -7
  141. package/dist/khronos/args.d.ts.map +1 -1
  142. package/dist/khronos/args.js +88 -67
  143. package/dist/khronos/args.js.map +1 -1
  144. package/dist/khronos/jsdoc.d.ts +4 -4
  145. package/dist/khronos/jsdoc.d.ts.map +1 -1
  146. package/dist/khronos/jsdoc.js +29 -16
  147. package/dist/khronos/jsdoc.js.map +1 -1
  148. package/dist/khronos/model.d.ts +8 -7
  149. package/dist/khronos/model.d.ts.map +1 -1
  150. package/dist/khronos/model.js +94 -59
  151. package/dist/khronos/model.js.map +1 -1
  152. package/dist/khronos/modules.d.ts +4 -3
  153. package/dist/khronos/modules.d.ts.map +1 -1
  154. package/dist/khronos/modules.js +40 -25
  155. package/dist/khronos/modules.js.map +1 -1
  156. package/dist/khronos/param-pair.d.ts +11 -0
  157. package/dist/khronos/param-pair.d.ts.map +1 -0
  158. package/dist/khronos/param-pair.js +6 -0
  159. package/dist/khronos/param-pair.js.map +1 -0
  160. package/dist/khronos/parse.d.ts +7 -8
  161. package/dist/khronos/parse.d.ts.map +1 -1
  162. package/dist/khronos/parse.js +17 -16
  163. package/dist/khronos/parse.js.map +1 -1
  164. package/dist/khronos/pipeline.d.ts +4 -4
  165. package/dist/khronos/pipeline.d.ts.map +1 -1
  166. package/dist/khronos/pipeline.js +97 -56
  167. package/dist/khronos/pipeline.js.map +1 -1
  168. package/dist/khronos/plan.d.ts +11 -10
  169. package/dist/khronos/plan.d.ts.map +1 -1
  170. package/dist/khronos/plan.js +109 -45
  171. package/dist/khronos/plan.js.map +1 -1
  172. package/dist/khronos/render.d.ts +5 -4
  173. package/dist/khronos/render.d.ts.map +1 -1
  174. package/dist/khronos/render.js +106 -59
  175. package/dist/khronos/render.js.map +1 -1
  176. package/dist/khronos/select.d.ts +4 -4
  177. package/dist/khronos/select.d.ts.map +1 -1
  178. package/dist/khronos/select.js +30 -19
  179. package/dist/khronos/select.js.map +1 -1
  180. package/dist/react/element-config.d.ts +20 -0
  181. package/dist/react/element-config.d.ts.map +1 -0
  182. package/dist/react/element-config.js +64 -0
  183. package/dist/react/element-config.js.map +1 -0
  184. package/dist/runner.d.ts +19 -10
  185. package/dist/runner.d.ts.map +1 -1
  186. package/dist/runner.js +48 -43
  187. package/dist/runner.js.map +1 -1
  188. package/dist/store/compile-store.d.ts +5 -3
  189. package/dist/store/compile-store.d.ts.map +1 -1
  190. package/dist/store/compile-store.js +24 -22
  191. package/dist/store/compile-store.js.map +1 -1
  192. package/dist/store/gi/async.d.ts +2 -1
  193. package/dist/store/gi/async.d.ts.map +1 -1
  194. package/dist/store/gi/async.js +28 -24
  195. package/dist/store/gi/async.js.map +1 -1
  196. package/dist/store/gi/callables.d.ts +26 -20
  197. package/dist/store/gi/callables.d.ts.map +1 -1
  198. package/dist/store/gi/callables.js +157 -100
  199. package/dist/store/gi/callables.js.map +1 -1
  200. package/dist/store/gi/callback.d.ts +3 -2
  201. package/dist/store/gi/callback.d.ts.map +1 -1
  202. package/dist/store/gi/callback.js +6 -3
  203. package/dist/store/gi/callback.js.map +1 -1
  204. package/dist/store/gi/class.d.ts +2 -1
  205. package/dist/store/gi/class.d.ts.map +1 -1
  206. package/dist/store/gi/class.js +86 -47
  207. package/dist/store/gi/class.js.map +1 -1
  208. package/dist/store/gi/companion.d.ts +2 -1
  209. package/dist/store/gi/companion.d.ts.map +1 -1
  210. package/dist/store/gi/companion.js +8 -5
  211. package/dist/store/gi/companion.js.map +1 -1
  212. package/dist/store/gi/constant.d.ts +3 -2
  213. package/dist/store/gi/constant.d.ts.map +1 -1
  214. package/dist/store/gi/constant.js +25 -8
  215. package/dist/store/gi/constant.js.map +1 -1
  216. package/dist/store/gi/constructor-props.d.ts +3 -2
  217. package/dist/store/gi/constructor-props.d.ts.map +1 -1
  218. package/dist/store/gi/constructor-props.js +17 -10
  219. package/dist/store/gi/constructor-props.js.map +1 -1
  220. package/dist/store/gi/enum.d.ts +3 -2
  221. package/dist/store/gi/enum.d.ts.map +1 -1
  222. package/dist/store/gi/enum.js +14 -11
  223. package/dist/store/gi/enum.js.map +1 -1
  224. package/dist/store/gi/function.d.ts +5 -4
  225. package/dist/store/gi/function.d.ts.map +1 -1
  226. package/dist/store/gi/function.js +48 -23
  227. package/dist/store/gi/function.js.map +1 -1
  228. package/dist/store/gi/gtype-binding.d.ts +4 -4
  229. package/dist/store/gi/gtype-binding.d.ts.map +1 -1
  230. package/dist/store/gi/gtype-binding.js +15 -11
  231. package/dist/store/gi/gtype-binding.js.map +1 -1
  232. package/dist/store/gi/interface.d.ts +2 -1
  233. package/dist/store/gi/interface.d.ts.map +1 -1
  234. package/dist/store/gi/interface.js +36 -18
  235. package/dist/store/gi/interface.js.map +1 -1
  236. package/dist/store/gi/item-comparators.d.ts +3 -2
  237. package/dist/store/gi/item-comparators.d.ts.map +1 -1
  238. package/dist/store/gi/item-comparators.js +33 -21
  239. package/dist/store/gi/item-comparators.js.map +1 -1
  240. package/dist/store/gi/method.d.ts +13 -13
  241. package/dist/store/gi/method.d.ts.map +1 -1
  242. package/dist/store/gi/method.js +188 -130
  243. package/dist/store/gi/method.js.map +1 -1
  244. package/dist/store/gi/param-marshal.d.ts +7 -6
  245. package/dist/store/gi/param-marshal.d.ts.map +1 -1
  246. package/dist/store/gi/param-marshal.js +26 -13
  247. package/dist/store/gi/param-marshal.js.map +1 -1
  248. package/dist/store/gi/pipeline.d.ts +2 -1
  249. package/dist/store/gi/pipeline.d.ts.map +1 -1
  250. package/dist/store/gi/pipeline.js +38 -23
  251. package/dist/store/gi/pipeline.js.map +1 -1
  252. package/dist/store/gi/properties.d.ts +2 -1
  253. package/dist/store/gi/properties.d.ts.map +1 -1
  254. package/dist/store/gi/properties.js +6 -4
  255. package/dist/store/gi/properties.js.map +1 -1
  256. package/dist/store/gi/property-accessor.d.ts +11 -10
  257. package/dist/store/gi/property-accessor.d.ts.map +1 -1
  258. package/dist/store/gi/property-accessor.js +86 -60
  259. package/dist/store/gi/property-accessor.js.map +1 -1
  260. package/dist/store/gi/record-constructor.d.ts +3 -2
  261. package/dist/store/gi/record-constructor.d.ts.map +1 -1
  262. package/dist/store/gi/record-constructor.js +40 -28
  263. package/dist/store/gi/record-constructor.js.map +1 -1
  264. package/dist/store/gi/record-field-accessor.d.ts +9 -8
  265. package/dist/store/gi/record-field-accessor.d.ts.map +1 -1
  266. package/dist/store/gi/record-field-accessor.js +187 -99
  267. package/dist/store/gi/record-field-accessor.js.map +1 -1
  268. package/dist/store/gi/record-layout.d.ts +6 -5
  269. package/dist/store/gi/record-layout.d.ts.map +1 -1
  270. package/dist/store/gi/record-layout.js +75 -39
  271. package/dist/store/gi/record-layout.js.map +1 -1
  272. package/dist/store/gi/record.d.ts +2 -1
  273. package/dist/store/gi/record.d.ts.map +1 -1
  274. package/dist/store/gi/record.js +15 -16
  275. package/dist/store/gi/record.js.map +1 -1
  276. package/dist/store/gi/registration.d.ts +3 -3
  277. package/dist/store/gi/registration.d.ts.map +1 -1
  278. package/dist/store/gi/registration.js +3 -2
  279. package/dist/store/gi/registration.js.map +1 -1
  280. package/dist/store/gi/return-wrap.d.ts +2 -2
  281. package/dist/store/gi/return-wrap.d.ts.map +1 -1
  282. package/dist/store/gi/return-wrap.js +43 -22
  283. package/dist/store/gi/return-wrap.js.map +1 -1
  284. package/dist/store/gi/runtime-override.d.ts +2 -1
  285. package/dist/store/gi/runtime-override.d.ts.map +1 -1
  286. package/dist/store/gi/runtime-override.js +6 -3
  287. package/dist/store/gi/runtime-override.js.map +1 -1
  288. package/dist/store/gi/signal.d.ts +3 -2
  289. package/dist/store/gi/signal.d.ts.map +1 -1
  290. package/dist/store/gi/signal.js +113 -66
  291. package/dist/store/gi/signal.js.map +1 -1
  292. package/dist/store/gi/value-marshalable.d.ts +15 -0
  293. package/dist/store/gi/value-marshalable.d.ts.map +1 -0
  294. package/dist/store/gi/value-marshalable.js +66 -0
  295. package/dist/store/gi/value-marshalable.js.map +1 -0
  296. package/dist/store/gi/vtable.d.ts +2 -1
  297. package/dist/store/gi/vtable.d.ts.map +1 -1
  298. package/dist/store/gi/vtable.js +60 -30
  299. package/dist/store/gi/vtable.js.map +1 -1
  300. package/dist/store/gi-store.d.ts +5 -4
  301. package/dist/store/gi-store.d.ts.map +1 -1
  302. package/dist/store/gi-store.js +4 -2
  303. package/dist/store/gi-store.js.map +1 -1
  304. package/dist/store/jsx/element-components.d.ts +23 -0
  305. package/dist/store/jsx/element-components.d.ts.map +1 -0
  306. package/dist/store/jsx/element-components.js +86 -0
  307. package/dist/store/jsx/element-components.js.map +1 -0
  308. package/dist/store/jsx/element-prop-imports.d.ts +17 -0
  309. package/dist/store/jsx/element-prop-imports.d.ts.map +1 -0
  310. package/dist/store/jsx/element-prop-imports.js +15 -0
  311. package/dist/store/jsx/element-prop-imports.js.map +1 -0
  312. package/dist/store/jsx/element-prop-types.d.ts +10 -0
  313. package/dist/store/jsx/element-prop-types.d.ts.map +1 -0
  314. package/dist/store/jsx/element-prop-types.js +41 -0
  315. package/dist/store/jsx/element-prop-types.js.map +1 -0
  316. package/dist/store/jsx/gir-index.d.ts +16 -0
  317. package/dist/store/jsx/gir-index.d.ts.map +1 -0
  318. package/dist/store/jsx/gir-index.js +33 -0
  319. package/dist/store/jsx/gir-index.js.map +1 -0
  320. package/dist/store/jsx/intrinsic-elements.d.ts +26 -0
  321. package/dist/store/jsx/intrinsic-elements.d.ts.map +1 -0
  322. package/dist/store/jsx/intrinsic-elements.js +127 -0
  323. package/dist/store/jsx/intrinsic-elements.js.map +1 -0
  324. package/dist/store/{react → jsx}/jsx.d.ts +2 -4
  325. package/dist/store/jsx/jsx.d.ts.map +1 -0
  326. package/dist/store/{react → jsx}/jsx.js +110 -71
  327. package/dist/store/jsx/jsx.js.map +1 -0
  328. package/dist/store/jsx/metadata.d.ts +4 -0
  329. package/dist/store/jsx/metadata.d.ts.map +1 -0
  330. package/dist/store/{react → jsx}/metadata.js +148 -69
  331. package/dist/store/jsx/metadata.js.map +1 -0
  332. package/dist/store/jsx/omitted-props.d.ts +10 -0
  333. package/dist/store/jsx/omitted-props.d.ts.map +1 -0
  334. package/dist/store/jsx/omitted-props.js +22 -0
  335. package/dist/store/jsx/omitted-props.js.map +1 -0
  336. package/dist/store/jsx/pipeline.d.ts +23 -0
  337. package/dist/store/jsx/pipeline.d.ts.map +1 -0
  338. package/dist/store/{react → jsx}/pipeline.js +38 -15
  339. package/dist/store/jsx/pipeline.js.map +1 -0
  340. package/dist/store/{react → jsx}/props.d.ts +9 -12
  341. package/dist/store/jsx/props.d.ts.map +1 -0
  342. package/dist/store/jsx/props.js +153 -0
  343. package/dist/store/jsx/props.js.map +1 -0
  344. package/dist/store/jsx-store.d.ts +5 -3
  345. package/dist/store/jsx-store.d.ts.map +1 -1
  346. package/dist/store/jsx-store.js +4 -1
  347. package/dist/store/jsx-store.js.map +1 -1
  348. package/dist/store/store-fs.d.ts +14 -12
  349. package/dist/store/store-fs.d.ts.map +1 -1
  350. package/dist/store/store-fs.js +9 -7
  351. package/dist/store/store-fs.js.map +1 -1
  352. package/dist/writer/context.d.ts +2 -1
  353. package/dist/writer/context.d.ts.map +1 -1
  354. package/dist/writer/context.js +12 -6
  355. package/dist/writer/context.js.map +1 -1
  356. package/dist/writer/doc.d.ts +2 -1
  357. package/dist/writer/doc.d.ts.map +1 -1
  358. package/dist/writer/doc.js +13 -7
  359. package/dist/writer/doc.js.map +1 -1
  360. package/dist/writer/emit.d.ts +8 -7
  361. package/dist/writer/emit.d.ts.map +1 -1
  362. package/dist/writer/emit.js +13 -10
  363. package/dist/writer/emit.js.map +1 -1
  364. package/dist/writer/gtk-doc.d.ts +2 -1
  365. package/dist/writer/gtk-doc.d.ts.map +1 -1
  366. package/dist/writer/gtk-doc.js +29 -18
  367. package/dist/writer/gtk-doc.js.map +1 -1
  368. package/dist/writer/imports.d.ts +4 -2
  369. package/dist/writer/imports.d.ts.map +1 -1
  370. package/dist/writer/imports.js +35 -24
  371. package/dist/writer/imports.js.map +1 -1
  372. package/dist/writer/module.d.ts +3 -2
  373. package/dist/writer/module.d.ts.map +1 -1
  374. package/dist/writer/module.js +16 -9
  375. package/dist/writer/module.js.map +1 -1
  376. package/dist/xml.d.ts +4 -0
  377. package/dist/xml.d.ts.map +1 -0
  378. package/dist/xml.js +10 -0
  379. package/dist/xml.js.map +1 -0
  380. package/overrides/cairo/context.ts.ejs +7 -7
  381. package/overrides/cairo/matrix.ts.ejs +2 -2
  382. package/overrides/cairo/recording-surface.ts.ejs +2 -2
  383. package/overrides/cairo/region.ts.ejs +1 -1
  384. package/overrides/cairo/scaled-font.ts.ejs +3 -3
  385. package/package.json +14 -9
  386. package/src/analysis/descriptor-render.ts +516 -168
  387. package/src/analysis/descriptor.ts +162 -125
  388. package/src/analysis/inheritance.ts +286 -98
  389. package/src/analysis/param-structure.ts +188 -57
  390. package/src/analysis/ts-type.ts +113 -34
  391. package/src/compile.ts +103 -76
  392. package/src/docs/api-reference.ts +337 -146
  393. package/src/docs/element-page.ts +137 -150
  394. package/src/docs/pipeline.ts +135 -73
  395. package/src/docs/render.ts +151 -87
  396. package/src/docs/symbol-page.ts +268 -123
  397. package/src/fingerprint.ts +138 -26
  398. package/src/gi.ts +35 -0
  399. package/src/gir/ancestry.ts +26 -14
  400. package/src/gir/callback.ts +10 -15
  401. package/src/gir/class.ts +20 -16
  402. package/src/gir/enum.ts +9 -7
  403. package/src/gir/field.ts +37 -8
  404. package/src/gir/function.ts +33 -9
  405. package/src/gir/gir-path.ts +36 -12
  406. package/src/gir/libraries.ts +59 -33
  407. package/src/gir/library.ts +200 -97
  408. package/src/gir/namespace.ts +42 -26
  409. package/src/gir/nullable-overrides.ts +5 -0
  410. package/src/gir/parameter.ts +80 -42
  411. package/src/gir/parse.ts +102 -47
  412. package/src/gir/primitives.ts +25 -23
  413. package/src/gir/property.ts +13 -11
  414. package/src/gir/record.ts +16 -14
  415. package/src/gir/size.ts +91 -58
  416. package/src/gir/type-id.ts +33 -18
  417. package/src/gir/type-ref.ts +62 -26
  418. package/src/gir/type.ts +10 -8
  419. package/src/index.ts +8 -0
  420. package/src/jsx.ts +75 -0
  421. package/src/khronos/args.ts +158 -89
  422. package/src/khronos/jsdoc.ts +67 -29
  423. package/src/khronos/model.ts +154 -53
  424. package/src/khronos/modules.ts +67 -27
  425. package/src/khronos/param-pair.ts +14 -0
  426. package/src/khronos/parse.ts +37 -17
  427. package/src/khronos/pipeline.ts +193 -90
  428. package/src/khronos/plan.ts +235 -86
  429. package/src/khronos/render.ts +208 -71
  430. package/src/khronos/select.ts +48 -18
  431. package/src/react/element-config.ts +97 -0
  432. package/src/runner.ts +100 -57
  433. package/src/store/compile-store.ts +32 -26
  434. package/src/store/gi/async.ts +48 -21
  435. package/src/store/gi/callables.ts +339 -136
  436. package/src/store/gi/callback.ts +13 -4
  437. package/src/store/gi/class.ts +186 -64
  438. package/src/store/gi/companion.ts +15 -6
  439. package/src/store/gi/constant.ts +42 -8
  440. package/src/store/gi/constructor-props.ts +42 -16
  441. package/src/store/gi/enum.ts +28 -13
  442. package/src/store/gi/function.ts +88 -24
  443. package/src/store/gi/gtype-binding.ts +31 -18
  444. package/src/store/gi/interface.ts +101 -36
  445. package/src/store/gi/item-comparators.ts +74 -26
  446. package/src/store/gi/method.ts +377 -159
  447. package/src/store/gi/param-marshal.ts +38 -15
  448. package/src/store/gi/pipeline.ts +72 -22
  449. package/src/store/gi/properties.ts +16 -5
  450. package/src/store/gi/property-accessor.ts +192 -84
  451. package/src/store/gi/record-constructor.ts +70 -33
  452. package/src/store/gi/record-field-accessor.ts +415 -167
  453. package/src/store/gi/record-layout.ts +130 -43
  454. package/src/store/gi/record.ts +29 -15
  455. package/src/store/gi/registration.ts +15 -9
  456. package/src/store/gi/return-wrap.ts +71 -23
  457. package/src/store/gi/runtime-override.ts +13 -3
  458. package/src/store/gi/signal.ts +244 -104
  459. package/src/store/gi/value-marshalable.ts +96 -0
  460. package/src/store/gi/vtable.ts +117 -41
  461. package/src/store/gi-store.ts +26 -13
  462. package/src/store/jsx/element-components.ts +152 -0
  463. package/src/store/jsx/element-prop-imports.ts +24 -0
  464. package/src/store/jsx/element-prop-types.ts +59 -0
  465. package/src/store/jsx/gir-index.ts +62 -0
  466. package/src/store/jsx/intrinsic-elements.ts +253 -0
  467. package/src/store/{react → jsx}/jsx.ts +213 -99
  468. package/src/store/jsx/metadata.ts +385 -0
  469. package/src/store/jsx/omitted-props.ts +32 -0
  470. package/src/store/jsx/pipeline.ts +148 -0
  471. package/src/store/jsx/props.ts +262 -0
  472. package/src/store/jsx-store.ts +15 -3
  473. package/src/store/store-fs.ts +36 -20
  474. package/src/writer/context.ts +25 -6
  475. package/src/writer/doc.ts +19 -5
  476. package/src/writer/emit.ts +20 -11
  477. package/src/writer/gtk-doc.ts +48 -21
  478. package/src/writer/imports.ts +63 -28
  479. package/src/writer/module.ts +35 -11
  480. package/src/xml.ts +12 -0
  481. package/dist/store/gi/class-struct-record.d.ts +0 -9
  482. package/dist/store/gi/class-struct-record.d.ts.map +0 -1
  483. package/dist/store/gi/class-struct-record.js +0 -34
  484. package/dist/store/gi/class-struct-record.js.map +0 -1
  485. package/dist/store/react/built-ins.d.ts +0 -9
  486. package/dist/store/react/built-ins.d.ts.map +0 -1
  487. package/dist/store/react/built-ins.js +0 -226
  488. package/dist/store/react/built-ins.js.map +0 -1
  489. package/dist/store/react/element-components.d.ts +0 -15
  490. package/dist/store/react/element-components.d.ts.map +0 -1
  491. package/dist/store/react/element-components.js +0 -92
  492. package/dist/store/react/element-components.js.map +0 -1
  493. package/dist/store/react/element-prop-types.d.ts +0 -19
  494. package/dist/store/react/element-prop-types.d.ts.map +0 -1
  495. package/dist/store/react/element-prop-types.js +0 -244
  496. package/dist/store/react/element-prop-types.js.map +0 -1
  497. package/dist/store/react/element-props.d.ts +0 -4
  498. package/dist/store/react/element-props.d.ts.map +0 -1
  499. package/dist/store/react/element-props.js +0 -178
  500. package/dist/store/react/element-props.js.map +0 -1
  501. package/dist/store/react/gir-index.d.ts +0 -25
  502. package/dist/store/react/gir-index.d.ts.map +0 -1
  503. package/dist/store/react/gir-index.js +0 -55
  504. package/dist/store/react/gir-index.js.map +0 -1
  505. package/dist/store/react/intrinsic-elements.d.ts +0 -26
  506. package/dist/store/react/intrinsic-elements.d.ts.map +0 -1
  507. package/dist/store/react/intrinsic-elements.js +0 -107
  508. package/dist/store/react/intrinsic-elements.js.map +0 -1
  509. package/dist/store/react/jsx.d.ts.map +0 -1
  510. package/dist/store/react/jsx.js.map +0 -1
  511. package/dist/store/react/metadata.d.ts +0 -4
  512. package/dist/store/react/metadata.d.ts.map +0 -1
  513. package/dist/store/react/metadata.js.map +0 -1
  514. package/dist/store/react/pipeline.d.ts +0 -14
  515. package/dist/store/react/pipeline.d.ts.map +0 -1
  516. package/dist/store/react/pipeline.js.map +0 -1
  517. package/dist/store/react/props.d.ts.map +0 -1
  518. package/dist/store/react/props.js +0 -133
  519. package/dist/store/react/props.js.map +0 -1
  520. package/overrides/gtk/constants.ts.ejs +0 -3
  521. package/overrides/gtk/index.ts.ejs +0 -2
  522. package/src/store/gi/class-struct-record.ts +0 -40
  523. package/src/store/react/built-ins.ts +0 -260
  524. package/src/store/react/element-components.ts +0 -138
  525. package/src/store/react/element-prop-types.ts +0 -280
  526. package/src/store/react/element-props.ts +0 -204
  527. package/src/store/react/gir-index.ts +0 -85
  528. package/src/store/react/intrinsic-elements.ts +0 -161
  529. package/src/store/react/metadata.ts +0 -197
  530. package/src/store/react/pipeline.ts +0 -90
  531. package/src/store/react/props.ts +0 -197
@@ -1 +1 @@
1
- {"version":3,"file":"pipeline.js","sourceRoot":"","sources":["../../src/docs/pipeline.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AACrF,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAE1C,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAC5C,OAAO,EAAE,kBAAkB,EAAE,oBAAoB,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAC3F,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAC5C,OAAO,EAAE,kBAAkB,EAAE,MAAM,qBAAqB,CAAC;AACzD,OAAO,EAAE,8BAA8B,EAAuB,MAAM,sCAAsC,CAAC;AAC3G,OAAO,EAAE,wBAAwB,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAC;AAChF,OAAO,EAAE,WAAW,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AA2BzE,MAAM,iBAAiB,GAAG,eAAe,CAAC;AAE1C,MAAM,kBAAkB,GAAG,CAAC,SAAwB,EAAE,QAA0B,EAAU,EAAE;IACxF,MAAM,IAAI,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE;QACvC,MAAM,IAAI,GAAG,SAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,IAAI,IAAI,EAAE,CAAC;QACnD,MAAM,WAAW,GAAG,aAAa,CAAC,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,UAAU,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;QAC1E,OAAO,MAAM,KAAK,CAAC,QAAQ,KAAK,IAAI,OAAO,WAAW,IAAI,CAAC;IAC/D,CAAC,CAAC,CAAC;IACH,OAAO;QACH,KAAK;QACL,gBAAgB,IAAI,CAAC,SAAS,CAAC,2BAA2B,SAAS,CAAC,QAAQ,CAAC,MAAM,wBAAwB,SAAS,CAAC,IAAI,aAAa,CAAC,EAAE;QACzI,KAAK;QACL,EAAE;QACF,KAAK,SAAS,CAAC,IAAI,WAAW;QAC9B,EAAE;QACF,4DAA4D,SAAS,CAAC,SAAS,+EAA+E,SAAS,CAAC,SAAS,KAAK;QACtL,EAAE;QACF,2BAA2B;QAC3B,eAAe;QACf,GAAG,IAAI;QACP,EAAE;KACL,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AACjB,CAAC,CAAC;AAEF,MAAM,aAAa,GAAG,CAAC,UAA2B,EAAE,SAAmB,EAAU,EAAE;IAC/E,MAAM,IAAI,GAAG,UAAU,CAAC,GAAG,CACvB,CAAC,EAAE,EAAE,EAAE,CAAC,MAAM,EAAE,CAAC,IAAI,KAAK,EAAE,CAAC,IAAI,mBAAmB,EAAE,CAAC,SAAS,QAAQ,EAAE,CAAC,QAAQ,CAAC,MAAM,IAAI,CACjG,CAAC;IACF,MAAM,aAAa,GAAG,SAAS,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,KAAK,OAAO,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC9E,OAAO;QACH,KAAK;QACL,yGAAyG;QACzG,KAAK;QACL,EAAE;QACF,qBAAqB;QACrB,EAAE;QACF,gGAAgG,aAAa,oNAAoN;QACjU,EAAE;QACF,0BAA0B;QAC1B,EAAE;QACF,uKAAuK;QACvK,kFAAkF;QAClF,4EAA4E;QAC5E,EAAE;QACF,eAAe;QACf,EAAE;QACF,mCAAmC;QACnC,qBAAqB;QACrB,GAAG,IAAI;QACP,EAAE;KACL,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AACjB,CAAC,CAAC;AAOF,MAAM,aAAa,GAAG,CAAC,OAAoB,EAAE,QAAgB,EAAE,OAAgB,EAAiB,EAAE;IAC9F,MAAM,iBAAiB,GAAG,8BAA8B,CAAC,OAAO,CAAC,CAAC;IAElE,MAAM,WAAW,GAAG,IAAI,GAAG,EAA4B,CAAC;IACxD,KAAK,MAAM,KAAK,IAAI,iBAAiB,EAAE,CAAC;QACpC,MAAM,IAAI,GAAG,WAAW,CAAC,GAAG,CAAC,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;QACzD,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACjB,WAAW,CAAC,GAAG,CAAC,KAAK,CAAC,SAAS,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IAChD,CAAC;IAED,MAAM,cAAc,GAAG,IAAI,GAAG,EAAkB,CAAC;IACjD,KAAK,MAAM,KAAK,IAAI,iBAAiB,EAAE,CAAC;QACpC,MAAM,SAAS,GAAG,kBAAkB,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QACtD,MAAM,IAAI,GAAG,WAAW,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAC3C,MAAM,IAAI,GAAG,GAAG,QAAQ,IAAI,SAAS,IAAI,IAAI,EAAE,CAAC;QAChD,MAAM,QAAQ,GAAG,CAAC,GAAG,cAAc,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QAC7D,IAAI,QAAQ;YAAE,MAAM,IAAI,KAAK,CAAC,gCAAgC,KAAK,CAAC,QAAQ,OAAO,IAAI,EAAE,CAAC,CAAC;QAC3F,cAAc,CAAC,GAAG,CAAC,KAAK,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;IAC7C,CAAC;IAED,MAAM,WAAW,GAAG,wBAAwB,CAAC,OAAO,EAAE,OAAO,CAAC,YAAY,IAAI,EAAE,EAAE,CAAC,QAAQ,EAAE,EAAE,CAC3F,cAAc,CAAC,GAAG,CAAC,QAAQ,CAAC,CAC/B,CAAC;IAEF,MAAM,KAAK,GAAwC,EAAE,CAAC;IACtD,MAAM,UAAU,GAAoB,EAAE,CAAC;IACvC,MAAM,YAAY,GAAG,aAAa,CAAC,CAAC,GAAG,WAAW,CAAC,IAAI,EAAE,CAAC,EAAE,cAAc,CAAC,CAAC;IAC5E,KAAK,MAAM,IAAI,IAAI,YAAY,EAAE,CAAC;QAC9B,MAAM,QAAQ,GAAG,aAAa,CAAC,WAAW,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QACvF,MAAM,SAAS,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC;QACrC,MAAM,aAAa,GAAkB;YACjC,IAAI;YACJ,SAAS;YACT,IAAI,EAAE,GAAG,QAAQ,IAAI,SAAS,GAAG;YACjC,QAAQ,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;gBAC/B,IAAI,EAAE,KAAK,CAAC,QAAQ;gBACpB,IAAI,EAAE,cAAc,CAAC,GAAG,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,EAAE;aACjD,CAAC,CAAC;SACN,CAAC;QACF,KAAK,MAAM,KAAK,IAAI,QAAQ,EAAE,CAAC;YAC3B,MAAM,IAAI,GAAG,WAAW,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;YAC3C,KAAK,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,GAAG,SAAS,IAAI,IAAI,KAAK,EAAE,OAAO,EAAE,iBAAiB,CAAC,KAAK,EAAE,WAAW,CAAC,EAAE,CAAC,CAAC;QACpG,CAAC;QACD,KAAK,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,GAAG,SAAS,WAAW,EAAE,OAAO,EAAE,kBAAkB,CAAC,aAAa,EAAE,QAAQ,CAAC,EAAE,CAAC,CAAC;QACpG,UAAU,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;IACnC,CAAC;IACD,KAAK,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,UAAU,EAAE,OAAO,EAAE,aAAa,CAAC,UAAU,EAAE,OAAO,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;IACxF,OAAO,EAAE,KAAK,EAAE,UAAU,EAAE,CAAC;AACjC,CAAC,CAAC;AAOF,MAAM,CAAC,MAAM,SAAS,GAAG,CAAC,OAAoB,EAAc,EAAE;IAC1D,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,IAAI,YAAY,CAAC;IAClD,MAAM,YAAY,GAAG,OAAO,CAAC,YAAY,IAAI,EAAE,CAAC;IAChD,MAAM,YAAY,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAC;IAC7D,IAAI,OAAO,CAAC,KAAK,KAAK,IAAI,IAAI,YAAY,CAAC,OAAO,CAAC,MAAM,EAAE,OAAO,CAAC,SAAS,EAAE,YAAY,CAAC,EAAE,CAAC;QAC1F,IAAI,UAAU,CAAC,YAAY,CAAC,EAAE,CAAC;YAC3B,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,YAAY,EAAE,MAAM,CAAC,CAAiB,CAAC;YAChF,OAAO,EAAE,WAAW,EAAE,KAAK,EAAE,UAAU,EAAE,QAAQ,CAAC,UAAU,EAAE,CAAC;QACnE,CAAC;IACL,CAAC;IAED,MAAM,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;IACjE,MAAM,EAAE,KAAK,EAAE,UAAU,EAAE,GAAG,aAAa,CAAC,OAAO,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;IAExE,MAAM,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;IACzD,SAAS,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IAC/C,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACvB,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;QAC/C,SAAS,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QAChD,aAAa,CAAC,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;IACxC,CAAC;IACD,MAAM,QAAQ,GAAiB,EAAE,UAAU,EAAE,CAAC;IAC9C,aAAa,CAAC,YAAY,EAAE,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAC;IACtD,aAAa,CACT,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,oBAAoB,CAAC,EAC1C,IAAI,CAAC,SAAS,CAAC;QACX,KAAK,EAAE,kBAAkB,CAAC,OAAO,CAAC,QAAQ,EAAE,OAAO,CAAC,SAAS,EAAE,YAAY,CAAC;QAC5E,QAAQ,EAAE,OAAO,CAAC,QAAQ;QAC1B,SAAS,EAAE,OAAO,CAAC,SAAS;KAC/B,CAAC,CACL,CAAC;IACF,OAAO,EAAE,WAAW,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC;AAC7C,CAAC,CAAC","sourcesContent":["import { existsSync, mkdirSync, readFileSync, rmSync, writeFileSync } from \"node:fs\";\nimport { dirname, join } from \"node:path\";\nimport type { ElementProp } from \"@gtkx/config\";\nimport { sortStringsBy } from \"@gtkx/utils\";\nimport { computeFingerprint, FINGERPRINT_FILENAME, isStoreFresh } from \"../fingerprint.js\";\nimport { Library } from \"../gir/library.js\";\nimport { namespaceDirectory } from \"../gir/namespace.js\";\nimport { collectIntrinsicElementClasses, type GlibNamedClass } from \"../store/react/intrinsic-elements.js\";\nimport { createElementPageContext, renderElementPage } from \"./element-page.js\";\nimport { elementSlug, firstSentence, namespaceOrder } from \"./render.js\";\n\nexport type DocsElementLink = {\n text: string;\n link: string;\n};\n\nexport type DocsNamespace = {\n name: string;\n directory: string;\n link: string;\n elements: DocsElementLink[];\n};\n\nexport type DocsOptions = {\n libraries: string[];\n girPath: string[];\n outDir: string;\n basePath?: string;\n elementProps?: Record<string, ElementProp[]>;\n force?: boolean;\n};\n\ntype DocsManifest = {\n namespaces: DocsNamespace[];\n};\n\nconst MANIFEST_FILENAME = \"manifest.json\";\n\nconst namespaceIndexPage = (namespace: DocsNamespace, elements: GlibNamedClass[]): string => {\n const rows = elements.map((entry, index) => {\n const link = namespace.elements[index]?.link ?? \"\";\n const description = firstSentence(entry.klass.doc).replaceAll(\"|\", \"\\\\|\");\n return `| [${entry.glibName}](${link}) | ${description} |`;\n });\n return [\n \"---\",\n `description: ${JSON.stringify(`Reference pages for the ${namespace.elements.length} JSX elements in the ${namespace.name} namespace.`)}`,\n \"---\",\n \"\",\n `# ${namespace.name} elements`,\n \"\",\n `Elements in this namespace are imported from \\`@gtkx/jsx/${namespace.directory}\\`; the matching classes, enums, and functions are imported from \\`@gtkx/gi/${namespace.directory}\\`.`,\n \"\",\n \"| Element | Description |\",\n \"| --- | --- |\",\n ...rows,\n \"\",\n ].join(\"\\n\");\n};\n\nconst rootIndexPage = (namespaces: DocsNamespace[], libraries: string[]): string => {\n const rows = namespaces.map(\n (ns) => `| [${ns.name}](${ns.link}) | \\`@gtkx/jsx/${ns.directory}\\` | ${ns.elements.length} |`,\n );\n const librariesList = libraries.map((library) => `\\`${library}\\``).join(\", \");\n return [\n \"---\",\n `description: \"Generated reference documentation for every JSX element in this project's GIR libraries.\"`,\n \"---\",\n \"\",\n \"# Element Reference\",\n \"\",\n `This reference documents every JSX element generated from the GObject-Introspection data for ${librariesList}, together with the namespaces they pull in. It is produced by \\`gtkx docs\\` using the same pipeline that generates the \\`@gtkx/jsx\\` and \\`@gtkx/gi\\` bindings, so every page matches the types your editor sees.`,\n \"\",\n \"Each element page lists:\",\n \"\",\n \"- **Props** derived from GObject properties, plus the element props GTKX adds (such as `children` and named slots), with types, defaults, and upstream documentation.\",\n \"- **Signals** as `on<Signal>` handler props with their exact handler signatures.\",\n \"- **Methods** available on the underlying instance through the `ref` prop.\",\n \"\",\n \"## Namespaces\",\n \"\",\n \"| Namespace | Import | Elements |\",\n \"| --- | --- | --- |\",\n ...rows,\n \"\",\n ].join(\"\\n\");\n};\n\ntype GeneratedDocs = {\n pages: { path: string; content: string }[];\n namespaces: DocsNamespace[];\n};\n\nconst generatePages = (options: DocsOptions, basePath: string, library: Library): GeneratedDocs => {\n const intrinsicElements = collectIntrinsicElementClasses(library);\n\n const byNamespace = new Map<string, GlibNamedClass[]>();\n for (const entry of intrinsicElements) {\n const list = byNamespace.get(entry.namespace.name) ?? [];\n list.push(entry);\n byNamespace.set(entry.namespace.name, list);\n }\n\n const linkByGlibName = new Map<string, string>();\n for (const entry of intrinsicElements) {\n const directory = namespaceDirectory(entry.namespace);\n const slug = elementSlug(entry.klass.name);\n const link = `${basePath}/${directory}/${slug}`;\n const existing = [...linkByGlibName.values()].includes(link);\n if (existing) throw new Error(`Docs page slug collision for ${entry.glibName} at ${link}`);\n linkByGlibName.set(entry.glibName, link);\n }\n\n const pageContext = createElementPageContext(library, options.elementProps ?? {}, (glibName) =>\n linkByGlibName.get(glibName),\n );\n\n const pages: { path: string; content: string }[] = [];\n const namespaces: DocsNamespace[] = [];\n const orderedNames = sortStringsBy([...byNamespace.keys()], namespaceOrder);\n for (const name of orderedNames) {\n const elements = sortStringsBy(byNamespace.get(name) ?? [], (entry) => entry.glibName);\n const directory = name.toLowerCase();\n const namespaceDocs: DocsNamespace = {\n name,\n directory,\n link: `${basePath}/${directory}/`,\n elements: elements.map((entry) => ({\n text: entry.glibName,\n link: linkByGlibName.get(entry.glibName) ?? \"\",\n })),\n };\n for (const entry of elements) {\n const slug = elementSlug(entry.klass.name);\n pages.push({ path: `${directory}/${slug}.md`, content: renderElementPage(entry, pageContext) });\n }\n pages.push({ path: `${directory}/index.md`, content: namespaceIndexPage(namespaceDocs, elements) });\n namespaces.push(namespaceDocs);\n }\n pages.push({ path: \"index.md\", content: rootIndexPage(namespaces, options.libraries) });\n return { pages, namespaces };\n};\n\nexport type DocsResult = {\n regenerated: boolean;\n namespaces: DocsNamespace[];\n};\n\nexport const writeDocs = (options: DocsOptions): DocsResult => {\n const basePath = options.basePath ?? \"/reference\";\n const elementProps = options.elementProps ?? {};\n const manifestPath = join(options.outDir, MANIFEST_FILENAME);\n if (options.force !== true && isStoreFresh(options.outDir, options.libraries, elementProps)) {\n if (existsSync(manifestPath)) {\n const manifest = JSON.parse(readFileSync(manifestPath, \"utf8\")) as DocsManifest;\n return { regenerated: false, namespaces: manifest.namespaces };\n }\n }\n\n const library = Library.load(options.libraries, options.girPath);\n const { pages, namespaces } = generatePages(options, basePath, library);\n\n rmSync(options.outDir, { recursive: true, force: true });\n mkdirSync(options.outDir, { recursive: true });\n for (const page of pages) {\n const target = join(options.outDir, page.path);\n mkdirSync(dirname(target), { recursive: true });\n writeFileSync(target, page.content);\n }\n const manifest: DocsManifest = { namespaces };\n writeFileSync(manifestPath, JSON.stringify(manifest));\n writeFileSync(\n join(options.outDir, FINGERPRINT_FILENAME),\n JSON.stringify({\n value: computeFingerprint(library.girFiles, options.libraries, elementProps),\n girFiles: library.girFiles,\n libraries: options.libraries,\n }),\n );\n return { regenerated: true, namespaces };\n};\n"]}
1
+ {"version":3,"file":"pipeline.js","sourceRoot":"","sources":["../../src/docs/pipeline.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAC5C,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AACrF,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAC1C,OAAO,EAAE,oBAAoB,EAAE,oBAAoB,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AAC/F,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAC5C,OAAO,EAAE,kBAAkB,EAAE,MAAM,qBAAqB,CAAC;AACzD,OAAO,EAAqB,eAAe,EAAE,MAAM,sCAAsC,CAAC;AAC1F,OAAO,EAAE,8BAA8B,EAAuB,MAAM,oCAAoC,CAAC;AACzG,OAAO,EAAqB,eAAe,EAAE,MAAM,+BAA+B,CAAC;AACnF,OAAO,EAAE,wBAAwB,EAA2B,iBAAiB,EAAE,MAAM,mBAAmB,CAAC;AACzG,OAAO,EAAE,WAAW,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAyCzE,MAAM,iBAAiB,GAAG,eAAe,CAAC;AAE1C,MAAM,kBAAkB,GAAG,CAAC,SAAwB,EAAE,QAA0B,EAAU,EAAE;IACxF,MAAM,IAAI,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE;QACvC,MAAM,IAAI,GAAG,SAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,IAAI,IAAI,EAAE,CAAC;QACnD,MAAM,WAAW,GAAG,aAAa,CAAC,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,UAAU,CAAC,GAAG,EAAE,MAAM,CAAC,GAAG,CAAA,IAAI,CAAC,CAAC;QAEnF,OAAO,MAAM,KAAK,CAAC,QAAQ,KAAK,IAAI,OAAO,WAAW,IAAI,CAAC;IAC/D,CAAC,CAAC,CAAC;IAEH,MAAM,WAAW,GACb,2BAA2B,MAAM,CAAC,SAAS,CAAC,QAAQ,CAAC,MAAM,CAAC,mBAAmB;QAC/E,OAAO,SAAS,CAAC,IAAI,aAAa,CAAC;IAEvC,OAAO;QACH,KAAK;QACL,gBAAgB,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,EAAE;QAC7C,KAAK;QACL,EAAE;QACF,KAAK,SAAS,CAAC,IAAI,WAAW;QAC9B,EAAE;QACF,4DAA4D,SAAS,CAAC,SAAS,mBAAmB;YAClG,8DAA8D,SAAS,CAAC,SAAS,KAAK;QACtF,EAAE;QACF,2BAA2B;QAC3B,eAAe;QACf,GAAG,IAAI;QACP,EAAE;KACL,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AACjB,CAAC,CAAC;AAEF,MAAM,aAAa,GAAG,CAAC,UAA2B,EAAE,SAAmB,EAAU,EAAE;IAC/E,MAAM,IAAI,GAAG,UAAU,CAAC,GAAG,CACvB,CAAC,EAAE,EAAE,EAAE,CAAC,MAAM,EAAE,CAAC,IAAI,KAAK,EAAE,CAAC,IAAI,mBAAmB,EAAE,CAAC,SAAS,QAAQ,MAAM,CAAC,EAAE,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,CACzG,CAAC;IAEF,MAAM,aAAa,GAAG,SAAS,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,KAAK,OAAO,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAE9E,OAAO;QACH,KAAK;QACL,2GAA2G;QAC3G,KAAK;QACL,EAAE;QACF,qBAAqB;QACrB,EAAE;QACF,+FAA+F;YAC/F,GAAG,aAAa,+EAA+E;YAC/F,gGAAgG;YAChG,qCAAqC;QACrC,EAAE;QACF,0BAA0B;QAC1B,EAAE;QACF,oGAAoG;YACpG,qEAAqE;QACrE,kFAAkF;QAClF,4EAA4E;QAC5E,EAAE;QACF,eAAe;QACf,EAAE;QACF,mCAAmC;QACnC,qBAAqB;QACrB,GAAG,IAAI;QACP,EAAE;KACL,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AACjB,CAAC,CAAC;AAEF,MAAM,wBAAwB,GAAG,CAAC,QAA0B,EAAiC,EAAE;IAC3F,MAAM,WAAW,GAAkC,IAAI,GAAG,EAAE,CAAC;IAE7D,KAAK,MAAM,KAAK,IAAI,QAAQ,EAAE,CAAC;QAC3B,MAAM,IAAI,GAAG,WAAW,CAAC,GAAG,CAAC,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;QACzD,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACjB,WAAW,CAAC,GAAG,CAAC,KAAK,CAAC,SAAS,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IAChD,CAAC;IAED,OAAO,WAAW,CAAC;AACvB,CAAC,CAAC;AAEF,MAAM,iBAAiB,GAAG,CAAC,QAA0B,EAAE,QAAgB,EAAuB,EAAE;IAC5F,MAAM,cAAc,GAAwB,IAAI,GAAG,EAAE,CAAC;IAEtD,KAAK,MAAM,KAAK,IAAI,QAAQ,EAAE,CAAC;QAC3B,MAAM,SAAS,GAAG,kBAAkB,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QACtD,MAAM,IAAI,GAAG,GAAG,QAAQ,IAAI,SAAS,IAAI,WAAW,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;QAEzE,IAAI,cAAc,CAAC,MAAM,EAAE,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,KAAK,IAAI,CAAC,EAAE,CAAC;YAChE,MAAM,IAAI,KAAK,CAAC,gCAAgC,KAAK,CAAC,QAAQ,OAAO,IAAI,EAAE,CAAC,CAAC;QACjF,CAAC;QAED,cAAc,CAAC,GAAG,CAAC,KAAK,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;IAC7C,CAAC;IAED,OAAO,cAAc,CAAC;AAC1B,CAAC,CAAC;AAEF,MAAM,cAAc,GAAG,CAAC,KAMvB,EAAkB,EAAE;IACjB,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,cAAc,EAAE,WAAW,EAAE,GAAG,KAAK,CAAC;IACxE,MAAM,SAAS,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC;IAErC,MAAM,IAAI,GAAkB;QACxB,IAAI;QACJ,SAAS;QACT,IAAI,EAAE,GAAG,QAAQ,IAAI,SAAS,GAAG;QACjC,QAAQ,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC,QAAQ,EAAE,IAAI,EAAE,cAAc,CAAC,GAAG,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;KAChH,CAAC;IAEF,MAAM,KAAK,GAAW,QAAQ,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;QAC3C,IAAI,EAAE,GAAG,SAAS,IAAI,WAAW,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK;QACxD,OAAO,EAAE,iBAAiB,CAAC,KAAK,EAAE,WAAW,CAAC;KACjD,CAAC,CAAC,CAAC;IAEJ,KAAK,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,GAAG,SAAS,WAAW,EAAE,OAAO,EAAE,kBAAkB,CAAC,IAAI,EAAE,QAAQ,CAAC,EAAE,CAAC,CAAC;IAE3F,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC;AAC3B,CAAC,CAAC;AAEF,MAAM,aAAa,GAAG,CAAC,OAAoB,EAAE,QAAgB,EAAE,OAAgB,EAAiB,EAAE;IAC9F,MAAM,iBAAiB,GAAG,8BAA8B,CAAC,OAAO,CAAC,CAAC;IAClE,MAAM,WAAW,GAAG,wBAAwB,CAAC,iBAAiB,CAAC,CAAC;IAChE,MAAM,cAAc,GAAG,iBAAiB,CAAC,iBAAiB,EAAE,QAAQ,CAAC,CAAC;IACtE,MAAM,WAAW,GAAG,wBAAwB,CAAC,OAAO,EAAE,CAAC,QAAgB,EAAE,EAAE,CAAC,cAAc,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC;IAC1G,MAAM,KAAK,GAAW,EAAE,CAAC;IACzB,MAAM,UAAU,GAAoB,EAAE,CAAC;IACvC,MAAM,YAAY,GAAG,aAAa,CAAC,WAAW,CAAC,IAAI,EAAE,EAAE,cAAc,CAAC,CAAC;IAEvE,KAAK,MAAM,IAAI,IAAI,YAAY,EAAE,CAAC;QAC9B,MAAM,QAAQ,GAAG,aAAa,CAAC,WAAW,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QACvF,MAAM,MAAM,GAAG,cAAc,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,cAAc,EAAE,WAAW,EAAE,CAAC,CAAC;QACzF,KAAK,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;QAC5B,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IACjC,CAAC;IAED,KAAK,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,UAAU,EAAE,OAAO,EAAE,aAAa,CAAC,UAAU,EAAE,OAAO,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;IAExF,OAAO,EAAE,KAAK,EAAE,UAAU,EAAE,CAAC;AACjC,CAAC,CAAC;AAEF,MAAM,gBAAgB,GAAG,CAAC,OAAoB,EAAE,YAAoB,EAA0B,EAAE;IAC5F,IAAI,OAAO,CAAC,KAAK,KAAK,IAAI,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,MAAM,EAAE,OAAO,CAAC,SAAS,EAAE,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;QAChG,OAAO,SAAS,CAAC;IACrB,CAAC;IAED,IAAI,CAAC,UAAU,CAAC,YAAY,CAAC,EAAE,CAAC;QAC5B,OAAO,SAAS,CAAC;IACrB,CAAC;IAED,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,YAAY,EAAE,MAAM,CAAC,CAAiB,CAAC;IAEhF,OAAO,EAAE,WAAW,EAAE,KAAK,EAAE,UAAU,EAAE,QAAQ,CAAC,UAAU,EAAE,CAAC;AACnE,CAAC,CAAC;AAEF,MAAM,UAAU,GAAG,CAAC,MAAc,EAAE,KAAa,EAAQ,EAAE;IACvD,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACvB,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;QACvC,SAAS,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QAChD,aAAa,CAAC,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;IACxC,CAAC;AACL,CAAC,CAAC;AAEF,MAAM,SAAS,GAAG,CAAC,OAAoB,EAAc,EAAE;IACnD,eAAe,CAAC,OAAO,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC;IACrC,eAAe,CAAC,OAAO,CAAC,SAAS,IAAI,EAAE,CAAC,CAAC;IACzC,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,IAAI,YAAY,CAAC;IAClD,MAAM,YAAY,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAC;IAC7D,MAAM,MAAM,GAAG,gBAAgB,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC;IAEvD,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;QACvB,OAAO,MAAM,CAAC;IAClB,CAAC;IAED,MAAM,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;IACjE,MAAM,EAAE,KAAK,EAAE,UAAU,EAAE,GAAG,aAAa,CAAC,OAAO,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;IACxE,MAAM,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;IACzD,SAAS,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IAC/C,UAAU,CAAC,OAAO,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;IAClC,MAAM,QAAQ,GAAiB,EAAE,UAAU,EAAE,CAAC;IAC9C,aAAa,CAAC,YAAY,EAAE,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAC;IAEtD,aAAa,CACT,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,oBAAoB,CAAC,EAC1C,IAAI,CAAC,SAAS,CAAC,oBAAoB,CAAC,OAAO,CAAC,QAAQ,EAAE,OAAO,CAAC,SAAS,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC,CAC7F,CAAC;IAEF,OAAO,EAAE,WAAW,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC;AAC7C,CAAC,CAAC;AAEF,OAAO,EAAE,SAAS,EAA+E,CAAC","sourcesContent":["import { sortStringsBy } from \"@gtkx/utils\";\nimport { existsSync, mkdirSync, readFileSync, rmSync, writeFileSync } from \"node:fs\";\nimport { dirname, join } from \"node:path\";\nimport { computeGiFingerprint, FINGERPRINT_FILENAME, isGiStoreFresh } from \"../fingerprint.js\";\nimport { Library } from \"../gir/library.js\";\nimport { namespaceDirectory } from \"../gir/namespace.js\";\nimport { type ElementProps, setElementProps } from \"../store/jsx/element-prop-imports.js\";\nimport { collectIntrinsicElementClasses, type GlibNamedClass } from \"../store/jsx/intrinsic-elements.js\";\nimport { type OmittedProps, setOmittedProps } from \"../store/jsx/omitted-props.js\";\nimport { createElementPageContext, type ElementPageContext, renderElementPage } from \"./element-page.js\";\nimport { elementSlug, firstSentence, namespaceOrder } from \"./render.js\";\n\ntype DocsElementLink = {\n text: string;\n link: string;\n};\n\ntype DocsNamespace = {\n name: string;\n directory: string;\n link: string;\n elements: DocsElementLink[];\n};\n\ntype DocsOptions = {\n libraries: string[];\n girPath: string[];\n outDir: string;\n basePath?: string;\n props?: ElementProps;\n omitProps?: OmittedProps;\n force?: boolean;\n};\n\ntype DocsManifest = {\n namespaces: DocsNamespace[];\n};\n\ntype GeneratedDocs = {\n pages: { path: string; content: string }[];\n namespaces: DocsNamespace[];\n};\n\ntype Page = { path: string; content: string };\ntype NamespacePages = { docs: DocsNamespace; pages: Page[] };\n\ntype DocsResult = {\n regenerated: boolean;\n namespaces: DocsNamespace[];\n};\n\nconst MANIFEST_FILENAME = \"manifest.json\";\n\nconst namespaceIndexPage = (namespace: DocsNamespace, elements: GlibNamedClass[]): string => {\n const rows = elements.map((entry, index) => {\n const link = namespace.elements[index]?.link ?? \"\";\n const description = firstSentence(entry.klass.doc).replaceAll(\"|\", String.raw`\\|`);\n\n return `| [${entry.glibName}](${link}) | ${description} |`;\n });\n\n const description =\n `Reference pages for the ${String(namespace.elements.length)} JSX elements in ` +\n `the ${namespace.name} namespace.`;\n\n return [\n \"---\",\n `description: ${JSON.stringify(description)}`,\n \"---\",\n \"\",\n `# ${namespace.name} elements`,\n \"\",\n `Elements in this namespace are imported from \\`@gtkx/jsx/${namespace.directory}\\`; the matching ` +\n `classes, enums, and functions are imported from \\`@gtkx/gi/${namespace.directory}\\`.`,\n \"\",\n \"| Element | Description |\",\n \"| --- | --- |\",\n ...rows,\n \"\",\n ].join(\"\\n\");\n};\n\nconst rootIndexPage = (namespaces: DocsNamespace[], libraries: string[]): string => {\n const rows = namespaces.map(\n (ns) => `| [${ns.name}](${ns.link}) | \\`@gtkx/jsx/${ns.directory}\\` | ${String(ns.elements.length)} |`,\n );\n\n const librariesList = libraries.map((library) => `\\`${library}\\``).join(\", \");\n\n return [\n \"---\",\n \"description: \\\"Generated reference documentation for every JSX element in this project's GIR libraries.\\\"\",\n \"---\",\n \"\",\n \"# Element Reference\",\n \"\",\n \"This reference documents every JSX element generated from the GObject-Introspection data for \" +\n `${librariesList}, together with the namespaces they pull in. It is produced by \\`gtkx docs\\` ` +\n \"using the same pipeline that generates the `@gtkx/jsx` and `@gtkx/gi` bindings, so every page \" +\n \"matches the types your editor sees.\",\n \"\",\n \"Each element page lists:\",\n \"\",\n \"- **Props** derived from GObject properties, plus the element props GTKX adds (such as `children` \" +\n \"and named slots), with types, defaults, and upstream documentation.\",\n \"- **Signals** as `on<Signal>` handler props with their exact handler signatures.\",\n \"- **Methods** available on the underlying instance through the `ref` prop.\",\n \"\",\n \"## Namespaces\",\n \"\",\n \"| Namespace | Import | Elements |\",\n \"| --- | --- | --- |\",\n ...rows,\n \"\",\n ].join(\"\\n\");\n};\n\nconst groupElementsByNamespace = (elements: GlibNamedClass[]): Map<string, GlibNamedClass[]> => {\n const byNamespace: Map<string, GlibNamedClass[]> = new Map();\n\n for (const entry of elements) {\n const list = byNamespace.get(entry.namespace.name) ?? [];\n list.push(entry);\n byNamespace.set(entry.namespace.name, list);\n }\n\n return byNamespace;\n};\n\nconst buildElementLinks = (elements: GlibNamedClass[], basePath: string): Map<string, string> => {\n const linkByGlibName: Map<string, string> = new Map();\n\n for (const entry of elements) {\n const directory = namespaceDirectory(entry.namespace);\n const link = `${basePath}/${directory}/${elementSlug(entry.klass.name)}`;\n\n if (linkByGlibName.values().some((existing) => existing === link)) {\n throw new Error(`Docs page slug collision for ${entry.glibName} at ${link}`);\n }\n\n linkByGlibName.set(entry.glibName, link);\n }\n\n return linkByGlibName;\n};\n\nconst namespacePages = (input: {\n name: string;\n elements: GlibNamedClass[];\n basePath: string;\n linkByGlibName: Map<string, string>;\n pageContext: ElementPageContext;\n}): NamespacePages => {\n const { name, elements, basePath, linkByGlibName, pageContext } = input;\n const directory = name.toLowerCase();\n\n const docs: DocsNamespace = {\n name,\n directory,\n link: `${basePath}/${directory}/`,\n elements: elements.map((entry) => ({ text: entry.glibName, link: linkByGlibName.get(entry.glibName) ?? \"\" })),\n };\n\n const pages: Page[] = elements.map((entry) => ({\n path: `${directory}/${elementSlug(entry.klass.name)}.md`,\n content: renderElementPage(entry, pageContext),\n }));\n\n pages.push({ path: `${directory}/index.md`, content: namespaceIndexPage(docs, elements) });\n\n return { docs, pages };\n};\n\nconst generatePages = (options: DocsOptions, basePath: string, library: Library): GeneratedDocs => {\n const intrinsicElements = collectIntrinsicElementClasses(library);\n const byNamespace = groupElementsByNamespace(intrinsicElements);\n const linkByGlibName = buildElementLinks(intrinsicElements, basePath);\n const pageContext = createElementPageContext(library, (glibName: string) => linkByGlibName.get(glibName));\n const pages: Page[] = [];\n const namespaces: DocsNamespace[] = [];\n const orderedNames = sortStringsBy(byNamespace.keys(), namespaceOrder);\n\n for (const name of orderedNames) {\n const elements = sortStringsBy(byNamespace.get(name) ?? [], (entry) => entry.glibName);\n const result = namespacePages({ name, elements, basePath, linkByGlibName, pageContext });\n pages.push(...result.pages);\n namespaces.push(result.docs);\n }\n\n pages.push({ path: \"index.md\", content: rootIndexPage(namespaces, options.libraries) });\n\n return { pages, namespaces };\n};\n\nconst cachedDocsResult = (options: DocsOptions, manifestPath: string): DocsResult | undefined => {\n if (options.force === true || !isGiStoreFresh(options.outDir, options.libraries, options.girPath)) {\n return undefined;\n }\n\n if (!existsSync(manifestPath)) {\n return undefined;\n }\n\n const manifest = JSON.parse(readFileSync(manifestPath, \"utf8\")) as DocsManifest;\n\n return { regenerated: false, namespaces: manifest.namespaces };\n};\n\nconst writePages = (outDir: string, pages: Page[]): void => {\n for (const page of pages) {\n const target = join(outDir, page.path);\n mkdirSync(dirname(target), { recursive: true });\n writeFileSync(target, page.content);\n }\n};\n\nconst writeDocs = (options: DocsOptions): DocsResult => {\n setElementProps(options.props ?? {});\n setOmittedProps(options.omitProps ?? {});\n const basePath = options.basePath ?? \"/reference\";\n const manifestPath = join(options.outDir, MANIFEST_FILENAME);\n const cached = cachedDocsResult(options, manifestPath);\n\n if (cached !== undefined) {\n return cached;\n }\n\n const library = Library.load(options.libraries, options.girPath);\n const { pages, namespaces } = generatePages(options, basePath, library);\n rmSync(options.outDir, { recursive: true, force: true });\n mkdirSync(options.outDir, { recursive: true });\n writePages(options.outDir, pages);\n const manifest: DocsManifest = { namespaces };\n writeFileSync(manifestPath, JSON.stringify(manifest));\n\n writeFileSync(\n join(options.outDir, FINGERPRINT_FILENAME),\n JSON.stringify(computeGiFingerprint(library.girFiles, options.libraries, options.girPath)),\n );\n\n return { regenerated: true, namespaces };\n};\n\nexport { writeDocs, type DocsElementLink, type DocsNamespace, type DocsOptions, type DocsResult };\n"]}
@@ -2,31 +2,33 @@ import type { GirClass } from "../gir/class.js";
2
2
  import type { GirFunction } from "../gir/function.js";
3
3
  import type { Library } from "../gir/library.js";
4
4
  import type { GirNamespace } from "../gir/namespace.js";
5
- import type { GirSignal } from "../gir/parameter.js";
5
+ import type { GirCallable } from "../gir/parameter.js";
6
6
  import type { TypeId } from "../gir/type-id.js";
7
7
  import { ModuleContext } from "../writer/context.js";
8
- export declare const renderDocsType: (library: Library, ref: TypeId | undefined, isNullable: boolean) => string;
9
- export declare const renderDocsSignalSignature: (library: Library, signal: GirSignal, selfType: string) => string;
10
- export declare const renderDocsSignalHandlerType: (library: Library, signal: GirSignal) => string;
11
- export declare const docsDefaultValue: (value: string) => string;
12
- export declare const docMarkdown: (doc: string | undefined) => string;
13
- export declare const firstSentence: (doc: string | undefined) => string;
14
- export declare const elementSlug: (className: string) => string;
15
- export declare const joinSections: (sections: string[]) => string;
16
- export declare const metaBlock: (name: string, meta: string, doc: string) => string;
17
- export declare const signatureBlock: (name: string, signature: string, notes: string[]) => string;
18
- export declare const namespaceOrder: (name: string) => string;
19
- export declare const docsSignatureContext: (namespace: GirNamespace, library: Library) => ModuleContext;
20
- export type SignatureEntry = {
8
+ type SignatureEntry = {
21
9
  name: string;
22
10
  signature: string;
23
11
  doc: string;
24
12
  };
25
- export type OriginSignatureEntry = SignatureEntry & {
13
+ type OriginSignatureEntry = SignatureEntry & {
26
14
  origin: string | undefined;
27
15
  };
28
- export declare const originSignatureBlocks: (entries: OriginSignatureEntry[]) => string[];
29
- export declare const classMethodEntries: (library: Library, namespace: GirNamespace, klass: GirClass) => SignatureEntry[];
30
- export declare const methodsSectionBlocks: (entries: SignatureEntry[], intro: string) => string[];
31
- export declare const instanceMethodEntries: (signatureContext: ModuleContext, methods: GirFunction[], rename: (fn: GirFunction) => string | undefined) => SignatureEntry[];
16
+ declare const renderDocsType: (library: Library, ref: TypeId | undefined, isNullable: boolean) => string;
17
+ declare const renderDocsSignalSignature: (library: Library, signal: GirCallable, selfType: string) => string;
18
+ declare const renderDocsSignalHandlerType: (library: Library, signal: GirCallable) => string;
19
+ declare const docsDefaultValue: (value: string) => string;
20
+ declare const docMarkdown: (doc: string | undefined) => string;
21
+ declare const firstSentence: (doc: string | undefined) => string;
22
+ declare const elementSlug: (className: string) => string;
23
+ declare const implementsLine: (names: string[]) => string[];
24
+ declare const joinSections: (sections: string[]) => string;
25
+ declare const metaBlock: (name: string, meta: string, doc: string) => string;
26
+ declare const signatureBlock: (name: string, signature: string, notes: string[]) => string;
27
+ declare const namespaceOrder: (name: string) => string;
28
+ declare const docsSignatureContext: (namespace: GirNamespace, library: Library) => ModuleContext;
29
+ declare const originSignatureBlocks: (entries: OriginSignatureEntry[]) => string[];
30
+ declare const classMethodEntries: (library: Library, namespace: GirNamespace, klass: GirClass) => SignatureEntry[];
31
+ declare const methodsSectionBlocks: (entries: SignatureEntry[], intro: string) => string[];
32
+ declare const instanceMethodEntries: (signatureContext: ModuleContext, klass: GirClass, rename: (fn: GirFunction) => string | undefined) => SignatureEntry[];
33
+ export { renderDocsType, renderDocsSignalSignature, renderDocsSignalHandlerType, docsDefaultValue, docMarkdown, firstSentence, elementSlug, implementsLine, joinSections, metaBlock, signatureBlock, namespaceOrder, docsSignatureContext, originSignatureBlocks, classMethodEntries, methodsSectionBlocks, instanceMethodEntries, type SignatureEntry, type OriginSignatureEntry, };
32
34
  //# sourceMappingURL=render.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"render.d.ts","sourceRoot":"","sources":["../../src/docs/render.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AACjD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AACxD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AACrD,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAGhD,OAAO,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AAkBrD,eAAO,MAAM,cAAc,YAAa,OAAO,OAAO,MAAM,GAAG,SAAS,cAAc,OAAO,KAAG,MAG/F,CAAC;AAcF,eAAO,MAAM,yBAAyB,YAAa,OAAO,UAAU,SAAS,YAAY,MAAM,KAAG,MAGjG,CAAC;AAEF,eAAO,MAAM,2BAA2B,YAAa,OAAO,UAAU,SAAS,KAAG,MACmC,CAAC;AAItH,eAAO,MAAM,gBAAgB,UAAW,MAAM,KAAG,MAA6C,CAAC;AAuB/F,eAAO,MAAM,WAAW,QAAS,MAAM,GAAG,SAAS,KAAG,MACsD,CAAC;AAW7G,eAAO,MAAM,aAAa,QAAS,MAAM,GAAG,SAAS,KAAG,MAMvD,CAAC;AAEF,eAAO,MAAM,WAAW,cAAe,MAAM,KAAG,MAI1B,CAAC;AAEvB,eAAO,MAAM,YAAY,aAAc,MAAM,EAAE,KAAG,MACsB,CAAC;AAEzE,eAAO,MAAM,SAAS,SAAU,MAAM,QAAQ,MAAM,OAAO,MAAM,KAAG,MAInE,CAAC;AAEF,eAAO,MAAM,cAAc,SAAU,MAAM,aAAa,MAAM,SAAS,MAAM,EAAE,KAAG,MAMjF,CAAC;AAIF,eAAO,MAAM,cAAc,SAAU,MAAM,KAAG,MAG7C,CAAC;AAIF,eAAO,MAAM,oBAAoB,cAAe,YAAY,WAAW,OAAO,KAAG,aACD,CAAC;AAEjF,MAAM,MAAM,cAAc,GAAG;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,MAAM,CAAC;IAClB,GAAG,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG,cAAc,GAAG;IAAE,MAAM,EAAE,MAAM,GAAG,SAAS,CAAA;CAAE,CAAC;AAEnF,eAAO,MAAM,qBAAqB,YAAa,oBAAoB,EAAE,KAAG,MAAM,EAMzE,CAAC;AAEN,eAAO,MAAM,kBAAkB,YAAa,OAAO,aAAa,YAAY,SAAS,QAAQ,KAAG,cAAc,EAQ7G,CAAC;AAEF,eAAO,MAAM,oBAAoB,YAAa,cAAc,EAAE,SAAS,MAAM,KAAG,MAAM,EAG0B,CAAC;AAEjH,eAAO,MAAM,qBAAqB,qBACZ,aAAa,WACtB,WAAW,EAAE,UACd,CAAC,EAAE,EAAE,WAAW,KAAK,MAAM,GAAG,SAAS,KAChD,cAAc,EAoBhB,CAAC"}
1
+ {"version":3,"file":"render.d.ts","sourceRoot":"","sources":["../../src/docs/render.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AACjD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AACxD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AACvD,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAMhD,OAAO,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AAGrD,KAAK,cAAc,GAAG;IAClB,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,MAAM,CAAC;IAClB,GAAG,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,KAAK,oBAAoB,GAAG,cAAc,GAAG;IAAE,MAAM,EAAE,MAAM,GAAG,SAAS,CAAA;CAAE,CAAC;AAe5E,QAAA,MAAM,cAAc,GAAI,SAAS,OAAO,EAAE,KAAK,MAAM,GAAG,SAAS,EAAE,YAAY,OAAO,KAAG,MAIxF,CAAC;AAcF,QAAA,MAAM,yBAAyB,GAAI,SAAS,OAAO,EAAE,QAAQ,WAAW,EAAE,UAAU,MAAM,KAAG,MAI5F,CAAC;AAEF,QAAA,MAAM,2BAA2B,GAAI,SAAS,OAAO,EAAE,QAAQ,WAAW,KAAG,MACwC,CAAC;AAEtH,QAAA,MAAM,gBAAgB,GAAI,OAAO,MAAM,KAAG,MAA6C,CAAC;AAiCxF,QAAA,MAAM,WAAW,GAAI,KAAK,MAAM,GAAG,SAAS,KAAG,MAC6D,CAAC;AAW7G,QAAA,MAAM,aAAa,GAAI,KAAK,MAAM,GAAG,SAAS,KAAG,MAWhD,CAAC;AAEF,QAAA,MAAM,WAAW,GAAI,WAAW,MAAM,KAAG,MAInB,CAAC;AAEvB,QAAA,MAAM,cAAc,GAAI,OAAO,MAAM,EAAE,KAAG,MAAM,EAQ/C,CAAC;AAEF,QAAA,MAAM,YAAY,GAAI,UAAU,MAAM,EAAE,KAAG,MAC6B,CAAC;AAEzE,QAAA,MAAM,SAAS,GAAI,MAAM,MAAM,EAAE,MAAM,MAAM,EAAE,KAAK,MAAM,KAAG,MAQ5D,CAAC;AAEF,QAAA,MAAM,cAAc,GAAI,MAAM,MAAM,EAAE,WAAW,MAAM,EAAE,OAAO,MAAM,EAAE,KAAG,MAU1E,CAAC;AAEF,QAAA,MAAM,cAAc,GAAI,MAAM,MAAM,KAAG,MAItC,CAAC;AAEF,QAAA,MAAM,oBAAoB,GAAI,WAAW,YAAY,EAAE,SAAS,OAAO,KAAG,aACM,CAAC;AAEjF,QAAA,MAAM,qBAAqB,GAAI,SAAS,oBAAoB,EAAE,KAAG,MAAM,EAMlE,CAAC;AAEN,QAAA,MAAM,kBAAkB,GAAI,SAAS,OAAO,EAAE,WAAW,YAAY,EAAE,OAAO,QAAQ,KAAG,cAAc,EAStG,CAAC;AAEF,QAAA,MAAM,oBAAoB,GAAI,SAAS,cAAc,EAAE,EAAE,OAAO,MAAM,KAAG,MAAM,EAGiC,CAAC;AAEjH,QAAA,MAAM,qBAAqB,GACvB,kBAAkB,aAAa,EAC/B,OAAO,QAAQ,EACf,QAAQ,CAAC,EAAE,EAAE,WAAW,KAAK,MAAM,GAAG,SAAS,KAChD,cAAc,EAiChB,CAAC;AAEF,OAAO,EACH,cAAc,EACd,yBAAyB,EACzB,2BAA2B,EAC3B,gBAAgB,EAChB,WAAW,EACX,aAAa,EACb,WAAW,EACX,cAAc,EACd,YAAY,EACZ,SAAS,EACT,cAAc,EACd,cAAc,EACd,oBAAoB,EACpB,qBAAqB,EACrB,kBAAkB,EAClB,oBAAoB,EACpB,qBAAqB,EACrB,KAAK,cAAc,EACnB,KAAK,oBAAoB,GAC5B,CAAC"}
@@ -1,27 +1,19 @@
1
- import { sortStringsBy, toPascalCase } from "@gtkx/utils";
1
+ import { pascalCase, sortStringsBy } from "@gtkx/utils";
2
2
  import { collectInheritedMethods, conflictRename } from "../analysis/inheritance.js";
3
3
  import { renderHandlerParameters, renderHandlerResultType } from "../analysis/param-structure.js";
4
- import { renderBaseTypeFor } from "../analysis/ts-type.js";
5
- import { dedupeCallables, indexMethodsByName, renderInstanceMethodSignature } from "../store/gi/callables.js";
4
+ import { recordTypeTarget, renderBaseType } from "../analysis/ts-type.js";
5
+ import { dedupeCallables, instanceScope, renderInstanceMethodSignature } from "../store/gi/callables.js";
6
6
  import { methodExportName } from "../store/gi/method.js";
7
7
  import { ModuleContext } from "../writer/context.js";
8
8
  import { gtkDocToMarkdown } from "../writer/gtk-doc.js";
9
- const docsTarget = (library) => ({
10
- containerStyle: "record",
11
- callbackType: "((...args: unknown[]) => unknown)",
12
- byteArrayAsNumber: false,
13
- renderNamed: (resolved, name) => {
14
- if (resolved?.kind === "alias") {
15
- return resolved.value.target === undefined
16
- ? "number"
17
- : renderBaseTypeFor(library, docsTarget(library), resolved.value.target);
18
- }
19
- return `${name.namespaceName}.${name.typeName}`;
20
- },
21
- renderGtype: () => "GObject.Type",
22
- });
23
- export const renderDocsType = (library, ref, isNullable) => {
24
- const base = renderBaseTypeFor(library, docsTarget(library), ref);
9
+ const DOCS_DEFAULT_VALUES = { TRUE: "true", FALSE: "false", NULL: "null" };
10
+ const FENCE_LINE = /^\s*(```|~~~)/;
11
+ const HEADING_LINE = /^#{1,5}\s/;
12
+ const LEADING_NAMESPACES = ["Gtk", "Adw"];
13
+ const DOCS_SIGNATURE_NAMESPACE = "$docs";
14
+ const docsTarget = (library) => recordTypeTarget(library, (name) => `${name.namespaceName}.${name.typeName}`, () => "GObject.Type");
15
+ const renderDocsType = (library, ref, isNullable) => {
16
+ const base = renderBaseType(library, docsTarget(library), ref);
25
17
  return isNullable ? `${base} | null` : base;
26
18
  };
27
19
  const renderDocsHandlerResultType = (library, signal) => renderHandlerResultType({
@@ -32,97 +24,113 @@ const renderDocsHandlerResultType = (library, signal) => renderHandlerResultType
32
24
  optOut: true,
33
25
  });
34
26
  const renderDocsHandlerParameters = (library, signal) => renderHandlerParameters(signal.parameters, (ref, nullable) => renderDocsType(library, ref, nullable));
35
- export const renderDocsSignalSignature = (library, signal, selfType) => {
27
+ const renderDocsSignalSignature = (library, signal, selfType) => {
36
28
  const params = [...renderDocsHandlerParameters(library, signal), `self: ${selfType}`];
37
29
  return `(${params.join(", ")}) => ${renderDocsHandlerResultType(library, signal)}`;
38
30
  };
39
- export const renderDocsSignalHandlerType = (library, signal) => `(${renderDocsHandlerParameters(library, signal).join(", ")}) => ${renderDocsHandlerResultType(library, signal)}`;
40
- const DOCS_DEFAULT_VALUES = { TRUE: "true", FALSE: "false", NULL: "null" };
41
- export const docsDefaultValue = (value) => DOCS_DEFAULT_VALUES[value] ?? value;
31
+ const renderDocsSignalHandlerType = (library, signal) => `(${renderDocsHandlerParameters(library, signal).join(", ")}) => ${renderDocsHandlerResultType(library, signal)}`;
32
+ const docsDefaultValue = (value) => DOCS_DEFAULT_VALUES[value] ?? value;
42
33
  const stripDocMedia = (markdown) => markdown
43
- .replace(/<picture[\s\S]*?<\/picture>/g, "")
44
- .replace(/<video[\s\S]*?(?:<\/video>|\/>)/g, "")
45
- .replace(/<img[^>]*>/g, "");
34
+ .replaceAll(/<picture[\s\S]*?<\/picture>/g, "")
35
+ .replaceAll(/<video[\s\S]*?(?:<\/video>|\/>)/g, "")
36
+ .replaceAll(/<img[^>]*>/g, "");
37
+ const demoteLine = (line, isInFence) => {
38
+ if (FENCE_LINE.test(line)) {
39
+ return { text: line, inFence: !isInFence };
40
+ }
41
+ if (isInFence) {
42
+ return { text: line, inFence: isInFence };
43
+ }
44
+ return { text: HEADING_LINE.test(line) ? `#${line}` : line, inFence: isInFence };
45
+ };
46
46
  const demoteHeadings = (markdown) => {
47
- let inFence = false;
48
- return markdown
49
- .split("\n")
50
- .map((line) => {
51
- if (/^\s*(```|~~~)/.test(line)) {
52
- inFence = !inFence;
53
- return line;
54
- }
55
- if (inFence)
56
- return line;
57
- return /^#{1,5}\s/.test(line) ? `#${line}` : line;
58
- })
59
- .join("\n");
47
+ let isInFence = false;
48
+ const lines = [];
49
+ for (const line of markdown.split("\n")) {
50
+ const result = demoteLine(line, isInFence);
51
+ isInFence = result.inFence;
52
+ lines.push(result.text);
53
+ }
54
+ return lines.join("\n");
60
55
  };
61
- export const docMarkdown = (doc) => doc === undefined || doc.length === 0 ? "" : demoteHeadings(stripDocMedia(gtkDocToMarkdown(doc))).trim();
56
+ const docMarkdown = (doc) => doc === undefined || doc.length === 0 ? "" : demoteHeadings(stripDocMedia(gtkDocToMarkdown(doc))).trim();
62
57
  const stripMarkdown = (markdown) => markdown
63
- .replace(/```[\s\S]*?```/g, " ")
64
- .replace(/`([^`]*)`/g, "$1")
65
- .replace(/\[([^\]]*)\]\([^)]*\)/g, "$1")
66
- .replace(/[*_#>]/g, "")
67
- .replace(/\s+/g, " ")
58
+ .replaceAll(/```[\s\S]*?```/g, " ")
59
+ .replaceAll(/`([^`]*)`/g, "$1")
60
+ .replaceAll(/\[([^[\]]*)\]\([^)]*\)/g, "$1")
61
+ .replaceAll(/[*_#>]/g, "")
62
+ .replaceAll(/\s+/g, " ")
68
63
  .trim();
69
- export const firstSentence = (doc) => {
64
+ const firstSentence = (doc) => {
70
65
  const text = stripMarkdown(docMarkdown(doc));
71
- if (text.length === 0)
66
+ if (text.length === 0) {
72
67
  return "";
73
- const match = text.match(/^.*?[.!?](?=\s|$)/);
68
+ }
69
+ const match = /^.*?[.!?](?=\s|$)/.exec(text);
74
70
  const sentence = match?.[0] ?? text;
75
71
  return sentence.length > 220 ? `${sentence.slice(0, 217)}...` : sentence;
76
72
  };
77
- export const elementSlug = (className) => className
78
- .replace(/([a-z0-9])([A-Z])/g, "$1-$2")
79
- .replace(/([A-Z]+)([A-Z][a-z])/g, "$1-$2")
73
+ const elementSlug = (className) => className
74
+ .replaceAll(/([a-z0-9])([A-Z])/g, "$1-$2")
75
+ .replaceAll(/([A-Z])(?=[A-Z][a-z])/g, "$1-")
80
76
  .toLowerCase();
81
- export const joinSections = (sections) => `${sections.filter((section) => section.length > 0).join("\n\n")}\n`;
82
- export const metaBlock = (name, meta, doc) => {
77
+ const implementsLine = (names) => {
78
+ if (names.length === 0) {
79
+ return [];
80
+ }
81
+ const quotedNames = names.map((name) => `\`${name}\``).join(", ");
82
+ return [`Implements ${quotedNames}.`];
83
+ };
84
+ const joinSections = (sections) => `${sections.filter((section) => section.length > 0).join("\n\n")}\n`;
85
+ const metaBlock = (name, meta, doc) => {
83
86
  const lines = [`### \`${name}\``, "", meta];
84
- if (doc.length > 0)
87
+ if (doc.length > 0) {
85
88
  lines.push("", doc);
89
+ }
86
90
  return lines.join("\n");
87
91
  };
88
- export const signatureBlock = (name, signature, notes) => {
92
+ const signatureBlock = (name, signature, notes) => {
89
93
  const lines = [`### \`${name}\``, "", `\`\`\`ts\n${signature}\n\`\`\``];
90
94
  for (const note of notes) {
91
- if (note.length > 0)
95
+ if (note.length > 0) {
92
96
  lines.push("", note);
97
+ }
93
98
  }
94
99
  return lines.join("\n");
95
100
  };
96
- const LEADING_NAMESPACES = ["Gtk", "Adw"];
97
- export const namespaceOrder = (name) => {
101
+ const namespaceOrder = (name) => {
98
102
  const index = LEADING_NAMESPACES.indexOf(name);
99
- return index === -1 ? `1${name}` : `0${index}`;
103
+ return index === -1 ? `1${name}` : `0${String(index)}`;
100
104
  };
101
- const DOCS_SIGNATURE_NAMESPACE = "$docs";
102
- export const docsSignatureContext = (namespace, library) => new ModuleContext({ ...namespace, name: DOCS_SIGNATURE_NAMESPACE }, library);
103
- export const originSignatureBlocks = (entries) => sortStringsBy(entries, (item) => item.name).map((item) => signatureBlock(item.name, item.signature, [
105
+ const docsSignatureContext = (namespace, library) => new ModuleContext({ ...namespace, name: DOCS_SIGNATURE_NAMESPACE }, library);
106
+ const originSignatureBlocks = (entries) => sortStringsBy(entries, (item) => item.name).map((item) => signatureBlock(item.name, item.signature, [
104
107
  item.origin === undefined ? "" : `From \`${item.origin}\`.`,
105
108
  item.doc,
106
109
  ]));
107
- export const classMethodEntries = (library, namespace, klass) => {
110
+ const classMethodEntries = (library, namespace, klass) => {
108
111
  const realContext = new ModuleContext(namespace, library);
109
112
  const signatureContext = docsSignatureContext(namespace, library);
110
- const className = toPascalCase(klass.name);
113
+ const className = pascalCase(klass.name);
111
114
  const inherited = collectInheritedMethods(realContext, klass);
112
- return instanceMethodEntries(signatureContext, klass.methods, (method) => conflictRename(realContext, method, inherited, className));
115
+ return instanceMethodEntries(signatureContext, klass, (method) => conflictRename(realContext, method, inherited, className));
113
116
  };
114
- export const methodsSectionBlocks = (entries, intro) => entries.length === 0
117
+ const methodsSectionBlocks = (entries, intro) => entries.length === 0
115
118
  ? []
116
119
  : ["## Methods", intro, ...entries.map((item) => signatureBlock(item.name, item.signature, [item.doc]))];
117
- export const instanceMethodEntries = (signatureContext, methods, rename) => {
118
- const deduped = dedupeCallables(methods);
119
- const siblings = indexMethodsByName(deduped);
120
+ const instanceMethodEntries = (signatureContext, klass, rename) => {
121
+ const deduped = dedupeCallables(klass.methods);
122
+ const scope = instanceScope(pascalCase(klass.name), {
123
+ constructors: dedupeCallables(klass.constructors),
124
+ functions: dedupeCallables(klass.functions),
125
+ methods: deduped,
126
+ });
120
127
  const entries = [];
121
128
  for (const method of deduped) {
122
129
  const nameOverride = rename(method);
123
- const rendered = renderInstanceMethodSignature(signatureContext, { ...method, doc: undefined }, siblings, nameOverride);
124
- if (rendered === undefined)
130
+ const rendered = renderInstanceMethodSignature(signatureContext, { ...method, doc: undefined }, scope, nameOverride);
131
+ if (rendered === undefined) {
125
132
  continue;
133
+ }
126
134
  entries.push({
127
135
  name: nameOverride ?? methodExportName(method),
128
136
  signature: rendered.trim().replace(/;$/, ""),
@@ -131,4 +139,5 @@ export const instanceMethodEntries = (signatureContext, methods, rename) => {
131
139
  }
132
140
  return sortStringsBy(entries, (entry) => entry.name);
133
141
  };
142
+ export { renderDocsType, renderDocsSignalSignature, renderDocsSignalHandlerType, docsDefaultValue, docMarkdown, firstSentence, elementSlug, implementsLine, joinSections, metaBlock, signatureBlock, namespaceOrder, docsSignatureContext, originSignatureBlocks, classMethodEntries, methodsSectionBlocks, instanceMethodEntries, };
134
143
  //# sourceMappingURL=render.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"render.js","sourceRoot":"","sources":["../../src/docs/render.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAC1D,OAAO,EAAE,uBAAuB,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AACrF,OAAO,EAAE,uBAAuB,EAAE,uBAAuB,EAAE,MAAM,gCAAgC,CAAC;AAClG,OAAO,EAAE,iBAAiB,EAAqB,MAAM,wBAAwB,CAAC;AAO9E,OAAO,EAAE,eAAe,EAAE,kBAAkB,EAAE,6BAA6B,EAAE,MAAM,0BAA0B,CAAC;AAC9G,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AACzD,OAAO,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AACrD,OAAO,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AAExD,MAAM,UAAU,GAAG,CAAC,OAAgB,EAAgB,EAAE,CAAC,CAAC;IACpD,cAAc,EAAE,QAAQ;IACxB,YAAY,EAAE,mCAAmC;IACjD,iBAAiB,EAAE,KAAK;IACxB,WAAW,EAAE,CAAC,QAAQ,EAAE,IAAI,EAAE,EAAE;QAC5B,IAAI,QAAQ,EAAE,IAAI,KAAK,OAAO,EAAE,CAAC;YAC7B,OAAO,QAAQ,CAAC,KAAK,CAAC,MAAM,KAAK,SAAS;gBACtC,CAAC,CAAC,QAAQ;gBACV,CAAC,CAAC,iBAAiB,CAAC,OAAO,EAAE,UAAU,CAAC,OAAO,CAAC,EAAE,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QACjF,CAAC;QACD,OAAO,GAAG,IAAI,CAAC,aAAa,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;IACpD,CAAC;IACD,WAAW,EAAE,GAAG,EAAE,CAAC,cAAc;CACpC,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,OAAgB,EAAE,GAAuB,EAAE,UAAmB,EAAU,EAAE;IACrG,MAAM,IAAI,GAAG,iBAAiB,CAAC,OAAO,EAAE,UAAU,CAAC,OAAO,CAAC,EAAE,GAAG,CAAC,CAAC;IAClE,OAAO,UAAU,CAAC,CAAC,CAAC,GAAG,IAAI,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC;AAChD,CAAC,CAAC;AAEF,MAAM,2BAA2B,GAAG,CAAC,OAAgB,EAAE,MAAiB,EAAU,EAAE,CAChF,uBAAuB,CAAC;IACpB,OAAO;IACP,MAAM;IACN,UAAU,EAAE,CAAC,GAAG,EAAE,QAAQ,EAAE,EAAE,CAAC,cAAc,CAAC,OAAO,EAAE,GAAG,EAAE,QAAQ,CAAC;IACrE,sBAAsB,EAAE,KAAK;IAC7B,MAAM,EAAE,IAAI;CACf,CAAC,CAAC;AAEP,MAAM,2BAA2B,GAAG,CAAC,OAAgB,EAAE,MAAiB,EAAY,EAAE,CAClF,uBAAuB,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC,GAAG,EAAE,QAAQ,EAAE,EAAE,CAAC,cAAc,CAAC,OAAO,EAAE,GAAG,EAAE,QAAQ,CAAC,CAAC,CAAC;AAE1G,MAAM,CAAC,MAAM,yBAAyB,GAAG,CAAC,OAAgB,EAAE,MAAiB,EAAE,QAAgB,EAAU,EAAE;IACvG,MAAM,MAAM,GAAG,CAAC,GAAG,2BAA2B,CAAC,OAAO,EAAE,MAAM,CAAC,EAAE,SAAS,QAAQ,EAAE,CAAC,CAAC;IACtF,OAAO,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,2BAA2B,CAAC,OAAO,EAAE,MAAM,CAAC,EAAE,CAAC;AACvF,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,2BAA2B,GAAG,CAAC,OAAgB,EAAE,MAAiB,EAAU,EAAE,CACvF,IAAI,2BAA2B,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,2BAA2B,CAAC,OAAO,EAAE,MAAM,CAAC,EAAE,CAAC;AAEtH,MAAM,mBAAmB,GAA2B,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;AAEnG,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,KAAa,EAAU,EAAE,CAAC,mBAAmB,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC;AAE/F,MAAM,aAAa,GAAG,CAAC,QAAgB,EAAU,EAAE,CAC/C,QAAQ;KACH,OAAO,CAAC,8BAA8B,EAAE,EAAE,CAAC;KAC3C,OAAO,CAAC,kCAAkC,EAAE,EAAE,CAAC;KAC/C,OAAO,CAAC,aAAa,EAAE,EAAE,CAAC,CAAC;AAEpC,MAAM,cAAc,GAAG,CAAC,QAAgB,EAAU,EAAE;IAChD,IAAI,OAAO,GAAG,KAAK,CAAC;IACpB,OAAO,QAAQ;SACV,KAAK,CAAC,IAAI,CAAC;SACX,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;QACV,IAAI,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;YAC7B,OAAO,GAAG,CAAC,OAAO,CAAC;YACnB,OAAO,IAAI,CAAC;QAChB,CAAC;QACD,IAAI,OAAO;YAAE,OAAO,IAAI,CAAC;QACzB,OAAO,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC;IACtD,CAAC,CAAC;SACD,IAAI,CAAC,IAAI,CAAC,CAAC;AACpB,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,GAAuB,EAAU,EAAE,CAC3D,GAAG,KAAK,SAAS,IAAI,GAAG,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,cAAc,CAAC,aAAa,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;AAE7G,MAAM,aAAa,GAAG,CAAC,QAAgB,EAAU,EAAE,CAC/C,QAAQ;KACH,OAAO,CAAC,iBAAiB,EAAE,GAAG,CAAC;KAC/B,OAAO,CAAC,YAAY,EAAE,IAAI,CAAC;KAC3B,OAAO,CAAC,wBAAwB,EAAE,IAAI,CAAC;KACvC,OAAO,CAAC,SAAS,EAAE,EAAE,CAAC;KACtB,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC;KACpB,IAAI,EAAE,CAAC;AAEhB,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,GAAuB,EAAU,EAAE;IAC7D,MAAM,IAAI,GAAG,aAAa,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC;IAC7C,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,EAAE,CAAC;IACjC,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,mBAAmB,CAAC,CAAC;IAC9C,MAAM,QAAQ,GAAG,KAAK,EAAE,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC;IACpC,OAAO,QAAQ,CAAC,MAAM,GAAG,GAAG,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC,EAAE,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,QAAQ,CAAC;AAC7E,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,SAAiB,EAAU,EAAE,CACrD,SAAS;KACJ,OAAO,CAAC,oBAAoB,EAAE,OAAO,CAAC;KACtC,OAAO,CAAC,uBAAuB,EAAE,OAAO,CAAC;KACzC,WAAW,EAAE,CAAC;AAEvB,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,QAAkB,EAAU,EAAE,CACvD,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC;AAEzE,MAAM,CAAC,MAAM,SAAS,GAAG,CAAC,IAAY,EAAE,IAAY,EAAE,GAAW,EAAU,EAAE;IACzE,MAAM,KAAK,GAAG,CAAC,SAAS,IAAI,IAAI,EAAE,EAAE,EAAE,IAAI,CAAC,CAAC;IAC5C,IAAI,GAAG,CAAC,MAAM,GAAG,CAAC;QAAE,KAAK,CAAC,IAAI,CAAC,EAAE,EAAE,GAAG,CAAC,CAAC;IACxC,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC5B,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,IAAY,EAAE,SAAiB,EAAE,KAAe,EAAU,EAAE;IACvF,MAAM,KAAK,GAAG,CAAC,SAAS,IAAI,IAAI,EAAE,EAAE,EAAE,aAAa,SAAS,UAAU,CAAC,CAAC;IACxE,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACvB,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC;YAAE,KAAK,CAAC,IAAI,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC;IAC9C,CAAC;IACD,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC5B,CAAC,CAAC;AAEF,MAAM,kBAAkB,GAAG,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;AAE1C,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,IAAY,EAAU,EAAE;IACnD,MAAM,KAAK,GAAG,kBAAkB,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IAC/C,OAAO,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,EAAE,CAAC;AACnD,CAAC,CAAC;AAEF,MAAM,wBAAwB,GAAG,OAAO,CAAC;AAEzC,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,SAAuB,EAAE,OAAgB,EAAiB,EAAE,CAC7F,IAAI,aAAa,CAAC,EAAE,GAAG,SAAS,EAAE,IAAI,EAAE,wBAAwB,EAAE,EAAE,OAAO,CAAC,CAAC;AAUjF,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAAC,OAA+B,EAAY,EAAE,CAC/E,aAAa,CAAC,OAAO,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CACrD,cAAc,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,SAAS,EAAE;IACtC,IAAI,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,UAAU,IAAI,CAAC,MAAM,KAAK;IAC3D,IAAI,CAAC,GAAG;CACX,CAAC,CACL,CAAC;AAEN,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,OAAgB,EAAE,SAAuB,EAAE,KAAe,EAAoB,EAAE;IAC/G,MAAM,WAAW,GAAG,IAAI,aAAa,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;IAC1D,MAAM,gBAAgB,GAAG,oBAAoB,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;IAClE,MAAM,SAAS,GAAG,YAAY,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAC3C,MAAM,SAAS,GAAG,uBAAuB,CAAC,WAAW,EAAE,KAAK,CAAC,CAAC;IAC9D,OAAO,qBAAqB,CAAC,gBAAgB,EAAE,KAAK,CAAC,OAAO,EAAE,CAAC,MAAM,EAAE,EAAE,CACrE,cAAc,CAAC,WAAW,EAAE,MAAM,EAAE,SAAS,EAAE,SAAS,CAAC,CAC5D,CAAC;AACN,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,OAAyB,EAAE,KAAa,EAAY,EAAE,CACvF,OAAO,CAAC,MAAM,KAAK,CAAC;IAChB,CAAC,CAAC,EAAE;IACJ,CAAC,CAAC,CAAC,YAAY,EAAE,KAAK,EAAE,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,SAAS,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;AAEjH,MAAM,CAAC,MAAM,qBAAqB,GAAG,CACjC,gBAA+B,EAC/B,OAAsB,EACtB,MAA+C,EAC/B,EAAE;IAClB,MAAM,OAAO,GAAG,eAAe,CAAC,OAAO,CAAC,CAAC;IACzC,MAAM,QAAQ,GAAG,kBAAkB,CAAC,OAAO,CAAC,CAAC;IAC7C,MAAM,OAAO,GAAqB,EAAE,CAAC;IACrC,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;QAC3B,MAAM,YAAY,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC;QACpC,MAAM,QAAQ,GAAG,6BAA6B,CAC1C,gBAAgB,EAChB,EAAE,GAAG,MAAM,EAAE,GAAG,EAAE,SAAS,EAAE,EAC7B,QAAQ,EACR,YAAY,CACf,CAAC;QACF,IAAI,QAAQ,KAAK,SAAS;YAAE,SAAS;QACrC,OAAO,CAAC,IAAI,CAAC;YACT,IAAI,EAAE,YAAY,IAAI,gBAAgB,CAAC,MAAM,CAAC;YAC9C,SAAS,EAAE,QAAQ,CAAC,IAAI,EAAE,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC;YAC5C,GAAG,EAAE,WAAW,CAAC,MAAM,CAAC,GAAG,CAAC;SAC/B,CAAC,CAAC;IACP,CAAC;IACD,OAAO,aAAa,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;AACzD,CAAC,CAAC","sourcesContent":["import { sortStringsBy, toPascalCase } from \"@gtkx/utils\";\nimport { collectInheritedMethods, conflictRename } from \"../analysis/inheritance.js\";\nimport { renderHandlerParameters, renderHandlerResultType } from \"../analysis/param-structure.js\";\nimport { renderBaseTypeFor, type TsTypeTarget } from \"../analysis/ts-type.js\";\nimport type { GirClass } from \"../gir/class.js\";\nimport type { GirFunction } from \"../gir/function.js\";\nimport type { Library } from \"../gir/library.js\";\nimport type { GirNamespace } from \"../gir/namespace.js\";\nimport type { GirSignal } from \"../gir/parameter.js\";\nimport type { TypeId } from \"../gir/type-id.js\";\nimport { dedupeCallables, indexMethodsByName, renderInstanceMethodSignature } from \"../store/gi/callables.js\";\nimport { methodExportName } from \"../store/gi/method.js\";\nimport { ModuleContext } from \"../writer/context.js\";\nimport { gtkDocToMarkdown } from \"../writer/gtk-doc.js\";\n\nconst docsTarget = (library: Library): TsTypeTarget => ({\n containerStyle: \"record\",\n callbackType: \"((...args: unknown[]) => unknown)\",\n byteArrayAsNumber: false,\n renderNamed: (resolved, name) => {\n if (resolved?.kind === \"alias\") {\n return resolved.value.target === undefined\n ? \"number\"\n : renderBaseTypeFor(library, docsTarget(library), resolved.value.target);\n }\n return `${name.namespaceName}.${name.typeName}`;\n },\n renderGtype: () => \"GObject.Type\",\n});\n\nexport const renderDocsType = (library: Library, ref: TypeId | undefined, isNullable: boolean): string => {\n const base = renderBaseTypeFor(library, docsTarget(library), ref);\n return isNullable ? `${base} | null` : base;\n};\n\nconst renderDocsHandlerResultType = (library: Library, signal: GirSignal): string =>\n renderHandlerResultType({\n library,\n signal,\n renderType: (ref, nullable) => renderDocsType(library, ref, nullable),\n includeCallerAllocated: false,\n optOut: true,\n });\n\nconst renderDocsHandlerParameters = (library: Library, signal: GirSignal): string[] =>\n renderHandlerParameters(signal.parameters, (ref, nullable) => renderDocsType(library, ref, nullable));\n\nexport const renderDocsSignalSignature = (library: Library, signal: GirSignal, selfType: string): string => {\n const params = [...renderDocsHandlerParameters(library, signal), `self: ${selfType}`];\n return `(${params.join(\", \")}) => ${renderDocsHandlerResultType(library, signal)}`;\n};\n\nexport const renderDocsSignalHandlerType = (library: Library, signal: GirSignal): string =>\n `(${renderDocsHandlerParameters(library, signal).join(\", \")}) => ${renderDocsHandlerResultType(library, signal)}`;\n\nconst DOCS_DEFAULT_VALUES: Record<string, string> = { TRUE: \"true\", FALSE: \"false\", NULL: \"null\" };\n\nexport const docsDefaultValue = (value: string): string => DOCS_DEFAULT_VALUES[value] ?? value;\n\nconst stripDocMedia = (markdown: string): string =>\n markdown\n .replace(/<picture[\\s\\S]*?<\\/picture>/g, \"\")\n .replace(/<video[\\s\\S]*?(?:<\\/video>|\\/>)/g, \"\")\n .replace(/<img[^>]*>/g, \"\");\n\nconst demoteHeadings = (markdown: string): string => {\n let inFence = false;\n return markdown\n .split(\"\\n\")\n .map((line) => {\n if (/^\\s*(```|~~~)/.test(line)) {\n inFence = !inFence;\n return line;\n }\n if (inFence) return line;\n return /^#{1,5}\\s/.test(line) ? `#${line}` : line;\n })\n .join(\"\\n\");\n};\n\nexport const docMarkdown = (doc: string | undefined): string =>\n doc === undefined || doc.length === 0 ? \"\" : demoteHeadings(stripDocMedia(gtkDocToMarkdown(doc))).trim();\n\nconst stripMarkdown = (markdown: string): string =>\n markdown\n .replace(/```[\\s\\S]*?```/g, \" \")\n .replace(/`([^`]*)`/g, \"$1\")\n .replace(/\\[([^\\]]*)\\]\\([^)]*\\)/g, \"$1\")\n .replace(/[*_#>]/g, \"\")\n .replace(/\\s+/g, \" \")\n .trim();\n\nexport const firstSentence = (doc: string | undefined): string => {\n const text = stripMarkdown(docMarkdown(doc));\n if (text.length === 0) return \"\";\n const match = text.match(/^.*?[.!?](?=\\s|$)/);\n const sentence = match?.[0] ?? text;\n return sentence.length > 220 ? `${sentence.slice(0, 217)}...` : sentence;\n};\n\nexport const elementSlug = (className: string): string =>\n className\n .replace(/([a-z0-9])([A-Z])/g, \"$1-$2\")\n .replace(/([A-Z]+)([A-Z][a-z])/g, \"$1-$2\")\n .toLowerCase();\n\nexport const joinSections = (sections: string[]): string =>\n `${sections.filter((section) => section.length > 0).join(\"\\n\\n\")}\\n`;\n\nexport const metaBlock = (name: string, meta: string, doc: string): string => {\n const lines = [`### \\`${name}\\``, \"\", meta];\n if (doc.length > 0) lines.push(\"\", doc);\n return lines.join(\"\\n\");\n};\n\nexport const signatureBlock = (name: string, signature: string, notes: string[]): string => {\n const lines = [`### \\`${name}\\``, \"\", `\\`\\`\\`ts\\n${signature}\\n\\`\\`\\``];\n for (const note of notes) {\n if (note.length > 0) lines.push(\"\", note);\n }\n return lines.join(\"\\n\");\n};\n\nconst LEADING_NAMESPACES = [\"Gtk\", \"Adw\"];\n\nexport const namespaceOrder = (name: string): string => {\n const index = LEADING_NAMESPACES.indexOf(name);\n return index === -1 ? `1${name}` : `0${index}`;\n};\n\nconst DOCS_SIGNATURE_NAMESPACE = \"$docs\";\n\nexport const docsSignatureContext = (namespace: GirNamespace, library: Library): ModuleContext =>\n new ModuleContext({ ...namespace, name: DOCS_SIGNATURE_NAMESPACE }, library);\n\nexport type SignatureEntry = {\n name: string;\n signature: string;\n doc: string;\n};\n\nexport type OriginSignatureEntry = SignatureEntry & { origin: string | undefined };\n\nexport const originSignatureBlocks = (entries: OriginSignatureEntry[]): string[] =>\n sortStringsBy(entries, (item) => item.name).map((item) =>\n signatureBlock(item.name, item.signature, [\n item.origin === undefined ? \"\" : `From \\`${item.origin}\\`.`,\n item.doc,\n ]),\n );\n\nexport const classMethodEntries = (library: Library, namespace: GirNamespace, klass: GirClass): SignatureEntry[] => {\n const realContext = new ModuleContext(namespace, library);\n const signatureContext = docsSignatureContext(namespace, library);\n const className = toPascalCase(klass.name);\n const inherited = collectInheritedMethods(realContext, klass);\n return instanceMethodEntries(signatureContext, klass.methods, (method) =>\n conflictRename(realContext, method, inherited, className),\n );\n};\n\nexport const methodsSectionBlocks = (entries: SignatureEntry[], intro: string): string[] =>\n entries.length === 0\n ? []\n : [\"## Methods\", intro, ...entries.map((item) => signatureBlock(item.name, item.signature, [item.doc]))];\n\nexport const instanceMethodEntries = (\n signatureContext: ModuleContext,\n methods: GirFunction[],\n rename: (fn: GirFunction) => string | undefined,\n): SignatureEntry[] => {\n const deduped = dedupeCallables(methods);\n const siblings = indexMethodsByName(deduped);\n const entries: SignatureEntry[] = [];\n for (const method of deduped) {\n const nameOverride = rename(method);\n const rendered = renderInstanceMethodSignature(\n signatureContext,\n { ...method, doc: undefined },\n siblings,\n nameOverride,\n );\n if (rendered === undefined) continue;\n entries.push({\n name: nameOverride ?? methodExportName(method),\n signature: rendered.trim().replace(/;$/, \"\"),\n doc: docMarkdown(method.doc),\n });\n }\n return sortStringsBy(entries, (entry) => entry.name);\n};\n"]}
1
+ {"version":3,"file":"render.js","sourceRoot":"","sources":["../../src/docs/render.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAOxD,OAAO,EAAE,uBAAuB,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AACrF,OAAO,EAAE,uBAAuB,EAAE,uBAAuB,EAAE,MAAM,gCAAgC,CAAC;AAClG,OAAO,EAAE,gBAAgB,EAAE,cAAc,EAAqB,MAAM,wBAAwB,CAAC;AAC7F,OAAO,EAAE,eAAe,EAAE,aAAa,EAAE,6BAA6B,EAAE,MAAM,0BAA0B,CAAC;AACzG,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AACzD,OAAO,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AACrD,OAAO,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AAUxD,MAAM,mBAAmB,GAA2B,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;AACnG,MAAM,UAAU,GAAG,eAAe,CAAC;AACnC,MAAM,YAAY,GAAG,WAAW,CAAC;AACjC,MAAM,kBAAkB,GAAG,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;AAC1C,MAAM,wBAAwB,GAAG,OAAO,CAAC;AAEzC,MAAM,UAAU,GAAG,CAAC,OAAgB,EAAgB,EAAE,CAClD,gBAAgB,CACZ,OAAO,EACP,CAAC,IAAI,EAAE,EAAE,CAAC,GAAG,IAAI,CAAC,aAAa,IAAI,IAAI,CAAC,QAAQ,EAAE,EAClD,GAAG,EAAE,CAAC,cAAc,CACvB,CAAC;AAEN,MAAM,cAAc,GAAG,CAAC,OAAgB,EAAE,GAAuB,EAAE,UAAmB,EAAU,EAAE;IAC9F,MAAM,IAAI,GAAG,cAAc,CAAC,OAAO,EAAE,UAAU,CAAC,OAAO,CAAC,EAAE,GAAG,CAAC,CAAC;IAE/D,OAAO,UAAU,CAAC,CAAC,CAAC,GAAG,IAAI,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC;AAChD,CAAC,CAAC;AAEF,MAAM,2BAA2B,GAAG,CAAC,OAAgB,EAAE,MAAmB,EAAU,EAAE,CAClF,uBAAuB,CAAC;IACpB,OAAO;IACP,MAAM;IACN,UAAU,EAAE,CAAC,GAAG,EAAE,QAAQ,EAAE,EAAE,CAAC,cAAc,CAAC,OAAO,EAAE,GAAG,EAAE,QAAQ,CAAC;IACrE,sBAAsB,EAAE,KAAK;IAC7B,MAAM,EAAE,IAAI;CACf,CAAC,CAAC;AAEP,MAAM,2BAA2B,GAAG,CAAC,OAAgB,EAAE,MAAmB,EAAY,EAAE,CACpF,uBAAuB,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC,GAAG,EAAE,QAAQ,EAAE,EAAE,CAAC,cAAc,CAAC,OAAO,EAAE,GAAG,EAAE,QAAQ,CAAC,CAAC,CAAC;AAE1G,MAAM,yBAAyB,GAAG,CAAC,OAAgB,EAAE,MAAmB,EAAE,QAAgB,EAAU,EAAE;IAClG,MAAM,MAAM,GAAG,CAAC,GAAG,2BAA2B,CAAC,OAAO,EAAE,MAAM,CAAC,EAAE,SAAS,QAAQ,EAAE,CAAC,CAAC;IAEtF,OAAO,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,2BAA2B,CAAC,OAAO,EAAE,MAAM,CAAC,EAAE,CAAC;AACvF,CAAC,CAAC;AAEF,MAAM,2BAA2B,GAAG,CAAC,OAAgB,EAAE,MAAmB,EAAU,EAAE,CAClF,IAAI,2BAA2B,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,2BAA2B,CAAC,OAAO,EAAE,MAAM,CAAC,EAAE,CAAC;AAEtH,MAAM,gBAAgB,GAAG,CAAC,KAAa,EAAU,EAAE,CAAC,mBAAmB,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC;AAExF,MAAM,aAAa,GAAG,CAAC,QAAgB,EAAU,EAAE,CAC/C,QAAQ;KACH,UAAU,CAAC,8BAA8B,EAAE,EAAE,CAAC;KAC9C,UAAU,CAAC,kCAAkC,EAAE,EAAE,CAAC;KAClD,UAAU,CAAC,aAAa,EAAE,EAAE,CAAC,CAAC;AAEvC,MAAM,UAAU,GAAG,CAAC,IAAY,EAAE,SAAkB,EAAsC,EAAE;IACxF,IAAI,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;QACxB,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,SAAS,EAAE,CAAC;IAC/C,CAAC;IAED,IAAI,SAAS,EAAE,CAAC;QACZ,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE,SAAS,EAAE,CAAC;IAC9C,CAAC;IAED,OAAO,EAAE,IAAI,EAAE,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,OAAO,EAAE,SAAS,EAAE,CAAC;AACrF,CAAC,CAAC;AAEF,MAAM,cAAc,GAAG,CAAC,QAAgB,EAAU,EAAE;IAChD,IAAI,SAAS,GAAG,KAAK,CAAC;IACtB,MAAM,KAAK,GAAa,EAAE,CAAC;IAE3B,KAAK,MAAM,IAAI,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;QACtC,MAAM,MAAM,GAAG,UAAU,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;QAC3C,SAAS,GAAG,MAAM,CAAC,OAAO,CAAC;QAC3B,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IAC5B,CAAC;IAED,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC5B,CAAC,CAAC;AAEF,MAAM,WAAW,GAAG,CAAC,GAAuB,EAAU,EAAE,CACpD,GAAG,KAAK,SAAS,IAAI,GAAG,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,cAAc,CAAC,aAAa,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;AAE7G,MAAM,aAAa,GAAG,CAAC,QAAgB,EAAU,EAAE,CAC/C,QAAQ;KACH,UAAU,CAAC,iBAAiB,EAAE,GAAG,CAAC;KAClC,UAAU,CAAC,YAAY,EAAE,IAAI,CAAC;KAC9B,UAAU,CAAC,yBAAyB,EAAE,IAAI,CAAC;KAC3C,UAAU,CAAC,SAAS,EAAE,EAAE,CAAC;KACzB,UAAU,CAAC,MAAM,EAAE,GAAG,CAAC;KACvB,IAAI,EAAE,CAAC;AAEhB,MAAM,aAAa,GAAG,CAAC,GAAuB,EAAU,EAAE;IACtD,MAAM,IAAI,GAAG,aAAa,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC;IAE7C,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACpB,OAAO,EAAE,CAAC;IACd,CAAC;IAED,MAAM,KAAK,GAAG,mBAAmB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC7C,MAAM,QAAQ,GAAG,KAAK,EAAE,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC;IAEpC,OAAO,QAAQ,CAAC,MAAM,GAAG,GAAG,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC,EAAE,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,QAAQ,CAAC;AAC7E,CAAC,CAAC;AAEF,MAAM,WAAW,GAAG,CAAC,SAAiB,EAAU,EAAE,CAC9C,SAAS;KACJ,UAAU,CAAC,oBAAoB,EAAE,OAAO,CAAC;KACzC,UAAU,CAAC,wBAAwB,EAAE,KAAK,CAAC;KAC3C,WAAW,EAAE,CAAC;AAEvB,MAAM,cAAc,GAAG,CAAC,KAAe,EAAY,EAAE;IACjD,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACrB,OAAO,EAAE,CAAC;IACd,CAAC;IAED,MAAM,WAAW,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,KAAK,IAAI,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAElE,OAAO,CAAC,cAAc,WAAW,GAAG,CAAC,CAAC;AAC1C,CAAC,CAAC;AAEF,MAAM,YAAY,GAAG,CAAC,QAAkB,EAAU,EAAE,CAChD,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC;AAEzE,MAAM,SAAS,GAAG,CAAC,IAAY,EAAE,IAAY,EAAE,GAAW,EAAU,EAAE;IAClE,MAAM,KAAK,GAAG,CAAC,SAAS,IAAI,IAAI,EAAE,EAAE,EAAE,IAAI,CAAC,CAAC;IAE5C,IAAI,GAAG,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACjB,KAAK,CAAC,IAAI,CAAC,EAAE,EAAE,GAAG,CAAC,CAAC;IACxB,CAAC;IAED,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC5B,CAAC,CAAC;AAEF,MAAM,cAAc,GAAG,CAAC,IAAY,EAAE,SAAiB,EAAE,KAAe,EAAU,EAAE;IAChF,MAAM,KAAK,GAAG,CAAC,SAAS,IAAI,IAAI,EAAE,EAAE,EAAE,aAAa,SAAS,UAAU,CAAC,CAAC;IAExE,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACvB,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAClB,KAAK,CAAC,IAAI,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC;QACzB,CAAC;IACL,CAAC;IAED,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC5B,CAAC,CAAC;AAEF,MAAM,cAAc,GAAG,CAAC,IAAY,EAAU,EAAE;IAC5C,MAAM,KAAK,GAAG,kBAAkB,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IAE/C,OAAO,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;AAC3D,CAAC,CAAC;AAEF,MAAM,oBAAoB,GAAG,CAAC,SAAuB,EAAE,OAAgB,EAAiB,EAAE,CACtF,IAAI,aAAa,CAAC,EAAE,GAAG,SAAS,EAAE,IAAI,EAAE,wBAAwB,EAAE,EAAE,OAAO,CAAC,CAAC;AAEjF,MAAM,qBAAqB,GAAG,CAAC,OAA+B,EAAY,EAAE,CACxE,aAAa,CAAC,OAAO,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CACrD,cAAc,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,SAAS,EAAE;IACtC,IAAI,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,UAAU,IAAI,CAAC,MAAM,KAAK;IAC3D,IAAI,CAAC,GAAG;CACX,CAAC,CACL,CAAC;AAEN,MAAM,kBAAkB,GAAG,CAAC,OAAgB,EAAE,SAAuB,EAAE,KAAe,EAAoB,EAAE;IACxG,MAAM,WAAW,GAAG,IAAI,aAAa,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;IAC1D,MAAM,gBAAgB,GAAG,oBAAoB,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;IAClE,MAAM,SAAS,GAAG,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IACzC,MAAM,SAAS,GAAG,uBAAuB,CAAC,WAAW,EAAE,KAAK,CAAC,CAAC;IAE9D,OAAO,qBAAqB,CAAC,gBAAgB,EAAE,KAAK,EAAE,CAAC,MAAM,EAAE,EAAE,CAC7D,cAAc,CAAC,WAAW,EAAE,MAAM,EAAE,SAAS,EAAE,SAAS,CAAC,CAC5D,CAAC;AACN,CAAC,CAAC;AAEF,MAAM,oBAAoB,GAAG,CAAC,OAAyB,EAAE,KAAa,EAAY,EAAE,CAChF,OAAO,CAAC,MAAM,KAAK,CAAC;IAChB,CAAC,CAAC,EAAE;IACJ,CAAC,CAAC,CAAC,YAAY,EAAE,KAAK,EAAE,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,SAAS,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;AAEjH,MAAM,qBAAqB,GAAG,CAC1B,gBAA+B,EAC/B,KAAe,EACf,MAA+C,EAC/B,EAAE;IAClB,MAAM,OAAO,GAAG,eAAe,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IAE/C,MAAM,KAAK,GAAG,aAAa,CAAC,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE;QAChD,YAAY,EAAE,eAAe,CAAC,KAAK,CAAC,YAAY,CAAC;QACjD,SAAS,EAAE,eAAe,CAAC,KAAK,CAAC,SAAS,CAAC;QAC3C,OAAO,EAAE,OAAO;KACnB,CAAC,CAAC;IAEH,MAAM,OAAO,GAAqB,EAAE,CAAC;IAErC,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;QAC3B,MAAM,YAAY,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC;QAEpC,MAAM,QAAQ,GAAG,6BAA6B,CAC1C,gBAAgB,EAChB,EAAE,GAAG,MAAM,EAAE,GAAG,EAAE,SAAS,EAAE,EAC7B,KAAK,EACL,YAAY,CACf,CAAC;QAEF,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;YACzB,SAAS;QACb,CAAC;QAED,OAAO,CAAC,IAAI,CAAC;YACT,IAAI,EAAE,YAAY,IAAI,gBAAgB,CAAC,MAAM,CAAC;YAC9C,SAAS,EAAE,QAAQ,CAAC,IAAI,EAAE,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC;YAC5C,GAAG,EAAE,WAAW,CAAC,MAAM,CAAC,GAAG,CAAC;SAC/B,CAAC,CAAC;IACP,CAAC;IAED,OAAO,aAAa,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;AACzD,CAAC,CAAC;AAEF,OAAO,EACH,cAAc,EACd,yBAAyB,EACzB,2BAA2B,EAC3B,gBAAgB,EAChB,WAAW,EACX,aAAa,EACb,WAAW,EACX,cAAc,EACd,YAAY,EACZ,SAAS,EACT,cAAc,EACd,cAAc,EACd,oBAAoB,EACpB,qBAAqB,EACrB,kBAAkB,EAClB,oBAAoB,EACpB,qBAAqB,GAGxB,CAAC","sourcesContent":["import { pascalCase, sortStringsBy } from \"@gtkx/utils\";\nimport type { GirClass } from \"../gir/class.js\";\nimport type { GirFunction } from \"../gir/function.js\";\nimport type { Library } from \"../gir/library.js\";\nimport type { GirNamespace } from \"../gir/namespace.js\";\nimport type { GirCallable } from \"../gir/parameter.js\";\nimport type { TypeId } from \"../gir/type-id.js\";\nimport { collectInheritedMethods, conflictRename } from \"../analysis/inheritance.js\";\nimport { renderHandlerParameters, renderHandlerResultType } from \"../analysis/param-structure.js\";\nimport { recordTypeTarget, renderBaseType, type TsTypeTarget } from \"../analysis/ts-type.js\";\nimport { dedupeCallables, instanceScope, renderInstanceMethodSignature } from \"../store/gi/callables.js\";\nimport { methodExportName } from \"../store/gi/method.js\";\nimport { ModuleContext } from \"../writer/context.js\";\nimport { gtkDocToMarkdown } from \"../writer/gtk-doc.js\";\n\ntype SignatureEntry = {\n name: string;\n signature: string;\n doc: string;\n};\n\ntype OriginSignatureEntry = SignatureEntry & { origin: string | undefined };\n\nconst DOCS_DEFAULT_VALUES: Record<string, string> = { TRUE: \"true\", FALSE: \"false\", NULL: \"null\" };\nconst FENCE_LINE = /^\\s*(```|~~~)/;\nconst HEADING_LINE = /^#{1,5}\\s/;\nconst LEADING_NAMESPACES = [\"Gtk\", \"Adw\"];\nconst DOCS_SIGNATURE_NAMESPACE = \"$docs\";\n\nconst docsTarget = (library: Library): TsTypeTarget =>\n recordTypeTarget(\n library,\n (name) => `${name.namespaceName}.${name.typeName}`,\n () => \"GObject.Type\",\n );\n\nconst renderDocsType = (library: Library, ref: TypeId | undefined, isNullable: boolean): string => {\n const base = renderBaseType(library, docsTarget(library), ref);\n\n return isNullable ? `${base} | null` : base;\n};\n\nconst renderDocsHandlerResultType = (library: Library, signal: GirCallable): string =>\n renderHandlerResultType({\n library,\n signal,\n renderType: (ref, nullable) => renderDocsType(library, ref, nullable),\n includeCallerAllocated: false,\n optOut: true,\n });\n\nconst renderDocsHandlerParameters = (library: Library, signal: GirCallable): string[] =>\n renderHandlerParameters(signal.parameters, (ref, nullable) => renderDocsType(library, ref, nullable));\n\nconst renderDocsSignalSignature = (library: Library, signal: GirCallable, selfType: string): string => {\n const params = [...renderDocsHandlerParameters(library, signal), `self: ${selfType}`];\n\n return `(${params.join(\", \")}) => ${renderDocsHandlerResultType(library, signal)}`;\n};\n\nconst renderDocsSignalHandlerType = (library: Library, signal: GirCallable): string =>\n `(${renderDocsHandlerParameters(library, signal).join(\", \")}) => ${renderDocsHandlerResultType(library, signal)}`;\n\nconst docsDefaultValue = (value: string): string => DOCS_DEFAULT_VALUES[value] ?? value;\n\nconst stripDocMedia = (markdown: string): string =>\n markdown\n .replaceAll(/<picture[\\s\\S]*?<\\/picture>/g, \"\")\n .replaceAll(/<video[\\s\\S]*?(?:<\\/video>|\\/>)/g, \"\")\n .replaceAll(/<img[^>]*>/g, \"\");\n\nconst demoteLine = (line: string, isInFence: boolean): { text: string; inFence: boolean } => {\n if (FENCE_LINE.test(line)) {\n return { text: line, inFence: !isInFence };\n }\n\n if (isInFence) {\n return { text: line, inFence: isInFence };\n }\n\n return { text: HEADING_LINE.test(line) ? `#${line}` : line, inFence: isInFence };\n};\n\nconst demoteHeadings = (markdown: string): string => {\n let isInFence = false;\n const lines: string[] = [];\n\n for (const line of markdown.split(\"\\n\")) {\n const result = demoteLine(line, isInFence);\n isInFence = result.inFence;\n lines.push(result.text);\n }\n\n return lines.join(\"\\n\");\n};\n\nconst docMarkdown = (doc: string | undefined): string =>\n doc === undefined || doc.length === 0 ? \"\" : demoteHeadings(stripDocMedia(gtkDocToMarkdown(doc))).trim();\n\nconst stripMarkdown = (markdown: string): string =>\n markdown\n .replaceAll(/```[\\s\\S]*?```/g, \" \")\n .replaceAll(/`([^`]*)`/g, \"$1\")\n .replaceAll(/\\[([^[\\]]*)\\]\\([^)]*\\)/g, \"$1\")\n .replaceAll(/[*_#>]/g, \"\")\n .replaceAll(/\\s+/g, \" \")\n .trim();\n\nconst firstSentence = (doc: string | undefined): string => {\n const text = stripMarkdown(docMarkdown(doc));\n\n if (text.length === 0) {\n return \"\";\n }\n\n const match = /^.*?[.!?](?=\\s|$)/.exec(text);\n const sentence = match?.[0] ?? text;\n\n return sentence.length > 220 ? `${sentence.slice(0, 217)}...` : sentence;\n};\n\nconst elementSlug = (className: string): string =>\n className\n .replaceAll(/([a-z0-9])([A-Z])/g, \"$1-$2\")\n .replaceAll(/([A-Z])(?=[A-Z][a-z])/g, \"$1-\")\n .toLowerCase();\n\nconst implementsLine = (names: string[]): string[] => {\n if (names.length === 0) {\n return [];\n }\n\n const quotedNames = names.map((name) => `\\`${name}\\``).join(\", \");\n\n return [`Implements ${quotedNames}.`];\n};\n\nconst joinSections = (sections: string[]): string =>\n `${sections.filter((section) => section.length > 0).join(\"\\n\\n\")}\\n`;\n\nconst metaBlock = (name: string, meta: string, doc: string): string => {\n const lines = [`### \\`${name}\\``, \"\", meta];\n\n if (doc.length > 0) {\n lines.push(\"\", doc);\n }\n\n return lines.join(\"\\n\");\n};\n\nconst signatureBlock = (name: string, signature: string, notes: string[]): string => {\n const lines = [`### \\`${name}\\``, \"\", `\\`\\`\\`ts\\n${signature}\\n\\`\\`\\``];\n\n for (const note of notes) {\n if (note.length > 0) {\n lines.push(\"\", note);\n }\n }\n\n return lines.join(\"\\n\");\n};\n\nconst namespaceOrder = (name: string): string => {\n const index = LEADING_NAMESPACES.indexOf(name);\n\n return index === -1 ? `1${name}` : `0${String(index)}`;\n};\n\nconst docsSignatureContext = (namespace: GirNamespace, library: Library): ModuleContext =>\n new ModuleContext({ ...namespace, name: DOCS_SIGNATURE_NAMESPACE }, library);\n\nconst originSignatureBlocks = (entries: OriginSignatureEntry[]): string[] =>\n sortStringsBy(entries, (item) => item.name).map((item) =>\n signatureBlock(item.name, item.signature, [\n item.origin === undefined ? \"\" : `From \\`${item.origin}\\`.`,\n item.doc,\n ]),\n );\n\nconst classMethodEntries = (library: Library, namespace: GirNamespace, klass: GirClass): SignatureEntry[] => {\n const realContext = new ModuleContext(namespace, library);\n const signatureContext = docsSignatureContext(namespace, library);\n const className = pascalCase(klass.name);\n const inherited = collectInheritedMethods(realContext, klass);\n\n return instanceMethodEntries(signatureContext, klass, (method) =>\n conflictRename(realContext, method, inherited, className),\n );\n};\n\nconst methodsSectionBlocks = (entries: SignatureEntry[], intro: string): string[] =>\n entries.length === 0\n ? []\n : [\"## Methods\", intro, ...entries.map((item) => signatureBlock(item.name, item.signature, [item.doc]))];\n\nconst instanceMethodEntries = (\n signatureContext: ModuleContext,\n klass: GirClass,\n rename: (fn: GirFunction) => string | undefined,\n): SignatureEntry[] => {\n const deduped = dedupeCallables(klass.methods);\n\n const scope = instanceScope(pascalCase(klass.name), {\n constructors: dedupeCallables(klass.constructors),\n functions: dedupeCallables(klass.functions),\n methods: deduped,\n });\n\n const entries: SignatureEntry[] = [];\n\n for (const method of deduped) {\n const nameOverride = rename(method);\n\n const rendered = renderInstanceMethodSignature(\n signatureContext,\n { ...method, doc: undefined },\n scope,\n nameOverride,\n );\n\n if (rendered === undefined) {\n continue;\n }\n\n entries.push({\n name: nameOverride ?? methodExportName(method),\n signature: rendered.trim().replace(/;$/, \"\"),\n doc: docMarkdown(method.doc),\n });\n }\n\n return sortStringsBy(entries, (entry) => entry.name);\n};\n\nexport {\n renderDocsType,\n renderDocsSignalSignature,\n renderDocsSignalHandlerType,\n docsDefaultValue,\n docMarkdown,\n firstSentence,\n elementSlug,\n implementsLine,\n joinSections,\n metaBlock,\n signatureBlock,\n namespaceOrder,\n docsSignatureContext,\n originSignatureBlocks,\n classMethodEntries,\n methodsSectionBlocks,\n instanceMethodEntries,\n type SignatureEntry,\n type OriginSignatureEntry,\n};\n"]}
@@ -1,16 +1,16 @@
1
- import { type GirCallback } from "../gir/callback.js";
2
1
  import type { GirClass } from "../gir/class.js";
3
2
  import type { GirEnum } from "../gir/enum.js";
4
3
  import type { GirFunction } from "../gir/function.js";
5
4
  import type { Library } from "../gir/library.js";
6
- import { type GirAlias, type GirConstant, type GirNamespace } from "../gir/namespace.js";
7
5
  import type { GirRecord } from "../gir/record.js";
6
+ import { type GirCallback } from "../gir/callback.js";
7
+ import { type GirAlias, type GirConstant, type GirNamespace } from "../gir/namespace.js";
8
8
  type GiSymbolBase = {
9
9
  namespace: GirNamespace;
10
10
  name: string;
11
11
  doc: string | undefined;
12
12
  };
13
- export type GiSymbolEntry = (GiSymbolBase & {
13
+ type GiSymbolEntry = (GiSymbolBase & {
14
14
  kind: "class" | "interface";
15
15
  klass: GirClass;
16
16
  }) | (GiSymbolBase & {
@@ -32,10 +32,10 @@ export type GiSymbolEntry = (GiSymbolBase & {
32
32
  kind: "constant";
33
33
  constant: GirConstant;
34
34
  });
35
- export type SymbolPageOptions = {
35
+ type SymbolPageOptions = {
36
36
  library: Library;
37
37
  elementNameFor: (namespaceName: string, className: string) => string | undefined;
38
38
  };
39
- export declare const renderSymbolPage: (entry: GiSymbolEntry, options: SymbolPageOptions) => string;
40
- export {};
39
+ declare const renderSymbolPage: (entry: GiSymbolEntry, options: SymbolPageOptions) => string;
40
+ export { renderSymbolPage, type GiSymbolEntry, type SymbolPageOptions };
41
41
  //# sourceMappingURL=symbol-page.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"symbol-page.d.ts","sourceRoot":"","sources":["../../src/docs/symbol-page.ts"],"names":[],"mappings":"AAIA,OAAO,EAAsB,KAAK,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAC1E,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AACjD,OAAO,EAAE,KAAK,QAAQ,EAAE,KAAK,WAAW,EAAE,KAAK,YAAY,EAAsB,MAAM,qBAAqB,CAAC;AAG7G,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAqClD,KAAK,YAAY,GAAG;IAChB,SAAS,EAAE,YAAY,CAAC;IACxB,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,GAAG,SAAS,CAAC;CAC3B,CAAC;AAEF,MAAM,MAAM,aAAa,GACnB,CAAC,YAAY,GAAG;IAAE,IAAI,EAAE,OAAO,GAAG,WAAW,CAAC;IAAC,KAAK,EAAE,QAAQ,CAAA;CAAE,CAAC,GACjE,CAAC,YAAY,GAAG;IAAE,IAAI,EAAE,QAAQ,CAAC;IAAC,MAAM,EAAE,SAAS,CAAA;CAAE,CAAC,GACtD,CAAC,YAAY,GAAG;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,WAAW,EAAE,OAAO,CAAA;CAAE,CAAC,GACvD,CAAC,YAAY,GAAG;IAAE,IAAI,EAAE,UAAU,CAAC;IAAC,QAAQ,EAAE,WAAW,CAAA;CAAE,CAAC,GAC5D,CAAC,YAAY,GAAG;IAAE,IAAI,EAAE,OAAO,CAAC;IAAC,KAAK,EAAE,QAAQ,CAAA;CAAE,CAAC,GACnD,CAAC,YAAY,GAAG;IAAE,IAAI,EAAE,UAAU,CAAC;IAAC,EAAE,EAAE,WAAW,CAAA;CAAE,CAAC,GACtD,CAAC,YAAY,GAAG;IAAE,IAAI,EAAE,UAAU,CAAC;IAAC,QAAQ,EAAE,WAAW,CAAA;CAAE,CAAC,CAAC;AAEnE,MAAM,MAAM,iBAAiB,GAAG;IAC5B,OAAO,EAAE,OAAO,CAAC;IACjB,cAAc,EAAE,CAAC,aAAa,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,KAAK,MAAM,GAAG,SAAS,CAAC;CACpF,CAAC;AAuPF,eAAO,MAAM,gBAAgB,UAAW,aAAa,WAAW,iBAAiB,KAAG,MAkBnF,CAAC"}
1
+ {"version":3,"file":"symbol-page.d.ts","sourceRoot":"","sources":["../../src/docs/symbol-page.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAEjD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAKlD,OAAO,EAAsB,KAAK,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAC1E,OAAO,EAAE,KAAK,QAAQ,EAAE,KAAK,WAAW,EAAE,KAAK,YAAY,EAAsB,MAAM,qBAAqB,CAAC;AAuC7G,KAAK,YAAY,GAAG;IAChB,SAAS,EAAE,YAAY,CAAC;IACxB,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,GAAG,SAAS,CAAC;CAC3B,CAAC;AAEF,KAAK,aAAa,GACZ,CAAC,YAAY,GAAG;IAAE,IAAI,EAAE,OAAO,GAAG,WAAW,CAAC;IAAC,KAAK,EAAE,QAAQ,CAAA;CAAE,CAAC,GACnE,CAAC,YAAY,GAAG;IAAE,IAAI,EAAE,QAAQ,CAAC;IAAC,MAAM,EAAE,SAAS,CAAA;CAAE,CAAC,GACtD,CAAC,YAAY,GAAG;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,WAAW,EAAE,OAAO,CAAA;CAAE,CAAC,GACvD,CAAC,YAAY,GAAG;IAAE,IAAI,EAAE,UAAU,CAAC;IAAC,QAAQ,EAAE,WAAW,CAAA;CAAE,CAAC,GAC5D,CAAC,YAAY,GAAG;IAAE,IAAI,EAAE,OAAO,CAAC;IAAC,KAAK,EAAE,QAAQ,CAAA;CAAE,CAAC,GACnD,CAAC,YAAY,GAAG;IAAE,IAAI,EAAE,UAAU,CAAC;IAAC,EAAE,EAAE,WAAW,CAAA;CAAE,CAAC,GACtD,CAAC,YAAY,GAAG;IAAE,IAAI,EAAE,UAAU,CAAC;IAAC,QAAQ,EAAE,WAAW,CAAA;CAAE,CAAC,CAAC;AAEjE,KAAK,iBAAiB,GAAG;IACrB,OAAO,EAAE,OAAO,CAAC;IACjB,cAAc,EAAE,CAAC,aAAa,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,KAAK,MAAM,GAAG,SAAS,CAAC;CACpF,CAAC;AAiWF,QAAA,MAAM,gBAAgB,GAAI,OAAO,aAAa,EAAE,SAAS,iBAAiB,KAAG,MAyB5E,CAAC;AA6IF,OAAO,EAAE,gBAAgB,EAAE,KAAK,aAAa,EAAE,KAAK,iBAAiB,EAAE,CAAC"}