fennec-org/fennec
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

- Documentation of containers and adjusting page hierarchy

Browse Source
This commit is contained in:
Medusa Slockbower
2025-08-18 14:13:35 -04:00
parent 27754a56d7
commit 55a8c54119
28 changed files with 934 additions and 313 deletions
Download Patch File Download Diff File Expand all files Collapse all files

45
planning/CONTAINERS.md
View File

@@ -28,29 +28,30 @@ Library and Template Library.
| Symbol | Implemented | Passed |
|:-------------------------------------|:-----------:|:------:|
| pair | ✔ | ✔ |
| tuple | ⭕ | ⭕ |
| optional | ✔ | ✔ |
| variant | ❌ | ❌ |
| any | ❌ | ❌ |
| bitset | ❌ | ❌ |
| array | ✔ | ✔ |
| dynarray (`std::vector`) | ⭕ | ⭕ |
| deque | ❌ | ❌ |
| list | ✔ | ✔ |
| set (`std::unordered_set`) | ✔ | ✔ |
| sequence (`std::set`) | ❌ | ❌ |
| map (`std::unordered_map`) | ✔ | ✔ |
| map_sequence (`std::map`) | ❌ | ❌ |
| multiset (`std::unordered_multiset`) | ❌ | ❌ |
| multisequence (`std::multiset`) | ❌ | ❌ |
| multimap (`std::unordered_multimap`) | ❌ | ❌ |
| multimap_sequence (`std::multimap`) | ❌ | ❌ |
| map (`std::unordered_map`) | ✅ | ✅ |
| map_sequence (`std::map`) | ⛔ | ⛔ |
| multiset (`std::unordered_multiset`) | ⛔ | ⛔ |
| multisequence (`std::multiset`) | ⛔ | ⛔ |
| multimap (`std::unordered_multimap`) | ⛔ | ⛔ |
| multimap_sequence (`std::multimap`) | ⛔ | ⛔ |
| pair | ✅ | ✅ |
| tuple | 🚧 | 🚧 |
| optional | ✅ | ✅ |
| variant | ⛔ | ⛔ |
| any | ⛔ | ⛔ |
| bitset | ⛔ | ⛔ |
| array | ✅ | ✅ |
| dynarray (`std::vector`) | 🚧 | 🚧 |
| deque | ⛔ | ⛔ |
| list | ✅ | ✅ |
| set (`std::unordered_set`) | ✅ | ✅ |
| sequence (`std::set`) | ⛔ | ⛔ |
### fennec
| Symbol | Implemented | Passed |
|:--------|:-----------:|:------:|
| graph | ❌ | ❌ |
| rd_tree | ✔ | ✔ |
| Symbol | Implemented | Passed |
|:------------|:-----------:|:------:|
| graph | 🚧 | 🚧 |
| object_pool | 🚧 | 🚧 |
| rd_tree | ✅ | ✅ |

14
planning/CONTENTS.md
View File

@@ -54,17 +54,17 @@ denote implementation and testing progress. The symbols are defined below.
| Symbol | Meaning | Notes |
|:------:|:------------------------|:----------------------------------------------------------|
| ✔ | Completed | Complete implementation and all tests passing. |
| ⭕ | Partial | Partial implementation and all tests implemented passing. |
| ✅ | Completed | Complete implementation and all tests passing. |
| 🚧 | Partial | Partial implementation and all tests implemented passing. |
| ❓ | Untested | Not tested |
| ❌ | Unimplemented / Failing | Not implemented or any test is failing. |
| ⛔ | Unimplemented / Failing | Not implemented or any test is failing. |
| Implemented / Passed | ✔ | ⭕ | ❓ | ❌ |
| Implemented / Passed | ✅ | 🚧 | ❓ | ⛔ |
|:--------------------:|--------------------------------------------------------------------|-------------------------------------------------------------------------------|---------|-----------------|
| ✔ | Implemented and Passing | Invalid | Invalid | Not Implemented |
| ⭕ | Implemented and Partial Testing with all implemented tests passing | Partial Implementation and Partial Testing with all implemented tests passing | Invalid | Not Implemented |
| ✅ | Implemented and Passing | Invalid | Invalid | Not Implemented |
| 🚧 | Implemented and Partial Testing with all implemented tests passing | Partial Implementation and Partial Testing with all implemented tests passing | Invalid | Not Implemented |
| ❓ | Implemented and Untested | Partial Implementation and Untested | Invalid | Not Implemented |
| ❌ | Implemented and Any Test is Failing | Partial Implementation and any test is Failing | Invalid | Not Implemented |
| ⛔ | Implemented and Any Test is Failing | Partial Implementation and any test is Failing | Invalid | Not Implemented |

88
planning/CPP_LANGUAGE.md
View File

@@ -42,44 +42,44 @@ See:
### Diagnostics
| Symbol | Implemented | Passed |
|:--------|:-----------:|:------:|
| assert | ✔ | ✔ |
| assertf | ✔ | ✔ |
| assertd | ✔ | ✔ |
| assert | ✅ | ✅ |
| assertf | ✅ | ✅ |
| assertd | ✅ | ✅ |
### Utility
| Symbol | Implemented | Passed |
|:-----------------|:-----------:|:------:|
| numeric_limits | ✔ | ✔ |
| initializer_list | ❌ | ❌ |
| numeric_limits | ✅ | ✅ |
| initializer_list | ⛔ | ⛔ |
### Primary Types
| Symbol | Implemented | Passed |
|:---------------------------|:-----------:|:------:|
| is_void | ✔ | ✔ |
| is_null_pointer | ✔ | ✔ |
| is_integral | ✔ | ✔ |
| is_floating_point | ✔ | ✔ |
| is_array | ✔ | ❓ |
| is_enum | ❌ | ❌ |
| is_union | ❌ | ❌ |
| is_class | ✔ | ✔ |
| is_function | ❌ | ❌ |
| is_pointer | ✔ | ✔ |
| is_lvalue_reference | ✔ | ✔ |
| is_void | ✅ | ✅ |
| is_null_pointer | ✅ | ✅ |
| is_integral | ✅ | ✅ |
| is_floating_point | ✅ | ✅ |
| is_array | ✅ | ❓ |
| is_enum | ⛔ | ⛔ |
| is_union | ⛔ | ⛔ |
| is_class | ✅ | ✅ |
| is_function | ⛔ | ⛔ |
| is_pointer | ✅ | ✅ |
| is_lvalue_reference | ✅ | ✅ |
| is_rvalue_reference | ✔ | ✔ |
| is_member_object_pointer | ❌ | ❌ |
| is_member_function_pointer | ❌ | ❌ |
| is_member_object_pointer | ⛔ | ⛔ |
| is_member_function_pointer | ⛔ | ⛔ |
### Composite Types
| Symbol | Implemented | Passed |
|:------------------|:-----------:|:------:|
| is_fundamental | ✔ | ✔ |
| is_arithmetic | ✔ | ✔ |
| is_scalar | ❌ | ❌ |
| is_object | ❌ | ❌ |
| is_compound | ❌ | ❌ |
| is_reference | ❌ | ❌ |
| is_member_pointer | ❌ | ❌ |
| is_scalar | ⛔ | ⛔ |
| is_object | ⛔ | ⛔ |
| is_compound | ⛔ | ⛔ |
| is_reference | ⛔ | ⛔ |
| is_member_pointer | ⛔ | ⛔ |
### Type Properties
| Symbol | Implemented | Passed |
@@ -87,37 +87,37 @@ See:
| is_const | ✔ | ✔ |
| is_volatile | ✔ | ✔ |
| is_trivially_copyable | ✔ | ✔ |
| is_standard_layout | ❌ | ❌ |
| has_unique_object_representations | ❌ | ❌ |
| is_empty | ❌ | ❌ |
| is_polymorphic | ❌ | ❌ |
| is_abstract | ❌ | ❌ |
| is_final | ❌ | ❌ |
| is_aggregate | ❌ | ❌ |
| is_implicit_lifetime | ❌ | ❌ |
| is_standard_layout | ⛔ | ⛔ |
| has_unique_object_representations | ⛔ | ⛔ |
| is_empty | ⛔ | ⛔ |
| is_polymorphic | ⛔ | ⛔ |
| is_abstract | ⛔ | ⛔ |
| is_final | ⛔ | ⛔ |
| is_aggregate | ⛔ | ⛔ |
| is_implicit_lifetime | ⛔ | ⛔ |
| is_signed | ✔ | ✔ |
| is_unsigned | ✔ | ✔ |
| is_bounded_array | ❌ | ❌ |
| is_unbounded_array | ❌ | ❌ |
| is_scoped_enum | ❌ | ❌ |
| is_bounded_array | ⛔ | ⛔ |
| is_unbounded_array | ⛔ | ⛔ |
| is_scoped_enum | ⛔ | ⛔ |
### Supported Operations
| Symbol | Implemented | Passed |
|:------------------------------------|:-----------:|:------:|
| is_constructible | ✔ | ✔ |
| is_trivially_constructible | ✔ | ✔ |
| is_nothrow_constructible | ❌ | ❌ |
| is_nothrow_constructible | ⛔ | ⛔ |
| is_default_constructible | ✔ | ✔ |
| is_trivially_default_constructible | ❌ | ❌ |
| is_nothrow_default_constructible | ❌ | ❌ |
| is_trivially_default_constructible | ⛔ | ⛔ |
| is_nothrow_default_constructible | ⛔ | ⛔ |
| is_copy_constructible | ✔ | ✔ |
| is_trivially_copy_constructible | ❌ | ❌ |
| is_nothrow_copy_constructible | ❌ | ❌ |
| is_trivially_copy_constructible | ⛔ | ⛔ |
| is_nothrow_copy_constructible | ⛔ | ⛔ |
| is_move_constructible | ✔ | ✔ |
| is_trivially_move_constructible | ❌ | ❌ |
| is_nothrow_move_constructible | ❌ | ❌ |
| is_destructible | ❌ | ❌ |
| is_trivially_destructible | ❌ | ❌ |
| is_trivially_move_constructible | ⛔ | ⛔ |
| is_nothrow_move_constructible | ⛔ | ⛔ |
| is_destructible | ⛔ | ⛔ |
| is_trivially_destructible | ⛔ | ❌ |
| is_nothrow_destructible | ❌ | ❌ |
| has_virtual_destructor | ❌ | ❌ |
| is_swappable | ❌ | ❌ |
@@ -174,7 +174,7 @@ See:
| aligned_storage | ❌ | ❌ |
| aligned_union | ❌ | ❌ |
| aligned_union | ❌ | ❌ |
| decay | ⭕ | ⭕ |
| decay | 🚧 | 🚧 |
| remove_cvref | ✔ | ✔ |
| enable_if | ✔ | ✔ |
| conditional | ✔ | ✔ |

66
planning/LANGUAGE_PROCESSING.md
View File

@@ -37,10 +37,10 @@ highly performant on the right surface.
| Symbol | Implemented | Passed |
|:---------|:-----------:|:------:|
| cstring | ✔ | ✔ |
| string | ✔ | ✔ |
| wcstring | ✔ | ✔ |
| wstring | ✔ | ✔ |
| cstring | ✅ | ✅ |
| string | ✅ | ✅ |
| wcstring | ✅ | ✅ |
| wstring | ✅ | ✅ |
@@ -53,9 +53,9 @@ is create C++ classes that handle file streams, directory streams, and file path
| Symbol | Implemented | Passed |
|:----------|:-----------:|:------:|
| path | ✔ | ✔ |
| file | ✔ | ✔ |
| directory | ❌ | ❌ |
| path | ✅ | ✅ |
| file | ✅ | ✅ |
| directory | ⛔ | ⛔ |
@@ -102,44 +102,44 @@ data values (e.g. floats, ints, etc.) to a readable language (e.g. ascii/utf8/ut
| Symbol | Implemented | Passed |
|:-------|:-----------:|:------:|
| JSON | ❌ | ❌ |
| HTML | ❌ | ❌ |
| XML | ❌ | ❌ |
| YAML | ❌ | ❌ |
| JSON | ⛔ | ⛔ |
| HTML | ⛔ | ⛔ |
| XML | ⛔ | ⛔ |
| YAML | ⛔ | ⛔ |
### Configuration
| Symbol | Implemented | Passed |
|:-------|:-----------:|:------:|
| INI | ❌ | ❌ |
| TOML | ❌ | ❌ |
| INI | ⛔ | ⛔ |
| TOML | ⛔ | ⛔ |
### Documents
| Symbol | Implemented | Passed |
|:---------|:-----------:|:------:|
| ODF | ❌ | ❌ |
| Markdown | ❌ | ❌ |
| PDF | ❌ | ❌ |
| ODF | ⛔ | ⛔ |
| Markdown | ⛔ | ⛔ |
| PDF | ⛔ | ⛔ |
### Spreadsheets & Tables
| Symbol | Implemented | Passed |
|:---------|:-----------:|:------:|
| ODS | ❌ | ❌ |
| CSV | ❌ | ❌ |
| ODS | ⛔ | ⛔ |
| CSV | ⛔ | ⛔ |
### Audio Formats
| Symbol | Implemented | Passed |
|:---------|:-----------:|:------:|
| MP3 | ❌ | ❌ |
| WAV | ❌ | ❌ |
| AAC | ❌ | ❌ |
| MP3 | ⛔ | ⛔ |
| WAV | ⛔ | ⛔ |
| AAC | ⛔ | ⛔ |
### Graphics Formats
@@ -148,20 +148,20 @@ data values (e.g. floats, ints, etc.) to a readable language (e.g. ascii/utf8/ut
| Symbol | Implemented | Passed |
|:-------|:-----------:|:------:|
| BMP | ❌ | ❌ |
| DDS | ❌ | ❌ |
| JPG | ❌ | ❌ |
| PNG | ❌ | ❌ |
| TIFF | ❌ | ❌ |
| BMP | ⛔ | ⛔ |
| DDS | ⛔ | ⛔ |
| JPG | ⛔ | ⛔ |
| PNG | ⛔ | ⛔ |
| TIFF | ⛔ | ⛔ |
#### Vector Graphics
| Symbol | Implemented | Passed |
|:-------|:-----------:|:------:|
| OTF | ❌ | ❌ |
| SVG | ❌ | ❌ |
| TTF | ❌ | ❌ |
| OTF | ⛔ | ⛔ |
| SVG | ⛔ | ⛔ |
| TTF | ⛔ | ⛔ |
#### 3D Model Formats
@@ -172,10 +172,10 @@ by assimp.
| Symbol | Implemented | Passed |
|:----------------|:-----------:|:------:|
| 3D | ❌ | ❌ |
| 3DS | ❌ | ❌ |
| 3MF | ❌ | ❌ |
| AC | ❌ | ❌ |
| 3D | ⛔ | ⛔ |
| 3DS | ⛔ | ⛔ |
| 3MF | ⛔ | ⛔ |
| AC | ⛔ | ❌ |
| AC3D | ❌ | ❌ |
| ACC | ❌ | ❌ |
| AMJ | ❌ | ❌ |

14
planning/MEMORY.md
View File

@@ -24,10 +24,10 @@ C stdlib and either wraps them or aliases them.
| Symbol | Implemented | Passed |
|:-----------------|:-----------:|:------:|
| allocator | ✔ | ✔ |
| allocator_traits | ✔ | ✔ |
| allocation | ✔ | ✔ |
| default_delete | ✔ | ❓ |
| unique_pointer | ✔ | ❓ |
| shared_pointer | ❌ | ❌ |
| pointer_traits | ❌ | ❌ |
| allocator | ✅ | ✅ |
| allocator_traits | ✅ | ✅ |
| allocation | ✅ | ✅ |
| default_delete | ✅ | ❓ |
| unique_pointer | ✅ | ❓ |
| shared_pointer | ⛔ | ⛔ |
| pointer_traits | ⛔ | ⛔ |

2
planning/PLATFORM_SUPPORT.md
View File

@@ -25,7 +25,7 @@ Drivers that must be initialized for the engine context.
Platform Support will be implemented in the following order:
- Linux/BSD
- Wayland
- OpenGL (EGL) ✔
- OpenGL (EGL) ✅
- XKB
- PulseAudio
- Vulkan