1 /* Array and structure constructors
2    Copyright (C) 2009-2021 Free Software Foundation, Inc.
3 
4 This file is part of GCC.
5 
6 GCC is free software; you can redistribute it and/or modify it under
7 the terms of the GNU General Public License as published by the Free
8 Software Foundation; either version 3, or (at your option) any later
9 version.
10 
11 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
12 WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
14 for more details.
15 
16 You should have received a copy of the GNU General Public License
17 along with GCC; see the file COPYING3.  If not see
18 <http://www.gnu.org/licenses/>.  */
19 
20 #ifndef GFC_CONSTRUCTOR_H
21 #define GFC_CONSTRUCTOR_H
22 
23 /* Get a new constructor structure.  */
24 gfc_constructor *gfc_constructor_get (void);
25 
26 gfc_constructor_base gfc_constructor_get_base (void);
27 
28 /* Copy a constructor structure.  */
29 gfc_constructor_base gfc_constructor_copy (gfc_constructor_base base);
30 
31 
32 /* Free a gfc_constructor structure.  */
33 void gfc_constructor_free (gfc_constructor_base base);
34 
35 
36 /* Given an constructor structure, append the expression node onto
37    the constructor. Returns the constructor node appended.  */
38 gfc_constructor *gfc_constructor_append (gfc_constructor_base *base,
39 					 gfc_constructor *c);
40 
41 gfc_constructor *gfc_constructor_append_expr (gfc_constructor_base *base,
42 					      gfc_expr *e, locus *where);
43 
44 
45 /* Given an constructor structure, place the expression node at position.
46    Returns the constructor node inserted.  */
47 gfc_constructor *gfc_constructor_insert (gfc_constructor_base *base,
48 					 gfc_constructor *c, int n);
49 
50 gfc_constructor *gfc_constructor_insert_expr (gfc_constructor_base *base,
51 					      gfc_expr *e, locus *where,
52 					      int n);
53 
54 /* Given an array constructor expression and an element number (starting
55    at zero), return a pointer to the array element.  NULL is returned if
56    the size of the array has been exceeded. The expression node returned
57    remains a part of the array and should not be freed.  */
58 
59 gfc_constructor *gfc_constructor_lookup (gfc_constructor_base base, int n);
60 
61 /* Convenience function. Same as ...
62      gfc_constructor *c = gfc_constructor_lookup (base, n);
63      gfc_expr *e = c ? c->expr : NULL;
64 */
65 gfc_expr *gfc_constructor_lookup_expr (gfc_constructor_base base, int n);
66 
67 
68 int gfc_constructor_expr_foreach (gfc_constructor *ctor, int(*)(gfc_expr *));
69 
70 
71 void gfc_constructor_swap (gfc_constructor *ctor, int n, int m);
72 
73 
74 
75 /* Get the first constructor node in the constructure structure.
76    Returns NULL if there is no such expression.  */
77 gfc_constructor *gfc_constructor_first (gfc_constructor_base base);
78 
79 /* Get the next constructor node in the constructure structure.
80    Returns NULL if there is no next expression.  */
81 gfc_constructor *gfc_constructor_next (gfc_constructor *ctor);
82 
83 /* Remove the gfc_constructor node from the splay tree.  */
84 void gfc_constructor_remove (gfc_constructor *);
85 
86 /* Return first constructor node after offset.  */
87 gfc_constructor *gfc_constructor_lookup_next (gfc_constructor_base, int);
88 
89 #endif /* GFC_CONSTRUCTOR_H */
90