diff --git a/.appveyor.yml b/.appveyor.yml
deleted file mode 100644
index f0dab1d..0000000
--- a/.appveyor.yml
+++ /dev/null
@@ -1,14 +0,0 @@
-version: 1.0.{build}
-platform:
- - x86
-
-environment:
- FORK_USER: ocaml
- FORK_BRANCH: master
- CYG_ROOT: C:\cygwin64
-
-install:
- - ps: iex ((new-object net.webclient).DownloadString("https://raw.githubusercontent.com/$env:FORK_USER/ocaml-ci-scripts/$env:FORK_BRANCH/appveyor-install.ps1"))
-
-build_script:
- - call %CYG_ROOT%\bin\bash.exe -l %APPVEYOR_BUILD_FOLDER%\appveyor-opam.sh
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
new file mode 100644
index 0000000..7c12eaf
--- /dev/null
+++ b/.github/workflows/main.yml
@@ -0,0 +1,38 @@
+name: Main workflow
+
+on:
+ pull_request:
+ push:
+ schedule:
+ # Prime the caches every Monday
+ - cron: 0 1 * * MON
+
+jobs:
+ build:
+ strategy:
+ fail-fast: false
+ matrix:
+ os:
+ - macos-latest
+ - ubuntu-latest
+ - windows-latest
+ ocaml-compiler:
+ - 4.14
+ - 5
+
+ runs-on: ${{ matrix.os }}
+
+ steps:
+ - name: Checkout code
+ uses: actions/checkout@v4
+
+ - name: Use OCaml ${{ matrix.ocaml-compiler }}
+ uses: ocaml/setup-ocaml@v3
+ with:
+ ocaml-compiler: ${{ matrix.ocaml-compiler }}
+
+ - run: opam install . --deps-only --with-test
+
+ - run: opam exec -- dune build
+
+ - run: opam exec -- dune runtest
diff --git a/.gitignore b/.gitignore
index f08664d..fd80b30 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,3 +1,4 @@
_build
+_opam
*.install
-.merlin
\ No newline at end of file
+.merlin
diff --git a/.ocamlformat b/.ocamlformat
new file mode 100644
index 0000000..8a3b53e
--- /dev/null
+++ b/.ocamlformat
@@ -0,0 +1 @@
+version = 0.26.2
diff --git a/.travis.yml b/.travis.yml
deleted file mode 100644
index d1e7c73..0000000
--- a/.travis.yml
+++ /dev/null
@@ -1,74 +0,0 @@
-language: c
-dist: trusty
-
-sudo: required
-
-services:
- - docker
-
-matrix:
- include:
- - os: osx
- env: OCAML_VERSION=4.05
- - os: osx
- env: OCAML_VERSION=4.06
- - os: osx
- env: OCAML_VERSION=4.07
- - os: osx
- env: OCAML_VERSION=4.08
- - os: osx
- env: OCAML_VERSION=4.09
- - os: linux
- env: TYPE=ubuntu-lts OCAML_VERSION=4.05
- - os: linux
- env: TYPE=ubuntu-lts OCAML_VERSION=4.06
- - os: linux
- env: TYPE=ubuntu-lts OCAML_VERSION=4.07
- - os: linux
- env: TYPE=ubuntu-lts OCAML_VERSION=4.08
- - os: linux
- env: TYPE=ubuntu-lts OCAML_VERSION=4.09
- - os: linux
- env: TYPE=ubuntu OCAML_VERSION=4.05
- - os: linux
- env: TYPE=ubuntu OCAML_VERSION=4.06
- - os: linux
- env: TYPE=ubuntu OCAML_VERSION=4.07
- - os: linux
- env: TYPE=ubuntu OCAML_VERSION=4.08
- - os: linux
- env: TYPE=ubuntu OCAML_VERSION=4.09
- - os: linux
- env: TYPE=debian-stable OCAML_VERSION=4.05
- - os: linux
- env: TYPE=debian-stable OCAML_VERSION=4.06
- - os: linux
- env: TYPE=debian-stable OCAML_VERSION=4.07
- - os: linux
- env: TYPE=debian-stable OCAML_VERSION=4.08
- - os: linux
- env: TYPE=debian-stable OCAML_VERSION=4.09
- - os: linux
- env: TYPE=centos OCAML_VERSION=4.05
- - os: linux
- env: TYPE=centos OCAML_VERSION=4.06
- - os: linux
- env: TYPE=centos OCAML_VERSION=4.07
- - os: linux
- env: TYPE=fedora OCAML_VERSION=4.05
- - os: linux
- env: TYPE=fedora OCAML_VERSION=4.06
- - os: linux
- env: TYPE=fedora OCAML_VERSION=4.07
- - os: linux
- env: TYPE=fedora OCAML_VERSION=4.08
- - os: linux
- env: TYPE=fedora OCAML_VERSION=4.09
- allow_failures:
- - os: osx
-
-install:
- - source ./travis/install-deps
-
-script:
- - bash ./travis/run-tests
diff --git a/README.md b/README.md
index 2b935e9..06f3d8e 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,5 @@
-[](https://travis-ci.org/cedlemo/OCaml-GObject-Introspection)
-[](https://www.gnu.org/licenses/gpl-3.0)
-
+[](https://github.com/cedlemo/OCaml-GObject-Introspection/actions)
+[](https://www.gnu.org/licenses/gpl-3.0)
# gobject-introspection OCaml package
@@ -8,35 +7,35 @@ The OCaml bindings to the [GObject-Introspection](https://gi.readthedocs.io/en/l
## Installation
-the package gobject-introspection is now published and available in the opam-repository:
+The package gobject-introspection is now published and available in the opam-repository:
```
opam install gobject-introspection
```
-## API:
+## API
-https://cedlemo.github.io/OCaml-GObject-Introspection/
+
## Usage
Two ideas to explore:
- Create a generic Ctypes bindings generator, based on ocaml-gobject-introspection,
- for the GNOME libraries : https://github.com/cedlemo/OCaml-GI-ctypes-bindings-generator
+ for the GNOME libraries: .
- Create a generic FFI bindings generator for bucklescript in order to be able to
use the javascript bindings to the GNOME libraries. (I am not sure if it is
- faisable).
+ feasible).
- - https://devdocs.baznga.org/
- - https://bucklescript.github.io/bucklescript/Manual.html#_ffi
- - https://github.com/glennsl/bucklescript-ffi-cheatsheet
- - https://github.com/Place1/node-gir
+ -
+ -
+ -
+ -
-## Wiki :
+## Manual
-https://github.com/cedlemo/OCaml-GObject-Introspection/wiki#introduction
+
### table of content.
@@ -48,4 +47,3 @@ https://github.com/cedlemo/OCaml-GObject-Introspection/wiki#introduction
- [Finished](https://github.com/cedlemo/OCaml-GObject-Introspection/wiki/#finished)
- [Remains](https://github.com/cedlemo/OCaml-GObject-Introspection/wiki/#remains)
- [Resources](https://github.com/cedlemo/OCaml-GObject-Introspection/wiki/#resources)
-
diff --git a/bindings/Arg_info.ml b/bindings/Arg_info.ml
index cae64f7..18ab0f5 100644
--- a/bindings/Arg_info.ml
+++ b/bindings/Arg_info.ml
@@ -18,9 +18,9 @@
(** The direction of a Arg_info. *)
type direction =
- | In (** in argument. *)
- | Out (** out argument. *)
- | InOut (** in and out argument. *)
+ | In (** in argument. *)
+ | Out (** out argument. *)
+ | InOut (** in and out argument. *)
let string_of_direction = function
| In -> "In"
@@ -35,23 +35,25 @@ let string_of_direction = function
complete. In case of a containing type such as a list, an array or a hash
table the container itself is specified differently from the items within
the container itself. Each container is freed differently, check the
- documentation for the types themselves for information on how to free them.*)
+ documentation for the types themselves for information on how to free them. *)
type transfer =
- | Nothing (** transfer nothing from the callee (function or the type
- instance the property belongs to) to the caller. The callee
- retains the ownership of the transfer and the caller doesn't
- need to do anything to free up the resources of this transfer. *)
- | Container (** transfer the container (list, array, hash table) from the
- callee to the caller. The callee retains the ownership of
- the individual items in the container and the caller has to
- free up the container resources (g_list_free()/
- g_hash_table_destroy() etc) of this transfer. *)
- | Everything (** transfer everything, eg the container and its contents from
- the callee to the caller. This is the case when the callee
- creates a copy of all the data it returns. The caller is
- responsible for cleaning up the container and item resources
- of this transfer. *)
+ | Nothing
+ (** transfer nothing from the callee (function or the type instance
+ the property belongs to) to the caller. The callee retains the
+ ownership of the transfer and the caller doesn't need to do
+ anything to free up the resources of this transfer. *)
+ | Container
+ (** transfer the container (list, array, hash table) from the callee
+ to the caller. The callee retains the ownership of the individual
+ items in the container and the caller has to free up the
+ container resources (g_list_free()/ g_hash_table_destroy() etc)
+ of this transfer. *)
+ | Everything
+ (** transfer everything, eg the container and its contents from the
+ callee to the caller. This is the case when the callee creates a
+ copy of all the data it returns. The caller is responsible for
+ cleaning up the container and item resources of this transfer. *)
let string_of_transfert = function
| Nothing -> "Nothing"
@@ -62,14 +64,17 @@ let string_of_transfert = function
callback is invoked and is used to decided when the invoke structs can be
freed. *)
type scope_type =
- | Invalid (** The argument is not of callback type. *)
- | Call (** The callback and associated user_data is only used during the
- call to this function. *)
- | Async (** The callback and associated user_data is only used until the
- callback is invoked, and the callback. is invoked always
- exactly once. *)
- | Notified (** The callback and and associated user_data is used until the
- caller is notfied via the destroy_notify. *)
+ | Invalid (** The argument is not of callback type. *)
+ | Call
+ (** The callback and associated user_data is only used during the
+ call to this function. *)
+ | Async
+ (** The callback and associated user_data is only used until the
+ callback is invoked, and the callback. is invoked always exactly
+ once. *)
+ | Notified
+ (** The callback and and associated user_data is used until the
+ caller is notfied via the destroy_notify. *)
let string_of_scope_type = function
| Invalid -> "Invalid"
@@ -77,39 +82,49 @@ let string_of_scope_type = function
| Async -> "Async"
| Notified -> "Notified"
-module Enums = functor (T : Cstubs.Types.TYPE) -> struct
- let gi_direction_in = T.constant "GI_DIRECTION_IN" T.int64_t
- let gi_direction_out = T.constant "GI_DIRECTION_OUT" T.int64_t
- let gi_direction_inout = T.constant "GI_DIRECTION_INOUT" T.int64_t
+module Enums =
+functor
+ (T : Cstubs.Types.TYPE)
+ ->
+ struct
+ let gi_direction_in = T.constant "GI_DIRECTION_IN" T.int64_t
+ let gi_direction_out = T.constant "GI_DIRECTION_OUT" T.int64_t
+ let gi_direction_inout = T.constant "GI_DIRECTION_INOUT" T.int64_t
- let direction = T.enum "GIDirection" ~typedef:true [
- In, gi_direction_in;
- Out, gi_direction_out;
- InOut, gi_direction_inout;
- ]
- ~unexpected:(Utils.unexpected_value_for "GIDirection")
+ let direction =
+ T.enum "GIDirection" ~typedef:true
+ [
+ (In, gi_direction_in);
+ (Out, gi_direction_out);
+ (InOut, gi_direction_inout);
+ ]
+ ~unexpected:(Utils.unexpected_value_for "GIDirection")
- let gi_transfer_nothing = T.constant "GI_TRANSFER_NOTHING" T.int64_t
- let gi_transfer_container = T.constant "GI_TRANSFER_CONTAINER" T.int64_t
- let gi_transfer_everything = T.constant "GI_TRANSFER_EVERYTHING" T.int64_t
+ let gi_transfer_nothing = T.constant "GI_TRANSFER_NOTHING" T.int64_t
+ let gi_transfer_container = T.constant "GI_TRANSFER_CONTAINER" T.int64_t
+ let gi_transfer_everything = T.constant "GI_TRANSFER_EVERYTHING" T.int64_t
- let transfer = T.enum "GITransfer" ~typedef:true [
- Nothing, gi_transfer_nothing;
- Container, gi_transfer_container;
- Everything, gi_transfer_everything;
- ]
- ~unexpected:(Utils.unexpected_value_for "GITransfer")
+ let transfer =
+ T.enum "GITransfer" ~typedef:true
+ [
+ (Nothing, gi_transfer_nothing);
+ (Container, gi_transfer_container);
+ (Everything, gi_transfer_everything);
+ ]
+ ~unexpected:(Utils.unexpected_value_for "GITransfer")
- let gi_scope_type_invalid = T.constant "GI_SCOPE_TYPE_INVALID" T.int64_t
- let gi_scope_type_call = T.constant "GI_SCOPE_TYPE_CALL" T.int64_t
- let gi_scope_type_async = T.constant "GI_SCOPE_TYPE_ASYNC" T.int64_t
- let gi_scope_type_notified = T.constant "GI_SCOPE_TYPE_NOTIFIED" T.int64_t
+ let gi_scope_type_invalid = T.constant "GI_SCOPE_TYPE_INVALID" T.int64_t
+ let gi_scope_type_call = T.constant "GI_SCOPE_TYPE_CALL" T.int64_t
+ let gi_scope_type_async = T.constant "GI_SCOPE_TYPE_ASYNC" T.int64_t
+ let gi_scope_type_notified = T.constant "GI_SCOPE_TYPE_NOTIFIED" T.int64_t
- let scope_type = T.enum "GIScopeType" ~typedef:true [
- Invalid, gi_scope_type_invalid;
- Call, gi_scope_type_call;
- Async, gi_scope_type_async;
- Notified, gi_scope_type_notified;
- ]
- ~unexpected:(Utils.unexpected_value_for "GIScopeType")
-end
+ let scope_type =
+ T.enum "GIScopeType" ~typedef:true
+ [
+ (Invalid, gi_scope_type_invalid);
+ (Call, gi_scope_type_call);
+ (Async, gi_scope_type_async);
+ (Notified, gi_scope_type_notified);
+ ]
+ ~unexpected:(Utils.unexpected_value_for "GIScopeType")
+ end
diff --git a/bindings/Base_info.ml b/bindings/Base_info.ml
index 26bdabb..63133bc 100644
--- a/bindings/Base_info.ml
+++ b/bindings/Base_info.ml
@@ -17,26 +17,27 @@
*)
type info_type =
- | Invalid (** invalid type *)
- | Function (** function, see Function_info *)
- | Callback (** callback, see Function_info *)
- | Struct (** struct, see Struct_info *)
- | Boxed (** boxed, see Struct_info or Union_info *)
- | Enum (** enum, see Enum_info *)
- | Flags (** flags, see Enum_info *)
- | Object (** object, see Object_info *)
- | Interface (** interface, see Interface_info *)
- | Constant (** contant, see Constant_info *)
- | Invalid_0 (** deleted, used to be GI_INFO_TYPE_ERROR_DOMAIN. *)
- | Union (** union, see Union_info *)
- | Value (** enum value, see Value_info *)
- | Signal (** signal, see Signal_info *)
- | Vfunc (** virtual function, see VFunc_info *)
- | Property (** GObject property, see Property_info *)
- | Field (** struct or union field, see Field_info *)
- | Arg (** argument of a function or callback, see Arg_info *)
- | Type (** type information, see Type_info *)
- | Unresolved (** unresolved type, a type which is not present in the typelib, or any of its dependencies. *)
+ | Invalid (** invalid type *)
+ | Function (** function, see Function_info *)
+ | Callback (** callback, see Function_info *)
+ | Struct (** struct, see Struct_info *)
+ | Boxed (** boxed, see Struct_info or Union_info *)
+ | Enum (** enum, see Enum_info *)
+ | Flags (** flags, see Enum_info *)
+ | Object (** object, see Object_info *)
+ | Interface (** interface, see Interface_info *)
+ | Constant (** contant, see Constant_info *)
+ | Invalid_0 (** deleted, used to be GI_INFO_TYPE_ERROR_DOMAIN. *)
+ | Union (** union, see Union_info *)
+ | Value (** enum value, see Value_info *)
+ | Signal (** signal, see Signal_info *)
+ | Vfunc (** virtual function, see VFunc_info *)
+ | Property (** GObject property, see Property_info *)
+ | Field (** struct or union field, see Field_info *)
+ | Arg (** argument of a function or callback, see Arg_info *)
+ | Type (** type information, see Type_info *)
+ | Unresolved
+ (** unresolved type, a type which is not present in the typelib, or any of its dependencies. *)
let string_of_info_type = function
| Invalid -> "Invalid"
@@ -60,49 +61,55 @@ let string_of_info_type = function
| Type -> "Type"
| Unresolved -> "Unresolved "
-module Enums = functor (T : Cstubs.Types.TYPE) -> struct
- let gi_info_type_invalid = T.constant "GI_INFO_TYPE_INVALID" T.int64_t
- let gi_info_type_function = T.constant "GI_INFO_TYPE_FUNCTION" T.int64_t
- let gi_info_type_callback = T.constant "GI_INFO_TYPE_CALLBACK" T.int64_t
- let gi_info_type_struct = T.constant "GI_INFO_TYPE_STRUCT" T.int64_t
- let gi_info_type_boxed = T.constant "GI_INFO_TYPE_BOXED" T.int64_t
- let gi_info_type_enum = T.constant "GI_INFO_TYPE_ENUM" T.int64_t
- let gi_info_type_flags = T.constant "GI_INFO_TYPE_FLAGS" T.int64_t
- let gi_info_type_object = T.constant "GI_INFO_TYPE_OBJECT" T.int64_t
- let gi_info_type_interface = T.constant "GI_INFO_TYPE_INTERFACE" T.int64_t
- let gi_info_type_constant = T.constant "GI_INFO_TYPE_CONSTANT" T.int64_t
- let gi_info_type_invalid_0 = T.constant "GI_INFO_TYPE_INVALID_0" T.int64_t
- let gi_info_type_union = T.constant "GI_INFO_TYPE_UNION" T.int64_t
- let gi_info_type_value = T.constant "GI_INFO_TYPE_VALUE" T.int64_t
- let gi_info_type_signal = T.constant "GI_INFO_TYPE_SIGNAL" T.int64_t
- let gi_info_type_vfunc = T.constant "GI_INFO_TYPE_VFUNC" T.int64_t
- let gi_info_type_property = T.constant "GI_INFO_TYPE_PROPERTY" T.int64_t
- let gi_info_type_field = T.constant "GI_INFO_TYPE_FIELD" T.int64_t
- let gi_info_type_arg = T.constant "GI_INFO_TYPE_ARG" T.int64_t
- let gi_info_type_type = T.constant "GI_INFO_TYPE_TYPE" T.int64_t
- let gi_info_type_unresolved = T.constant "GI_INFO_TYPE_UNRESOLVED" T.int64_t
+module Enums =
+functor
+ (T : Cstubs.Types.TYPE)
+ ->
+ struct
+ let gi_info_type_invalid = T.constant "GI_INFO_TYPE_INVALID" T.int64_t
+ let gi_info_type_function = T.constant "GI_INFO_TYPE_FUNCTION" T.int64_t
+ let gi_info_type_callback = T.constant "GI_INFO_TYPE_CALLBACK" T.int64_t
+ let gi_info_type_struct = T.constant "GI_INFO_TYPE_STRUCT" T.int64_t
+ let gi_info_type_boxed = T.constant "GI_INFO_TYPE_BOXED" T.int64_t
+ let gi_info_type_enum = T.constant "GI_INFO_TYPE_ENUM" T.int64_t
+ let gi_info_type_flags = T.constant "GI_INFO_TYPE_FLAGS" T.int64_t
+ let gi_info_type_object = T.constant "GI_INFO_TYPE_OBJECT" T.int64_t
+ let gi_info_type_interface = T.constant "GI_INFO_TYPE_INTERFACE" T.int64_t
+ let gi_info_type_constant = T.constant "GI_INFO_TYPE_CONSTANT" T.int64_t
+ let gi_info_type_invalid_0 = T.constant "GI_INFO_TYPE_INVALID_0" T.int64_t
+ let gi_info_type_union = T.constant "GI_INFO_TYPE_UNION" T.int64_t
+ let gi_info_type_value = T.constant "GI_INFO_TYPE_VALUE" T.int64_t
+ let gi_info_type_signal = T.constant "GI_INFO_TYPE_SIGNAL" T.int64_t
+ let gi_info_type_vfunc = T.constant "GI_INFO_TYPE_VFUNC" T.int64_t
+ let gi_info_type_property = T.constant "GI_INFO_TYPE_PROPERTY" T.int64_t
+ let gi_info_type_field = T.constant "GI_INFO_TYPE_FIELD" T.int64_t
+ let gi_info_type_arg = T.constant "GI_INFO_TYPE_ARG" T.int64_t
+ let gi_info_type_type = T.constant "GI_INFO_TYPE_TYPE" T.int64_t
+ let gi_info_type_unresolved = T.constant "GI_INFO_TYPE_UNRESOLVED" T.int64_t
- let info_type = T.enum "GIInfoType" ~typedef:true [
- Invalid, gi_info_type_invalid;
- Function, gi_info_type_function;
- Callback, gi_info_type_callback;
- Struct, gi_info_type_struct;
- Boxed, gi_info_type_boxed;
- Enum, gi_info_type_enum;
- Flags, gi_info_type_flags;
- Object, gi_info_type_object;
- Interface, gi_info_type_interface;
- Constant, gi_info_type_constant;
- Invalid_0, gi_info_type_invalid_0;
- Union, gi_info_type_union;
- Value, gi_info_type_value;
- Signal, gi_info_type_signal;
- Vfunc, gi_info_type_vfunc;
- Property, gi_info_type_property;
- Field, gi_info_type_field;
- Arg, gi_info_type_arg;
- Type, gi_info_type_type;
- Unresolved, gi_info_type_unresolved;
- ]
- ~unexpected:(Utils.unexpected_value_for "GIInfoType")
-end
+ let info_type =
+ T.enum "GIInfoType" ~typedef:true
+ [
+ (Invalid, gi_info_type_invalid);
+ (Function, gi_info_type_function);
+ (Callback, gi_info_type_callback);
+ (Struct, gi_info_type_struct);
+ (Boxed, gi_info_type_boxed);
+ (Enum, gi_info_type_enum);
+ (Flags, gi_info_type_flags);
+ (Object, gi_info_type_object);
+ (Interface, gi_info_type_interface);
+ (Constant, gi_info_type_constant);
+ (Invalid_0, gi_info_type_invalid_0);
+ (Union, gi_info_type_union);
+ (Value, gi_info_type_value);
+ (Signal, gi_info_type_signal);
+ (Vfunc, gi_info_type_vfunc);
+ (Property, gi_info_type_property);
+ (Field, gi_info_type_field);
+ (Arg, gi_info_type_arg);
+ (Type, gi_info_type_type);
+ (Unresolved, gi_info_type_unresolved);
+ ]
+ ~unexpected:(Utils.unexpected_value_for "GIInfoType")
+ end
diff --git a/bindings/Field_info.ml b/bindings/Field_info.ml
index a543065..27dd81d 100644
--- a/bindings/Field_info.ml
+++ b/bindings/Field_info.ml
@@ -18,16 +18,21 @@
(** Flags for a Field_info. *)
type flags =
- | Is_readable (** field is readable. *)
- | Is_writable (** field is writable. *)
+ | Is_readable (** field is readable. *)
+ | Is_writable (** field is writable. *)
let string_of_flag = function
| Is_readable -> "Is_readable"
| Is_writable -> "Is_writable"
-module Flags = functor (T : Cstubs.Types.TYPE) -> struct
- let gi_field_is_readable = T.constant "GI_FIELD_IS_READABLE" T.int64_t
- let gi_field_is_writable = T.constant "GI_FIELD_IS_WRITABLE" T.int64_t
+module Flags =
+functor
+ (T : Cstubs.Types.TYPE)
+ ->
+ struct
+ let gi_field_is_readable = T.constant "GI_FIELD_IS_READABLE" T.int64_t
+ let gi_field_is_writable = T.constant "GI_FIELD_IS_WRITABLE" T.int64_t
- let flags = T.enum "GIFieldInfoFlags" ~typedef:true [] ~unexpected:(fun x -> x)
-end
+ let flags =
+ T.enum "GIFieldInfoFlags" ~typedef:true [] ~unexpected:(fun x -> x)
+ end
diff --git a/bindings/Function_info.ml b/bindings/Function_info.ml
index 13048a0..de2281f 100644
--- a/bindings/Function_info.ml
+++ b/bindings/Function_info.ml
@@ -18,12 +18,12 @@
(** Flags for a Function_info struct. *)
type flags =
- | Is_method (** is a method. *)
- | Is_constructor (** is a constructor. *)
- | Is_getter (** is a getter of a Property_info. *)
- | Is_setter (** is a setter of a Property_info. *)
- | Wraps_vfunc (** represents a virtual function. *)
- | Throws (** the function may throw an error. *)
+ | Is_method (** is a method. *)
+ | Is_constructor (** is a constructor. *)
+ | Is_getter (** is a getter of a Property_info. *)
+ | Is_setter (** is a setter of a Property_info. *)
+ | Wraps_vfunc (** represents a virtual function. *)
+ | Throws (** the function may throw an error. *)
let string_of_flag = function
| Is_method -> "Is_method"
@@ -33,12 +33,21 @@ let string_of_flag = function
| Wraps_vfunc -> "Wraps_vfunc"
| Throws -> "Throws"
-module Flags = functor (T : Cstubs.Types.TYPE) -> struct
- let gi_function_is_method = T.constant "GI_FUNCTION_IS_METHOD" T.int64_t
- let gi_function_is_constructor = T.constant "GI_FUNCTION_IS_CONSTRUCTOR" T.int64_t
- let gi_function_is_getter = T.constant "GI_FUNCTION_IS_GETTER" T.int64_t
- let gi_function_is_setter = T.constant "GI_FUNCTION_IS_SETTER" T.int64_t
- let gi_function_wraps_vfunc = T.constant "GI_FUNCTION_WRAPS_VFUNC" T.int64_t
- let gi_function_throws = T.constant "GI_FUNCTION_THROWS" T.int64_t
- let flags = T.enum "GIFunctionInfoFlags" ~typedef:true [] ~unexpected:(fun x -> x)
-end
+module Flags =
+functor
+ (T : Cstubs.Types.TYPE)
+ ->
+ struct
+ let gi_function_is_method = T.constant "GI_FUNCTION_IS_METHOD" T.int64_t
+
+ let gi_function_is_constructor =
+ T.constant "GI_FUNCTION_IS_CONSTRUCTOR" T.int64_t
+
+ let gi_function_is_getter = T.constant "GI_FUNCTION_IS_GETTER" T.int64_t
+ let gi_function_is_setter = T.constant "GI_FUNCTION_IS_SETTER" T.int64_t
+ let gi_function_wraps_vfunc = T.constant "GI_FUNCTION_WRAPS_VFUNC" T.int64_t
+ let gi_function_throws = T.constant "GI_FUNCTION_THROWS" T.int64_t
+
+ let flags =
+ T.enum "GIFunctionInfoFlags" ~typedef:true [] ~unexpected:(fun x -> x)
+ end
diff --git a/bindings/GParam.ml b/bindings/GParam.ml
index 4ae9af0..a2ba27c 100644
--- a/bindings/GParam.ml
+++ b/bindings/GParam.ml
@@ -21,31 +21,36 @@
* Through the GParamFlags flag values, certain aspects of parameters can be
* configured. *)
type flags =
- | Readable (** the parameter is readable *)
- | Writable (** the parameter is writable *)
- | Readwrite (** alias for G_PARAM_READABLE | G_PARAM_WRITABLE *)
- | Construct (** the parameter will be set upon object construction *)
- | Construct_only (** the parameter can only be set upon object construction *)
- | Lax_validation (** upon parameter conversion (see g_param_value_convert())
- strict validation is not required *)
- | Static_name (** the string used as name when constructing the parameter
- is guaranteed to remain valid and unmodified for the
- lifetime of the parameter. Since 2.8 *)
- | Static_nick (** the string used as nick when constructing the parameter
- is guaranteed to remain valid and unmmodified for the
- lifetime of the parameter. Since 2.8 *)
- | Static_blurb (** the string used as blurb when constructing the parameter
- is guaranteed to remain valid and unmodified for the
- lifetime of the parameter. Since 2.8 *)
- | Explicit_notify (** calls to g_object_set_property() for this property will
- not automatically result in a "notify" signal being
- emitted: the implementation must call g_object_notify()
- themselves in case the property actually changes.
- Since: 2.42. *)
- | Deprecated (** the parameter is deprecated and will be removed in a
- future version. A warning will be generated if it is
- used while running with G_ENABLE_DIAGNOSTIC=1.
- Since 2.26 *)
+ | Readable (** the parameter is readable *)
+ | Writable (** the parameter is writable *)
+ | Readwrite (** alias for G_PARAM_READABLE | G_PARAM_WRITABLE *)
+ | Construct (** the parameter will be set upon object construction *)
+ | Construct_only
+ (** the parameter can only be set upon object construction *)
+ | Lax_validation
+ (** upon parameter conversion (see g_param_value_convert()) strict
+ validation is not required *)
+ | Static_name
+ (** the string used as name when constructing the parameter is
+ guaranteed to remain valid and unmodified for the lifetime of the
+ parameter. Since 2.8 *)
+ | Static_nick
+ (** the string used as nick when constructing the parameter is
+ guaranteed to remain valid and unmmodified for the lifetime of
+ the parameter. Since 2.8 *)
+ | Static_blurb
+ (** the string used as blurb when constructing the parameter is
+ guaranteed to remain valid and unmodified for the lifetime of the
+ parameter. Since 2.8 *)
+ | Explicit_notify
+ (** calls to g_object_set_property() for this property will not
+ automatically result in a "notify" signal being emitted: the
+ implementation must call g_object_notify() themselves in case the
+ property actually changes. Since: 2.42. *)
+ | Deprecated
+ (** the parameter is deprecated and will be removed in a future
+ version. A warning will be generated if it is used while running
+ with G_ENABLE_DIAGNOSTIC=1. Since 2.26 *)
let string_of_flag = function
| Readable -> "Readable"
@@ -60,17 +65,21 @@ let string_of_flag = function
| Explicit_notify -> "Explicit_notify"
| Deprecated -> "Deprecated"
-module Flags = functor (T : Cstubs.Types.TYPE) -> struct
- let g_param_readable = T.constant "G_PARAM_READABLE" T.int64_t
- let g_param_writable = T.constant "G_PARAM_WRITABLE" T.int64_t
- let g_param_readwrite = T.constant "G_PARAM_READWRITE" T.int64_t
- let g_param_construct = T.constant "G_PARAM_CONSTRUCT" T.int64_t
- let g_param_construct_only = T.constant "G_PARAM_CONSTRUCT_ONLY" T.int64_t
- let g_param_lax_validation = T.constant "G_PARAM_LAX_VALIDATION" T.int64_t
- let g_param_static_name = T.constant "G_PARAM_STATIC_NAME" T.int64_t
- let g_param_static_nick = T.constant "G_PARAM_STATIC_NICK" T.int64_t
- let g_param_static_blurb = T.constant "G_PARAM_STATIC_BLURB" T.int64_t
- let g_param_explicit_notify = T.constant "G_PARAM_EXPLICIT_NOTIFY" T.int64_t
- let g_param_deprecated = T.constant "G_PARAM_DEPRECATED" T.int64_t
- let flags = T.enum "GParamFlags" ~typedef:true [] ~unexpected:(fun x -> x)
-end
+module Flags =
+functor
+ (T : Cstubs.Types.TYPE)
+ ->
+ struct
+ let g_param_readable = T.constant "G_PARAM_READABLE" T.int64_t
+ let g_param_writable = T.constant "G_PARAM_WRITABLE" T.int64_t
+ let g_param_readwrite = T.constant "G_PARAM_READWRITE" T.int64_t
+ let g_param_construct = T.constant "G_PARAM_CONSTRUCT" T.int64_t
+ let g_param_construct_only = T.constant "G_PARAM_CONSTRUCT_ONLY" T.int64_t
+ let g_param_lax_validation = T.constant "G_PARAM_LAX_VALIDATION" T.int64_t
+ let g_param_static_name = T.constant "G_PARAM_STATIC_NAME" T.int64_t
+ let g_param_static_nick = T.constant "G_PARAM_STATIC_NICK" T.int64_t
+ let g_param_static_blurb = T.constant "G_PARAM_STATIC_BLURB" T.int64_t
+ let g_param_explicit_notify = T.constant "G_PARAM_EXPLICIT_NOTIFY" T.int64_t
+ let g_param_deprecated = T.constant "G_PARAM_DEPRECATED" T.int64_t
+ let flags = T.enum "GParamFlags" ~typedef:true [] ~unexpected:(fun x -> x)
+ end
diff --git a/bindings/GSignal.ml b/bindings/GSignal.ml
index 7e50c92..a057e88 100644
--- a/bindings/GSignal.ml
+++ b/bindings/GSignal.ml
@@ -21,33 +21,34 @@
signal description outlines how especially the RUN flags control the stages
of a signal emission. *)
type flags =
- | Run_first (** Invoke the object method handler in the first
- emission stage. *)
- | Run_last (** Invoke the object method handler in the third
- emission stage. *)
- | Run_cleanup (** Invoke the object method handler in the last
- emission stage. *)
- | No_recurse (** Signals being emitted for an object while currently
- being in emission for this very object will not be
- emitted recursively, but instead cause the first
- emission to be restarted. *)
- | Detailed (** This signal supports "::detail" appendices to the
- signal name upon handler connections and emissions. *)
- | Action (** Action signals are signals that may freely be
- emitted on alive objects from user code via
- g_signal_emit() and friends, without the need of
- being embedded into extra code that performs pre or
- post emission adjustments on the object. They can
- also be thought of as object methods which can be
- called generically by third-party code. *)
- | No_hooks (** No emissions hooks are supported for this signal. *)
- | Must_collect (** Varargs signal emission will always collect the
- arguments, even if there are no signal handlers
- connected. Since 2.30. *)
- | Deprecated (** The signal is deprecated and will be removed in a
- future version. A warning will be generated if it is
- connected while running with G_ENABLE_DIAGNOSTIC=1.
- Since 2.32. *)
+ | Run_first
+ (** Invoke the object method handler in the first emission stage. *)
+ | Run_last
+ (** Invoke the object method handler in the third emission stage. *)
+ | Run_cleanup
+ (** Invoke the object method handler in the last emission stage. *)
+ | No_recurse
+ (** Signals being emitted for an object while currently being in
+ emission for this very object will not be emitted recursively,
+ but instead cause the first emission to be restarted. *)
+ | Detailed
+ (** This signal supports "::detail" appendices to the signal name
+ upon handler connections and emissions. *)
+ | Action
+ (** Action signals are signals that may freely be emitted on alive
+ objects from user code via g_signal_emit() and friends, without
+ the need of being embedded into extra code that performs pre or
+ post emission adjustments on the object. They can also be thought
+ of as object methods which can be called generically by
+ third-party code. *)
+ | No_hooks (** No emissions hooks are supported for this signal. *)
+ | Must_collect
+ (** Varargs signal emission will always collect the arguments, even
+ if there are no signal handlers connected. Since 2.30. *)
+ | Deprecated
+ (** The signal is deprecated and will be removed in a future
+ version. A warning will be generated if it is connected while
+ running with G_ENABLE_DIAGNOSTIC=1. Since 2.32. *)
let string_of_flag = function
| Run_first -> "Run_first"
@@ -60,15 +61,19 @@ let string_of_flag = function
| Must_collect -> "Must_collect"
| Deprecated -> "Deprecated"
-module Flags = functor (T : Cstubs.Types.TYPE) -> struct
- let g_signal_run_first = T.constant "G_SIGNAL_RUN_FIRST" T.int64_t
- let g_signal_run_last = T.constant "G_SIGNAL_RUN_LAST" T.int64_t
- let g_signal_run_cleanup = T.constant "G_SIGNAL_RUN_CLEANUP" T.int64_t
- let g_signal_no_recurse = T.constant "G_SIGNAL_NO_RECURSE" T.int64_t
- let g_signal_detailed = T.constant "G_SIGNAL_DETAILED" T.int64_t
- let g_signal_action = T.constant "G_SIGNAL_ACTION" T.int64_t
- let g_signal_no_hooks = T.constant "G_SIGNAL_NO_HOOKS" T.int64_t
- let g_signal_must_collect = T.constant "G_SIGNAL_MUST_COLLECT" T.int64_t
- let g_signal_deprecated = T.constant "G_SIGNAL_DEPRECATED" T.int64_t
- let flags = T.enum "GSignalFlags" ~typedef:true [] ~unexpected:(fun x -> x)
-end
+module Flags =
+functor
+ (T : Cstubs.Types.TYPE)
+ ->
+ struct
+ let g_signal_run_first = T.constant "G_SIGNAL_RUN_FIRST" T.int64_t
+ let g_signal_run_last = T.constant "G_SIGNAL_RUN_LAST" T.int64_t
+ let g_signal_run_cleanup = T.constant "G_SIGNAL_RUN_CLEANUP" T.int64_t
+ let g_signal_no_recurse = T.constant "G_SIGNAL_NO_RECURSE" T.int64_t
+ let g_signal_detailed = T.constant "G_SIGNAL_DETAILED" T.int64_t
+ let g_signal_action = T.constant "G_SIGNAL_ACTION" T.int64_t
+ let g_signal_no_hooks = T.constant "G_SIGNAL_NO_HOOKS" T.int64_t
+ let g_signal_must_collect = T.constant "G_SIGNAL_MUST_COLLECT" T.int64_t
+ let g_signal_deprecated = T.constant "G_SIGNAL_DEPRECATED" T.int64_t
+ let flags = T.enum "GSignalFlags" ~typedef:true [] ~unexpected:(fun x -> x)
+ end
diff --git a/bindings/Types.ml b/bindings/Types.ml
index 6f6ad8b..83fbeaa 100644
--- a/bindings/Types.ml
+++ b/bindings/Types.ml
@@ -18,10 +18,10 @@
(** The type of array in a GITypeInfo. *)
type array_type =
- | C (** a C array, char[] for instance *)
- | Array (** a GArray array *)
+ | C (** a C array, char[] for instance *)
+ | Array (** a GArray array *)
| Ptr_array (** a GPtrArray array *)
- | Byte_array (** a GByteArray array *)
+ | Byte_array (** a GByteArray array *)
let string_of_array_type = function
| C -> "C"
@@ -31,28 +31,29 @@ let string_of_array_type = function
(** The type tag of a Type_info. *)
type tag =
- | Void (** void *)
- | Boolean (** boolean *)
- | Int8 (** 8-bit signed integer *)
- | Uint8 (** 8-bit unsigned integer *)
- | Int16 (** 16-bit signed integer *)
- | Uint16 (** 16-bit unsigned integer *)
- | Int32 (** 32-bit signed integer *)
- | Uint32 (** 32-bit unsigned integer *)
- | Int64 (** 64-bit signed integer *)
- | Uint64 (** 64-bit unsigned integer *)
- | Float (** float *)
- | Double (** double floating point *)
- | GType (** a GType *)
- | Utf8 (** a UTF-8 encoded string *)
- | Filename (** a filename, encoded in the same encoding as the native filesystem is using. *)
- | Array (** an array *)
- | Interface (** an extended interface object *)
- | GList (** a GList *)
- | GSList (** a GSList *)
- | GHash (** a GHashTable *)
- | Error (** a GError *)
- | Unichar (** Unicode character *)
+ | Void (** void *)
+ | Boolean (** boolean *)
+ | Int8 (** 8-bit signed integer *)
+ | Uint8 (** 8-bit unsigned integer *)
+ | Int16 (** 16-bit signed integer *)
+ | Uint16 (** 16-bit unsigned integer *)
+ | Int32 (** 32-bit signed integer *)
+ | Uint32 (** 32-bit unsigned integer *)
+ | Int64 (** 64-bit signed integer *)
+ | Uint64 (** 64-bit unsigned integer *)
+ | Float (** float *)
+ | Double (** double floating point *)
+ | GType (** a GType *)
+ | Utf8 (** a UTF-8 encoded string *)
+ | Filename
+ (** a filename, encoded in the same encoding as the native filesystem is using. *)
+ | Array (** an array *)
+ | Interface (** an extended interface object *)
+ | GList (** a GList *)
+ | GSList (** a GSList *)
+ | GHash (** a GHashTable *)
+ | Error (** a GError *)
+ | Unichar (** Unicode character *)
let string_of_tag = function
| Void -> "Void"
@@ -78,66 +79,76 @@ let string_of_tag = function
| Error -> "Error"
| Unichar -> "Unichar"
-module Enums = functor (T : Cstubs.Types.TYPE) -> struct
- let gi_type_tag_void = T.constant "GI_TYPE_TAG_VOID" T.int64_t
- let gi_type_tag_boolean = T.constant "GI_TYPE_TAG_BOOLEAN" T.int64_t
- let gi_type_tag_int8 = T.constant "GI_TYPE_TAG_INT8" T.int64_t
- let gi_type_tag_uint8 = T.constant "GI_TYPE_TAG_UINT8" T.int64_t
- let gi_type_tag_int16 = T.constant "GI_TYPE_TAG_INT16" T.int64_t
- let gi_type_tag_uint16 = T.constant "GI_TYPE_TAG_UINT16" T.int64_t
- let gi_type_tag_int32 = T.constant "GI_TYPE_TAG_INT32" T.int64_t
- let gi_type_tag_uint32 = T.constant "GI_TYPE_TAG_UINT32" T.int64_t
- let gi_type_tag_int64 = T.constant "GI_TYPE_TAG_INT64" T.int64_t
- let gi_type_tag_uint64 = T.constant "GI_TYPE_TAG_UINT64" T.int64_t
- let gi_type_tag_float = T.constant "GI_TYPE_TAG_FLOAT" T.int64_t
- let gi_type_tag_double = T.constant "GI_TYPE_TAG_DOUBLE" T.int64_t
- let gi_type_tag_gtype = T.constant "GI_TYPE_TAG_GTYPE" T.int64_t
- let gi_type_tag_utf8 = T.constant "GI_TYPE_TAG_UTF8" T.int64_t
- let gi_type_tag_filename = T.constant "GI_TYPE_TAG_FILENAME" T.int64_t
- let gi_type_tag_array = T.constant "GI_TYPE_TAG_ARRAY" T.int64_t
- let gi_type_tag_interface = T.constant "GI_TYPE_TAG_INTERFACE" T.int64_t
- let gi_type_tag_glist = T.constant "GI_TYPE_TAG_GLIST" T.int64_t
- let gi_type_tag_gslist = T.constant "GI_TYPE_TAG_GSLIST" T.int64_t
- let gi_type_tag_ghash = T.constant "GI_TYPE_TAG_GHASH" T.int64_t
- let gi_type_tag_error = T.constant "GI_TYPE_TAG_ERROR" T.int64_t
- let gi_type_tag_unichar = T.constant "GI_TYPE_TAG_UNICHAR" T.int64_t
+module Enums =
+functor
+ (T : Cstubs.Types.TYPE)
+ ->
+ struct
+ let gi_type_tag_void = T.constant "GI_TYPE_TAG_VOID" T.int64_t
+ let gi_type_tag_boolean = T.constant "GI_TYPE_TAG_BOOLEAN" T.int64_t
+ let gi_type_tag_int8 = T.constant "GI_TYPE_TAG_INT8" T.int64_t
+ let gi_type_tag_uint8 = T.constant "GI_TYPE_TAG_UINT8" T.int64_t
+ let gi_type_tag_int16 = T.constant "GI_TYPE_TAG_INT16" T.int64_t
+ let gi_type_tag_uint16 = T.constant "GI_TYPE_TAG_UINT16" T.int64_t
+ let gi_type_tag_int32 = T.constant "GI_TYPE_TAG_INT32" T.int64_t
+ let gi_type_tag_uint32 = T.constant "GI_TYPE_TAG_UINT32" T.int64_t
+ let gi_type_tag_int64 = T.constant "GI_TYPE_TAG_INT64" T.int64_t
+ let gi_type_tag_uint64 = T.constant "GI_TYPE_TAG_UINT64" T.int64_t
+ let gi_type_tag_float = T.constant "GI_TYPE_TAG_FLOAT" T.int64_t
+ let gi_type_tag_double = T.constant "GI_TYPE_TAG_DOUBLE" T.int64_t
+ let gi_type_tag_gtype = T.constant "GI_TYPE_TAG_GTYPE" T.int64_t
+ let gi_type_tag_utf8 = T.constant "GI_TYPE_TAG_UTF8" T.int64_t
+ let gi_type_tag_filename = T.constant "GI_TYPE_TAG_FILENAME" T.int64_t
+ let gi_type_tag_array = T.constant "GI_TYPE_TAG_ARRAY" T.int64_t
+ let gi_type_tag_interface = T.constant "GI_TYPE_TAG_INTERFACE" T.int64_t
+ let gi_type_tag_glist = T.constant "GI_TYPE_TAG_GLIST" T.int64_t
+ let gi_type_tag_gslist = T.constant "GI_TYPE_TAG_GSLIST" T.int64_t
+ let gi_type_tag_ghash = T.constant "GI_TYPE_TAG_GHASH" T.int64_t
+ let gi_type_tag_error = T.constant "GI_TYPE_TAG_ERROR" T.int64_t
+ let gi_type_tag_unichar = T.constant "GI_TYPE_TAG_UNICHAR" T.int64_t
- let tag = T.enum "GITypeTag" ~typedef:true [
- Void, gi_type_tag_void;
- Boolean, gi_type_tag_boolean;
- Int8, gi_type_tag_int8;
- Uint8, gi_type_tag_uint8;
- Int16, gi_type_tag_int16;
- Uint16, gi_type_tag_uint16;
- Int32, gi_type_tag_int32;
- Uint32, gi_type_tag_uint32;
- Int64, gi_type_tag_int64;
- Uint64, gi_type_tag_uint64;
- Float, gi_type_tag_float;
- Double, gi_type_tag_double;
- GType, gi_type_tag_gtype;
- Utf8, gi_type_tag_utf8;
- Filename, gi_type_tag_filename;
- Array, gi_type_tag_array;
- Interface, gi_type_tag_interface;
- GList, gi_type_tag_glist;
- GSList, gi_type_tag_gslist;
- GHash, gi_type_tag_ghash;
- Error, gi_type_tag_error;
- Unichar, gi_type_tag_unichar;
- ]
- ~unexpected:(Utils.unexpected_value_for "GITypeTag")
+ let tag =
+ T.enum "GITypeTag" ~typedef:true
+ [
+ (Void, gi_type_tag_void);
+ (Boolean, gi_type_tag_boolean);
+ (Int8, gi_type_tag_int8);
+ (Uint8, gi_type_tag_uint8);
+ (Int16, gi_type_tag_int16);
+ (Uint16, gi_type_tag_uint16);
+ (Int32, gi_type_tag_int32);
+ (Uint32, gi_type_tag_uint32);
+ (Int64, gi_type_tag_int64);
+ (Uint64, gi_type_tag_uint64);
+ (Float, gi_type_tag_float);
+ (Double, gi_type_tag_double);
+ (GType, gi_type_tag_gtype);
+ (Utf8, gi_type_tag_utf8);
+ (Filename, gi_type_tag_filename);
+ (Array, gi_type_tag_array);
+ (Interface, gi_type_tag_interface);
+ (GList, gi_type_tag_glist);
+ (GSList, gi_type_tag_gslist);
+ (GHash, gi_type_tag_ghash);
+ (Error, gi_type_tag_error);
+ (Unichar, gi_type_tag_unichar);
+ ]
+ ~unexpected:(Utils.unexpected_value_for "GITypeTag")
- let gi_array_type_c = T.constant "GI_ARRAY_TYPE_C" T.int64_t
- let gi_array_type_array = T.constant "GI_ARRAY_TYPE_ARRAY" T.int64_t
- let gi_array_type_ptr_array = T.constant "GI_ARRAY_TYPE_PTR_ARRAY" T.int64_t
- let gi_array_type_byte_array = T.constant "GI_ARRAY_TYPE_BYTE_ARRAY" T.int64_t
+ let gi_array_type_c = T.constant "GI_ARRAY_TYPE_C" T.int64_t
+ let gi_array_type_array = T.constant "GI_ARRAY_TYPE_ARRAY" T.int64_t
+ let gi_array_type_ptr_array = T.constant "GI_ARRAY_TYPE_PTR_ARRAY" T.int64_t
- let array_type = T.enum "GIArrayType" ~typedef:true [
- C, gi_array_type_c;
- Array, gi_array_type_array;
- Ptr_array, gi_array_type_ptr_array;
- Byte_array, gi_array_type_byte_array;
- ]
- ~unexpected:(Utils.unexpected_value_for "GIArrayType")
-end
+ let gi_array_type_byte_array =
+ T.constant "GI_ARRAY_TYPE_BYTE_ARRAY" T.int64_t
+
+ let array_type =
+ T.enum "GIArrayType" ~typedef:true
+ [
+ (C, gi_array_type_c);
+ (Array, gi_array_type_array);
+ (Ptr_array, gi_array_type_ptr_array);
+ (Byte_array, gi_array_type_byte_array);
+ ]
+ ~unexpected:(Utils.unexpected_value_for "GIArrayType")
+ end
diff --git a/bindings/VFunc_info.ml b/bindings/VFunc_info.ml
index b5c3802..6a4c05f 100644
--- a/bindings/VFunc_info.ml
+++ b/bindings/VFunc_info.ml
@@ -17,10 +17,10 @@
*)
type flags =
- | Must_chain_up (** chains up to the parent type *)
- | Must_override (** overrides *)
- | Must_not_override (** does not override *)
- | Throws (** Includes a GError *)
+ | Must_chain_up (** chains up to the parent type *)
+ | Must_override (** overrides *)
+ | Must_not_override (** does not override *)
+ | Throws (** Includes a GError *)
let string_of_flag = function
| Must_chain_up -> "Must_chain_up"
@@ -28,10 +28,19 @@ let string_of_flag = function
| Must_not_override -> "Must_not_override"
| Throws -> "Throws"
-module Flags = functor (T : Cstubs.Types.TYPE) -> struct
- let gi_vfunc_must_chain_up = T.constant "GI_VFUNC_MUST_CHAIN_UP" T.int64_t
- let gi_vfunc_must_override = T.constant "GI_VFUNC_MUST_OVERRIDE" T.int64_t
- let gi_vfunc_must_not_override = T.constant "GI_VFUNC_MUST_NOT_OVERRIDE" T.int64_t
- let gi_vfunc_throws = T.constant "GI_VFUNC_THROWS" T.int64_t
- let flags = T.enum "GIVFuncInfoFlags" ~typedef:true [] ~unexpected:(fun x -> x)
-end
+module Flags =
+functor
+ (T : Cstubs.Types.TYPE)
+ ->
+ struct
+ let gi_vfunc_must_chain_up = T.constant "GI_VFUNC_MUST_CHAIN_UP" T.int64_t
+ let gi_vfunc_must_override = T.constant "GI_VFUNC_MUST_OVERRIDE" T.int64_t
+
+ let gi_vfunc_must_not_override =
+ T.constant "GI_VFUNC_MUST_NOT_OVERRIDE" T.int64_t
+
+ let gi_vfunc_throws = T.constant "GI_VFUNC_THROWS" T.int64_t
+
+ let flags =
+ T.enum "GIVFuncInfoFlags" ~typedef:true [] ~unexpected:(fun x -> x)
+ end
diff --git a/bindings/bindings.ml b/bindings/bindings.ml
index 2467cb6..b823ea4 100644
--- a/bindings/bindings.ml
+++ b/bindings/bindings.ml
@@ -16,11 +16,34 @@
* along with OCaml-GObject-Introspection. If not, see .
*)
-module Base_info = struct include Base_info end
-module Function_info = struct include Function_info end
-module Types = struct include Types end
-module VFunc_info = struct include VFunc_info end
-module Arg_info = struct include Arg_info end
-module Field_info = struct include Field_info end
-module GParam = struct include GParam end
-module GSignal = struct include GSignal end
+module Base_info = struct
+ include Base_info
+end
+
+module Function_info = struct
+ include Function_info
+end
+
+module Types = struct
+ include Types
+end
+
+module VFunc_info = struct
+ include VFunc_info
+end
+
+module Arg_info = struct
+ include Arg_info
+end
+
+module Field_info = struct
+ include Field_info
+end
+
+module GParam = struct
+ include GParam
+end
+
+module GSignal = struct
+ include GSignal
+end
diff --git a/bindings/dune b/bindings/dune
index 4c20209..a3af9a0 100644
--- a/bindings/dune
+++ b/bindings/dune
@@ -1,5 +1,4 @@
(library
- (name bindings)
- (public_name gobject-introspection.bindings)
- (libraries ctypes.stubs ctypes)
-)
+ (name bindings)
+ (public_name gobject-introspection.bindings)
+ (libraries ctypes.stubs ctypes))
diff --git a/bindings/utils.ml b/bindings/utils.ml
index 938df32..61c6ee6 100644
--- a/bindings/utils.ml
+++ b/bindings/utils.ml
@@ -1,5 +1,5 @@
-
-let unexpected_value_for (enum : string) : (int64 -> 'a)=
- (fun x ->
- let value = " - Unexpexted value " ^ Int64.to_string x in
- let message = enum ^ value in failwith message)
+let unexpected_value_for (enum : string) : int64 -> 'a =
+ fun x ->
+ let value = " - Unexpexted value " ^ Int64.to_string x in
+ let message = enum ^ value in
+ failwith message
diff --git a/config/discover.ml b/config/discover.ml
index 838c833..cb17fa4 100644
--- a/config/discover.ml
+++ b/config/discover.ml
@@ -1,53 +1,80 @@
-open Base
-open Stdio
-module C = Configurator
+open Sexplib0
+open Sexplib0.Sexp_conv
+open StdLabels
+module C = Configurator.V1
+
+let write_data fn data =
+ let och = open_out fn in
+ Fun.protect
+ (fun () -> output_string och data)
+ ~finally:(fun () -> close_out och)
let write_sexp fn list_of_str =
let data = sexp_of_list sexp_of_string list_of_str |> Sexp.to_string in
- Out_channel.write_all fn ~data
+ write_data fn data
-let write_flags file list_of_str =
+let write_flags fn list_of_str =
let data = String.concat list_of_str ~sep:" " in
- Out_channel.write_all file ~data
+ write_data fn data
let () =
C.main ~name:"GObject-Introspection" (fun c ->
- let default : C.Pkg_config.package_conf =
- { libs = ["-lgirepository-1.0"; "-lgobject-2.0"; "-lglib-2.0"; "-lffi"]
- ; cflags = ["-O2"; "-Wall"; "-Wextra"; "-Wno-unused-parameter"; "-pthread";
- "-I/usr/include/gobject-introspection-1.0";
- "-I/usr/lib/libffi-3.2.1/include";
- "-I/usr/include/glib-2.0";
- "-I/usr/lib/glib-2.0/include"]
- }
- in
- let default_ffi : C.Pkg_config.package_conf =
- { libs = ["-lffi"] ;
- cflags = ["-O2"; "-Wall"; "-Wextra"; "-Wno-unused-parameter";
- "-I/usr/lib/libffi-3.2.1/include";
- "-I/usr/include/x86_64-linux-gnu"; (* default ubuntu *)
- "-I/usr/include"] (* default ubuntu *)
- }
- in
- let conf =
- match C.Pkg_config.get c with
- | None -> default
- | Some pc ->
- let get_config package default =
- Option.value (C.Pkg_config.query pc ~package) ~default in
- let libffi = get_config "libffi" default_ffi in
- let gobject = get_config "gobject-introspection-1.0" default in
- let module P = C.Pkg_config in
- { libs = (libffi.P.libs @ gobject.P.libs);
- cflags = (libffi.P.cflags @ gobject.P.cflags) }
- in
- let os_type = C.ocaml_config_var_exn (C.create "") "system" in
- let ccopts =
- if Base.String.(os_type = "macosx") then [""]
- else ["-Wl,-no-as-needed"]
- in
- write_sexp "c_flags.sexp" conf.cflags;
- write_sexp "c_library_flags.sexp" conf.libs;
- write_sexp "ccopts.sexp" ccopts;
- write_flags "c_library_flags" conf.libs;
- write_flags "c_flags" conf.cflags)
+ let default : C.Pkg_config.package_conf =
+ {
+ libs =
+ [ "-lgirepository-1.0"; "-lgobject-2.0"; "-lglib-2.0"; "-lffi" ];
+ cflags =
+ [
+ "-O2";
+ "-Wall";
+ "-Wextra";
+ "-Wno-unused-parameter";
+ "-pthread";
+ "-I/usr/include/gobject-introspection-1.0";
+ "-I/usr/lib/libffi-3.2.1/include";
+ "-I/usr/include/glib-2.0";
+ "-I/usr/lib/glib-2.0/include";
+ ];
+ }
+ in
+ let default_ffi : C.Pkg_config.package_conf =
+ {
+ libs = [ "-lffi" ];
+ cflags =
+ [
+ "-O2";
+ "-Wall";
+ "-Wextra";
+ "-Wno-unused-parameter";
+ "-I/usr/lib/libffi-3.2.1/include";
+ "-I/usr/include/x86_64-linux-gnu";
+ (* default ubuntu *)
+ "-I/usr/include";
+ ]
+ (* default ubuntu *);
+ }
+ in
+ let conf =
+ match C.Pkg_config.get c with
+ | None -> default
+ | Some pc ->
+ let get_config package default =
+ Option.value (C.Pkg_config.query pc ~package) ~default
+ in
+ let libffi = get_config "libffi" default_ffi in
+ let gobject = get_config "gobject-introspection-1.0" default in
+ let module P = C.Pkg_config in
+ {
+ libs = libffi.P.libs @ gobject.P.libs;
+ cflags = libffi.P.cflags @ gobject.P.cflags;
+ }
+ in
+ let os_type = C.ocaml_config_var_exn (C.create "") "system" in
+ let ccopts =
+ if os_type = "macosx" then [ "" ] else [ "-Wl,-no-as-needed" ]
+ in
+ write_sexp "c_flags.sexp" conf.cflags;
+ write_sexp "c_library_flags.sexp" conf.libs;
+ write_sexp "ccopts.sexp" ccopts;
+ write_flags "c_library_flags" conf.libs;
+ write_flags "c_flags" conf.cflags)
diff --git a/config/dune b/config/dune
index e2ed62f..0e0b6f5 100644
--- a/config/dune
+++ b/config/dune
@@ -1,3 +1,3 @@
(executable
(name discover)
- (libraries base stdio configurator))
+ (libraries sexplib0 dune-configurator))
diff --git a/docs/Bindings/.dune-keep b/docs/Bindings/.dune-keep
deleted file mode 100644
index e69de29..0000000
diff --git a/docs/Bindings/Arg_info/index.html b/docs/Bindings/Arg_info/index.html
deleted file mode 100644
index 50ae3e1..0000000
--- a/docs/Bindings/Arg_info/index.html
+++ /dev/null
@@ -1,2 +0,0 @@
-
-Arg_info (gobject-introspection.Bindings.Arg_info)
transfer nothing from the callee (function or the type instance the property belongs to) to the caller. The callee retains the ownership of the transfer and the caller doesn't need to do anything to free up the resources of this transfer.
| Container
transfer the container (list, array, hash table) from the callee to the caller. The callee retains the ownership of the individual items in the container and the caller has to free up the container resources (g_list_free()/ g_hash_table_destroy() etc) of this transfer.
| Everything
transfer everything, eg the container and its contents from the callee to the caller. This is the case when the callee creates a copy of all the data it returns. The caller is responsible for cleaning up the container and item resources of this transfer.
the parameter will be set upon object construction
| Construct_only
the parameter can only be set upon object construction
| Lax_validation
upon parameter conversion (see g_param_value_convert()) strict validation is not required
| Static_name
the string used as name when constructing the parameter is guaranteed to remain valid and unmodified for the lifetime of the parameter. Since 2.8
| Static_nick
the string used as nick when constructing the parameter is guaranteed to remain valid and unmmodified for the lifetime of the parameter. Since 2.8
| Static_blurb
the string used as blurb when constructing the parameter is guaranteed to remain valid and unmodified for the lifetime of the parameter. Since 2.8
| Explicit_notify
calls to g_object_set_property() for this property will not automatically result in a "notify" signal being emitted: the implementation must call g_object_notify() themselves in case the property actually changes. Since: 2.42.
| Deprecated
the parameter is deprecated and will be removed in a future version. A warning will be generated if it is used while running with G_ENABLE_DIAGNOSTIC=1. Since 2.26
Invoke the object method handler in the first emission stage.
| Run_last
Invoke the object method handler in the third emission stage.
| Run_cleanup
Invoke the object method handler in the last emission stage.
| No_recurse
Signals being emitted for an object while currently being in emission for this very object will not be emitted recursively, but instead cause the first emission to be restarted.
| Detailed
This signal supports "::detail" appendices to the signal name upon handler connections and emissions.
| Action
Action signals are signals that may freely be emitted on alive objects from user code via g_signal_emit() and friends, without the need of being embedded into extra code that performs pre or post emission adjustments on the object. They can also be thought of as object methods which can be called generically by third-party code.
| No_hooks
No emissions hooks are supported for this signal.
| Must_collect
Varargs signal emission will always collect the arguments, even if there are no signal handlers connected. Since 2.30.
| Deprecated
The signal is deprecated and will be removed in a future version. A warning will be generated if it is connected while running with G_ENABLE_DIAGNOSTIC=1. Since 2.32.
Flags defined in the module Signals of the GObject library The signal flags are used to specify a signal's behaviour, the overall signal description outlines how especially the RUN flags control the stages of a signal emission.
transfer nothing from the callee (function or the type instance the property belongs to) to the caller. The callee retains the ownership of the transfer and the caller doesn't need to do anything to free up the resources of this transfer.
| Container
transfer the container (list, array, hash table) from the callee to the caller. The callee retains the ownership of the individual items in the container and the caller has to free up the container resources (g_list_free()/ g_hash_table_destroy() etc) of this transfer.
| Everything
transfer everything, eg the container and its contents from the callee to the caller. This is the case when the callee creates a copy of all the data it returns. The caller is responsible for cleaning up the container and item resources of this transfer.
\ No newline at end of file
diff --git a/docs/Bindings__/GParam/index.html b/docs/Bindings__/GParam/index.html
deleted file mode 100644
index 2886c45..0000000
--- a/docs/Bindings__/GParam/index.html
+++ /dev/null
@@ -1,2 +0,0 @@
-
-GParam (gobject-introspection.Bindings__.GParam)
Module Bindings__.GParam
type flags =
| Readable
the parameter is readable
| Writable
the parameter is writable
| Readwrite
alias for G_PARAM_READABLE | G_PARAM_WRITABLE
| Construct
the parameter will be set upon object construction
| Construct_only
the parameter can only be set upon object construction
| Lax_validation
upon parameter conversion (see g_param_value_convert()) strict validation is not required
| Static_name
the string used as name when constructing the parameter is guaranteed to remain valid and unmodified for the lifetime of the parameter. Since 2.8
| Static_nick
the string used as nick when constructing the parameter is guaranteed to remain valid and unmmodified for the lifetime of the parameter. Since 2.8
| Static_blurb
the string used as blurb when constructing the parameter is guaranteed to remain valid and unmodified for the lifetime of the parameter. Since 2.8
| Explicit_notify
calls to g_object_set_property() for this property will not automatically result in a "notify" signal being emitted: the implementation must call g_object_notify() themselves in case the property actually changes. Since: 2.42.
| Deprecated
the parameter is deprecated and will be removed in a future version. A warning will be generated if it is used while running with G_ENABLE_DIAGNOSTIC=1. Since 2.26
\ No newline at end of file
diff --git a/docs/Bindings__/GSignal/index.html b/docs/Bindings__/GSignal/index.html
deleted file mode 100644
index 6ec892b..0000000
--- a/docs/Bindings__/GSignal/index.html
+++ /dev/null
@@ -1,2 +0,0 @@
-
-GSignal (gobject-introspection.Bindings__.GSignal)
Module Bindings__.GSignal
type flags =
| Run_first
Invoke the object method handler in the first emission stage.
| Run_last
Invoke the object method handler in the third emission stage.
| Run_cleanup
Invoke the object method handler in the last emission stage.
| No_recurse
Signals being emitted for an object while currently being in emission for this very object will not be emitted recursively, but instead cause the first emission to be restarted.
| Detailed
This signal supports "::detail" appendices to the signal name upon handler connections and emissions.
| Action
Action signals are signals that may freely be emitted on alive objects from user code via g_signal_emit() and friends, without the need of being embedded into extra code that performs pre or post emission adjustments on the object. They can also be thought of as object methods which can be called generically by third-party code.
| No_hooks
No emissions hooks are supported for this signal.
| Must_collect
Varargs signal emission will always collect the arguments, even if there are no signal handlers connected. Since 2.30.
| Deprecated
The signal is deprecated and will be removed in a future version. A warning will be generated if it is connected while running with G_ENABLE_DIAGNOSTIC=1. Since 2.32.
Flags defined in the module Signals of the GObject library The signal flags are used to specify a signal's behaviour, the overall signal description outlines how especially the RUN flags control the stages of a signal emission.
transfer nothing from the callee (function or the type instance the property belongs to) to the caller. The callee retains the ownership of the transfer and the caller doesn't need to do anything to free up the resources of this transfer.
| Container
transfer the container (list, array, hash table) from the callee to the caller. The callee retains the ownership of the individual items in the container and the caller has to free up the container resources (g_list_free()/ g_hash_table_destroy() etc) of this transfer.
| Everything
transfer everything, eg the container and its contents from the callee to the caller. This is the case when the callee creates a copy of all the data it returns. The caller is responsible for cleaning up the container and item resources of this transfer.
\ No newline at end of file
diff --git a/docs/Bindings__GParam/index.html b/docs/Bindings__GParam/index.html
deleted file mode 100644
index 52ba61c..0000000
--- a/docs/Bindings__GParam/index.html
+++ /dev/null
@@ -1,2 +0,0 @@
-
-Bindings__GParam (gobject-introspection.Bindings__GParam)
Module Bindings__GParam
type flags =
| Readable
the parameter is readable
| Writable
the parameter is writable
| Readwrite
alias for G_PARAM_READABLE | G_PARAM_WRITABLE
| Construct
the parameter will be set upon object construction
| Construct_only
the parameter can only be set upon object construction
| Lax_validation
upon parameter conversion (see g_param_value_convert()) strict validation is not required
| Static_name
the string used as name when constructing the parameter is guaranteed to remain valid and unmodified for the lifetime of the parameter. Since 2.8
| Static_nick
the string used as nick when constructing the parameter is guaranteed to remain valid and unmmodified for the lifetime of the parameter. Since 2.8
| Static_blurb
the string used as blurb when constructing the parameter is guaranteed to remain valid and unmodified for the lifetime of the parameter. Since 2.8
| Explicit_notify
calls to g_object_set_property() for this property will not automatically result in a "notify" signal being emitted: the implementation must call g_object_notify() themselves in case the property actually changes. Since: 2.42.
| Deprecated
the parameter is deprecated and will be removed in a future version. A warning will be generated if it is used while running with G_ENABLE_DIAGNOSTIC=1. Since 2.26
\ No newline at end of file
diff --git a/docs/Bindings__GSignal/index.html b/docs/Bindings__GSignal/index.html
deleted file mode 100644
index f8c5b97..0000000
--- a/docs/Bindings__GSignal/index.html
+++ /dev/null
@@ -1,2 +0,0 @@
-
-Bindings__GSignal (gobject-introspection.Bindings__GSignal)
Module Bindings__GSignal
type flags =
| Run_first
Invoke the object method handler in the first emission stage.
| Run_last
Invoke the object method handler in the third emission stage.
| Run_cleanup
Invoke the object method handler in the last emission stage.
| No_recurse
Signals being emitted for an object while currently being in emission for this very object will not be emitted recursively, but instead cause the first emission to be restarted.
| Detailed
This signal supports "::detail" appendices to the signal name upon handler connections and emissions.
| Action
Action signals are signals that may freely be emitted on alive objects from user code via g_signal_emit() and friends, without the need of being embedded into extra code that performs pre or post emission adjustments on the object. They can also be thought of as object methods which can be called generically by third-party code.
| No_hooks
No emissions hooks are supported for this signal.
| Must_collect
Varargs signal emission will always collect the arguments, even if there are no signal handlers connected. Since 2.30.
| Deprecated
The signal is deprecated and will be removed in a future version. A warning will be generated if it is connected while running with G_ENABLE_DIAGNOSTIC=1. Since 2.32.
Flags defined in the module Signals of the GObject library The signal flags are used to specify a signal's behaviour, the overall signal description outlines how especially the RUN flags control the stages of a signal emission.
Obtain the direction of the argument. Check GIDirection for possible direction values.
val get_closure : t Ctypes.structure Ctypes.ptr-> int
Obtain the index of the user data argument. This is only valid for arguments which are callbacks. Returns index of the user data argument or -1 if there is none.
val get_destroy : t Ctypes.structure Ctypes.ptr-> int
Obtains the index of the GDestroyNotify argument. This is only valid for arguments which are callbacks. Returns index of the GDestroyNotify argument or -1 if there is none
Obtain the ownership transfer for this argument. GITransfer contains a list of possible values.
val may_be_null : t Ctypes.structure Ctypes.ptr-> bool
Obtain if the type of the argument includes the possibility of NULL. For 'in' values this means that NULL is a valid value. For 'out' values, this means that NULL may be returned. See also Arg_info.is_optional.
val is_caller_allocates : t Ctypes.structure Ctypes.ptr-> bool
Obtain if the argument is a pointer to a struct or object that will receive an output of a function. The default assumption for Arg_info.Out arguments which have allocation is that the callee allocates; if this is TRUE, then the caller must allocate.
val is_optional : t Ctypes.structure Ctypes.ptr-> bool
Obtain if the argument is optional. For 'out' arguments this means that you can pass NULL in order to ignore the result.
val is_return_value : t Ctypes.structure Ctypes.ptr-> bool
Obtain if the argument is a return value. It can either be a parameter or a return value.
val is_skip : t Ctypes.structure Ctypes.ptr-> bool
val get_type : t Ctypes.structure Ctypes.ptr->Type_info.t Ctypes.structure Ctypes.ptr
val cast_from_baseinfo : Base_info.t Ctypes.structure Ctypes.ptr->t Ctypes.structure Ctypes.ptr
Just cast OCaml Ctypes base info to arg info.
val cast_to_baseinfo : t Ctypes.structure Ctypes.ptr->Base_info.t Ctypes.structure Ctypes.ptr
Just cast OCaml Ctypes arg info to base info
val add_unref_finaliser : t Ctypes.structure Ctypes.ptr->t Ctypes.structure Ctypes.ptr
Add unref of the C underlying structure whith Gc.finalise.
val from_baseinfo : Base_info.t Ctypes.structure Ctypes.ptr->t Ctypes.structure Ctypes.ptr
Return a Arg_info.t from a Base_info.t, the underlying C structure ref count is increased and the value is Gc.finalis"ed" with Base_info.baseinfo_unref.
val to_baseinfo : t Ctypes.structure Ctypes.ptr->Base_info.t Ctypes.structure Ctypes.ptr
Return a Base_info.t form a Arg_info, the underlying C structure ref count is increased and the value is Gc.finalis"ed" with Base_info.baseinfo_unref.
\ No newline at end of file
diff --git a/docs/GObject_introspection/Base_info/index.html b/docs/GObject_introspection/Base_info/index.html
deleted file mode 100644
index 94b64d6..0000000
--- a/docs/GObject_introspection/Base_info/index.html
+++ /dev/null
@@ -1,2 +0,0 @@
-
-Base_info (gobject-introspection.GObject_introspection.Base_info)
Module GObject_introspection.Base_info
type t
Base_info is the common base struct of all other *Info structs accessible through the Repository API. All other structs can be casted to a Base_info
val base_info_ref : t Ctypes.structure Ctypes.ptr->t Ctypes.structure Ctypes.ptr
Increases the reference count of underlying Base_info *info.
val base_info_unref : t Ctypes.structure Ctypes.ptr-> unit
Decreases the reference count of underlying Base_info *info . When its reference count drops to 0, the info is freed.
val get_name : t Ctypes.structure Ctypes.ptr->string option
Obtain the name of the info . What the name represents depends on the GIInfoType of the info . For instance for Function_info it is the name of the function.
val equal : t Ctypes.structure Ctypes.ptr->t Ctypes.structure Ctypes.ptr-> bool
Compare two Base_info. Using pointer comparison is not practical since many functions return different instances of Base_info that refers to the same part of the TypeLib; use this function instead to do Base_info comparisons.
val get_namespace : t Ctypes.structure Ctypes.ptr-> string
Obtain the namespace of info
val is_deprecated : t Ctypes.structure Ctypes.ptr-> bool
Obtain whether the info is represents a metadata which is deprecated or not.
val get_container : t Ctypes.structure Ctypes.ptr->t Ctypes.structure Ctypes.ptr option
Obtain the container of the info . The container is the parent Base_info. For instance, the parent of a Function_info is an Object_info or Interface_info.
val enum : string ->?typedef:bool->?unexpected:(int64 ->'a)->('a * int64 const) list->'atyp
\ No newline at end of file
diff --git a/docs/GObject_introspection/Callable_info/index.html b/docs/GObject_introspection/Callable_info/index.html
deleted file mode 100644
index 367b5f0..0000000
--- a/docs/GObject_introspection/Callable_info/index.html
+++ /dev/null
@@ -1,2 +0,0 @@
-
-Callable_info (gobject-introspection.GObject_introspection.Callable_info)
Module GObject_introspection.Callable_info
type t
Callable_info represents an entity which is callable. Currently a function (Function_info), virtual function, (VFunc_info) or callback (GICallbackInfo). A callable has a list of arguments (Arg_info), a return type, direction and a flag which decides if it returns null
val can_throw_gerror : t Ctypes.structure Ctypes.ptr-> bool
Does the function throws an error.
val get_n_args : t Ctypes.structure Ctypes.ptr-> int
Obtain the number of arguments (both IN and OUT) for this callable.
val get_return_attribute : t Ctypes.structure Ctypes.ptr->string option
Retrieve an arbitrary attribute associated with the return value.
val is_method : t Ctypes.structure Ctypes.ptr-> bool
Determines if the callable info is a method. For VFunc_infos, GICallbackInfos, and Signal_infos, this is always true. Otherwise, this looks at the Function_info.Is_method flag on the Function_info. Concretely, this function returns whether Callable_info.get_n_args matches the number of arguments in the raw C method. For methods, there is one more C argument than is exposed by introspection: the "self" or "this" object.
val may_return_null : t Ctypes.structure Ctypes.ptr-> bool
See if a callable could return NULL.
val skip_return : t Ctypes.structure Ctypes.ptr-> bool
See if a callable's return value is only useful in C.
val get_arg : t Ctypes.structure Ctypes.ptr-> int ->Arg_info.t Ctypes.structure Ctypes.ptr
Obtain information about a particular argument of this callable.
val get_return_type : t Ctypes.structure Ctypes.ptr->Type_info.t Ctypes.structure Ctypes.ptr
Obtain the return type of a callable item as a Type_info.
See whether the caller owns the return value of this callable. GITransfer contains a list of possible transfer values.
val cast_from_baseinfo : Base_info.t Ctypes.structure Ctypes.ptr->t Ctypes.structure Ctypes.ptr
Just cast OCaml Ctypes base info to callable info.
val cast_to_baseinfo : t Ctypes.structure Ctypes.ptr->Base_info.t Ctypes.structure Ctypes.ptr
Just cast OCaml Ctypes callable info to base info
val add_unref_finaliser : t Ctypes.structure Ctypes.ptr->t Ctypes.structure Ctypes.ptr
Add unref of the C underlying structure whith Gc.finalise.
val from_baseinfo : Base_info.t Ctypes.structure Ctypes.ptr->t Ctypes.structure Ctypes.ptr
Return a Function_info.t from a Base_info.t, the underlying C structure ref count is increased and the value is Gc.finalis"ed" with Base_info.baseinfo_unref.
val to_baseinfo : t Ctypes.structure Ctypes.ptr->Base_info.t Ctypes.structure Ctypes.ptr
Return a Base_info.t from a Function_info, the underlying C structure ref count is increased and the value is Gc.finalis"ed" with Base_info.baseinfo_unref.
\ No newline at end of file
diff --git a/docs/GObject_introspection/Constant_info/index.html b/docs/GObject_introspection/Constant_info/index.html
deleted file mode 100644
index 85ff55a..0000000
--- a/docs/GObject_introspection/Constant_info/index.html
+++ /dev/null
@@ -1,2 +0,0 @@
-
-Constant_info (gobject-introspection.GObject_introspection.Constant_info)
Module GObject_introspection.Constant_info
type t
Constant_info represents a constant. A constant has a type associated which can be obtained by calling Constant_info.get_type and a value, which can be obtained by calling GIConstant.get_value.
val get_type : t Ctypes.structure Ctypes.ptr->Type_info.t Ctypes.structure Ctypes.ptr
Obtain the type of the constant as a Type_info.
val cast_from_baseinfo : Base_info.t Ctypes.structure Ctypes.ptr->t Ctypes.structure Ctypes.ptr
Just cast OCaml Ctypes base info to constant info.
val cast_to_baseinfo : t Ctypes.structure Ctypes.ptr->Base_info.t Ctypes.structure Ctypes.ptr
Just cast OCaml Ctypes constant info to base info
val add_unref_finaliser : t Ctypes.structure Ctypes.ptr->t Ctypes.structure Ctypes.ptr
Add unref of the C underlying structure whith Gc.finalise.
val from_baseinfo : Base_info.t Ctypes.structure Ctypes.ptr->t Ctypes.structure Ctypes.ptr
Return a Constant_info.t from a Base_info.t, the underlying C structure ref count is increased and the value is Gc.finalis"ed" with Base_info.baseinfo_unref.
val to_baseinfo : t Ctypes.structure Ctypes.ptr->Base_info.t Ctypes.structure Ctypes.ptr
Return a Base_info.t form a Constant_info, the underlying C structure ref count is increased and the value is Gc.finalis"ed" with Base_info.baseinfo_unref.
val get_value : t Ctypes.structure Ctypes.ptr->Types.argument_t Ctypes.union Ctypes.ptr
Obtain the value associated with the Constant_info and store it in the value parameter. argument needs to be allocated before passing it in. The size of the constant value stored in argument will be returned. Free the value with Constant_info.free_value.
\ No newline at end of file
diff --git a/docs/GObject_introspection/Conversions/index.html b/docs/GObject_introspection/Conversions/index.html
deleted file mode 100644
index 26757a5..0000000
--- a/docs/GObject_introspection/Conversions/index.html
+++ /dev/null
@@ -1,2 +0,0 @@
-
-Conversions (gobject-introspection.GObject_introspection.Conversions)
Module GObject_introspection.Conversions
type carray_of_strings = char Ctypes.ptr Ctypes.ptr
val g_slist_data : (gslist, [ `Struct ]) Ctypes.structured Ctypes.ptr->unit Ctypes_static.ptr
Get the void ptr data of the current element
val gslist_of_strings_to_list : (gslist, [ `Struct ]) Ctypes.structured Ctypes.ptr->string list
Transform a GSList of strings to an OCaml list of strings
\ No newline at end of file
diff --git a/docs/GObject_introspection/Enum_info/index.html b/docs/GObject_introspection/Enum_info/index.html
deleted file mode 100644
index f820210..0000000
--- a/docs/GObject_introspection/Enum_info/index.html
+++ /dev/null
@@ -1,2 +0,0 @@
-
-Enum_info (gobject-introspection.GObject_introspection.Enum_info)
Module GObject_introspection.Enum_info
type t
A Enum_info represents an enumeration and a Value_info struct represents a value of an enumeration. The Enum_info contains a set of values and a type The Value_info is fetched by calling Enum_info.get_value on a Enum_info.
Obtain the tag of the type used for the enum in the C ABI. This will be a signed or unsigned integral type. Note that in the current implementation the width of the type is computed correctly, but the signed or unsigned nature of the type may not match the sign of the type used by the C compiler.
val cast_from_baseinfo : Base_info.t Ctypes.structure Ctypes.ptr->t Ctypes.structure Ctypes.ptr
Just cast OCaml Ctypes base info to enum info.
val cast_to_baseinfo : t Ctypes.structure Ctypes.ptr->Base_info.t Ctypes.structure Ctypes.ptr
Just cast OCaml Ctypes enum info to base info
val from_baseinfo : Base_info.t Ctypes.structure Ctypes.ptr->t Ctypes.structure Ctypes.ptr
Return a Enum_info.t from a Base_info.t, the underlying C structure ref count is increased and the value is Gc.finalis"ed" with Base_info.baseinfo_unref.
val to_baseinfo : t Ctypes.structure Ctypes.ptr->Base_info.t Ctypes.structure Ctypes.ptr
Return a Base_info.t form a Enum_info, the underlying C structure ref count is increased and the value is Gc.finalis"ed" with Base_info.baseinfo_unref.
val cast_from_registeredtypeinfo : Registered_type_info.t Ctypes.structure Ctypes.ptr->t Ctypes.structure Ctypes.ptr
Just cast OCaml Ctypes registeredtype info to enum info.
val cast_to_registeredtypeinfo : t Ctypes.structure Ctypes.ptr->Registered_type_info.t Ctypes.structure Ctypes.ptr
Just cast OCaml Ctypes enum info to registeredtype info
val from_registeredtypeinfo : Registered_type_info.t Ctypes.structure Ctypes.ptr->t Ctypes.structure Ctypes.ptr
Return a Enum_info.t from a Registered_type_info.t, the underlying C structure ref count is increased and the value is Gc.finalis"ed" with Registered_type_info.registeredtypeinfo_unref.
val to_registeredtypeinfo : t Ctypes.structure Ctypes.ptr->Registered_type_info.t Ctypes.structure Ctypes.ptr
Return a Registered_type_info.t form a Enum_info, the underlying C structure ref count is increased and the value is Gc.finalis"ed" with Registered_type_info.registeredtypeinfo_unref.
\ No newline at end of file
diff --git a/docs/GObject_introspection/Field_info/index.html b/docs/GObject_introspection/Field_info/index.html
deleted file mode 100644
index aaa1ac7..0000000
--- a/docs/GObject_introspection/Field_info/index.html
+++ /dev/null
@@ -1,2 +0,0 @@
-
-Field_info (gobject-introspection.GObject_introspection.Field_info)
Module GObject_introspection.Field_info
type t
A Field_info struct represents a field of a struct (see Struct_info), union (see Union_info) or an object (see Object_info). The Field_info is fetched by calling Struct_info.get_field, Union_info.get_field or Object_info.get_field. A field has a size, type and a struct offset asssociated and a set of flags, which is currently GI_FIELD_IS_READABLE or GI_FIELD_IS_WRITABLE.
Obtain the flags for this Field_info. See Field_info.flags for possible flag values.
val get_offset : t Ctypes.structure Ctypes.ptr-> int
Obtain the offset in bits of the field member, this is relative to the beginning of the struct or union.
val get_size : t Ctypes.structure Ctypes.ptr-> int
Obtain the size in bits of the field member, this is how much space you need to allocate to store the field.
val get_type : t Ctypes.structure Ctypes.ptr->Type_info.t Ctypes.structure Ctypes.ptr
Obtain the type of a field as a Type_info.
val cast_from_baseinfo : Base_info.t Ctypes.structure Ctypes.ptr->t Ctypes.structure Ctypes.ptr
Just cast OCaml Ctypes base info to field info.
val cast_to_baseinfo : t Ctypes.structure Ctypes.ptr->Base_info.t Ctypes.structure Ctypes.ptr
Just cast OCaml Ctypes field info to base info
val add_unref_finaliser : t Ctypes.structure Ctypes.ptr->t Ctypes.structure Ctypes.ptr
Add unref of the C underlying structure whith Gc.finalise.
val from_baseinfo : Base_info.t Ctypes.structure Ctypes.ptr->t Ctypes.structure Ctypes.ptr
Return a Field_info.t from a Base_info.t, the underlying C structure ref count is increased and the value is Gc.finalis"ed" with Base_info.baseinfo_unref.
val to_baseinfo : t Ctypes.structure Ctypes.ptr->Base_info.t Ctypes.structure Ctypes.ptr
Return a Base_info.t from a Field_info, the underlying C structure ref count is increased and the value is Gc.finalis"ed" with Base_info.baseinfo_unref.
\ No newline at end of file
diff --git a/docs/GObject_introspection/Function_info/index.html b/docs/GObject_introspection/Function_info/index.html
deleted file mode 100644
index 461f7c2..0000000
--- a/docs/GObject_introspection/Function_info/index.html
+++ /dev/null
@@ -1,2 +0,0 @@
-
-Function_info (gobject-introspection.GObject_introspection.Function_info)
Module GObject_introspection.Function_info
type t
Function_info represents a function, method or constructor. To find out what kind of entity a Function_info represents, call Function_info.get_flags. See also Callable_info for information on how to retreive arguments and other metadata.
val get_property : t Ctypes.structure Ctypes.ptr->Property_info.t Ctypes.structure Ctypes.ptr option
Obtain the property associated with this Function_info. Only Function_info with the flag GIFunction.Is_getter or GIFunction.Is_setter have a property set. For other cases, NULL will be returned.
val get_vfunc : t Ctypes.structure Ctypes.ptr->Callable_info.t Ctypes.structure Ctypes.ptr option
Obtain the virtual function associated with this Function_info. Only Function_info with the flag Wraps_vfunc has a virtual function set. For other cases, None will be returned. In order to avoid circular call graph between Function_info and VFunc_info, this function will return a Callable_info. It is upto the user to use VFunc_info.from_callableinfo in order to have the VFunc_info.
val cast_from_baseinfo : Base_info.t Ctypes.structure Ctypes.ptr->t Ctypes.structure Ctypes.ptr
Just cast OCaml Ctypes base info to function info.
val cast_to_baseinfo : t Ctypes.structure Ctypes.ptr->Base_info.t Ctypes.structure Ctypes.ptr
Just cast OCaml Ctypes function info to base info
val add_unref_finaliser : t Ctypes.structure Ctypes.ptr->t Ctypes.structure Ctypes.ptr
Add unref of the C underlying structure whith Gc.finalise.
val from_baseinfo : Base_info.t Ctypes.structure Ctypes.ptr->t Ctypes.structure Ctypes.ptr
Return a Function_info.t from a Base_info.t, the underlying C structure ref count is increased and the value is Gc.finalis"ed" with Base_info.baseinfo_unref.
val to_baseinfo : t Ctypes.structure Ctypes.ptr->Base_info.t Ctypes.structure Ctypes.ptr
Return a Base_info.t from a Function_info, the underlying C structure ref count is increased and the value is Gc.finalis"ed" with Base_info.baseinfo_unref.
val cast_from_callableinfo : Callable_info.t Ctypes.structure Ctypes.ptr->t Ctypes.structure Ctypes.ptr
Just cast OCaml Ctypes callable info to function info.
val cast_to_callableinfo : t Ctypes.structure Ctypes.ptr->Callable_info.t Ctypes.structure Ctypes.ptr
Just cast OCaml Ctypes function info to callable info
val from_callableinfo : Callable_info.t Ctypes.structure Ctypes.ptr->t Ctypes.structure Ctypes.ptr
Return a Function_info.t from a Callable_info.t, the underlying C structure ref count is increased and the value is Gc.finalis"ed" with Base_info.baseinfo_unref.
val to_callableinfo : t Ctypes.structure Ctypes.ptr->Callable_info.t Ctypes.structure Ctypes.ptr
Return a Callable_info.t from a Function_info, the underlying C structure ref count is increased and the value is Gc.finalis"ed" with Base_info.baseinfo_unref.
\ No newline at end of file
diff --git a/docs/GObject_introspection/GParam/index.html b/docs/GObject_introspection/GParam/index.html
deleted file mode 100644
index 45caa93..0000000
--- a/docs/GObject_introspection/GParam/index.html
+++ /dev/null
@@ -1,2 +0,0 @@
-
-GParam (gobject-introspection.GObject_introspection.GParam)
\ No newline at end of file
diff --git a/docs/GObject_introspection/Interface_info/index.html b/docs/GObject_introspection/Interface_info/index.html
deleted file mode 100644
index d1f2200..0000000
--- a/docs/GObject_introspection/Interface_info/index.html
+++ /dev/null
@@ -1,2 +0,0 @@
-
-Interface_info (gobject-introspection.GObject_introspection.Interface_info)
Module GObject_introspection.Interface_info
type t
Interface_info represents a GInterface type. A GInterface has methods, fields, properties, signals, interfaces, constants, virtual functions and prerequisites.
val get_n_prerequisites : t Ctypes.structure Ctypes.ptr-> int
Obtain the number of prerequisites for this interface type. A prerequisites is another interface that needs to be implemented for interface, similar to an base class for GObjects.
val get_prerequisite : t Ctypes.structure Ctypes.ptr-> int ->Base_info.t Ctypes.structure Ctypes.ptr
Obtain an interface type prerequisites index n .
val get_n_properties : t Ctypes.structure Ctypes.ptr-> int
Obtain the number of properties that this interface type has.
val get_property : t Ctypes.structure Ctypes.ptr-> int ->Property_info.t Ctypes.structure Ctypes.ptr
Obtain an interface type property at index n .
val get_n_methods : t Ctypes.structure Ctypes.ptr-> int
Obtain the number of methods that this interface type has.
val get_method : t Ctypes.structure Ctypes.ptr-> int ->Function_info.t Ctypes.structure Ctypes.ptr
Obtain an interface type method at index n .
val find_method : t Ctypes.structure Ctypes.ptr-> string ->Function_info.t Ctypes.structure Ctypes.ptr option
Obtain a method of the interface type given a name . NULL will be returned if there's no method available with that name.
val get_n_signals : t Ctypes.structure Ctypes.ptr-> int
Obtain the number of signals that this interface type has.
val get_signal : t Ctypes.structure Ctypes.ptr-> int ->Signal_info.t Ctypes.structure Ctypes.ptr
Obtain an interface type signal at index n .
val find_signal : t Ctypes.structure Ctypes.ptr-> string ->Signal_info.t Ctypes.structure Ctypes.ptr option
Find a signal of the interface
val get_n_constants : t Ctypes.structure Ctypes.ptr-> int
Obtain the number of constants that this interface type has.
val get_constant : t Ctypes.structure Ctypes.ptr-> int ->Constant_info.t Ctypes.structure Ctypes.ptr
Obtain an interface type constant at index n .
val get_iface_struct : t Ctypes.structure Ctypes.ptr->Struct_info.t Ctypes.structure Ctypes.ptr option
Returns the layout C structure associated with this GInterface.
val get_n_vfuncs : t Ctypes.structure Ctypes.ptr-> int
Obtain the number of virtual functions that this interface type has.
val get_vfunc : t Ctypes.structure Ctypes.ptr-> int ->VFunc_info.t Ctypes.structure Ctypes.ptr
Obtain an interface type virtual function at index n .
val find_vfunc : t Ctypes.structure Ctypes.ptr-> string ->VFunc_info.t Ctypes.structure Ctypes.ptr option
Locate a virtual function slot with name name . See the documentation for g_object_info_find_vfunc() for more information on virtuals.
val cast_from_baseinfo : Base_info.t Ctypes.structure Ctypes.ptr->t Ctypes.structure Ctypes.ptr
Just cast OCaml Ctypes base info to interface info.
val cast_to_baseinfo : t Ctypes.structure Ctypes.ptr->Base_info.t Ctypes.structure Ctypes.ptr
Just cast OCaml Ctypes interface info to base info
val add_unref_finaliser : t Ctypes.structure Ctypes.ptr->t Ctypes.structure Ctypes.ptr
Add unref of the C underlying structure whith Gc.finalise.
val from_baseinfo : Base_info.t Ctypes.structure Ctypes.ptr->t Ctypes.structure Ctypes.ptr
Return a Interface_info.t from a Base_info.t, the underlying C structure ref count is increased and the value is Gc.finalis"ed" with Base_info.baseinfo_unref.
val to_baseinfo : t Ctypes.structure Ctypes.ptr->Base_info.t Ctypes.structure Ctypes.ptr
Return a Base_info.t from a Interface_info, the underlying C structure ref count is increased and the value is Gc.finalis"ed" with Base_info.baseinfo_unref.
val cast_from_registeredtypeinfo : Registered_type_info.t Ctypes.structure Ctypes.ptr->t Ctypes.structure Ctypes.ptr
Just cast OCaml Ctypes registeredtype info to enum info.
val cast_to_registeredtypeinfo : t Ctypes.structure Ctypes.ptr->Registered_type_info.t Ctypes.structure Ctypes.ptr
Just cast OCaml Ctypes enum info to registeredtype info
val from_registeredtypeinfo : Registered_type_info.t Ctypes.structure Ctypes.ptr->t Ctypes.structure Ctypes.ptr
Return a Interface_info.t from a Registered_type_info.t, the underlying C structure ref count is increased and the value is Gc.finalis"ed" with Registered_type_info.registeredtypeinfo_unref.
val to_registeredtypeinfo : t Ctypes.structure Ctypes.ptr->Registered_type_info.t Ctypes.structure Ctypes.ptr
Return a Registered_type_info.t form a Interface_info, the underlying C structure ref count is increased and the value is Gc.finalis"ed" with Registered_type_info.registeredtypeinfo_unref.
\ No newline at end of file
diff --git a/docs/GObject_introspection/Object_info/index.html b/docs/GObject_introspection/Object_info/index.html
deleted file mode 100644
index 5298d1a..0000000
--- a/docs/GObject_introspection/Object_info/index.html
+++ /dev/null
@@ -1,2 +0,0 @@
-
-Object_info (gobject-introspection.GObject_introspection.Object_info)
Module GObject_introspection.Object_info
type t
Object_info represents a GObject. This doesn't represent a specific instance of a GObject, instead this represent the object type (eg class). A GObject has methods, fields, properties, signals, interfaces, constants and virtual functions.
val get_abstract : t Ctypes.structure Ctypes.ptr-> bool
Obtain if the object type is an abstract type, eg if it cannot be instantiated
val get_fundamental : t Ctypes.structure Ctypes.ptr-> bool
Obtain if the object type is of a fundamental type which is not G_TYPE_OBJECT. This is mostly for supporting GstMiniObject.
val get_parent : t Ctypes.structure Ctypes.ptr->Base_info.t Ctypes.structure Ctypes.ptr
Obtain the parent of the object type.
val get_type_name : t Ctypes.structure Ctypes.ptr-> string
Obtain the name of the objects class/type.
val get_type_init : t Ctypes.structure Ctypes.ptr-> string
Obtain the function which when called will return the GType function for which this object type is registered.
val get_n_constants : t Ctypes.structure Ctypes.ptr-> int
Obtain the number of constants that this object type has.
val get_constant : t Ctypes.structure Ctypes.ptr-> int ->Constant_info.t Ctypes.structure Ctypes.ptr
Obtain an object type constant at index n .
val get_n_fields : t Ctypes.structure Ctypes.ptr-> int
Obtain the number of fields that this object type has.
val get_field : t Ctypes.structure Ctypes.ptr-> int ->Field_info.t Ctypes.structure Ctypes.ptr
Obtain an object type field at index n .
val get_n_interfaces : t Ctypes.structure Ctypes.ptr-> int
Obtain the number of interfaces that this object type has.
val get_interface : t Ctypes.structure Ctypes.ptr-> int ->Interface_info.t Ctypes.structure Ctypes.ptr
Obtain an object type interface at index n .
val get_n_methods : t Ctypes.structure Ctypes.ptr-> int
Obtain the number of methods that this object type has.
val get_method : t Ctypes.structure Ctypes.ptr-> int ->Function_info.t Ctypes.structure Ctypes.ptr
Obtain an object type method at index n .
val find_method : t Ctypes.structure Ctypes.ptr-> string ->Function_info.t Ctypes.structure Ctypes.ptr option
Obtain a method of the object type given a name . None will be returned if there's no method available with that name.
val get_n_properties : t Ctypes.structure Ctypes.ptr-> int
Obtain the number of properties that this object type has.
val get_property : t Ctypes.structure Ctypes.ptr-> int ->Property_info.t Ctypes.structure Ctypes.ptr
Obtain an object type property at index n .
val get_n_signals : t Ctypes.structure Ctypes.ptr-> int
Obtain the number of signals that this object type has.
val get_signal : t Ctypes.structure Ctypes.ptr-> int ->Signal_info.t Ctypes.structure Ctypes.ptr
Obtain an object type signal at index n .
val find_signal : t Ctypes.structure Ctypes.ptr-> string ->Signal_info.t Ctypes.structure Ctypes.ptr option
Find a signal with a name.
val get_n_vfuncs : t Ctypes.structure Ctypes.ptr-> int
Obtain the number of virtual functions that this object type has.
val get_vfunc : t Ctypes.structure Ctypes.ptr-> int ->VFunc_info.t Ctypes.structure Ctypes.ptr
Obtain an object type virtual function at index n .
val find_vfunc : t Ctypes.structure Ctypes.ptr-> string ->VFunc_info.t Ctypes.structure Ctypes.ptr option
Locate a virtual function slot with name name . Note that the namespace for virtuals is distinct from that of methods; there may or may not be a concrete method associated for a virtual. If there is one, it may be retrieved using VFunc_info.get_invoker, otherwise None will be returned. See the documentation for VFunc_info.get_invoker for more information on invoking virtuals.
val get_class_struct : t Ctypes.structure Ctypes.ptr->Struct_info.t Ctypes.structure Ctypes.ptr option
Every GObject has two structures; an instance structure and a class structure. This function returns the metadata for the class structure. It returns a Struct_info.t or None.
val find_method_using_interfaces : t Ctypes.structure Ctypes.ptr-> string ->Function_info.t Ctypes.structure Ctypes.ptr option * t Ctypes.structure Ctypes.ptr option
Obtain a method of the object given a name , searching both the object info and any interfaces it implements. None will be returned if there's no method available with that name. Note that this function does *not* search parent classes; you will have to chain up if that's desired.
val get_ref_function : t Ctypes.structure Ctypes.ptr->string option
Obtain the symbol name of the function that should be called to ref this object type. It's mainly used fundamental types. The type signature for the symbol is Object_infoRefFunction, to fetch the function pointer see Object_info.get_ref_function.
val get_unref_function : t Ctypes.structure Ctypes.ptr->string option
Obtain the symbol name of the function that should be called to unref this object type. It's mainly used fundamental types. The type signature for the symbol is Object_infoUnrefFunction, to fetch the function pointer see Object_info.get_unref_function.
val get_set_value_function : t Ctypes.structure Ctypes.ptr->string option
Obtain the symbol name of the function that should be called to convert set a GValue giving an object instance pointer of this object type. I's mainly used fundamental types. The type signature for the symbol is Object_infoSetValueFunction, to fetch the function pointer see Object_info.get_set_value_function.
val get_get_value_function : t Ctypes.structure Ctypes.ptr->string option
Obtain the symbol name of the function that should be called to convert an object instance pointer of this object type to a GValue. I's mainly used fundamental types. The type signature for the symbol is Object_infoGetValueFunction, to fetch the function pointer see Object_info.get_get_value_function.
val find_vfunc_using_interfaces : t Ctypes.structure Ctypes.ptr-> string ->VFunc_info.t Ctypes.structure Ctypes.ptr option * t Ctypes.structure Ctypes.ptr option
Locate a virtual function slot with name name , searching both the object info and any interfaces it implements. Note that the namespace for virtuals is distinct from that of methods; there may or may not be a concrete method associated for a virtual. If there is one, it may be retrieved using g_vfunc_info_get_invoker(), otherwise None will be returned. Note that this function does *not* search parent classes; you will have to chain up if that's desired.
val cast_from_baseinfo : Base_info.t Ctypes.structure Ctypes.ptr->t Ctypes.structure Ctypes.ptr
Just cast OCaml Ctypes base info to object info.
val cast_to_baseinfo : t Ctypes.structure Ctypes.ptr->Base_info.t Ctypes.structure Ctypes.ptr
Just cast OCaml Ctypes object info to base info
val from_baseinfo : Base_info.t Ctypes.structure Ctypes.ptr->t Ctypes.structure Ctypes.ptr
Return a Object_info.t from a Base_info.t, the underlying C structure ref count is increased and the value is Gc.finalis"ed" with Base_info.baseinfo_unref.
val to_baseinfo : t Ctypes.structure Ctypes.ptr->Base_info.t Ctypes.structure Ctypes.ptr
Return a Base_info.t from a Object_info, the underlying C structure ref count is increased and the value is Gc.finalis"ed" with Base_info.baseinfo_unref.
val cast_from_registeredtypeinfo : Registered_type_info.t Ctypes.structure Ctypes.ptr->t Ctypes.structure Ctypes.ptr
Just cast OCaml Ctypes registeredtype info to object info.
val cast_to_registeredtypeinfo : t Ctypes.structure Ctypes.ptr->Registered_type_info.t Ctypes.structure Ctypes.ptr
Just cast OCaml Ctypes object info to registeredtype info
val from_registeredtypeinfo : Registered_type_info.t Ctypes.structure Ctypes.ptr->t Ctypes.structure Ctypes.ptr
Return a Object_info.t from a Registered_type_info.t, the underlying C structure ref count is increased and the value is Gc.finalis"ed" with Registered_type_info.registeredtypeinfo_unref.
val to_registeredtypeinfo : t Ctypes.structure Ctypes.ptr->Registered_type_info.t Ctypes.structure Ctypes.ptr
Return a Registered_type_info.t form a Object_info, the underlying C structure ref count is increased and the value is Gc.finalis"ed" with Registered_type_info.registeredtypeinfo_unref.
\ No newline at end of file
diff --git a/docs/GObject_introspection/Property_info/index.html b/docs/GObject_introspection/Property_info/index.html
deleted file mode 100644
index 05af611..0000000
--- a/docs/GObject_introspection/Property_info/index.html
+++ /dev/null
@@ -1,2 +0,0 @@
-
-Property_info (gobject-introspection.GObject_introspection.Property_info)
Module GObject_introspection.Property_info
type t
Property_info represents a property. A property belongs to either a Object_info or a Interface_info.
Obtain the flags for this property info. See GParamFlags for more information about possible flag values.
val cast_from_baseinfo : Base_info.t Ctypes.structure Ctypes.ptr->t Ctypes.structure Ctypes.ptr
Just cast OCaml Ctypes base info to property info.
val cast_to_baseinfo : t Ctypes.structure Ctypes.ptr->Base_info.t Ctypes.structure Ctypes.ptr
Just cast OCaml Ctypes property info to base info
val add_unref_finaliser : t Ctypes.structure Ctypes.ptr->t Ctypes.structure Ctypes.ptr
Add unref of the C underlying structure whith Gc.finalise.
val from_baseinfo : Base_info.t Ctypes.structure Ctypes.ptr->t Ctypes.structure Ctypes.ptr
Return a Property_info.t from a Base_info.t, the underlying C structure ref count is increased and the value is Gc.finalis"ed" with Base_info.baseinfo_unref.
val to_baseinfo : t Ctypes.structure Ctypes.ptr->Base_info.t Ctypes.structure Ctypes.ptr
Return a Base_info.t from a Property_info, the underlying C structure ref count is increased and the value is Gc.finalis"ed" with Base_info.baseinfo_unref.
\ No newline at end of file
diff --git a/docs/GObject_introspection/Registered_type_info/index.html b/docs/GObject_introspection/Registered_type_info/index.html
deleted file mode 100644
index f6d251c..0000000
--- a/docs/GObject_introspection/Registered_type_info/index.html
+++ /dev/null
@@ -1,2 +0,0 @@
-
-Registered_type_info (gobject-introspection.GObject_introspection.Registered_type_info)
Module GObject_introspection.Registered_type_info
type t
val registeredtypeinfo : t Ctypes.structure Ctypes.typ
val get_type_name : t Ctypes.structure Ctypes.ptr->string option
Obtain the type name of the struct within the GObject type system. This type can be passed to g_type_name() to get a #GType.
val get_g_type : t Ctypes.structure Ctypes.ptr->Repository.gtype option
Obtain the gtype for this registered type or None which a special meaning. It means that either there is no type information associated with this info or that the shared library which provides the type_init function for this info cannot be called.
val get_type_init : t Ctypes.structure Ctypes.ptr->string option
Obtain the type init function for info . The type init function is the function which will register the GType within the GObject type system. Usually this is not called by langauge bindings or applications, use Registered_type_info.get_g_type directly instead.
val cast_from_baseinfo : Base_info.t Ctypes.structure Ctypes.ptr->t Ctypes.structure Ctypes.ptr
Just cast OCaml Ctypes base info to registeredtype info.
val cast_to_baseinfo : t Ctypes.structure Ctypes.ptr->Base_info.t Ctypes.structure Ctypes.ptr
Just cast OCaml Ctypes registeredtype info to base info
val add_unref_finaliser : t Ctypes.structure Ctypes.ptr->t Ctypes.structure Ctypes.ptr
Add unref of the C underlying structure whith Gc.finalise.
val from_baseinfo : Base_info.t Ctypes.structure Ctypes.ptr->t Ctypes.structure Ctypes.ptr
Return a Registered_type_info.t from a Base_info.t, the underlying C structure ref count is increased and the value is Gc.finalis"ed" with Base_info.baseinfo_unref.
val to_baseinfo : t Ctypes.structure Ctypes.ptr->Base_info.t Ctypes.structure Ctypes.ptr
Return a Base_info.t from a Registered_type_info, the underlying C structure ref count is increased and the value is Gc.finalis"ed" with Base_info.baseinfo_unref.
\ No newline at end of file
diff --git a/docs/GObject_introspection/Repository/index.html b/docs/GObject_introspection/Repository/index.html
deleted file mode 100644
index c7515b9..0000000
--- a/docs/GObject_introspection/Repository/index.html
+++ /dev/null
@@ -1,2 +0,0 @@
-
-Repository (gobject-introspection.GObject_introspection.Repository)
Returns the singleton process-global default Repository.
val require : ?repository:repository-> string ->?version:string-> unit ->(typelib, string) Stdlib.result
Force the namespace namespace_ to be loaded if it isn't already. If namespace_ is not loaded, this function will search for a ".typelib" file using the repository search path. In addition, a version version of namespace may be specified. If version is not specified, the latest will be used).
val get_loaded_namespaces : ?repository:repository-> unit ->string list
Return the list of currently loaded namespaces.
val get_dependencies : ?repository:repository-> string ->string list
Return an list of all (transitive) versioned dependencies for namespace_ . Returned strings are of the form namespace-version. Note: namespace_ must have already been loaded using a function such as Repository.require before calling this function. To get only the immediate dependencies for namespace_ , use Repository.get_immediate_dependencies.
val get_c_prefix : ?repository:repository-> string -> string
This function returns the "C prefix", or the C level namespace associated with the given introspection namespace. Each C symbol starts with this prefix, as well each GType in the library. Note: The namespace must have already been loaded using a function such as Repository.require before calling this function.
val get_version : ?repository:repository-> string -> string
This function returns the loaded version associated with the given namespace namespace_ . Note: The namespace must have already been loaded using a function such as Repository.require before calling this function.
val get_typelib_path : ?repository:repository-> string -> string
If namespace namespace_ is loaded, return the full path to the .typelib file it was loaded from. If the typelib for namespace namespace_ was included in a shared library, return the special string "<builtin>".
val enumerate_versions : ?repository:repository-> string ->string list
Obtain an unordered list of versions (either currently loaded or available) for namespace_ in this repository .
val get_search_path : unit ->string list
Returns the current search path Repository will use when loading typelib files. The list is internal to GIRespository and should not be freed, nor should its string elements.
val prepend_search_path : string -> unit
Prepends directory to the typelib search path. See Repository.get_search_path.
Searches for a particular entry in a namespace. Before calling this function for a particular namespace, you must call Repository.require once to load the namespace, or otherwise ensure the namespace has already been loaded.
val get_n_infos : ?repository:repository-> string -> int
This function returns the number of metadata entries in given namespace namespace_ . The namespace must have already been loaded before calling this function.
val get_info : ?repository:repository-> string -> int ->Base_info.t Ctypes.structure Ctypes.ptr
This function returns a particular metadata entry in the given namespace namespace_ . The namespace must have already been loaded before calling this function. See Repository.get_n_infos to find the maximum number of entries.
val get_shared_library : ?repository:repository-> string ->string option
This function returns a comma-separated list of paths to the shared C libraries associated with the given namespace namespace_ . There may be no shared library path associated, in which case this function will return NULL. Note: The namespace must have already been loaded using a function such as Repository.require before calling this function.
val prepend_library_path : string -> unit
Prepends directory to the search path that is used to search shared libraries referenced by imported namespaces. Multiple calls to this function all contribute to the final list of paths. The list of paths is unique and shared for all Repository instances across the process, but it doesn't affect namespaces imported before the call. If the library is not found in the directories configured in this way, loading will fall back to the system library path (ie. LD_LIBRARY_PATH and DT_RPATH in ELF systems). See the documentation of your dynamic linker for full details.
Searches all loaded namespaces for a particular #GType. Note that in order to locate the metadata, the namespace corresponding to the type must first have been loaded. There is currently no mechanism for determining the namespace which corresponds to an arbitrary GType - thus, this function will operate most reliably when you know the GType to originate from be from a loaded namespace.
\ No newline at end of file
diff --git a/docs/GObject_introspection/Signal_info/index.html b/docs/GObject_introspection/Signal_info/index.html
deleted file mode 100644
index 9fcadec..0000000
--- a/docs/GObject_introspection/Signal_info/index.html
+++ /dev/null
@@ -1,2 +0,0 @@
-
-Signal_info (gobject-introspection.GObject_introspection.Signal_info)
Module GObject_introspection.Signal_info
type t
Signal_info represents a signal. It's a sub-struct of Callable_info and contains a set of flags and a class closure. See Callable_info for information on how to retreive arguments and other metadata from the signal.
Obtain the flags for this signal info. See GSignalFlags for more information about possible flag values.
val get_class_closure : t Ctypes.structure Ctypes.ptr->Callable_info.t Ctypes.structure Ctypes.ptr option
Obtain the class closure for this signal if one is set. The class closure is a virtual function on the type that the signal belongs to. If the signal lacks a closure None will be returned. In order to avoid circular call graph between Signal_info and VFunc_info, this function will return a Callable_info. It is upto the user to use GIVSignalInfo.from_callableinfo in order to have the VFunc_info.
val cast_from_baseinfo : Base_info.t Ctypes.structure Ctypes.ptr->t Ctypes.structure Ctypes.ptr
Just cast OCaml Ctypes base info to signal info.
val cast_to_baseinfo : t Ctypes.structure Ctypes.ptr->Base_info.t Ctypes.structure Ctypes.ptr
Just cast OCaml Ctypes signal info to base info
val add_unref_finaliser : t Ctypes.structure Ctypes.ptr->t Ctypes.structure Ctypes.ptr
Add unref of the C underlying structure whith Gc.finalise.
val from_baseinfo : Base_info.t Ctypes.structure Ctypes.ptr->t Ctypes.structure Ctypes.ptr
Return a Signal_info.t from a Base_info.t, the underlying C structure ref count is increased and the value is Gc.finalis"ed" with Base_info.baseinfo_unref.
val to_baseinfo : t Ctypes.structure Ctypes.ptr->Base_info.t Ctypes.structure Ctypes.ptr
Return a Base_info.t from a Signal_info, the underlying C structure ref count is increased and the value is Gc.finalis"ed" with Base_info.baseinfo_unref.
val cast_from_callableinfo : Callable_info.t Ctypes.structure Ctypes.ptr->t Ctypes.structure Ctypes.ptr
Just cast OCaml Ctypes callable info to signal info.
val cast_to_callableinfo : t Ctypes.structure Ctypes.ptr->Callable_info.t Ctypes.structure Ctypes.ptr
Just cast OCaml Ctypes signal info to callable info
val from_callableinfo : Callable_info.t Ctypes.structure Ctypes.ptr->t Ctypes.structure Ctypes.ptr
Return a Signal_info.t from a Callable_info.t, the underlying C structure ref count is increased and the value is Gc.finalis"ed" with Base_info.baseinfo_unref.
val to_callableinfo : t Ctypes.structure Ctypes.ptr->Callable_info.t Ctypes.structure Ctypes.ptr
Return a Callable_info.t from a Signal_info, the underlying C structure ref count is increased and the value is Gc.finalis"ed" with Base_info.baseinfo_unref.
\ No newline at end of file
diff --git a/docs/GObject_introspection/Struct_info/index.html b/docs/GObject_introspection/Struct_info/index.html
deleted file mode 100644
index b33bdce..0000000
--- a/docs/GObject_introspection/Struct_info/index.html
+++ /dev/null
@@ -1,2 +0,0 @@
-
-Struct_info (gobject-introspection.GObject_introspection.Struct_info)
Module GObject_introspection.Struct_info
type t
Struct_info represents a generic C structure type. A structure has methods and fields.
val is_gtype_struct : t Ctypes.structure Ctypes.ptr-> bool
Return true if this structure represents the "class structure" for some GObject or GInterface. This function is mainly useful to hide this kind of structure from generated public APIs.
val get_alignment : t Ctypes.structure Ctypes.ptr-> int
Obtain the required alignment of the structure.
val get_size : t Ctypes.structure Ctypes.ptr-> int
Obtain the total size of the structure.
val is_foreign : t Ctypes.structure Ctypes.ptr-> bool
No doc yet
val get_n_fields : t Ctypes.structure Ctypes.ptr-> int
Obtain the number of fields this structure has.
val get_n_methods : t Ctypes.structure Ctypes.ptr-> int
Obtain the number of methods this structure has.
val get_field : t Ctypes.structure Ctypes.ptr-> int ->Field_info.t Ctypes.structure Ctypes.ptr
Obtain the type information for field with specified index.
val get_method : t Ctypes.structure Ctypes.ptr-> int ->Function_info.t Ctypes.structure Ctypes.ptr
Obtain the type information for method with specified index.
val find_method : t Ctypes.structure Ctypes.ptr-> string ->Function_info.t Ctypes.structure Ctypes.ptr option
Obtain the type information for method named name .
val add_unref_finaliser : t Ctypes.structure Ctypes.ptr->t Ctypes.structure Ctypes.ptr
Add unref of the C underlying structure whith Gc.finalise.
val from_baseinfo : Base_info.t Ctypes.structure Ctypes.ptr->t Ctypes.structure Ctypes.ptr
Return a Struct_info.t from a Base_info.t, the underlying C structure ref count is increased and the value is Gc.finalis"ed" with Base_info.baseinfo_unref.
val to_baseinfo : t Ctypes.structure Ctypes.ptr->Base_info.t Ctypes.structure Ctypes.ptr
Return a Base_info.t form a Struct_info, the underlying C structure ref count is increased and the value is Gc.finalis"ed" with Base_info.baseinfo_unref.
val cast_from_registeredtypeinfo : Registered_type_info.t Ctypes.structure Ctypes.ptr->t Ctypes.structure Ctypes.ptr
Just cast OCaml Ctypes registeredtype info to struct info.
val cast_to_registeredtypeinfo : t Ctypes.structure Ctypes.ptr->Registered_type_info.t Ctypes.structure Ctypes.ptr
Just cast OCaml Ctypes struct info to registeredtype info
val from_registeredtypeinfo : Registered_type_info.t Ctypes.structure Ctypes.ptr->t Ctypes.structure Ctypes.ptr
Return a Struct_info.t from a Registered_type_info.t, the underlying C structure ref count is increased and the value is Gc.finalis"ed" with Registered_type_info.registeredtypeinfo_unref.
val to_registeredtypeinfo : t Ctypes.structure Ctypes.ptr->Registered_type_info.t Ctypes.structure Ctypes.ptr
Return a Registered_type_info.t form a Struct_info, the underlying C structure ref count is increased and the value is Gc.finalis"ed" with Registered_type_info.registeredtypeinfo_unref.
\ No newline at end of file
diff --git a/docs/GObject_introspection/Stubs/Arg_info/index.html b/docs/GObject_introspection/Stubs/Arg_info/index.html
deleted file mode 100644
index 83a91b3..0000000
--- a/docs/GObject_introspection/Stubs/Arg_info/index.html
+++ /dev/null
@@ -1,2 +0,0 @@
-
-Arg_info (gobject-introspection.GObject_introspection.Stubs.Arg_info)
\ No newline at end of file
diff --git a/docs/GObject_introspection/Type_info/index.html b/docs/GObject_introspection/Type_info/index.html
deleted file mode 100644
index 83d7fc6..0000000
--- a/docs/GObject_introspection/Type_info/index.html
+++ /dev/null
@@ -1,2 +0,0 @@
-
-Type_info (gobject-introspection.GObject_introspection.Type_info)
Module GObject_introspection.Type_info
type t
Type_info represents a type. You can retrieve a type info from an argument (see Arg_info), a function return value (see Function_info), a field (see Field_info), a property (see Property_info), a constant (see Constant_info) or for a union discriminator (see Union_info). A type can either be a of a basic type which is a standard C primitive type or an interface type. For interface types you need to call Type_info.get_interface to get a reference to the base info for that interface.
val to_string : t Ctypes.structure Ctypes.ptr-> string
Obtain a string representation of type.
val is_pointer : t Ctypes.structure Ctypes.ptr-> bool
Obtain if the type is passed as a reference. Note that the types of GI_DIRECTION_OUT and GI_DIRECTION_INOUT parameters will only be pointers if the underlying type being transferred is a pointer (i.e. only if the type of the C function’s formal parameter is a pointer to a pointer).
Obtain the array type for this type. See GIArrayType for a list of possible values. If the type tag of this type is not array, None will be returned.
val unsafe_get_param_type : t Ctypes.structure Ctypes.ptr-> int ->t Ctypes.structure Ctypes.ptr
Obtain the parameter type n. It is used to get the parameter type of generic * container. For example if the current Type_info.t is an array, a GList, a * GSList or an Hash, you have to use this in order to get the Type_info.t of * the data of the container. * Basicaly it is done with Type_info.get_param_type type_info 0 . * https://github.com/GNOME/pygobject/blob/288bd2957916568666c3d5d27e8c868d67b7e8c9/gi/pygi-argument.c#L526 * https://github.com/ruby-gnome2/ruby-gnome2/blob/ec4160b4f4c5432c6ff8a9e962e7ffeacfd48869/gobject-introspection/ext/gobject-introspection/rb-gi-argument.c#L928 * This function is unsafe meanings that it is your responsability to not use * a number out of bounds.
val get_param_type : t Ctypes.structure Ctypes.ptr->t Ctypes.structure Ctypes.ptr
This is just an alias to Type_info.unsage_get_param_type with the index set to 0.
val get_interface : t Ctypes.structure Ctypes.ptr->Base_info.t Ctypes.structure Ctypes.ptr option
For types which have Types.Interface such as GObjects and boxed values, this function returns full information about the referenced type. You can then inspect the type of the returned Base_info to further query whether it is a concrete GObject, a GInterface, a structure, etc. using Base_info.get_type.
val cast_from_baseinfo : Base_info.t Ctypes.structure Ctypes.ptr->t Ctypes.structure Ctypes.ptr
Just cast OCaml Ctypes base info to typeinfo.
val cast_to_baseinfo : t Ctypes.structure Ctypes.ptr->Base_info.t Ctypes.structure Ctypes.ptr
Just cast OCaml Ctypes typeinfo to base info
val add_unref_finaliser : t Ctypes.structure Ctypes.ptr->t Ctypes.structure Ctypes.ptr
Add unref of the C underlying structure whith Gc.finalise.
val from_baseinfo : Base_info.t Ctypes.structure Ctypes.ptr->t Ctypes.structure Ctypes.ptr
Return a Type_info.t from a Base_info.t, the underlying C structure ref count is increased and the value is Gc.finalis"ed" with Base_info.baseinfo_unref.
val to_baseinfo : t Ctypes.structure Ctypes.ptr->Base_info.t Ctypes.structure Ctypes.ptr
Return a Base_info.t form a Type_info, the underlying C structure ref count is increased and the value is Gc.finalis"ed" with Base_info.baseinfo_unref.
\ No newline at end of file
diff --git a/docs/GObject_introspection/Types/index.html b/docs/GObject_introspection/Types/index.html
deleted file mode 100644
index f710d2c..0000000
--- a/docs/GObject_introspection/Types/index.html
+++ /dev/null
@@ -1,2 +0,0 @@
-
-Types (gobject-introspection.GObject_introspection.Types)
val v_boolean : (bool, argument_t Ctypes.union) Ctypes.field
val v_int8 : (int, argument_t Ctypes.union) Ctypes.field
val v_uint8 : (Unsigned.uint8, argument_t Ctypes.union) Ctypes.field
val v_int16 : (int, argument_t Ctypes.union) Ctypes.field
val v_uint16 : (Unsigned.uint16, argument_t Ctypes.union) Ctypes.field
val v_int32 : (int32, argument_t Ctypes.union) Ctypes.field
val v_uint32 : (Unsigned.uint32, argument_t Ctypes.union) Ctypes.field
val v_int64 : (int64, argument_t Ctypes.union) Ctypes.field
val v_uint64 : (Unsigned.uint64, argument_t Ctypes.union) Ctypes.field
val v_float : (float, argument_t Ctypes.union) Ctypes.field
val v_double : (float, argument_t Ctypes.union) Ctypes.field
val v_short : (int, argument_t Ctypes.union) Ctypes.field
val v_ushort : (Unsigned.ushort, argument_t Ctypes.union) Ctypes.field
val v_int : (int, argument_t Ctypes.union) Ctypes.field
val v_uint : (Unsigned.uint, argument_t Ctypes.union) Ctypes.field
val v_long : (Signed.long, argument_t Ctypes.union) Ctypes.field
val v_ulong : (Unsigned.ulong, argument_t Ctypes.union) Ctypes.field
val v_ssize : (PosixTypes.ssize_t, argument_t Ctypes.union) Ctypes.field
val v_size : (PosixTypes.size_t, argument_t Ctypes.union) Ctypes.field
val v_string : (string, argument_t Ctypes.union) Ctypes.field
val v_pointer : (unit Ctypes_static.ptr option, argument_t Ctypes.union) Ctypes.field
\ No newline at end of file
diff --git a/docs/GObject_introspection/Union_info/index.html b/docs/GObject_introspection/Union_info/index.html
deleted file mode 100644
index a64a551..0000000
--- a/docs/GObject_introspection/Union_info/index.html
+++ /dev/null
@@ -1,2 +0,0 @@
-
-Union_info (gobject-introspection.GObject_introspection.Union_info)
Module GObject_introspection.Union_info
type t
Union_info represents a union type. A union has methods and fields. Unions can optionally have a discriminator, which is a field deciding what type of real union fields is valid for specified instance.
val get_n_fields : t Ctypes.structure Ctypes.ptr-> int
Obtain the number of fields this union has.
val get_size : t Ctypes.structure Ctypes.ptr-> int
Obtain the total size of the union.
val get_alignment : t Ctypes.structure Ctypes.ptr-> int
Obtain the required alignment of the union.
val get_n_methods : t Ctypes.structure Ctypes.ptr-> int
Obtain the number of methods this union has.
val get_field : t Ctypes.structure Ctypes.ptr-> int ->Field_info.t Ctypes.structure Ctypes.ptr
Obtain the type information for field with specified index.
val get_method : t Ctypes.structure Ctypes.ptr-> int ->Function_info.t Ctypes.structure Ctypes.ptr
Obtain the type information for method with specified index.
val find_method : t Ctypes.structure Ctypes.ptr-> string ->Function_info.t Ctypes.structure Ctypes.ptr option
Obtain the type information for method named name .
val is_discriminated : t Ctypes.structure Ctypes.ptr-> bool
Return true if this union contains discriminator field.
val get_discriminator_offset : t Ctypes.structure Ctypes.ptr-> int
Returns offset of the discriminator field in the structure.
val get_discriminator_type : t Ctypes.structure Ctypes.ptr->Type_info.t Ctypes.structure Ctypes.ptr
Obtain the type information of the union discriminator.
val get_discriminator : t Ctypes.structure Ctypes.ptr-> int ->Constant_info.t Ctypes.structure Ctypes.ptr
Obtain discriminator value assigned for n-th union field, i.e. n-th union field is the active one if discriminator contains this constant.
val cast_from_baseinfo : Base_info.t Ctypes.structure Ctypes.ptr->t Ctypes.structure Ctypes.ptr
Just cast OCaml Ctypes base info to union info.
val cast_to_baseinfo : t Ctypes.structure Ctypes.ptr->Base_info.t Ctypes.structure Ctypes.ptr
Just cast OCaml Ctypes union info to base info
val from_baseinfo : Base_info.t Ctypes.structure Ctypes.ptr->t Ctypes.structure Ctypes.ptr
Return a Union_info.t from a Base_info.t, the underlying C structure ref count is increased and the value is Gc.finalis"ed" with Base_info.baseinfo_unref.
val to_baseinfo : t Ctypes.structure Ctypes.ptr->Base_info.t Ctypes.structure Ctypes.ptr
Return a Base_info.t form a Union_info, the underlying C structure ref count is increased and the value is Gc.finalis"ed" with Base_info.baseinfo_unref.
val cast_from_registeredtypeinfo : Registered_type_info.t Ctypes.structure Ctypes.ptr->t Ctypes.structure Ctypes.ptr
Just cast OCaml Ctypes registeredtype info to union info.
val cast_to_registeredtypeinfo : t Ctypes.structure Ctypes.ptr->Registered_type_info.t Ctypes.structure Ctypes.ptr
Just cast OCaml Ctypes union info to registeredtype info
val from_registeredtypeinfo : Registered_type_info.t Ctypes.structure Ctypes.ptr->t Ctypes.structure Ctypes.ptr
Return a Union_info.t from a Registered_type_info.t, the underlying C structure ref count is increased and the value is Gc.finalis"ed" with Registered_type_info.registeredtypeinfo_unref.
val to_registeredtypeinfo : t Ctypes.structure Ctypes.ptr->Registered_type_info.t Ctypes.structure Ctypes.ptr
Return a Registered_type_info.t form a Union_info, the underlying C structure ref count is increased and the value is Gc.finalis"ed" with Registered_type_info.registeredtypeinfo_unref.
\ No newline at end of file
diff --git a/docs/GObject_introspection/Utils/index.html b/docs/GObject_introspection/Utils/index.html
deleted file mode 100644
index 44b4170..0000000
--- a/docs/GObject_introspection/Utils/index.html
+++ /dev/null
@@ -1,2 +0,0 @@
-
-Utils (gobject-introspection.GObject_introspection.Utils)
Module GObject_introspection.Utils
val flags_list_of_int64 : (int64 * 'a) list-> int64 ->'a list
val int64_of_flags_list : (int64 * 'a) list->'a list-> int64
val generate_flags_list_view : int64 Ctypes.typ->(int64 * 'a) list->'a list Ctypes.typ
\ No newline at end of file
diff --git a/docs/GObject_introspection/VFunc_info/index.html b/docs/GObject_introspection/VFunc_info/index.html
deleted file mode 100644
index d9961bd..0000000
--- a/docs/GObject_introspection/VFunc_info/index.html
+++ /dev/null
@@ -1,2 +0,0 @@
-
-VFunc_info (gobject-introspection.GObject_introspection.VFunc_info)
Module GObject_introspection.VFunc_info
type t
GIVfuncInfo represents a virtual function. A property belongs to either a Object_info or a Interface_info.
val get_offset : t Ctypes.structure Ctypes.ptr-> int
Obtain the offset of the function pointer in the class struct. The value 0xFFFF indicates that the struct offset is unknown.
val get_signal : t Ctypes.structure Ctypes.ptr->Callable_info.t Ctypes.structure Ctypes.ptr option
Obtain the signal for the virtual function if one is set. The signal comes from the object or interface to which this virtual function belongs. In order to avoid circular call graph between VFunc_info and Signal_info, this function will return a Callable_info. It is upto the user to use Signal_info.from_callableinfo in order to have the Signal_info.
Obtain the flags for this virtual function info. See VFunc_infoFlags for more information about possible flag values.
val cast_from_baseinfo : Base_info.t Ctypes.structure Ctypes.ptr->t Ctypes.structure Ctypes.ptr
Just cast OCaml Ctypes base info to vfunc info.
val cast_to_baseinfo : t Ctypes.structure Ctypes.ptr->Base_info.t Ctypes.structure Ctypes.ptr
Just cast OCaml Ctypes vfunc info to base info
val add_unref_finaliser : t Ctypes.structure Ctypes.ptr->t Ctypes.structure Ctypes.ptr
Add unref of the C underlying structure whith Gc.finalise.
val from_baseinfo : Base_info.t Ctypes.structure Ctypes.ptr->t Ctypes.structure Ctypes.ptr
Return a VFunc_info.t from a Base_info.t, the underlying C structure ref count is increased and the value is Gc.finalis"ed" with Base_info.baseinfo_unref.
val to_baseinfo : t Ctypes.structure Ctypes.ptr->Base_info.t Ctypes.structure Ctypes.ptr
Return a Base_info.t from a VFunc_info, the underlying C structure ref count is increased and the value is Gc.finalis"ed" with Base_info.baseinfo_unref.
val cast_from_callableinfo : Callable_info.t Ctypes.structure Ctypes.ptr->t Ctypes.structure Ctypes.ptr
Just cast OCaml Ctypes callable info to vfunc info.
val cast_to_callableinfo : t Ctypes.structure Ctypes.ptr->Callable_info.t Ctypes.structure Ctypes.ptr
Just cast OCaml Ctypes vfunc info to callable info
val from_callableinfo : Callable_info.t Ctypes.structure Ctypes.ptr->t Ctypes.structure Ctypes.ptr
Return a VFunc_info.t from a Callable_info.t, the underlying C structure ref count is increased and the value is Gc.finalis"ed" with Base_info.baseinfo_unref.
val to_callableinfo : t Ctypes.structure Ctypes.ptr->Callable_info.t Ctypes.structure Ctypes.ptr
Return a Callable_info.t from a VFunc_info, the underlying C structure ref count is increased and the value is Gc.finalis"ed" with Base_info.baseinfo_unref.
\ No newline at end of file
diff --git a/docs/GObject_introspection/Value_info/index.html b/docs/GObject_introspection/Value_info/index.html
deleted file mode 100644
index d748203..0000000
--- a/docs/GObject_introspection/Value_info/index.html
+++ /dev/null
@@ -1,2 +0,0 @@
-
-Value_info (gobject-introspection.GObject_introspection.Value_info)
val get_value : t Ctypes.structure Ctypes.ptr-> int64
Obtain the enumeration value of the Value_info.
val cast_from_baseinfo : Base_info.t Ctypes.structure Ctypes.ptr->t Ctypes.structure Ctypes.ptr
Just cast OCaml Ctypes base info to enum info.
val cast_to_baseinfo : t Ctypes.structure Ctypes.ptr->Base_info.t Ctypes.structure Ctypes.ptr
Just cast OCaml Ctypes enum info to base info
val add_unref_finaliser : t Ctypes.structure Ctypes.ptr->t Ctypes.structure Ctypes.ptr
Add unref of the C underlying structure whith Gc.finalise.
val from_baseinfo : Base_info.t Ctypes.structure Ctypes.ptr->t Ctypes.structure Ctypes.ptr
Return a Struct_info.t from a Base_info.t, the underlying C structure ref count is increased and the value is Gc.finalis"ed" with Base_info.baseinfo_unref.
val to_baseinfo : t Ctypes.structure Ctypes.ptr->Base_info.t Ctypes.structure Ctypes.ptr
Return a Base_info.t form a Struct_info, the underlying C structure ref count is increased and the value is Gc.finalis"ed" with Base_info.baseinfo_unref.
\ No newline at end of file
diff --git a/docs/GObject_introspection/Version/index.html b/docs/GObject_introspection/Version/index.html
deleted file mode 100644
index 6955646..0000000
--- a/docs/GObject_introspection/Version/index.html
+++ /dev/null
@@ -1,2 +0,0 @@
-
-Version (gobject-introspection.GObject_introspection.Version)
Module GObject_introspection.Version
val get_major_version : unit -> int
* Returns the major version number of the girepository library. (e.g. in version 1.58.2 this is 1.) *
val get_minor_version : unit -> int
* Returns the minor version number of the girepository library. (e.g. in version 1.58.2 this is 58.) *
val get_micro_version : unit -> int
* Returns the micro version number of the girepository library. (e.g. in version 1.58.2 this is 2.) *
\ No newline at end of file
diff --git a/docs/GObject_introspection/index.html b/docs/GObject_introspection/index.html
deleted file mode 100644
index f1f2ba6..0000000
--- a/docs/GObject_introspection/index.html
+++ /dev/null
@@ -1,2 +0,0 @@
-
-GObject_introspection (gobject-introspection.GObject_introspection)
Obtain the direction of the argument. Check GIDirection for possible direction values.
val get_closure : t Ctypes.structure Ctypes.ptr-> int
Obtain the index of the user data argument. This is only valid for arguments which are callbacks. Returns index of the user data argument or -1 if there is none.
val get_destroy : t Ctypes.structure Ctypes.ptr-> int
Obtains the index of the GDestroyNotify argument. This is only valid for arguments which are callbacks. Returns index of the GDestroyNotify argument or -1 if there is none
Obtain the ownership transfer for this argument. GITransfer contains a list of possible values.
val may_be_null : t Ctypes.structure Ctypes.ptr-> bool
Obtain if the type of the argument includes the possibility of NULL. For 'in' values this means that NULL is a valid value. For 'out' values, this means that NULL may be returned. See also Arg_info.is_optional.
val is_caller_allocates : t Ctypes.structure Ctypes.ptr-> bool
Obtain if the argument is a pointer to a struct or object that will receive an output of a function. The default assumption for Arg_info.Out arguments which have allocation is that the callee allocates; if this is TRUE, then the caller must allocate.
val is_optional : t Ctypes.structure Ctypes.ptr-> bool
Obtain if the argument is optional. For 'out' arguments this means that you can pass NULL in order to ignore the result.
val is_return_value : t Ctypes.structure Ctypes.ptr-> bool
Obtain if the argument is a return value. It can either be a parameter or a return value.
val is_skip : t Ctypes.structure Ctypes.ptr-> bool
Return a Arg_info.t from a Base_info.t, the underlying C structure ref count is increased and the value is Gc.finalis"ed" with Base_info.baseinfo_unref.
val base_info_ref : t Ctypes.structure Ctypes.ptr->t Ctypes.structure Ctypes.ptr
Increases the reference count of underlying Base_info *info.
val base_info_unref : t Ctypes.structure Ctypes.ptr-> unit
Decreases the reference count of underlying Base_info *info . When its reference count drops to 0, the info is freed.
val get_name : t Ctypes.structure Ctypes.ptr->string option
Obtain the name of the info . What the name represents depends on the GIInfoType of the info . For instance for Function_info it is the name of the function.
val equal : t Ctypes.structure Ctypes.ptr->t Ctypes.structure Ctypes.ptr-> bool
Compare two Base_info. Using pointer comparison is not practical since many functions return different instances of Base_info that refers to the same part of the TypeLib; use this function instead to do Base_info comparisons.
val get_namespace : t Ctypes.structure Ctypes.ptr-> string
Obtain the namespace of info
val is_deprecated : t Ctypes.structure Ctypes.ptr-> bool
Obtain whether the info is represents a metadata which is deprecated or not.
val get_container : t Ctypes.structure Ctypes.ptr->t Ctypes.structure Ctypes.ptr option
Obtain the container of the info . The container is the parent Base_info. For instance, the parent of a Function_info is an Object_info or Interface_info.
val enum : string ->?typedef:bool->?unexpected:(int64 ->'a)->('a * int64 const) list->'atyp
\ No newline at end of file
diff --git a/docs/GObject_introspection__Callable_info/.dune-keep b/docs/GObject_introspection__Callable_info/.dune-keep
deleted file mode 100644
index e69de29..0000000
diff --git a/docs/GObject_introspection__Callable_info/index.html b/docs/GObject_introspection__Callable_info/index.html
deleted file mode 100644
index 734dc5a..0000000
--- a/docs/GObject_introspection__Callable_info/index.html
+++ /dev/null
@@ -1,2 +0,0 @@
-
-GObject_introspection__Callable_info (gobject-introspection.GObject_introspection__Callable_info)
Module GObject_introspection__Callable_info
Callable_info — Struct representing a callable.
type t
Callable_info represents an entity which is callable. Currently a function (Function_info), virtual function, (VFunc_info) or callback (GICallbackInfo). A callable has a list of arguments (Arg_info), a return type, direction and a flag which decides if it returns null
val can_throw_gerror : t Ctypes.structure Ctypes.ptr-> bool
Does the function throws an error.
val get_n_args : t Ctypes.structure Ctypes.ptr-> int
Obtain the number of arguments (both IN and OUT) for this callable.
val get_return_attribute : t Ctypes.structure Ctypes.ptr->string option
Retrieve an arbitrary attribute associated with the return value.
val is_method : t Ctypes.structure Ctypes.ptr-> bool
Determines if the callable info is a method. For VFunc_infos, GICallbackInfos, and Signal_infos, this is always true. Otherwise, this looks at the Function_info.Is_method flag on the Function_info. Concretely, this function returns whether Callable_info.get_n_args matches the number of arguments in the raw C method. For methods, there is one more C argument than is exposed by introspection: the "self" or "this" object.
val may_return_null : t Ctypes.structure Ctypes.ptr-> bool
See if a callable could return NULL.
val skip_return : t Ctypes.structure Ctypes.ptr-> bool
See if a callable's return value is only useful in C.
Return a Function_info.t from a Base_info.t, the underlying C structure ref count is increased and the value is Gc.finalis"ed" with Base_info.baseinfo_unref.
Return a Base_info.t from a Function_info, the underlying C structure ref count is increased and the value is Gc.finalis"ed" with Base_info.baseinfo_unref.
\ No newline at end of file
diff --git a/docs/GObject_introspection__Constant_info/.dune-keep b/docs/GObject_introspection__Constant_info/.dune-keep
deleted file mode 100644
index e69de29..0000000
diff --git a/docs/GObject_introspection__Constant_info/index.html b/docs/GObject_introspection__Constant_info/index.html
deleted file mode 100644
index 82af529..0000000
--- a/docs/GObject_introspection__Constant_info/index.html
+++ /dev/null
@@ -1,2 +0,0 @@
-
-GObject_introspection__Constant_info (gobject-introspection.GObject_introspection__Constant_info)
Module GObject_introspection__Constant_info
Constant_info — Struct representing a constant
type t
Constant_info represents a constant. A constant has a type associated which can be obtained by calling Constant_info.get_type and a value, which can be obtained by calling GIConstant.get_value.
Return a Constant_info.t from a Base_info.t, the underlying C structure ref count is increased and the value is Gc.finalis"ed" with Base_info.baseinfo_unref.
Return a Base_info.t form a Constant_info, the underlying C structure ref count is increased and the value is Gc.finalis"ed" with Base_info.baseinfo_unref.
Obtain the value associated with the Constant_info and store it in the value parameter. argument needs to be allocated before passing it in. The size of the constant value stored in argument will be returned. Free the value with Constant_info.free_value.
\ No newline at end of file
diff --git a/docs/GObject_introspection__Conversions/.dune-keep b/docs/GObject_introspection__Conversions/.dune-keep
deleted file mode 100644
index e69de29..0000000
diff --git a/docs/GObject_introspection__Conversions/index.html b/docs/GObject_introspection__Conversions/index.html
deleted file mode 100644
index aa31599..0000000
--- a/docs/GObject_introspection__Conversions/index.html
+++ /dev/null
@@ -1,2 +0,0 @@
-
-GObject_introspection__Conversions (gobject-introspection.GObject_introspection__Conversions)
Module GObject_introspection__Conversions
Conversions functions
type carray_of_strings = char Ctypes.ptr Ctypes.ptr
val g_slist_data : (gslist, [ `Struct ]) Ctypes.structured Ctypes.ptr->unit Ctypes_static.ptr
Get the void ptr data of the current element
val gslist_of_strings_to_list : (gslist, [ `Struct ]) Ctypes.structured Ctypes.ptr->string list
Transform a GSList of strings to an OCaml list of strings
\ No newline at end of file
diff --git a/docs/GObject_introspection__Enum_info/.dune-keep b/docs/GObject_introspection__Enum_info/.dune-keep
deleted file mode 100644
index e69de29..0000000
diff --git a/docs/GObject_introspection__Enum_info/index.html b/docs/GObject_introspection__Enum_info/index.html
deleted file mode 100644
index fa1f06d..0000000
--- a/docs/GObject_introspection__Enum_info/index.html
+++ /dev/null
@@ -1,2 +0,0 @@
-
-GObject_introspection__Enum_info (gobject-introspection.GObject_introspection__Enum_info)
Module GObject_introspection__Enum_info
Enum_info — Structs representing an enumeration and its values
type t
A Enum_info represents an enumeration and a Value_info struct represents a value of an enumeration. The Enum_info contains a set of values and a type The Value_info is fetched by calling Enum_info.get_value on a Enum_info.
Obtain the tag of the type used for the enum in the C ABI. This will be a signed or unsigned integral type. Note that in the current implementation the width of the type is computed correctly, but the signed or unsigned nature of the type may not match the sign of the type used by the C compiler.
Return a Enum_info.t from a Base_info.t, the underlying C structure ref count is increased and the value is Gc.finalis"ed" with Base_info.baseinfo_unref.
Return a Base_info.t form a Enum_info, the underlying C structure ref count is increased and the value is Gc.finalis"ed" with Base_info.baseinfo_unref.
Return a Enum_info.t from a Registered_type_info.t, the underlying C structure ref count is increased and the value is Gc.finalis"ed" with Registered_type_info.registeredtypeinfo_unref.
Return a Registered_type_info.t form a Enum_info, the underlying C structure ref count is increased and the value is Gc.finalis"ed" with Registered_type_info.registeredtypeinfo_unref.
\ No newline at end of file
diff --git a/docs/GObject_introspection__Field_info/.dune-keep b/docs/GObject_introspection__Field_info/.dune-keep
deleted file mode 100644
index e69de29..0000000
diff --git a/docs/GObject_introspection__Field_info/index.html b/docs/GObject_introspection__Field_info/index.html
deleted file mode 100644
index d546fcd..0000000
--- a/docs/GObject_introspection__Field_info/index.html
+++ /dev/null
@@ -1,2 +0,0 @@
-
-GObject_introspection__Field_info (gobject-introspection.GObject_introspection__Field_info)
Module GObject_introspection__Field_info
Field_info — Struct representing a struct or union field
type t
A Field_info struct represents a field of a struct (see Struct_info), union (see Union_info) or an object (see Object_info). The Field_info is fetched by calling Struct_info.get_field, Union_info.get_field or Object_info.get_field. A field has a size, type and a struct offset asssociated and a set of flags, which is currently GI_FIELD_IS_READABLE or GI_FIELD_IS_WRITABLE.
Return a Field_info.t from a Base_info.t, the underlying C structure ref count is increased and the value is Gc.finalis"ed" with Base_info.baseinfo_unref.
Return a Base_info.t from a Field_info, the underlying C structure ref count is increased and the value is Gc.finalis"ed" with Base_info.baseinfo_unref.
\ No newline at end of file
diff --git a/docs/GObject_introspection__Function_info/.dune-keep b/docs/GObject_introspection__Function_info/.dune-keep
deleted file mode 100644
index e69de29..0000000
diff --git a/docs/GObject_introspection__Function_info/index.html b/docs/GObject_introspection__Function_info/index.html
deleted file mode 100644
index b3a75c8..0000000
--- a/docs/GObject_introspection__Function_info/index.html
+++ /dev/null
@@ -1,2 +0,0 @@
-
-GObject_introspection__Function_info (gobject-introspection.GObject_introspection__Function_info)
Module GObject_introspection__Function_info
Function_info — Struct representing a function.
type t
Function_info represents a function, method or constructor. To find out what kind of entity a Function_info represents, call Function_info.get_flags. See also Callable_info for information on how to retreive arguments and other metadata.
Obtain the property associated with this Function_info. Only Function_info with the flag GIFunction.Is_getter or GIFunction.Is_setter have a property set. For other cases, NULL will be returned.
Obtain the virtual function associated with this Function_info. Only Function_info with the flag Wraps_vfunc has a virtual function set. For other cases, None will be returned. In order to avoid circular call graph between Function_info and VFunc_info, this function will return a Callable_info. It is upto the user to use VFunc_info.from_callableinfo in order to have the VFunc_info.
Return a Function_info.t from a Base_info.t, the underlying C structure ref count is increased and the value is Gc.finalis"ed" with Base_info.baseinfo_unref.
Return a Base_info.t from a Function_info, the underlying C structure ref count is increased and the value is Gc.finalis"ed" with Base_info.baseinfo_unref.
Return a Function_info.t from a Callable_info.t, the underlying C structure ref count is increased and the value is Gc.finalis"ed" with Base_info.baseinfo_unref.
Return a Callable_info.t from a Function_info, the underlying C structure ref count is increased and the value is Gc.finalis"ed" with Base_info.baseinfo_unref.
\ No newline at end of file
diff --git a/docs/GObject_introspection__GParam/.dune-keep b/docs/GObject_introspection__GParam/.dune-keep
deleted file mode 100644
index e69de29..0000000
diff --git a/docs/GObject_introspection__GParam/index.html b/docs/GObject_introspection__GParam/index.html
deleted file mode 100644
index 9541216..0000000
--- a/docs/GObject_introspection__GParam/index.html
+++ /dev/null
@@ -1,2 +0,0 @@
-
-GObject_introspection__GParam (gobject-introspection.GObject_introspection__GParam)
\ No newline at end of file
diff --git a/docs/GObject_introspection__Interface_info/.dune-keep b/docs/GObject_introspection__Interface_info/.dune-keep
deleted file mode 100644
index e69de29..0000000
diff --git a/docs/GObject_introspection__Interface_info/index.html b/docs/GObject_introspection__Interface_info/index.html
deleted file mode 100644
index 22773b3..0000000
--- a/docs/GObject_introspection__Interface_info/index.html
+++ /dev/null
@@ -1,2 +0,0 @@
-
-GObject_introspection__Interface_info (gobject-introspection.GObject_introspection__Interface_info)
Module GObject_introspection__Interface_info
Interface_info — Struct representing a GInterface
type t
Interface_info represents a GInterface type. A GInterface has methods, fields, properties, signals, interfaces, constants, virtual functions and prerequisites.
val get_n_prerequisites : t Ctypes.structure Ctypes.ptr-> int
Obtain the number of prerequisites for this interface type. A prerequisites is another interface that needs to be implemented for interface, similar to an base class for GObjects.
Return a Interface_info.t from a Base_info.t, the underlying C structure ref count is increased and the value is Gc.finalis"ed" with Base_info.baseinfo_unref.
Return a Base_info.t from a Interface_info, the underlying C structure ref count is increased and the value is Gc.finalis"ed" with Base_info.baseinfo_unref.
Return a Interface_info.t from a Registered_type_info.t, the underlying C structure ref count is increased and the value is Gc.finalis"ed" with Registered_type_info.registeredtypeinfo_unref.
Return a Registered_type_info.t form a Interface_info, the underlying C structure ref count is increased and the value is Gc.finalis"ed" with Registered_type_info.registeredtypeinfo_unref.
\ No newline at end of file
diff --git a/docs/GObject_introspection__Object_info/.dune-keep b/docs/GObject_introspection__Object_info/.dune-keep
deleted file mode 100644
index e69de29..0000000
diff --git a/docs/GObject_introspection__Object_info/index.html b/docs/GObject_introspection__Object_info/index.html
deleted file mode 100644
index 8d5c317..0000000
--- a/docs/GObject_introspection__Object_info/index.html
+++ /dev/null
@@ -1,2 +0,0 @@
-
-GObject_introspection__Object_info (gobject-introspection.GObject_introspection__Object_info)
Module GObject_introspection__Object_info
Object_info — Struct representing a GObject
type t
Object_info represents a GObject. This doesn't represent a specific instance of a GObject, instead this represent the object type (eg class). A GObject has methods, fields, properties, signals, interfaces, constants and virtual functions.
Locate a virtual function slot with name name . Note that the namespace for virtuals is distinct from that of methods; there may or may not be a concrete method associated for a virtual. If there is one, it may be retrieved using VFunc_info.get_invoker, otherwise None will be returned. See the documentation for VFunc_info.get_invoker for more information on invoking virtuals.
Every GObject has two structures; an instance structure and a class structure. This function returns the metadata for the class structure. It returns a Struct_info.t or None.
val find_method_using_interfaces : t Ctypes.structure Ctypes.ptr-> string ->GObject_introspection.Function_info.t Ctypes.structure Ctypes.ptr option * t Ctypes.structure Ctypes.ptr option
Obtain a method of the object given a name , searching both the object info and any interfaces it implements. None will be returned if there's no method available with that name. Note that this function does *not* search parent classes; you will have to chain up if that's desired.
val get_ref_function : t Ctypes.structure Ctypes.ptr->string option
Obtain the symbol name of the function that should be called to ref this object type. It's mainly used fundamental types. The type signature for the symbol is Object_infoRefFunction, to fetch the function pointer see Object_info.get_ref_function.
val get_unref_function : t Ctypes.structure Ctypes.ptr->string option
Obtain the symbol name of the function that should be called to unref this object type. It's mainly used fundamental types. The type signature for the symbol is Object_infoUnrefFunction, to fetch the function pointer see Object_info.get_unref_function.
val get_set_value_function : t Ctypes.structure Ctypes.ptr->string option
Obtain the symbol name of the function that should be called to convert set a GValue giving an object instance pointer of this object type. I's mainly used fundamental types. The type signature for the symbol is Object_infoSetValueFunction, to fetch the function pointer see Object_info.get_set_value_function.
val get_get_value_function : t Ctypes.structure Ctypes.ptr->string option
Obtain the symbol name of the function that should be called to convert an object instance pointer of this object type to a GValue. I's mainly used fundamental types. The type signature for the symbol is Object_infoGetValueFunction, to fetch the function pointer see Object_info.get_get_value_function.
val find_vfunc_using_interfaces : t Ctypes.structure Ctypes.ptr-> string ->GObject_introspection.VFunc_info.t Ctypes.structure Ctypes.ptr option * t Ctypes.structure Ctypes.ptr option
Locate a virtual function slot with name name , searching both the object info and any interfaces it implements. Note that the namespace for virtuals is distinct from that of methods; there may or may not be a concrete method associated for a virtual. If there is one, it may be retrieved using g_vfunc_info_get_invoker(), otherwise None will be returned. Note that this function does *not* search parent classes; you will have to chain up if that's desired.
Return a Object_info.t from a Base_info.t, the underlying C structure ref count is increased and the value is Gc.finalis"ed" with Base_info.baseinfo_unref.
Return a Base_info.t from a Object_info, the underlying C structure ref count is increased and the value is Gc.finalis"ed" with Base_info.baseinfo_unref.
Return a Object_info.t from a Registered_type_info.t, the underlying C structure ref count is increased and the value is Gc.finalis"ed" with Registered_type_info.registeredtypeinfo_unref.
Return a Registered_type_info.t form a Object_info, the underlying C structure ref count is increased and the value is Gc.finalis"ed" with Registered_type_info.registeredtypeinfo_unref.
\ No newline at end of file
diff --git a/docs/GObject_introspection__Property_info/.dune-keep b/docs/GObject_introspection__Property_info/.dune-keep
deleted file mode 100644
index e69de29..0000000
diff --git a/docs/GObject_introspection__Property_info/index.html b/docs/GObject_introspection__Property_info/index.html
deleted file mode 100644
index c0afa07..0000000
--- a/docs/GObject_introspection__Property_info/index.html
+++ /dev/null
@@ -1,2 +0,0 @@
-
-GObject_introspection__Property_info (gobject-introspection.GObject_introspection__Property_info)
Module GObject_introspection__Property_info
Property_info — Struct representing a property
type t
Property_info represents a property. A property belongs to either a Object_info or a Interface_info.
Return a Property_info.t from a Base_info.t, the underlying C structure ref count is increased and the value is Gc.finalis"ed" with Base_info.baseinfo_unref.
Return a Base_info.t from a Property_info, the underlying C structure ref count is increased and the value is Gc.finalis"ed" with Base_info.baseinfo_unref.
\ No newline at end of file
diff --git a/docs/GObject_introspection__Registered_type_info/.dune-keep b/docs/GObject_introspection__Registered_type_info/.dune-keep
deleted file mode 100644
index e69de29..0000000
diff --git a/docs/GObject_introspection__Registered_type_info/index.html b/docs/GObject_introspection__Registered_type_info/index.html
deleted file mode 100644
index 00080a1..0000000
--- a/docs/GObject_introspection__Registered_type_info/index.html
+++ /dev/null
@@ -1,2 +0,0 @@
-
-GObject_introspection__Registered_type_info (gobject-introspection.GObject_introspection__Registered_type_info)
Obtain the gtype for this registered type or None which a special meaning. It means that either there is no type information associated with this info or that the shared library which provides the type_init function for this info cannot be called.
val get_type_init : t Ctypes.structure Ctypes.ptr->string option
Obtain the type init function for info . The type init function is the function which will register the GType within the GObject type system. Usually this is not called by langauge bindings or applications, use Registered_type_info.get_g_type directly instead.
Return a Registered_type_info.t from a Base_info.t, the underlying C structure ref count is increased and the value is Gc.finalis"ed" with Base_info.baseinfo_unref.
Return a Base_info.t from a Registered_type_info, the underlying C structure ref count is increased and the value is Gc.finalis"ed" with Base_info.baseinfo_unref.
\ No newline at end of file
diff --git a/docs/GObject_introspection__Repository/.dune-keep b/docs/GObject_introspection__Repository/.dune-keep
deleted file mode 100644
index e69de29..0000000
diff --git a/docs/GObject_introspection__Repository/index.html b/docs/GObject_introspection__Repository/index.html
deleted file mode 100644
index 8a31b0b..0000000
--- a/docs/GObject_introspection__Repository/index.html
+++ /dev/null
@@ -1,2 +0,0 @@
-
-GObject_introspection__Repository (gobject-introspection.GObject_introspection__Repository)
Module GObject_introspection__Repository
Repository — GObject Introspection repository manager module Repository is used to manage repositories of namespaces. Namespaces are represented on disk by type libraries (.typelib files).
Returns the singleton process-global default Repository.
val require : ?repository:repository-> string ->?version:string-> unit ->(typelib, string) Stdlib.result
Force the namespace namespace_ to be loaded if it isn't already. If namespace_ is not loaded, this function will search for a ".typelib" file using the repository search path. In addition, a version version of namespace may be specified. If version is not specified, the latest will be used).
val get_loaded_namespaces : ?repository:repository-> unit ->string list
Return the list of currently loaded namespaces.
val get_dependencies : ?repository:repository-> string ->string list
Return an list of all (transitive) versioned dependencies for namespace_ . Returned strings are of the form namespace-version. Note: namespace_ must have already been loaded using a function such as Repository.require before calling this function. To get only the immediate dependencies for namespace_ , use Repository.get_immediate_dependencies.
val get_c_prefix : ?repository:repository-> string -> string
This function returns the "C prefix", or the C level namespace associated with the given introspection namespace. Each C symbol starts with this prefix, as well each GType in the library. Note: The namespace must have already been loaded using a function such as Repository.require before calling this function.
val get_version : ?repository:repository-> string -> string
This function returns the loaded version associated with the given namespace namespace_ . Note: The namespace must have already been loaded using a function such as Repository.require before calling this function.
val get_typelib_path : ?repository:repository-> string -> string
If namespace namespace_ is loaded, return the full path to the .typelib file it was loaded from. If the typelib for namespace namespace_ was included in a shared library, return the special string "<builtin>".
val enumerate_versions : ?repository:repository-> string ->string list
Obtain an unordered list of versions (either currently loaded or available) for namespace_ in this repository .
val get_search_path : unit ->string list
Returns the current search path Repository will use when loading typelib files. The list is internal to GIRespository and should not be freed, nor should its string elements.
val prepend_search_path : string -> unit
Prepends directory to the typelib search path. See Repository.get_search_path.
Searches for a particular entry in a namespace. Before calling this function for a particular namespace, you must call Repository.require once to load the namespace, or otherwise ensure the namespace has already been loaded.
val get_n_infos : ?repository:repository-> string -> int
This function returns the number of metadata entries in given namespace namespace_ . The namespace must have already been loaded before calling this function.
This function returns a particular metadata entry in the given namespace namespace_ . The namespace must have already been loaded before calling this function. See Repository.get_n_infos to find the maximum number of entries.
val get_shared_library : ?repository:repository-> string ->string option
This function returns a comma-separated list of paths to the shared C libraries associated with the given namespace namespace_ . There may be no shared library path associated, in which case this function will return NULL. Note: The namespace must have already been loaded using a function such as Repository.require before calling this function.
val prepend_library_path : string -> unit
Prepends directory to the search path that is used to search shared libraries referenced by imported namespaces. Multiple calls to this function all contribute to the final list of paths. The list of paths is unique and shared for all Repository instances across the process, but it doesn't affect namespaces imported before the call. If the library is not found in the directories configured in this way, loading will fall back to the system library path (ie. LD_LIBRARY_PATH and DT_RPATH in ELF systems). See the documentation of your dynamic linker for full details.
Searches all loaded namespaces for a particular #GType. Note that in order to locate the metadata, the namespace corresponding to the type must first have been loaded. There is currently no mechanism for determining the namespace which corresponds to an arbitrary GType - thus, this function will operate most reliably when you know the GType to originate from be from a loaded namespace.
\ No newline at end of file
diff --git a/docs/GObject_introspection__Signal_info/.dune-keep b/docs/GObject_introspection__Signal_info/.dune-keep
deleted file mode 100644
index e69de29..0000000
diff --git a/docs/GObject_introspection__Signal_info/index.html b/docs/GObject_introspection__Signal_info/index.html
deleted file mode 100644
index 7fd17df..0000000
--- a/docs/GObject_introspection__Signal_info/index.html
+++ /dev/null
@@ -1,2 +0,0 @@
-
-GObject_introspection__Signal_info (gobject-introspection.GObject_introspection__Signal_info)
Module GObject_introspection__Signal_info
Signal_info — Struct representing a signal.
type t
Signal_info represents a signal. It's a sub-struct of Callable_info and contains a set of flags and a class closure. See Callable_info for information on how to retreive arguments and other metadata from the signal.
Obtain the class closure for this signal if one is set. The class closure is a virtual function on the type that the signal belongs to. If the signal lacks a closure None will be returned. In order to avoid circular call graph between Signal_info and VFunc_info, this function will return a Callable_info. It is upto the user to use GIVSignalInfo.from_callableinfo in order to have the VFunc_info.
Return a Signal_info.t from a Base_info.t, the underlying C structure ref count is increased and the value is Gc.finalis"ed" with Base_info.baseinfo_unref.
Return a Base_info.t from a Signal_info, the underlying C structure ref count is increased and the value is Gc.finalis"ed" with Base_info.baseinfo_unref.
Return a Signal_info.t from a Callable_info.t, the underlying C structure ref count is increased and the value is Gc.finalis"ed" with Base_info.baseinfo_unref.
Return a Callable_info.t from a Signal_info, the underlying C structure ref count is increased and the value is Gc.finalis"ed" with Base_info.baseinfo_unref.
\ No newline at end of file
diff --git a/docs/GObject_introspection__Struct_info/.dune-keep b/docs/GObject_introspection__Struct_info/.dune-keep
deleted file mode 100644
index e69de29..0000000
diff --git a/docs/GObject_introspection__Struct_info/index.html b/docs/GObject_introspection__Struct_info/index.html
deleted file mode 100644
index 0ed8dae..0000000
--- a/docs/GObject_introspection__Struct_info/index.html
+++ /dev/null
@@ -1,2 +0,0 @@
-
-GObject_introspection__Struct_info (gobject-introspection.GObject_introspection__Struct_info)
Module GObject_introspection__Struct_info
Struct_info — Module representing a C structure
type t
Struct_info represents a generic C structure type. A structure has methods and fields.
val is_gtype_struct : t Ctypes.structure Ctypes.ptr-> bool
Return true if this structure represents the "class structure" for some GObject or GInterface. This function is mainly useful to hide this kind of structure from generated public APIs.
val get_alignment : t Ctypes.structure Ctypes.ptr-> int
Obtain the required alignment of the structure.
val get_size : t Ctypes.structure Ctypes.ptr-> int
Obtain the total size of the structure.
val is_foreign : t Ctypes.structure Ctypes.ptr-> bool
No doc yet
val get_n_fields : t Ctypes.structure Ctypes.ptr-> int
Obtain the number of fields this structure has.
val get_n_methods : t Ctypes.structure Ctypes.ptr-> int
Return a Struct_info.t from a Base_info.t, the underlying C structure ref count is increased and the value is Gc.finalis"ed" with Base_info.baseinfo_unref.
Return a Base_info.t form a Struct_info, the underlying C structure ref count is increased and the value is Gc.finalis"ed" with Base_info.baseinfo_unref.
Return a Struct_info.t from a Registered_type_info.t, the underlying C structure ref count is increased and the value is Gc.finalis"ed" with Registered_type_info.registeredtypeinfo_unref.
Return a Registered_type_info.t form a Struct_info, the underlying C structure ref count is increased and the value is Gc.finalis"ed" with Registered_type_info.registeredtypeinfo_unref.
\ No newline at end of file
diff --git a/docs/GObject_introspection__Stubs/.dune-keep b/docs/GObject_introspection__Stubs/.dune-keep
deleted file mode 100644
index e69de29..0000000
diff --git a/docs/GObject_introspection__Stubs/Arg_info/index.html b/docs/GObject_introspection__Stubs/Arg_info/index.html
deleted file mode 100644
index 6056eed..0000000
--- a/docs/GObject_introspection__Stubs/Arg_info/index.html
+++ /dev/null
@@ -1,2 +0,0 @@
-
-Arg_info (gobject-introspection.GObject_introspection__Stubs.Arg_info)
\ No newline at end of file
diff --git a/docs/GObject_introspection__Type_info/.dune-keep b/docs/GObject_introspection__Type_info/.dune-keep
deleted file mode 100644
index e69de29..0000000
diff --git a/docs/GObject_introspection__Type_info/index.html b/docs/GObject_introspection__Type_info/index.html
deleted file mode 100644
index cfdc747..0000000
--- a/docs/GObject_introspection__Type_info/index.html
+++ /dev/null
@@ -1,2 +0,0 @@
-
-GObject_introspection__Type_info (gobject-introspection.GObject_introspection__Type_info)
Module GObject_introspection__Type_info
Type_info — Struct representing a type
type t
Type_info represents a type. You can retrieve a type info from an argument (see Arg_info), a function return value (see Function_info), a field (see Field_info), a property (see Property_info), a constant (see Constant_info) or for a union discriminator (see Union_info). A type can either be a of a basic type which is a standard C primitive type or an interface type. For interface types you need to call Type_info.get_interface to get a reference to the base info for that interface.
val to_string : t Ctypes.structure Ctypes.ptr-> string
Obtain a string representation of type.
val is_pointer : t Ctypes.structure Ctypes.ptr-> bool
Obtain if the type is passed as a reference. Note that the types of GI_DIRECTION_OUT and GI_DIRECTION_INOUT parameters will only be pointers if the underlying type being transferred is a pointer (i.e. only if the type of the C function’s formal parameter is a pointer to a pointer).
Obtain the array type for this type. See GIArrayType for a list of possible values. If the type tag of this type is not array, None will be returned.
val unsafe_get_param_type : t Ctypes.structure Ctypes.ptr-> int ->t Ctypes.structure Ctypes.ptr
Obtain the parameter type n. It is used to get the parameter type of generic * container. For example if the current Type_info.t is an array, a GList, a * GSList or an Hash, you have to use this in order to get the Type_info.t of * the data of the container. * Basicaly it is done with Type_info.get_param_type type_info 0 . * https://github.com/GNOME/pygobject/blob/288bd2957916568666c3d5d27e8c868d67b7e8c9/gi/pygi-argument.c#L526 * https://github.com/ruby-gnome2/ruby-gnome2/blob/ec4160b4f4c5432c6ff8a9e962e7ffeacfd48869/gobject-introspection/ext/gobject-introspection/rb-gi-argument.c#L928 * This function is unsafe meanings that it is your responsability to not use * a number out of bounds.
val get_param_type : t Ctypes.structure Ctypes.ptr->t Ctypes.structure Ctypes.ptr
This is just an alias to Type_info.unsage_get_param_type with the index set to 0.
For types which have Types.Interface such as GObjects and boxed values, this function returns full information about the referenced type. You can then inspect the type of the returned Base_info to further query whether it is a concrete GObject, a GInterface, a structure, etc. using Base_info.get_type.
Return a Type_info.t from a Base_info.t, the underlying C structure ref count is increased and the value is Gc.finalis"ed" with Base_info.baseinfo_unref.
Return a Base_info.t form a Type_info, the underlying C structure ref count is increased and the value is Gc.finalis"ed" with Base_info.baseinfo_unref.
\ No newline at end of file
diff --git a/docs/GObject_introspection__Types/.dune-keep b/docs/GObject_introspection__Types/.dune-keep
deleted file mode 100644
index e69de29..0000000
diff --git a/docs/GObject_introspection__Types/index.html b/docs/GObject_introspection__Types/index.html
deleted file mode 100644
index 32fed7b..0000000
--- a/docs/GObject_introspection__Types/index.html
+++ /dev/null
@@ -1,2 +0,0 @@
-
-GObject_introspection__Types (gobject-introspection.GObject_introspection__Types)
val v_boolean : (bool, argument_t Ctypes.union) Ctypes.field
val v_int8 : (int, argument_t Ctypes.union) Ctypes.field
val v_uint8 : (Unsigned.uint8, argument_t Ctypes.union) Ctypes.field
val v_int16 : (int, argument_t Ctypes.union) Ctypes.field
val v_uint16 : (Unsigned.uint16, argument_t Ctypes.union) Ctypes.field
val v_int32 : (int32, argument_t Ctypes.union) Ctypes.field
val v_uint32 : (Unsigned.uint32, argument_t Ctypes.union) Ctypes.field
val v_int64 : (int64, argument_t Ctypes.union) Ctypes.field
val v_uint64 : (Unsigned.uint64, argument_t Ctypes.union) Ctypes.field
val v_float : (float, argument_t Ctypes.union) Ctypes.field
val v_double : (float, argument_t Ctypes.union) Ctypes.field
val v_short : (int, argument_t Ctypes.union) Ctypes.field
val v_ushort : (Unsigned.ushort, argument_t Ctypes.union) Ctypes.field
val v_int : (int, argument_t Ctypes.union) Ctypes.field
val v_uint : (Unsigned.uint, argument_t Ctypes.union) Ctypes.field
val v_long : (Signed.long, argument_t Ctypes.union) Ctypes.field
val v_ulong : (Unsigned.ulong, argument_t Ctypes.union) Ctypes.field
val v_ssize : (PosixTypes.ssize_t, argument_t Ctypes.union) Ctypes.field
val v_size : (PosixTypes.size_t, argument_t Ctypes.union) Ctypes.field
val v_string : (string, argument_t Ctypes.union) Ctypes.field
val v_pointer : (unit Ctypes_static.ptr option, argument_t Ctypes.union) Ctypes.field
\ No newline at end of file
diff --git a/docs/GObject_introspection__Union_info/.dune-keep b/docs/GObject_introspection__Union_info/.dune-keep
deleted file mode 100644
index e69de29..0000000
diff --git a/docs/GObject_introspection__Union_info/index.html b/docs/GObject_introspection__Union_info/index.html
deleted file mode 100644
index dccf864..0000000
--- a/docs/GObject_introspection__Union_info/index.html
+++ /dev/null
@@ -1,2 +0,0 @@
-
-GObject_introspection__Union_info (gobject-introspection.GObject_introspection__Union_info)
Module GObject_introspection__Union_info
Union_info — Module representing a C structure
type t
Union_info represents a union type. A union has methods and fields. Unions can optionally have a discriminator, which is a field deciding what type of real union fields is valid for specified instance.
Return a Union_info.t from a Base_info.t, the underlying C structure ref count is increased and the value is Gc.finalis"ed" with Base_info.baseinfo_unref.
Return a Base_info.t form a Union_info, the underlying C structure ref count is increased and the value is Gc.finalis"ed" with Base_info.baseinfo_unref.
Return a Union_info.t from a Registered_type_info.t, the underlying C structure ref count is increased and the value is Gc.finalis"ed" with Registered_type_info.registeredtypeinfo_unref.
Return a Registered_type_info.t form a Union_info, the underlying C structure ref count is increased and the value is Gc.finalis"ed" with Registered_type_info.registeredtypeinfo_unref.
\ No newline at end of file
diff --git a/docs/GObject_introspection__Utils/.dune-keep b/docs/GObject_introspection__Utils/.dune-keep
deleted file mode 100644
index e69de29..0000000
diff --git a/docs/GObject_introspection__Utils/index.html b/docs/GObject_introspection__Utils/index.html
deleted file mode 100644
index 6203a37..0000000
--- a/docs/GObject_introspection__Utils/index.html
+++ /dev/null
@@ -1,2 +0,0 @@
-
-GObject_introspection__Utils (gobject-introspection.GObject_introspection__Utils)
Module GObject_introspection__Utils
val flags_list_of_int64 : (int64 * 'a) list-> int64 ->'a list
val int64_of_flags_list : (int64 * 'a) list->'a list-> int64
val generate_flags_list_view : int64 Ctypes.typ->(int64 * 'a) list->'a list Ctypes.typ
\ No newline at end of file
diff --git a/docs/GObject_introspection__VFunc_info/.dune-keep b/docs/GObject_introspection__VFunc_info/.dune-keep
deleted file mode 100644
index e69de29..0000000
diff --git a/docs/GObject_introspection__VFunc_info/index.html b/docs/GObject_introspection__VFunc_info/index.html
deleted file mode 100644
index 7a0322e..0000000
--- a/docs/GObject_introspection__VFunc_info/index.html
+++ /dev/null
@@ -1,2 +0,0 @@
-
-GObject_introspection__VFunc_info (gobject-introspection.GObject_introspection__VFunc_info)
Module GObject_introspection__VFunc_info
VFunc_info — Struct representing a virtual function.
type t
GIVfuncInfo represents a virtual function. A property belongs to either a Object_info or a Interface_info.
Obtain the signal for the virtual function if one is set. The signal comes from the object or interface to which this virtual function belongs. In order to avoid circular call graph between VFunc_info and Signal_info, this function will return a Callable_info. It is upto the user to use Signal_info.from_callableinfo in order to have the Signal_info.
Return a VFunc_info.t from a Base_info.t, the underlying C structure ref count is increased and the value is Gc.finalis"ed" with Base_info.baseinfo_unref.
Return a Base_info.t from a VFunc_info, the underlying C structure ref count is increased and the value is Gc.finalis"ed" with Base_info.baseinfo_unref.
Return a VFunc_info.t from a Callable_info.t, the underlying C structure ref count is increased and the value is Gc.finalis"ed" with Base_info.baseinfo_unref.
Return a Callable_info.t from a VFunc_info, the underlying C structure ref count is increased and the value is Gc.finalis"ed" with Base_info.baseinfo_unref.
\ No newline at end of file
diff --git a/docs/GObject_introspection__Value_info/.dune-keep b/docs/GObject_introspection__Value_info/.dune-keep
deleted file mode 100644
index e69de29..0000000
diff --git a/docs/GObject_introspection__Value_info/index.html b/docs/GObject_introspection__Value_info/index.html
deleted file mode 100644
index 43e2833..0000000
--- a/docs/GObject_introspection__Value_info/index.html
+++ /dev/null
@@ -1,2 +0,0 @@
-
-GObject_introspection__Value_info (gobject-introspection.GObject_introspection__Value_info)
Return a Struct_info.t from a Base_info.t, the underlying C structure ref count is increased and the value is Gc.finalis"ed" with Base_info.baseinfo_unref.
Return a Base_info.t form a Struct_info, the underlying C structure ref count is increased and the value is Gc.finalis"ed" with Base_info.baseinfo_unref.
\ No newline at end of file
diff --git a/docs/GObject_introspection__Version/.dune-keep b/docs/GObject_introspection__Version/.dune-keep
deleted file mode 100644
index e69de29..0000000
diff --git a/docs/GObject_introspection__Version/index.html b/docs/GObject_introspection__Version/index.html
deleted file mode 100644
index c952628..0000000
--- a/docs/GObject_introspection__Version/index.html
+++ /dev/null
@@ -1,2 +0,0 @@
-
-GObject_introspection__Version (gobject-introspection.GObject_introspection__Version)
Module GObject_introspection__Version
val get_major_version : unit -> int
* Returns the major version number of the girepository library. (e.g. in version 1.58.2 this is 1.) *
val get_minor_version : unit -> int
* Returns the minor version number of the girepository library. (e.g. in version 1.58.2 this is 58.) *
val get_micro_version : unit -> int
* Returns the micro version number of the girepository library. (e.g. in version 1.58.2 this is 2.) *
\ No newline at end of file
diff --git a/docs/dune b/docs/dune
new file mode 100644
index 0000000..49fb4b7
--- /dev/null
+++ b/docs/dune
@@ -0,0 +1,2 @@
+(documentation
+ (mld_files index manual))
diff --git a/docs/index.html b/docs/index.html
deleted file mode 100644
index 7bc1e00..0000000
--- a/docs/index.html
+++ /dev/null
@@ -1,2 +0,0 @@
-
-index (gobject-introspection.index)