Source file Arg_info.ml

(*
 * Copyright 2019 Cedric LE MOIGNE, cedlemo@gmx.com
 * This file is part of OCaml-GObject-Introspection.
 *
 * OCaml-GObject-Introspection is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * any later version.
 *
 * OCaml-GObject-Introspection is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with OCaml-GObject-Introspection.  If not, see <http://www.gnu.org/licenses/>.
 *)

(** The direction of a Arg_info. *)
type direction =
  | In    (** in argument. *)
  | Out   (** out argument. *)
  | InOut (** in and out argument. *)

let string_of_direction = function
  | In -> "In"
  | Out -> "Out"
  | InOut -> "InOut"

(** The transfer is the exchange of data between two parts, from the callee to
    the caller. The callee is either a function/method/signal or an
    object/interface where a property is defined. The caller is the side
    accessing a property or calling a function. GITransfer specifies who's
    responsible for freeing the resources after the ownership transfer is
    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.*)

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. *)

let string_of_transfert = function
  | Nothing -> "Nothing"
  | Container -> "Container"
  | Everything -> "Everything"

(** Scope type of a Arg_info representing callback, determines how the
    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. *)

let string_of_scope_type = function
  | Invalid -> "Invalid"
  | Call -> "Call"
  | 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

  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 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 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