libbanshee/engine/banshee.h

   1 /*
   2  * Copyright (c) 2000-2001
   3  *      The Regents of the University of California.  All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  * 3. Neither the name of the University nor the names of its contributors
  14  *    may be used to endorse or promote products derived from this software
  15  *    without specific prior written permission.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  27  * SUCH DAMAGE.
  28  *
  29  */
  30
  31 #ifndef BANSHEE_H
  32 #define BANSHEE_H
  33
  34 #include <stdio.h>
  35 #include "linkage.h"
  36 #include "stamp.h"
  37 #include "list.h"
  38 #include "util.h"
  39 #include "dot.h"
  40
  41 #define ALIAS_TYPE -2
  42 #define VAR_TYPE -1
  43 #define ZERO_TYPE 0
  44 #define ONE_TYPE 1
  45 #define UNION_TYPE 2
  46 #define INTER_TYPE 3
  47 #define CONSTANT_TYPE 4
  48
  49 EXTERN_C_BEGIN
  50
  51
  52 #ifdef NONSPEC
  53
  54 typedef enum sort_kind
  55 {
  56   flowrow_sort,
  57   setif_sort,
  58   setst_sort,
  59   flowterm_sort,
  60   term_sort
  61 } sort_kind;
  62
  63 typedef struct gen_e
  64 {
  65   sort_kind sort;
  66 } *gen_e;
  67 #else
  68 typedef void *gen_e;
  69 #endif
  70
  71 DECLARE_LIST(gen_e_list,gen_e)
  72
  73  typedef void (*gen_e_pr_fn_ptr) (FILE *, gen_e);
  74
  75 /*
  76   Function pointers that are common to all sorts
  77 */
  78
  79 /* inclusion */
  80 typedef void (*incl_fn_ptr) (gen_e, gen_e) deletes;
  81
  82 /* match constructed terms */
  83 typedef void (*con_match_fn_ptr) (gen_e, gen_e) deletes;
  84
  85 /* make fresh variables */
  86 typedef gen_e (*fresh_fn_ptr) (const char *);
  87 typedef gen_e (*fresh_small_fn_ptr) (const char *);
  88 typedef gen_e (*fresh_large_fn_ptr) (const char *);
  89
  90 /* get a stamp */
  91 typedef stamp (*get_stamp_fn_ptr) (gen_e);
  92
  93 /* extract a term from a proj pat */
  94 typedef gen_e (*get_proj_fn_ptr) (gen_e_list);
  95
  96 void engine_init(void);
  97 void engine_reset(void) deletes;
  98 void engine_update(void);
  99 void engine_stats(FILE *f);
 100
 101 void print_constraint_graphs(FILE *f);
 102
 103 EXTERN_C_END
 104
 105 #endif /* BANSHEE_H */