@girs/gtksource-3.0 4.7.0 → 4.9.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.
package/README.md CHANGED
@@ -4,7 +4,7 @@
4
4
  ![version](https://img.shields.io/npm/v/@girs/gtksource-3.0)
5
5
  ![downloads/week](https://img.shields.io/npm/dw/@girs/gtksource-3.0)
6
6
 
7
- GJS TypeScript type definitions for GtkSource-3.0 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v4.7.0.
7
+ GJS TypeScript type definitions for GtkSource-3.0 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v4.9.0.
8
8
 
9
9
  This package contains type declarations only. It ships no runtime code, so it adds
10
10
  nothing to your program and works with any bundler or none at all.
@@ -289,6 +289,82 @@ export const CHILD_HOLDERS: readonly string[];
289
289
  /** Enum GType -> the nicks this surface offers. */
290
290
  export const ENUM_NICKS: Readonly<Record<string, readonly string[]>>;
291
291
 
292
+ /**
293
+ * `<enum GType>.<nick>` -> the integer GObject registers for it, from GIR's `value`.
294
+ *
295
+ * Position in `ENUM_NICKS` is NOT this number. Counting is wrong on 6 of the 129 enums a
296
+ * GTK 4 vocabulary carries -- 104 in Gtk-4.0 and 25 in Adw-1: `GtkResponseType` runs -1 to -11, `GtkTextWindowType` starts
297
+ * at 1, `GtkOrdering` and `GtkConstraintRelation` are -1/0/1, `GtkAlign` has two names
298
+ * on one value, and `GtkConstraintStrength.required` is 1001001000 where counting says 0.
299
+ *
300
+ * Read from the same GIR as the nicks, deliberately. A consumer reading the numbers off an
301
+ * installed typelib instead has two provenances for one table, and then cannot tell a
302
+ * missing number from a host older than the vocabulary.
303
+ */
304
+ export const ENUM_VALUES: Readonly<Record<string, number>>;
305
+
306
+ /**
307
+ * The `<enum GType>.<nick>` entries GIR marks `deprecated="1"`.
308
+ *
309
+ * Two names on one value is how GObject spells an alias -- `GTK_ALIGN_BASELINE` and
310
+ * `GTK_ALIGN_BASELINE_FILL` are both 4, and both keep a `ENUM_VALUES` entry. The pairing
311
+ * is visible in the numbers; which name is the old one is not, and this is that fact --
312
+ * where GIR states it. It usually does not: 4 registered-enum members across the 718 GIRs
313
+ * carry the attribute, and 179 of the 182 value-sharing pairs carry it on neither half, so
314
+ * absence from this list means GIR is silent, not that the nick is the current one.
315
+ */
316
+ export const ENUM_DEPRECATED: readonly string[];
317
+
318
+ /**
319
+ * `<enum GType>.<nick>` -> the raw GIR `value` no number could be read from.
320
+ *
321
+ * The declared remainder, so that every nick in `ENUM_NICKS` is in `ENUM_VALUES` or in
322
+ * here and a drop cannot be silent. Two shapes reach it: a symbolic or absent value (Vala
323
+ * writes `(null)`, a char enum writes a letter) and an integer past
324
+ * `Number.MAX_SAFE_INTEGER`, where a literal would lose precision and stop being the
325
+ * GIR's number. Empty for Gtk, Adw, GLib and Gio.
326
+ */
327
+ export const ENUM_VALUES_UNREADABLE: Readonly<Record<string, string>>;
328
+
329
+ /**
330
+ * `<bitfield GType>.<nick>` -> the integer GObject registers for that one member.
331
+ *
332
+ * `ENUM_NICKS` carries no bitfield, because GObject cannot resolve a nick SET; that says
333
+ * nothing about a single member's number, and the number is what a host without GI needs.
334
+ * 21 writable widget properties in Gtk-4.0 and Adw-1 are bitfield-typed and are declared
335
+ * bare `number` -- `GtkEntry:input-hints`, `GtkPopoverMenu:flags`, `AdwTabView:shortcuts`
336
+ * among them. Counting is worst here: 95 of 121 Gtk-4.0 bitfield members disagree with their
337
+ * position, against 29 of 685 enumeration members.
338
+ *
339
+ * Combine with `|` as GObject does. There is no nick table to pair this with, so a name
340
+ * here is resolvable and a SET still is not.
341
+ */
342
+ export const FLAG_VALUES: Readonly<Record<string, number>>;
343
+
344
+ /** `<bitfield GType>.<nick>` -> the raw GIR `value` no number could be read from. */
345
+ export const FLAG_VALUES_UNREADABLE: Readonly<Record<string, string>>;
346
+
347
+ /**
348
+ * `<declaration GType>.<property>` -> the GType of that property's enum or bitfield.
349
+ *
350
+ * The join the value tables need and nothing else here carries. A host with no GI has a
351
+ * property name and a nick and needs a number; `ENUM_VALUES` is keyed by ENUM GType, and
352
+ * only this says which enum a property is. Keyed by DECLARATION like `OWN_PROPS`, so it is
353
+ * read at every link of a `DECLS` chain — `orientation` belongs to `GtkOrientable`, not
354
+ * to the `GtkBox` a caller starts from.
355
+ *
356
+ * Present only where the property's OWN type is the enum: an array of them, or a union that
357
+ * merely mentions one, would be an entry a consumer resolves wrongly.
358
+ *
359
+ * The GType named here is not always one THIS module gives numbers for. A nick vocabulary is
360
+ * emitted once, by the namespace that owns the enum, so `AdwComboRow.search-match-mode` names
361
+ * `GtkStringFilterMatchMode` and its rows are in `@girs/gtk-4.0/vocabulary` — 57 of the 438
362
+ * entries in a full run resolve only with the owner's vocabulary loaded beside this one. An
363
+ * owner with no vocabulary of its own (Gdk, Pango) is inlined here instead, so every entry
364
+ * resolves against SOME module.
365
+ */
366
+ export const PROP_ENUMS: Readonly<Record<string, string>>;
367
+
292
368
  /** Widget GType -> slot name -> the method that may adopt a child there. */
293
369
  export const SLOT_CANDIDATES: Readonly<Record<string, Readonly<Record<string, string>>>>;
294
370
 
@@ -52,6 +52,143 @@ export const ENUM_NICKS = {
52
52
  GtkSourceViewGutterPosition: ['lines', 'marks'],
53
53
  };
54
54
 
55
+ // The number behind each of those nicks, read from GIR's own `value` attribute.
56
+ //
57
+ // It ships because position in `ENUM_NICKS` is not the value and a consumer with no
58
+ // typelib has no other way to learn it: a surface without GI still has to hand GObject an
59
+ // integer. The alternative a consumer reaches for first is counting, and counting is wrong
60
+ // on 6 of the 129 enums a GTK 4 vocabulary carries (104 in Gtk-4.0, 25 in Adw-1) --
61
+ // `GtkResponseType` runs -1 down to
62
+ // -11, `GtkTextWindowType` starts at 1, and `GtkConstraintStrength.required` is
63
+ // 1001001000 where counting answers 0.
64
+ //
65
+ // Same provenance as the nicks above, which is the point: a consumer that reads the numbers
66
+ // from an INSTALLED library instead gets two provenances for one table, and a member the
67
+ // vocabulary describes but the host predates then looks like a missing number rather than a
68
+ // version gap.
69
+ export const ENUM_VALUES = {
70
+ 'GtkSourceBackgroundPatternType.grid': 1,
71
+ 'GtkSourceBackgroundPatternType.none': 0,
72
+ 'GtkSourceBracketMatchType.found': 3,
73
+ 'GtkSourceBracketMatchType.none': 0,
74
+ 'GtkSourceBracketMatchType.not-found': 2,
75
+ 'GtkSourceBracketMatchType.out-of-range': 1,
76
+ 'GtkSourceChangeCaseType.lower': 0,
77
+ 'GtkSourceChangeCaseType.title': 3,
78
+ 'GtkSourceChangeCaseType.toggle': 2,
79
+ 'GtkSourceChangeCaseType.upper': 1,
80
+ 'GtkSourceCompressionType.gzip': 1,
81
+ 'GtkSourceCompressionType.none': 0,
82
+ 'GtkSourceGutterRendererAlignmentMode.cell': 0,
83
+ 'GtkSourceGutterRendererAlignmentMode.first': 1,
84
+ 'GtkSourceGutterRendererAlignmentMode.last': 2,
85
+ 'GtkSourceNewlineType.cr': 1,
86
+ 'GtkSourceNewlineType.cr-lf': 2,
87
+ 'GtkSourceNewlineType.lf': 0,
88
+ 'GtkSourceSmartHomeEndType.after': 2,
89
+ 'GtkSourceSmartHomeEndType.always': 3,
90
+ 'GtkSourceSmartHomeEndType.before': 1,
91
+ 'GtkSourceSmartHomeEndType.disabled': 0,
92
+ 'GtkSourceViewGutterPosition.lines': -30,
93
+ 'GtkSourceViewGutterPosition.marks': -20,
94
+ };
95
+
96
+ // The nicks GIR marks `deprecated="1"`.
97
+ //
98
+ // Two members of one enum may share a value -- that is how GObject spells an alias, and
99
+ // `GTK_ALIGN_BASELINE` and `GTK_ALIGN_BASELINE_FILL` are both 4. `ENUM_VALUES` keeps
100
+ // both names, so nothing is lost, and this is what says which of the two a number should be
101
+ // spelled back as. Stated rather than derived: the pairing is visible in the values, the
102
+ // DIRECTION is not.
103
+ //
104
+ // Read it as evidence, not as a negative: 4 registered-enum members in the 718 GIRs carry
105
+ // the attribute at all, and 179 of the 182 value-sharing pairs carry it on neither half.
106
+ // A nick missing from here is a nick GIR says nothing about, not a nick GIR calls current.
107
+ export const ENUM_DEPRECATED = [];
108
+
109
+ // The declared remainder: nicks whose GIR `value` is not a number this can carry.
110
+ //
111
+ // Every nick in `ENUM_NICKS` is in `ENUM_VALUES` or here -- a nick in neither would be a
112
+ // silent drop. GIR carries two shapes no integer holds: a symbolic or absent value (Vala
113
+ // writes `(null)`, a char enum writes a letter) and an integer past
114
+ // `Number.MAX_SAFE_INTEGER`. The value kept here is the raw attribute, so the entry says
115
+ // WHAT was unreadable rather than only that something was. Measured over the 718 GIRs in
116
+ // ts-for-gir's `girs/`: 32 of 34096 registered-enum members, none in Gtk, Adw, GLib or Gio.
117
+ export const ENUM_VALUES_UNREADABLE = {};
118
+
119
+ // The number behind each member of a registered BITFIELD, keyed the same way.
120
+ //
121
+ // `ENUM_NICKS` refuses a bitfield because GObject cannot resolve a nick SET, and that
122
+ // reason says nothing about one member's number. 21 writable widget properties in Gtk-4.0
123
+ // and Adw-1 are bitfield-typed -- `GtkEntry:input-hints`, `GtkPopoverMenu:flags`,
124
+ // `AdwTabView:shortcuts`, ... -- and they are typed bare `number`, so a host without GI
125
+ // has nothing to compute one from. Counting is worst exactly here: 95 of 121 Gtk-4.0
126
+ // bitfield members disagree with their position, against 29 of 685 enumeration members.
127
+ //
128
+ // A table of its own rather than more rows in `ENUM_VALUES`, so that "every nick in
129
+ // `ENUM_NICKS` has a number or a declared reason" stays a claim about one set.
130
+ export const FLAG_VALUES = {
131
+ 'GtkSourceCompletionActivation.interactive': 1,
132
+ 'GtkSourceCompletionActivation.none': 0,
133
+ 'GtkSourceCompletionActivation.user-requested': 2,
134
+ 'GtkSourceDrawSpacesFlags.all': 127,
135
+ 'GtkSourceDrawSpacesFlags.leading': 16,
136
+ 'GtkSourceDrawSpacesFlags.nbsp': 8,
137
+ 'GtkSourceDrawSpacesFlags.newline': 4,
138
+ 'GtkSourceDrawSpacesFlags.space': 1,
139
+ 'GtkSourceDrawSpacesFlags.tab': 2,
140
+ 'GtkSourceDrawSpacesFlags.text': 32,
141
+ 'GtkSourceDrawSpacesFlags.trailing': 64,
142
+ 'GtkSourceFileSaverFlags.create-backup': 4,
143
+ 'GtkSourceFileSaverFlags.ignore-invalid-chars': 1,
144
+ 'GtkSourceFileSaverFlags.ignore-modification-time': 2,
145
+ 'GtkSourceFileSaverFlags.none': 0,
146
+ 'GtkSourceGutterRendererState.cursor': 1,
147
+ 'GtkSourceGutterRendererState.normal': 0,
148
+ 'GtkSourceGutterRendererState.prelit': 2,
149
+ 'GtkSourceGutterRendererState.selected': 4,
150
+ 'GtkSourceSortFlags.case-sensitive': 1,
151
+ 'GtkSourceSortFlags.none': 0,
152
+ 'GtkSourceSortFlags.remove-duplicates': 4,
153
+ 'GtkSourceSortFlags.reverse-order': 2,
154
+ 'GtkSourceSpaceLocationFlags.all': 7,
155
+ 'GtkSourceSpaceLocationFlags.inside-text': 2,
156
+ 'GtkSourceSpaceLocationFlags.leading': 1,
157
+ 'GtkSourceSpaceLocationFlags.none': 0,
158
+ 'GtkSourceSpaceLocationFlags.trailing': 4,
159
+ 'GtkSourceSpaceTypeFlags.all': 15,
160
+ 'GtkSourceSpaceTypeFlags.nbsp': 8,
161
+ 'GtkSourceSpaceTypeFlags.newline': 4,
162
+ 'GtkSourceSpaceTypeFlags.none': 0,
163
+ 'GtkSourceSpaceTypeFlags.space': 1,
164
+ 'GtkSourceSpaceTypeFlags.tab': 2,
165
+ };
166
+
167
+ // The same declared remainder for the bitfields. Every one of the 13 members in ts-for-gir's
168
+ // `girs/` whose value is past `Number.MAX_SAFE_INTEGER` is a bitfield member (Fwupd, Qmi),
169
+ // so this is the table that shape actually reaches.
170
+ export const FLAG_VALUES_UNREADABLE = {};
171
+
172
+ // Declaration GType + property name -> the GType of that property's enum or bitfield.
173
+ //
174
+ // Without it the value tables above are half an answer. A host with no GI knows it must set
175
+ // `orientation` to the number behind the nick `vertical`; `ENUM_VALUES` is keyed
176
+ // `GtkOrientation.vertical`, and nothing else says that `orientation` is a
177
+ // `GtkOrientation`. Deriving it is not available: `never` is a member of several Gtk enums,
178
+ // and choosing between them produces a wrong number rather than a missing one.
179
+ //
180
+ // Only where the property's OWN type is the enum. An array of them and a union that mentions
181
+ // one are both entries a consumer would resolve wrongly, so neither is written.
182
+ //
183
+ // A GType named here has numbers in SOME vocabulary, not necessarily this one: the namespace
184
+ // that OWNS an enum publishes it, so 57 of the 438 entries a full run emits want the owner's
185
+ // vocabulary loaded too. Owners that emit none (Gdk, Pango) are inlined into the tables above.
186
+ export const PROP_ENUMS = {
187
+ 'GtkSourceView.background-pattern': 'GtkSourceBackgroundPatternType',
188
+ 'GtkSourceView.draw-spaces': 'GtkSourceDrawSpacesFlags',
189
+ 'GtkSourceView.smart-home-end': 'GtkSourceSmartHomeEndType',
190
+ };
191
+
55
192
  export const SLOT_CANDIDATES = {
56
193
  GtkSourceCompletionInfo: {
57
194
  'widget': 'set_widget',
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@girs/gtksource-3.0",
3
- "version": "4.7.0",
3
+ "version": "4.9.0",
4
4
  "description": "GJS TypeScript type definitions for GtkSource-3.0",
5
5
  "type": "module",
6
6
  "module": "gtksource-3.0.js",
@@ -36,20 +36,20 @@
36
36
  "test": "tsc --project tsconfig.json"
37
37
  },
38
38
  "dependencies": {
39
- "@girs/gjs": "^4.7.0",
40
- "@girs/gtk-3.0": "^4.7.0",
41
- "@girs/xlib-2.0": "^4.7.0",
42
- "@girs/gdk-3.0": "^4.7.0",
43
- "@girs/cairo-1.0": "^4.7.0",
44
- "@girs/gobject-2.0": "^4.7.0",
45
- "@girs/glib-2.0": "^4.7.0",
46
- "@girs/pango-1.0": "^4.7.0",
47
- "@girs/harfbuzz-0.0": "^4.7.0",
48
- "@girs/freetype2-2.0": "^4.7.0",
49
- "@girs/gio-2.0": "^4.7.0",
50
- "@girs/gmodule-2.0": "^4.7.0",
51
- "@girs/gdkpixbuf-2.0": "^4.7.0",
52
- "@girs/atk-1.0": "^4.7.0" },
39
+ "@girs/gjs": "^4.9.0",
40
+ "@girs/gtk-3.0": "^4.9.0",
41
+ "@girs/xlib-2.0": "^4.9.0",
42
+ "@girs/gdk-3.0": "^4.9.0",
43
+ "@girs/cairo-1.0": "^4.9.0",
44
+ "@girs/gobject-2.0": "^4.9.0",
45
+ "@girs/glib-2.0": "^4.9.0",
46
+ "@girs/pango-1.0": "^4.9.0",
47
+ "@girs/harfbuzz-0.0": "^4.9.0",
48
+ "@girs/freetype2-2.0": "^4.9.0",
49
+ "@girs/gio-2.0": "^4.9.0",
50
+ "@girs/gmodule-2.0": "^4.9.0",
51
+ "@girs/gdkpixbuf-2.0": "^4.9.0",
52
+ "@girs/atk-1.0": "^4.9.0" },
53
53
  "devDependencies": {
54
54
  "typescript": "*"
55
55
  },