API Reference
The API Reference is spit into Three parts and Compiler and RunTime.
Every thing in UCodeLang in UCodeLang NameSpace
namespace UC = UCodeLang;
Compilation
Types related to compiling and its Output.
| Name | Type | Description |
|---|---|---|
| Compiler | Class | The UCodeLang Compiler. |
| ModuleFile | Class | The UCodeLang Compiler Module System. |
| UClib | Class | The UCodeLang Compiler Output. |
| UCodeBackEnd | Class | The BackEnd for the UCodeInterpreter. |
| C11BackEnd | Class | The BackEnd to output C Code. |
| WasmBackEnd | Class | The BackEnd targeting Wasm. |
RunTime
Types related to The UCodeVM/RunTime.
| Name | Type | Description |
|---|---|---|
| RunTimeLib | Class | The BackEnd to output C Code. |
| UCodeRunTime | Class | The Core UCodeLang Runtime. |
| AnyInterpreter | Class | A wapper over Interpreter,JitInterpreter and NativeInterpreter. |
| Interpreter | Class | The Default Interpreter. |
| JitInterpreter | Class | The Jit Interpreter. |
| NativeInterpreter | Class | Runs Precompiled Native Code. |
| IOLink | Class | Adds CppCalls for direct access to the file system,network and other IO. |
| SandBoxedIOLink | Class | Adds CppCalls for SandBoxed access to the file system,network and other IO. |
| UtilityLink | Class | Adds CppCalls for everything else that doesn't fit in IO. |
Analysis
Types related to The Analyzing UCodeLang ,UCodeLang Output or its Runtime.
| Name | Type | Description |
|---|---|---|
| ReflectionVector | Class | Lets you use UCodeLang Vectors in a Easy Way. |
| ReflectionString | Class | Lets you use UCodeLang Strings in a Easy Way. |
Core
Basic types that UCodeLang Uses stop isn't part of C++17 standard Library.
| Name | Type | Description |
|---|---|---|
| Result | Generic class | A type holding a returned value or an error code. |
| NeverNullPtr | Generic class | A pointer that should never be null. |
| NullablePtr | Generic class | A pointer that could be null. |
| Variant | Generic class | A wapper over std::variant give it more functions. |
| Span | Generic class | A contiguous sequence of objects |
C API
UCodeLang Has a C API for using UCodeLang in Programming Languages other than C++.
Notes
Many more classes and funcions can be found in UCodeLang but may change may change on a whim its recommended not to used those them if its not documented here.