GCC Code Coverage Report

Directory: ../
Coverage: low: ≥ 0% medium: ≥ 75.0% high: ≥ 90.0%
Coverage Exec / Excl / Total
Lines: 100.0% 8 / 0 / 8
Functions: 100.0% 1 / 0 / 1
Branches: 44.8% 81 / 0 / 181
src/symboltablebuilder/Scope.h
Line Branch Exec Source
1 // Copyright (c) 2021-2026 ChilliBits. All rights reserved.
2
3 #pragma once
4
5 #include <model/Interface.h>
6 #include <model/Struct.h>
7 #include <symboltablebuilder/SymbolTable.h>
8 #include <typechecker/FunctionManager.h>
9 #include <typechecker/InterfaceManager.h>
10 #include <typechecker/StructManager.h>
11 #include <util/CompilerWarning.h>
12
13 namespace spice::compiler {
14
15 // Forward declarations
16 class FctDefNode;
17 class ProcDefNode;
18 class SourceFile;
19
20 enum class ScopeType : uint8_t {
21 GLOBAL,
22 FUNC_PROC_BODY,
23 LAMBDA_BODY,
24 STRUCT,
25 INTERFACE,
26 ENUM,
27 IF_ELSE_BODY,
28 WHILE_BODY,
29 FOR_BODY,
30 FOREACH_BODY,
31 CASE_BODY,
32 DEFAULT_BODY,
33 UNSAFE_BODY,
34 ANONYMOUS_BLOCK_BODY
35 };
36
37 /**
38 * Represents an enclosed group of instructions, which are semantically separated from other scopes.
39 * In the source code, scopes usually are written as curly braces.
40 *
41 * Following language structures use scopes:
42 * - global scope
43 * - functions/procedures
44 * - structs
45 * - enums
46 * - interfaces
47 * - thread blocks
48 * - unsafe blocks
49 * - for loops
50 * - foreach loops
51 * - while loops
52 * - if statements
53 * - anonymous scopes
54 */
55 class Scope {
56 public:
57 // Constructors
58 26287 Scope(Scope *parent, SourceFile *sourceFile, ScopeType scopeType, const CodeLoc *codeLoc)
59
2/2
✓ Branch 3 → 4 taken 25062 times.
✓ Branch 3 → 5 taken 1225 times.
 26287 : parent(parent), sourceFile(sourceFile), codeLoc(codeLoc), type(scopeType) {}
60
61 // Friend classes
62 friend class FunctionManager;
63 friend class StructManager;
64 friend class InterfaceManager;
65
66 // Public methods
67 // Scope management
68 Scope *createChildScope(const std::string &scopeName, ScopeType scopeType, const CodeLoc *declCodeLoc);
69 void renameChildScope(const std::string &oldName, const std::string &newName);
70 Scope *copyChildScope(const std::string &oldName, const std::string &newName);
71 std::shared_ptr<Scope> deepCopyScope();
72 [[nodiscard]] Scope *getChildScope(const std::string &scopeName) const;
73 [[nodiscard]] std::vector<SymbolTableEntry *> getVarsGoingOutOfScope();
74
75 // Generic types
76 void insertGenericType(const std::string &typeName, const GenericType &genericType);
77 GenericType *lookupGenericTypeStrict(const std::string &typeName);
78
79 // Util
80 void collectWarnings(std::vector<CompilerWarning> &warnings) const;
81 void ensureSuccessfulTypeInference() const;
82 [[nodiscard]] size_t getFieldCount() const;
83 [[nodiscard]] std::vector<Function *> getVirtualMethods();
84 [[nodiscard]] std::vector<const Struct *> getAllStructManifestationsInDeclarationOrder() const;
85 [[nodiscard]] unsigned int getLoopNestingDepth() const;
86 [[nodiscard]] bool isInCaseBranch() const;
87 [[nodiscard]] bool isInAsyncScope() const;
88 [[nodiscard]] bool doesAllowUnsafeOperations() const;
89 [[nodiscard]] bool isImportedBy(const Scope *askingScope) const;
90 [[nodiscard]] nlohmann::json getSymbolTableJSON() const;
91 45808 [[nodiscard]] ALWAYS_INLINE bool isRootScope() const { return parent == nullptr; }
92
93 // Wrapper methods for symbol table
94 ALWAYS_INLINE SymbolTableEntry *insert(const std::string &name, ASTNode *declNode) {
95
15/32
✓ Branch 9 → 10 taken 370 times.
✗ Branch 9 → 79 not taken.
✓ Branch 13 → 14 taken 735 times.
✗ Branch 13 → 41 not taken.
✓ Branch 26 → 27 taken 409 times.
✗ Branch 26 → 67 not taken.
✓ Branch 27 → 28 taken 143 times.
✗ Branch 27 → 76 not taken.
✓ Branch 30 → 31 taken 16 times.
✗ Branch 30 → 62 not taken.
✓ Branch 31 → 32 taken 70 times.
✗ Branch 31 → 65 not taken.
✓ Branch 36 → 37 taken 479 times.
✗ Branch 36 → 63 not taken.
✗ Branch 36 → 73 not taken.
✓ Branch 40 → 41 taken 370 times.
✗ Branch 40 → 68 not taken.
✓ Branch 47 → 48 taken 107 times.
✗ Branch 47 → 81 not taken.
✓ Branch 55 → 56 taken 4055 times.
✗ Branch 55 → 92 not taken.
✗ Branch 55 → 118 not taken.
✓ Branch 60 → 61 taken 3495 times.
✗ Branch 60 → 117 not taken.
✓ Branch 64 → 65 taken 8233 times.
✗ Branch 64 → 124 not taken.
✓ Branch 73 → 74 taken 4259 times.
✗ Branch 73 → 125 not taken.
✓ Branch 76 → 77 taken 8233 times.
✗ Branch 76 → 132 not taken.
✓ Branch 169 → 170 taken 650 times.
✗ Branch 169 → 327 not taken.
 58420 return symbolTable.insert(name, declNode);
96 }
97
5/10
✓ Branch 5 → 6 taken 10158 times.
✗ Branch 5 → 66 not taken.
✓ Branch 16 → 17 taken 17006 times.
✗ Branch 16 → 522 not taken.
✓ Branch 21 → 22 taken 59496 times.
✗ Branch 21 → 219 not taken.
✓ Branch 29 → 30 taken 17677 times.
✗ Branch 29 → 502 not taken.
✓ Branch 36 → 37 taken 70 times.
✗ Branch 36 → 79 not taken.
 104437 ALWAYS_INLINE SymbolTableEntry *lookup(const std::string &symbolName) { return symbolTable.lookup(symbolName); }
98
33/83
✓ Branch 2 → 3 taken 39109 times.
✗ Branch 2 → 41 not taken.
✗ Branch 2 → 65 not taken.
✗ Branch 2 → 165 not taken.
✓ Branch 6 → 7 taken 1843 times.
✗ Branch 6 → 16 not taken.
✗ Branch 6 → 83 not taken.
✗ Branch 6 → 94 not taken.
✓ Branch 7 → 8 taken 1989 times.
✗ Branch 7 → 45 not taken.
✗ Branch 7 → 48 not taken.
✗ Branch 7 → 71 not taken.
✗ Branch 7 → 128 not taken.
✗ Branch 7 → 139 not taken.
✓ Branch 9 → 10 taken 410 times.
✗ Branch 9 → 52 not taken.
✓ Branch 17 → 18 taken 575 times.
✗ Branch 17 → 125 not taken.
✗ Branch 17 → 165 not taken.
✓ Branch 18 → 19 taken 1923 times.
✗ Branch 18 → 28 not taken.
✗ Branch 18 → 47 not taken.
✗ Branch 18 → 124 not taken.
✗ Branch 18 → 138 not taken.
✓ Branch 19 → 20 taken 2 times.
✗ Branch 19 → 139 not taken.
✓ Branch 20 → 21 taken 29 times.
✗ Branch 20 → 142 not taken.
✗ Branch 20 → 172 not taken.
✓ Branch 28 → 29 taken 7760 times.
✗ Branch 28 → 55 not taken.
✓ Branch 33 → 34 taken 393 times.
✗ Branch 33 → 59 not taken.
✓ Branch 35 → 36 taken 730 times.
✗ Branch 35 → 74 not taken.
✓ Branch 37 → 38 taken 464 times.
✗ Branch 37 → 69 not taken.
✗ Branch 37 → 267 not taken.
✓ Branch 39 → 40 taken 850 times.
✗ Branch 39 → 395 not taken.
✓ Branch 41 → 42 taken 3395 times.
✗ Branch 41 → 220 not taken.
✓ Branch 42 → 43 taken 14 times.
✗ Branch 42 → 132 not taken.
✓ Branch 43 → 44 taken 2795 times.
✗ Branch 43 → 174 not taken.
✓ Branch 51 → 52 taken 3492 times.
✗ Branch 51 → 219 not taken.
✓ Branch 56 → 57 taken 3319 times.
✗ Branch 56 → 282 not taken.
✓ Branch 58 → 59 taken 8885 times.
✗ Branch 58 → 233 not taken.
✓ Branch 60 → 61 taken 5154 times.
✗ Branch 60 → 187 not taken.
✓ Branch 64 → 65 taken 2713 times.
✗ Branch 64 → 137 not taken.
✗ Branch 64 → 190 not taken.
✗ Branch 64 → 196 not taken.
✓ Branch 68 → 69 taken 12 times.
✗ Branch 68 → 186 not taken.
✓ Branch 72 → 73 taken 3492 times.
✗ Branch 72 → 213 not taken.
✓ Branch 76 → 77 taken 254 times.
✗ Branch 76 → 158 not taken.
✓ Branch 77 → 78 taken 3461 times.
✗ Branch 77 → 227 not taken.
✗ Branch 77 → 276 not taken.
✓ Branch 80 → 81 taken 3016 times.
✗ Branch 80 → 172 not taken.
✓ Branch 113 → 114 taken 1887 times.
✗ Branch 113 → 163 not taken.
✓ Branch 123 → 124 taken 1559 times.
✗ Branch 123 → 254 not taken.
✓ Branch 126 → 127 taken 4253 times.
✗ Branch 126 → 242 not taken.
✓ Branch 145 → 146 taken 7438 times.
✗ Branch 145 → 264 not taken.
✓ Branch 157 → 158 taken 8224 times.
✗ Branch 157 → 322 not taken.
✓ Branch 158 → 159 taken 652 times.
✗ Branch 158 → 327 not taken.
✓ Branch 174 → 175 taken 116 times.
✗ Branch 174 → 343 not taken.
 149718 ALWAYS_INLINE SymbolTableEntry *lookupStrict(const std::string &symbolName) { return symbolTable.lookupStrict(symbolName); }
99 ALWAYS_INLINE SymbolTableEntry *lookupField(unsigned int n) {
100
15/30
✗ Branch 3 → 4 not taken.
✓ Branch 3 → 5 taken 3865 times.
✗ Branch 5 → 6 not taken.
✓ Branch 5 → 7 taken 334 times.
✗ Branch 6 → 7 not taken.
✓ Branch 6 → 8 taken 4830 times.
✗ Branch 9 → 10 not taken.
✓ Branch 9 → 11 taken 19657 times.
✗ Branch 16 → 17 not taken.
✓ Branch 16 → 18 taken 1384 times.
✗ Branch 22 → 23 not taken.
✓ Branch 22 → 24 taken 382 times.
✗ Branch 23 → 24 not taken.
✓ Branch 23 → 25 taken 360 times.
✗ Branch 25 → 26 not taken.
✓ Branch 25 → 27 taken 77 times.
✗ Branch 30 → 31 not taken.
✓ Branch 30 → 32 taken 1219 times.
✗ Branch 47 → 48 not taken.
✓ Branch 47 → 49 taken 3375 times.
✗ Branch 83 → 84 not taken.
✓ Branch 83 → 85 taken 63 times.
✗ Branch 86 → 87 not taken.
✓ Branch 86 → 88 taken 1095 times.
✗ Branch 89 → 90 not taken.
✓ Branch 89 → 91 taken 76 times.
✗ Branch 96 → 97 not taken.
✓ Branch 96 → 98 taken 4652 times.
✗ Branch 149 → 150 not taken.
✓ Branch 149 → 151 taken 413 times.
 41782 assert(type == ScopeType::STRUCT);
101
11/24
✓ Branch 7 → 8 taken 334 times.
✗ Branch 7 → 27 not taken.
✓ Branch 8 → 9 taken 4830 times.
✗ Branch 8 → 59 not taken.
✗ Branch 8 → 70 not taken.
✗ Branch 8 → 86 not taken.
✓ Branch 18 → 19 taken 1384 times.
✗ Branch 18 → 120 not taken.
✓ Branch 25 → 26 taken 360 times.
✗ Branch 25 → 111 not taken.
✓ Branch 32 → 33 taken 1219 times.
✗ Branch 32 → 137 not taken.
✓ Branch 49 → 50 taken 3375 times.
✗ Branch 49 → 184 not taken.
✓ Branch 85 → 86 taken 63 times.
✗ Branch 85 → 154 not taken.
✓ Branch 88 → 89 taken 1095 times.
✗ Branch 88 → 181 not taken.
✓ Branch 91 → 92 taken 76 times.
✗ Branch 91 → 201 not taken.
✓ Branch 98 → 99 taken 4652 times.
✗ Branch 98 → 185 not taken.
✓ Branch 151 → 152 taken 413 times.
✗ Branch 151 → 253 not taken.
 41782 return symbolTable.lookupStrictByIndex(n);
102 }
103
104 // Public members
105 Scope *parent;
106 SourceFile *sourceFile;
107 std::map<std::string, std::shared_ptr<Scope>> children;
108 SymbolTable symbolTable = SymbolTable(parent == nullptr ? nullptr : &parent->symbolTable, this);
109 const CodeLoc *codeLoc = nullptr;
110 const ScopeType type;
111 bool isGenericScope = false;
112 bool isAsyncScope = false;
113 bool isDtorScope = false;
114
115 private:
116 // Private members
117 FunctionRegistry functions;
118 StructRegistry structs;
119 InterfaceRegistry interfaces;
120 std::map<std::string, GenericType> genericTypes;
121 };
122
123 } // namespace spice::compiler
124