@gtkx/ffi 0.1.45 → 0.1.46

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

@@ -1,6 +1,15 @@
 import { call } from "@gtkx/native";
 import { getObject } from "@gtkx/ffi";
 import { Attribute } from "./attribute.js";
+/**
+ * A `PangoAttrIterator` is used to iterate through a `PangoAttrList`.
+ *
+ * A new iterator is created with [method@Pango.AttrList.get_iterator].
+ * Once the iterator is created, it can be advanced through the style
+ * changes in the text using [method@Pango.AttrIterator.next]. At each
+ * style change, the range of the current style segment and the attributes
+ * currently in effect can be queried.
+ */
 export class AttrIterator {
     ptr;
     constructor() {
@@ -9,6 +18,9 @@ export class AttrIterator {
     createPtr(_init) {
         return null;
     }
+    /**
+     * Copy a `PangoAttrIterator`.
+     */
     copy() {
         const ptr = call("libpango-1.0.so.0", "pango_attr_iterator_copy", [
             {
@@ -23,6 +35,9 @@ export class AttrIterator {
         });
         return getObject(ptr, AttrIterator);
     }
+    /**
+     * Destroy a `PangoAttrIterator` and free all associated memory.
+     */
     destroy() {
         call("libpango-1.0.so.0", "pango_attr_iterator_destroy", [
             {
@@ -31,6 +46,15 @@ export class AttrIterator {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Find the current attribute of a particular type
+     * at the iterator location.
+     *
+     * When multiple attributes of the same type overlap,
+     * the attribute whose range starts closest to the
+     * current location is used.
+     * @param type - the type of attribute to find
+     */
     get(type) {
         const ptr = call("libpango-1.0.so.0", "pango_attr_iterator_get", [
             {
@@ -51,6 +75,10 @@ export class AttrIterator {
             return null;
         return getObject(ptr, Attribute);
     }
+    /**
+     * Gets a list of all attributes at the current position of the
+     * iterator.
+     */
     getAttrs() {
         return call("libpango-1.0.so.0", "pango_attr_iterator_get_attrs", [
             {
@@ -68,6 +96,13 @@ export class AttrIterator {
             borrowed: true,
         });
     }
+    /**
+     * Get the font and other attributes at the current
+     * iterator position.
+     * @param desc - a `PangoFontDescription` to fill in with the current
+     * @param language - location to store language tag
+     * @param extraAttrs - location in which to store a list of non-font attributes
+     */
     getFont(desc, language, extraAttrs) {
         call("libpango-1.0.so.0", "pango_attr_iterator_get_font", [
             {
@@ -113,6 +148,9 @@ export class AttrIterator {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Advance the iterator until the next change of style.
+     */
     next() {
         return call("libpango-1.0.so.0", "pango_attr_iterator_next", [
             {
@@ -121,6 +159,16 @@ export class AttrIterator {
             },
         ], { type: "boolean" });
     }
+    /**
+     * Get the range of the current segment.
+     *
+     * Note that the stored return values are signed, not unsigned
+     * like the values in `PangoAttribute`. To deal with this API
+     * oversight, stored return values that wouldn't fit into
+     * a signed integer are clamped to %G_MAXINT.
+     * @param start - location to store the start of the range
+     * @param end - location to store the end of the range
+     */
     range(start, end) {
         call("libpango-1.0.so.0", "pango_attr_iterator_range", [
             {

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

@@ -1,21 +1,189 @@
 import { AttrIterator } from "./attr-iterator.js";
 import { Attribute } from "./attribute.js";
+/**
+ * A `PangoAttrList` represents a list of attributes that apply to a section
+ * of text.
+ *
+ * The attributes in a `PangoAttrList` are, in general, allowed to overlap in
+ * an arbitrary fashion. However, if the attributes are manipulated only through
+ * [method@Pango.AttrList.change], the overlap between properties will meet
+ * stricter criteria.
+ *
+ * Since the `PangoAttrList` structure is stored as a linear list, it is not
+ * suitable for storing attributes for large amounts of text. In general, you
+ * should not use a single `PangoAttrList` for more than one paragraph of text.
+ */
 export declare class AttrList {
     ptr: unknown;
+    /**
+     * Create a new empty attribute list with a reference
+     * count of one.
+     */
     constructor();
     protected createPtr(_args: unknown[]): unknown;
+    /**
+     * Deserializes a `PangoAttrList` from a string.
+     *
+     * This is the counterpart to [method@Pango.AttrList.to_string].
+     * See that functions for details about the format.
+     * @param text - a string
+     */
     static fromString(text: string): AttrList;
+    /**
+     * Insert the given attribute into the `PangoAttrList`.
+     *
+     * It will replace any attributes of the same type
+     * on that segment and be merged with any adjoining
+     * attributes that are identical.
+     *
+     * This function is slower than [method@Pango.AttrList.insert]
+     * for creating an attribute list in order (potentially
+     * much slower for large lists). However,
+     * [method@Pango.AttrList.insert] is not suitable for
+     * continually changing a set of attributes since it
+     * never removes or combines existing attributes.
+     * @param attr - the attribute to insert
+     */
     change(attr: Attribute): void;
+    /**
+     * Copy `list` and return an identical new list.
+     */
     copy(): AttrList | null;
+    /**
+     * Checks whether `list` and `other_list` contain the same
+     * attributes and whether those attributes apply to the
+     * same ranges.
+     *
+     * Beware that this will return wrong values if any list
+     * contains duplicates.
+     * @param otherList - the other `PangoAttrList`
+     */
     equal(otherList: AttrList): boolean;
+    /**
+     * Given a `PangoAttrList` and callback function, removes
+     * any elements of `list` for which `func` returns %TRUE and
+     * inserts them into a new list.
+     * @param func - callback function;
+     * @param data - Data to be passed to @func
+     */
     filter(func: (...args: unknown[]) => unknown, data?: number | null): AttrList | null;
+    /**
+     * Gets a list of all attributes in @list.
+     */
     getAttributes(): Attribute[];
+    /**
+     * Create a iterator initialized to the beginning of the list.
+     *
+     * `list` must not be modified until this iterator is freed.
+     */
     getIterator(): AttrIterator;
+    /**
+     * Insert the given attribute into the `PangoAttrList`.
+     *
+     * It will be inserted after all other attributes with a
+     * matching @start_index.
+     * @param attr - the attribute to insert
+     */
     insert(attr: Attribute): void;
+    /**
+     * Insert the given attribute into the `PangoAttrList`.
+     *
+     * It will be inserted before all other attributes with a
+     * matching @start_index.
+     * @param attr - the attribute to insert
+     */
     insertBefore(attr: Attribute): void;
+    /**
+     * Increase the reference count of the given attribute
+     * list by one.
+     */
     ref(): AttrList;
+    /**
+     * This function opens up a hole in @list, fills it
+     * in with attributes from the left, and then merges
+     * `other` on top of the hole.
+     *
+     * This operation is equivalent to stretching every attribute
+     * that applies at position `pos` in `list` by an amount @len,
+     * and then calling [method@Pango.AttrList.change] with a copy
+     * of each attribute in `other` in sequence (offset in position
+     * by @pos, and limited in length to @len).
+     *
+     * This operation proves useful for, for instance, inserting
+     * a pre-edit string in the middle of an edit buffer.
+     *
+     * For backwards compatibility, the function behaves differently
+     * when `len` is 0. In this case, the attributes from `other` are
+     * not imited to @len, and are just overlayed on top of @list.
+     *
+     * This mode is useful for merging two lists of attributes together.
+     * @param other - another `PangoAttrList`
+     * @param pos - the position in `list` at which to insert @other
+     * @param len - the length of the spliced segment. (Note that this
+     */
     splice(other: AttrList, pos: number, len: number): void;
+    /**
+     * Serializes a `PangoAttrList` to a string.
+     *
+     * In the resulting string, serialized attributes are separated by newlines or commas.
+     * Individual attributes are serialized to a string of the form
+     *
+     * [START END] TYPE VALUE
+     *
+     * Where START and END are the indices (with -1 being accepted in place
+     * of MAXUINT), TYPE is the nickname of the attribute value type, e.g.
+     * _weight_ or _stretch_, and the value is serialized according to its type:
+     *
+     * Optionally, START and END can be omitted to indicate unlimited extent.
+     *
+     * - enum values as nick or numeric value
+     * - boolean values as _true_ or _false_
+     * - integers and floats as numbers
+     * - strings as string, optionally quoted
+     * - font features as quoted string
+     * - PangoLanguage as string
+     * - PangoFontDescription as serialized by [method@Pango.FontDescription.to_string], quoted
+     * - PangoColor as serialized by [method@Pango.Color.to_string]
+     *
+     * Examples:
+     *
+     * 0 10 foreground red, 5 15 weight bold, 0 200 font-desc "Sans 10"
+     *
+     * 0 -1 weight 700
+     * 0 100 family Times
+     *
+     * weight bold
+     *
+     * To parse the returned value, use [func@Pango.AttrList.from_string].
+     *
+     * Note that shape attributes can not be serialized.
+     */
     toString(): string;
+    /**
+     * Decrease the reference count of the given attribute
+     * list by one.
+     *
+     * If the result is zero, free the attribute list
+     * and the attributes it contains.
+     */
     unref(): void;
+    /**
+     * Update indices of attributes in `list` for a change in the
+     * text they refer to.
+     *
+     * The change that this function applies is removing `remove` bytes at position `pos` and inserting `add` bytes instead.
+     *
+     * Attributes that fall entirely in the (@pos, `pos` + @remove)
+     * range are removed.
+     *
+     * Attributes that start or end inside the (@pos, `pos` + @remove)
+     * range are shortened to reflect the removal.
+     *
+     * Attributes start and end positions are updated if they are
+     * behind `pos` + @remove.
+     * @param pos - the position of the change
+     * @param remove - the number of removed bytes
+     * @param add - the number of added bytes
+     */
     update(pos: number, remove: number, add: number): void;
 }

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

@@ -1,8 +1,25 @@
 import { call } from "@gtkx/native";
 import { getObject } from "@gtkx/ffi";
 import { AttrIterator } from "./attr-iterator.js";
+/**
+ * A `PangoAttrList` represents a list of attributes that apply to a section
+ * of text.
+ *
+ * The attributes in a `PangoAttrList` are, in general, allowed to overlap in
+ * an arbitrary fashion. However, if the attributes are manipulated only through
+ * [method@Pango.AttrList.change], the overlap between properties will meet
+ * stricter criteria.
+ *
+ * Since the `PangoAttrList` structure is stored as a linear list, it is not
+ * suitable for storing attributes for large amounts of text. In general, you
+ * should not use a single `PangoAttrList` for more than one paragraph of text.
+ */
 export class AttrList {
     ptr;
+    /**
+     * Create a new empty attribute list with a reference
+     * count of one.
+     */
     constructor() {
         this.ptr = this.createPtr([]);
     }
@@ -13,6 +30,13 @@ export class AttrList {
             innerType: "PangoAttrList",
         });
     }
+    /**
+     * Deserializes a `PangoAttrList` from a string.
+     *
+     * This is the counterpart to [method@Pango.AttrList.to_string].
+     * See that functions for details about the format.
+     * @param text - a string
+     */
     static fromString(text) {
         const ptr = call("libpango-1.0.so.0", "pango_attr_list_from_string", [
             {
@@ -27,6 +51,21 @@ export class AttrList {
         });
         return getObject(ptr, AttrList);
     }
+    /**
+     * Insert the given attribute into the `PangoAttrList`.
+     *
+     * It will replace any attributes of the same type
+     * on that segment and be merged with any adjoining
+     * attributes that are identical.
+     *
+     * This function is slower than [method@Pango.AttrList.insert]
+     * for creating an attribute list in order (potentially
+     * much slower for large lists). However,
+     * [method@Pango.AttrList.insert] is not suitable for
+     * continually changing a set of attributes since it
+     * never removes or combines existing attributes.
+     * @param attr - the attribute to insert
+     */
     change(attr) {
         call("libpango-1.0.so.0", "pango_attr_list_change", [
             {
@@ -43,6 +82,9 @@ export class AttrList {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Copy `list` and return an identical new list.
+     */
     copy() {
         const ptr = call("libpango-1.0.so.0", "pango_attr_list_copy", [
             {
@@ -59,6 +101,15 @@ export class AttrList {
             return null;
         return getObject(ptr, AttrList);
     }
+    /**
+     * Checks whether `list` and `other_list` contain the same
+     * attributes and whether those attributes apply to the
+     * same ranges.
+     *
+     * Beware that this will return wrong values if any list
+     * contains duplicates.
+     * @param otherList - the other `PangoAttrList`
+     */
     equal(otherList) {
         return call("libpango-1.0.so.0", "pango_attr_list_equal", [
             {
@@ -76,6 +127,13 @@ export class AttrList {
             },
         ], { type: "boolean" });
     }
+    /**
+     * Given a `PangoAttrList` and callback function, removes
+     * any elements of `list` for which `func` returns %TRUE and
+     * inserts them into a new list.
+     * @param func - callback function;
+     * @param data - Data to be passed to @func
+     */
     filter(func, data) {
         const ptr = call("libpango-1.0.so.0", "pango_attr_list_filter", [
             {
@@ -101,6 +159,9 @@ export class AttrList {
             return null;
         return getObject(ptr, AttrList);
     }
+    /**
+     * Gets a list of all attributes in @list.
+     */
     getAttributes() {
         return call("libpango-1.0.so.0", "pango_attr_list_get_attributes", [
             {
@@ -118,6 +179,11 @@ export class AttrList {
             borrowed: true,
         });
     }
+    /**
+     * Create a iterator initialized to the beginning of the list.
+     *
+     * `list` must not be modified until this iterator is freed.
+     */
     getIterator() {
         const ptr = call("libpango-1.0.so.0", "pango_attr_list_get_iterator", [
             {
@@ -132,6 +198,13 @@ export class AttrList {
         });
         return getObject(ptr, AttrIterator);
     }
+    /**
+     * Insert the given attribute into the `PangoAttrList`.
+     *
+     * It will be inserted after all other attributes with a
+     * matching @start_index.
+     * @param attr - the attribute to insert
+     */
     insert(attr) {
         call("libpango-1.0.so.0", "pango_attr_list_insert", [
             {
@@ -148,6 +221,13 @@ export class AttrList {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Insert the given attribute into the `PangoAttrList`.
+     *
+     * It will be inserted before all other attributes with a
+     * matching @start_index.
+     * @param attr - the attribute to insert
+     */
     insertBefore(attr) {
         call("libpango-1.0.so.0", "pango_attr_list_insert_before", [
             {
@@ -164,6 +244,10 @@ export class AttrList {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Increase the reference count of the given attribute
+     * list by one.
+     */
     ref() {
         const ptr = call("libpango-1.0.so.0", "pango_attr_list_ref", [
             {
@@ -178,6 +262,29 @@ export class AttrList {
         });
         return getObject(ptr, AttrList);
     }
+    /**
+     * This function opens up a hole in @list, fills it
+     * in with attributes from the left, and then merges
+     * `other` on top of the hole.
+     *
+     * This operation is equivalent to stretching every attribute
+     * that applies at position `pos` in `list` by an amount @len,
+     * and then calling [method@Pango.AttrList.change] with a copy
+     * of each attribute in `other` in sequence (offset in position
+     * by @pos, and limited in length to @len).
+     *
+     * This operation proves useful for, for instance, inserting
+     * a pre-edit string in the middle of an edit buffer.
+     *
+     * For backwards compatibility, the function behaves differently
+     * when `len` is 0. In this case, the attributes from `other` are
+     * not imited to @len, and are just overlayed on top of @list.
+     *
+     * This mode is useful for merging two lists of attributes together.
+     * @param other - another `PangoAttrList`
+     * @param pos - the position in `list` at which to insert @other
+     * @param len - the length of the spliced segment. (Note that this
+     */
     splice(other, pos, len) {
         call("libpango-1.0.so.0", "pango_attr_list_splice", [
             {
@@ -203,6 +310,42 @@ export class AttrList {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Serializes a `PangoAttrList` to a string.
+     *
+     * In the resulting string, serialized attributes are separated by newlines or commas.
+     * Individual attributes are serialized to a string of the form
+     *
+     * [START END] TYPE VALUE
+     *
+     * Where START and END are the indices (with -1 being accepted in place
+     * of MAXUINT), TYPE is the nickname of the attribute value type, e.g.
+     * _weight_ or _stretch_, and the value is serialized according to its type:
+     *
+     * Optionally, START and END can be omitted to indicate unlimited extent.
+     *
+     * - enum values as nick or numeric value
+     * - boolean values as _true_ or _false_
+     * - integers and floats as numbers
+     * - strings as string, optionally quoted
+     * - font features as quoted string
+     * - PangoLanguage as string
+     * - PangoFontDescription as serialized by [method@Pango.FontDescription.to_string], quoted
+     * - PangoColor as serialized by [method@Pango.Color.to_string]
+     *
+     * Examples:
+     *
+     * 0 10 foreground red, 5 15 weight bold, 0 200 font-desc "Sans 10"
+     *
+     * 0 -1 weight 700
+     * 0 100 family Times
+     *
+     * weight bold
+     *
+     * To parse the returned value, use [func@Pango.AttrList.from_string].
+     *
+     * Note that shape attributes can not be serialized.
+     */
     toString() {
         return call("libpango-1.0.so.0", "pango_attr_list_to_string", [
             {
@@ -211,6 +354,13 @@ export class AttrList {
             },
         ], { type: "string" });
     }
+    /**
+     * Decrease the reference count of the given attribute
+     * list by one.
+     *
+     * If the result is zero, free the attribute list
+     * and the attributes it contains.
+     */
     unref() {
         call("libpango-1.0.so.0", "pango_attr_list_unref", [
             {
@@ -219,6 +369,24 @@ export class AttrList {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Update indices of attributes in `list` for a change in the
+     * text they refer to.
+     *
+     * The change that this function applies is removing `remove` bytes at position `pos` and inserting `add` bytes instead.
+     *
+     * Attributes that fall entirely in the (@pos, `pos` + @remove)
+     * range are removed.
+     *
+     * Attributes that start or end inside the (@pos, `pos` + @remove)
+     * range are shortened to reflect the removal.
+     *
+     * Attributes start and end positions are updated if they are
+     * behind `pos` + @remove.
+     * @param pos - the position of the change
+     * @param remove - the number of removed bytes
+     * @param add - the number of added bytes
+     */
     update(pos, remove, add) {
         call("libpango-1.0.so.0", "pango_attr_list_update", [
             {

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

@@ -2,26 +2,108 @@ export interface AttributeInit {
     startIndex?: number;
     endIndex?: number;
 }
+/**
+ * The `PangoAttribute` structure represents the common portions of all
+ * attributes.
+ *
+ * Particular types of attributes include this structure as their initial
+ * portion. The common portion of the attribute holds the range to which
+ * the value in the type-specific part of the attribute applies and should
+ * be initialized using [method@Pango.Attribute.init]. By default, an attribute
+ * will have an all-inclusive range of [0,%G_MAXUINT].
+ */
 export declare class Attribute {
     ptr: unknown;
     constructor(init?: AttributeInit);
     protected createPtr(init: AttributeInit): unknown;
+    /**
+     * Returns the attribute cast to `PangoAttrColor`.
+     *
+     * This is mainly useful for language bindings.
+     */
     asColor(): number | null;
+    /**
+     * Returns the attribute cast to `PangoAttrFloat`.
+     *
+     * This is mainly useful for language bindings.
+     */
     asFloat(): number | null;
+    /**
+     * Returns the attribute cast to `PangoAttrFontDesc`.
+     *
+     * This is mainly useful for language bindings.
+     */
     asFontDesc(): number | null;
+    /**
+     * Returns the attribute cast to `PangoAttrFontFeatures`.
+     *
+     * This is mainly useful for language bindings.
+     */
     asFontFeatures(): number | null;
+    /**
+     * Returns the attribute cast to `PangoAttrInt`.
+     *
+     * This is mainly useful for language bindings.
+     */
     asInt(): number | null;
+    /**
+     * Returns the attribute cast to `PangoAttrLanguage`.
+     *
+     * This is mainly useful for language bindings.
+     */
     asLanguage(): number | null;
+    /**
+     * Returns the attribute cast to `PangoAttrShape`.
+     *
+     * This is mainly useful for language bindings.
+     */
     asShape(): number | null;
+    /**
+     * Returns the attribute cast to `PangoAttrSize`.
+     *
+     * This is mainly useful for language bindings.
+     */
     asSize(): number | null;
+    /**
+     * Returns the attribute cast to `PangoAttrString`.
+     *
+     * This is mainly useful for language bindings.
+     */
     asString(): number | null;
+    /**
+     * Make a copy of an attribute.
+     */
     copy(): Attribute;
+    /**
+     * Destroy a `PangoAttribute` and free all associated memory.
+     */
     destroy(): void;
+    /**
+     * Compare two attributes for equality.
+     *
+     * This compares only the actual value of the two
+     * attributes and not the ranges that the attributes
+     * apply to.
+     * @param attr2 - another `PangoAttribute`
+     */
     equal(attr2: Attribute): boolean;
+    /**
+     * Initializes @attr's klass to @klass, it's start_index to
+     * %PANGO_ATTR_INDEX_FROM_TEXT_BEGINNING and end_index to
+     * %PANGO_ATTR_INDEX_TO_TEXT_END such that the attribute applies
+     * to the entire text by default.
+     * @param klass - a `PangoAttrClass`
+     */
     init(klass: number): void;
+    /** the class structure holding information about the type of the attribute */
     get klass(): number;
+    /** the start index of the range (in bytes). */
     get startIndex(): number;
     set startIndex(value: number);
+    /**
+     * end index of the range (in bytes). The character at this index
+     * is not included in the range.
+     */
     get endIndex(): number;
     set endIndex(value: number);
 }