@girs/gtksource-4 4.7.0 → 4.8.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-4)
5
5
  ![downloads/week](https://img.shields.io/npm/dw/@girs/gtksource-4)
6
6
 
7
- GJS TypeScript type definitions for GtkSource-4 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v4.7.0.
7
+ GJS TypeScript type definitions for GtkSource-4 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v4.8.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.
@@ -280,6 +280,61 @@ export const CHILD_HOLDERS: readonly string[];
280
280
  /** Enum GType -> the nicks this surface offers. */
281
281
  export const ENUM_NICKS: Readonly<Record<string, readonly string[]>>;
282
282
 
283
+ /**
284
+ * `<enum GType>.<nick>` -> the integer GObject registers for it, from GIR's `value`.
285
+ *
286
+ * Position in `ENUM_NICKS` is NOT this number. Counting is wrong on 6 of the 129 enums a
287
+ * GTK 4 vocabulary carries -- 104 in Gtk-4.0 and 25 in Adw-1: `GtkResponseType` runs -1 to -11, `GtkTextWindowType` starts
288
+ * at 1, `GtkOrdering` and `GtkConstraintRelation` are -1/0/1, `GtkAlign` has two names
289
+ * on one value, and `GtkConstraintStrength.required` is 1001001000 where counting says 0.
290
+ *
291
+ * Read from the same GIR as the nicks, deliberately. A consumer reading the numbers off an
292
+ * installed typelib instead has two provenances for one table, and then cannot tell a
293
+ * missing number from a host older than the vocabulary.
294
+ */
295
+ export const ENUM_VALUES: Readonly<Record<string, number>>;
296
+
297
+ /**
298
+ * The `<enum GType>.<nick>` entries GIR marks `deprecated="1"`.
299
+ *
300
+ * Two names on one value is how GObject spells an alias -- `GTK_ALIGN_BASELINE` and
301
+ * `GTK_ALIGN_BASELINE_FILL` are both 4, and both keep a `ENUM_VALUES` entry. The pairing
302
+ * is visible in the numbers; which name is the old one is not, and this is that fact --
303
+ * where GIR states it. It usually does not: 4 registered-enum members across the 718 GIRs
304
+ * carry the attribute, and 179 of the 182 value-sharing pairs carry it on neither half, so
305
+ * absence from this list means GIR is silent, not that the nick is the current one.
306
+ */
307
+ export const ENUM_DEPRECATED: readonly string[];
308
+
309
+ /**
310
+ * `<enum GType>.<nick>` -> the raw GIR `value` no number could be read from.
311
+ *
312
+ * The declared remainder, so that every nick in `ENUM_NICKS` is in `ENUM_VALUES` or in
313
+ * here and a drop cannot be silent. Two shapes reach it: a symbolic or absent value (Vala
314
+ * writes `(null)`, a char enum writes a letter) and an integer past
315
+ * `Number.MAX_SAFE_INTEGER`, where a literal would lose precision and stop being the
316
+ * GIR's number. Empty for Gtk, Adw, GLib and Gio.
317
+ */
318
+ export const ENUM_VALUES_UNREADABLE: Readonly<Record<string, string>>;
319
+
320
+ /**
321
+ * `<bitfield GType>.<nick>` -> the integer GObject registers for that one member.
322
+ *
323
+ * `ENUM_NICKS` carries no bitfield, because GObject cannot resolve a nick SET; that says
324
+ * nothing about a single member's number, and the number is what a host without GI needs.
325
+ * 21 writable widget properties in Gtk-4.0 and Adw-1 are bitfield-typed and are declared
326
+ * bare `number` -- `GtkEntry:input-hints`, `GtkPopoverMenu:flags`, `AdwTabView:shortcuts`
327
+ * among them. Counting is worst here: 95 of 121 Gtk-4.0 bitfield members disagree with their
328
+ * position, against 29 of 685 enumeration members.
329
+ *
330
+ * Combine with `|` as GObject does. There is no nick table to pair this with, so a name
331
+ * here is resolvable and a SET still is not.
332
+ */
333
+ export const FLAG_VALUES: Readonly<Record<string, number>>;
334
+
335
+ /** `<bitfield GType>.<nick>` -> the raw GIR `value` no number could be read from. */
336
+ export const FLAG_VALUES_UNREADABLE: Readonly<Record<string, string>>;
337
+
283
338
  /** Widget GType -> slot name -> the method that may adopt a child there. */
284
339
  export const SLOT_CANDIDATES: Readonly<Record<string, Readonly<Record<string, string>>>>;
285
340
 
@@ -51,6 +51,115 @@ export const ENUM_NICKS = {
51
51
  GtkSourceViewGutterPosition: ['lines', 'marks'],
52
52
  };
53
53
 
54
+ // The number behind each of those nicks, read from GIR's own `value` attribute.
55
+ //
56
+ // It ships because position in `ENUM_NICKS` is not the value and a consumer with no
57
+ // typelib has no other way to learn it: a surface without GI still has to hand GObject an
58
+ // integer. The alternative a consumer reaches for first is counting, and counting is wrong
59
+ // on 6 of the 129 enums a GTK 4 vocabulary carries (104 in Gtk-4.0, 25 in Adw-1) --
60
+ // `GtkResponseType` runs -1 down to
61
+ // -11, `GtkTextWindowType` starts at 1, and `GtkConstraintStrength.required` is
62
+ // 1001001000 where counting answers 0.
63
+ //
64
+ // Same provenance as the nicks above, which is the point: a consumer that reads the numbers
65
+ // from an INSTALLED library instead gets two provenances for one table, and a member the
66
+ // vocabulary describes but the host predates then looks like a missing number rather than a
67
+ // version gap.
68
+ export const ENUM_VALUES = {
69
+ 'GtkSourceBackgroundPatternType.grid': 1,
70
+ 'GtkSourceBackgroundPatternType.none': 0,
71
+ 'GtkSourceBracketMatchType.found': 3,
72
+ 'GtkSourceBracketMatchType.none': 0,
73
+ 'GtkSourceBracketMatchType.not-found': 2,
74
+ 'GtkSourceBracketMatchType.out-of-range': 1,
75
+ 'GtkSourceChangeCaseType.lower': 0,
76
+ 'GtkSourceChangeCaseType.title': 3,
77
+ 'GtkSourceChangeCaseType.toggle': 2,
78
+ 'GtkSourceChangeCaseType.upper': 1,
79
+ 'GtkSourceCompressionType.gzip': 1,
80
+ 'GtkSourceCompressionType.none': 0,
81
+ 'GtkSourceGutterRendererAlignmentMode.cell': 0,
82
+ 'GtkSourceGutterRendererAlignmentMode.first': 1,
83
+ 'GtkSourceGutterRendererAlignmentMode.last': 2,
84
+ 'GtkSourceNewlineType.cr': 1,
85
+ 'GtkSourceNewlineType.cr-lf': 2,
86
+ 'GtkSourceNewlineType.lf': 0,
87
+ 'GtkSourceSmartHomeEndType.after': 2,
88
+ 'GtkSourceSmartHomeEndType.always': 3,
89
+ 'GtkSourceSmartHomeEndType.before': 1,
90
+ 'GtkSourceSmartHomeEndType.disabled': 0,
91
+ 'GtkSourceViewGutterPosition.lines': -30,
92
+ 'GtkSourceViewGutterPosition.marks': -20,
93
+ };
94
+
95
+ // The nicks GIR marks `deprecated="1"`.
96
+ //
97
+ // Two members of one enum may share a value -- that is how GObject spells an alias, and
98
+ // `GTK_ALIGN_BASELINE` and `GTK_ALIGN_BASELINE_FILL` are both 4. `ENUM_VALUES` keeps
99
+ // both names, so nothing is lost, and this is what says which of the two a number should be
100
+ // spelled back as. Stated rather than derived: the pairing is visible in the values, the
101
+ // DIRECTION is not.
102
+ //
103
+ // Read it as evidence, not as a negative: 4 registered-enum members in the 718 GIRs carry
104
+ // the attribute at all, and 179 of the 182 value-sharing pairs carry it on neither half.
105
+ // A nick missing from here is a nick GIR says nothing about, not a nick GIR calls current.
106
+ export const ENUM_DEPRECATED = [];
107
+
108
+ // The declared remainder: nicks whose GIR `value` is not a number this can carry.
109
+ //
110
+ // Every nick in `ENUM_NICKS` is in `ENUM_VALUES` or here -- a nick in neither would be a
111
+ // silent drop. GIR carries two shapes no integer holds: a symbolic or absent value (Vala
112
+ // writes `(null)`, a char enum writes a letter) and an integer past
113
+ // `Number.MAX_SAFE_INTEGER`. The value kept here is the raw attribute, so the entry says
114
+ // WHAT was unreadable rather than only that something was. Measured over the 718 GIRs in
115
+ // ts-for-gir's `girs/`: 32 of 34096 registered-enum members, none in Gtk, Adw, GLib or Gio.
116
+ export const ENUM_VALUES_UNREADABLE = {};
117
+
118
+ // The number behind each member of a registered BITFIELD, keyed the same way.
119
+ //
120
+ // `ENUM_NICKS` refuses a bitfield because GObject cannot resolve a nick SET, and that
121
+ // reason says nothing about one member's number. 21 writable widget properties in Gtk-4.0
122
+ // and Adw-1 are bitfield-typed -- `GtkEntry:input-hints`, `GtkPopoverMenu:flags`,
123
+ // `AdwTabView:shortcuts`, ... -- and they are typed bare `number`, so a host without GI
124
+ // has nothing to compute one from. Counting is worst exactly here: 95 of 121 Gtk-4.0
125
+ // bitfield members disagree with their position, against 29 of 685 enumeration members.
126
+ //
127
+ // A table of its own rather than more rows in `ENUM_VALUES`, so that "every nick in
128
+ // `ENUM_NICKS` has a number or a declared reason" stays a claim about one set.
129
+ export const FLAG_VALUES = {
130
+ 'GtkSourceCompletionActivation.interactive': 1,
131
+ 'GtkSourceCompletionActivation.none': 0,
132
+ 'GtkSourceCompletionActivation.user-requested': 2,
133
+ 'GtkSourceFileSaverFlags.create-backup': 4,
134
+ 'GtkSourceFileSaverFlags.ignore-invalid-chars': 1,
135
+ 'GtkSourceFileSaverFlags.ignore-modification-time': 2,
136
+ 'GtkSourceFileSaverFlags.none': 0,
137
+ 'GtkSourceGutterRendererState.cursor': 1,
138
+ 'GtkSourceGutterRendererState.normal': 0,
139
+ 'GtkSourceGutterRendererState.prelit': 2,
140
+ 'GtkSourceGutterRendererState.selected': 4,
141
+ 'GtkSourceSortFlags.case-sensitive': 1,
142
+ 'GtkSourceSortFlags.none': 0,
143
+ 'GtkSourceSortFlags.remove-duplicates': 4,
144
+ 'GtkSourceSortFlags.reverse-order': 2,
145
+ 'GtkSourceSpaceLocationFlags.all': 7,
146
+ 'GtkSourceSpaceLocationFlags.inside-text': 2,
147
+ 'GtkSourceSpaceLocationFlags.leading': 1,
148
+ 'GtkSourceSpaceLocationFlags.none': 0,
149
+ 'GtkSourceSpaceLocationFlags.trailing': 4,
150
+ 'GtkSourceSpaceTypeFlags.all': 15,
151
+ 'GtkSourceSpaceTypeFlags.nbsp': 8,
152
+ 'GtkSourceSpaceTypeFlags.newline': 4,
153
+ 'GtkSourceSpaceTypeFlags.none': 0,
154
+ 'GtkSourceSpaceTypeFlags.space': 1,
155
+ 'GtkSourceSpaceTypeFlags.tab': 2,
156
+ };
157
+
158
+ // The same declared remainder for the bitfields. Every one of the 13 members in ts-for-gir's
159
+ // `girs/` whose value is past `Number.MAX_SAFE_INTEGER` is a bitfield member (Fwupd, Qmi),
160
+ // so this is the table that shape actually reaches.
161
+ export const FLAG_VALUES_UNREADABLE = {};
162
+
54
163
  export const SLOT_CANDIDATES = {
55
164
  GtkSourceMap: {
56
165
  'view': 'set_view',
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@girs/gtksource-4",
3
- "version": "4.7.0",
3
+ "version": "4.8.0",
4
4
  "description": "GJS TypeScript type definitions for GtkSource-4",
5
5
  "type": "module",
6
6
  "module": "gtksource-4.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.8.0",
40
+ "@girs/gtk-3.0": "^4.8.0",
41
+ "@girs/xlib-2.0": "^4.8.0",
42
+ "@girs/gdk-3.0": "^4.8.0",
43
+ "@girs/cairo-1.0": "^4.8.0",
44
+ "@girs/gobject-2.0": "^4.8.0",
45
+ "@girs/glib-2.0": "^4.8.0",
46
+ "@girs/pango-1.0": "^4.8.0",
47
+ "@girs/harfbuzz-0.0": "^4.8.0",
48
+ "@girs/freetype2-2.0": "^4.8.0",
49
+ "@girs/gio-2.0": "^4.8.0",
50
+ "@girs/gmodule-2.0": "^4.8.0",
51
+ "@girs/gdkpixbuf-2.0": "^4.8.0",
52
+ "@girs/atk-1.0": "^4.8.0" },
53
53
  "devDependencies": {
54
54
  "typescript": "*"
55
55
  },