ocaml/runtime/caml/alloc.h

83 lines
3.4 KiB
C

/**************************************************************************/
/* */
/* OCaml */
/* */
/* Xavier Leroy and Damien Doligez, INRIA Rocquencourt */
/* */
/* Copyright 1996 Institut National de Recherche en Informatique et */
/* en Automatique. */
/* */
/* All rights reserved. This file is distributed under the terms of */
/* the GNU Lesser General Public License version 2.1, with the */
/* special exception on linking described in the file LICENSE. */
/* */
/**************************************************************************/
#ifndef CAML_ALLOC_H
#define CAML_ALLOC_H
#ifndef CAML_NAME_SPACE
#include "compatibility.h"
#endif
#include "misc.h"
#include "mlvalues.h"
#ifdef __cplusplus
extern "C" {
#endif
CAMLextern value caml_alloc (mlsize_t wosize, tag_t);
CAMLextern value caml_alloc_small (mlsize_t wosize, tag_t);
CAMLextern value caml_alloc_tuple (mlsize_t wosize);
CAMLextern value caml_alloc_float_array (mlsize_t len);
CAMLextern value caml_alloc_string (mlsize_t len); /* len in bytes (chars) */
CAMLextern value caml_alloc_initialized_string (mlsize_t len, const char *);
CAMLextern value caml_copy_string (char const *);
CAMLextern value caml_copy_string_array (char const **);
CAMLextern value caml_copy_double (double);
CAMLextern value caml_copy_int32 (int32_t); /* defined in [ints.c] */
CAMLextern value caml_copy_int64 (int64_t); /* defined in [ints.c] */
CAMLextern value caml_copy_nativeint (intnat); /* defined in [ints.c] */
CAMLextern value caml_alloc_array (value (*funct) (char const *),
char const ** array);
CAMLextern value caml_alloc_sprintf(const char * format, ...)
#ifdef __GNUC__
__attribute__ ((format (printf, 1, 2)))
#endif
;
CAMLextern value caml_alloc_with_profinfo (mlsize_t, tag_t, intnat);
CAMLextern value caml_alloc_small_with_my_or_given_profinfo (
mlsize_t, tag_t, uintnat);
CAMLextern value caml_alloc_small_with_profinfo (mlsize_t, tag_t, intnat);
typedef void (*final_fun)(value);
CAMLextern value caml_alloc_final (mlsize_t wosize,
final_fun, /*finalization function*/
mlsize_t, /*resources consumed*/
mlsize_t /*max resources*/);
CAMLextern int caml_convert_flag_list (value, int *);
/* Convenience functions to deal with unboxable types. */
static inline value caml_alloc_unboxed (value arg) { return arg; }
static inline value caml_alloc_boxed (value arg) {
value result = caml_alloc_small (1, 0);
Field (result, 0) = arg;
return result;
}
static inline value caml_field_unboxed (value arg) { return arg; }
static inline value caml_field_boxed (value arg) { return Field (arg, 0); }
/* Unannotated unboxable types are boxed by default. (may change in the
future) */
#define caml_alloc_unboxable caml_alloc_boxed
#define caml_field_unboxable caml_field_boxed
#ifdef __cplusplus
}
#endif
#endif /* CAML_ALLOC_H */