libguile/gh.h

   1 /* Copyright (C) 1995,1996,1997,1998,2000,2001, 2005 Free Software Foundation, Inc.
   2  *
   3  * This library is free software; you can redistribute it and/or
   4  * modify it under the terms of the GNU Lesser General Public
   5  * License as published by the Free Software Foundation; either
   6  * version 2.1 of the License, or (at your option) any later version.
   7  *
   8  * This library is distributed in the hope that it will be useful,
   9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  11  * Lesser General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU Lesser General Public
  14  * License along with this library; if not, write to the Free Software
  15  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  16  */
  17 \f
  18
  19 #ifndef __GH_H
  20 #define __GH_H
  21
  22 /* This needs to be included outside of the extern "C" block.
  23  */
  24 #include <libguile.h>
  25
  26 #ifdef __cplusplus
  27 extern "C" {
  28 #endif
  29
  30 /* gcc has extern inline functions that are basically as fast as macros */
  31 #ifdef __GNUC__
  32 # define INL inline
  33 # define EXTINL extern inline
  34 #else
  35 # define INL
  36 #define EXTINL
  37 #endif /* __GNUC__ */
  38
  39 SCM_API void gh_enter(int argc, char *argv[],
  40                       void (*c_main_prog)(int, char **));
  41 #define gh_init () scm_init_guile ()
  42 SCM_API void gh_repl(int argc, char *argv[]);
  43 SCM_API SCM gh_catch(SCM tag, scm_t_catch_body body, void *body_data,
  44                      scm_t_catch_handler handler, void *handler_data);
  45
  46 SCM_API SCM gh_standard_handler(void *data, SCM tag, SCM throw_args);
  47
  48 SCM_API SCM gh_eval_str(const char *scheme_code);
  49 SCM_API SCM gh_eval_str_with_catch(const char *scheme_code, scm_t_catch_handler handler);
  50 SCM_API SCM gh_eval_str_with_standard_handler(const char *scheme_code);
  51 SCM_API SCM gh_eval_str_with_stack_saving_handler(const char *scheme_code);
  52
  53 SCM_API SCM gh_eval_file(const char *fname);
  54 #define gh_load(fname) gh_eval_file(fname)
  55 SCM_API SCM gh_eval_file_with_catch(const char *scheme_code, scm_t_catch_handler handler);
  56 SCM_API SCM gh_eval_file_with_standard_handler(const char *scheme_code);
  57
  58 #define gh_defer_ints() SCM_CRITICAL_SECTION_START
  59 #define gh_allow_ints() SCM_CRITICAL_SECTION_END
  60
  61 SCM_API SCM gh_new_procedure(const char *proc_name, SCM (*fn)(),
  62                              int n_required_args, int n_optional_args,
  63                              int varp);
  64 SCM_API SCM gh_new_procedure0_0(const char *proc_name, SCM (*fn)(void));
  65 SCM_API SCM gh_new_procedure0_1(const char *proc_name, SCM (*fn)(SCM));
  66 SCM_API SCM gh_new_procedure0_2(const char *proc_name, SCM (*fn)(SCM, SCM));
  67 SCM_API SCM gh_new_procedure1_0(const char *proc_name, SCM (*fn)(SCM));
  68 SCM_API SCM gh_new_procedure1_1(const char *proc_name, SCM (*fn)(SCM, SCM));
  69 SCM_API SCM gh_new_procedure1_2(const char *proc_name, SCM (*fn)(SCM, SCM, SCM));
  70 SCM_API SCM gh_new_procedure2_0(const char *proc_name, SCM (*fn)(SCM, SCM));
  71 SCM_API SCM gh_new_procedure2_1(const char *proc_name, SCM (*fn)(SCM, SCM, SCM));
  72 SCM_API SCM gh_new_procedure2_2(const char *proc_name, SCM (*fn)(SCM, SCM, SCM, SCM));
  73 SCM_API SCM gh_new_procedure3_0(const char *proc_name, SCM (*fn)(SCM, SCM, SCM));
  74 SCM_API SCM gh_new_procedure4_0(const char *proc_name, SCM (*fn)(SCM, SCM, SCM, SCM));
  75 SCM_API SCM gh_new_procedure5_0(const char *proc_name, SCM (*fn)(SCM, SCM, SCM, SCM, SCM));
  76
  77 /* C to Scheme conversion */
  78 SCM_API SCM gh_bool2scm(int x);
  79 SCM_API SCM gh_int2scm(int x);
  80 SCM_API SCM gh_ulong2scm(unsigned long x);
  81 SCM_API SCM gh_long2scm(long x);
  82 SCM_API SCM gh_double2scm(double x);
  83 SCM_API SCM gh_char2scm(char c);
  84 SCM_API SCM gh_str2scm(const char *s, size_t len);
  85 SCM_API SCM gh_str02scm(const char *s);
  86 SCM_API void gh_set_substr(const char *src, SCM dst, long start, size_t len);
  87 SCM_API SCM gh_symbol2scm(const char *symbol_str);
  88 SCM_API SCM gh_ints2scm(const int *d, long n);
  89
  90 SCM_API SCM gh_chars2byvect(const char *d, long n);
  91 SCM_API SCM gh_shorts2svect(const short *d, long n);
  92 SCM_API SCM gh_longs2ivect(const long *d, long n);
  93 SCM_API SCM gh_ulongs2uvect(const unsigned long *d, long n);
  94 SCM_API SCM gh_floats2fvect(const float *d, long n);
  95 SCM_API SCM gh_doubles2dvect(const double *d, long n);
  96
  97 SCM_API SCM gh_doubles2scm(const double *d, long n);
  98
  99 /* Scheme to C conversion */
 100 SCM_API int gh_scm2bool(SCM obj);
 101 SCM_API int gh_scm2int(SCM obj);
 102 SCM_API unsigned long gh_scm2ulong(SCM obj);
 103 SCM_API long gh_scm2long(SCM obj);
 104 SCM_API char gh_scm2char(SCM obj);
 105 SCM_API double gh_scm2double(SCM obj);
 106 SCM_API char *gh_scm2newstr(SCM str, size_t *lenp);
 107 SCM_API void gh_get_substr(SCM src, char *dst, long start, size_t len);
 108 SCM_API char *gh_symbol2newstr(SCM sym, size_t *lenp);
 109 SCM_API char *gh_scm2chars(SCM vector, char *result);
 110 SCM_API short *gh_scm2shorts(SCM vector, short *result);
 111 SCM_API long *gh_scm2longs(SCM vector, long *result);
 112 SCM_API float *gh_scm2floats(SCM vector, float *result);
 113 SCM_API double *gh_scm2doubles(SCM vector, double *result);
 114
 115 /* type predicates: tell you if an SCM object has a given type */
 116 SCM_API int gh_boolean_p(SCM val);
 117 SCM_API int gh_symbol_p(SCM val);
 118 SCM_API int gh_char_p(SCM val);
 119 SCM_API int gh_vector_p(SCM val);
 120 SCM_API int gh_pair_p(SCM val);
 121 SCM_API int gh_number_p(SCM val);
 122 SCM_API int gh_string_p(SCM val);
 123 SCM_API int gh_procedure_p(SCM val);
 124 SCM_API int gh_list_p(SCM val);
 125 SCM_API int gh_inexact_p(SCM val);
 126 SCM_API int gh_exact_p(SCM val);
 127
 128 /* more predicates */
 129 SCM_API int gh_eq_p(SCM x, SCM y);
 130 SCM_API int gh_eqv_p(SCM x, SCM y);
 131 SCM_API int gh_equal_p(SCM x, SCM y);
 132 SCM_API int gh_string_equal_p(SCM s1, SCM s2);
 133 SCM_API int gh_null_p(SCM l);
 134
 135 /* standard Scheme procedures available from C */
 136
 137 #define gh_not(x) scm_not(x)
 138
 139 SCM_API SCM gh_define(const char *name, SCM val);
 140
 141 /* string manipulation routines */
 142 #define gh_make_string(k, chr)       scm_make_string(k, chr)
 143 #define gh_string_length(str)        scm_string_length(str)
 144 #define gh_string_ref(str, k)        scm_string_ref(str, k)
 145 #define gh_string_set_x(str, k, chr) scm_string_set_x(str, k, chr)
 146 #define gh_substring(str, start, end) scm_substring(str, start, end)
 147 #define gh_string_append(args)       scm_string_append(args)
 148
 149
 150 /* vector manipulation routines */
 151 /* note that gh_vector() does not behave quite like the Scheme (vector
 152    obj1 obj2 ...), because the interpreter engine does not pass the
 153    data element by element, but rather as a list.  thus, gh_vector()
 154    ends up being identical to gh_list_to_vector() */
 155 #define gh_vector(ls) scm_vector(ls)
 156 SCM_API SCM gh_make_vector(SCM length, SCM val);
 157 SCM_API SCM gh_vector_set_x(SCM vec, SCM pos, SCM val);
 158 SCM_API SCM gh_vector_ref(SCM vec, SCM pos);
 159 SCM_API unsigned long gh_vector_length (SCM v);
 160 SCM_API unsigned long gh_uniform_vector_length (SCM v);
 161 SCM_API SCM gh_uniform_vector_ref (SCM v, SCM ilist);
 162 #define gh_list_to_vector(ls) scm_vector(ls)
 163 #define gh_vector_to_list(v) scm_vector_to_list(v)
 164
 165 SCM_API SCM gh_lookup (const char *sname);
 166 SCM_API SCM gh_module_lookup (SCM module, const char *sname);
 167
 168 SCM_API SCM gh_cons(SCM x, SCM y);
 169 #define gh_list scm_list_n
 170 SCM_API unsigned long gh_length(SCM l);
 171 SCM_API SCM gh_append(SCM args);
 172 SCM_API SCM gh_append2(SCM l1, SCM l2);
 173 SCM_API SCM gh_append3(SCM l1, SCM l2, SCM l3);
 174 SCM_API SCM gh_append4(SCM l1, SCM l2, SCM l3, SCM l4);
 175 #define gh_reverse(ls) scm_reverse(ls)
 176 #define gh_list_tail(ls, k) scm_list_tail(ls, k)
 177 #define gh_list_ref(ls, k) scm_list_ref(ls, k)
 178 #define gh_memq(x, ls) scm_memq(x, ls)
 179 #define gh_memv(x, ls) scm_memv(x, ls)
 180 #define gh_member(x, ls) scm_member(x, ls)
 181 #define gh_assq(x, alist) scm_assq(x, alist)
 182 #define gh_assv(x, alist) scm_assv(x, alist)
 183 #define gh_assoc(x, alist) scm_assoc(x, alist)
 184
 185 SCM_API SCM gh_car(SCM x);
 186 SCM_API SCM gh_cdr(SCM x);
 187
 188 SCM_API SCM gh_caar(SCM x);
 189 SCM_API SCM gh_cadr(SCM x);
 190 SCM_API SCM gh_cdar(SCM x);
 191 SCM_API SCM gh_cddr(SCM x);
 192
 193 SCM_API SCM gh_caaar(SCM x);
 194 SCM_API SCM gh_caadr(SCM x);
 195 SCM_API SCM gh_cadar(SCM x);
 196 SCM_API SCM gh_caddr(SCM x);
 197 SCM_API SCM gh_cdaar(SCM x);
 198 SCM_API SCM gh_cdadr(SCM x);
 199 SCM_API SCM gh_cddar(SCM x);
 200 SCM_API SCM gh_cdddr(SCM x);
 201
 202 SCM_API SCM gh_set_car_x(SCM pair, SCM value);
 203 SCM_API SCM gh_set_cdr_x(SCM pair, SCM value);
 204
 205
 206 /* Calling Scheme functions from C.  */
 207 SCM_API SCM gh_apply (SCM proc, SCM ls);
 208 SCM_API SCM gh_call0 (SCM proc);
 209 SCM_API SCM gh_call1 (SCM proc, SCM arg);
 210 SCM_API SCM gh_call2 (SCM proc, SCM arg1, SCM arg2);
 211 SCM_API SCM gh_call3 (SCM proc, SCM arg1, SCM arg2, SCM arg3);
 212
 213 /* reading and writing Scheme objects.  */
 214 SCM_API void gh_display (SCM x);
 215 SCM_API void gh_write (SCM x);
 216 SCM_API void gh_newline (void);
 217
 218 /* void  gh_gc_mark(SCM)              : mark an SCM as in use. */
 219 /* void  gh_defer_ints()              : don't interrupt code section. */
 220 /* void  gh_allow_ints()              : see gh_defer_ints(). */
 221 /* void  gh_new_cell(SCM, int tag)    : initialize SCM to be of type 'tag' */
 222 /* int   gh_type_p(SCM, tag)          : test if SCM is of type 'tag' */
 223 /* SCM   gh_intern(char*)             : get symbol corresponding to c-string.*/
 224 /* void  gh_set_ext_data(SCM, void*)  : set extension data on SCM */
 225 /* void *gh_get_ext_data(SCM)         : return extension data from SCM. */
 226
 227 /* void  gh_assert(int cond, char *msg, SCM obj); */
 228
 229 #ifdef __cplusplus
 230 }
 231 #endif
 232
 233 #endif /* __GH_H */
 234
 235 /*
 236   Local Variables:
 237   c-file-style: "gnu"
 238   End:
 239 */