@gtkx/codegen 1.0.0-rc.3 → 1.0.0

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 (486) hide show
  1. package/README.md +8 -9
  2. package/dist/analysis/descriptor-render.d.ts +9 -4
  3. package/dist/analysis/descriptor-render.d.ts.map +1 -1
  4. package/dist/analysis/descriptor-render.js +51 -61
  5. package/dist/analysis/descriptor-render.js.map +1 -1
  6. package/dist/analysis/descriptor.d.ts +7 -7
  7. package/dist/analysis/descriptor.d.ts.map +1 -1
  8. package/dist/analysis/descriptor.js +7 -7
  9. package/dist/analysis/descriptor.js.map +1 -1
  10. package/dist/analysis/inheritance.d.ts +1 -2
  11. package/dist/analysis/inheritance.d.ts.map +1 -1
  12. package/dist/analysis/inheritance.js +25 -22
  13. package/dist/analysis/inheritance.js.map +1 -1
  14. package/dist/analysis/nul-terminated-bytes.d.ts +5 -0
  15. package/dist/analysis/nul-terminated-bytes.d.ts.map +1 -0
  16. package/dist/analysis/nul-terminated-bytes.js +18 -0
  17. package/dist/analysis/nul-terminated-bytes.js.map +1 -0
  18. package/dist/analysis/param-capability.d.ts +5 -0
  19. package/dist/analysis/param-capability.d.ts.map +1 -0
  20. package/dist/analysis/param-capability.js +130 -0
  21. package/dist/analysis/param-capability.js.map +1 -0
  22. package/dist/analysis/param-structure.d.ts +13 -6
  23. package/dist/analysis/param-structure.d.ts.map +1 -1
  24. package/dist/analysis/param-structure.js +44 -20
  25. package/dist/analysis/param-structure.js.map +1 -1
  26. package/dist/analysis/ts-type.d.ts +1 -1
  27. package/dist/analysis/ts-type.d.ts.map +1 -1
  28. package/dist/analysis/ts-type.js +3 -5
  29. package/dist/analysis/ts-type.js.map +1 -1
  30. package/dist/analysis/type-shape.d.ts +8 -0
  31. package/dist/analysis/type-shape.d.ts.map +1 -0
  32. package/dist/analysis/type-shape.js +12 -0
  33. package/dist/analysis/type-shape.js.map +1 -0
  34. package/dist/compile.d.ts +1 -1
  35. package/dist/compile.d.ts.map +1 -1
  36. package/dist/compile.js +2 -1
  37. package/dist/compile.js.map +1 -1
  38. package/dist/docs/api-reference.d.ts +79 -3
  39. package/dist/docs/api-reference.d.ts.map +1 -1
  40. package/dist/docs/api-reference.js +68 -13
  41. package/dist/docs/api-reference.js.map +1 -1
  42. package/dist/docs/element-page.d.ts +4 -4
  43. package/dist/docs/element-page.d.ts.map +1 -1
  44. package/dist/docs/element-page.js +32 -20
  45. package/dist/docs/element-page.js.map +1 -1
  46. package/dist/docs/handwritten-props.d.ts +9 -0
  47. package/dist/docs/handwritten-props.d.ts.map +1 -0
  48. package/dist/docs/handwritten-props.js +149 -0
  49. package/dist/docs/handwritten-props.js.map +1 -0
  50. package/dist/docs/pipeline.d.ts +4 -4
  51. package/dist/docs/pipeline.d.ts.map +1 -1
  52. package/dist/docs/pipeline.js +6 -6
  53. package/dist/docs/pipeline.js.map +1 -1
  54. package/dist/docs/render.d.ts +25 -5
  55. package/dist/docs/render.d.ts.map +1 -1
  56. package/dist/docs/render.js +90 -28
  57. package/dist/docs/render.js.map +1 -1
  58. package/dist/docs/symbol-page.d.ts +22 -0
  59. package/dist/docs/symbol-page.d.ts.map +1 -1
  60. package/dist/docs/symbol-page.js +129 -44
  61. package/dist/docs/symbol-page.js.map +1 -1
  62. package/dist/fingerprint.d.ts +3 -6
  63. package/dist/fingerprint.d.ts.map +1 -1
  64. package/dist/fingerprint.js +6 -8
  65. package/dist/fingerprint.js.map +1 -1
  66. package/dist/gi.d.ts +3 -11
  67. package/dist/gi.d.ts.map +1 -1
  68. package/dist/gi.js +0 -7
  69. package/dist/gi.js.map +1 -1
  70. package/dist/gir/ancestry.d.ts +2 -2
  71. package/dist/gir/ancestry.d.ts.map +1 -1
  72. package/dist/gir/ancestry.js +11 -1
  73. package/dist/gir/ancestry.js.map +1 -1
  74. package/dist/gir/annotations.d.ts +22 -0
  75. package/dist/gir/annotations.d.ts.map +1 -0
  76. package/dist/gir/annotations.js +15 -0
  77. package/dist/gir/annotations.js.map +1 -0
  78. package/dist/gir/callback.d.ts +1 -0
  79. package/dist/gir/callback.d.ts.map +1 -1
  80. package/dist/gir/callback.js +1 -0
  81. package/dist/gir/callback.js.map +1 -1
  82. package/dist/gir/class.d.ts +32 -1
  83. package/dist/gir/class.d.ts.map +1 -1
  84. package/dist/gir/class.js +8 -3
  85. package/dist/gir/class.js.map +1 -1
  86. package/dist/gir/enum.d.ts +21 -1
  87. package/dist/gir/enum.d.ts.map +1 -1
  88. package/dist/gir/enum.js +9 -9
  89. package/dist/gir/enum.js.map +1 -1
  90. package/dist/gir/field.d.ts +19 -4
  91. package/dist/gir/field.d.ts.map +1 -1
  92. package/dist/gir/field.js +7 -11
  93. package/dist/gir/field.js.map +1 -1
  94. package/dist/gir/function.d.ts +15 -0
  95. package/dist/gir/function.d.ts.map +1 -1
  96. package/dist/gir/function.js.map +1 -1
  97. package/dist/gir/gir-path.d.ts +7 -0
  98. package/dist/gir/gir-path.d.ts.map +1 -1
  99. package/dist/gir/gir-path.js +7 -0
  100. package/dist/gir/gir-path.js.map +1 -1
  101. package/dist/gir/libraries.d.ts +13 -2
  102. package/dist/gir/libraries.d.ts.map +1 -1
  103. package/dist/gir/libraries.js +11 -0
  104. package/dist/gir/libraries.js.map +1 -1
  105. package/dist/gir/library.d.ts +36 -0
  106. package/dist/gir/library.d.ts.map +1 -1
  107. package/dist/gir/library.js +34 -0
  108. package/dist/gir/library.js.map +1 -1
  109. package/dist/gir/namespace.d.ts +38 -0
  110. package/dist/gir/namespace.d.ts.map +1 -1
  111. package/dist/gir/namespace.js +4 -5
  112. package/dist/gir/namespace.js.map +1 -1
  113. package/dist/gir/parameter.d.ts +39 -0
  114. package/dist/gir/parameter.d.ts.map +1 -1
  115. package/dist/gir/parameter.js +7 -7
  116. package/dist/gir/parameter.js.map +1 -1
  117. package/dist/gir/parse.d.ts +3 -1
  118. package/dist/gir/parse.d.ts.map +1 -1
  119. package/dist/gir/parse.js +6 -3
  120. package/dist/gir/parse.js.map +1 -1
  121. package/dist/gir/primitives.d.ts +1 -0
  122. package/dist/gir/primitives.d.ts.map +1 -1
  123. package/dist/gir/primitives.js.map +1 -1
  124. package/dist/gir/property.d.ts +16 -0
  125. package/dist/gir/property.d.ts.map +1 -1
  126. package/dist/gir/property.js +3 -3
  127. package/dist/gir/property.js.map +1 -1
  128. package/dist/gir/record.d.ts +22 -0
  129. package/dist/gir/record.d.ts.map +1 -1
  130. package/dist/gir/record.js +3 -2
  131. package/dist/gir/record.js.map +1 -1
  132. package/dist/gir/size.d.ts +5 -4
  133. package/dist/gir/size.d.ts.map +1 -1
  134. package/dist/gir/size.js +0 -3
  135. package/dist/gir/size.js.map +1 -1
  136. package/dist/gir/type-id.d.ts +36 -1
  137. package/dist/gir/type-id.d.ts.map +1 -1
  138. package/dist/gir/type-id.js +2 -3
  139. package/dist/gir/type-id.js.map +1 -1
  140. package/dist/gir/type-ref.d.ts.map +1 -1
  141. package/dist/gir/type-ref.js +2 -1
  142. package/dist/gir/type-ref.js.map +1 -1
  143. package/dist/gir/type.d.ts +20 -0
  144. package/dist/gir/type.d.ts.map +1 -1
  145. package/dist/gir/type.js.map +1 -1
  146. package/dist/index.d.ts +18 -6
  147. package/dist/index.d.ts.map +1 -1
  148. package/dist/index.js +12 -3
  149. package/dist/index.js.map +1 -1
  150. package/dist/internal.d.ts +3 -0
  151. package/dist/internal.d.ts.map +1 -0
  152. package/dist/internal.js +3 -0
  153. package/dist/internal.js.map +1 -0
  154. package/dist/jsx.d.ts +7 -12
  155. package/dist/jsx.d.ts.map +1 -1
  156. package/dist/jsx.js +18 -19
  157. package/dist/jsx.js.map +1 -1
  158. package/dist/khronos/args.d.ts +7 -6
  159. package/dist/khronos/args.d.ts.map +1 -1
  160. package/dist/khronos/args.js +29 -7
  161. package/dist/khronos/args.js.map +1 -1
  162. package/dist/khronos/doc-context.d.ts +29 -0
  163. package/dist/khronos/doc-context.d.ts.map +1 -0
  164. package/dist/khronos/doc-context.js +29 -0
  165. package/dist/khronos/doc-context.js.map +1 -0
  166. package/dist/khronos/extensions.d.ts +13 -0
  167. package/dist/khronos/extensions.d.ts.map +1 -0
  168. package/dist/khronos/extensions.js +49 -0
  169. package/dist/khronos/extensions.js.map +1 -0
  170. package/dist/khronos/jsdoc.d.ts +17 -11
  171. package/dist/khronos/jsdoc.d.ts.map +1 -1
  172. package/dist/khronos/jsdoc.js +104 -46
  173. package/dist/khronos/jsdoc.js.map +1 -1
  174. package/dist/khronos/model.d.ts +42 -3
  175. package/dist/khronos/model.d.ts.map +1 -1
  176. package/dist/khronos/model.js +218 -63
  177. package/dist/khronos/model.js.map +1 -1
  178. package/dist/khronos/modules.d.ts +9 -6
  179. package/dist/khronos/modules.d.ts.map +1 -1
  180. package/dist/khronos/modules.js +96 -26
  181. package/dist/khronos/modules.js.map +1 -1
  182. package/dist/khronos/notes.d.ts +19 -0
  183. package/dist/khronos/notes.d.ts.map +1 -0
  184. package/dist/khronos/notes.js +35 -0
  185. package/dist/khronos/notes.js.map +1 -0
  186. package/dist/khronos/param-pair.d.ts +1 -1
  187. package/dist/khronos/param-pair.d.ts.map +1 -1
  188. package/dist/khronos/param-pair.js.map +1 -1
  189. package/dist/khronos/pipeline.d.ts +3 -1
  190. package/dist/khronos/pipeline.d.ts.map +1 -1
  191. package/dist/khronos/pipeline.js +59 -28
  192. package/dist/khronos/pipeline.js.map +1 -1
  193. package/dist/khronos/plan.d.ts +5 -5
  194. package/dist/khronos/plan.d.ts.map +1 -1
  195. package/dist/khronos/plan.js +8 -8
  196. package/dist/khronos/plan.js.map +1 -1
  197. package/dist/khronos/render.d.ts +8 -6
  198. package/dist/khronos/render.d.ts.map +1 -1
  199. package/dist/khronos/render.js +35 -26
  200. package/dist/khronos/render.js.map +1 -1
  201. package/dist/khronos/select.d.ts +21 -4
  202. package/dist/khronos/select.d.ts.map +1 -1
  203. package/dist/khronos/select.js +47 -34
  204. package/dist/khronos/select.js.map +1 -1
  205. package/dist/react/element-config.d.ts +16 -10
  206. package/dist/react/element-config.d.ts.map +1 -1
  207. package/dist/react/element-config.js +22 -15
  208. package/dist/react/element-config.js.map +1 -1
  209. package/dist/runner.d.ts +33 -21
  210. package/dist/runner.d.ts.map +1 -1
  211. package/dist/runner.js +19 -20
  212. package/dist/runner.js.map +1 -1
  213. package/dist/store/compile-store.d.ts +2 -3
  214. package/dist/store/compile-store.d.ts.map +1 -1
  215. package/dist/store/compile-store.js +2 -2
  216. package/dist/store/compile-store.js.map +1 -1
  217. package/dist/store/gi/callable-doc.d.ts +11 -0
  218. package/dist/store/gi/callable-doc.d.ts.map +1 -0
  219. package/dist/store/gi/callable-doc.js +62 -0
  220. package/dist/store/gi/callable-doc.js.map +1 -0
  221. package/dist/store/gi/callables.d.ts +3 -1
  222. package/dist/store/gi/callables.d.ts.map +1 -1
  223. package/dist/store/gi/callables.js +16 -16
  224. package/dist/store/gi/callables.js.map +1 -1
  225. package/dist/store/gi/callback.d.ts.map +1 -1
  226. package/dist/store/gi/callback.js +2 -2
  227. package/dist/store/gi/callback.js.map +1 -1
  228. package/dist/store/gi/class.d.ts.map +1 -1
  229. package/dist/store/gi/class.js +5 -3
  230. package/dist/store/gi/class.js.map +1 -1
  231. package/dist/store/gi/closure-invocation.d.ts +4 -0
  232. package/dist/store/gi/closure-invocation.d.ts.map +1 -0
  233. package/dist/store/gi/closure-invocation.js +22 -0
  234. package/dist/store/gi/closure-invocation.js.map +1 -0
  235. package/dist/store/gi/constant.d.ts.map +1 -1
  236. package/dist/store/gi/constant.js +3 -4
  237. package/dist/store/gi/constant.js.map +1 -1
  238. package/dist/store/gi/constructor-props.d.ts.map +1 -1
  239. package/dist/store/gi/constructor-props.js +18 -20
  240. package/dist/store/gi/constructor-props.js.map +1 -1
  241. package/dist/store/gi/doc-spec.d.ts +14 -0
  242. package/dist/store/gi/doc-spec.d.ts.map +1 -0
  243. package/dist/store/gi/doc-spec.js +23 -0
  244. package/dist/store/gi/doc-spec.js.map +1 -0
  245. package/dist/store/gi/enum.d.ts.map +1 -1
  246. package/dist/store/gi/enum.js +29 -16
  247. package/dist/store/gi/enum.js.map +1 -1
  248. package/dist/store/gi/function.d.ts.map +1 -1
  249. package/dist/store/gi/function.js +28 -17
  250. package/dist/store/gi/function.js.map +1 -1
  251. package/dist/store/gi/interface.d.ts.map +1 -1
  252. package/dist/store/gi/interface.js +130 -16
  253. package/dist/store/gi/interface.js.map +1 -1
  254. package/dist/store/gi/item-comparators.d.ts.map +1 -1
  255. package/dist/store/gi/item-comparators.js +3 -5
  256. package/dist/store/gi/item-comparators.js.map +1 -1
  257. package/dist/store/gi/method.d.ts +9 -1
  258. package/dist/store/gi/method.d.ts.map +1 -1
  259. package/dist/store/gi/method.js +92 -47
  260. package/dist/store/gi/method.js.map +1 -1
  261. package/dist/store/gi/param-marshal.d.ts +4 -1
  262. package/dist/store/gi/param-marshal.d.ts.map +1 -1
  263. package/dist/store/gi/param-marshal.js +5 -1
  264. package/dist/store/gi/param-marshal.js.map +1 -1
  265. package/dist/store/gi/pipeline.d.ts.map +1 -1
  266. package/dist/store/gi/pipeline.js +3 -2
  267. package/dist/store/gi/pipeline.js.map +1 -1
  268. package/dist/store/gi/properties.d.ts.map +1 -1
  269. package/dist/store/gi/properties.js +2 -2
  270. package/dist/store/gi/properties.js.map +1 -1
  271. package/dist/store/gi/property-accessor.d.ts +4 -2
  272. package/dist/store/gi/property-accessor.d.ts.map +1 -1
  273. package/dist/store/gi/property-accessor.js +10 -11
  274. package/dist/store/gi/property-accessor.js.map +1 -1
  275. package/dist/store/gi/record-constructor.d.ts.map +1 -1
  276. package/dist/store/gi/record-constructor.js +3 -1
  277. package/dist/store/gi/record-constructor.js.map +1 -1
  278. package/dist/store/gi/record-field-accessor.d.ts +4 -2
  279. package/dist/store/gi/record-field-accessor.d.ts.map +1 -1
  280. package/dist/store/gi/record-field-accessor.js +6 -11
  281. package/dist/store/gi/record-field-accessor.js.map +1 -1
  282. package/dist/store/gi/record-layout.d.ts.map +1 -1
  283. package/dist/store/gi/record-layout.js +1 -5
  284. package/dist/store/gi/record-layout.js.map +1 -1
  285. package/dist/store/gi/record.d.ts.map +1 -1
  286. package/dist/store/gi/record.js +3 -2
  287. package/dist/store/gi/record.js.map +1 -1
  288. package/dist/store/gi/registration.d.ts +1 -1
  289. package/dist/store/gi/registration.js +2 -2
  290. package/dist/store/gi/registration.js.map +1 -1
  291. package/dist/store/gi/return-wrap.d.ts +1 -1
  292. package/dist/store/gi/return-wrap.d.ts.map +1 -1
  293. package/dist/store/gi/return-wrap.js +4 -4
  294. package/dist/store/gi/return-wrap.js.map +1 -1
  295. package/dist/store/gi/runtime-override.d.ts +2 -1
  296. package/dist/store/gi/runtime-override.d.ts.map +1 -1
  297. package/dist/store/gi/runtime-override.js +8 -5
  298. package/dist/store/gi/runtime-override.js.map +1 -1
  299. package/dist/store/gi/signal.d.ts.map +1 -1
  300. package/dist/store/gi/signal.js +27 -31
  301. package/dist/store/gi/signal.js.map +1 -1
  302. package/dist/store/gi/value-marshalable.d.ts +1 -10
  303. package/dist/store/gi/value-marshalable.d.ts.map +1 -1
  304. package/dist/store/gi/value-marshalable.js +1 -10
  305. package/dist/store/gi/value-marshalable.js.map +1 -1
  306. package/dist/store/gi/vtable.d.ts +16 -1
  307. package/dist/store/gi/vtable.d.ts.map +1 -1
  308. package/dist/store/gi/vtable.js +214 -51
  309. package/dist/store/gi/vtable.js.map +1 -1
  310. package/dist/store/gi-store.d.ts +2 -3
  311. package/dist/store/gi-store.d.ts.map +1 -1
  312. package/dist/store/gi-store.js.map +1 -1
  313. package/dist/store/jsx/element-components.d.ts +1 -3
  314. package/dist/store/jsx/element-components.d.ts.map +1 -1
  315. package/dist/store/jsx/element-components.js +6 -8
  316. package/dist/store/jsx/element-components.js.map +1 -1
  317. package/dist/store/jsx/element-prop-imports.d.ts +1 -4
  318. package/dist/store/jsx/element-prop-imports.d.ts.map +1 -1
  319. package/dist/store/jsx/element-prop-imports.js +0 -2
  320. package/dist/store/jsx/element-prop-imports.js.map +1 -1
  321. package/dist/store/jsx/element-prop-types.d.ts +3 -1
  322. package/dist/store/jsx/element-prop-types.d.ts.map +1 -1
  323. package/dist/store/jsx/element-prop-types.js +7 -2
  324. package/dist/store/jsx/element-prop-types.js.map +1 -1
  325. package/dist/store/jsx/generated-elements.d.ts +29 -0
  326. package/dist/store/jsx/generated-elements.d.ts.map +1 -0
  327. package/dist/store/jsx/generated-elements.js +30 -0
  328. package/dist/store/jsx/generated-elements.js.map +1 -0
  329. package/dist/store/jsx/intrinsic-elements.d.ts +4 -0
  330. package/dist/store/jsx/intrinsic-elements.d.ts.map +1 -1
  331. package/dist/store/jsx/intrinsic-elements.js.map +1 -1
  332. package/dist/store/jsx/jsx.d.ts.map +1 -1
  333. package/dist/store/jsx/jsx.js +13 -12
  334. package/dist/store/jsx/jsx.js.map +1 -1
  335. package/dist/store/jsx/metadata.js +9 -9
  336. package/dist/store/jsx/metadata.js.map +1 -1
  337. package/dist/store/jsx/omitted-props.d.ts +2 -4
  338. package/dist/store/jsx/omitted-props.d.ts.map +1 -1
  339. package/dist/store/jsx/omitted-props.js +2 -4
  340. package/dist/store/jsx/omitted-props.js.map +1 -1
  341. package/dist/store/jsx/pipeline.d.ts +4 -2
  342. package/dist/store/jsx/pipeline.d.ts.map +1 -1
  343. package/dist/store/jsx/pipeline.js +3 -2
  344. package/dist/store/jsx/pipeline.js.map +1 -1
  345. package/dist/store/jsx/props.d.ts +1 -7
  346. package/dist/store/jsx/props.d.ts.map +1 -1
  347. package/dist/store/jsx/props.js +16 -8
  348. package/dist/store/jsx/props.js.map +1 -1
  349. package/dist/store/jsx-store.d.ts +2 -3
  350. package/dist/store/jsx-store.d.ts.map +1 -1
  351. package/dist/store/jsx-store.js +3 -3
  352. package/dist/store/jsx-store.js.map +1 -1
  353. package/dist/store/resolve-store.d.ts +28 -0
  354. package/dist/store/resolve-store.d.ts.map +1 -0
  355. package/dist/store/resolve-store.js +65 -0
  356. package/dist/store/resolve-store.js.map +1 -0
  357. package/dist/store/store-fs.d.ts +5 -1
  358. package/dist/store/store-fs.d.ts.map +1 -1
  359. package/dist/store/store-fs.js +6 -4
  360. package/dist/store/store-fs.js.map +1 -1
  361. package/dist/writer/context.d.ts +2 -1
  362. package/dist/writer/context.d.ts.map +1 -1
  363. package/dist/writer/context.js +3 -0
  364. package/dist/writer/context.js.map +1 -1
  365. package/dist/writer/doc-tags.d.ts +21 -0
  366. package/dist/writer/doc-tags.d.ts.map +1 -0
  367. package/dist/writer/doc-tags.js +38 -0
  368. package/dist/writer/doc-tags.js.map +1 -0
  369. package/dist/writer/doc.d.ts +3 -1
  370. package/dist/writer/doc.d.ts.map +1 -1
  371. package/dist/writer/doc.js +19 -6
  372. package/dist/writer/doc.js.map +1 -1
  373. package/dist/writer/gtk-doc.d.ts +1 -1
  374. package/dist/writer/gtk-doc.d.ts.map +1 -1
  375. package/dist/writer/gtk-doc.js +64 -15
  376. package/dist/writer/gtk-doc.js.map +1 -1
  377. package/dist/writer/module.d.ts +8 -2
  378. package/dist/writer/module.d.ts.map +1 -1
  379. package/dist/writer/module.js +13 -1
  380. package/dist/writer/module.js.map +1 -1
  381. package/overrides/gdk/rgba.ts.ejs +26 -0
  382. package/overrides/gobject/object.ts.ejs +56 -11
  383. package/overrides/gobject/value.ts.ejs +7 -0
  384. package/overrides/graphene/structs.ts.ejs +55 -0
  385. package/package.json +7 -11
  386. package/src/analysis/descriptor-render.ts +67 -73
  387. package/src/analysis/descriptor.ts +13 -16
  388. package/src/analysis/inheritance.ts +35 -34
  389. package/src/analysis/nul-terminated-bytes.ts +31 -0
  390. package/src/analysis/param-capability.ts +172 -0
  391. package/src/analysis/param-structure.ts +90 -32
  392. package/src/analysis/ts-type.ts +4 -6
  393. package/src/analysis/type-shape.ts +24 -0
  394. package/src/compile.ts +3 -2
  395. package/src/docs/api-reference.ts +162 -28
  396. package/src/docs/element-page.ts +53 -47
  397. package/src/docs/handwritten-props.ts +230 -0
  398. package/src/docs/pipeline.ts +10 -10
  399. package/src/docs/render.ts +153 -39
  400. package/src/docs/symbol-page.ts +230 -80
  401. package/src/fingerprint.ts +8 -14
  402. package/src/gi.ts +4 -11
  403. package/src/gir/ancestry.ts +15 -1
  404. package/src/gir/annotations.ts +37 -0
  405. package/src/gir/callback.ts +2 -0
  406. package/src/gir/class.ts +42 -4
  407. package/src/gir/enum.ts +30 -10
  408. package/src/gir/field.ts +24 -13
  409. package/src/gir/function.ts +15 -0
  410. package/src/gir/gir-path.ts +7 -0
  411. package/src/gir/libraries.ts +23 -2
  412. package/src/gir/library.ts +51 -2
  413. package/src/gir/namespace.ts +41 -5
  414. package/src/gir/parameter.ts +47 -7
  415. package/src/gir/parse.ts +8 -2
  416. package/src/gir/primitives.ts +1 -0
  417. package/src/gir/property.ts +18 -3
  418. package/src/gir/record.ts +24 -2
  419. package/src/gir/size.ts +8 -6
  420. package/src/gir/type-id.ts +51 -7
  421. package/src/gir/type-ref.ts +2 -1
  422. package/src/gir/type.ts +50 -6
  423. package/src/index.ts +18 -16
  424. package/src/internal.ts +2 -0
  425. package/src/jsx.ts +26 -26
  426. package/src/khronos/args.ts +37 -14
  427. package/src/khronos/doc-context.ts +62 -0
  428. package/src/khronos/extensions.ts +85 -0
  429. package/src/khronos/jsdoc.ts +152 -56
  430. package/src/khronos/model.ts +314 -69
  431. package/src/khronos/modules.ts +134 -40
  432. package/src/khronos/notes.ts +74 -0
  433. package/src/khronos/param-pair.ts +1 -1
  434. package/src/khronos/pipeline.ts +95 -42
  435. package/src/khronos/plan.ts +12 -13
  436. package/src/khronos/render.ts +62 -50
  437. package/src/khronos/select.ts +91 -50
  438. package/src/react/element-config.ts +21 -18
  439. package/src/runner.ts +51 -40
  440. package/src/store/compile-store.ts +4 -5
  441. package/src/store/gi/callable-doc.ts +102 -0
  442. package/src/store/gi/callables.ts +23 -17
  443. package/src/store/gi/callback.ts +3 -2
  444. package/src/store/gi/class.ts +6 -3
  445. package/src/store/gi/closure-invocation.ts +26 -0
  446. package/src/store/gi/constant.ts +3 -6
  447. package/src/store/gi/constructor-props.ts +19 -23
  448. package/src/store/gi/doc-spec.ts +38 -0
  449. package/src/store/gi/enum.ts +55 -20
  450. package/src/store/gi/function.ts +44 -26
  451. package/src/store/gi/interface.ts +214 -26
  452. package/src/store/gi/item-comparators.ts +3 -5
  453. package/src/store/gi/method.ts +126 -68
  454. package/src/store/gi/param-marshal.ts +15 -1
  455. package/src/store/gi/pipeline.ts +7 -2
  456. package/src/store/gi/properties.ts +3 -2
  457. package/src/store/gi/property-accessor.ts +14 -11
  458. package/src/store/gi/record-constructor.ts +6 -1
  459. package/src/store/gi/record-field-accessor.ts +9 -13
  460. package/src/store/gi/record-layout.ts +1 -5
  461. package/src/store/gi/record.ts +8 -2
  462. package/src/store/gi/registration.ts +3 -3
  463. package/src/store/gi/return-wrap.ts +5 -5
  464. package/src/store/gi/runtime-override.ts +13 -6
  465. package/src/store/gi/signal.ts +36 -37
  466. package/src/store/gi/value-marshalable.ts +1 -10
  467. package/src/store/gi/vtable.ts +361 -60
  468. package/src/store/gi-store.ts +2 -4
  469. package/src/store/jsx/element-components.ts +8 -11
  470. package/src/store/jsx/element-prop-imports.ts +6 -5
  471. package/src/store/jsx/element-prop-types.ts +10 -2
  472. package/src/store/jsx/generated-elements.ts +60 -0
  473. package/src/store/jsx/intrinsic-elements.ts +4 -0
  474. package/src/store/jsx/jsx.ts +15 -13
  475. package/src/store/jsx/metadata.ts +10 -10
  476. package/src/store/jsx/omitted-props.ts +2 -4
  477. package/src/store/jsx/pipeline.ts +6 -4
  478. package/src/store/jsx/props.ts +22 -9
  479. package/src/store/jsx-store.ts +5 -7
  480. package/src/store/resolve-store.ts +100 -0
  481. package/src/store/store-fs.ts +12 -5
  482. package/src/writer/context.ts +5 -1
  483. package/src/writer/doc-tags.ts +70 -0
  484. package/src/writer/doc.ts +29 -6
  485. package/src/writer/gtk-doc.ts +82 -15
  486. package/src/writer/module.ts +25 -2
@@ -0,0 +1,29 @@
1
+ import { sortStrings } from "@gtkx/utils";
2
+ const buildGroupMembers = (rows) => {
3
+ const members = new Map();
4
+ for (const row of rows) {
5
+ for (const group of row.token.groups) {
6
+ members.set(group, [...(members.get(group) ?? []), row.exportName]);
7
+ }
8
+ }
9
+ for (const [group, names] of members) {
10
+ members.set(group, sortStrings(names));
11
+ }
12
+ return members;
13
+ };
14
+ const buildDocContext = (options) => {
15
+ const { registry, extensions, plans, enumRows } = options;
16
+ return {
17
+ ...(registry.comment !== undefined && { registryComment: registry.comment }),
18
+ kinds: registry.kinds,
19
+ types: registry.types,
20
+ aliasTargets: registry.aliasTargets,
21
+ extensionCommands: extensions.commands,
22
+ extensionEnums: extensions.enums,
23
+ bitmaskGroups: registry.bitmaskGroups,
24
+ emittedCommands: new Set(plans.map((plan) => plan.command.name)),
25
+ groupMembers: buildGroupMembers(enumRows),
26
+ };
27
+ };
28
+ export { buildDocContext };
29
+ //# sourceMappingURL=doc-context.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"doc-context.js","sourceRoot":"","sources":["../../src/khronos/doc-context.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AA6B1C,MAAM,iBAAiB,GAAG,CAAC,IAAoB,EAAyB,EAAE;IACtE,MAAM,OAAO,GAA0B,IAAI,GAAG,EAAE,CAAC;IAEjD,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;QACrB,KAAK,MAAM,KAAK,IAAI,GAAG,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC;YACnC,OAAO,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,EAAE,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC;QACxE,CAAC;IACL,CAAC;IAED,KAAK,MAAM,CAAC,KAAK,EAAE,KAAK,CAAC,IAAI,OAAO,EAAE,CAAC;QACnC,OAAO,CAAC,GAAG,CAAC,KAAK,EAAE,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC;IAC3C,CAAC;IAED,OAAO,OAAO,CAAC;AACnB,CAAC,CAAC;AAEF,MAAM,eAAe,GAAG,CAAC,OAA+B,EAAgB,EAAE;IACtE,MAAM,EAAE,QAAQ,EAAE,UAAU,EAAE,KAAK,EAAE,QAAQ,EAAE,GAAG,OAAO,CAAC;IAE1D,OAAO;QACH,GAAG,CAAC,QAAQ,CAAC,OAAO,KAAK,SAAS,IAAI,EAAE,eAAe,EAAE,QAAQ,CAAC,OAAO,EAAE,CAAC;QAC5E,KAAK,EAAE,QAAQ,CAAC,KAAK;QACrB,KAAK,EAAE,QAAQ,CAAC,KAAK;QACrB,YAAY,EAAE,QAAQ,CAAC,YAAY;QACnC,iBAAiB,EAAE,UAAU,CAAC,QAAQ;QACtC,cAAc,EAAE,UAAU,CAAC,KAAK;QAChC,aAAa,EAAE,QAAQ,CAAC,aAAa;QACrC,eAAe,EAAE,IAAI,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAChE,YAAY,EAAE,iBAAiB,CAAC,QAAQ,CAAC;KAC5C,CAAC;AACN,CAAC,CAAC;AAEF,OAAO,EAAE,eAAe,EAAqB,CAAC","sourcesContent":["import { sortStrings } from \"@gtkx/utils\";\nimport type { GlExtensionAttribution, GlExtensionIndex } from \"./extensions.js\";\nimport type { GlEnum, GlRegistry, GlType } from \"./model.js\";\nimport type { CommandPlan } from \"./plan.js\";\n\ntype GlDocEnumRow = {\n token: GlEnum;\n exportName: string;\n};\n\ntype GlDocContext = {\n registryComment?: string;\n kinds: Map<string, string>;\n types: Map<string, GlType>;\n aliasTargets: Map<string, string[]>;\n extensionCommands: Map<string, GlExtensionAttribution[]>;\n extensionEnums: Map<string, GlExtensionAttribution[]>;\n bitmaskGroups: Set<string>;\n emittedCommands: Set<string>;\n groupMembers: Map<string, string[]>;\n};\n\ntype BuildDocContextOptions = {\n registry: GlRegistry;\n extensions: GlExtensionIndex;\n plans: (CommandPlan & { isOk: true })[];\n enumRows: GlDocEnumRow[];\n};\n\nconst buildGroupMembers = (rows: GlDocEnumRow[]): Map<string, string[]> => {\n const members: Map<string, string[]> = new Map();\n\n for (const row of rows) {\n for (const group of row.token.groups) {\n members.set(group, [...(members.get(group) ?? []), row.exportName]);\n }\n }\n\n for (const [group, names] of members) {\n members.set(group, sortStrings(names));\n }\n\n return members;\n};\n\nconst buildDocContext = (options: BuildDocContextOptions): GlDocContext => {\n const { registry, extensions, plans, enumRows } = options;\n\n return {\n ...(registry.comment !== undefined && { registryComment: registry.comment }),\n kinds: registry.kinds,\n types: registry.types,\n aliasTargets: registry.aliasTargets,\n extensionCommands: extensions.commands,\n extensionEnums: extensions.enums,\n bitmaskGroups: registry.bitmaskGroups,\n emittedCommands: new Set(plans.map((plan) => plan.command.name)),\n groupMembers: buildGroupMembers(enumRows),\n };\n};\n\nexport { buildDocContext, type GlDocContext };\n"]}
@@ -0,0 +1,13 @@
1
+ import type { GlRegistry } from "./model.js";
2
+ import type { GlSelection } from "./select.js";
3
+ type GlExtensionAttribution = {
4
+ name: string;
5
+ notes: string[];
6
+ };
7
+ type GlExtensionIndex = {
8
+ commands: Map<string, GlExtensionAttribution[]>;
9
+ enums: Map<string, GlExtensionAttribution[]>;
10
+ };
11
+ declare const buildExtensionIndex: (registry: GlRegistry, selection: GlSelection) => GlExtensionIndex;
12
+ export { buildExtensionIndex, type GlExtensionAttribution, type GlExtensionIndex };
13
+ //# sourceMappingURL=extensions.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"extensions.d.ts","sourceRoot":"","sources":["../../src/khronos/extensions.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAiC,UAAU,EAAE,MAAM,YAAY,CAAC;AAC5E,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAE/C,KAAK,sBAAsB,GAAG;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,EAAE,CAAC;CACnB,CAAC;AAEF,KAAK,gBAAgB,GAAG;IACpB,QAAQ,EAAE,GAAG,CAAC,MAAM,EAAE,sBAAsB,EAAE,CAAC,CAAC;IAChD,KAAK,EAAE,GAAG,CAAC,MAAM,EAAE,sBAAsB,EAAE,CAAC,CAAC;CAChD,CAAC;AA4DF,QAAA,MAAM,mBAAmB,GAAI,UAAU,UAAU,EAAE,WAAW,WAAW,KAAG,gBAU3E,CAAC;AAEF,OAAO,EAAE,mBAAmB,EAAE,KAAK,sBAAsB,EAAE,KAAK,gBAAgB,EAAE,CAAC"}
@@ -0,0 +1,49 @@
1
+ import { sortStrings } from "@gtkx/utils";
2
+ const SUPPORTED_APIS = new Set(["gl", "glcore"]);
3
+ const isExtensionSupported = (extension) => extension.supported.some((api) => SUPPORTED_APIS.has(api));
4
+ const isBlockIncluded = (block, selection) => block.kind === "require" &&
5
+ (block.api === undefined || block.api === selection.api) &&
6
+ (block.profile === undefined || block.profile === selection.profile);
7
+ const blockNotes = (extension, block) => [
8
+ ...(extension.comment === undefined ? [] : [extension.comment]),
9
+ ...(block.comment === undefined ? [] : [block.comment]),
10
+ ];
11
+ const appendMembers = (index, names, extension, notes) => {
12
+ for (const name of names) {
13
+ const byExtension = index.get(name) ?? new Map();
14
+ byExtension.set(extension, [...(byExtension.get(extension) ?? []), ...notes]);
15
+ index.set(name, byExtension);
16
+ }
17
+ };
18
+ const indexExtension = (index, extension, selection) => {
19
+ for (const block of extension.blocks) {
20
+ if (!isBlockIncluded(block, selection)) {
21
+ continue;
22
+ }
23
+ const notes = blockNotes(extension, block);
24
+ appendMembers(index.commands, block.commands, extension.name, notes);
25
+ appendMembers(index.enums, block.enums, extension.name, notes);
26
+ }
27
+ };
28
+ const attributionsFor = (byExtension) => sortStrings(byExtension.keys()).map((name) => ({
29
+ name,
30
+ notes: [...new Set(byExtension.get(name))],
31
+ }));
32
+ const finalizeIndex = (pending) => {
33
+ const index = new Map();
34
+ for (const [name, byExtension] of pending) {
35
+ index.set(name, attributionsFor(byExtension));
36
+ }
37
+ return index;
38
+ };
39
+ const buildExtensionIndex = (registry, selection) => {
40
+ const pending = { commands: new Map(), enums: new Map() };
41
+ for (const extension of registry.extensions) {
42
+ if (isExtensionSupported(extension)) {
43
+ indexExtension(pending, extension, selection);
44
+ }
45
+ }
46
+ return { commands: finalizeIndex(pending.commands), enums: finalizeIndex(pending.enums) };
47
+ };
48
+ export { buildExtensionIndex };
49
+ //# sourceMappingURL=extensions.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"extensions.js","sourceRoot":"","sources":["../../src/khronos/extensions.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAqB1C,MAAM,cAAc,GAAgB,IAAI,GAAG,CAAC,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC,CAAC;AAE9D,MAAM,oBAAoB,GAAG,CAAC,SAAsB,EAAW,EAAE,CAC7D,SAAS,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,cAAc,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC;AAE/D,MAAM,eAAe,GAAG,CAAC,KAAuB,EAAE,SAAsB,EAAW,EAAE,CACjF,KAAK,CAAC,IAAI,KAAK,SAAS;IACxB,CAAC,KAAK,CAAC,GAAG,KAAK,SAAS,IAAI,KAAK,CAAC,GAAG,KAAK,SAAS,CAAC,GAAG,CAAC;IACxD,CAAC,KAAK,CAAC,OAAO,KAAK,SAAS,IAAI,KAAK,CAAC,OAAO,KAAK,SAAS,CAAC,OAAO,CAAC,CAAC;AAEzE,MAAM,UAAU,GAAG,CAAC,SAAsB,EAAE,KAAuB,EAAY,EAAE,CAAC;IAC9E,GAAG,CAAC,SAAS,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;IAC/D,GAAG,CAAC,KAAK,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;CAC1D,CAAC;AAEF,MAAM,aAAa,GAAG,CAAC,KAAmB,EAAE,KAAe,EAAE,SAAiB,EAAE,KAAe,EAAQ,EAAE;IACrG,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACvB,MAAM,WAAW,GAAG,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,IAAI,GAAG,EAAoB,CAAC;QACnE,WAAW,CAAC,GAAG,CAAC,SAAS,EAAE,CAAC,GAAG,CAAC,WAAW,CAAC,GAAG,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC,EAAE,GAAG,KAAK,CAAC,CAAC,CAAC;QAC9E,KAAK,CAAC,GAAG,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;IACjC,CAAC;AACL,CAAC,CAAC;AAEF,MAAM,cAAc,GAAG,CAAC,KAA4B,EAAE,SAAsB,EAAE,SAAsB,EAAQ,EAAE;IAC1G,KAAK,MAAM,KAAK,IAAI,SAAS,CAAC,MAAM,EAAE,CAAC;QACnC,IAAI,CAAC,eAAe,CAAC,KAAK,EAAE,SAAS,CAAC,EAAE,CAAC;YACrC,SAAS;QACb,CAAC;QAED,MAAM,KAAK,GAAG,UAAU,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;QAC3C,aAAa,CAAC,KAAK,CAAC,QAAQ,EAAE,KAAK,CAAC,QAAQ,EAAE,SAAS,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;QACrE,aAAa,CAAC,KAAK,CAAC,KAAK,EAAE,KAAK,CAAC,KAAK,EAAE,SAAS,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IACnE,CAAC;AACL,CAAC,CAAC;AAEF,MAAM,eAAe,GAAG,CAAC,WAAkC,EAA4B,EAAE,CACrF,WAAW,CAAC,WAAW,CAAC,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;IAC3C,IAAI;IACJ,KAAK,EAAE,CAAC,GAAG,IAAI,GAAG,CAAC,WAAW,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC;CAC7C,CAAC,CAAC,CAAC;AAER,MAAM,aAAa,GAAG,CAAC,OAAqB,EAAyC,EAAE;IACnF,MAAM,KAAK,GAA0C,IAAI,GAAG,EAAE,CAAC;IAE/D,KAAK,MAAM,CAAC,IAAI,EAAE,WAAW,CAAC,IAAI,OAAO,EAAE,CAAC;QACxC,KAAK,CAAC,GAAG,CAAC,IAAI,EAAE,eAAe,CAAC,WAAW,CAAC,CAAC,CAAC;IAClD,CAAC;IAED,OAAO,KAAK,CAAC;AACjB,CAAC,CAAC;AAEF,MAAM,mBAAmB,GAAG,CAAC,QAAoB,EAAE,SAAsB,EAAoB,EAAE;IAC3F,MAAM,OAAO,GAA0B,EAAE,QAAQ,EAAE,IAAI,GAAG,EAAE,EAAE,KAAK,EAAE,IAAI,GAAG,EAAE,EAAE,CAAC;IAEjF,KAAK,MAAM,SAAS,IAAI,QAAQ,CAAC,UAAU,EAAE,CAAC;QAC1C,IAAI,oBAAoB,CAAC,SAAS,CAAC,EAAE,CAAC;YAClC,cAAc,CAAC,OAAO,EAAE,SAAS,EAAE,SAAS,CAAC,CAAC;QAClD,CAAC;IACL,CAAC;IAED,OAAO,EAAE,QAAQ,EAAE,aAAa,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,KAAK,EAAE,aAAa,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;AAC9F,CAAC,CAAC;AAEF,OAAO,EAAE,mBAAmB,EAAsD,CAAC","sourcesContent":["import { sortStrings } from \"@gtkx/utils\";\nimport type { GlExtension, GlInterfaceBlock, GlRegistry } from \"./model.js\";\nimport type { GlSelection } from \"./select.js\";\n\ntype GlExtensionAttribution = {\n name: string;\n notes: string[];\n};\n\ntype GlExtensionIndex = {\n commands: Map<string, GlExtensionAttribution[]>;\n enums: Map<string, GlExtensionAttribution[]>;\n};\n\ntype PendingIndex = Map<string, Map<string, string[]>>;\n\ntype PendingExtensionIndex = {\n commands: PendingIndex;\n enums: PendingIndex;\n};\n\nconst SUPPORTED_APIS: Set<string> = new Set([\"gl\", \"glcore\"]);\n\nconst isExtensionSupported = (extension: GlExtension): boolean =>\n extension.supported.some((api) => SUPPORTED_APIS.has(api));\n\nconst isBlockIncluded = (block: GlInterfaceBlock, selection: GlSelection): boolean =>\n block.kind === \"require\" &&\n (block.api === undefined || block.api === selection.api) &&\n (block.profile === undefined || block.profile === selection.profile);\n\nconst blockNotes = (extension: GlExtension, block: GlInterfaceBlock): string[] => [\n ...(extension.comment === undefined ? [] : [extension.comment]),\n ...(block.comment === undefined ? [] : [block.comment]),\n];\n\nconst appendMembers = (index: PendingIndex, names: string[], extension: string, notes: string[]): void => {\n for (const name of names) {\n const byExtension = index.get(name) ?? new Map<string, string[]>();\n byExtension.set(extension, [...(byExtension.get(extension) ?? []), ...notes]);\n index.set(name, byExtension);\n }\n};\n\nconst indexExtension = (index: PendingExtensionIndex, extension: GlExtension, selection: GlSelection): void => {\n for (const block of extension.blocks) {\n if (!isBlockIncluded(block, selection)) {\n continue;\n }\n\n const notes = blockNotes(extension, block);\n appendMembers(index.commands, block.commands, extension.name, notes);\n appendMembers(index.enums, block.enums, extension.name, notes);\n }\n};\n\nconst attributionsFor = (byExtension: Map<string, string[]>): GlExtensionAttribution[] =>\n sortStrings(byExtension.keys()).map((name) => ({\n name,\n notes: [...new Set(byExtension.get(name))],\n }));\n\nconst finalizeIndex = (pending: PendingIndex): Map<string, GlExtensionAttribution[]> => {\n const index: Map<string, GlExtensionAttribution[]> = new Map();\n\n for (const [name, byExtension] of pending) {\n index.set(name, attributionsFor(byExtension));\n }\n\n return index;\n};\n\nconst buildExtensionIndex = (registry: GlRegistry, selection: GlSelection): GlExtensionIndex => {\n const pending: PendingExtensionIndex = { commands: new Map(), enums: new Map() };\n\n for (const extension of registry.extensions) {\n if (isExtensionSupported(extension)) {\n indexExtension(pending, extension, selection);\n }\n }\n\n return { commands: finalizeIndex(pending.commands), enums: finalizeIndex(pending.enums) };\n};\n\nexport { buildExtensionIndex, type GlExtensionAttribution, type GlExtensionIndex };\n"]}
@@ -1,21 +1,27 @@
1
1
  import type { InArg, OutArg } from "./args.js";
2
+ import type { GlDocContext } from "./doc-context.js";
2
3
  import type { GlCommand } from "./model.js";
3
- import type { ReturnPlan } from "./plan.js";
4
+ import type { CommandPlan } from "./plan.js";
5
+ import type { GlSymbolProvenance } from "./select.js";
6
+ type OkPlan = CommandPlan & {
7
+ isOk: true;
8
+ };
4
9
  type CommandJsDocOptions = {
5
- command: GlCommand;
6
- feature: string;
10
+ plan: OkPlan;
11
+ provenance: GlSymbolProvenance;
7
12
  ins: InArg[];
8
13
  outs: OutArg[];
9
- returnPlan: ReturnPlan;
14
+ docs: GlDocContext;
10
15
  };
11
- type SingularJsDocOptions = {
12
- commandName: string;
13
- feature: string;
16
+ type DerivedJsDocOptions = {
17
+ command: GlCommand;
18
+ provenance: GlSymbolProvenance;
14
19
  summary: string;
15
20
  body: string[];
21
+ docs: GlDocContext;
16
22
  };
17
- declare const inParamDocLine: (command: GlCommand, arg: InArg) => string;
18
- declare const singularJsDoc: ({ commandName, feature, summary, body }: SingularJsDocOptions) => string;
19
- declare const commandJsDoc: ({ command, feature, ins, outs, returnPlan }: CommandJsDocOptions) => string;
20
- export { inParamDocLine, singularJsDoc, commandJsDoc };
23
+ declare const inParamDocLine: (plan: OkPlan, arg: InArg, docs: GlDocContext) => string;
24
+ declare const derivedJsDoc: ({ command, provenance, summary, body, docs }: DerivedJsDocOptions) => string;
25
+ declare const commandJsDoc: ({ plan, provenance, ins, outs, docs }: CommandJsDocOptions) => string;
26
+ export { commandJsDoc, derivedJsDoc, inParamDocLine };
21
27
  //# sourceMappingURL=jsdoc.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"jsdoc.d.ts","sourceRoot":"","sources":["../../src/khronos/jsdoc.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,WAAW,CAAC;AAC/C,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAC5C,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,WAAW,CAAC;AAE5C,KAAK,mBAAmB,GAAG;IACvB,OAAO,EAAE,SAAS,CAAC;IACnB,OAAO,EAAE,MAAM,CAAC;IAChB,GAAG,EAAE,KAAK,EAAE,CAAC;IACb,IAAI,EAAE,MAAM,EAAE,CAAC;IACf,UAAU,EAAE,UAAU,CAAC;CAC1B,CAAC;AAEF,KAAK,oBAAoB,GAAG;IACxB,WAAW,EAAE,MAAM,CAAC;IACpB,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,EAAE,CAAC;CAClB,CAAC;AAYF,QAAA,MAAM,cAAc,GAAI,SAAS,SAAS,EAAE,KAAK,KAAK,KAAG,MAsBxD,CAAC;AAoCF,QAAA,MAAM,aAAa,GAAI,yCAAyC,oBAAoB,KAAG,MASvE,CAAC;AAEjB,QAAA,MAAM,YAAY,GAAI,6CAA6C,mBAAmB,KAAG,MAYxF,CAAC;AAEF,OAAO,EAAE,cAAc,EAAE,aAAa,EAAE,YAAY,EAAE,CAAC"}
1
+ {"version":3,"file":"jsdoc.d.ts","sourceRoot":"","sources":["../../src/khronos/jsdoc.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,WAAW,CAAC;AAC/C,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AACrD,OAAO,KAAK,EAAE,SAAS,EAAkB,MAAM,YAAY,CAAC;AAC5D,OAAO,KAAK,EAAE,WAAW,EAAyB,MAAM,WAAW,CAAC;AACpE,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAC;AActD,KAAK,MAAM,GAAG,WAAW,GAAG;IAAE,IAAI,EAAE,IAAI,CAAA;CAAE,CAAC;AAO3C,KAAK,mBAAmB,GAAG;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,kBAAkB,CAAC;IAC/B,GAAG,EAAE,KAAK,EAAE,CAAC;IACb,IAAI,EAAE,MAAM,EAAE,CAAC;IACf,IAAI,EAAE,YAAY,CAAC;CACtB,CAAC;AAEF,KAAK,mBAAmB,GAAG;IACvB,OAAO,EAAE,SAAS,CAAC;IACnB,UAAU,EAAE,kBAAkB,CAAC;IAC/B,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,EAAE,CAAC;IACf,IAAI,EAAE,YAAY,CAAC;CACtB,CAAC;AA8FF,QAAA,MAAM,cAAc,GAAI,MAAM,MAAM,EAAE,KAAK,KAAK,EAAE,MAAM,YAAY,KAAG,MAYtE,CAAC;AAiCF,QAAA,MAAM,YAAY,GAAI,8CAA8C,mBAAmB,KAAG,MAQ1E,CAAC;AAEjB,QAAA,MAAM,YAAY,GAAI,uCAAuC,mBAAmB,KAAG,MAkBlF,CAAC;AAEF,OAAO,EAAE,YAAY,EAAE,YAAY,EAAE,cAAc,EAAE,CAAC"}
@@ -1,72 +1,130 @@
1
1
  import { toCamelIdentifier } from "@gtkx/utils";
2
- const REFPAGES_BASE = "https://registry.khronos.org/OpenGL-Refpages/gl4/html";
2
+ import { returnPlanTsType, scalarAliasOrGroup } from "./args.js";
3
+ import { asSentence, backtick, backtickList, commandExportName, kindDescriptions, metadataNotes, provenanceLines, } from "./notes.js";
4
+ import { paramPairAt } from "./param-pair.js";
5
+ const GROUPED_PLAN_KINDS = new Set(["scalar", "array-in", "ref-out", "ref-array-out"]);
6
+ const LENGTHLESS_PLAN_KINDS = new Set(["byte-offset", "byte-offset-array", "ref-out"]);
7
+ const OFFSET_NOTES = new Map([
8
+ ["byte-offset", "byte offset into the bound buffer"],
9
+ ["byte-offset-array", "byte offsets into the bound buffer"],
10
+ ]);
3
11
  const formatPrototype = (command) => {
4
12
  const params = command.params
5
13
  .map((param) => (param.cType.endsWith("*") ? `${param.cType}${param.name}` : `${param.cType} ${param.name}`))
6
14
  .join(", ");
7
15
  return `${command.returnCType} ${command.name}(${params})`;
8
16
  };
9
- const inParamDocLine = (command, arg) => {
10
- const param = command.params.find((candidate) => toCamelIdentifier(candidate.name) === arg.name);
11
- if (param === undefined) {
12
- return ` * @param ${arg.name}`;
13
- }
14
- const notes = [`\`${param.cType}\``];
15
- if (param.group !== undefined) {
16
- notes.push(`group \`${param.group}\``);
17
- }
18
- if (param.len !== undefined) {
19
- notes.push(`length \`${param.len}\``);
20
- }
21
- if (param.objectClass !== undefined) {
22
- notes.push(`object class \`${param.objectClass}\``);
17
+ const glxLine = (glx) => {
18
+ const opcode = ` * GLX ${glx.type} opcode ${glx.opcode}.`;
19
+ return glx.comment === undefined ? opcode : `${opcode} ${asSentence(glx.comment)}`;
20
+ };
21
+ const aliasLine = (aliases) => ` * Also known as ${backtickList(aliases)}.`;
22
+ const vectorFormLines = (command, docs) => {
23
+ const target = command.vecEquiv;
24
+ if (target === undefined || !docs.emittedCommands.has(target)) {
25
+ return [];
23
26
  }
24
- return ` * @param ${arg.name} - ${notes.join(", ")}`;
27
+ return [` * Vector form: ${backtick(commandExportName(target))}.`];
28
+ };
29
+ const commandNotes = (command, docs) => {
30
+ const aliases = docs.aliasTargets.get(command.name) ?? [];
31
+ return [
32
+ ...(command.comment === undefined ? [] : [` * Registry note: ${command.comment}`]),
33
+ ...(aliases.length > 0 ? [aliasLine(aliases)] : []),
34
+ ...vectorFormLines(command, docs),
35
+ ...(command.glx === undefined ? [] : [glxLine(command.glx)]),
36
+ ];
37
+ };
38
+ const isGroupFolded = (plan, group) => GROUPED_PLAN_KINDS.has(plan.kind) &&
39
+ "scalar" in plan &&
40
+ scalarAliasOrGroup(plan.scalar, group) !== plan.scalar.tsAlias;
41
+ const groupEntry = (param, paramPlan) => param.group === undefined || isGroupFolded(paramPlan, param.group) ? {} : { group: param.group };
42
+ const lengthEntry = (param, paramPlan) => param.len === undefined || LENGTHLESS_PLAN_KINDS.has(paramPlan.kind) ? {} : { len: param.len };
43
+ const paramShape = (param, paramPlan, type) => {
44
+ const note = OFFSET_NOTES.get(paramPlan.kind);
45
+ return {
46
+ type,
47
+ ...groupEntry(param, paramPlan),
48
+ ...lengthEntry(param, paramPlan),
49
+ ...(param.objectClass !== undefined && { objectClass: param.objectClass }),
50
+ ...(note !== undefined && { note }),
51
+ kinds: param.kinds,
52
+ };
25
53
  };
26
- const outMember = (command, out) => {
27
- const param = command.params[out.paramIndex];
28
- if (param === undefined) {
29
- throw new Error(`Output parameter index ${String(out.paramIndex)} out of range on ${command.name}`);
54
+ const returnShape = (plan) => {
55
+ const { command, returnPlan } = plan;
56
+ const group = command.returnGroup;
57
+ return {
58
+ type: returnPlanTsType(returnPlan, group),
59
+ ...(group !== undefined && !isGroupFolded(returnPlan, group) && { group }),
60
+ ...(command.returnObjectClass !== undefined && { objectClass: command.returnObjectClass }),
61
+ kinds: command.returnKinds,
62
+ };
63
+ };
64
+ const paramPairFor = (plan, argName) => {
65
+ const index = plan.command.params.findIndex((candidate) => toCamelIdentifier(candidate.name) === argName);
66
+ const { param, paramPlan } = paramPairAt(plan, index);
67
+ if (param === undefined || paramPlan === undefined) {
68
+ return undefined;
30
69
  }
31
- return `\`${param.name}\` (\`${param.cType}\`)`;
70
+ return { param, paramPlan };
32
71
  };
33
- const returnsDocLine = (command, returnPlan, outs) => {
34
- const members = [];
35
- if (returnPlan.kind !== "void") {
36
- members.push(`\`${command.returnCType}\``);
72
+ const inParamDocLine = (plan, arg, docs) => {
73
+ const pair = paramPairFor(plan, arg.name);
74
+ if (pair === undefined) {
75
+ return ` * @param ${arg.name}`;
37
76
  }
38
- for (const out of outs) {
39
- members.push(outMember(command, out));
77
+ const descriptions = kindDescriptions(pair.param.kinds, docs.kinds);
78
+ const sentence = descriptions.length === 0 ? "" : `. ${descriptions}`;
79
+ const notes = metadataNotes(paramShape(pair.param, pair.paramPlan, arg.tsType));
80
+ return ` * @param ${arg.name} - ${notes}${sentence}`;
81
+ };
82
+ const outMember = (plan, out) => {
83
+ const { param, paramPlan } = paramPairAt(plan, out.paramIndex);
84
+ if (param === undefined || paramPlan === undefined) {
85
+ throw new Error(`Output parameter index ${String(out.paramIndex)} out of range on ${plan.command.name}`);
40
86
  }
41
- if (members.length === 0) {
87
+ return `${backtick(param.name)} (${metadataNotes(paramShape(param, paramPlan, out.tsType))})`;
88
+ };
89
+ const returnsDocLine = (plan, outs) => {
90
+ const members = [
91
+ ...(plan.returnPlan.kind === "void" ? [] : [metadataNotes(returnShape(plan))]),
92
+ ...outs.map((out) => outMember(plan, out)),
93
+ ];
94
+ const [single] = members;
95
+ if (single === undefined) {
42
96
  return undefined;
43
97
  }
44
- const [single] = members;
45
- if (single !== undefined && members.length === 1) {
98
+ if (members.length === 1) {
46
99
  return ` * @returns ${single}`;
47
100
  }
48
101
  return ` * @returns Tuple of ${members.join(", ")}`;
49
102
  };
50
- const singularJsDoc = ({ commandName, feature, summary, body }) => [
103
+ const tagBlock = (tags) => (tags.length === 0 ? [] : [" *", ...tags]);
104
+ const derivedJsDoc = ({ command, provenance, summary, body, docs }) => [
51
105
  "/**",
52
106
  ` * ${summary}`,
53
107
  " *",
54
- ` * Provided by \`${feature}\`.`,
55
- ...body,
56
- ` * @see ${REFPAGES_BASE}/${commandName}.xhtml`,
108
+ ...provenanceLines(provenance, docs.extensionCommands.get(command.name) ?? []),
109
+ ...tagBlock(body),
57
110
  " */",
58
111
  ].join("\n");
59
- const commandJsDoc = ({ command, feature, ins, outs, returnPlan }) => {
60
- const returnsLine = returnsDocLine(command, returnPlan, outs);
61
- return singularJsDoc({
62
- commandName: command.name,
63
- feature,
64
- summary: `\`${formatPrototype(command)}\``,
65
- body: [
66
- ...(ins.length > 0 ? [" *", ...ins.map((arg) => inParamDocLine(command, arg))] : []),
67
- ...(returnsLine === undefined ? [] : [returnsLine]),
68
- ],
69
- });
112
+ const commandJsDoc = ({ plan, provenance, ins, outs, docs }) => {
113
+ const { command } = plan;
114
+ const returnsLine = returnsDocLine(plan, outs);
115
+ const tags = [
116
+ ...ins.map((arg) => inParamDocLine(plan, arg, docs)),
117
+ ...(returnsLine === undefined ? [] : [returnsLine]),
118
+ ];
119
+ return [
120
+ "/**",
121
+ ` * ${backtick(formatPrototype(command))}`,
122
+ " *",
123
+ ...provenanceLines(provenance, docs.extensionCommands.get(command.name) ?? []),
124
+ ...commandNotes(command, docs),
125
+ ...tagBlock(tags),
126
+ " */",
127
+ ].join("\n");
70
128
  };
71
- export { inParamDocLine, singularJsDoc, commandJsDoc };
129
+ export { commandJsDoc, derivedJsDoc, inParamDocLine };
72
130
  //# sourceMappingURL=jsdoc.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"jsdoc.js","sourceRoot":"","sources":["../../src/khronos/jsdoc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC;AAoBhD,MAAM,aAAa,GAAG,uDAAuD,CAAC;AAE9E,MAAM,eAAe,GAAG,CAAC,OAAkB,EAAU,EAAE;IACnD,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM;SACxB,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,KAAK,GAAG,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,KAAK,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC;SAC5G,IAAI,CAAC,IAAI,CAAC,CAAC;IAEhB,OAAO,GAAG,OAAO,CAAC,WAAW,IAAI,OAAO,CAAC,IAAI,IAAI,MAAM,GAAG,CAAC;AAC/D,CAAC,CAAC;AAEF,MAAM,cAAc,GAAG,CAAC,OAAkB,EAAE,GAAU,EAAU,EAAE;IAC9D,MAAM,KAAK,GAAG,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,iBAAiB,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,GAAG,CAAC,IAAI,CAAC,CAAC;IAEjG,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;QACtB,OAAO,aAAa,GAAG,CAAC,IAAI,EAAE,CAAC;IACnC,CAAC;IAED,MAAM,KAAK,GAAa,CAAC,KAAK,KAAK,CAAC,KAAK,IAAI,CAAC,CAAC;IAE/C,IAAI,KAAK,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;QAC5B,KAAK,CAAC,IAAI,CAAC,WAAW,KAAK,CAAC,KAAK,IAAI,CAAC,CAAC;IAC3C,CAAC;IAED,IAAI,KAAK,CAAC,GAAG,KAAK,SAAS,EAAE,CAAC;QAC1B,KAAK,CAAC,IAAI,CAAC,YAAY,KAAK,CAAC,GAAG,IAAI,CAAC,CAAC;IAC1C,CAAC;IAED,IAAI,KAAK,CAAC,WAAW,KAAK,SAAS,EAAE,CAAC;QAClC,KAAK,CAAC,IAAI,CAAC,kBAAkB,KAAK,CAAC,WAAW,IAAI,CAAC,CAAC;IACxD,CAAC;IAED,OAAO,aAAa,GAAG,CAAC,IAAI,MAAM,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;AACzD,CAAC,CAAC;AAEF,MAAM,SAAS,GAAG,CAAC,OAAkB,EAAE,GAAW,EAAU,EAAE;IAC1D,MAAM,KAAK,GAAG,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;IAE7C,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;QACtB,MAAM,IAAI,KAAK,CAAC,0BAA0B,MAAM,CAAC,GAAG,CAAC,UAAU,CAAC,oBAAoB,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC;IACxG,CAAC;IAED,OAAO,KAAK,KAAK,CAAC,IAAI,SAAS,KAAK,CAAC,KAAK,KAAK,CAAC;AACpD,CAAC,CAAC;AAEF,MAAM,cAAc,GAAG,CAAC,OAAkB,EAAE,UAAsB,EAAE,IAAc,EAAsB,EAAE;IACtG,MAAM,OAAO,GAAa,EAAE,CAAC;IAE7B,IAAI,UAAU,CAAC,IAAI,KAAK,MAAM,EAAE,CAAC;QAC7B,OAAO,CAAC,IAAI,CAAC,KAAK,OAAO,CAAC,WAAW,IAAI,CAAC,CAAC;IAC/C,CAAC;IAED,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;QACrB,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC,CAAC;IAC1C,CAAC;IAED,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACvB,OAAO,SAAS,CAAC;IACrB,CAAC;IAED,MAAM,CAAC,MAAM,CAAC,GAAG,OAAO,CAAC;IAEzB,IAAI,MAAM,KAAK,SAAS,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC/C,OAAO,eAAe,MAAM,EAAE,CAAC;IACnC,CAAC;IAED,OAAO,wBAAwB,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;AACxD,CAAC,CAAC;AAEF,MAAM,aAAa,GAAG,CAAC,EAAE,WAAW,EAAE,OAAO,EAAE,OAAO,EAAE,IAAI,EAAwB,EAAU,EAAE,CAC5F;IACI,KAAK;IACL,MAAM,OAAO,EAAE;IACf,IAAI;IACJ,oBAAoB,OAAO,KAAK;IAChC,GAAG,IAAI;IACP,WAAW,aAAa,IAAI,WAAW,QAAQ;IAC/C,KAAK;CACR,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAEjB,MAAM,YAAY,GAAG,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,GAAG,EAAE,IAAI,EAAE,UAAU,EAAuB,EAAU,EAAE;IAC9F,MAAM,WAAW,GAAG,cAAc,CAAC,OAAO,EAAE,UAAU,EAAE,IAAI,CAAC,CAAC;IAE9D,OAAO,aAAa,CAAC;QACjB,WAAW,EAAE,OAAO,CAAC,IAAI;QACzB,OAAO;QACP,OAAO,EAAE,KAAK,eAAe,CAAC,OAAO,CAAC,IAAI;QAC1C,IAAI,EAAE;YACF,GAAG,CAAC,GAAG,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,GAAG,GAAG,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,cAAc,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;YACpF,GAAG,CAAC,WAAW,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC;SACtD;KACJ,CAAC,CAAC;AACP,CAAC,CAAC;AAEF,OAAO,EAAE,cAAc,EAAE,aAAa,EAAE,YAAY,EAAE,CAAC","sourcesContent":["import { toCamelIdentifier } from \"@gtkx/utils\";\nimport type { InArg, OutArg } from \"./args.js\";\nimport type { GlCommand } from \"./model.js\";\nimport type { ReturnPlan } from \"./plan.js\";\n\ntype CommandJsDocOptions = {\n command: GlCommand;\n feature: string;\n ins: InArg[];\n outs: OutArg[];\n returnPlan: ReturnPlan;\n};\n\ntype SingularJsDocOptions = {\n commandName: string;\n feature: string;\n summary: string;\n body: string[];\n};\n\nconst REFPAGES_BASE = \"https://registry.khronos.org/OpenGL-Refpages/gl4/html\";\n\nconst formatPrototype = (command: GlCommand): string => {\n const params = command.params\n .map((param) => (param.cType.endsWith(\"*\") ? `${param.cType}${param.name}` : `${param.cType} ${param.name}`))\n .join(\", \");\n\n return `${command.returnCType} ${command.name}(${params})`;\n};\n\nconst inParamDocLine = (command: GlCommand, arg: InArg): string => {\n const param = command.params.find((candidate) => toCamelIdentifier(candidate.name) === arg.name);\n\n if (param === undefined) {\n return ` * @param ${arg.name}`;\n }\n\n const notes: string[] = [`\\`${param.cType}\\``];\n\n if (param.group !== undefined) {\n notes.push(`group \\`${param.group}\\``);\n }\n\n if (param.len !== undefined) {\n notes.push(`length \\`${param.len}\\``);\n }\n\n if (param.objectClass !== undefined) {\n notes.push(`object class \\`${param.objectClass}\\``);\n }\n\n return ` * @param ${arg.name} - ${notes.join(\", \")}`;\n};\n\nconst outMember = (command: GlCommand, out: OutArg): string => {\n const param = command.params[out.paramIndex];\n\n if (param === undefined) {\n throw new Error(`Output parameter index ${String(out.paramIndex)} out of range on ${command.name}`);\n }\n\n return `\\`${param.name}\\` (\\`${param.cType}\\`)`;\n};\n\nconst returnsDocLine = (command: GlCommand, returnPlan: ReturnPlan, outs: OutArg[]): string | undefined => {\n const members: string[] = [];\n\n if (returnPlan.kind !== \"void\") {\n members.push(`\\`${command.returnCType}\\``);\n }\n\n for (const out of outs) {\n members.push(outMember(command, out));\n }\n\n if (members.length === 0) {\n return undefined;\n }\n\n const [single] = members;\n\n if (single !== undefined && members.length === 1) {\n return ` * @returns ${single}`;\n }\n\n return ` * @returns Tuple of ${members.join(\", \")}`;\n};\n\nconst singularJsDoc = ({ commandName, feature, summary, body }: SingularJsDocOptions): string =>\n [\n \"/**\",\n ` * ${summary}`,\n \" *\",\n ` * Provided by \\`${feature}\\`.`,\n ...body,\n ` * @see ${REFPAGES_BASE}/${commandName}.xhtml`,\n \" */\",\n ].join(\"\\n\");\n\nconst commandJsDoc = ({ command, feature, ins, outs, returnPlan }: CommandJsDocOptions): string => {\n const returnsLine = returnsDocLine(command, returnPlan, outs);\n\n return singularJsDoc({\n commandName: command.name,\n feature,\n summary: `\\`${formatPrototype(command)}\\``,\n body: [\n ...(ins.length > 0 ? [\" *\", ...ins.map((arg) => inParamDocLine(command, arg))] : []),\n ...(returnsLine === undefined ? [] : [returnsLine]),\n ],\n });\n};\n\nexport { inParamDocLine, singularJsDoc, commandJsDoc };\n"]}
1
+ {"version":3,"file":"jsdoc.js","sourceRoot":"","sources":["../../src/khronos/jsdoc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC;AAMhD,OAAO,EAAE,gBAAgB,EAAE,kBAAkB,EAAE,MAAM,WAAW,CAAC;AACjE,OAAO,EACH,UAAU,EACV,QAAQ,EACR,YAAY,EACZ,iBAAiB,EACjB,gBAAgB,EAChB,aAAa,EAEb,eAAe,GAClB,MAAM,YAAY,CAAC;AACpB,OAAO,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAyB9C,MAAM,kBAAkB,GAAgB,IAAI,GAAG,CAAC,CAAC,QAAQ,EAAE,UAAU,EAAE,SAAS,EAAE,eAAe,CAAC,CAAC,CAAC;AACpG,MAAM,qBAAqB,GAAgB,IAAI,GAAG,CAAC,CAAC,aAAa,EAAE,mBAAmB,EAAE,SAAS,CAAC,CAAC,CAAC;AAEpG,MAAM,YAAY,GAAwB,IAAI,GAAG,CAAC;IAC9C,CAAC,aAAa,EAAE,mCAAmC,CAAC;IACpD,CAAC,mBAAmB,EAAE,oCAAoC,CAAC;CAC9D,CAAC,CAAC;AAEH,MAAM,eAAe,GAAG,CAAC,OAAkB,EAAU,EAAE;IACnD,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM;SACxB,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,KAAK,GAAG,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,KAAK,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC;SAC5G,IAAI,CAAC,IAAI,CAAC,CAAC;IAEhB,OAAO,GAAG,OAAO,CAAC,WAAW,IAAI,OAAO,CAAC,IAAI,IAAI,MAAM,GAAG,CAAC;AAC/D,CAAC,CAAC;AAEF,MAAM,OAAO,GAAG,CAAC,GAAU,EAAU,EAAE;IACnC,MAAM,MAAM,GAAG,UAAU,GAAG,CAAC,IAAI,WAAW,GAAG,CAAC,MAAM,GAAG,CAAC;IAE1D,OAAO,GAAG,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,MAAM,IAAI,UAAU,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC;AACvF,CAAC,CAAC;AAEF,MAAM,SAAS,GAAG,CAAC,OAAiB,EAAU,EAAE,CAAC,oBAAoB,YAAY,CAAC,OAAO,CAAC,GAAG,CAAC;AAE9F,MAAM,eAAe,GAAG,CAAC,OAAkB,EAAE,IAAkB,EAAY,EAAE;IACzE,MAAM,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC;IAEhC,IAAI,MAAM,KAAK,SAAS,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC;QAC5D,OAAO,EAAE,CAAC;IACd,CAAC;IAED,OAAO,CAAC,mBAAmB,QAAQ,CAAC,iBAAiB,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC;AACvE,CAAC,CAAC;AAEF,MAAM,YAAY,GAAG,CAAC,OAAkB,EAAE,IAAkB,EAAY,EAAE;IACtE,MAAM,OAAO,GAAG,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;IAE1D,OAAO;QACH,GAAG,CAAC,OAAO,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,qBAAqB,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC;QAClF,GAAG,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QACnD,GAAG,eAAe,CAAC,OAAO,EAAE,IAAI,CAAC;QACjC,GAAG,CAAC,OAAO,CAAC,GAAG,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC;KAC/D,CAAC;AACN,CAAC,CAAC;AAEF,MAAM,aAAa,GAAG,CAAC,IAA4B,EAAE,KAAa,EAAW,EAAE,CAC3E,kBAAkB,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC;IACjC,QAAQ,IAAI,IAAI;IAChB,kBAAkB,CAAC,IAAI,CAAC,MAAM,EAAE,KAAK,CAAC,KAAK,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC;AAEnE,MAAM,UAAU,GAAG,CAAC,KAAc,EAAE,SAAoB,EAAsB,EAAE,CAC5E,KAAK,CAAC,KAAK,KAAK,SAAS,IAAI,aAAa,CAAC,SAAS,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,EAAE,CAAC;AAErG,MAAM,WAAW,GAAG,CAAC,KAAc,EAAE,SAAoB,EAAoB,EAAE,CAC3E,KAAK,CAAC,GAAG,KAAK,SAAS,IAAI,qBAAqB,CAAC,GAAG,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,KAAK,CAAC,GAAG,EAAE,CAAC;AAEnG,MAAM,UAAU,GAAG,CAAC,KAAc,EAAE,SAAoB,EAAE,IAAY,EAAwB,EAAE;IAC5F,MAAM,IAAI,GAAG,YAAY,CAAC,GAAG,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;IAE9C,OAAO;QACH,IAAI;QACJ,GAAG,UAAU,CAAC,KAAK,EAAE,SAAS,CAAC;QAC/B,GAAG,WAAW,CAAC,KAAK,EAAE,SAAS,CAAC;QAChC,GAAG,CAAC,KAAK,CAAC,WAAW,KAAK,SAAS,IAAI,EAAE,WAAW,EAAE,KAAK,CAAC,WAAW,EAAE,CAAC;QAC1E,GAAG,CAAC,IAAI,KAAK,SAAS,IAAI,EAAE,IAAI,EAAE,CAAC;QACnC,KAAK,EAAE,KAAK,CAAC,KAAK;KACrB,CAAC;AACN,CAAC,CAAC;AAEF,MAAM,WAAW,GAAG,CAAC,IAAY,EAAwB,EAAE;IACvD,MAAM,EAAE,OAAO,EAAE,UAAU,EAAE,GAAG,IAAI,CAAC;IACrC,MAAM,KAAK,GAAG,OAAO,CAAC,WAAW,CAAC;IAElC,OAAO;QACH,IAAI,EAAE,gBAAgB,CAAC,UAAU,EAAE,KAAK,CAAC;QACzC,GAAG,CAAC,KAAK,KAAK,SAAS,IAAI,CAAC,aAAa,CAAC,UAAU,EAAE,KAAK,CAAC,IAAI,EAAE,KAAK,EAAE,CAAC;QAC1E,GAAG,CAAC,OAAO,CAAC,iBAAiB,KAAK,SAAS,IAAI,EAAE,WAAW,EAAE,OAAO,CAAC,iBAAiB,EAAE,CAAC;QAC1F,KAAK,EAAE,OAAO,CAAC,WAAW;KAC7B,CAAC;AACN,CAAC,CAAC;AAEF,MAAM,YAAY,GAAG,CAAC,IAAY,EAAE,OAAe,EAAyB,EAAE;IAC1E,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,iBAAiB,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,OAAO,CAAC,CAAC;IAC1G,MAAM,EAAE,KAAK,EAAE,SAAS,EAAE,GAAG,WAAW,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IAEtD,IAAI,KAAK,KAAK,SAAS,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;QACjD,OAAO,SAAS,CAAC;IACrB,CAAC;IAED,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC;AAChC,CAAC,CAAC;AAEF,MAAM,cAAc,GAAG,CAAC,IAAY,EAAE,GAAU,EAAE,IAAkB,EAAU,EAAE;IAC5E,MAAM,IAAI,GAAG,YAAY,CAAC,IAAI,EAAE,GAAG,CAAC,IAAI,CAAC,CAAC;IAE1C,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;QACrB,OAAO,aAAa,GAAG,CAAC,IAAI,EAAE,CAAC;IACnC,CAAC;IAED,MAAM,YAAY,GAAG,gBAAgB,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC;IACpE,MAAM,QAAQ,GAAG,YAAY,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,YAAY,EAAE,CAAC;IACtE,MAAM,KAAK,GAAG,aAAa,CAAC,UAAU,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,SAAS,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC;IAEhF,OAAO,aAAa,GAAG,CAAC,IAAI,MAAM,KAAK,GAAG,QAAQ,EAAE,CAAC;AACzD,CAAC,CAAC;AAEF,MAAM,SAAS,GAAG,CAAC,IAAY,EAAE,GAAW,EAAU,EAAE;IACpD,MAAM,EAAE,KAAK,EAAE,SAAS,EAAE,GAAG,WAAW,CAAC,IAAI,EAAE,GAAG,CAAC,UAAU,CAAC,CAAC;IAE/D,IAAI,KAAK,KAAK,SAAS,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;QACjD,MAAM,IAAI,KAAK,CAAC,0BAA0B,MAAM,CAAC,GAAG,CAAC,UAAU,CAAC,oBAAoB,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC;IAC7G,CAAC;IAED,OAAO,GAAG,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,aAAa,CAAC,UAAU,CAAC,KAAK,EAAE,SAAS,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC;AAClG,CAAC,CAAC;AAEF,MAAM,cAAc,GAAG,CAAC,IAAY,EAAE,IAAc,EAAsB,EAAE;IACxE,MAAM,OAAO,GAAG;QACZ,GAAG,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,KAAK,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAC9E,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,SAAS,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;KAC7C,CAAC;IAEF,MAAM,CAAC,MAAM,CAAC,GAAG,OAAO,CAAC;IAEzB,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;QACvB,OAAO,SAAS,CAAC;IACrB,CAAC;IAED,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACvB,OAAO,eAAe,MAAM,EAAE,CAAC;IACnC,CAAC;IAED,OAAO,wBAAwB,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;AACxD,CAAC,CAAC;AAEF,MAAM,QAAQ,GAAG,CAAC,IAAc,EAAY,EAAE,CAAC,CAAC,IAAI,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,GAAG,IAAI,CAAC,CAAC,CAAC;AAE1F,MAAM,YAAY,GAAG,CAAC,EAAE,OAAO,EAAE,UAAU,EAAE,OAAO,EAAE,IAAI,EAAE,IAAI,EAAuB,EAAU,EAAE,CAC/F;IACI,KAAK;IACL,MAAM,OAAO,EAAE;IACf,IAAI;IACJ,GAAG,eAAe,CAAC,UAAU,EAAE,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;IAC9E,GAAG,QAAQ,CAAC,IAAI,CAAC;IACjB,KAAK;CACR,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAEjB,MAAM,YAAY,GAAG,CAAC,EAAE,IAAI,EAAE,UAAU,EAAE,GAAG,EAAE,IAAI,EAAE,IAAI,EAAuB,EAAU,EAAE;IACxF,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC;IACzB,MAAM,WAAW,GAAG,cAAc,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IAE/C,MAAM,IAAI,GAAG;QACT,GAAG,GAAG,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,cAAc,CAAC,IAAI,EAAE,GAAG,EAAE,IAAI,CAAC,CAAC;QACpD,GAAG,CAAC,WAAW,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC;KACtD,CAAC;IAEF,OAAO;QACH,KAAK;QACL,MAAM,QAAQ,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC,EAAE;QAC1C,IAAI;QACJ,GAAG,eAAe,CAAC,UAAU,EAAE,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;QAC9E,GAAG,YAAY,CAAC,OAAO,EAAE,IAAI,CAAC;QAC9B,GAAG,QAAQ,CAAC,IAAI,CAAC;QACjB,KAAK;KACR,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AACjB,CAAC,CAAC;AAEF,OAAO,EAAE,YAAY,EAAE,YAAY,EAAE,cAAc,EAAE,CAAC","sourcesContent":["import { toCamelIdentifier } from \"@gtkx/utils\";\nimport type { InArg, OutArg } from \"./args.js\";\nimport type { GlDocContext } from \"./doc-context.js\";\nimport type { GlCommand, GlGlx, GlParam } from \"./model.js\";\nimport type { CommandPlan, ParamPlan, ReturnPlan } from \"./plan.js\";\nimport type { GlSymbolProvenance } from \"./select.js\";\nimport { returnPlanTsType, scalarAliasOrGroup } from \"./args.js\";\nimport {\n asSentence,\n backtick,\n backtickList,\n commandExportName,\n kindDescriptions,\n metadataNotes,\n type MetadataNotesOptions,\n provenanceLines,\n} from \"./notes.js\";\nimport { paramPairAt } from \"./param-pair.js\";\n\ntype OkPlan = CommandPlan & { isOk: true };\n\ntype ParamPair = {\n param: GlParam;\n paramPlan: ParamPlan;\n};\n\ntype CommandJsDocOptions = {\n plan: OkPlan;\n provenance: GlSymbolProvenance;\n ins: InArg[];\n outs: OutArg[];\n docs: GlDocContext;\n};\n\ntype DerivedJsDocOptions = {\n command: GlCommand;\n provenance: GlSymbolProvenance;\n summary: string;\n body: string[];\n docs: GlDocContext;\n};\n\nconst GROUPED_PLAN_KINDS: Set<string> = new Set([\"scalar\", \"array-in\", \"ref-out\", \"ref-array-out\"]);\nconst LENGTHLESS_PLAN_KINDS: Set<string> = new Set([\"byte-offset\", \"byte-offset-array\", \"ref-out\"]);\n\nconst OFFSET_NOTES: Map<string, string> = new Map([\n [\"byte-offset\", \"byte offset into the bound buffer\"],\n [\"byte-offset-array\", \"byte offsets into the bound buffer\"],\n]);\n\nconst formatPrototype = (command: GlCommand): string => {\n const params = command.params\n .map((param) => (param.cType.endsWith(\"*\") ? `${param.cType}${param.name}` : `${param.cType} ${param.name}`))\n .join(\", \");\n\n return `${command.returnCType} ${command.name}(${params})`;\n};\n\nconst glxLine = (glx: GlGlx): string => {\n const opcode = ` * GLX ${glx.type} opcode ${glx.opcode}.`;\n\n return glx.comment === undefined ? opcode : `${opcode} ${asSentence(glx.comment)}`;\n};\n\nconst aliasLine = (aliases: string[]): string => ` * Also known as ${backtickList(aliases)}.`;\n\nconst vectorFormLines = (command: GlCommand, docs: GlDocContext): string[] => {\n const target = command.vecEquiv;\n\n if (target === undefined || !docs.emittedCommands.has(target)) {\n return [];\n }\n\n return [` * Vector form: ${backtick(commandExportName(target))}.`];\n};\n\nconst commandNotes = (command: GlCommand, docs: GlDocContext): string[] => {\n const aliases = docs.aliasTargets.get(command.name) ?? [];\n\n return [\n ...(command.comment === undefined ? [] : [` * Registry note: ${command.comment}`]),\n ...(aliases.length > 0 ? [aliasLine(aliases)] : []),\n ...vectorFormLines(command, docs),\n ...(command.glx === undefined ? [] : [glxLine(command.glx)]),\n ];\n};\n\nconst isGroupFolded = (plan: ParamPlan | ReturnPlan, group: string): boolean =>\n GROUPED_PLAN_KINDS.has(plan.kind) &&\n \"scalar\" in plan &&\n scalarAliasOrGroup(plan.scalar, group) !== plan.scalar.tsAlias;\n\nconst groupEntry = (param: GlParam, paramPlan: ParamPlan): { group?: string } =>\n param.group === undefined || isGroupFolded(paramPlan, param.group) ? {} : { group: param.group };\n\nconst lengthEntry = (param: GlParam, paramPlan: ParamPlan): { len?: string } =>\n param.len === undefined || LENGTHLESS_PLAN_KINDS.has(paramPlan.kind) ? {} : { len: param.len };\n\nconst paramShape = (param: GlParam, paramPlan: ParamPlan, type: string): MetadataNotesOptions => {\n const note = OFFSET_NOTES.get(paramPlan.kind);\n\n return {\n type,\n ...groupEntry(param, paramPlan),\n ...lengthEntry(param, paramPlan),\n ...(param.objectClass !== undefined && { objectClass: param.objectClass }),\n ...(note !== undefined && { note }),\n kinds: param.kinds,\n };\n};\n\nconst returnShape = (plan: OkPlan): MetadataNotesOptions => {\n const { command, returnPlan } = plan;\n const group = command.returnGroup;\n\n return {\n type: returnPlanTsType(returnPlan, group),\n ...(group !== undefined && !isGroupFolded(returnPlan, group) && { group }),\n ...(command.returnObjectClass !== undefined && { objectClass: command.returnObjectClass }),\n kinds: command.returnKinds,\n };\n};\n\nconst paramPairFor = (plan: OkPlan, argName: string): ParamPair | undefined => {\n const index = plan.command.params.findIndex((candidate) => toCamelIdentifier(candidate.name) === argName);\n const { param, paramPlan } = paramPairAt(plan, index);\n\n if (param === undefined || paramPlan === undefined) {\n return undefined;\n }\n\n return { param, paramPlan };\n};\n\nconst inParamDocLine = (plan: OkPlan, arg: InArg, docs: GlDocContext): string => {\n const pair = paramPairFor(plan, arg.name);\n\n if (pair === undefined) {\n return ` * @param ${arg.name}`;\n }\n\n const descriptions = kindDescriptions(pair.param.kinds, docs.kinds);\n const sentence = descriptions.length === 0 ? \"\" : `. ${descriptions}`;\n const notes = metadataNotes(paramShape(pair.param, pair.paramPlan, arg.tsType));\n\n return ` * @param ${arg.name} - ${notes}${sentence}`;\n};\n\nconst outMember = (plan: OkPlan, out: OutArg): string => {\n const { param, paramPlan } = paramPairAt(plan, out.paramIndex);\n\n if (param === undefined || paramPlan === undefined) {\n throw new Error(`Output parameter index ${String(out.paramIndex)} out of range on ${plan.command.name}`);\n }\n\n return `${backtick(param.name)} (${metadataNotes(paramShape(param, paramPlan, out.tsType))})`;\n};\n\nconst returnsDocLine = (plan: OkPlan, outs: OutArg[]): string | undefined => {\n const members = [\n ...(plan.returnPlan.kind === \"void\" ? [] : [metadataNotes(returnShape(plan))]),\n ...outs.map((out) => outMember(plan, out)),\n ];\n\n const [single] = members;\n\n if (single === undefined) {\n return undefined;\n }\n\n if (members.length === 1) {\n return ` * @returns ${single}`;\n }\n\n return ` * @returns Tuple of ${members.join(\", \")}`;\n};\n\nconst tagBlock = (tags: string[]): string[] => (tags.length === 0 ? [] : [\" *\", ...tags]);\n\nconst derivedJsDoc = ({ command, provenance, summary, body, docs }: DerivedJsDocOptions): string =>\n [\n \"/**\",\n ` * ${summary}`,\n \" *\",\n ...provenanceLines(provenance, docs.extensionCommands.get(command.name) ?? []),\n ...tagBlock(body),\n \" */\",\n ].join(\"\\n\");\n\nconst commandJsDoc = ({ plan, provenance, ins, outs, docs }: CommandJsDocOptions): string => {\n const { command } = plan;\n const returnsLine = returnsDocLine(plan, outs);\n\n const tags = [\n ...ins.map((arg) => inParamDocLine(plan, arg, docs)),\n ...(returnsLine === undefined ? [] : [returnsLine]),\n ];\n\n return [\n \"/**\",\n ` * ${backtick(formatPrototype(command))}`,\n \" *\",\n ...provenanceLines(provenance, docs.extensionCommands.get(command.name) ?? []),\n ...commandNotes(command, docs),\n ...tagBlock(tags),\n \" */\",\n ].join(\"\\n\");\n};\n\nexport { commandJsDoc, derivedJsDoc, inParamDocLine };\n"]}
@@ -4,20 +4,42 @@ type GlParam = {
4
4
  group?: string;
5
5
  len?: string;
6
6
  objectClass?: string;
7
+ kinds: string[];
8
+ };
9
+ type GlGlx = {
10
+ type: string;
11
+ opcode: string;
12
+ comment?: string;
7
13
  };
8
14
  type GlCommand = {
9
15
  name: string;
10
16
  returnCType: string;
11
17
  returnGroup?: string;
18
+ returnObjectClass?: string;
19
+ returnKinds: string[];
20
+ comment?: string;
21
+ aliasTarget?: string;
22
+ vecEquiv?: string;
23
+ glx?: GlGlx;
12
24
  params: GlParam[];
13
25
  };
14
26
  type GlEnum = {
15
27
  name: string;
16
28
  value: string;
17
29
  groups: string[];
30
+ comment?: string;
31
+ alias?: string;
32
+ api?: string;
33
+ valueType?: string;
34
+ vendor?: string;
35
+ blockComment?: string;
36
+ isBitmask: boolean;
18
37
  };
19
38
  type GlInterfaceBlock = {
39
+ kind: "require" | "remove";
40
+ api?: string;
20
41
  profile?: string;
42
+ comment?: string;
21
43
  commands: string[];
22
44
  enums: string[];
23
45
  };
@@ -25,14 +47,31 @@ type GlFeature = {
25
47
  api: string;
26
48
  name: string;
27
49
  number: number;
28
- requires: GlInterfaceBlock[];
29
- removes: GlInterfaceBlock[];
50
+ blocks: GlInterfaceBlock[];
51
+ };
52
+ type GlExtension = {
53
+ name: string;
54
+ supported: string[];
55
+ comment?: string;
56
+ blocks: GlInterfaceBlock[];
57
+ };
58
+ type GlType = {
59
+ name: string;
60
+ declaration: string;
61
+ requires?: string;
62
+ comment?: string;
30
63
  };
31
64
  type GlRegistry = {
65
+ comment?: string;
66
+ types: Map<string, GlType>;
67
+ kinds: Map<string, string>;
32
68
  commands: Map<string, GlCommand>;
33
69
  enums: GlEnum[];
34
70
  features: GlFeature[];
71
+ extensions: GlExtension[];
72
+ aliasTargets: Map<string, string[]>;
73
+ bitmaskGroups: Set<string>;
35
74
  };
36
75
  declare const loadGlRegistry: (path: string) => GlRegistry;
37
- export { loadGlRegistry, type GlParam, type GlCommand, type GlEnum, type GlInterfaceBlock, type GlFeature, type GlRegistry, };
76
+ export { loadGlRegistry, type GlParam, type GlGlx, type GlCommand, type GlEnum, type GlInterfaceBlock, type GlFeature, type GlExtension, type GlType, type GlRegistry, };
38
77
  //# sourceMappingURL=model.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"model.d.ts","sourceRoot":"","sources":["../../src/khronos/model.ts"],"names":[],"mappings":"AAEA,KAAK,OAAO,GAAG;IACX,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;CACxB,CAAC;AAEF,KAAK,SAAS,GAAG;IACb,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,MAAM,EAAE,OAAO,EAAE,CAAC;CACrB,CAAC;AAEF,KAAK,MAAM,GAAG;IACV,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,EAAE,CAAC;CACpB,CAAC;AAEF,KAAK,gBAAgB,GAAG;IACpB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,EAAE,CAAC;IACnB,KAAK,EAAE,MAAM,EAAE,CAAC;CACnB,CAAC;AAEF,KAAK,SAAS,GAAG;IACb,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,gBAAgB,EAAE,CAAC;IAC7B,OAAO,EAAE,gBAAgB,EAAE,CAAC;CAC/B,CAAC;AAEF,KAAK,UAAU,GAAG;IACd,QAAQ,EAAE,GAAG,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;IACjC,KAAK,EAAE,MAAM,EAAE,CAAC;IAChB,QAAQ,EAAE,SAAS,EAAE,CAAC;CACzB,CAAC;AA+MF,QAAA,MAAM,cAAc,GAAI,MAAM,MAAM,KAAG,UAQtC,CAAC;AAEF,OAAO,EACH,cAAc,EACd,KAAK,OAAO,EACZ,KAAK,SAAS,EACd,KAAK,MAAM,EACX,KAAK,gBAAgB,EACrB,KAAK,SAAS,EACd,KAAK,UAAU,GAClB,CAAC"}
1
+ {"version":3,"file":"model.d.ts","sourceRoot":"","sources":["../../src/khronos/model.ts"],"names":[],"mappings":"AAGA,KAAK,OAAO,GAAG;IACX,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,KAAK,EAAE,MAAM,EAAE,CAAC;CACnB,CAAC;AAEF,KAAK,KAAK,GAAG;IACT,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF,KAAK,SAAS,GAAG;IACb,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,WAAW,EAAE,MAAM,EAAE,CAAC;IACtB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,GAAG,CAAC,EAAE,KAAK,CAAC;IACZ,MAAM,EAAE,OAAO,EAAE,CAAC;CACrB,CAAC;AAEF,KAAK,MAAM,GAAG;IACV,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,SAAS,EAAE,OAAO,CAAC;CACtB,CAAC;AASF,KAAK,gBAAgB,GAAG;IACpB,IAAI,EAAE,SAAS,GAAG,QAAQ,CAAC;IAC3B,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,EAAE,CAAC;IACnB,KAAK,EAAE,MAAM,EAAE,CAAC;CACnB,CAAC;AAEF,KAAK,SAAS,GAAG;IACb,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,gBAAgB,EAAE,CAAC;CAC9B,CAAC;AAEF,KAAK,WAAW,GAAG;IACf,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,MAAM,EAAE,CAAC;IACpB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,gBAAgB,EAAE,CAAC;CAC9B,CAAC;AAEF,KAAK,MAAM,GAAG;IACV,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF,KAAK,UAAU,GAAG;IACd,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC3B,KAAK,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC3B,QAAQ,EAAE,GAAG,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;IACjC,KAAK,EAAE,MAAM,EAAE,CAAC;IAChB,QAAQ,EAAE,SAAS,EAAE,CAAC;IACtB,UAAU,EAAE,WAAW,EAAE,CAAC;IAC1B,YAAY,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC;IACpC,aAAa,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;CAC9B,CAAC;AAoYF,QAAA,MAAM,cAAc,GAAI,MAAM,MAAM,KAAG,UAmBtC,CAAC;AAEF,OAAO,EACH,cAAc,EACd,KAAK,OAAO,EACZ,KAAK,KAAK,EACV,KAAK,SAAS,EACd,KAAK,MAAM,EACX,KAAK,gBAAgB,EACrB,KAAK,SAAS,EACd,KAAK,WAAW,EAChB,KAAK,MAAM,EACX,KAAK,UAAU,GAClB,CAAC"}