Overview of shared code and practices used throughout the library.
The slang source code tries to follow a number of conventions:
- The codebase is kept up to date with new versions of C++. Currently that means C++20.
- All code is compiled at the highest warning levels and checked by static analysis.
- clang-format enforces stylistic conventions
- Types and constants are PascalCase, functions and members are camelCase.
- slang is intended to be used as a library in other programs, possibly in multithreaded scenarios, so global state or code that affects the environment is not allowed.
Generally allocations are to be avoided. Compilers are full of places that need many little objects that link to each other – rather than allocate and track the lifetime of each one separately, arena based allocation is preferred. All objects are allocated out of slabs of memory, and only the entire arena can be deallocated if that memory is no longer needed.
This is supported by the slang::
A common operation is to build up dynamic lists of objects; using the arena allocator for the construction process would waste lots of memory (since it can't be freed until the entire arena is destroyed). Instead, the lists are built locally, ideally on the stack, and then once the full set is known it is copied to a chunk of memory within the arena. The type slang::
SmallVector<int> smallVec; smallVec.append(3); smallVec.append(4); smallVec.append(5); BumpAllocator alloc; span<int> finalList = smallVec.copy(alloc);
Note the use of std::span here; spans are the preferred mechanism for representing lists of things that have been allocated in an arena somewhere. Once the list has been constructed the spans can be passed around, copied, and stored cheaply.
The frontend of a compiler deals with many strings. User source code is loaded once into memory and then never copied or manipulated again; all strings from that point forward are represented by std::string_view instances that point into that stored source.
Some other useful components to know:
- The slang::
not_null template decorates pointers that can be assumed to never be null. Otherwise, any pointer (that's not in a dynamically sized list) must be assumed to potentially be null.
- The slang::
ScopeGuard template makes it easy to have a function (typically given via a lambda) that should run once the guard is destructed.
- The SLANG_ASSERT macro does runtime checking of invariants. It should only be used to check things that should always be true if the programmer has not made any mistakes. User errors must instead be handled gracefully.
- It's very common to have big switch statements that cover all expected possibilities but need a default case to handle programmer bugs; in those cases, you can use the SLANG_UNREACHABLE macro which unconditionally throws a std::logic_error in debug builds and marks the path unreachable in release builds.
- The SLANG_ENUM macro is used to define scoped enumerations that have a toString() method. Ideally C++ will expose this at the language level at some point but until then we're on our own.
- The slang::
bitmask template wraps scoped enumerations that should be treated as a set of flag bits. It gives them a bunch of expected operators like & and |.
- Similarly to SmallVector, there is a slang::
SmallSet and slang:: SmallMap that allocate their first few elements on the stack to try to avoid heap allocations.
- For any hash tables that do need to live outside the stack, flat_hash_map should be used over std::unordered_map, always, as it's much more efficient.