1/* All matcher functions.
2 Copyright (C) 2003-2026 Free Software Foundation, Inc.
3 Contributed by Steven Bosscher
4
5This file is part of GCC.
6
7GCC is free software; you can redistribute it and/or modify it under
8the terms of the GNU General Public License as published by the Free
9Software Foundation; either version 3, or (at your option) any later
10version.
11
12GCC is distributed in the hope that it will be useful, but WITHOUT ANY
13WARRANTY; without even the implied warranty of MERCHANTABILITY or
14FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
15for more details.
16
17You should have received a copy of the GNU General Public License
18along with GCC; see the file COPYING3. If not see
19<http://www.gnu.org/licenses/>. */
20
21
22#ifndef GFC_MATCH_H
23#define GFC_MATCH_H
24
25/* gfc_new_block points to the symbol of a newly matched block. */
26extern gfc_symbol *gfc_new_block;
27
28/* Current statement label. Zero means no statement label. Because
29 new_st can get wiped during statement matching, we have to keep it
30 separate. */
31extern gfc_st_label *gfc_statement_label;
32
33extern int gfc_matching_ptr_assignment;
34extern int gfc_matching_procptr_assignment;
35extern bool gfc_matching_prefix;
36
37/* Default access specifier while matching procedure bindings. */
38extern gfc_access gfc_typebound_default_access;
39
40/****************** All gfc_match* routines *****************/
41
42/* match.cc. */
43
44/* Generic match subroutines. */
45match gfc_match_special_char (gfc_char_t *);
46match gfc_match_space (void);
47match gfc_match_eos (void);
48match gfc_match_small_literal_int (int *, int *, bool = true);
49match gfc_match_st_label (gfc_st_label **);
50match gfc_match_small_int (int *);
51match gfc_match_name (char *, bool = true);
52match gfc_match_symbol (gfc_symbol **, int);
53match gfc_match_sym_tree (gfc_symtree **, int);
54match gfc_match_intrinsic_op (gfc_intrinsic_op *);
55match gfc_match_char (char, bool = true);
56match gfc_match (const char *, ...);
57match gfc_match_iterator (gfc_iterator *, int);
58match gfc_match_parens (void);
59match gfc_match_type_spec (gfc_typespec *);
60match gfc_match_member_sep(gfc_symbol *);
61
62
63/* Statement matchers. */
64match gfc_match_program (void);
65match gfc_match_pointer_assignment (void);
66match gfc_match_assignment (void);
67match gfc_match_if (gfc_statement *);
68match gfc_match_else (void);
69match gfc_match_elseif (void);
70match gfc_match_event_post (void);
71match gfc_match_event_wait (void);
72match gfc_match_critical (void);
73match gfc_match_fail_image (void);
74match gfc_match_change_team (void);
75match gfc_match_end_team (void);
76match gfc_match_form_team (void);
77match gfc_match_sync_team (void);
78match gfc_match_block (void);
79match gfc_match_associate (void);
80match gfc_match_do (void);
81match gfc_match_cycle (void);
82match gfc_match_exit (void);
83match gfc_match_lock (void);
84match gfc_match_pause (void);
85match gfc_match_stop (void);
86match gfc_match_error_stop (void);
87match gfc_match_continue (void);
88match gfc_match_assign (void);
89match gfc_match_goto (void);
90match gfc_match_sync_all (void);
91match gfc_match_sync_images (void);
92match gfc_match_sync_memory (void);
93match gfc_match_unlock (void);
94
95match gfc_match_allocate (void);
96match gfc_match_nullify (void);
97match gfc_match_deallocate (void);
98match gfc_match_return (void);
99match gfc_match_call (void);
100
101/* We want to use this function to check for a common-block-name
102 that can exist in a bind statement, so removed the "static"
103 declaration of the function in match.cc. */
104
105match gfc_match_common_name (char *name);
106
107match gfc_match_common (void);
108match gfc_match_block_data (void);
109match gfc_match_namelist (void);
110match gfc_match_module (void);
111match gfc_match_equivalence (void);
112match gfc_match_st_function (void);
113match gfc_match_ptr_fcn_assign (void);
114match gfc_match_case (void);
115match gfc_match_select (void);
116match gfc_match_select_type (void);
117match gfc_match_type_is (void);
118match gfc_match_class_is (void);
119match gfc_match_select_rank (void);
120match gfc_match_rank_is (void);
121match gfc_match_where (gfc_statement *);
122match gfc_match_elsewhere (void);
123match gfc_match_forall (gfc_statement *);
124
125/* Other functions. */
126
127gfc_common_head *gfc_get_common (const char *, int);
128
129/* openmp.cc. */
130
131/* OpenACC directive matchers. */
132match gfc_match_oacc_atomic (void);
133match gfc_match_oacc_cache (void);
134match gfc_match_oacc_wait (void);
135match gfc_match_oacc_update (void);
136match gfc_match_oacc_declare (void);
137match gfc_match_oacc_loop (void);
138match gfc_match_oacc_host_data (void);
139match gfc_match_oacc_data (void);
140match gfc_match_oacc_kernels (void);
141match gfc_match_oacc_kernels_loop (void);
142match gfc_match_oacc_parallel (void);
143match gfc_match_oacc_parallel_loop (void);
144match gfc_match_oacc_serial (void);
145match gfc_match_oacc_serial_loop (void);
146match gfc_match_oacc_enter_data (void);
147match gfc_match_oacc_exit_data (void);
148match gfc_match_oacc_routine (void);
149
150/* OpenMP directive matchers. */
151match gfc_match_omp_eos_error (void);
152match gfc_match_omp_allocate (void);
153match gfc_match_omp_allocators (void);
154match gfc_match_omp_assume (void);
155match gfc_match_omp_assumes (void);
156match gfc_match_omp_atomic (void);
157match gfc_match_omp_barrier (void);
158match gfc_match_omp_begin_metadirective (void);
159match gfc_match_omp_cancel (void);
160match gfc_match_omp_cancellation_point (void);
161match gfc_match_omp_critical (void);
162match gfc_match_omp_declare_reduction (void);
163match gfc_match_omp_declare_simd (void);
164match gfc_match_omp_declare_target (void);
165match gfc_match_omp_declare_variant (void);
166match gfc_match_omp_depobj (void);
167match gfc_match_omp_dispatch (void);
168match gfc_match_omp_distribute (void);
169match gfc_match_omp_distribute_parallel_do (void);
170match gfc_match_omp_distribute_parallel_do_simd (void);
171match gfc_match_omp_distribute_simd (void);
172match gfc_match_omp_do (void);
173match gfc_match_omp_do_simd (void);
174match gfc_match_omp_loop (void);
175match gfc_match_omp_error (void);
176match gfc_match_omp_flush (void);
177match gfc_match_omp_groupprivate (void);
178match gfc_match_omp_interop (void);
179match gfc_match_omp_masked (void);
180match gfc_match_omp_masked_taskloop (void);
181match gfc_match_omp_masked_taskloop_simd (void);
182match gfc_match_omp_master (void);
183match gfc_match_omp_master_taskloop (void);
184match gfc_match_omp_master_taskloop_simd (void);
185match gfc_match_omp_metadirective (void);
186match gfc_match_omp_nothing (void);
187match gfc_match_omp_ordered (void);
188match gfc_match_omp_ordered_depend (void);
189match gfc_match_omp_parallel (void);
190match gfc_match_omp_parallel_do (void);
191match gfc_match_omp_parallel_do_simd (void);
192match gfc_match_omp_parallel_loop (void);
193match gfc_match_omp_parallel_masked (void);
194match gfc_match_omp_parallel_masked_taskloop (void);
195match gfc_match_omp_parallel_masked_taskloop_simd (void);
196match gfc_match_omp_parallel_master (void);
197match gfc_match_omp_parallel_master_taskloop (void);
198match gfc_match_omp_parallel_master_taskloop_simd (void);
199match gfc_match_omp_parallel_sections (void);
200match gfc_match_omp_parallel_workshare (void);
201match gfc_match_omp_requires (void);
202match gfc_match_omp_scope (void);
203match gfc_match_omp_scan (void);
204match gfc_match_omp_sections (void);
205match gfc_match_omp_simd (void);
206match gfc_match_omp_single (void);
207match gfc_match_omp_target (void);
208match gfc_match_omp_target_data (void);
209match gfc_match_omp_target_enter_data (void);
210match gfc_match_omp_target_exit_data (void);
211match gfc_match_omp_target_parallel (void);
212match gfc_match_omp_target_parallel_do (void);
213match gfc_match_omp_target_parallel_do_simd (void);
214match gfc_match_omp_target_parallel_loop (void);
215match gfc_match_omp_target_simd (void);
216match gfc_match_omp_target_teams (void);
217match gfc_match_omp_target_teams_distribute (void);
218match gfc_match_omp_target_teams_distribute_parallel_do (void);
219match gfc_match_omp_target_teams_distribute_parallel_do_simd (void);
220match gfc_match_omp_target_teams_distribute_simd (void);
221match gfc_match_omp_target_teams_loop (void);
222match gfc_match_omp_target_update (void);
223match gfc_match_omp_task (void);
224match gfc_match_omp_taskgroup (void);
225match gfc_match_omp_taskloop (void);
226match gfc_match_omp_taskloop_simd (void);
227match gfc_match_omp_taskwait (void);
228match gfc_match_omp_taskyield (void);
229match gfc_match_omp_teams (void);
230match gfc_match_omp_teams_distribute (void);
231match gfc_match_omp_teams_distribute_parallel_do (void);
232match gfc_match_omp_teams_distribute_parallel_do_simd (void);
233match gfc_match_omp_teams_distribute_simd (void);
234match gfc_match_omp_teams_loop (void);
235match gfc_match_omp_threadprivate (void);
236match gfc_match_omp_tile (void);
237match gfc_match_omp_unroll (void);
238match gfc_match_omp_workshare (void);
239match gfc_match_omp_end_critical (void);
240match gfc_match_omp_end_nowait (void);
241match gfc_match_omp_end_single (void);
242
243/* decl.cc. */
244
245match gfc_match_data (void);
246match gfc_match_null (gfc_expr **);
247match gfc_match_kind_spec (gfc_typespec *, bool);
248match gfc_match_decl_type_spec (gfc_typespec *, int);
249
250match gfc_match_end (gfc_statement *);
251match gfc_match_data_decl (void);
252match gfc_match_formal_arglist (gfc_symbol *, int, int, bool = false);
253match gfc_match_procedure (void);
254match gfc_match_generic (void);
255match gfc_match_function_decl (void);
256match gfc_match_entry (void);
257match gfc_match_subroutine (void);
258match gfc_match_submod_proc (void);
259match gfc_match_map (void);
260match gfc_match_union (void);
261match gfc_match_structure_decl (void);
262match gfc_match_derived_decl (void);
263match gfc_match_final_decl (void);
264match gfc_match_type (gfc_statement *);
265
266match gfc_match_implicit_none (void);
267match gfc_match_implicit (void);
268
269void gfc_set_constant_character_len (gfc_charlen_t, gfc_expr *,
270 gfc_charlen_t);
271
272/* Matchers for attribute declarations. */
273match gfc_match_allocatable (void);
274match gfc_match_asynchronous (void);
275match gfc_match_automatic (void);
276match gfc_match_codimension (void);
277match gfc_match_contiguous (void);
278match gfc_match_dimension (void);
279match gfc_match_external (void);
280match gfc_match_gcc_attributes (void);
281match gfc_match_gcc_builtin (void);
282match gfc_match_gcc_ivdep (void);
283match gfc_match_gcc_novector (void);
284match gfc_match_gcc_unroll (void);
285match gfc_match_gcc_vector (void);
286match gfc_match_import (void);
287match gfc_match_intent (void);
288match gfc_match_intrinsic (void);
289match gfc_match_optional (void);
290match gfc_match_parameter (void);
291match gfc_match_pointer (void);
292match gfc_match_protected (void);
293match gfc_match_private (gfc_statement *);
294match gfc_match_public (gfc_statement *);
295match gfc_match_save (void);
296match gfc_match_static (void);
297match gfc_match_modproc (void);
298match gfc_match_target (void);
299match gfc_match_value (void);
300match gfc_match_volatile (void);
301
302/* decl.cc. */
303
304/* Fortran 2003 c interop.
305 TODO: some of these should be moved to another file rather than decl.cc */
306match gfc_match_bind_c_stmt (void);
307match gfc_match_bind_c (gfc_symbol *, bool);
308
309/* primary.cc. */
310match gfc_match_structure_constructor (gfc_symbol *, gfc_symtree *, gfc_expr **);
311match gfc_match_variable (gfc_expr **, int);
312match gfc_match_equiv_variable (gfc_expr **);
313match gfc_match_actual_arglist (int, gfc_actual_arglist **, bool = false);
314match gfc_match_literal_constant (gfc_expr **, int);
315
316/* expr.cc -- FIXME: this one should be eliminated by moving the
317 matcher to matchexp.cc and a call to a new function in expr.cc that
318 only makes sure the init expr. is valid. */
319bool gfc_reduce_init_expr (gfc_expr *expr);
320match gfc_match_init_expr (gfc_expr **);
321
322/* array.cc. */
323match gfc_match_array_spec (gfc_array_spec **, bool, bool);
324match gfc_match_array_ref (gfc_array_ref *, gfc_array_spec *, int, int,
325 bool = false);
326match gfc_match_array_constructor (gfc_expr **);
327
328/* interface.cc. */
329match gfc_match_abstract_interface (void);
330match gfc_match_generic_spec (interface_type *, char *, gfc_intrinsic_op *);
331match gfc_match_interface (void);
332match gfc_match_end_interface (void);
333
334/* io.cc. */
335match gfc_match_format (void);
336match gfc_match_open (void);
337match gfc_match_close (void);
338match gfc_match_endfile (void);
339match gfc_match_backspace (void);
340match gfc_match_rewind (void);
341match gfc_match_flush (void);
342match gfc_match_inquire (void);
343match gfc_match_read (void);
344match gfc_match_wait (void);
345match gfc_match_write (void);
346match gfc_match_print (void);
347
348/* matchexp.cc. */
349match gfc_match_defined_op_name (char *, int);
350match gfc_match_expr (gfc_expr **);
351
352/* module.cc. */
353match gfc_match_use (void);
354match gfc_match_submodule (void);
355void gfc_use_modules (void);
356
357#endif /* GFC_MATCH_H */
358
359

source code of gcc/fortran/match.h