@gtkx/ffi 0.1.45 → 0.1.46

package/dist/generated/pango/font-metrics.js

@@ -1,5 +1,16 @@
 import { alloc, call } from "@gtkx/native";
 import { getObject } from "@gtkx/ffi";
+/**
+ * A `PangoFontMetrics` structure holds the overall metric information
+ * for a font.
+ *
+ * The information in a `PangoFontMetrics` structure may be restricted
+ * to a script. The fields of this structure are private to implementations
+ * of a font backend. See the documentation of the corresponding getters
+ * for documentation of their meaning.
+ *
+ * For an overview of the most important metrics, see:
+ */
 export class FontMetrics {
     ptr;
     constructor() {
@@ -8,6 +19,13 @@ export class FontMetrics {
     createPtr(_init) {
         return alloc(0, "PangoFontMetrics", "libpango-1.0.so.0");
     }
+    /**
+     * Gets the approximate character width for a font metrics structure.
+     *
+     * This is merely a representative value useful, for example, for
+     * determining the initial size for a window. Actual characters in
+     * text will be wider and narrower than this.
+     */
     getApproximateCharWidth() {
         return call("libpango-1.0.so.0", "pango_font_metrics_get_approximate_char_width", [
             {
@@ -16,6 +34,15 @@ export class FontMetrics {
             },
         ], { type: "int", size: 32, unsigned: false });
     }
+    /**
+     * Gets the approximate digit width for a font metrics structure.
+     *
+     * This is merely a representative value useful, for example, for
+     * determining the initial size for a window. Actual digits in
+     * text can be wider or narrower than this, though this value
+     * is generally somewhat more accurate than the result of
+     * pango_font_metrics_get_approximate_char_width() for digits.
+     */
     getApproximateDigitWidth() {
         return call("libpango-1.0.so.0", "pango_font_metrics_get_approximate_digit_width", [
             {
@@ -24,6 +51,14 @@ export class FontMetrics {
             },
         ], { type: "int", size: 32, unsigned: false });
     }
+    /**
+     * Gets the ascent from a font metrics structure.
+     *
+     * The ascent is the distance from the baseline to the logical top
+     * of a line of text. (The logical top may be above or below the top
+     * of the actual drawn ink. It is necessary to lay out the text to
+     * figure where the ink will be.)
+     */
     getAscent() {
         return call("libpango-1.0.so.0", "pango_font_metrics_get_ascent", [
             {
@@ -32,6 +67,14 @@ export class FontMetrics {
             },
         ], { type: "int", size: 32, unsigned: false });
     }
+    /**
+     * Gets the descent from a font metrics structure.
+     *
+     * The descent is the distance from the baseline to the logical bottom
+     * of a line of text. (The logical bottom may be above or below the
+     * bottom of the actual drawn ink. It is necessary to lay out the text
+     * to figure where the ink will be.)
+     */
     getDescent() {
         return call("libpango-1.0.so.0", "pango_font_metrics_get_descent", [
             {
@@ -40,6 +83,14 @@ export class FontMetrics {
             },
         ], { type: "int", size: 32, unsigned: false });
     }
+    /**
+     * Gets the line height from a font metrics structure.
+     *
+     * The line height is the recommended distance between successive
+     * baselines in wrapped text using this font.
+     *
+     * If the line height is not available, 0 is returned.
+     */
     getHeight() {
         return call("libpango-1.0.so.0", "pango_font_metrics_get_height", [
             {
@@ -48,6 +99,12 @@ export class FontMetrics {
             },
         ], { type: "int", size: 32, unsigned: false });
     }
+    /**
+     * Gets the suggested position to draw the strikethrough.
+     *
+     * The value returned is the distance *above* the
+     * baseline of the top of the strikethrough.
+     */
     getStrikethroughPosition() {
         return call("libpango-1.0.so.0", "pango_font_metrics_get_strikethrough_position", [
             {
@@ -56,6 +113,9 @@ export class FontMetrics {
             },
         ], { type: "int", size: 32, unsigned: false });
     }
+    /**
+     * Gets the suggested thickness to draw for the strikethrough.
+     */
     getStrikethroughThickness() {
         return call("libpango-1.0.so.0", "pango_font_metrics_get_strikethrough_thickness", [
             {
@@ -64,6 +124,13 @@ export class FontMetrics {
             },
         ], { type: "int", size: 32, unsigned: false });
     }
+    /**
+     * Gets the suggested position to draw the underline.
+     *
+     * The value returned is the distance *above* the baseline of the top
+     * of the underline. Since most fonts have underline positions beneath
+     * the baseline, this value is typically negative.
+     */
     getUnderlinePosition() {
         return call("libpango-1.0.so.0", "pango_font_metrics_get_underline_position", [
             {
@@ -72,6 +139,9 @@ export class FontMetrics {
             },
         ], { type: "int", size: 32, unsigned: false });
     }
+    /**
+     * Gets the suggested thickness to draw for the underline.
+     */
     getUnderlineThickness() {
         return call("libpango-1.0.so.0", "pango_font_metrics_get_underline_thickness", [
             {
@@ -80,6 +150,9 @@ export class FontMetrics {
             },
         ], { type: "int", size: 32, unsigned: false });
     }
+    /**
+     * Increase the reference count of a font metrics structure by one.
+     */
     ref() {
         const ptr = call("libpango-1.0.so.0", "pango_font_metrics_ref", [
             {
@@ -96,6 +169,11 @@ export class FontMetrics {
             return null;
         return getObject(ptr, FontMetrics);
     }
+    /**
+     * Decrease the reference count of a font metrics structure by one.
+     *
+     * If the result is zero, frees the structure and any associated memory.
+     */
     unref() {
         call("libpango-1.0.so.0", "pango_font_metrics_unref", [
             {

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

@@ -9,21 +9,140 @@ import { FontMap } from "./font-map.js";
 import * as GLib from "../glib/index.js";
 import * as GObject from "../gobject/index.js";
 import * as HarfBuzz from "../harfbuzz/index.js";
+/**
+ * A `PangoFont` is used to represent a font in a
+ * rendering-system-independent manner.
+ */
 export declare class Font extends GObject.GObject {
     constructor(...args: unknown[]);
     protected createPtr(_args: unknown[]): unknown;
+    /**
+     * Frees an array of font descriptions.
+     * @param descs - a pointer
+     * @param nDescs - number of font descriptions in @descs
+     */
     static descriptionsFree(nDescs: number, descs?: FontDescription[] | null): void;
+    /**
+     * Loads data previously created via [method@Pango.Font.serialize].
+     *
+     * For a discussion of the supported format, see that function.
+     *
+     * Note: to verify that the returned font is identical to
+     * the one that was serialized, you can compare `bytes` to the
+     * result of serializing the font again.
+     * @param context - a `PangoContext`
+     * @param bytes - the bytes containing the data
+     */
     static deserialize(context: Context, bytes: GLib.Bytes): Font;
+    /**
+     * Returns a description of the font, with font size set in points.
+     *
+     * Use [method@Pango.Font.describe_with_absolute_size] if you want
+     * the font size in device units.
+     */
     describe(): FontDescription;
+    /**
+     * Returns a description of the font, with absolute font size set
+     * in device units.
+     *
+     * Use [method@Pango.Font.describe] if you want the font size in points.
+     */
     describeWithAbsoluteSize(): FontDescription;
+    /**
+     * Computes the coverage map for a given font and language tag.
+     * @param language - the language tag
+     */
     getCoverage(language: Language): Coverage;
+    /**
+     * Gets the `PangoFontFace` to which `font` belongs.
+     *
+     * Note that this function can return `NULL` in cases
+     * where the font outlives its font map.
+     */
     getFace(): FontFace | null;
+    /**
+     * Obtain the OpenType features that are provided by the font.
+     *
+     * These are passed to the rendering system, together with features
+     * that have been explicitly set via attributes.
+     *
+     * Note that this does not include OpenType features which the
+     * rendering system enables by default.
+     * @param features - Array to features in
+     * @param len - the length of @features
+     * @param numFeatures - the number of used items in @features
+     */
     getFeatures(features: Ref<HarfBuzz.FeatureT[]>, len: number, numFeatures: Ref<number>): void;
+    /**
+     * Gets the font map for which the font was created.
+     *
+     * Note that the font maintains a *weak* reference to
+     * the font map, so if all references to font map are
+     * dropped, the font map will be finalized even if there
+     * are fonts created with the font map that are still alive.
+     * In that case this function will return %NULL.
+     *
+     * It is the responsibility of the user to ensure that the
+     * font map is kept alive. In most uses this is not an issue
+     * as a `PangoContext` holds a reference to the font map.
+     */
     getFontMap(): FontMap | null;
+    /**
+     * Gets the logical and ink extents of a glyph within a font.
+     *
+     * The coordinate system for each rectangle has its origin at the
+     * base line and horizontal origin of the character with increasing
+     * coordinates extending to the right and down. The macros PANGO_ASCENT(),
+     * PANGO_DESCENT(), PANGO_LBEARING(), and PANGO_RBEARING() can be used to convert
+     * from the extents rectangle to more traditional font metrics. The units
+     * of the rectangles are in 1/PANGO_SCALE of a device unit.
+     *
+     * If `font` is %NULL, this function gracefully sets some sane values in the
+     * output variables and returns.
+     * @param glyph - the glyph index
+     * @param inkRect - rectangle used to store the extents of the glyph as drawn
+     * @param logicalRect - rectangle used to store the logical extents of the glyph
+     */
     getGlyphExtents(glyph: number, inkRect?: Ref<number> | null, logicalRect?: Ref<number> | null): void;
+    /**
+     * Returns the languages that are supported by @font.
+     *
+     * If the font backend does not provide this information,
+     * %NULL is returned. For the fontconfig backend, this
+     * corresponds to the FC_LANG member of the FcPattern.
+     *
+     * The returned array is only valid as long as the font
+     * and its fontmap are valid.
+     */
     getLanguages(): Language[] | null;
+    /**
+     * Gets overall metric information for a font.
+     *
+     * Since the metrics may be substantially different for different scripts,
+     * a language tag can be provided to indicate that the metrics should be
+     * retrieved that correspond to the script(s) used by that language.
+     *
+     * If `font` is %NULL, this function gracefully sets some sane values in the
+     * output variables and returns.
+     * @param language - language tag used to determine which script
+     */
     getMetrics(language?: Language | null): FontMetrics;
+    /**
+     * Returns whether the font provides a glyph for this character.
+     * @param wc - a Unicode character
+     */
     hasChar(wc: number): boolean;
+    /**
+     * Serializes the `font` in a way that can be uniquely identified.
+     *
+     * There are no guarantees about the format of the output across different
+     * versions of Pango.
+     *
+     * The intended use of this function is testing, benchmarking and debugging.
+     * The format is not meant as a permanent storage format.
+     *
+     * To recreate a font from its serialized form, use [func@Pango.Font.deserialize].
+     */
     serialize(): GLib.Bytes;
     connect(signal: "notify", handler: (self: Font, pspec: GObject.ParamSpec) => void, after?: boolean): number;
     connect(signal: string, handler: (...args: any[]) => any, after?: boolean): number;

package/dist/generated/pango/font.js

@@ -7,6 +7,10 @@ import { FontFace } from "./font-face.js";
 import { FontMap } from "./font-map.js";
 import * as GLib from "../glib/index.js";
 import * as GObject from "../gobject/index.js";
+/**
+ * A `PangoFont` is used to represent a font in a
+ * rendering-system-independent manner.
+ */
 export class Font extends GObject.GObject {
     constructor(...args) {
         super(...args);
@@ -22,6 +26,11 @@ export class Font extends GObject.GObject {
             { type: { type: "gobject" }, value: null },
         ], { type: "gobject", borrowed: true });
     }
+    /**
+     * Frees an array of font descriptions.
+     * @param descs - a pointer
+     * @param nDescs - number of font descriptions in @descs
+     */
     static descriptionsFree(nDescs, descs) {
         call("libpango-1.0.so.0", "pango_font_descriptions_free", [
             {
@@ -42,6 +51,17 @@ export class Font extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Loads data previously created via [method@Pango.Font.serialize].
+     *
+     * For a discussion of the supported format, see that function.
+     *
+     * Note: to verify that the returned font is identical to
+     * the one that was serialized, you can compare `bytes` to the
+     * result of serializing the font again.
+     * @param context - a `PangoContext`
+     * @param bytes - the bytes containing the data
+     */
     static deserialize(context, bytes) {
         const error = { value: null };
         const ptr = call("libpango-1.0.so.0", "pango_font_deserialize", [
@@ -75,6 +95,12 @@ export class Font extends GObject.GObject {
         }
         return getObject(ptr, Font);
     }
+    /**
+     * Returns a description of the font, with font size set in points.
+     *
+     * Use [method@Pango.Font.describe_with_absolute_size] if you want
+     * the font size in device units.
+     */
     describe() {
         const ptr = call("libpango-1.0.so.0", "pango_font_describe", [
             {
@@ -89,6 +115,12 @@ export class Font extends GObject.GObject {
         });
         return getObject(ptr, FontDescription);
     }
+    /**
+     * Returns a description of the font, with absolute font size set
+     * in device units.
+     *
+     * Use [method@Pango.Font.describe] if you want the font size in points.
+     */
     describeWithAbsoluteSize() {
         const ptr = call("libpango-1.0.so.0", "pango_font_describe_with_absolute_size", [
             {
@@ -103,6 +135,10 @@ export class Font extends GObject.GObject {
         });
         return getObject(ptr, FontDescription);
     }
+    /**
+     * Computes the coverage map for a given font and language tag.
+     * @param language - the language tag
+     */
     getCoverage(language) {
         const ptr = call("libpango-1.0.so.0", "pango_font_get_coverage", [
             {
@@ -121,6 +157,12 @@ export class Font extends GObject.GObject {
         ], { type: "gobject", borrowed: true });
         return getObject(ptr, Coverage);
     }
+    /**
+     * Gets the `PangoFontFace` to which `font` belongs.
+     *
+     * Note that this function can return `NULL` in cases
+     * where the font outlives its font map.
+     */
     getFace() {
         const ptr = call("libpango-1.0.so.0", "pango_font_get_face", [
             {
@@ -132,6 +174,18 @@ export class Font extends GObject.GObject {
             return null;
         return getObject(ptr, FontFace);
     }
+    /**
+     * Obtain the OpenType features that are provided by the font.
+     *
+     * These are passed to the rendering system, together with features
+     * that have been explicitly set via attributes.
+     *
+     * Note that this does not include OpenType features which the
+     * rendering system enables by default.
+     * @param features - Array to features in
+     * @param len - the length of @features
+     * @param numFeatures - the number of used items in @features
+     */
     getFeatures(features, len, numFeatures) {
         call("libpango-1.0.so.0", "pango_font_get_features", [
             {
@@ -165,6 +219,19 @@ export class Font extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Gets the font map for which the font was created.
+     *
+     * Note that the font maintains a *weak* reference to
+     * the font map, so if all references to font map are
+     * dropped, the font map will be finalized even if there
+     * are fonts created with the font map that are still alive.
+     * In that case this function will return %NULL.
+     *
+     * It is the responsibility of the user to ensure that the
+     * font map is kept alive. In most uses this is not an issue
+     * as a `PangoContext` holds a reference to the font map.
+     */
     getFontMap() {
         const ptr = call("libpango-1.0.so.0", "pango_font_get_font_map", [
             {
@@ -176,6 +243,22 @@ export class Font extends GObject.GObject {
             return null;
         return getObject(ptr, FontMap);
     }
+    /**
+     * Gets the logical and ink extents of a glyph within a font.
+     *
+     * The coordinate system for each rectangle has its origin at the
+     * base line and horizontal origin of the character with increasing
+     * coordinates extending to the right and down. The macros PANGO_ASCENT(),
+     * PANGO_DESCENT(), PANGO_LBEARING(), and PANGO_RBEARING() can be used to convert
+     * from the extents rectangle to more traditional font metrics. The units
+     * of the rectangles are in 1/PANGO_SCALE of a device unit.
+     *
+     * If `font` is %NULL, this function gracefully sets some sane values in the
+     * output variables and returns.
+     * @param glyph - the glyph index
+     * @param inkRect - rectangle used to store the extents of the glyph as drawn
+     * @param logicalRect - rectangle used to store the logical extents of the glyph
+     */
     getGlyphExtents(glyph, inkRect, logicalRect) {
         call("libpango-1.0.so.0", "pango_font_get_glyph_extents", [
             {
@@ -204,6 +287,16 @@ export class Font extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Returns the languages that are supported by @font.
+     *
+     * If the font backend does not provide this information,
+     * %NULL is returned. For the fontconfig backend, this
+     * corresponds to the FC_LANG member of the FcPattern.
+     *
+     * The returned array is only valid as long as the font
+     * and its fontmap are valid.
+     */
     getLanguages() {
         return call("libpango-1.0.so.0", "pango_font_get_languages", [
             {
@@ -219,6 +312,17 @@ export class Font extends GObject.GObject {
             },
         });
     }
+    /**
+     * Gets overall metric information for a font.
+     *
+     * Since the metrics may be substantially different for different scripts,
+     * a language tag can be provided to indicate that the metrics should be
+     * retrieved that correspond to the script(s) used by that language.
+     *
+     * If `font` is %NULL, this function gracefully sets some sane values in the
+     * output variables and returns.
+     * @param language - language tag used to determine which script
+     */
     getMetrics(language) {
         const ptr = call("libpango-1.0.so.0", "pango_font_get_metrics", [
             {
@@ -243,6 +347,10 @@ export class Font extends GObject.GObject {
         });
         return getObject(ptr, FontMetrics);
     }
+    /**
+     * Returns whether the font provides a glyph for this character.
+     * @param wc - a Unicode character
+     */
     hasChar(wc) {
         return call("libpango-1.0.so.0", "pango_font_has_char", [
             {
@@ -255,6 +363,17 @@ export class Font extends GObject.GObject {
             },
         ], { type: "boolean" });
     }
+    /**
+     * Serializes the `font` in a way that can be uniquely identified.
+     *
+     * There are no guarantees about the format of the output across different
+     * versions of Pango.
+     *
+     * The intended use of this function is testing, benchmarking and debugging.
+     * The format is not meant as a permanent storage format.
+     *
+     * To recreate a font from its serialized form, use [func@Pango.Font.deserialize].
+     */
     serialize() {
         const ptr = call("libpango-1.0.so.0", "pango_font_serialize", [
             {

package/dist/generated/pango/fontset-simple.d.ts

@@ -1,10 +1,30 @@
 import { Language } from "./language.js";
 import { Font } from "./font.js";
 import { Fontset } from "./fontset.js";
+/**
+ * `PangoFontsetSimple` is a implementation of the abstract
+ * `PangoFontset` base class as an array of fonts.
+ *
+ * When creating a `PangoFontsetSimple`, you have to provide
+ * the array of fonts that make up the fontset.
+ */
 export declare class FontsetSimple extends Fontset {
+    /**
+     * Creates a new `PangoFontsetSimple` for the given language.
+     * @param language - a `PangoLanguage` tag
+     */
     constructor(language: Language);
     constructor(...args: unknown[]);
     protected createPtr(args: unknown[]): unknown;
+    /**
+     * Adds a font to the fontset.
+     *
+     * The fontset takes ownership of @font.
+     * @param font - a `PangoFont`.
+     */
     append(font: Font): void;
+    /**
+     * Returns the number of fonts in the fontset.
+     */
     size(): number;
 }

package/dist/generated/pango/fontset-simple.js

@@ -1,5 +1,12 @@
 import { call } from "@gtkx/native";
 import { Fontset } from "./fontset.js";
+/**
+ * `PangoFontsetSimple` is a implementation of the abstract
+ * `PangoFontset` base class as an array of fonts.
+ *
+ * When creating a `PangoFontsetSimple`, you have to provide
+ * the array of fonts that make up the fontset.
+ */
 export class FontsetSimple extends Fontset {
     constructor(...args) {
         super(...args);
@@ -18,6 +25,12 @@ export class FontsetSimple extends Fontset {
             },
         ], { type: "gobject", borrowed: false });
     }
+    /**
+     * Adds a font to the fontset.
+     *
+     * The fontset takes ownership of @font.
+     * @param font - a `PangoFont`.
+     */
     append(font) {
         call("libpango-1.0.so.0", "pango_fontset_simple_append", [
             {
@@ -30,6 +43,9 @@ export class FontsetSimple extends Fontset {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Returns the number of fonts in the fontset.
+     */
     size() {
         return call("libpango-1.0.so.0", "pango_fontset_simple_size", [
             {

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

@@ -1,11 +1,35 @@
 import { FontMetrics } from "./font-metrics.js";
 import { Font } from "./font.js";
 import * as GObject from "../gobject/index.js";
+/**
+ * A `PangoFontset` represents a set of `PangoFont` to use when rendering text.
+ *
+ * A `PangoFontset` is the result of resolving a `PangoFontDescription`
+ * against a particular `PangoContext`. It has operations for finding the
+ * component font for a particular Unicode character, and for finding a
+ * composite set of metrics for the entire fontset.
+ */
 export declare class Fontset extends GObject.GObject {
     constructor(...args: unknown[]);
     protected createPtr(_args: unknown[]): unknown;
+    /**
+     * Iterates through all the fonts in a fontset, calling `func` for
+     * each one.
+     *
+     * If `func` returns %TRUE, that stops the iteration.
+     * @param func - Callback function
+     * @param data - data to pass to the callback function
+     */
     foreach(func: (...args: unknown[]) => unknown, data?: number | null): void;
+    /**
+     * Returns the font in the fontset that contains the best
+     * glyph for a Unicode character.
+     * @param wc - a Unicode character
+     */
     getFont(wc: number): Font;
+    /**
+     * Get overall metric information for the fonts in the fontset.
+     */
     getMetrics(): FontMetrics;
     connect(signal: "notify", handler: (self: Fontset, pspec: GObject.ParamSpec) => void, after?: boolean): number;
     connect(signal: string, handler: (...args: any[]) => any, after?: boolean): number;

package/dist/generated/pango/fontset.js

@@ -3,6 +3,14 @@ import { getObject } from "@gtkx/ffi";
 import { FontMetrics } from "./font-metrics.js";
 import { Font } from "./font.js";
 import * as GObject from "../gobject/index.js";
+/**
+ * A `PangoFontset` represents a set of `PangoFont` to use when rendering text.
+ *
+ * A `PangoFontset` is the result of resolving a `PangoFontDescription`
+ * against a particular `PangoContext`. It has operations for finding the
+ * component font for a particular Unicode character, and for finding a
+ * composite set of metrics for the entire fontset.
+ */
 export class Fontset extends GObject.GObject {
     constructor(...args) {
         super(...args);
@@ -18,6 +26,14 @@ export class Fontset extends GObject.GObject {
             { type: { type: "gobject" }, value: null },
         ], { type: "gobject", borrowed: true });
     }
+    /**
+     * Iterates through all the fonts in a fontset, calling `func` for
+     * each one.
+     *
+     * If `func` returns %TRUE, that stops the iteration.
+     * @param func - Callback function
+     * @param data - data to pass to the callback function
+     */
     foreach(func, data) {
         call("libpango-1.0.so.0", "pango_fontset_foreach", [
             {
@@ -35,6 +51,11 @@ export class Fontset extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Returns the font in the fontset that contains the best
+     * glyph for a Unicode character.
+     * @param wc - a Unicode character
+     */
     getFont(wc) {
         const ptr = call("libpango-1.0.so.0", "pango_fontset_get_font", [
             {
@@ -48,6 +69,9 @@ export class Fontset extends GObject.GObject {
         ], { type: "gobject", borrowed: true });
         return getObject(ptr, Font);
     }
+    /**
+     * Get overall metric information for the fonts in the fontset.
+     */
     getMetrics() {
         const ptr = call("libpango-1.0.so.0", "pango_fontset_get_metrics", [
             {