xref: /netbsd-src/external/gpl3/gdb.old/dist/gdb/namespace.h (revision f8cf1a9151c7af1cb0bd8b09c13c66bca599c027)
1 /* Code dealing with "using" directives for GDB.
2    Copyright (C) 2003-2023 Free Software Foundation, Inc.
3 
4    This file is part of GDB.
5 
6    This program is free software; you can redistribute it and/or modify
7    it under the terms of the GNU General Public License as published by
8    the Free Software Foundation; either version 3 of the License, or
9    (at your option) any later version.
10 
11    This program is distributed in the hope that it will be useful,
12    but WITHOUT ANY WARRANTY; without even the implied warranty of
13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14    GNU General Public License for more details.
15 
16    You should have received a copy of the GNU General Public License
17    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
18 
19 #ifndef NAMESPACE_H
20 #define NAMESPACE_H
21 
22 #include "gdbsupport/gdb_vecs.h"
23 #include "gdbsupport/gdb_obstack.h"
24 
25 /* This struct is designed to store data from using directives.  It
26    says that names from namespace IMPORT_SRC should be visible within
27    namespace IMPORT_DEST.  These form a linked list; NEXT is the next
28    element of the list.  If the imported namespace or declaration has
29    been aliased within the IMPORT_DEST namespace, ALIAS is set to a
30    string representing the alias.  Otherwise, ALIAS is NULL.
31    DECLARATION is the name of the imported declaration, if this import
32    statement represents one.  Otherwise DECLARATION is NULL and this
33    import statement represents a namespace.
34 
35    C++:      using namespace A;
36    Fortran:  use A
37    import_src = "A"
38    import_dest = local scope of the import statement even such as ""
39    alias = NULL
40    declaration = NULL
41    excludes = NULL
42 
43    C++:      using A::x;
44    Fortran:  use A, only: x
45    import_src = "A"
46    import_dest = local scope of the import statement even such as ""
47    alias = NULL
48    declaration = "x"
49    excludes = NULL
50    The declaration will get imported as import_dest::x.
51 
52    C++ has no way to import all names except those listed ones.
53    Fortran:  use A, localname => x
54    import_src = "A"
55    import_dest = local scope of the import statement even such as ""
56    alias = "localname"
57    declaration = "x"
58    excludes = NULL
59    +
60    import_src = "A"
61    import_dest = local scope of the import statement even such as ""
62    alias = NULL
63    declaration = NULL
64    excludes = ["x"]
65    All the entries of A get imported except of "x".  "x" gets imported as
66    "localname".  "x" is not defined as a local name by this statement.
67 
68    C++:      namespace LOCALNS = A;
69    Fortran has no way to address non-local namespace/module.
70    import_src = "A"
71    import_dest = local scope of the import statement even such as ""
72    alias = "LOCALNS"
73    declaration = NULL
74    excludes = NULL
75    The namespace will get imported as the import_dest::LOCALNS
76    namespace.
77 
78    C++ cannot express it, it would be something like: using localname
79    = A::x;
80    Fortran:  use A, only localname => x
81    import_src = "A"
82    import_dest = local scope of the import statement even such as ""
83    alias = "localname"
84    declaration = "x"
85    excludes = NULL
86    The declaration will get imported as localname or
87    `import_dest`localname.  */
88 
89 struct using_direct
90 {
91   const char *import_src;
92   const char *import_dest;
93 
94   const char *alias;
95   const char *declaration;
96 
97   struct using_direct *next;
98 
99   /* Used during import search to temporarily mark this node as
100      searched.  */
101   int searched;
102 
103   /* USING_DIRECT has variable allocation size according to the number of
104      EXCLUDES entries, the last entry is NULL.  */
105   const char *excludes[1];
106 };
107 
108 extern void add_using_directive (struct using_direct **using_directives,
109 				 const char *dest,
110 				 const char *src,
111 				 const char *alias,
112 				 const char *declaration,
113 				 const std::vector<const char *> &excludes,
114 				 int copy_names,
115 				 struct obstack *obstack);
116 
117 #endif /* NAMESPACE_H */
118