* $Header: /cvsroot/swig/SWIG/Lib/ocaml/cstring.i,v 1.5 2004/10/06 16:51:20 marcelomatus Exp $
* Modified from David Beazley (beazley@cs.uchicago.edu)
* This file provides typemaps and macros for dealing with various forms
* of C character string handling. The primary use of this module
* is in returning character data that has been allocated or changed in
/* %cstring_input_binary(TYPEMAP, SIZE)
* Macro makes a function accept binary string data along with
%define %cstring_input_binary(TYPEMAP, SIZE)
%apply (char *STRING, int LENGTH) { (TYPEMAP, SIZE) };
* %cstring_bounded_output(TYPEMAP, MAX)
* This macro is used to return a NULL-terminated output string of
* some maximum length. For example:
* %cstring_bounded_output(char *outx, 512);
* sprintf(outx,"blah blah\n");
%define %cstring_bounded_output(TYPEMAP,MAX)
%typemap(ignore) TYPEMAP(char temp[MAX+1]) {
%typemap(argout,fragment="t_output_helper") TYPEMAP {
$result = caml_list_append($result,caml_val_string(str));
* %cstring_chunk_output(TYPEMAP, SIZE)
* This macro is used to return a chunk of binary string data.
* Embedded NULLs are okay. For example:
* %cstring_chunk_output(char *outx, 512);
* memmove(outx, somedata, 512);
%define %cstring_chunk_output(TYPEMAP,SIZE)
%typemap(ignore) TYPEMAP(char temp[SIZE]) {
%typemap(argout) TYPEMAP {
$result = caml_list_append($result,caml_val_string_len($1,SIZE));
* %cstring_bounded_mutable(TYPEMAP, SIZE)
* This macro is used to wrap a string that's going to mutate.
* %cstring_bounded_mutable(char *in, 512);
%define %cstring_bounded_mutable(TYPEMAP,MAX)
%typemap(in) TYPEMAP(char temp[MAX+1]) {
char *t = (char *)caml_ptr_val($input);
%typemap(argout) TYPEMAP {
$result = caml_list_append($result,caml_val_string_len($1,MAX));
* %cstring_mutable(TYPEMAP [, expansion])
* This macro is used to wrap a string that will mutate in place.
* It may change size up to a user-defined expansion.
* %cstring_mutable(char *in);
%define %cstring_mutable(TYPEMAP,...)
char *t = String_val($input);
int n = string_length($input);
$1 = ($1_ltype) new char[n+1];
$1 = ($1_ltype) malloc(n+1);
$1 = ($1_ltype) new char[n+1+__VA_ARGS__];
$1 = ($1_ltype) malloc(n+1+__VA_ARGS__);
%typemap(argout) TYPEMAP {
$result = caml_list_append($result,caml_val_string($1));
* %cstring_output_maxsize(TYPEMAP, SIZE)
* This macro returns data in a string of some user-defined size.
* %cstring_output_maxsize(char *outx, int max) {
* void foo(char *outx, int max) {
* sprintf(outx,"blah blah\n");
%define %cstring_output_maxsize(TYPEMAP, SIZE)
%typemap(in) (TYPEMAP, SIZE) {
$2 = caml_val_long($input);
$1 = ($1_ltype) new char[$2+1];
$1 = ($1_ltype) malloc($2+1);
%typemap(argout) (TYPEMAP,SIZE) {
$result = caml_list_append($result,caml_val_string($1));
* %cstring_output_withsize(TYPEMAP, SIZE)
* This macro is used to return character data along with a size
* %cstring_output_maxsize(char *outx, int *max) {
* void foo(char *outx, int *max) {
* sprintf(outx,"blah blah\n");
%define %cstring_output_withsize(TYPEMAP, SIZE)
%typemap(in) (TYPEMAP, SIZE) {
int n = caml_val_long($input);
$1 = ($1_ltype) new char[n+1];
$2 = ($2_ltype) new $*1_ltype;
$1 = ($1_ltype) malloc(n+1);
$2 = ($2_ltype) malloc(sizeof($*1_ltype));
%typemap(argout) (TYPEMAP,SIZE) {
$result = caml_list_append($result,caml_val_string_len($1,$2));
* %cstring_output_allocate(TYPEMAP, RELEASE)
* This macro is used to return character data that was
* allocated with new or malloc.
* %cstring_output_allocated(char **outx, free($1));
* void foo(char **outx) {
* *outx = (char *) malloc(512);
* sprintf(outx,"blah blah\n");
%define %cstring_output_allocate(TYPEMAP, RELEASE)
%typemap(ignore) TYPEMAP($*1_ltype temp = 0) {
%typemap(argout) TYPEMAP {
$result = caml_list_append($result,caml_val_string($1));
$result = caml_list_append($result,caml_val_ptr($1));
* %cstring_output_allocate_size(TYPEMAP, SIZE, RELEASE)
* This macro is used to return character data that was
* allocated with new or malloc.
* %cstring_output_allocated(char **outx, int *sz, free($1));
* void foo(char **outx, int *sz) {
* *outx = (char *) malloc(512);
* sprintf(outx,"blah blah\n");
%define %cstring_output_allocate_size(TYPEMAP, SIZE, RELEASE)
%typemap(ignore) (TYPEMAP, SIZE) ($*1_ltype temp = 0, $*2_ltype tempn) {
%typemap(argout)(TYPEMAP,SIZE) {
$result = caml_list_append($result,caml_val_string_len($1,$2));
$result = caml_list_append($result,caml_val_ptr($1));