1 /* gfortran header file
2 Copyright (C) 2000, 2001, 2002, 2003, 2004 Free Software Foundation,
4 Contributed by Andy Vaught
6 This file is part of GCC.
8 GCC is free software; you can redistribute it and/or modify it under
9 the terms of the GNU General Public License as published by the Free
10 Software Foundation; either version 2, or (at your option) any later
13 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
14 WARRANTY; without even the implied warranty of MERCHANTABILITY or
15 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
18 You should have received a copy of the GNU General Public License
19 along with GCC; see the file COPYING. If not, write to the Free
20 Software Foundation, 59 Temple Place - Suite 330, Boston, MA
23 #ifndef GCC_GFORTRAN_H
24 #define GCC_GFORTRAN_H
26 /* It's probably insane to have this large of a header file, but it
27 seemed like everything had to be recompiled anyway when a change
28 was made to a header file, and there were ordering issues with
29 multiple header files. Besides, Microsoft's winnt.h was 250k last
30 time I looked, so by comparison this is perfectly reasonable. */
32 /* We need system.h for HOST_WIDE_INT. Including hwint.h by itself doesn't
33 seem to be sufficient on some systems. */
35 #include "coretypes.h"
37 /* The following ifdefs are recommended by the autoconf documentation
38 for any code using alloca. */
40 /* AIX requires this to be the first thing in the file. */
42 #else /* not __GNUC__ */
45 #else /* do not HAVE_ALLOCA_H */
49 #ifndef alloca /* predefined by HP cc +Olibcalls */
51 #endif /* not predefined */
53 #endif /* do not HAVE_ALLOCA_H */
54 #endif /* not __GNUC__ */
57 #include <stdio.h> /* need FILE * here */
59 /* Major control parameters. */
61 #define GFC_VERSION "0.23"
62 #define GFC_MAX_SYMBOL_LEN 63
63 #define GFC_REAL_BITS 100 /* Number of bits in g95's floating point numbers. */
64 #define GFC_MAX_LINE 132 /* Characters beyond this are not seen. */
65 #define GFC_MAX_DIMENSIONS 7 /* Maximum dimensions in an array. */
66 #define GFC_LETTERS 26 /* Number of letters in the alphabet. */
67 #define MAX_ERROR_MESSAGE 1000 /* Maximum length of an error message. */
69 #define free(x) Use_gfc_free_instead_of_free()
70 #define gfc_is_whitespace(c) ((c==' ') || (c=='\t'))
73 #define NULL ((void *) 0)
77 #define stringize(x) expand_macro(x)
78 #define expand_macro(x) # x
80 /* For a the runtime library, a standard prefix is a requirement to
81 avoid cluttering the namespace with things nobody asked for. It's
82 ugly to look at and a pain to type when you add the prefix by hand,
83 so we hide it behind a macro. */
84 #define PREFIX(x) "_gfortran_" x
87 /* Macro to initialize an mstring structure. */
88 #define minit(s, t) { s, NULL, t }
90 /* Structure for storing strings to be matched by gfc_match_string. */
100 /* Flags to specify which standardi/extension contains a feature. */
101 #define GFC_STD_GNU (1<<5) /* GNU Fortran extension. */
102 #define GFC_STD_F2003 (1<<4) /* New in F2003. */
103 #define GFC_STD_F2003_DEL (1<<3) /* Deleted in F2003. */
104 #define GFC_STD_F2003_OBS (1<<2) /* Obsoleted in F2003. */
105 #define GFC_STD_F95_DEL (1<<1) /* Deleted in F95. */
106 #define GFC_STD_F95_OBS (1<<0) /* Obsoleted in F95. */
108 /*************************** Enums *****************************/
110 /* The author remains confused to this day about the convention of
111 returning '0' for 'SUCCESS'... or was it the other way around? The
112 following enum makes things much more readable. We also start
113 values off at one instead of zero. */
116 { SUCCESS = 1, FAILURE }
119 /* Matchers return one of these three values. The difference between
120 MATCH_NO and MATCH_ERROR is that MATCH_ERROR means that a match was
121 successful, but that something non-syntactic is wrong and an error
122 has already been issued. */
125 { MATCH_NO = 1, MATCH_YES, MATCH_ERROR }
129 { FORM_FREE, FORM_FIXED, FORM_UNKNOWN }
133 { BT_UNKNOWN = 1, BT_INTEGER, BT_REAL, BT_COMPLEX,
134 BT_LOGICAL, BT_CHARACTER, BT_DERIVED, BT_PROCEDURE
138 /* Expression node types. */
140 { EXPR_OP = 1, EXPR_FUNCTION, EXPR_CONSTANT, EXPR_VARIABLE,
141 EXPR_SUBSTRING, EXPR_STRUCTURE, EXPR_ARRAY, EXPR_NULL
147 { AS_EXPLICIT = 1, AS_ASSUMED_SHAPE, AS_DEFERRED,
148 AS_ASSUMED_SIZE, AS_UNKNOWN
153 { AR_FULL = 1, AR_ELEMENT, AR_SECTION, AR_UNKNOWN }
156 /* Statement label types. */
158 { ST_LABEL_UNKNOWN = 1, ST_LABEL_TARGET,
159 ST_LABEL_BAD_TARGET, ST_LABEL_FORMAT
163 /* Intrinsic operators. */
165 { GFC_INTRINSIC_BEGIN = 0,
166 INTRINSIC_NONE = -1, INTRINSIC_UPLUS = GFC_INTRINSIC_BEGIN,
167 INTRINSIC_UMINUS, INTRINSIC_PLUS, INTRINSIC_MINUS, INTRINSIC_TIMES,
168 INTRINSIC_DIVIDE, INTRINSIC_POWER, INTRINSIC_CONCAT,
169 INTRINSIC_AND, INTRINSIC_OR, INTRINSIC_EQV, INTRINSIC_NEQV,
170 INTRINSIC_EQ, INTRINSIC_NE, INTRINSIC_GT, INTRINSIC_GE,
171 INTRINSIC_LT, INTRINSIC_LE, INTRINSIC_NOT, INTRINSIC_USER,
173 GFC_INTRINSIC_END /* Sentinel */
178 /* Strings for all intrinsic operators. */
179 extern mstring intrinsic_operators[];
182 /* This macro is the number of intrinsic operators that exist.
183 Assumptions are made about the numbering of the interface_op enums. */
184 #define GFC_INTRINSIC_OPS GFC_INTRINSIC_END
186 /* Arithmetic results. */
188 { ARITH_OK = 1, ARITH_OVERFLOW, ARITH_UNDERFLOW,
189 ARITH_DIV0, ARITH_0TO0, ARITH_INCOMMENSURATE
196 ST_ARITHMETIC_IF, ST_ALLOCATE, ST_ATTR_DECL, ST_BACKSPACE, ST_BLOCK_DATA,
197 ST_CALL, ST_CASE, ST_CLOSE, ST_COMMON, ST_CONTINUE, ST_CONTAINS, ST_CYCLE,
198 ST_DATA, ST_DATA_DECL, ST_DEALLOCATE, ST_DO, ST_ELSE, ST_ELSEIF,
199 ST_ELSEWHERE, ST_END_BLOCK_DATA, ST_ENDDO, ST_IMPLIED_ENDDO,
200 ST_END_FILE, ST_END_FORALL, ST_END_FUNCTION, ST_ENDIF, ST_END_INTERFACE,
201 ST_END_MODULE, ST_END_PROGRAM, ST_END_SELECT, ST_END_SUBROUTINE,
202 ST_END_WHERE, ST_END_TYPE, ST_ENTRY, ST_EQUIVALENCE, ST_EXIT, ST_FORALL,
203 ST_FORALL_BLOCK, ST_FORMAT, ST_FUNCTION, ST_GOTO, ST_IF_BLOCK, ST_IMPLICIT,
204 ST_IMPLICIT_NONE, ST_INQUIRE, ST_INTERFACE, ST_PARAMETER, ST_MODULE,
205 ST_MODULE_PROC, ST_NAMELIST, ST_NULLIFY, ST_OPEN, ST_PAUSE, ST_PRIVATE,
206 ST_PROGRAM, ST_PUBLIC, ST_READ, ST_RETURN, ST_REWIND, ST_STOP,
208 ST_TYPE, ST_USE, ST_WHERE_BLOCK, ST_WHERE, ST_WRITE, ST_ASSIGNMENT,
209 ST_POINTER_ASSIGNMENT, ST_SELECT_CASE, ST_SEQUENCE, ST_SIMPLE_IF,
210 ST_STATEMENT_FUNCTION, ST_DERIVED_DECL, ST_LABEL_ASSIGNMENT, ST_NONE
215 /* Types of interfaces that we can have. Assignment interfaces are
216 considered to be intrinsic operators. */
219 INTERFACE_NAMELESS = 1, INTERFACE_GENERIC,
220 INTERFACE_INTRINSIC_OP, INTERFACE_USER_OP
224 /* Symbol flavors: these are all mutually exclusive.
225 10 elements = 4 bits. */
228 FL_UNKNOWN = 0, FL_PROGRAM, FL_BLOCK_DATA, FL_MODULE, FL_VARIABLE,
229 FL_PARAMETER, FL_LABEL, FL_PROCEDURE, FL_DERIVED, FL_NAMELIST
233 /* Procedure types. 7 elements = 3 bits. */
235 { PROC_UNKNOWN, PROC_MODULE, PROC_INTERNAL, PROC_DUMMY,
236 PROC_INTRINSIC, PROC_ST_FUNCTION, PROC_EXTERNAL
242 { INTENT_UNKNOWN = 0, INTENT_IN, INTENT_OUT, INTENT_INOUT
248 { ACCESS_PUBLIC = 1, ACCESS_PRIVATE, ACCESS_UNKNOWN
252 /* Flags to keep track of where an interface came from.
253 4 elements = 2 bits. */
255 { IFSRC_UNKNOWN = 0, IFSRC_DECL, IFSRC_IFBODY, IFSRC_USAGE
259 /* Strings for all symbol attributes. We use these for dumping the
260 parse tree, in error messages, and also when reading and writing
261 modules. In symbol.c. */
262 extern const mstring flavors[];
263 extern const mstring procedures[];
264 extern const mstring intents[];
265 extern const mstring access_types[];
266 extern const mstring ifsrc_types[];
268 /* Enumeration of all the generic intrinsic functions. Used by the
269 backend for identification of a function. */
271 enum gfc_generic_isym_id
273 /* GFC_ISYM_NONE is used for intrinsics which will never be seen by
274 the backend (eg. KIND). */
302 GFC_ISYM_DOT_PRODUCT,
353 GFC_ISYM_SET_EXPONENT,
375 typedef enum gfc_generic_isym_id gfc_generic_isym_id;
377 /************************* Structures *****************************/
379 /* Symbol attribute structure. */
382 /* Variable attributes. */
383 unsigned allocatable:1, dimension:1, external:1, intrinsic:1,
384 optional:1, pointer:1, save:1, target:1,
385 dummy:1, common:1, result:1, entry:1, assign:1;
387 unsigned data:1, /* Symbol is named in a DATA statement. */
388 use_assoc:1; /* Symbol has been use-associated. */
390 unsigned in_namelist:1, in_common:1, saved_common:1;
391 unsigned function:1, subroutine:1, generic:1;
392 unsigned implicit_type:1; /* Type defined via implicit rules */
394 /* Function/subroutine attributes */
395 unsigned sequence:1, elemental:1, pure:1, recursive:1;
396 unsigned unmaskable:1, masked:1, contained:1;
398 /* Set if a function must always be referenced by an explicit interface. */
399 unsigned always_explicit:1;
401 /* Set if the symbol has been referenced in an expression. No further
402 modification of type or type parameters is permitted. */
403 unsigned referenced:1;
405 /* Mutually exclusive multibit attributes. */
411 procedure_type proc:3;
417 /* The following three structures are used to identify a location in
420 gfc_file is used to maintain a tree of the source files and how
421 they include each other
423 gfc_linebuf holds a single line of source code and information
424 which file it resides in
426 locus point to the sourceline and the character in the source
430 typedef struct gfc_file
432 struct gfc_file *included_by, *next, *up;
433 int inclusion_line, line;
437 typedef struct gfc_linebuf
440 struct gfc_file *file;
441 struct gfc_linebuf *next;
455 # include <sys/param.h>
456 # define PATH_MAX MAXPATHLEN
460 extern int gfc_suppress_error;
463 /* Character length structures hold the expression that gives the
464 length of a character variable. We avoid putting these into
465 gfc_typespec because doing so prevents us from doing structure
466 copies and forces us to deallocate any typespecs we create, as well
467 as structures that contain typespecs. They also can have multiple
468 character typespecs pointing to them.
470 These structures form a singly linked list within the current
471 namespace and are deallocated with the namespace. It is possible to
472 end up with gfc_charlen structures that have nothing pointing to them. */
474 typedef struct gfc_charlen
476 struct gfc_expr *length;
477 struct gfc_charlen *next;
482 #define gfc_get_charlen() gfc_getmem(sizeof(gfc_charlen))
484 /* Type specification structure. FIXME: derived and cl could be union??? */
489 struct gfc_symbol *derived;
490 gfc_charlen *cl; /* For character types only. */
494 /* Array specification. */
497 int rank; /* A rank of zero means that a variable is a scalar. */
499 struct gfc_expr *lower[GFC_MAX_DIMENSIONS], *upper[GFC_MAX_DIMENSIONS];
503 #define gfc_get_array_spec() gfc_getmem(sizeof(gfc_array_spec))
506 /* Components of derived types. */
507 typedef struct gfc_component
509 char name[GFC_MAX_SYMBOL_LEN + 1];
512 int pointer, dimension;
517 struct gfc_expr *initializer;
518 struct gfc_component *next;
522 #define gfc_get_component() gfc_getmem(sizeof(gfc_component))
524 /* Formal argument lists are lists of symbols. */
525 typedef struct gfc_formal_arglist
527 struct gfc_symbol *sym;
528 struct gfc_formal_arglist *next;
532 #define gfc_get_formal_arglist() gfc_getmem(sizeof(gfc_formal_arglist))
535 /* The gfc_actual_arglist structure is for actual arguments. */
536 typedef struct gfc_actual_arglist
538 char name[GFC_MAX_SYMBOL_LEN + 1];
539 /* Alternate return label when the expr member is null. */
540 struct gfc_st_label *label;
542 struct gfc_expr *expr;
543 struct gfc_actual_arglist *next;
547 #define gfc_get_actual_arglist() gfc_getmem(sizeof(gfc_actual_arglist))
550 /* Because a symbol can belong to multiple namelists, they must be
551 linked externally to the symbol itself. */
552 typedef struct gfc_namelist
554 struct gfc_symbol *sym;
555 struct gfc_namelist *next;
559 #define gfc_get_namelist() gfc_getmem(sizeof(gfc_namelist))
562 /* The gfc_st_label structure is a doubly linked list attached to a
563 namespace that records the usage of statement labels within that
565 /* TODO: Make format/statement specifics a union. */
566 typedef struct gfc_st_label
570 gfc_sl_type defined, referenced;
572 struct gfc_expr *format;
578 struct gfc_st_label *prev, *next;
583 /* gfc_interface()-- Interfaces are lists of symbols strung together. */
584 typedef struct gfc_interface
586 struct gfc_symbol *sym;
588 struct gfc_interface *next;
592 #define gfc_get_interface() gfc_getmem(sizeof(gfc_interface))
595 /* User operator nodes. These are like stripped down symbols. */
598 char name[GFC_MAX_SYMBOL_LEN + 1];
600 gfc_interface *operator;
601 struct gfc_namespace *ns;
606 /* Symbol nodes. These are important things. They are what the
607 standard refers to as "entities". The possibly multiple names that
608 refer to the same entity are accomplished by a binary tree of
609 symtree structures that is balanced by the red-black method-- more
610 than one symtree node can point to any given symbol. */
612 typedef struct gfc_symbol
614 char name[GFC_MAX_SYMBOL_LEN + 1]; /* Primary name, before renaming */
615 char module[GFC_MAX_SYMBOL_LEN + 1]; /* Module this symbol came from */
619 symbol_attribute attr;
621 /* The interface member points to the formal argument list if the
622 symbol is a function or subroutine name. If the symbol is a
623 generic name, the generic member points to the list of
626 gfc_interface *generic;
627 gfc_access component_access;
629 gfc_formal_arglist *formal;
630 struct gfc_namespace *formal_ns;
632 struct gfc_expr *value; /* Parameter/Initializer value */
634 struct gfc_symbol *result; /* function result symbol */
635 gfc_component *components; /* Derived type components */
637 /* TODO: These three fields are mutually exclusive. */
638 struct gfc_symbol *common_head, *common_next; /* Links for COMMON syms */
639 /* Make sure setup code for dummy arguments is generated in the correct
643 gfc_namelist *namelist, *namelist_tail;
645 /* Change management fields. Symbols that might be modified by the
646 current statement have the mark member nonzero and are kept in a
647 singly linked list through the tlink field. Of these symbols,
648 symbols with old_symbol equal to NULL are symbols created within
649 the current statement. Otherwise, old_symbol points to a copy of
652 struct gfc_symbol *old_symbol, *tlink;
653 unsigned mark:1, new:1;
655 struct gfc_namespace *ns; /* namespace containing this symbol */
663 /* Within a namespace, symbols are pointed to by symtree nodes that
664 are linked together in a balanced binary tree. There can be
665 several symtrees pointing to the same symbol node via USE
668 #define BBT_HEADER(self) int priority; struct self *left, *right
670 typedef struct gfc_symtree
672 BBT_HEADER (gfc_symtree);
673 char name[GFC_MAX_SYMBOL_LEN + 1];
677 gfc_symbol *sym; /* Symbol associated with this node */
686 typedef struct gfc_namespace
688 gfc_symtree *sym_root, *uop_root; /* Roots of the red/black symbol trees */
690 int set_flag[GFC_LETTERS];
691 gfc_typespec default_type[GFC_LETTERS]; /* IMPLICIT typespecs */
693 struct gfc_symbol *proc_name;
694 gfc_interface *operator[GFC_INTRINSIC_OPS];
695 struct gfc_namespace *parent, *contained, *sibling;
696 struct gfc_code *code;
697 gfc_symbol *blank_common;
698 struct gfc_equiv *equiv;
699 gfc_access default_access, operator_access[GFC_INTRINSIC_OPS];
701 gfc_st_label *st_labels;
702 struct gfc_data *data;
704 gfc_charlen *cl_list;
706 int save_all, seen_save;
710 extern gfc_namespace *gfc_current_ns;
713 /* Information on interfaces being built. */
724 extern gfc_interface_info current_interface;
727 /* Array reference. */
728 typedef struct gfc_array_ref
731 int dimen; /* # of components in the reference */
735 locus c_where[GFC_MAX_DIMENSIONS]; /* All expressions can be NULL */
736 struct gfc_expr *start[GFC_MAX_DIMENSIONS], *end[GFC_MAX_DIMENSIONS],
737 *stride[GFC_MAX_DIMENSIONS];
740 { DIMEN_ELEMENT = 1, DIMEN_RANGE, DIMEN_VECTOR, DIMEN_UNKNOWN }
741 dimen_type[GFC_MAX_DIMENSIONS];
743 struct gfc_expr *offset;
747 #define gfc_get_array_ref() gfc_getmem(sizeof(gfc_array_ref))
750 /* Component reference nodes. A variable is stored as an expression
751 node that points to the base symbol. After that, a singly linked
752 list of component reference nodes gives the variable's complete
753 resolution. The array_ref component may be present and comes
754 before the component component. */
757 { REF_ARRAY, REF_COMPONENT, REF_SUBSTRING }
760 typedef struct gfc_ref
766 struct gfc_array_ref ar;
770 gfc_component *component;
777 struct gfc_expr *start, *end; /* Substring */
785 struct gfc_ref *next;
789 #define gfc_get_ref() gfc_getmem(sizeof(gfc_ref))
792 /* Structures representing intrinsic symbols and their arguments lists. */
793 typedef struct gfc_intrinsic_arg
795 char name[GFC_MAX_SYMBOL_LEN + 1];
799 gfc_actual_arglist *actual;
801 struct gfc_intrinsic_arg *next;
809 try (*f1)(struct gfc_expr *);
810 try (*f1m)(gfc_actual_arglist *);
811 try (*f2)(struct gfc_expr *, struct gfc_expr *);
812 try (*f3)(struct gfc_expr *, struct gfc_expr *, struct gfc_expr *);
813 try (*f4)(struct gfc_expr *, struct gfc_expr *, struct gfc_expr *,
815 try (*f5)(struct gfc_expr *, struct gfc_expr *, struct gfc_expr *,
816 struct gfc_expr *, struct gfc_expr *);
823 struct gfc_expr *(*f1)(struct gfc_expr *);
824 struct gfc_expr *(*f2)(struct gfc_expr *, struct gfc_expr *);
825 struct gfc_expr *(*f3)(struct gfc_expr *, struct gfc_expr *,
827 struct gfc_expr *(*f4)(struct gfc_expr *, struct gfc_expr *,
828 struct gfc_expr *, struct gfc_expr *);
829 struct gfc_expr *(*f5)(struct gfc_expr *, struct gfc_expr *,
830 struct gfc_expr *, struct gfc_expr *,
832 struct gfc_expr *(*cc)(struct gfc_expr *, bt, int);
839 void (*f0)(struct gfc_expr *);
840 void (*f1)(struct gfc_expr *, struct gfc_expr *);
841 void (*f1m)(struct gfc_expr *, struct gfc_actual_arglist *);
842 void (*f2)(struct gfc_expr *, struct gfc_expr *, struct gfc_expr *);
843 void (*f3)(struct gfc_expr *, struct gfc_expr *, struct gfc_expr *,
845 void (*f4)(struct gfc_expr *, struct gfc_expr *, struct gfc_expr *,
846 struct gfc_expr *, struct gfc_expr *);
847 void (*f5)(struct gfc_expr *, struct gfc_expr *, struct gfc_expr *,
848 struct gfc_expr *, struct gfc_expr *, struct gfc_expr *);
849 void (*s1)(struct gfc_code *);
854 typedef struct gfc_intrinsic_sym
856 char name[GFC_MAX_SYMBOL_LEN + 1], lib_name[GFC_MAX_SYMBOL_LEN + 1];
857 gfc_intrinsic_arg *formal;
859 int elemental, pure, generic, specific, actual_ok;
861 gfc_simplify_f simplify;
863 gfc_resolve_f resolve;
864 struct gfc_intrinsic_sym *specific_head, *next;
865 gfc_generic_isym_id generic_id;
871 /* Expression nodes. The expression node types deserve explanations,
872 since the last couple can be easily misconstrued:
874 EXPR_OP Operator node pointing to one or two other nodes
875 EXPR_FUNCTION Function call, symbol points to function's name
876 EXPR_CONSTANT A scalar constant: Logical, String, Real, Int or Complex
877 EXPR_VARIABLE An Lvalue with a root symbol and possible reference list
878 which expresses structure, array and substring refs.
879 EXPR_NULL The NULL pointer value (which also has a basic type).
880 EXPR_SUBSTRING A substring of a constant string
881 EXPR_STRUCTURE A structure constructor
882 EXPR_ARRAY An array constructor. */
886 typedef struct gfc_expr
890 gfc_typespec ts; /* These two refer to the overall expression */
893 mpz_t *shape; /* Can be NULL if shape is unknown at compile time */
895 gfc_intrinsic_op operator;
897 /* Nonnull for functions and structure constructors */
898 gfc_symtree *symtree;
903 struct gfc_expr *op1, *op2;
920 gfc_actual_arglist *actual;
921 char *name; /* Points to the ultimate name of the function */
922 gfc_intrinsic_sym *isym;
934 struct gfc_constructor *constructor;
942 #define gfc_get_shape(rank) ((mpz_t *) gfc_getmem(rank*sizeof(mpz_t)))
944 /* Structures for information associated with different kinds of
945 numbers. The first set of integer parameters define all there is
946 to know about a particular kind. The rest of the elements are
947 computed from the first elements. */
951 int kind, radix, digits, bit_size;
956 mpz_t min_int, max_int; /* Values really representable by the target */
960 extern gfc_integer_info gfc_integer_kinds[];
970 extern gfc_logical_info gfc_logical_kinds[];
975 int kind, radix, digits, min_exponent, max_exponent;
977 int range, precision;
978 mpf_t epsilon, huge, tiny;
982 extern gfc_real_info gfc_real_kinds[];
985 /* Equivalence structures. Equivalent lvalues are linked along the
986 *eq pointer, equivalence sets are strung along the *next node. */
987 typedef struct gfc_equiv
989 struct gfc_equiv *next, *eq;
995 #define gfc_get_equiv() gfc_getmem(sizeof(gfc_equiv))
998 /* gfc_case stores the selector list of a case statement. The *low
999 and *high pointers can point to the same expression in the case of
1000 a single value. If *high is NULL, the selection is from *low
1001 upwards, if *low is NULL the selection is *high downwards.
1003 This structure has separate fields to allow singe and double linked
1004 lists of CASEs the same time. The singe linked list along the NEXT
1005 field is a list of cases for a single CASE label. The double linked
1006 list along the LEFT/RIGHT fields is used to detect overlap and to
1007 build a table of the cases for SELECT constructs with a CHARACTER
1010 typedef struct gfc_case
1012 /* Where we saw this case. */
1016 /* Case range values. If (low == high), it's a single value. If one of
1017 the labels is NULL, it's an unbounded case. If both are NULL, this
1018 represents the default case. */
1019 gfc_expr *low, *high;
1021 /* Next case label in the list of cases for a single CASE label. */
1022 struct gfc_case *next;
1024 /* Used for detecting overlap, and for code generation. */
1025 struct gfc_case *left, *right;
1027 /* True if this case label can never be matched. */
1032 #define gfc_get_case() gfc_getmem(sizeof(gfc_case))
1037 gfc_expr *var, *start, *end, *step;
1041 #define gfc_get_iterator() gfc_getmem(sizeof(gfc_iterator))
1044 /* Allocation structure for ALLOCATE, DEALLOCATE and NULLIFY statements. */
1046 typedef struct gfc_alloc
1049 struct gfc_alloc *next;
1053 #define gfc_get_alloc() gfc_getmem(sizeof(gfc_alloc))
1058 gfc_expr *unit, *file, *status, *access, *form, *recl,
1059 *blank, *position, *action, *delim, *pad, *iostat;
1067 gfc_expr *unit, *status, *iostat;
1075 gfc_expr *unit, *iostat;
1083 gfc_expr *unit, *file, *iostat, *exist, *opened, *number, *named,
1084 *name, *access, *sequential, *direct, *form, *formatted,
1085 *unformatted, *recl, *nextrec, *blank, *position, *action, *read,
1086 *write, *readwrite, *delim, *pad, *iolength;
1096 gfc_expr *io_unit, *format_expr, *rec, *advance, *iostat, *size;
1098 gfc_symbol *namelist;
1099 /* A format_label of `format_asterisk' indicates the "*" format */
1100 gfc_st_label *format_label;
1101 gfc_st_label *err, *end, *eor;
1103 locus eor_where, end_where;
1108 typedef struct gfc_forall_iterator
1110 gfc_expr *var, *start, *end, *stride;
1111 struct gfc_forall_iterator *next;
1113 gfc_forall_iterator;
1116 /* Executable statements that fill gfc_code structures. */
1119 EXEC_NOP = 1, EXEC_ASSIGN, EXEC_LABEL_ASSIGN, EXEC_POINTER_ASSIGN,
1120 EXEC_GOTO, EXEC_CALL, EXEC_RETURN, EXEC_PAUSE, EXEC_STOP, EXEC_CONTINUE,
1121 EXEC_IF, EXEC_ARITHMETIC_IF, EXEC_DO, EXEC_DO_WHILE, EXEC_SELECT,
1122 EXEC_FORALL, EXEC_WHERE, EXEC_CYCLE, EXEC_EXIT,
1123 EXEC_ALLOCATE, EXEC_DEALLOCATE,
1124 EXEC_OPEN, EXEC_CLOSE,
1125 EXEC_READ, EXEC_WRITE, EXEC_IOLENGTH, EXEC_TRANSFER, EXEC_DT_END,
1126 EXEC_BACKSPACE, EXEC_ENDFILE, EXEC_INQUIRE, EXEC_REWIND
1130 typedef struct gfc_code
1134 struct gfc_code *block, *next;
1137 gfc_st_label *here, *label, *label2, *label3;
1138 gfc_symtree *symtree;
1139 gfc_expr *expr, *expr2;
1140 /* A name isn't sufficient to identify a subroutine, we need the actual
1141 symbol for the interface definition.
1142 const char *sub_name; */
1143 gfc_symbol *resolved_sym;
1147 gfc_actual_arglist *actual;
1148 gfc_case *case_list;
1149 gfc_iterator *iterator;
1150 gfc_alloc *alloc_list;
1153 gfc_filepos *filepos;
1154 gfc_inquire *inquire;
1156 gfc_forall_iterator *forall_iterator;
1157 struct gfc_code *whichloop;
1160 ext; /* Points to additional structures required by statement */
1162 /* Backend_decl is used for cycle and break labels in do loops, and
1163 * probably for other constructs as well, once we translate them. */
1169 /* Storage for DATA statements. */
1170 typedef struct gfc_data_variable
1174 struct gfc_data_variable *list, *next;
1179 typedef struct gfc_data_value
1184 struct gfc_data_value *next;
1189 typedef struct gfc_data
1191 gfc_data_variable *var;
1192 gfc_data_value *value;
1195 struct gfc_data *next;
1199 #define gfc_get_data_variable() gfc_getmem(sizeof(gfc_data_variable))
1200 #define gfc_get_data_value() gfc_getmem(sizeof(gfc_data_value))
1201 #define gfc_get_data() gfc_getmem(sizeof(gfc_data))
1204 /* Structure for holding compile options */
1209 gfc_source_form source_form;
1210 int fixed_line_length;
1211 int max_identifier_length;
1215 int warn_conversion;
1216 int warn_implicit_interface;
1217 int warn_line_truncation;
1218 int warn_surprising;
1219 int warn_unused_labels;
1222 int flag_underscoring;
1223 int flag_second_underscore;
1224 int flag_implicit_none;
1225 int flag_max_stack_var_size;
1226 int flag_module_access_private;
1227 int flag_no_backend;
1228 int flag_pack_derived;
1229 int flag_repack_arrays;
1240 extern gfc_option_t gfc_option;
1243 /* Constructor nodes for array and structure constructors. */
1244 typedef struct gfc_constructor
1247 gfc_iterator *iterator;
1249 struct gfc_constructor *next;
1252 mpz_t offset; /* Record the offset of array element which appears in
1253 data statement like "data a(5)/4/". */
1254 gfc_component *component; /* Record the component being initialized. */
1257 mpz_t repeat; /* Record the repeat number of initial values in data
1258 statement like "data a/5*10/". */
1263 typedef struct iterator_stack
1265 gfc_symtree *variable;
1267 struct iterator_stack *prev;
1270 extern iterator_stack *iter_stack;
1272 /************************ Function prototypes *************************/
1275 void gfc_formalize_init_value (gfc_symbol *);
1276 void gfc_get_section_index (gfc_array_ref *, mpz_t *, mpz_t *);
1277 void gfc_assign_data_value (gfc_expr *, gfc_expr *, mpz_t);
1278 void gfc_advance_section (mpz_t *, gfc_array_ref *, mpz_t *);
1281 void gfc_scanner_done_1 (void);
1282 void gfc_scanner_init_1 (void);
1284 void gfc_add_include_path (const char *);
1285 void gfc_release_include_path (void);
1286 FILE *gfc_open_included_file (const char *);
1288 locus *gfc_current_locus (void);
1289 void gfc_set_locus (locus *);
1291 int gfc_at_end (void);
1292 int gfc_at_eof (void);
1293 int gfc_at_bol (void);
1294 int gfc_at_eol (void);
1295 void gfc_advance_line (void);
1296 int gfc_check_include (void);
1298 void gfc_skip_comments (void);
1299 int gfc_next_char_literal (int);
1300 int gfc_next_char (void);
1301 int gfc_peek_char (void);
1302 void gfc_error_recovery (void);
1303 void gfc_gobble_whitespace (void);
1304 try gfc_new_file (const char *, gfc_source_form);
1306 extern gfc_source_form gfc_current_form;
1307 extern char *gfc_source_file;
1308 /* extern locus gfc_current_locus; */
1311 void *gfc_getmem (size_t) ATTRIBUTE_MALLOC;
1312 void gfc_free (void *);
1313 int gfc_terminal_width(void);
1314 void gfc_clear_ts (gfc_typespec *);
1315 FILE *gfc_open_file (const char *);
1316 const char *gfc_article (const char *);
1317 const char *gfc_basic_typename (bt);
1318 const char *gfc_typename (gfc_typespec *);
1320 #define gfc_op2string(OP) (OP == INTRINSIC_ASSIGN ? \
1321 "=" : gfc_code2string (intrinsic_operators, OP))
1323 const char *gfc_code2string (const mstring *, int);
1324 int gfc_string2code (const mstring *, const char *);
1325 const char *gfc_intent_string (sym_intent);
1327 void gfc_init_1 (void);
1328 void gfc_init_2 (void);
1329 void gfc_done_1 (void);
1330 void gfc_done_2 (void);
1333 unsigned int gfc_init_options (unsigned int, const char **);
1334 int gfc_handle_option (size_t, const char *, int);
1335 bool gfc_post_options (const char **);
1338 char * gfc_get_string (const char *, ...) ATTRIBUTE_PRINTF_1;
1339 void gfc_iresolve_init_1 (void);
1340 void gfc_iresolve_done_1 (void);
1344 typedef struct gfc_error_buf
1347 char message[MAX_ERROR_MESSAGE];
1350 void gfc_error_init_1 (void);
1351 void gfc_buffer_error (int);
1353 void gfc_warning (const char *, ...);
1354 void gfc_warning_now (const char *, ...);
1355 void gfc_clear_warning (void);
1356 void gfc_warning_check (void);
1358 void gfc_error (const char *, ...);
1359 void gfc_error_now (const char *, ...);
1360 void gfc_fatal_error (const char *, ...) ATTRIBUTE_NORETURN;
1361 void gfc_internal_error (const char *, ...) ATTRIBUTE_NORETURN;
1362 void gfc_clear_error (void);
1363 int gfc_error_check (void);
1365 try gfc_notify_std (int, const char *, ...);
1367 /* A general purpose syntax error. */
1368 #define gfc_syntax_error(ST) \
1369 gfc_error ("Syntax error in %s statement at %C", gfc_ascii_statement (ST));
1371 void gfc_push_error (gfc_error_buf *);
1372 void gfc_pop_error (gfc_error_buf *);
1374 void gfc_status (const char *, ...) ATTRIBUTE_PRINTF_1;
1375 void gfc_status_char (char);
1377 void gfc_get_errors (int *, int *);
1380 void gfc_arith_init_1 (void);
1381 void gfc_arith_done_1 (void);
1383 /* FIXME: These should go to symbol.c, really... */
1384 int gfc_default_integer_kind (void);
1385 int gfc_default_real_kind (void);
1386 int gfc_default_double_kind (void);
1387 int gfc_default_character_kind (void);
1388 int gfc_default_logical_kind (void);
1389 int gfc_default_complex_kind (void);
1390 int gfc_validate_kind (bt, int);
1391 extern int gfc_index_integer_kind;
1394 void gfc_clear_new_implicit (void);
1395 try gfc_add_new_implicit_range (int, int, gfc_typespec *);
1396 try gfc_merge_new_implicit (void);
1397 void gfc_set_implicit_none (void);
1398 void gfc_set_implicit (void);
1400 gfc_typespec *gfc_get_default_type (gfc_symbol *, gfc_namespace *);
1401 try gfc_set_default_type (gfc_symbol *, int, gfc_namespace *);
1403 void gfc_set_component_attr (gfc_component *, symbol_attribute *);
1404 void gfc_get_component_attr (symbol_attribute *, gfc_component *);
1406 void gfc_set_sym_referenced (gfc_symbol * sym);
1408 try gfc_add_allocatable (symbol_attribute *, locus *);
1409 try gfc_add_dimension (symbol_attribute *, locus *);
1410 try gfc_add_external (symbol_attribute *, locus *);
1411 try gfc_add_intrinsic (symbol_attribute *, locus *);
1412 try gfc_add_optional (symbol_attribute *, locus *);
1413 try gfc_add_pointer (symbol_attribute *, locus *);
1414 try gfc_add_result (symbol_attribute *, locus *);
1415 try gfc_add_save (symbol_attribute *, locus *);
1416 try gfc_add_saved_common (symbol_attribute *, locus *);
1417 try gfc_add_target (symbol_attribute *, locus *);
1418 try gfc_add_dummy (symbol_attribute *, locus *);
1419 try gfc_add_generic (symbol_attribute *, locus *);
1420 try gfc_add_common (symbol_attribute *, locus *);
1421 try gfc_add_in_common (symbol_attribute *, locus *);
1422 try gfc_add_in_namelist (symbol_attribute *, locus *);
1423 try gfc_add_sequence (symbol_attribute *, locus *);
1424 try gfc_add_elemental (symbol_attribute *, locus *);
1425 try gfc_add_pure (symbol_attribute *, locus *);
1426 try gfc_add_recursive (symbol_attribute *, locus *);
1427 try gfc_add_function (symbol_attribute *, locus *);
1428 try gfc_add_subroutine (symbol_attribute *, locus *);
1430 try gfc_add_access (symbol_attribute *, gfc_access, locus *);
1431 try gfc_add_flavor (symbol_attribute *, sym_flavor, locus *);
1432 try gfc_add_entry (symbol_attribute *, locus *);
1433 try gfc_add_procedure (symbol_attribute *, procedure_type, locus *);
1434 try gfc_add_intent (symbol_attribute *, sym_intent, locus *);
1435 try gfc_add_explicit_interface (gfc_symbol *, ifsrc,
1436 gfc_formal_arglist *, locus *);
1437 try gfc_add_type (gfc_symbol *, gfc_typespec *, locus *);
1439 void gfc_clear_attr (symbol_attribute *);
1440 try gfc_missing_attr (symbol_attribute *, locus *);
1441 try gfc_copy_attr (symbol_attribute *, symbol_attribute *, locus *);
1443 try gfc_add_component (gfc_symbol *, const char *, gfc_component **);
1444 gfc_symbol *gfc_use_derived (gfc_symbol *);
1445 gfc_symtree *gfc_use_derived_tree (gfc_symtree *);
1446 gfc_component *gfc_find_component (gfc_symbol *, const char *);
1448 gfc_st_label *gfc_get_st_label (int);
1449 void gfc_free_st_label (gfc_st_label *);
1450 void gfc_define_st_label (gfc_st_label *, gfc_sl_type, locus *);
1451 try gfc_reference_st_label (gfc_st_label *, gfc_sl_type);
1453 gfc_namespace *gfc_get_namespace (gfc_namespace *);
1454 gfc_symtree *gfc_new_symtree (gfc_symtree **, const char *);
1455 gfc_symtree *gfc_find_symtree (gfc_symtree *, const char *);
1456 gfc_user_op *gfc_get_uop (const char *);
1457 gfc_user_op *gfc_find_uop (const char *, gfc_namespace *);
1458 void gfc_free_symbol (gfc_symbol *);
1459 gfc_symbol *gfc_new_symbol (const char *, gfc_namespace *);
1460 int gfc_find_symbol (const char *, gfc_namespace *, int, gfc_symbol **);
1461 int gfc_find_sym_tree (const char *, gfc_namespace *, int, gfc_symtree **);
1462 int gfc_get_symbol (const char *, gfc_namespace *, gfc_symbol **);
1463 int gfc_get_sym_tree (const char *, gfc_namespace *, gfc_symtree **);
1464 int gfc_get_ha_symbol (const char *, gfc_symbol **);
1465 int gfc_get_ha_sym_tree (const char *, gfc_symtree **);
1467 int gfc_symbols_could_alias (gfc_symbol *, gfc_symbol *);
1469 void gfc_undo_symbols (void);
1470 void gfc_commit_symbols (void);
1471 void gfc_free_namespace (gfc_namespace *);
1473 void gfc_symbol_init_2 (void);
1474 void gfc_symbol_done_2 (void);
1476 void gfc_traverse_symtree (gfc_namespace *, void (*)(gfc_symtree *));
1477 void gfc_traverse_ns (gfc_namespace *, void (*)(gfc_symbol *));
1478 void gfc_traverse_user_op (gfc_namespace *, void (*)(gfc_user_op *));
1479 void gfc_save_all (gfc_namespace *);
1481 void gfc_symbol_state (void);
1484 extern int gfc_init_expr;
1486 /* Given a symbol that we have decided is intrinsic, mark it as such
1487 by placing it into a special module that is otherwise impossible to
1490 #define gfc_intrinsic_symbol(SYM) strcpy (SYM->module, "(intrinsic)")
1492 void gfc_intrinsic_init_1 (void);
1493 void gfc_intrinsic_done_1 (void);
1495 char gfc_type_letter (bt);
1496 gfc_symbol * gfc_get_intrinsic_sub_symbol (const char *);
1497 try gfc_convert_type (gfc_expr *, gfc_typespec *, int);
1498 try gfc_convert_type_warn (gfc_expr *, gfc_typespec *, int, int);
1499 int gfc_generic_intrinsic (const char *);
1500 int gfc_specific_intrinsic (const char *);
1501 int gfc_intrinsic_name (const char *, int);
1502 gfc_intrinsic_sym *gfc_find_function (const char *);
1504 match gfc_intrinsic_func_interface (gfc_expr *, int);
1505 match gfc_intrinsic_sub_interface (gfc_code *, int);
1508 void gfc_simplify_init_1 (void);
1509 void gfc_simplify_done_1 (void);
1511 /* match.c -- FIXME */
1512 void gfc_free_iterator (gfc_iterator *, int);
1513 void gfc_free_forall_iterator (gfc_forall_iterator *);
1514 void gfc_free_alloc_list (gfc_alloc *);
1515 void gfc_free_namelist (gfc_namelist *);
1516 void gfc_free_equiv (gfc_equiv *);
1517 void gfc_free_data (gfc_data *);
1518 void gfc_free_case_list (gfc_case *);
1521 void gfc_free_actual_arglist (gfc_actual_arglist *);
1522 gfc_actual_arglist *gfc_copy_actual_arglist (gfc_actual_arglist *);
1523 const char *gfc_extract_int (gfc_expr *, int *);
1525 gfc_expr *gfc_build_conversion (gfc_expr *);
1526 void gfc_free_ref_list (gfc_ref *);
1527 void gfc_type_convert_binary (gfc_expr *);
1528 int gfc_is_constant_expr (gfc_expr *);
1529 try gfc_simplify_expr (gfc_expr *, int);
1531 gfc_expr *gfc_get_expr (void);
1532 void gfc_free_expr (gfc_expr *);
1533 void gfc_replace_expr (gfc_expr *, gfc_expr *);
1534 gfc_expr *gfc_int_expr (int);
1535 gfc_expr *gfc_logical_expr (int, locus *);
1536 mpz_t *gfc_copy_shape (mpz_t *, int);
1537 gfc_expr *gfc_copy_expr (gfc_expr *);
1539 try gfc_specification_expr (gfc_expr *);
1541 int gfc_numeric_ts (gfc_typespec *);
1542 int gfc_kind_max (gfc_expr *, gfc_expr *);
1544 try gfc_check_conformance (const char *, gfc_expr *, gfc_expr *);
1545 try gfc_check_assign (gfc_expr *, gfc_expr *, int);
1546 try gfc_check_pointer_assign (gfc_expr *, gfc_expr *);
1547 try gfc_check_assign_symbol (gfc_symbol *, gfc_expr *);
1549 gfc_expr *gfc_default_initializer (gfc_typespec *);
1552 extern gfc_code new_st;
1554 void gfc_clear_new_st (void);
1555 gfc_code *gfc_get_code (void);
1556 gfc_code *gfc_append_code (gfc_code *, gfc_code *);
1557 void gfc_free_statement (gfc_code *);
1558 void gfc_free_statements (gfc_code *);
1561 try gfc_resolve_expr (gfc_expr *);
1562 void gfc_resolve (gfc_namespace *);
1563 int gfc_impure_variable (gfc_symbol *);
1564 int gfc_pure (gfc_symbol *);
1565 int gfc_elemental (gfc_symbol *);
1566 try gfc_resolve_iterator (gfc_iterator *);
1567 try gfc_resolve_index (gfc_expr *, int);
1570 void gfc_free_array_spec (gfc_array_spec *);
1571 gfc_array_ref *gfc_copy_array_ref (gfc_array_ref *);
1573 try gfc_set_array_spec (gfc_symbol *, gfc_array_spec *, locus *);
1574 gfc_array_spec *gfc_copy_array_spec (gfc_array_spec *);
1575 try gfc_resolve_array_spec (gfc_array_spec *, int);
1577 int gfc_compare_array_spec (gfc_array_spec *, gfc_array_spec *);
1579 gfc_expr *gfc_start_constructor (bt, int, locus *);
1580 void gfc_append_constructor (gfc_expr *, gfc_expr *);
1581 void gfc_free_constructor (gfc_constructor *);
1582 void gfc_simplify_iterator_var (gfc_expr *);
1583 try gfc_expand_constructor (gfc_expr *);
1584 int gfc_constant_ac (gfc_expr *);
1585 int gfc_expanded_ac (gfc_expr *);
1586 try gfc_resolve_array_constructor (gfc_expr *);
1587 try gfc_check_constructor_type (gfc_expr *);
1588 try gfc_check_iter_variable (gfc_expr *);
1589 try gfc_check_constructor (gfc_expr *, try (*)(gfc_expr *));
1590 gfc_constructor *gfc_copy_constructor (gfc_constructor * src);
1591 gfc_expr *gfc_get_array_element (gfc_expr *, int);
1592 try gfc_array_size (gfc_expr *, mpz_t *);
1593 try gfc_array_dimen_size (gfc_expr *, int, mpz_t *);
1594 try gfc_array_ref_shape (gfc_array_ref *, mpz_t *);
1595 gfc_array_ref *gfc_find_array_ref (gfc_expr *);
1596 void gfc_insert_constructor (gfc_expr *, gfc_constructor *);
1597 gfc_constructor *gfc_get_constructor (void);
1598 tree gfc_conv_array_initializer (tree type, gfc_expr * expr);
1599 try spec_size (gfc_array_spec *, mpz_t *);
1601 /* interface.c -- FIXME: some of these should be in symbol.c */
1602 void gfc_free_interface (gfc_interface *);
1603 int gfc_compare_types (gfc_typespec *, gfc_typespec *);
1604 void gfc_check_interfaces (gfc_namespace *);
1605 void gfc_procedure_use (gfc_symbol *, gfc_actual_arglist **, locus *);
1606 gfc_symbol *gfc_search_interface (gfc_interface *, int,
1607 gfc_actual_arglist **);
1608 try gfc_extend_expr (gfc_expr *);
1609 void gfc_free_formal_arglist (gfc_formal_arglist *);
1610 try gfc_extend_assign (gfc_code *, gfc_namespace *);
1611 try gfc_add_interface (gfc_symbol * sym);
1614 extern gfc_st_label format_asterisk;
1616 void gfc_free_open (gfc_open *);
1617 try gfc_resolve_open (gfc_open *);
1618 void gfc_free_close (gfc_close *);
1619 try gfc_resolve_close (gfc_close *);
1620 void gfc_free_filepos (gfc_filepos *);
1621 try gfc_resolve_filepos (gfc_filepos *);
1622 void gfc_free_inquire (gfc_inquire *);
1623 try gfc_resolve_inquire (gfc_inquire *);
1624 void gfc_free_dt (gfc_dt *);
1625 try gfc_resolve_dt (gfc_dt *);
1628 void gfc_module_init_2 (void);
1629 void gfc_module_done_2 (void);
1630 void gfc_dump_module (const char *, int);
1633 symbol_attribute gfc_variable_attr (gfc_expr *, gfc_typespec *);
1634 symbol_attribute gfc_expr_attr (gfc_expr *);
1637 void gfc_generate_code (gfc_namespace *);
1638 void gfc_generate_module_code (gfc_namespace *);
1641 typedef int (*compare_fn) (void *, void *);
1642 void gfc_insert_bbt (void *, void *, compare_fn);
1643 void gfc_delete_bbt (void *, void *, compare_fn);
1645 /* dump-parse-tree.c */
1646 void gfc_show_namespace (gfc_namespace *);
1649 try gfc_parse_file (void);
1651 #endif /* GFC_GFC_H */