1/* stw.h -- Private #include File (module.h template V1.0)
2   Copyright (C) 1995 Free Software Foundation, Inc.
3   Contributed by James Craig Burley.
4
5This file is part of GNU Fortran.
6
7GNU Fortran is free software; you can redistribute it and/or modify
8it under the terms of the GNU General Public License as published by
9the Free Software Foundation; either version 2, or (at your option)
10any later version.
11
12GNU Fortran is distributed in the hope that it will be useful,
13but WITHOUT ANY WARRANTY; without even the implied warranty of
14MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15GNU General Public License for more details.
16
17You should have received a copy of the GNU General Public License
18along with GNU Fortran; see the file COPYING.  If not, write to
19the Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA
2002111-1307, USA.
21
22   Owning Modules:
23      stw.c
24
25   Modifications:
26*/
27
28/* Allow multiple inclusion to work. */
29
30#ifndef _H_f_stw
31#define _H_f_stw
32
33/* Simple definitions and enumerations. */
34
35
36/* Typedefs. */
37
38typedef struct _ffestw_ *ffestw;
39typedef struct _ffestw_case_ *ffestwCase;
40typedef struct _ffestw_select_ *ffestwSelect;
41typedef void (*ffestwShriek) (bool ok);
42
43/* Include files needed by this one. */
44
45#include "bld.h"
46#include "com.h"
47#include "info.h"
48#include "lab.h"
49#include "lex.h"
50#include "malloc.h"
51#include "stv.h"
52#include "symbol.h"
53#include "where.h"
54
55/* Structure definitions. */
56
57struct _ffestw_
58  {
59    ffestw next_;		/* Next (unused) block, or NULL. */
60    ffestw previous_;		/* Previous block, NULL if this is NIL state. */
61    ffestw top_do_;		/* Previous or current DO state, or NULL. */
62    unsigned long blocknum_;	/* Block # w/in procedure/program. */
63    ffestwShriek shriek_;	/* Call me to pop block in a hurry. */
64    ffesymbol sym_;		/* Related symbol (if there is one). */
65    ffelexToken name_;		/* Construct name (IFTHEN, SELECT, DO only). */
66    ffestwSelect select_;	/* Info for SELECT CASE blocks. */
67    ffelab label_;		/* For DO blocks w/labels, the target label. */
68    ffesymbol do_iter_var_;	/* For iter DO blocks, the iter var or NULL. */
69    ffelexToken do_iter_var_t_;	/* The token for do_iter_var. */
70    ffewhereLine line_;		/* Where first token of statement triggering
71				   state */
72    ffewhereColumn col_;	/* was seen in source file. */
73    int uses_;			/* # uses (new+use-kill calls). */
74    ffestvState state_;
75    int substate_;		/* Used on a per-block-state basis. */
76#if FFECOM_targetCURRENT == FFECOM_targetGCC
77    struct nesting *do_hook_;	/* backend id for given loop (EXIT/CYCLE). */
78    tree do_tvar_;		/* tree form of do_iter_var. */
79    tree do_incr_saved_;	/* tree SAVED_EXPR of incr expr. */
80    tree do_count_var_;		/* tree of countdown variable. */
81    tree select_texpr_;		/* tree for end case. */
82    bool select_break_;		/* TRUE when CASE should start with gen
83				   "break;". */
84    int ifthen_fake_else_;	/* Number of fake `else' introductions.  */
85#endif	/* FFECOM_targetCURRENT == FFECOM_targetGCC*/
86  };
87
88struct _ffestw_case_
89  {
90    ffestwCase next_rel;	/* Next case range in relational order. */
91    ffestwCase previous_rel;	/* Previous case range in relational order. */
92    ffestwCase next_stmt;	/* Next range in stmt or first in next stmt. */
93    ffestwCase previous_stmt;	/* Previous range. */
94    ffebldConstant low;		/* Low value in range. */
95    ffebldConstant high;	/* High value in range. */
96    unsigned long casenum;	/* CASE stmt index for this range/value. */
97    ffelexToken t;		/* Token for this range/value; ffestc only. */
98  };
99
100struct _ffestw_select_
101  {
102    ffestwCase first_rel;	/* First CASE range (after low) in order. */
103    ffestwCase last_rel;	/* Last CASE range (before high) in order. */
104    ffestwCase first_stmt;	/* First range in first CASE stmt. */
105    ffestwCase last_stmt;	/* Last range in last CASE stmt. */
106    mallocPool pool;		/* Pool in which this and all cases are
107				   allocated. */
108    unsigned long cases;	/* Number of CASE stmts seen so far. */
109    ffelexToken t;		/* First token of selected expression; ffestc
110				   only. */
111    ffeinfoBasictype type;	/* Basic type (integer, character, or
112				   logical). */
113    ffeinfoKindtype kindtype;	/* Kind type. */
114  };
115
116/* Global objects accessed by users of this module. */
117
118extern ffestw ffestw_stack_top_;
119
120/* Declare functions with prototypes. */
121
122void ffestw_display_state (void);
123void ffestw_kill (ffestw block);
124void ffestw_init_0 (void);
125ffestw ffestw_new (void);
126ffestw ffestw_pop (void);
127ffestw ffestw_push (ffestw block);
128ffestw ffestw_update (ffestw block);
129ffestw ffestw_use (ffestw block);
130
131/* Define macros. */
132
133#define ffestw_blocknum(b) ((b)->blocknum_)
134#define ffestw_col(b) ((b)->col_)
135#define ffestw_do_count_var(b) ((b)->do_count_var_)
136#define ffestw_do_hook(b) ((b)->do_hook_)
137#define ffestw_do_incr_saved(b) ((b)->do_incr_saved_)
138#define ffestw_do_iter_var(b) ((b)->do_iter_var_)
139#define ffestw_do_iter_var_t(b) ((b)->do_iter_var_t_)
140#define ffestw_do_tvar(b) ((b)->do_tvar_)
141#define ffestw_ifthen_fake_else(b) ((b)->ifthen_fake_else_)
142#define ffestw_init_1()
143#define ffestw_init_2()
144#define ffestw_init_3()
145#define ffestw_init_4()
146#define ffestw_label(b) ((b)->label_)
147#define ffestw_line(b) ((b)->line_)
148#define ffestw_name(b) ((b)->name_)
149#define ffestw_previous(b) ((b)->previous_)
150#define ffestw_select(b) ((b)->select_)
151#define ffestw_select_break(b) ((b)->select_break_)
152#define ffestw_select_texpr(b) ((b)->select_texpr_)
153#define ffestw_set_blocknum(b,bl) ((b)->blocknum_ = (bl))
154#define ffestw_set_col(b,c) ((b)->col_ = (c))
155#define ffestw_set_do_count_var(b,d) ((b)->do_count_var_ = (d))
156#define ffestw_set_do_hook(b,d) ((b)->do_hook_ = (d))
157#define ffestw_set_do_incr_saved(b,d) ((b)->do_incr_saved_ = (d))
158#define ffestw_set_do_iter_var(b,v) ((b)->do_iter_var_ = (v))
159#define ffestw_set_do_iter_var_t(b,t) ((b)->do_iter_var_t_ = (t))
160#define ffestw_set_do_tvar(b,d) ((b)->do_tvar_ = (d))
161#define ffestw_set_ifthen_fake_else(b,e) ((b)->ifthen_fake_else_ = (e))
162#define ffestw_set_label(b,l) ((b)->label_ = (l))
163#define ffestw_set_line(b,l) ((b)->line_ = (l))
164#define ffestw_set_name(b,n) ((b)->name_ = (n))
165#define ffestw_set_select(b,s) ((b)->select_ = (s))
166#define ffestw_set_select_break(b,br) ((b)->select_break_ = (br))
167#define ffestw_set_select_texpr(b,t) ((b)->select_texpr_ = (t))
168#define ffestw_set_shriek(b,s) ((b)->shriek_ = (s))
169#define ffestw_set_state(b,s) ((b)->state_ = (s))
170#define ffestw_set_substate(b,s) ((b)->substate_ = (s))
171#define ffestw_set_sym(b,s) ((b)->sym_= (s))
172#define ffestw_set_top_do(b,t) ((b)->top_do_ = (t))
173#define ffestw_shriek(b) ((b)->shriek_)
174#define ffestw_stack_top() ffestw_stack_top_
175#define ffestw_state(b) ((b)->state_)
176#define ffestw_substate(b) ((b)->substate_)
177#define ffestw_sym(b) ((b)->sym_)
178#define ffestw_terminate_0()
179#define ffestw_terminate_1()
180#define ffestw_terminate_2()
181#define ffestw_terminate_3()
182#define ffestw_terminate_4()
183#define ffestw_top_do(b) ((b)->top_do_)
184
185/* End of #include file. */
186
187#endif
188