libguile/futures.h

   1 /* classes: h_files */
   2
   3 #ifndef SCM_FUTURES_H
   4 #define SCM_FUTURES_H
   5
   6 /* Copyright (C) 2002, 2003 Free Software Foundation, Inc.
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation; either version 2, or (at your option)
  11  * any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this software; see the file COPYING.  If not, write to
  20  * the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
  21  * Boston, MA 02111-1307 USA
  22  *
  23  * As a special exception, the Free Software Foundation gives permission
  24  * for additional uses of the text contained in its release of GUILE.
  25  *
  26  * The exception is that, if you link the GUILE library with other files
  27  * to produce an executable, this does not by itself cause the
  28  * resulting executable to be covered by the GNU General Public License.
  29  * Your use of that executable is in no way restricted on account of
  30  * linking the GUILE library code into it.
  31  *
  32  * This exception does not however invalidate any other reasons why
  33  * the executable file might be covered by the GNU General Public License.
  34  *
  35  * This exception applies only to the code released by the
  36  * Free Software Foundation under the name GUILE.  If you copy
  37  * code from other Free Software Foundation releases into a copy of
  38  * GUILE, as the General Public License permits, the exception does
  39  * not apply to the code that you add in this way.  To avoid misleading
  40  * anyone as to the status of such modified files, you must delete
  41  * this exception notice from them.
  42  *
  43  * If you write modifications of your own for GUILE, it is your choice
  44  * whether to permit this exception to apply to your modifications.
  45  * If you do not wish that, delete this exception notice.  */
  46
  47 \f
  48
  49 #include "libguile/__scm.h"
  50 #include "libguile/threads.h"
  51
  52 \f
  53
  54 typedef struct scm_t_future {
  55   SCM data;
  56   scm_t_mutex mutex;
  57   scm_t_cond cond;
  58   int status;
  59   int die_p;
  60 } scm_t_future;
  61
  62 #define SCM_FUTURE_DEAD 0
  63 #define SCM_FUTURE_SIGNAL_ME -1
  64 #define SCM_FUTURE_COMPUTING 1
  65 #define SCM_FUTURE_TASK_ASSIGNED 2
  66
  67 #define SCM_VALIDATE_FUTURE(pos, obj) \
  68   SCM_ASSERT_TYPE (SCM_TYP16_PREDICATE (scm_tc16_future, obj), \
  69                    obj, pos, FUNC_NAME, "future");
  70 #define SCM_FUTURE(future) ((scm_t_future *) SCM_CELL_WORD_2 (future))
  71 #define SCM_FUTURE_MUTEX(future) (&SCM_FUTURE (future)->mutex)
  72 #define SCM_FUTURE_COND(future) (&SCM_FUTURE (future)->cond)
  73 #define SCM_FUTURE_STATUS(future) (SCM_FUTURE (future)->status)
  74 #define SCM_SET_FUTURE_STATUS(future, x) \
  75  do { SCM_FUTURE (future)->status = (x); } while (0)
  76 #define SCM_FUTURE_ALIVE_P(future) (SCM_FUTURE_STATUS (future))
  77 #define SCM_FUTURE_DATA(future) (SCM_FUTURE (future)->data)
  78 #define SCM_SET_FUTURE_DATA(future, x) \
  79  do { SCM_FUTURE (future)->data = (x); } while (0)
  80 #define SCM_FUTURE_NEXT SCM_CELL_OBJECT_1
  81 #define SCM_FUTURE_NEXTLOC(x) ((SCM *) SCM_CELL_WORD_LOC ((x), 1))
  82 #define SCM_SET_FUTURE_NEXT SCM_SET_CELL_OBJECT_1
  83
  84 SCM_API scm_t_bits scm_tc16_future;
  85
  86 extern SCM *scm_loc_sys_thread_handler;
  87
  88 SCM_API SCM scm_i_make_future (SCM thunk);
  89 SCM_API SCM scm_make_future (SCM thunk);
  90 SCM_API SCM scm_future_ref (SCM future);
  91
  92 void scm_init_futures (void);
  93
  94 #endif  /* SCM_FUTURES_H */
  95
  96 /*
  97   Local Variables:
  98   c-file-style: "gnu"
  99   End:
 100 */