1 /*
2 * Copyright (c) 2018, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation.
8 *
9 * This code is distributed in the hope that it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
12 * version 2 for more details (a copy is included in the LICENSE file that
13 * accompanied this code).
14 *
15 * You should have received a copy of the GNU General Public License version
16 * 2 along with this work; if not, write to the Free Software Foundation,
17 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
18 *
19 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
20 * or visit www.oracle.com if you need additional information or have any
21 * questions.
22 */
23 package com.sun.tools.jextract;
24
25 import java.nio.file.Path;
26 import java.nio.file.Paths;
27 import java.util.ArrayList;
28 import java.util.Arrays;
29 import java.util.HashMap;
30 import java.util.List;
31 import java.util.Map;
32 import java.util.Optional;
33 import java.util.stream.Collectors;
34 import com.sun.tools.jextract.parser.Parser;
35 import com.sun.tools.jextract.tree.EnumTree;
36 import com.sun.tools.jextract.tree.HeaderTree;
37 import com.sun.tools.jextract.tree.SimpleTreeVisitor;
38 import com.sun.tools.jextract.tree.StructTree;
39 import com.sun.tools.jextract.tree.Tree;
40 import com.sun.tools.jextract.tree.TreeMaker;
41 import com.sun.tools.jextract.tree.TreePrinter;
42 import com.sun.tools.jextract.tree.TypedefTree;
43 import jdk.internal.clang.Cursor;
44
45 /**
46 * This visitor handles certain typedef declarations.
47 *
48 * 1. Remove redundant typedefs.
49 * 2. Rename typedef'ed anonymous type definitions like
50 * typedef struct { int x; int y; } Point;
51 */
52 final class TypedefHandler extends SimpleTreeVisitor<Void, Void> {
53 private final TreeMaker treeMaker = new TreeMaker();
54
55 // Potential Tree instances that will go into transformed HeaderTree
56 // are collected in this list.
57 private final List<Tree> decls = new ArrayList<>();
58
59 // Tree instances that are to be replaced from "decls" list are
60 // saved in the following Map.
61 private final Map<Cursor, Tree> replacements = new HashMap<>();
62
63 HeaderTree transform(HeaderTree ht) {
64 // Process all header declarations are collect potential
65 // declarations that will go into transformed HeaderTree
66 // into the this.decls field.
67 ht.accept(this, null);
68
69 // Replace trees from this.decls with Trees found in this.replacements.
70 // We need this two step process so that named StructTree instances
71 // will replace with original unnamed StructTree instances.
72 List<Tree> newDecls = decls.stream().map(tx -> {
73 if (replacements.containsKey(tx.cursor())) {
74 return replacements.get(tx.cursor());
75 } else {
76 return tx;
77 }
78 }).collect(Collectors.toList());
79
80 return treeMaker.createHeader(ht.cursor(), ht.path(), newDecls);
81 }
82
83 @Override
84 public Void defaultAction(Tree tree, Void v) {
85 decls.add(tree);
86 return null;
87 }
88
89 @Override
90 public Void visitHeader(HeaderTree ht, Void v) {
91 ht.declarations().forEach(decl -> decl.accept(this, null));
92 return null;
93 }
94
95 @Override
96 public Void visitTypedef(TypedefTree tt, Void v) {
97 Optional<Tree> def = tt.typeDefinition();
98 if (def.isPresent()) {
99 Tree defTree = def.get();
100 if (defTree instanceof StructTree) {
101 if (defTree.name().isEmpty()) {
102 /**
103 * typedef struct { int x; int y; } Point
104 *
105 * is mapped to two Cursors by clang. First one for anonymous struct decl.
106 * and second one for typedef decl. We map it as a single named struct
107 * declaration.
108 */
109 replacements.put(defTree.cursor(), ((StructTree)defTree).withName(tt.name()));
110 return null;
111 } else if (defTree.name().equals(tt.name())) {
112 /*
113 * Remove redundant typedef like:
114 *
115 * typedef struct Point { int x; int y; } Point
116 */
117 return null;
118 }
119 } else if (defTree instanceof EnumTree && defTree.name().equals(tt.name())) {
120 /*
121 * Remove redundant typedef like:
122 *
123 * typedef enum Color { R, G, B} Color
124 */
125 return null;
126 }
127 }
128
129 decls.add(tt);
130 return null;
131 }
132
133 // test main to manually check this visitor
134 public static void main(String[] args) {
135 if (args.length == 0) {
136 System.err.println("Expected a header file");
137 return;
138 }
139
140 Parser p = new Parser(true);
141 List<Path> paths = Arrays.stream(args).map(Paths::get).collect(Collectors.toList());
142 Path builtinInc = Paths.get(System.getProperty("java.home"), "conf", "jextract");
143 List<String> clangArgs = List.of("-I" + builtinInc);
144 List<HeaderTree> headers = p.parse(paths, clangArgs);
145 TreePrinter printer = new TreePrinter();
146 TypedefHandler handler = new TypedefHandler();
147 for (HeaderTree ht : headers) {
148 handler.transform(ht).accept(printer, null);
149 }
150 }
151 }