@gtkx/ffi 0.11.0 → 0.12.0

package/dist/generated/pango/log-attr.d.ts

@@ -1,5 +1,5 @@
 import { NativeObject } from "../../native/base.js";
-export interface LogAttrInit {
+export type LogAttrInit = {
     isLineBreak?: number;
     isMandatoryBreak?: number;
     isCharBreak?: number;
@@ -16,7 +16,7 @@ export interface LogAttrInit {
     breakInsertsHyphen?: number;
     breakRemovesPreceding?: number;
     reserved?: number;
-}
+};
 /**
  * The `PangoLogAttr` structure stores information about the attributes of a
  * single character.
@@ -26,15 +26,19 @@ export declare class LogAttr extends NativeObject {
     constructor(init?: LogAttrInit);
     /** if set, can break line in front of character */
     get isLineBreak(): number;
+    /** if set, can break line in front of character */
     set isLineBreak(value: number);
     /** if set, must break line in front of character */
     get isMandatoryBreak(): number;
+    /** if set, must break line in front of character */
     set isMandatoryBreak(value: number);
     /** if set, can break here when doing character wrapping */
     get isCharBreak(): number;
+    /** if set, can break here when doing character wrapping */
     set isCharBreak(value: number);
     /** is whitespace character */
     get isWhite(): number;
+    /** is whitespace character */
     set isWhite(value: number);
     /**
      * if set, cursor can appear in front of character.
@@ -44,9 +48,17 @@ export declare class LogAttr extends NativeObject {
      *   semantics.
      */
     get isCursorPosition(): number;
+    /**
+     * if set, cursor can appear in front of character.
+     *   i.e. this is a grapheme boundary, or the first character in the text.
+     *   This flag implements Unicode's
+     *   [Grapheme Cluster Boundaries](http://www.unicode.org/reports/tr29/)
+     *   semantics.
+     */
     set isCursorPosition(value: number);
     /** is first character in a word */
     get isWordStart(): number;
+    /** is first character in a word */
     set isWordStart(value: number);
     /**
      * is first non-word char after a word
@@ -54,6 +66,11 @@ export declare class LogAttr extends NativeObject {
      *   and `is_word_end` set for some character.
      */
     get isWordEnd(): number;
+    /**
+     * is first non-word char after a word
+     *   Note that in degenerate cases, you could have both `is_word_start`
+     *   and `is_word_end` set for some character.
+     */
     set isWordEnd(value: number);
     /**
      * is a sentence boundary.
@@ -65,9 +82,19 @@ export declare class LogAttr extends NativeObject {
      *   `is_sentence_start`/`is_sentence_end` mark the boundaries of those sentences.
      */
     get isSentenceBoundary(): number;
+    /**
+     * is a sentence boundary.
+     *   There are two ways to divide sentences. The first assigns all
+     *   inter-sentence whitespace/control/format chars to some sentence,
+     *   so all chars are in some sentence; `is_sentence_boundary` denotes
+     *   the boundaries there. The second way doesn't assign
+     *   between-sentence spaces, etc. to any sentence, so
+     *   `is_sentence_start`/`is_sentence_end` mark the boundaries of those sentences.
+     */
     set isSentenceBoundary(value: number);
     /** is first character in a sentence */
     get isSentenceStart(): number;
+    /** is first character in a sentence */
     set isSentenceStart(value: number);
     /**
      * is first char after a sentence.
@@ -76,6 +103,12 @@ export declare class LogAttr extends NativeObject {
      *   period, so the next sentence starts right away)
      */
     get isSentenceEnd(): number;
+    /**
+     * is first char after a sentence.
+     *   Note that in degenerate cases, you could have both `is_sentence_start`
+     *   and `is_sentence_end` set for some character. (e.g. no space after a
+     *   period, so the next sentence starts right away)
+     */
     set isSentenceEnd(value: number);
     /**
      * if set, backspace deletes one character
@@ -87,12 +120,25 @@ export declare class LogAttr extends NativeObject {
      *   except those following Latin, Cyrillic or Greek base characters.
      */
     get backspaceDeletesCharacter(): number;
+    /**
+     * if set, backspace deletes one character
+     *   rather than the entire grapheme cluster. This field is only meaningful
+     *   on grapheme boundaries (where `is_cursor_position` is set). In some languages,
+     *   the full grapheme (e.g. letter + diacritics) is considered a unit, while in
+     *   others, each decomposed character in the grapheme is a unit. In the default
+     *   implementation of {@link break}, this bit is set on all grapheme boundaries
+     *   except those following Latin, Cyrillic or Greek base characters.
+     */
     set backspaceDeletesCharacter(value: number);
     /**
      * is a whitespace character that can possibly be
      *   expanded for justification purposes. (Since: 1.18)
      */
     get isExpandableSpace(): number;
+    /**
+     * is a whitespace character that can possibly be
+     *   expanded for justification purposes. (Since: 1.18)
+     */
     set isExpandableSpace(value: number);
     /**
      * is a word boundary, as defined by UAX#29.
@@ -103,18 +149,34 @@ export declare class LogAttr extends NativeObject {
      *   semantics. (Since: 1.22)
      */
     get isWordBoundary(): number;
+    /**
+     * is a word boundary, as defined by UAX#29.
+     *   More specifically, means that this is not a position in the middle of a word.
+     *   For example, both sides of a punctuation mark are considered word boundaries.
+     *   This flag is particularly useful when selecting text word-by-word. This flag
+     *   implements Unicode's [Word Boundaries](http://www.unicode.org/reports/tr29/)
+     *   semantics. (Since: 1.22)
+     */
     set isWordBoundary(value: number);
     /**
      * when breaking lines before this char, insert a hyphen.
      *   Since: 1.50
      */
     get breakInsertsHyphen(): number;
+    /**
+     * when breaking lines before this char, insert a hyphen.
+     *   Since: 1.50
+     */
     set breakInsertsHyphen(value: number);
     /**
      * when breaking lines before this char, remove the
      *   preceding char. Since 1.50
      */
     get breakRemovesPreceding(): number;
+    /**
+     * when breaking lines before this char, remove the
+     *   preceding char. Since 1.50
+     */
     set breakRemovesPreceding(value: number);
     get reserved(): number;
     set reserved(value: number);

package/dist/generated/pango/log-attr.js

@@ -8,99 +8,99 @@ export class LogAttr extends NativeObject {
     static objectType = "struct";
     constructor(init = {}) {
         super();
-        this.id = alloc(64);
+        this.handle = alloc(64);
         if (init.isLineBreak !== undefined)
-            write(this.id, {
+            write(this.handle, {
                 type: "int",
                 size: 32,
                 unsigned: true,
             }, 0, init.isLineBreak);
         if (init.isMandatoryBreak !== undefined)
-            write(this.id, {
+            write(this.handle, {
                 type: "int",
                 size: 32,
                 unsigned: true,
             }, 4, init.isMandatoryBreak);
         if (init.isCharBreak !== undefined)
-            write(this.id, {
+            write(this.handle, {
                 type: "int",
                 size: 32,
                 unsigned: true,
             }, 8, init.isCharBreak);
         if (init.isWhite !== undefined)
-            write(this.id, {
+            write(this.handle, {
                 type: "int",
                 size: 32,
                 unsigned: true,
             }, 12, init.isWhite);
         if (init.isCursorPosition !== undefined)
-            write(this.id, {
+            write(this.handle, {
                 type: "int",
                 size: 32,
                 unsigned: true,
             }, 16, init.isCursorPosition);
         if (init.isWordStart !== undefined)
-            write(this.id, {
+            write(this.handle, {
                 type: "int",
                 size: 32,
                 unsigned: true,
             }, 20, init.isWordStart);
         if (init.isWordEnd !== undefined)
-            write(this.id, {
+            write(this.handle, {
                 type: "int",
                 size: 32,
                 unsigned: true,
             }, 24, init.isWordEnd);
         if (init.isSentenceBoundary !== undefined)
-            write(this.id, {
+            write(this.handle, {
                 type: "int",
                 size: 32,
                 unsigned: true,
             }, 28, init.isSentenceBoundary);
         if (init.isSentenceStart !== undefined)
-            write(this.id, {
+            write(this.handle, {
                 type: "int",
                 size: 32,
                 unsigned: true,
             }, 32, init.isSentenceStart);
         if (init.isSentenceEnd !== undefined)
-            write(this.id, {
+            write(this.handle, {
                 type: "int",
                 size: 32,
                 unsigned: true,
             }, 36, init.isSentenceEnd);
         if (init.backspaceDeletesCharacter !== undefined)
-            write(this.id, {
+            write(this.handle, {
                 type: "int",
                 size: 32,
                 unsigned: true,
             }, 40, init.backspaceDeletesCharacter);
         if (init.isExpandableSpace !== undefined)
-            write(this.id, {
+            write(this.handle, {
                 type: "int",
                 size: 32,
                 unsigned: true,
             }, 44, init.isExpandableSpace);
         if (init.isWordBoundary !== undefined)
-            write(this.id, {
+            write(this.handle, {
                 type: "int",
                 size: 32,
                 unsigned: true,
             }, 48, init.isWordBoundary);
         if (init.breakInsertsHyphen !== undefined)
-            write(this.id, {
+            write(this.handle, {
                 type: "int",
                 size: 32,
                 unsigned: true,
             }, 52, init.breakInsertsHyphen);
         if (init.breakRemovesPreceding !== undefined)
-            write(this.id, {
+            write(this.handle, {
                 type: "int",
                 size: 32,
                 unsigned: true,
             }, 56, init.breakRemovesPreceding);
         if (init.reserved !== undefined)
-            write(this.id, {
+            write(this.handle, {
                 type: "int",
                 size: 32,
                 unsigned: true,
@@ -108,14 +108,15 @@ export class LogAttr extends NativeObject {
     }
     /** if set, can break line in front of character */
     get isLineBreak() {
-        return read(this.id, {
+        return read(this.handle, {
             type: "int",
             size: 32,
             unsigned: true,
         }, 0);
     }
+    /** if set, can break line in front of character */
     set isLineBreak(value) {
-        write(this.id, {
+        write(this.handle, {
             type: "int",
             size: 32,
             unsigned: true,
@@ -123,14 +124,15 @@ export class LogAttr extends NativeObject {
     }
     /** if set, must break line in front of character */
     get isMandatoryBreak() {
-        return read(this.id, {
+        return read(this.handle, {
             type: "int",
             size: 32,
             unsigned: true,
         }, 4);
     }
+    /** if set, must break line in front of character */
     set isMandatoryBreak(value) {
-        write(this.id, {
+        write(this.handle, {
             type: "int",
             size: 32,
             unsigned: true,
@@ -138,14 +140,15 @@ export class LogAttr extends NativeObject {
     }
     /** if set, can break here when doing character wrapping */
     get isCharBreak() {
-        return read(this.id, {
+        return read(this.handle, {
             type: "int",
             size: 32,
             unsigned: true,
         }, 8);
     }
+    /** if set, can break here when doing character wrapping */
     set isCharBreak(value) {
-        write(this.id, {
+        write(this.handle, {
             type: "int",
             size: 32,
             unsigned: true,
@@ -153,14 +156,15 @@ export class LogAttr extends NativeObject {
     }
     /** is whitespace character */
     get isWhite() {
-        return read(this.id, {
+        return read(this.handle, {
             type: "int",
             size: 32,
             unsigned: true,
         }, 12);
     }
+    /** is whitespace character */
     set isWhite(value) {
-        write(this.id, {
+        write(this.handle, {
             type: "int",
             size: 32,
             unsigned: true,
@@ -174,14 +178,21 @@ export class LogAttr extends NativeObject {
      *   semantics.
      */
     get isCursorPosition() {
-        return read(this.id, {
+        return read(this.handle, {
             type: "int",
             size: 32,
             unsigned: true,
         }, 16);
     }
+    /**
+     * if set, cursor can appear in front of character.
+     *   i.e. this is a grapheme boundary, or the first character in the text.
+     *   This flag implements Unicode's
+     *   [Grapheme Cluster Boundaries](http://www.unicode.org/reports/tr29/)
+     *   semantics.
+     */
     set isCursorPosition(value) {
-        write(this.id, {
+        write(this.handle, {
             type: "int",
             size: 32,
             unsigned: true,
@@ -189,14 +200,15 @@ export class LogAttr extends NativeObject {
     }
     /** is first character in a word */
     get isWordStart() {
-        return read(this.id, {
+        return read(this.handle, {
             type: "int",
             size: 32,
             unsigned: true,
         }, 20);
     }
+    /** is first character in a word */
     set isWordStart(value) {
-        write(this.id, {
+        write(this.handle, {
             type: "int",
             size: 32,
             unsigned: true,
@@ -208,14 +220,19 @@ export class LogAttr extends NativeObject {
      *   and `is_word_end` set for some character.
      */
     get isWordEnd() {
-        return read(this.id, {
+        return read(this.handle, {
             type: "int",
             size: 32,
             unsigned: true,
         }, 24);
     }
+    /**
+     * is first non-word char after a word
+     *   Note that in degenerate cases, you could have both `is_word_start`
+     *   and `is_word_end` set for some character.
+     */
     set isWordEnd(value) {
-        write(this.id, {
+        write(this.handle, {
             type: "int",
             size: 32,
             unsigned: true,
@@ -231,14 +248,23 @@ export class LogAttr extends NativeObject {
      *   `is_sentence_start`/`is_sentence_end` mark the boundaries of those sentences.
      */
     get isSentenceBoundary() {
-        return read(this.id, {
+        return read(this.handle, {
             type: "int",
             size: 32,
             unsigned: true,
         }, 28);
     }
+    /**
+     * is a sentence boundary.
+     *   There are two ways to divide sentences. The first assigns all
+     *   inter-sentence whitespace/control/format chars to some sentence,
+     *   so all chars are in some sentence; `is_sentence_boundary` denotes
+     *   the boundaries there. The second way doesn't assign
+     *   between-sentence spaces, etc. to any sentence, so
+     *   `is_sentence_start`/`is_sentence_end` mark the boundaries of those sentences.
+     */
     set isSentenceBoundary(value) {
-        write(this.id, {
+        write(this.handle, {
             type: "int",
             size: 32,
             unsigned: true,
@@ -246,14 +272,15 @@ export class LogAttr extends NativeObject {
     }
     /** is first character in a sentence */
     get isSentenceStart() {
-        return read(this.id, {
+        return read(this.handle, {
             type: "int",
             size: 32,
             unsigned: true,
         }, 32);
     }
+    /** is first character in a sentence */
     set isSentenceStart(value) {
-        write(this.id, {
+        write(this.handle, {
             type: "int",
             size: 32,
             unsigned: true,
@@ -266,14 +293,20 @@ export class LogAttr extends NativeObject {
      *   period, so the next sentence starts right away)
      */
     get isSentenceEnd() {
-        return read(this.id, {
+        return read(this.handle, {
             type: "int",
             size: 32,
             unsigned: true,
         }, 36);
     }
+    /**
+     * is first char after a sentence.
+     *   Note that in degenerate cases, you could have both `is_sentence_start`
+     *   and `is_sentence_end` set for some character. (e.g. no space after a
+     *   period, so the next sentence starts right away)
+     */
     set isSentenceEnd(value) {
-        write(this.id, {
+        write(this.handle, {
             type: "int",
             size: 32,
             unsigned: true,
@@ -289,14 +322,23 @@ export class LogAttr extends NativeObject {
      *   except those following Latin, Cyrillic or Greek base characters.
      */
     get backspaceDeletesCharacter() {
-        return read(this.id, {
+        return read(this.handle, {
             type: "int",
             size: 32,
             unsigned: true,
         }, 40);
     }
+    /**
+     * if set, backspace deletes one character
+     *   rather than the entire grapheme cluster. This field is only meaningful
+     *   on grapheme boundaries (where `is_cursor_position` is set). In some languages,
+     *   the full grapheme (e.g. letter + diacritics) is considered a unit, while in
+     *   others, each decomposed character in the grapheme is a unit. In the default
+     *   implementation of {@link break}, this bit is set on all grapheme boundaries
+     *   except those following Latin, Cyrillic or Greek base characters.
+     */
     set backspaceDeletesCharacter(value) {
-        write(this.id, {
+        write(this.handle, {
             type: "int",
             size: 32,
             unsigned: true,
@@ -307,14 +349,18 @@ export class LogAttr extends NativeObject {
      *   expanded for justification purposes. (Since: 1.18)
      */
     get isExpandableSpace() {
-        return read(this.id, {
+        return read(this.handle, {
             type: "int",
             size: 32,
             unsigned: true,
         }, 44);
     }
+    /**
+     * is a whitespace character that can possibly be
+     *   expanded for justification purposes. (Since: 1.18)
+     */
     set isExpandableSpace(value) {
-        write(this.id, {
+        write(this.handle, {
             type: "int",
             size: 32,
             unsigned: true,
@@ -329,14 +375,22 @@ export class LogAttr extends NativeObject {
      *   semantics. (Since: 1.22)
      */
     get isWordBoundary() {
-        return read(this.id, {
+        return read(this.handle, {
             type: "int",
             size: 32,
             unsigned: true,
         }, 48);
     }
+    /**
+     * is a word boundary, as defined by UAX#29.
+     *   More specifically, means that this is not a position in the middle of a word.
+     *   For example, both sides of a punctuation mark are considered word boundaries.
+     *   This flag is particularly useful when selecting text word-by-word. This flag
+     *   implements Unicode's [Word Boundaries](http://www.unicode.org/reports/tr29/)
+     *   semantics. (Since: 1.22)
+     */
     set isWordBoundary(value) {
-        write(this.id, {
+        write(this.handle, {
             type: "int",
             size: 32,
             unsigned: true,
@@ -347,14 +401,18 @@ export class LogAttr extends NativeObject {
      *   Since: 1.50
      */
     get breakInsertsHyphen() {
-        return read(this.id, {
+        return read(this.handle, {
             type: "int",
             size: 32,
             unsigned: true,
         }, 52);
     }
+    /**
+     * when breaking lines before this char, insert a hyphen.
+     *   Since: 1.50
+     */
     set breakInsertsHyphen(value) {
-        write(this.id, {
+        write(this.handle, {
             type: "int",
             size: 32,
             unsigned: true,
@@ -365,28 +423,32 @@ export class LogAttr extends NativeObject {
      *   preceding char. Since 1.50
      */
     get breakRemovesPreceding() {
-        return read(this.id, {
+        return read(this.handle, {
             type: "int",
             size: 32,
             unsigned: true,
         }, 56);
     }
+    /**
+     * when breaking lines before this char, remove the
+     *   preceding char. Since 1.50
+     */
     set breakRemovesPreceding(value) {
-        write(this.id, {
+        write(this.handle, {
             type: "int",
             size: 32,
             unsigned: true,
         }, 56, value);
     }
     get reserved() {
-        return read(this.id, {
+        return read(this.handle, {
             type: "int",
             size: 32,
             unsigned: true,
         }, 60);
     }
     set reserved(value) {
-        write(this.id, {
+        write(this.handle, {
             type: "int",
             size: 32,
             unsigned: true,

package/dist/generated/pango/matrix.d.ts

@@ -1,14 +1,14 @@
 import { Ref } from "@gtkx/native";
 import { NativeObject } from "../../native/base.js";
 import { Rectangle } from "./rectangle.js";
-export interface MatrixInit {
+export type MatrixInit = {
     xx?: number;
     xy?: number;
     yx?: number;
     yy?: number;
     x0?: number;
     y0?: number;
-}
+};
 /**
  * A `PangoMatrix` specifies a transformation between user-space
  * and device coordinates.
@@ -138,20 +138,26 @@ export declare class Matrix extends NativeObject {
     translate(tx: number, ty: number): void;
     /** 1st component of the transformation matrix */
     get xx(): number;
+    /** 1st component of the transformation matrix */
     set xx(value: number);
     /** 2nd component of the transformation matrix */
     get xy(): number;
+    /** 2nd component of the transformation matrix */
     set xy(value: number);
     /** 3rd component of the transformation matrix */
     get yx(): number;
+    /** 3rd component of the transformation matrix */
     set yx(value: number);
     /** 4th component of the transformation matrix */
     get yy(): number;
+    /** 4th component of the transformation matrix */
     set yy(value: number);
     /** x translation */
     get x0(): number;
+    /** x translation */
     set x0(value: number);
     /** y translation */
     get y0(): number;
+    /** y translation */
     set y0(value: number);
 }