GCC Code Coverage Report

Directory: ../
File: src/model/Function.cpp
Date: 2025-11-25 12:07:23
Coverage Exec Excl Total
Lines: 97.4% 75 0 77
Functions: 100.0% 15 0 15
Branches: 61.5% 107 0 174
Line Branch Exec Source
1 // Copyright (c) 2021-2025 ChilliBits. All rights reserved.
2
3 #include "Function.h"
4
5 #include "symboltablebuilder/SymbolTableBuilder.h"
6
7 #include <ast/ASTBuilder.h>
8 #include <ast/ASTNodes.h>
9 #include <irgenerator/NameMangling.h>
10
11 namespace spice::compiler {
12
13 /**
14 * Retrieve the parameter types of the current function
15 *
16 * @return Vector of parameter types
17 */
18 60270 QualTypeList Function::getParamTypes() const {
19 60270 QualTypeList newParamTypes;
20
2/2
✓ Branch 8 → 4 taken 104586 times.
✓ Branch 8 → 9 taken 60270 times.
 164856 for (const auto &[qualType, isOptional] : paramList)
21
1/2
✓ Branch 5 → 6 taken 104586 times.
✗ Branch 5 → 11 not taken.
 104586 newParamTypes.push_back(qualType);
22 60270 return newParamTypes;
23 ✗ }
24
25 /**
26 * Get a string representation of the current function.
27 *
28 * Example:
29 * string Vector<double>.setData<double>(double)
30 *
31 * @param withThisType Include 'this' type in signature
32 * @param withTemplateTypes Include concrete template types in the signature
33 * @return String representation as function signature
34 */
35 52847 std::string Function::getSignature(bool withThisType /*=true*/, bool withTemplateTypes /*=true*/) const {
36 52847 QualTypeList concreteTemplateTypes;
37
2/2
✓ Branch 2 → 3 taken 31723 times.
✓ Branch 2 → 27 taken 21124 times.
 52847 if (withTemplateTypes) {
38
1/2
✓ Branch 4 → 5 taken 31723 times.
✗ Branch 4 → 33 not taken.
 31723 concreteTemplateTypes.reserve(templateTypes.size());
39
2/2
✓ Branch 25 → 7 taken 17938 times.
✓ Branch 25 → 26 taken 31723 times.
 49661 for (const GenericType &genericType : templateTypes) {
40
6/8
✓ Branch 8 → 9 taken 17938 times.
✗ Branch 8 → 32 not taken.
✓ Branch 9 → 10 taken 17938 times.
✗ Branch 9 → 13 not taken.
✓ Branch 11 → 12 taken 8307 times.
✓ Branch 11 → 13 taken 9631 times.
✓ Branch 14 → 15 taken 8307 times.
✓ Branch 14 → 22 taken 9631 times.
 17938 if (genericType.is(TY_GENERIC) && !typeMapping.empty()) {
41
3/6
✓ Branch 15 → 16 taken 8307 times.
✗ Branch 15 → 32 not taken.
✓ Branch 16 → 17 taken 8307 times.
✗ Branch 16 → 32 not taken.
✗ Branch 17 → 18 not taken.
✓ Branch 17 → 19 taken 8307 times.
 8307 assert(typeMapping.contains(genericType.getSubType()));
42
3/6
✓ Branch 19 → 20 taken 8307 times.
✗ Branch 19 → 32 not taken.
✓ Branch 20 → 21 taken 8307 times.
✗ Branch 20 → 32 not taken.
✓ Branch 21 → 23 taken 8307 times.
✗ Branch 21 → 32 not taken.
 8307 concreteTemplateTypes.push_back(typeMapping.at(genericType.getSubType()));
43 } else {
44
1/2
✓ Branch 22 → 23 taken 9631 times.
✗ Branch 22 → 32 not taken.
 9631 concreteTemplateTypes.push_back(genericType);
45 }
46 }
47 }
48
49
1/2
✓ Branch 27 → 28 taken 52847 times.
✗ Branch 27 → 33 not taken.
 105694 return getSignature(name, thisType, returnType, paramList, concreteTemplateTypes, true, withThisType, true);
50 52847 }
51
52 /**
53 * Get a string representation of the current function.
54 *
55 * @param name Function name
56 * @param thisType This symbol type
57 * @param returnType Return symbol type
58 * @param paramList Param symbol types
59 * @param concreteTemplateTypes Concrete template symbol types
60 * @param withReturnType Include return type in signature
61 * @param withThisType Include 'this' type in signature
62 * @param ignorePublic Not include public modifiers in signature
63 * @return Function signature
64 */
65 52859 std::string Function::getSignature(const std::string &name, const QualType &thisType, const QualType &returnType,
66 const ParamList &paramList, const QualTypeList &concreteTemplateTypes,
67 bool withReturnType /*=true*/, bool withThisType /*=true*/, bool ignorePublic /*=false*/) {
68
1/2
✓ Branch 2 → 3 taken 52859 times.
✗ Branch 2 → 81 not taken.
 52859 std::stringstream signature;
69
70 // Build return type string
71
2/2
✓ Branch 3 → 4 taken 52847 times.
✓ Branch 3 → 10 taken 12 times.
 52859 if (withReturnType) {
72
3/4
✓ Branch 4 → 5 taken 52847 times.
✗ Branch 4 → 79 not taken.
✓ Branch 5 → 6 taken 21370 times.
✓ Branch 5 → 7 taken 31477 times.
 52847 if (returnType.is(TY_DYN)) {
73
1/2
✓ Branch 6 → 10 taken 21370 times.
✗ Branch 6 → 79 not taken.
 21370 signature << "p ";
74 } else {
75
1/2
✓ Branch 7 → 8 taken 31477 times.
✗ Branch 7 → 79 not taken.
 31477 signature << "f<";
76
1/2
✓ Branch 8 → 9 taken 31477 times.
✗ Branch 8 → 79 not taken.
 31477 returnType.getName(signature, false, ignorePublic);
77
1/2
✓ Branch 9 → 10 taken 31477 times.
✗ Branch 9 → 79 not taken.
 31477 signature << "> ";
78 }
79 }
80
81 // Build this type string
82
7/8
✓ Branch 10 → 11 taken 21178 times.
✓ Branch 10 → 14 taken 31681 times.
✓ Branch 11 → 12 taken 21178 times.
✗ Branch 11 → 79 not taken.
✓ Branch 12 → 13 taken 11733 times.
✓ Branch 12 → 14 taken 9445 times.
✓ Branch 15 → 16 taken 11733 times.
✓ Branch 15 → 35 taken 41126 times.
 52859 if (withThisType && !thisType.is(TY_DYN)) {
83
3/6
✓ Branch 16 → 17 taken 11733 times.
✗ Branch 16 → 69 not taken.
✓ Branch 17 → 18 taken 11733 times.
✗ Branch 17 → 69 not taken.
✓ Branch 18 → 19 taken 11733 times.
✗ Branch 18 → 69 not taken.
 11733 signature << thisType.getBase().getSubType();
84
1/2
✓ Branch 19 → 20 taken 11733 times.
✗ Branch 19 → 79 not taken.
 11733 const QualTypeList &thisTemplateTypes = thisType.getTemplateTypes();
85
2/2
✓ Branch 21 → 22 taken 5603 times.
✓ Branch 21 → 34 taken 6130 times.
 11733 if (!thisTemplateTypes.empty()) {
86
1/2
✓ Branch 22 → 23 taken 5603 times.
✗ Branch 22 → 79 not taken.
 5603 signature << "<";
87
2/2
✓ Branch 32 → 24 taken 7142 times.
✓ Branch 32 → 33 taken 5603 times.
 12745 for (size_t i = 0; i < thisTemplateTypes.size(); i++) {
88
2/2
✓ Branch 24 → 25 taken 1539 times.
✓ Branch 24 → 26 taken 5603 times.
 7142 if (i > 0)
89
1/2
✓ Branch 25 → 26 taken 1539 times.
✗ Branch 25 → 79 not taken.
 1539 signature << ",";
90
3/6
✓ Branch 26 → 27 taken 7142 times.
✗ Branch 26 → 72 not taken.
✓ Branch 27 → 28 taken 7142 times.
✗ Branch 27 → 72 not taken.
✓ Branch 28 → 29 taken 7142 times.
✗ Branch 28 → 70 not taken.
 7142 signature << thisTemplateTypes.at(i).getName(false, ignorePublic);
91 }
92
1/2
✓ Branch 33 → 34 taken 5603 times.
✗ Branch 33 → 79 not taken.
 5603 signature << ">";
93 }
94
1/2
✓ Branch 34 → 35 taken 11733 times.
✗ Branch 34 → 79 not taken.
 11733 signature << MEMBER_ACCESS_TOKEN;
95 }
96
97 // Name
98
1/2
✓ Branch 35 → 36 taken 52859 times.
✗ Branch 35 → 79 not taken.
 52859 signature << name;
99
100 // Build template type string
101
2/2
✓ Branch 37 → 38 taken 13157 times.
✓ Branch 37 → 50 taken 39702 times.
 52859 if (!concreteTemplateTypes.empty()) {
102
1/2
✓ Branch 38 → 39 taken 13157 times.
✗ Branch 38 → 79 not taken.
 13157 signature << "<";
103
2/2
✓ Branch 48 → 40 taken 17938 times.
✓ Branch 48 → 49 taken 13157 times.
 31095 for (size_t i = 0; i < concreteTemplateTypes.size(); i++) {
104
2/2
✓ Branch 40 → 41 taken 4781 times.
✓ Branch 40 → 42 taken 13157 times.
 17938 if (i > 0)
105
1/2
✓ Branch 41 → 42 taken 4781 times.
✗ Branch 41 → 79 not taken.
 4781 signature << ",";
106
3/6
✓ Branch 42 → 43 taken 17938 times.
✗ Branch 42 → 75 not taken.
✓ Branch 43 → 44 taken 17938 times.
✗ Branch 43 → 75 not taken.
✓ Branch 44 → 45 taken 17938 times.
✗ Branch 44 → 73 not taken.
 17938 signature << concreteTemplateTypes.at(i).getName(false, ignorePublic);
107 }
108
1/2
✓ Branch 49 → 50 taken 13157 times.
✗ Branch 49 → 79 not taken.
 13157 signature << ">";
109 }
110
111 // Parameter type string
112
1/2
✓ Branch 50 → 51 taken 52859 times.
✗ Branch 50 → 79 not taken.
 52859 signature << "(";
113
2/2
✓ Branch 62 → 52 taken 67627 times.
✓ Branch 62 → 63 taken 52859 times.
 120486 for (size_t i = 0; i < paramList.size(); i++) {
114
1/2
✓ Branch 52 → 53 taken 67627 times.
✗ Branch 52 → 79 not taken.
 67627 const auto &[qualType, isOptional] = paramList.at(i);
115
2/2
✓ Branch 53 → 54 taken 28174 times.
✓ Branch 53 → 55 taken 39453 times.
 67627 if (i > 0)
116
1/2
✓ Branch 54 → 55 taken 28174 times.
✗ Branch 54 → 79 not taken.
 28174 signature << ",";
117
2/4
✓ Branch 55 → 56 taken 67627 times.
✗ Branch 55 → 78 not taken.
✓ Branch 56 → 57 taken 67627 times.
✗ Branch 56 → 76 not taken.
 67627 signature << qualType.getName(false, ignorePublic);
118
1/2
✗ Branch 58 → 59 not taken.
✓ Branch 58 → 60 taken 67627 times.
 67627 if (isOptional)
119 ✗ signature << "?";
120 }
121
1/2
✓ Branch 63 → 64 taken 52859 times.
✗ Branch 63 → 79 not taken.
 52859 signature << ")";
122
123
1/2
✓ Branch 64 → 65 taken 52859 times.
✗ Branch 64 → 79 not taken.
 105718 return signature.str();
124 52859 }
125
126 33343 std::string Function::getMangledName() const {
127 // Use predefined mangled name if available
128
2/2
✓ Branch 3 → 4 taken 1 time.
✓ Branch 3 → 5 taken 33342 times.
 33343 if (!predefinedMangledName.empty())
129 1 return predefinedMangledName;
130 // Use function name if mangling is disabled
131
2/2
✓ Branch 5 → 6 taken 3256 times.
✓ Branch 5 → 7 taken 30086 times.
 33342 if (!mangleFunctionName)
132 3256 return name;
133 // Use normal name mangling
134 30086 return NameMangling::mangleFunction(*this);
135 }
136
137 24455 std::string Function::getSymbolTableEntryName(const std::string &functionName, const CodeLoc &codeLoc) {
138
3/6
✓ Branch 2 → 3 taken 24455 times.
✗ Branch 2 → 15 not taken.
✓ Branch 3 → 4 taken 24455 times.
✗ Branch 3 → 12 not taken.
✓ Branch 4 → 5 taken 24455 times.
✗ Branch 4 → 10 not taken.
 24455 return functionName + ":" + codeLoc.toString();
139 }
140
141 61 std::string Function::getSymbolTableEntryNameDefaultCtor(const CodeLoc &structCodeLoc) {
142
5/10
✓ Branch 2 → 3 taken 61 times.
✗ Branch 2 → 31 not taken.
✓ Branch 5 → 6 taken 61 times.
✗ Branch 5 → 23 not taken.
✓ Branch 6 → 7 taken 61 times.
✗ Branch 6 → 21 not taken.
✓ Branch 7 → 8 taken 61 times.
✗ Branch 7 → 19 not taken.
✓ Branch 8 → 9 taken 61 times.
✗ Branch 8 → 17 not taken.
 183 return "default_" + std::string(CTOR_FUNCTION_NAME) + ":" + structCodeLoc.toString();
143 }
144
145 204 std::string Function::getSymbolTableEntryNameDefaultCopyCtor(const CodeLoc &structCodeLoc) {
146
5/10
✓ Branch 2 → 3 taken 204 times.
✗ Branch 2 → 31 not taken.
✓ Branch 5 → 6 taken 204 times.
✗ Branch 5 → 23 not taken.
✓ Branch 6 → 7 taken 204 times.
✗ Branch 6 → 21 not taken.
✓ Branch 7 → 8 taken 204 times.
✗ Branch 7 → 19 not taken.
✓ Branch 8 → 9 taken 204 times.
✗ Branch 8 → 17 not taken.
 612 return "default_copy" + std::string(CTOR_FUNCTION_NAME) + ":" + structCodeLoc.toString();
147 }
148
149 107 std::string Function::getSymbolTableEntryNameDefaultDtor(const CodeLoc &structCodeLoc) {
150
5/10
✓ Branch 2 → 3 taken 107 times.
✗ Branch 2 → 31 not taken.
✓ Branch 5 → 6 taken 107 times.
✗ Branch 5 → 23 not taken.
✓ Branch 6 → 7 taken 107 times.
✗ Branch 6 → 21 not taken.
✓ Branch 7 → 8 taken 107 times.
✗ Branch 7 → 19 not taken.
✓ Branch 8 → 9 taken 107 times.
✗ Branch 8 → 17 not taken.
 321 return "default_" + std::string(DTOR_FUNCTION_NAME) + ":" + structCodeLoc.toString();
151 }
152
153 /**
154 * Checks if a function contains optional parameters.
155 * This would imply that the function is not substantiated by its optional parameters yet.
156 *
157 * @return Substantiated params or not
158 */
159 1138795 bool Function::hasSubstantiatedParams() const {
160 2840591 return std::ranges::none_of(paramList, [](const Param &param) { return param.isOptional; });
161 }
162
163 /**
164 * Checks if a function contains template types.
165 * This would imply that the function is not substantiated by its generic types yet.
166 *
167 * @return Substantiated generics or not
168 */
169 132985 bool Function::hasSubstantiatedGenerics() const {
170 72045 const auto predicate = [this](const GenericType &genericType) { return typeMapping.contains(genericType.getSubType()); };
171
1/2
✓ Branch 2 → 3 taken 132985 times.
✗ Branch 2 → 6 not taken.
 265970 return std::ranges::all_of(templateTypes, predicate);
172 }
173
174 /**
175 * Checks if a function contains optional parameters or has generic types present.
176 * This would imply that the function is not fully substantiated yet.
177 *
178 * @return Fully substantiated or not
179 */
180
3/4
✓ Branch 3 → 4 taken 132985 times.
✗ Branch 3 → 7 not taken.
✓ Branch 5 → 6 taken 86288 times.
✓ Branch 5 → 7 taken 46697 times.
 132985 bool Function::isFullySubstantiated() const { return hasSubstantiatedParams() && hasSubstantiatedGenerics(); }
181
182 /**
183 * Returns, if this function is a substantiation of a generic one.
184 *
185 * @return Generic substantiation or not
186 */
187 903964 bool Function::isGenericSubstantiation() const { return genericPreset != nullptr; }
188
189 /**
190 * Retrieve the declaration code location of this function
191 *
192 * @return Declaration code location
193 */
194 4452 const CodeLoc &Function::getDeclCodeLoc() const { return declNode->codeLoc; }
195
196 } // namespace spice::compiler
197