@ts-for-gir/cli 3.0.0-beta.9 → 3.0.0

package/src/types/answer-version.ts

@@ -1,4 +0,0 @@
-export interface AnswerVersion {
-    selected: string[]
-    unselected: string[]
-}

package/src/types/build-type.ts

@@ -1 +0,0 @@
-export type BuildType = 'lib' | 'types'

package/src/types/class-parent.ts

@@ -1,14 +0,0 @@
-import { GirClassElement, GirUnionElement, GirInterfaceElement, GirRecordElement, TypeGirClass } from './index.js'
-
-export interface ClassParent {
-    parentName: string
-    qualifiedParentName: string
-    /** qualified if its module != qualifiedName's module */
-    localParentName: string
-    type: 'parent' | 'prerequisite' | 'implements'
-    /** Parent class / interface */
-    cls?: GirClassElement | GirUnionElement | GirInterfaceElement | GirRecordElement
-    girTypeName: TypeGirClass
-    /** True if the parent dependency exists */
-    dependencyExists: boolean
-}

package/src/types/config-flags.ts

@@ -1,5 +0,0 @@
-import { UserConfig } from './user-config'
-
-export interface ConfigFlags extends UserConfig {
-    configName: string
-}

package/src/types/conflict-child-element.ts

@@ -1,11 +0,0 @@
-import type { TsFunction, TsProperty, TsVar } from './index.js'
-
-export interface ConflictChildElement<T = TsFunction | TsProperty | TsVar> {
-    /**
-     * The depth of the inheritance, starts at 1.
-     * 1 means it is a direct inheritance,
-     * greater means it is an indirect inheritance
-     */
-    depth: number
-    data: T
-}

package/src/types/conflict-grouped-element.ts

@@ -1,7 +0,0 @@
-import type { TsFunction, TsProperty, TsVar, TsClass, ConflictChildElement } from './index.js'
-
-export interface ConflictGroupedElement<T = TsFunction | TsProperty | TsVar> {
-    baseElements: ConflictChildElement<T>[]
-    inheritedElements: ConflictChildElement<T>[]
-    baseClass: TsClass
-}

package/src/types/conflict-grouped-elements.ts

@@ -1,5 +0,0 @@
-import type { TsFunction, TsProperty, TsVar, ConflictGroupedElement } from './index.js'
-
-export interface ConflictGroupedElements<T = TsFunction | TsProperty | TsVar> {
-    [name: string]: ConflictGroupedElement<T>
-}

package/src/types/construct-name.ts

@@ -1,11 +0,0 @@
-export type ConstructName =
-    | 'functionName'
-    | 'enumMember'
-    | 'signalName'
-    | 'fieldName'
-    | 'constantName'
-    | 'propertyName'
-    | 'parameterName'
-    | 'enumName'
-    | 'importName'
-    | 'signalInterfaceName'

package/src/types/dependency-map.ts

@@ -1,4 +0,0 @@
-import { Dependency } from './dependency'
-export interface DependencyMap {
-    [packageName: string]: Dependency[]
-}

package/src/types/dependency.ts

@@ -1,16 +0,0 @@
-import { FileInfo } from './file-info.js'
-
-export interface Dependency extends FileInfo {
-    /**
-     * E.g. 'Gtk'
-     */
-    namespace: string
-    /**
-     * E.g. '3.0'
-     */
-    version: string
-    /**
-     * E.g. 'Gtk-3.0'
-     */
-    packageName: string
-}

package/src/types/environment.ts

@@ -1 +0,0 @@
-export type Environment = 'gjs' | 'node'

package/src/types/file-info.ts

@@ -1,14 +0,0 @@
-export interface FileInfo {
-    /**
-     * The path to the gir file or null if the file does not exist
-     */
-    path: string | null
-    /**
-     * The filename of the gir file
-     */
-    filename: string
-    /**
-     * Whether the file exists or not
-     */
-    exists: boolean
-}

package/src/types/generate-config.ts

@@ -1,33 +0,0 @@
-import { BuildType, Environment, ModuleType } from './index.js'
-
-/**
- * Type for currently used config e.g. in GirModule
- */
-export interface GenerateConfig {
-    /** javascript environment */
-    environment: Environment
-    /** directory to output to */
-    outdir: string | null
-    /** Definitions generation type */
-    buildType?: BuildType
-    /** Module type, can be CommonJS or ESM */
-    moduleType?: ModuleType
-    /** GIR directories */
-    girDirectories: string[]
-    /** Switch on/off the verbose mode */
-    verbose: boolean
-    /** Do not export all symbols for each module as a namespace */
-    noNamespace: boolean
-    /** Do not generate documentation comments */
-    noComments: boolean
-    /** Do not generate debugging inline comments */
-    noDebugComments: boolean
-    /** Fix Inheritance and implementation type conflicts */
-    fixConflicts: boolean
-    /** Disables the generation of types that are in conflict with the DOM types */
-    noDOMLib: boolean
-    /** Generate types for GNOME Shell */
-    gnomeShellTypes: boolean
-    /** Generate a tsconfig alias */
-    generateAlias: boolean
-}

package/src/types/generator-type.ts

@@ -1,4 +0,0 @@
-export enum GeneratorType {
-    TYPES,
-    HTML_DOC,
-}

package/src/types/gir-alias-element.ts

@@ -1,15 +0,0 @@
-import { GirInfoAttrs, GirInfoElements, GirType, PartOfClass, TsAlias } from './index.js'
-
-export interface GirAliasElement extends PartOfClass, GirInfoElements {
-    /** Type's name substitution, representing a typedef in C */
-    $: GirInfoAttrs & {
-        /** the new name or typedef'd name */
-        name: string
-        /** the corresponding C type's name */
-        'c:type'?: string
-    }
-    /** Other elements an alias can contain */
-    type?: GirType[]
-
-    _tsData?: TsAlias
-}

package/src/types/gir-annotation.ts

@@ -1,10 +0,0 @@
-// See https://gitlab.gnome.org/ewlsh/gi.ts/-/blob/master/packages/parser/src/xml.ts
-export interface GirAnnotation {
-    /** element defining an annotation from the source code, usually a user-defined annotation associated to a parameter or a return value */
-    $: {
-        /** name of the attribute */
-        name: string
-        /** value of the attribute */
-        value: string[]
-    }
-}

package/src/types/gir-any-element.ts

@@ -1,35 +0,0 @@
-import {
-    GirBitfieldElement,
-    GirCallbackElement,
-    GirClassElement,
-    GirConstantElement,
-    GirEnumElement,
-    GirFunctionElement,
-    GirInterfaceElement,
-    GirRecordElement,
-    GirUnionElement,
-    GirAliasElement,
-    GirMethodElement,
-    GirVirtualMethodElement,
-    GirSignalElement,
-    GirConstructorElement,
-    GirFieldElement,
-    GirPropertyElement,
-} from './index.js'
-export type GirAnyElement =
-    | GirBitfieldElement
-    | GirCallbackElement
-    | GirClassElement
-    | GirConstantElement
-    | GirEnumElement
-    | GirFunctionElement
-    | GirInterfaceElement
-    | GirRecordElement
-    | GirUnionElement
-    | GirAliasElement
-    | GirMethodElement
-    | GirVirtualMethodElement
-    | GirSignalElement
-    | GirConstructorElement
-    | GirFieldElement
-    | GirPropertyElement

package/src/types/gir-any-type.ts

@@ -1,7 +0,0 @@
-import { GirType, GirArrayType } from './index.js'
-
-//A generic grammar element to represent either a simple Type or an Array of the same Type
-export interface GirAnyType {
-    type?: GirType[]
-    array?: GirArrayType[]
-}

package/src/types/gir-array-type.ts

@@ -1,23 +0,0 @@
-// See https://gitlab.gnome.org/ewlsh/gi.ts/-/blob/master/packages/parser/src/xml.ts
-
-import { GirInfoAttrs, GirUnparsedNumber, GirBoolean, GirType } from './index.js'
-
-export interface GirArrayType {
-    /** An array type of data where each element is of the same type */
-    $: GirInfoAttrs & {
-        /** name of the array type */
-        name?: string
-        /** Binary attribute, true if the last element of the array is zero. For example, in an array of pointers, the last pointer would be NULL */
-        'zero-terminated'?: GirBoolean
-        /** size of an array of predetermined fixed size. For example a C array declared as char arr[5]. */
-        'fixed-size'?: GirUnparsedNumber /** integer */
-        /** Binary attribute which is GirBoolean (false) if the element is not introspectable. It doesn't exist in the bindings, due in general to missing information in the annotations in the original C code */
-        introspectable?: GirBoolean
-        /** 0-based index of parameter element that specifies the length of the array */
-        length?: GirUnparsedNumber /** integer */
-        /** the C representation of the array type */
-        'c:type'?: string
-    }
-    array?: GirArrayType[]
-    type?: GirType[]
-}

package/src/types/gir-bitfield-element.ts

@@ -1,20 +0,0 @@
-import { GirInfoAttrs, GirFunctionElement, GirInfoElements, GirMemberElement, TsEnum, PartOfModule } from './index.js'
-
-export interface GirBitfieldElement extends PartOfModule, GirInfoElements {
-    /** element defining a bit field (as in C) */
-    $: GirInfoAttrs & {
-        /** name of the bit field */
-        name: string
-        /** corresponding C type of the bit field type */
-        'c:type': string
-        /** GObject compatible type name */
-        'glib:type-name'?: string
-        /** function to retrieve the GObject compatible type of the element */
-        'glib:get-type'?: string
-    }
-
-    member: GirMemberElement[]
-    function: GirFunctionElement[]
-
-    _tsData?: TsEnum
-}

package/src/types/gir-boolean.ts

@@ -1 +0,0 @@
-export type GirBoolean = '0' | '1'

package/src/types/gir-boxed-element.ts

@@ -1,19 +0,0 @@
-import { GirInfoAttrs, GirFunctionElement } from './index.js'
-
-export interface GirBoxedElement {
-    /** Boxed type (wrapper to opaque C structures registered by the type system) */
-    $: GirInfoAttrs & {
-        /** GObject compatible type name of the boxed type */
-        'glib:name': string
-        /** prefix to filter out from C functions. For example, gtk_window_new will lose gtk_ */
-        'c:symbol-prefix'?: string
-        /** GObject compatible type name of the boxed type */
-        'glib:type-name'?: string
-        /** Function to get the GObject compatible type of the boxed type */
-        'glib:get-type'?: string
-    }
-
-    /* Other elements a Boxed type can contain */
-
-    function?: GirFunctionElement[]
-}

package/src/types/gir-c-include.ts

@@ -1,7 +0,0 @@
-export interface GirCInclude {
-    /** Dependant C header file which should be included in C programs */
-    $: {
-        /** File name of the C header file. The path can be relative. */
-        name: string
-    }
-}

package/src/types/gir-callable-attrs.ts

@@ -1,19 +0,0 @@
-// See https://gitlab.gnome.org/ewlsh/gi.ts/-/blob/master/packages/parser/src/xml.ts
-
-import { GirBoolean } from './gir-boolean'
-
-/** Attributes of a Callable (functions, callbacks, closures, etc...) */
-export interface GirCallableAttrs {
-    /** name of the Callable */
-    name: string
-    //C identifier in the source code of the Callable
-    'c:identifier'?: string
-    /** Callable it is shadowed by. For example, in C++, only one version of an overloaded callable will appear */
-    'shadowed-by'?: string
-    /** Callable it shadows. For example, in C++, only one version of an overloaded callable will appear */
-    shadows?: string
-    /** Binary attribute, true if the callable can throw an error */
-    throws?: GirBoolean
-    /** if for backward compatibility reason the callable has a name in the source code but should be known by another one, this attribute contains the new name     */
-    'moved-to'?: string[]
-}

package/src/types/gir-callable-param-element.ts

@@ -1,45 +0,0 @@
-import type {
-    GirBoolean,
-    GirUnparsedNumber,
-    GirInfoAttrs,
-    GirDocElement,
-    GirAnyType,
-    GirTransferOwnership,
-    GirDirection,
-    GirVarArgs,
-    PartOfClass,
-    TsParameter,
-} from './index.js'
-
-export interface GirCallableParamElement extends PartOfClass, GirDocElement, GirAnyType {
-    /** parameter element of a list of parameters */
-    $: GirInfoAttrs &
-        Partial<GirTransferOwnership> & {
-            /** name of the parameter */
-            name?: string
-            /** Binary attribute, true if the parameter can have a null value */
-            nullable?: GirBoolean
-            /** @deprecated Replaced by nullable and optional */
-            'allow-none'?: GirBoolean
-            /** Binary attribute which is GirBoolean(false) if the element is not introspectable. It doesn't exist in the bindings, due in general to missing information in the annotations in the original C code */
-            introspectable?: GirBoolean
-            /** the parameter is a user_data for callbacks. The value points to a different parameter that is the actual callback */
-            closure?: GirUnparsedNumber /** integer */
-            /** the parameter is a destroy_data for callbacks. The value points to a different parameter that is the actual callback */
-            destroy?: GirUnparsedNumber /** integer */
-            /** the parameter is a callback, the value indicates the lifetime of the call. For language bindings which want to know when the resources required to do the call can be freed. "notified" valid until a GDestroyNotify argument is called, "async" only valid for the duration of the first callback invocation (can only be called once), "call" only valid for the duration of the call, can be called multiple times during the call.  */
-            scope?: 'notified' | 'async' | 'call'
-            /** direction of the parameter. "in" goes into the callable, "out" for output parameters from the callable (reference in C++, var in Pascal, etc...), "inout" for both (like a pre-allocated structure which will be filled-in by the callable) */
-            direction?: GirDirection
-            /** Binary attribute, true if the caller should allocate the parameter before calling the callable */
-            'caller-allocates'?: GirBoolean
-            /** Binary attribute, true if the parameter is optional */
-            optional?: GirBoolean
-            /**  Binary attribute, true if the parameter can be omitted from the introspected output */
-            skip?: GirBoolean
-        }
-
-    varargs?: GirVarArgs[]
-
-    _tsData?: TsParameter
-}

package/src/types/gir-callable-param.ts

@@ -1,9 +0,0 @@
-import { GirCallableParamElement, GirInstanceParameter } from './index.js'
-
-// Refer to https://wiki.gnome.org/Projects/GObjectIntrospection/Annotations#Support_for_GObject_closures
-export interface GirCallableParams {
-    /** parameters element of a callable, that is in general parameters of a function or similar */
-    parameter: GirCallableParamElement[]
-    /** instance-parameter is a parameter of a C function which is an instance of an existing object. So the callable is surely a method of a class, and this parameter points to the instance of the object. In C++, this would be equivalent to the pointer this which is not passed to the method, in Python it's equivalent to self. */
-    'instance-parameter'?: GirInstanceParameter[]
-}

package/src/types/gir-callable-return.ts

@@ -1,25 +0,0 @@
-import { PartOfClass, GirTransferOwnership, GirDocElement, GirAnyType, GirUnparsedNumber, GirBoolean } from './index.js'
-
-export interface GirCallableReturn extends PartOfClass, GirAnyType, GirDocElement {
-    /** return value of a callable */
-    $: {
-        name?: string
-        /** Binary attribute which is BinaryOption(false) if the element is not introspectable. It doesn't exist in the bindings, due in general to missing information in the annotations in the original C code */
-        introspectable?: GirBoolean
-        /** Binary attribute, true if the parameter can have a null value */
-        nullable?: GirBoolean
-        /** the parameter is a user_data for callbacks. The value points to a different parameter that is the actual callback */
-        closure?: GirUnparsedNumber /** integer */
-        /** the parameter is a callback, the value indicates the lifetime of the call. For language bindings which want to know when the resources required to do the call can be freed. "notified" valid until a GDestroyNotify argument is called, "async" only valid for the duration of the first callback invocationi (can only be called once), "call" only valid for the duration of the call, can be called multiple times during the call.  */
-        scope?: 'notified' | 'async' | 'call'
-        /** the parameter is a destroy_data for callbacks. The value points to a different parameter that is the actual callback */
-        destroy?: GirUnparsedNumber /** integer */
-        /**  Binary attribute, true if the parameter can be omitted from the introspected output */
-        skip?: GirBoolean
-        /** @deprecated Replaced by nullable and optional */
-        'allow-none'?: GirBoolean
-    } & Partial<GirTransferOwnership>
-
-    // CUSTOM
-    girTypeName?: 'callable-return'
-}

package/src/types/gir-callback-element.ts

@@ -1,28 +0,0 @@
-import {
-    GirBoolean,
-    GirInfoElements,
-    GirInfoAttrs,
-    GirCallableParams,
-    GirCallableReturn,
-    PartOfModule,
-    TsCallback,
-} from './index.js'
-
-export interface GirCallbackElement extends PartOfModule, GirInfoElements {
-    /** A callback closure, that is a function called when a signal is emitted (as an answer to that signal) */
-    $: GirInfoAttrs & {
-        /** name of the callback */
-        name: string
-        /** the C type returned by the callback closure (i.e. function) */
-        'c:type'?: string
-        /** Binary attribute, true if the callback can throw an error */
-        throws?: GirBoolean
-    }
-
-    /* Other elements a property can contain */
-
-    parameters?: [GirCallableParams]
-    'return-value'?: GirCallableReturn[]
-
-    _tsData?: TsCallback
-}

package/src/types/gir-class-element.ts

@@ -1,71 +0,0 @@
-import type {
-    GirBoolean,
-    GirInfoElements,
-    GirInfoAttrs,
-    PartOfModule,
-    GirConstructorElement,
-    GirImplements,
-    GirMethodElement,
-    GirFunctionElement,
-    GirVirtualMethodElement,
-    GirFieldElement,
-    GirPropertyElement,
-    GirSignalElement,
-    GirUnionElement,
-    GirConstantElement,
-    GirRecordElement,
-    GirCallbackElement,
-    TsClass,
-} from './index.js'
-
-export interface GirClassElement extends PartOfModule, GirInfoElements {
-    /** GObject inherited class definition */
-    $: GirInfoAttrs & {
-        /** Name of the class */
-        name: string
-        /** GObject compatible type name of the class */
-        'glib:type-name': string
-        /** Function to get the GObject compatible type of the class */
-        'glib:get-type': string
-        /** Name of the parent class if any */
-        parent?: string
-        /** GObject compatible C structure defining the class */
-        'glib:type-struct'?: string
-        /** GObject compatible function to reference or increase the reference count of the class */
-        'glib:ref-func'?: string
-        /** GObject compatible function to unreference or decrease the reference count of the class */
-        'glib:unref-func'?: string
-        /** GObject compatible function to set a value of a property of the class */
-        'glib:set-value-func'?: string
-        /** GObject compatible function to get a value of a property of the class */
-        'glib:get-value-func'?: string
-        /** C type of the class */
-        'c:type'?: string
-        /** prefix to filter out from C functions. For example, gtk_window_new will lose gtk_ */
-        'c:symbol-prefix'?: string
-        /** Binary attribute to declare the class abstract or not */
-        abstract?: GirBoolean
-        /** Binary attribute to declare the class fundamental or not (top-level class which do not derives from any other type) */
-        'glib:fundamental'?: GirBoolean
-        /** Binary attribute to declare the class final or not (non-derivable class in a derivable hierarchy) */
-        final: GirBoolean
-    }
-
-    /* Other elements a class can contain */
-
-    implements?: GirImplements[]
-    constructor?: GirConstructorElement[]
-    method?: GirMethodElement[]
-    function?: GirFunctionElement[]
-    'virtual-method'?: GirVirtualMethodElement[]
-    field?: GirFieldElement[]
-    property?: GirPropertyElement[]
-    signal?: GirSignalElement[]
-    'glib:signal'?: GirSignalElement[]
-    union?: GirUnionElement[]
-    constant?: GirConstantElement[]
-    record?: GirRecordElement[]
-    callback?: GirCallbackElement[]
-
-    _tsData?: TsClass
-}

package/src/types/gir-constant-element.ts

@@ -1,17 +0,0 @@
-import type { GirInfoElements, GirAnyType, GirInfoAttrs, PartOfModule, TsVar } from './index.js'
-
-export interface GirConstantElement extends PartOfModule, GirInfoElements, GirAnyType {
-    /** A constant entity, similar to const variable in C */
-    $: GirInfoAttrs & {
-        /** name of the constant */
-        name: string
-        /** value of the constant */
-        value: string
-        /** corresponding C type of the constant in C */
-        'c:type'?: string
-        /** corresponding C identifier in the source code */
-        'c:identifier'?: string
-    }
-
-    _tsData?: TsVar
-}

package/src/types/gir-constructor-element.ts

@@ -1,18 +0,0 @@
-import {
-    GirInfoAttrs,
-    GirCallableAttrs,
-    GirCallableParams,
-    GirCallableReturn,
-    PartOfClass,
-    TsFunction,
-} from './index.js'
-
-export interface GirConstructorElement extends PartOfClass {
-    /** A constructor of a class */
-    $: GirInfoAttrs & GirCallableAttrs
-
-    parameters?: [GirCallableParams]
-    'return-value'?: GirCallableReturn[]
-
-    _tsData?: TsFunction
-}

package/src/types/gir-direction.ts

@@ -1,5 +0,0 @@
-export enum GirDirection {
-    In = 'in',
-    Inout = 'inout',
-    Out = 'out',
-}

package/src/types/gir-doc-element.ts

@@ -1,73 +0,0 @@
-// Documentation of elements
-// See https://gitlab.gnome.org/ewlsh/gi.ts/-/blob/master/packages/parser/src/xml.ts
-export interface GirDocElement {
-    /** Version of the documentation */
-    'doc-version'?: [
-        {
-            $: {
-                /** Preserve the original formatting of the documentation from the source code */
-                'xml:space'?: 'preserve'
-                /** Preserve the original formatting of the documentation from the source code. Recommended to use this instead of xml:space */
-                'xml:whitespace'?: 'preserve'
-            }
-            /** the text of the version of the documentation */
-            _: string
-        },
-    ]
-    /** give the stability of the documentation */
-    'doc-stability'?: [
-        {
-            $: {
-                /** Preserve the original formatting of the documentation from the source code */
-                'xml:space'?: 'preserve'
-                /** Preserve the original formatting of the documentation from the source code. Recommended to use this instead of xml:space */
-                'xml:whitespace'?: 'preserve'
-                /** a text value about the stability of the documentation. Usually a simple description like stable or unstable */
-            }
-            _: string
-        },
-    ]
-    /** documentation of an element */
-    doc: [
-        {
-            $: {
-                /** Preserve the original formatting of the documentation from the source code */
-                'xml:space'?: 'preserve'
-                /** Keep the whitespace as they were in the source code */
-                'xml:whitespace'?: 'preserve'
-                /** The file containing this documentation */
-                filename: string
-                /** The first line of the documentation in the source code */
-                line: string
-                /** The first column of the documentation in the source code */
-                column: string
-                /** the text of the documentation */
-            }
-            _: string
-        },
-    ]
-    /** Deprecated documentation of an element. Kept for historical reasons in general */
-    'doc-deprecated': [
-        {
-            $: {
-                /** Preserve the original formatting of the documentation from the source code */
-                'xml:space'?: 'preserve'
-                /** Keep the whitespace as they were in the source code */
-                'xml:whitespace'?: 'preserve'
-                /** the text of the deprecated documentation */
-            }
-            _: string
-        },
-    ]
-    /** Position of the documentation in the original source code */
-    'source-position': [
-        {
-            /** File name of the source of the documentation */
-            filename: string
-            /** The first line of the documentation in the source code */
-            line: string
-            /** The first column of the documentation in the source code */
-            column: string[]
-        },
-    ]
-}