libguile/gh.h

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