mirror of
https://github.com/ByteWelder/Tactility.git
synced 2026-10-17 02:45:05 +00:00
79d3dd4fdb
app-module - Apps now have support for: - environment variables (inherit from parent app) - current workdir - window size (when running in terminal) - Add type aliases like `AppId` and `PackageId` - Remove data duplication between ledger and app instance records: create `AppManifestSet` - `AppManifest` usage safety improved: pass by value where needed, or use `AppId` instead of a manifest. Terminal and shell - Moved shell commands into coreutils-module as proper apps. - Refine stack size for terminal and shell because apps now run with their own task and stack (including in-memory apps) Platform - Fix for listing root dir on ESP32: wrap posix directory functions and wire in file systems. - Moved all platform-specific file system init code to platform subprojects Other - Fix for screenshot capture (issue with paths) - Fixes for coreutils app correctness - Memory optimizations (use more PSRAM where possible) in various locations such as app-module, shell and terminal. - `ls` and `help` commands now use terminal width and show columns of data by default - Created fs helpers at `TactilityKernel/include/tactility/filesystem/fs.h` (partially ported from `ShellFs`)
21 lines
1.1 KiB
Markdown
21 lines
1.1 KiB
Markdown
# Coding Style
|
|
|
|
Two conventions coexist; which one to use depends on the project layer:
|
|
|
|
- **C code**: `lower_snake_case` for files, functions, variables. `UpperCamelCase` for types. Files in `source/`, `include/`, `private/` directories.
|
|
- **C++ code**: `UpperCamelCase` for files and types. `lowerCamelCase` for functions. Files in `Source/`, `Include/`, `Private/` directories.
|
|
|
|
For projects that emit C headers and have a C++ implementation file: the internal C++ function naming should be snake_case.
|
|
|
|
Formatting is enforced by `.clang-format` (LLVM-based, 4-space indent, no column limit).
|
|
Never throw exceptions — use return types for error handling. Use `enum class` over plain `enum` when writing C++ code.
|
|
Do not add redundant null checks for parameters with an explicit non-null precondition.
|
|
|
|
Code Comments (important!):
|
|
|
|
- Should be minimal, but must contain critical information.
|
|
- Must not contain interjections " - " or ";"
|
|
- Must not explain how code was before, or how it was changed.
|
|
- Must avoid explaining what was not implemented.
|
|
- Must not refer to designs of other subsystems.
|