Skip to content

Commit ff5491e

Browse files
kornilova203kornilova203
committed
Replace opaque type with CStruct0
Add comment line to incomplete types
1 parent b2ba298 commit ff5491e

File tree

18 files changed

+219
-32
lines changed

18 files changed

+219
-32
lines changed

‎bindgen/Utils.h

+16
Original file line numberDiff line numberDiff line change
@@ -126,4 +126,20 @@ template <typename T> static inline bool isAliasForType(Type *type) {
126126
return false;
127127
}
128128

129+
/**
130+
* @return true if typedef references opaque type directly or through a
131+
* chain of typedefs.
132+
*/
133+
static inline bool isAliasForOpaqueType(const Type *type) {
134+
assert(type);
135+
auto *typeDef = dynamic_cast<const TypeDef *>(type);
136+
if (typeDef) {
137+
if (!typeDef->getType()) {
138+
return true;
139+
}
140+
return isAliasForOpaqueType(typeDef->getType().get());
141+
}
142+
return false;
143+
}
144+
129145
#endif // UTILS_H

‎bindgen/defines/DefineFinder.cpp

-3
Original file line numberDiff line numberDiff line change
@@ -104,9 +104,6 @@ void DefineFinder::MacroUndefined(const clang::Token &macroNameTok,
104104
const clang::MacroDefinition &md,
105105
const clang::MacroDirective *undef) {
106106
clang::SourceManager &sm = compiler.getSourceManager();
107-
if (!sm.isInMainFile(undef->getLocation())) {
108-
return;
109-
}
110107
if (sm.isWrittenInMainFile(macroNameTok.getLocation()) &&
111108
md.getMacroInfo() && !md.getMacroInfo()->isFunctionLike()) {
112109
std::string macroName = macroNameTok.getIdentifierInfo()->getName();

‎bindgen/ir/Function.cpp

+4-2
Original file line numberDiff line numberDiff line change
@@ -72,12 +72,14 @@ bool Function::isLegalScalaNativeFunction() const {
7272
/* Return type and parameters types cannot be array types because array type
7373
* in this case is always represented as a pointer to element type */
7474
if (isAliasForType<Struct>(retType.get()) ||
75-
isAliasForType<Union>(retType.get())) {
75+
isAliasForType<Union>(retType.get()) ||
76+
isAliasForOpaqueType(retType.get())) {
7677
return false;
7778
}
7879
for (const auto &parameter : parameters) {
7980
if (isAliasForType<Struct>(parameter->getType().get()) ||
80-
isAliasForType<Union>(parameter->getType().get())) {
81+
isAliasForType<Union>(parameter->getType().get()) ||
82+
isAliasForOpaqueType(parameter->getType().get())) {
8183
return false;
8284
}
8385
}

‎bindgen/ir/IR.cpp

+42-8
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
#include "IR.h"
22
#include "../Utils.h"
3+
#include "types/PointerType.h"
34

45
IR::IR(std::string libName, std::string linkName, std::string objectName,
56
std::string packageName, const LocationManager &locationManager)
@@ -111,26 +112,49 @@ llvm::raw_ostream &operator<<(llvm::raw_ostream &s, const IR &ir) {
111112
for (const auto &typeDef : ir.typeDefs) {
112113
if (ir.shouldOutput(typeDef)) {
113114
s << *typeDef;
115+
if (typeDef->getType()) {
116+
auto *structOrUnion =
117+
dynamic_cast<StructOrUnion *>(typeDef->getType().get());
118+
if (structOrUnion &&
119+
structOrUnion->hasIllegalUsageOfOpaqueType()) {
120+
llvm::errs()
121+
<< "Error: record " << structOrUnion->getName()
122+
<< " has field of incomplete type. Declarations "
123+
"that use this type may not work properly.\n";
124+
llvm::errs().flush();
125+
}
126+
}
114127
}
115128
}
116129

117130
for (const auto &variable : ir.variables) {
118-
s << *variable;
131+
if (!variable->hasIllegalUsageOfOpaqueType()) {
132+
s << *variable;
133+
} else {
134+
llvm::errs() << "Error: Variable " << variable->getName()
135+
<< " is skipped because it has incomplete type.\n";
136+
}
119137
}
120138

121139
for (const auto &varDefine : ir.varDefines) {
122-
s << *varDefine;
140+
if (!varDefine->hasIllegalUsageOfOpaqueType()) {
141+
s << *varDefine;
142+
} else {
143+
llvm::errs() << "Error: Variable alias " << varDefine->getName()
144+
<< " is skipped because it has incomplete type\n";
145+
llvm::errs().flush();
146+
}
123147
}
124148

125149
for (const auto &func : ir.functions) {
126-
if (func->isLegalScalaNativeFunction()) {
127-
s << *func;
128-
} else {
150+
if (!func->isLegalScalaNativeFunction()) {
129151
llvm::errs()
130152
<< "Warning: Function " << func->getName()
131153
<< " is skipped because Scala Native does not support "
132154
"passing structs and arrays by value.\n";
133155
llvm::errs().flush();
156+
} else {
157+
s << *func;
134158
}
135159
}
136160

@@ -167,13 +191,14 @@ llvm::raw_ostream &operator<<(llvm::raw_ostream &s, const IR &ir) {
167191
s << "object " << ir.libName << "Helpers {\n";
168192

169193
for (const auto &st : ir.structs) {
170-
if (ir.shouldOutput(st) && st->hasHelperMethods()) {
194+
if (ir.shouldOutput(st) && st->hasHelperMethods() &&
195+
!st->hasIllegalUsageOfOpaqueType()) {
171196
s << "\n" << st->generateHelperClass();
172197
}
173198
}
174199

175200
for (const auto &u : ir.unions) {
176-
if (ir.shouldOutput(u)) {
201+
if (ir.shouldOutput(u) && !u->hasIllegalUsageOfOpaqueType()) {
177202
s << "\n" << u->generateHelperClass();
178203
}
179204
}
@@ -446,5 +471,14 @@ bool IR::hasOutputtedDeclaration(
446471

447472
template <typename T>
448473
bool IR::shouldOutput(const std::shared_ptr<T> &type) const {
449-
return inMainFile(*type) || isTypeUsed(type, true);
474+
if (isTypeUsed(type, true)) {
475+
return true;
476+
}
477+
auto *typeDef = dynamic_cast<TypeDef *>(type.get());
478+
if (typeDef) {
479+
/* unused typedefs from main file are not printed if they are aliases
480+
* for opaque types */
481+
return !isAliasForOpaqueType(typeDef) && inMainFile(*typeDef);
482+
}
483+
return inMainFile(*type);
450484
}

‎bindgen/ir/IR.h

+7-3
Original file line numberDiff line numberDiff line change
@@ -148,9 +148,13 @@ class IR {
148148
template <typename T> bool inMainFile(const T &type) const;
149149

150150
/**
151-
* @tparam T Type subclass
152-
* @return true if type is in main file or it is used by declaration from
153-
* main file.
151+
* @tparam T Enum, Struct, Union or TypeDef
152+
* @return true if the type will be printed.
153+
* Following types are not printed:
154+
* - Unused types from included headers
155+
* - Unused typedefs from main header if they reference an opaque
156+
* type (if such typedef is used then true is returned but error
157+
* message is printed when bindings are generated)
154158
*/
155159
template <typename T>
156160
bool shouldOutput(const std::shared_ptr<T> &type) const;

‎bindgen/ir/Struct.cpp

+9
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,15 @@ std::shared_ptr<Location> StructOrUnion::getLocation() const {
7777
return location;
7878
}
7979

80+
bool StructOrUnion::hasIllegalUsageOfOpaqueType() const {
81+
for (const auto &field : fields) {
82+
if (isAliasForOpaqueType(field->getType().get())) {
83+
return true;
84+
}
85+
}
86+
return false;
87+
}
88+
8089
Struct::Struct(std::string name, std::vector<Field *> fields, uint64_t typeSize,
8190
std::shared_ptr<Location> location)
8291
: StructOrUnion(std::move(name), std::move(fields), std::move(location)),

‎bindgen/ir/Struct.h

+6
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,12 @@ class StructOrUnion {
3737

3838
virtual std::string getTypeAlias() const = 0;
3939

40+
/**
41+
* @return true if the record contains field of opaque type or an array
42+
* of elements of opaque type.
43+
*/
44+
bool hasIllegalUsageOfOpaqueType() const;
45+
4046
protected:
4147
std::string name;
4248
std::vector<Field *> fields;

‎bindgen/ir/TypeDef.cpp

+6-7
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,13 @@ TypeDef::TypeDef(std::string name, std::shared_ptr<Type> type,
99
location(std::move(location)) {}
1010

1111
llvm::raw_ostream &operator<<(llvm::raw_ostream &s, const TypeDef &typeDef) {
12-
if (!typeDef.getType()) {
13-
llvm::errs() << "Error: type definition for " << typeDef.getName()
14-
<< " was not found.\n";
15-
llvm::errs().flush();
16-
return s;
12+
s << " type " << handleReservedWords(typeDef.name) << " = ";
13+
if (typeDef.type) {
14+
s << typeDef.getType()->str();
15+
} else {
16+
s << "native.CStruct0 // incomplete type";
1717
}
18-
s << " type " + handleReservedWords(typeDef.name) + " = " +
19-
typeDef.getType()->str() + "\n";
18+
s << "\n";
2019
return s;
2120
}
2221

‎bindgen/ir/VarDefine.cpp

+4
Original file line numberDiff line numberDiff line change
@@ -10,3 +10,7 @@ llvm::raw_ostream &operator<<(llvm::raw_ostream &s,
1010
<< varDefine.variable->getType()->str() << " = native.extern\n";
1111
return s;
1212
}
13+
14+
bool VarDefine::hasIllegalUsageOfOpaqueType() const {
15+
return variable->hasIllegalUsageOfOpaqueType();
16+
}

‎bindgen/ir/VarDefine.h

+2
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,8 @@ class VarDefine : public Define {
1414
friend llvm::raw_ostream &operator<<(llvm::raw_ostream &s,
1515
const VarDefine &varDefine);
1616

17+
bool hasIllegalUsageOfOpaqueType() const;
18+
1719
private:
1820
std::shared_ptr<Variable> variable;
1921
};

‎bindgen/ir/Variable.cpp

+6-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
#include "Variable.h"
2+
#include "../Utils.h"
23

34
Variable::Variable(const std::string &name, std::shared_ptr<Type> type)
45
: TypeAndName(name, type) {}
@@ -7,4 +8,8 @@ llvm::raw_ostream &operator<<(llvm::raw_ostream &s, const Variable &variable) {
78
s << " val " << variable.getName() << ": " << variable.getType()->str()
89
<< " = native.extern\n";
910
return s;
10-
}
11+
}
12+
13+
bool Variable::hasIllegalUsageOfOpaqueType() const {
14+
return isAliasForOpaqueType(type.get());
15+
}

‎bindgen/ir/Variable.h

+2
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@ class Variable : public TypeAndName {
1010

1111
friend llvm::raw_ostream &operator<<(llvm::raw_ostream &s,
1212
const Variable &variable);
13+
14+
bool hasIllegalUsageOfOpaqueType() const;
1315
};
1416

1517
#endif // SCALA_NATIVE_BINDGEN_VARIABLE_H

‎tests/samples/OpaqueTypes.h

+36
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
#include "include/OpaqueTypes.h"
2+
13
typedef struct points points;
24

35
struct point;
@@ -21,3 +23,37 @@ struct point {
2123
int x;
2224
int y;
2325
};
26+
27+
struct undefinedStruct;
28+
29+
void usePointerToUndefinedStruct(struct undefinedStruct *);
30+
31+
struct structWithPointerToUndefinedStruct {
32+
struct undefinedStruct *field;
33+
};
34+
35+
union unionWithPointerToUndefinedStruct {
36+
struct undefinedStruct *field;
37+
};
38+
39+
typedef union undefinedUnion undefinedUnion;
40+
41+
typedef undefinedUnion *aliasToPointerOfUndefinedUnion;
42+
43+
aliasToPointerOfUndefinedUnion *fun();
44+
45+
typedef struct undefinedStruct aliasForUndefinedStruct; // okay
46+
47+
aliasForUndefinedStruct *returnPointerToAliasOfUndefinedStruct();
48+
49+
void usePointerToUndefinedIncludedStruct(undefinedIncludedStruct *);
50+
51+
typedef aliasToPointerOfUndefinedUnion (
52+
*functionPointerWithPointerToOpaqueType)(struct undefinedStruct **);
53+
54+
void useUndefinedStruct(
55+
struct undefinedStruct); // removed. Error message is printed
56+
57+
extern struct undefinedStruct removedExtern; // removed
58+
59+
#define removedExternAlias removedExtern // removed

‎tests/samples/OpaqueTypes.scala

+26
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,27 @@ import scala.scalanative.native._
66
@native.link("bindgentests")
77
@native.extern
88
object OpaqueTypes {
9+
type struct_undefinedIncludedStruct = native.CStruct0 // incomplete type
10+
type undefinedIncludedStruct = struct_undefinedIncludedStruct
911
type struct_points = native.CStruct2[native.Ptr[struct_point], native.Ptr[struct_point]]
1012
type points = struct_points
1113
type struct_point = native.CStruct2[native.CInt, native.CInt]
1214
type union_u = native.CArray[Byte, native.Nat._4]
1315
type u = union_u
16+
type struct_undefinedStruct = native.CStruct0 // incomplete type
17+
type struct_structWithPointerToUndefinedStruct = native.CStruct1[native.Ptr[struct_undefinedStruct]]
18+
type union_unionWithPointerToUndefinedStruct = native.CArray[Byte, native.Nat._8]
19+
type union_undefinedUnion = native.CStruct0 // incomplete type
20+
type undefinedUnion = union_undefinedUnion
21+
type aliasToPointerOfUndefinedUnion = native.Ptr[undefinedUnion]
22+
type aliasForUndefinedStruct = struct_undefinedStruct
23+
type functionPointerWithPointerToOpaqueType = native.CFunctionPtr1[native.Ptr[native.Ptr[struct_undefinedStruct]], native.Ptr[undefinedUnion]]
1424
def move(point: native.Ptr[struct_point], x: native.CInt, y: native.CInt): native.Ptr[struct_point] = native.extern
1525
def processPoints(p: native.Ptr[points]): native.Ptr[union_u] = native.extern
26+
def usePointerToUndefinedStruct(anonymous0: native.Ptr[struct_undefinedStruct]): Unit = native.extern
27+
def fun(): native.Ptr[native.Ptr[undefinedUnion]] = native.extern
28+
def returnPointerToAliasOfUndefinedStruct(): native.Ptr[aliasForUndefinedStruct] = native.extern
29+
def usePointerToUndefinedIncludedStruct(anonymous0: native.Ptr[undefinedIncludedStruct]): Unit = native.extern
1630
}
1731

1832
import OpaqueTypes._
@@ -37,10 +51,22 @@ object OpaqueTypesHelpers {
3751

3852
def struct_point()(implicit z: native.Zone): native.Ptr[struct_point] = native.alloc[struct_point]
3953

54+
implicit class struct_structWithPointerToUndefinedStruct_ops(val p: native.Ptr[struct_structWithPointerToUndefinedStruct]) extends AnyVal {
55+
def field: native.Ptr[struct_undefinedStruct] = !p._1
56+
def field_=(value: native.Ptr[struct_undefinedStruct]): Unit = !p._1 = value
57+
}
58+
59+
def struct_structWithPointerToUndefinedStruct()(implicit z: native.Zone): native.Ptr[struct_structWithPointerToUndefinedStruct] = native.alloc[struct_structWithPointerToUndefinedStruct]
60+
4061
implicit class union_u_pos(val p: native.Ptr[union_u]) extends AnyVal {
4162
def i: native.Ptr[native.CInt] = p.cast[native.Ptr[native.CInt]]
4263
def i_=(value: native.CInt): Unit = !p.cast[native.Ptr[native.CInt]] = value
4364
def f: native.Ptr[native.CFloat] = p.cast[native.Ptr[native.CFloat]]
4465
def f_=(value: native.CFloat): Unit = !p.cast[native.Ptr[native.CFloat]] = value
4566
}
67+
68+
implicit class union_unionWithPointerToUndefinedStruct_pos(val p: native.Ptr[union_unionWithPointerToUndefinedStruct]) extends AnyVal {
69+
def field: native.Ptr[native.Ptr[struct_undefinedStruct]] = p.cast[native.Ptr[native.Ptr[struct_undefinedStruct]]]
70+
def field_=(value: native.Ptr[struct_undefinedStruct]): Unit = !p.cast[native.Ptr[native.Ptr[struct_undefinedStruct]]] = value
71+
}
4672
}

‎tests/samples/include/OpaqueTypes.h

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
struct s;
2+
3+
extern struct s externVar; // removed. No warning printed
4+
5+
typedef struct undefinedIncludedStruct undefinedIncludedStruct;
6+
7+
void useUndefinedIncludedStruct(undefinedIncludedStruct);

0 commit comments

Comments
 (0)