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

- Debugged more PrettyPrinters, all implemented thus far work in testing

Browse Source 
- Fixed implementation of tuple.h, TODO: Still need to complete
 - Wrote a PrettyPrinter for tuple.h
This commit is contained in:
Medusa Slockbower
2025-08-10 23:46:36 -04:00
parent 9f96155856
commit b9de039a10
12 changed files with 170 additions and 44 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
doxy/Doxyfile
View File

@@ -48,7 +48,7 @@ PROJECT_NAME = fennec
# could be handy for archiving the generated documentation or if some version
# control system is used.
PROJECT_NUMBER = 1.0.2
PROJECT_NUMBER =
# Using the PROJECT_BRIEF tag one can provide an optional one line description
# for a project that appears at the top of each page and should give viewer a

1
gdb/fennec/__init__.py
View File

@@ -24,6 +24,7 @@ import gdb
from . import containers
from . import strings
from . import memory
from . import utility
def register_printers(obj):
gdb.printing.register_pretty_printer(obj, containers.printer)

32
gdb/fennec/containers.py
View File

@@ -19,6 +19,7 @@
import gdb
import re
from collections import deque
from . import utility
# OPTIONAL =============================================================================================================
class OptionalPrinter:
@@ -34,7 +35,7 @@ class OptionalPrinter:
else:
return "{ empty }"
# OPTIONAL =============================================================================================================
# PAIR =================================================================================================================
class PairPrinter:
"""Print a fennec::optional"""
@@ -48,8 +49,28 @@ class PairPrinter:
return ("first", self.val['first']), ("second", self.val['second'])
# TUPLE ================================================================================================================
class TuplePrinter:
"""Print a fennec::tuple"""
def __init__(self, val):
self.fields = val.type.fields()[0].type.fields()
self.elems = val
self.count = len(self.fields)
def to_string(self):
return " { size = " + str(len(self.fields)) + " }"
def children(self):
return (('[{}]'.format(i), self.elems.cast(self.fields[i].type)['value']) for i in range(self.count))
# ARRAY ================================================================================================================
class ArrayPrinter:
"""Print a fennec::array"""
def __init__(self, val):
self.val = val
@@ -66,6 +87,8 @@ class ArrayPrinter:
# DYNARRAY =============================================================================================================
class DynArrayPrinter:
"""Print a fennec::dynarray"""
def __init__(self, val):
self.val = val
@@ -201,6 +224,7 @@ class RDTreePrinter:
# SET ==================================================================================================================
class SetPrinter:
"""Print a fennec::set"""
class Iterator:
def __init__(self, table, capacity):
@@ -244,6 +268,7 @@ class SetPrinter:
# MAP ==================================================================================================================
class MapPrinter:
"""Print a fennec::map"""
class Iterator:
def __init__(self, table, capacity):
@@ -272,12 +297,12 @@ class MapPrinter:
if not self.move:
self.move = True
return ('key' + str(i), key)
return 'key' + str(i), key
else:
self.move = False
self.index = self.index + 1
self.node = self.node + 1
return ('value' + str(i), val)
return 'value' + str(i), val
def __init__(self, val):
self.table = val['_set']['_alloc']['_data']
@@ -303,6 +328,7 @@ def register_printers():
pp = gdb.printing.RegexpCollectionPrettyPrinter("fennec::containers")
pp.add_printer('optional', '^fennec::optional<.*>$', OptionalPrinter)
pp.add_printer('pair', '^fennec::pair<.*>$', PairPrinter)
pp.add_printer('tuple', '^fennec::tuple<.*>$', TuplePrinter)
pp.add_printer('array', '^fennec::array<.*>$', ArrayPrinter)
pp.add_printer('dynarray', '^fennec::dynarray<.*>$', DynArrayPrinter)
pp.add_printer('list', '^fennec::list<.*>$', ListPrinter)

20
gdb/fennec/utility.py Normal file
View File

@@ -0,0 +1,20 @@
# ======================================================================================================================
# fennec, a free and open source game engine
# Copyright © 2025 Medusa Slockbower
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <https://www.gnu.org/licenses/>.
# ======================================================================================================================
def printMembers(obj):
print(str(dir(obj)))

34
include/fennec/containers/detail/_tuple.h
View File

@@ -24,34 +24,28 @@
namespace fennec::detail
{
// leaves
template<size_t i, typename T>
struct _tuple_leaf {
T value;
template<typename...ArgsT>
_tuple_leaf(ArgsT&&...args) : value(args...) {
}
template <std::size_t I, typename T>
struct _tuple_leaf
{
template <typename ArgT>
_tuple_leaf(ArgT&& arg) : value(fennec::forward<ArgT>(arg)) {}
constexpr operator T&() {
return value;
}
~_tuple_leaf() = default;
constexpr operator const T&() const {
return value;
}
T value;
};
// proxy
template<typename, typename...TypesT>
template <typename, typename...>
struct _tuple;
template<size_t...i, typename...TypesT>
struct _tuple<index_sequence<i...>, TypesT...> : _tuple_leaf<i, TypesT>... {
template <size_t...IndicesV, typename...TypesT>
struct _tuple<index_sequence<IndicesV...>, TypesT...> : _tuple_leaf<IndicesV, TypesT>...
{
template <typename...ArgsT>
_tuple(ArgsT&&... args) : _tuple_leaf<IndicesV, TypesT>(fennec::forward<ArgsT>(args))... {}
template<typename...ArgsT>
_tuple(ArgsT&&...args) : _tuple_leaf<i, TypesT>(args)... {
}
~_tuple() = default;
};
}

36
include/fennec/containers/tuple.h
View File

@@ -36,32 +36,44 @@ template<typename...TypesT> struct tuple;
template<size_t i, typename...TypesT>
constexpr typename tuple<TypesT...>::template elem_t<i>& get(tuple<TypesT...>& x) {
using elem_t = typename tuple<TypesT...>::template elem_t<i>;
auto& it = static_cast<detail::_tuple_leaf<i, elem_t>>(x);
return it;
auto& it = *static_cast<detail::_tuple_leaf<i, elem_t>*>(&x);
return it.value;
}
template<size_t i, typename...TypesT>
constexpr const typename tuple<TypesT...>::template elem_t<i>& get(tuple<TypesT...>& x) {
constexpr const typename tuple<TypesT...>::template elem_t<i>& get(const tuple<TypesT...>& x) {
using elem_t = typename tuple<TypesT...>::template elem_t<i>;
auto& it = static_cast<detail::_tuple_leaf<i, elem_t>>(x);
return it;
const auto& it = *static_cast<const detail::_tuple_leaf<i, elem_t>*>(&x);
return it.value;
}
template<typename...TypesT>
struct tuple : detail::_tuple<make_index_sequence<sizeof...(TypesT)>, TypesT...> {
public:
using base_t = detail::_tuple<make_index_sequence<sizeof...(TypesT)>, TypesT...>;
template<typename ...TypesT>
struct tuple : public detail::_tuple<make_index_sequence_t<sizeof...(TypesT)>, TypesT...>
{
using base_t = detail::_tuple<make_index_sequence_t<sizeof...(TypesT)>, TypesT...>;
template<size_t i>
using elem_t = nth_element<i, TypesT...>;
using elem_t = typename nth_element<i, TypesT...>::type;
template<typename...ArgsT>
constexpr tuple(ArgsT&&...args) : base_t(args...) {
tuple(ArgsT&&...args)
: base_t(fennec::forward<ArgsT>(args)...) {
}
tuple(const tuple& cpy)
: base_t(cpy) {
}
tuple(tuple&& cpy)
: base_t(cpy) {
}
};
// This is needed for
template<typename...TypesT>
tuple(TypesT...) -> tuple<TypesT...>;
}
#endif // FENNEC_CONTAINERS_TUPLE_H

4
include/fennec/lang/detail/_type_sequences.h
View File

@@ -32,8 +32,8 @@ namespace fennec::detail
template<size_t n, size_t i, typename HeadT, typename...RestT>
struct _nth_element<n, i, HeadT, RestT...> : conditional<
n == i, type_identity<HeadT>,
_nth_element<n, i + 1, RestT...>
n == i, HeadT,
typename _nth_element<n, i + 1, RestT...>::type
> {};
}

33
include/fennec/langproc/strings/string.h
View File

@@ -86,10 +86,10 @@ public:
///
/// \details adds additional character for null termination. Ignores whether str is null-terminated.
/// This constructor makes the assumption that `n` is the intended number of characters.
constexpr _string(const char* str, size_t n)
: _str(n + 1) {
constexpr _string(char* str, size_t n)
: _str(str[n - 1] == '\0' ? n : n + 1) {
fennec::memcpy(_str.data(), str, n);
_str[n] = '\0';
if (str[n - 1] != '\0') _str[n] = '\0';
}
///
@@ -97,7 +97,30 @@ public:
/// \param str the buffer to wrap
/// \tparam n the number of characters in the buffer plus the null terminator
template<size_t n>
constexpr _string(char(&str)[n])
explicit constexpr _string(char(&str)[n])
: _str(str, n) {
assert(_str[n - 1] == '\0', "Invalid NTBS.");
}
///
/// \brief Buffer Copy Constructor
/// \param str the buffer to copy
/// \param n number of characters in the buffer
///
/// \details adds additional character for null termination. Ignores whether str is null-terminated.
/// This constructor makes the assumption that `n` is the intended number of characters.
constexpr _string(const char* str, size_t n)
: _str(str[n - 1] == '\0' ? n : n + 1) {
fennec::memcpy(_str.data(), str, n);
if (str[n - 1] != '\0') _str[n] = '\0';
}
///
/// \brief Buffer Constructor, wraps the provided C-Style string
/// \param str the buffer to wrap
/// \tparam n the number of characters in the buffer plus the null terminator
template<size_t n>
explicit constexpr _string(const char(&str)[n])
: _str(str, n) {
assert(_str[n - 1] == '\0', "Invalid NTBS.");
}
@@ -385,7 +408,7 @@ public:
/// \returns
constexpr _string operator+(char c) const {
// Copy contents with one additional byte.
_string res(_str.data(), _str.size());
_string res(_str.data(), _str.size() + 1);
res[size()] = c; // Set the last character to c
return res;
}

2
planning/CONTAINERS.md
View File

@@ -29,7 +29,7 @@ Library and Template Library.
| Symbol | Implemented | Passed |
|:-------------------------------------|:-----------:|:------:|
| pair | ✔ | ✔ |
| tuple | ⭕ | ❌ |
| tuple | ⭕ | ⭕ |
| optional | ✔ | ✔ |
| variant | ❌ | ❌ |
| any | ❌ | ❌ |

1
test/CMakeLists.txt
View File

@@ -34,6 +34,7 @@ add_executable(fennec-test main.cpp
tests/containers/test_map.h
tests/containers/test_rdtree.h
tests/containers/test_list.h
tests/containers/test_tuple.h
)
target_compile_definitions(fennec-test PUBLIC FENNEC_TEST_CWD="${CMAKE_SOURCE_DIR}/bin/${FENNEC_BUILD_NAME}"

43
test/tests/containers/test_tuple.h Normal file
View File

@@ -0,0 +1,43 @@
// =====================================================================================================================
// fennec, a free and open source game engine
// Copyright © 2025 Medusa Slockbower
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program. If not, see <https://www.gnu.org/licenses/>.
// =====================================================================================================================
#ifndef FENNEC_TEST_CONTAINERS_TUPLE_H
#define FENNEC_TEST_CONTAINERS_TUPLE_H
#include <fennec/containers/tuple.h>
#include <fennec/langproc/strings/string.h>
namespace fennec
{
namespace test
{
inline void fennec_test_containers_tuple() {
string str{ "Hello World!" };
tuple test { 0, 0.5f, str };
fennec_test_run(get<0>(test), 0);
fennec_test_run(get<1>(test), 0.5f);
fennec_test_run(get<2>(test), str);
}
}
}
#endif // FENNEC_TEST_CONTAINERS_TUPLE_H

6
test/tests/test_containers.h
View File

@@ -26,6 +26,7 @@
#include "containers/test_optional.h"
#include "containers/test_rdtree.h"
#include "containers/test_set.h"
#include "containers/test_tuple.h"
namespace fennec::test
{
@@ -37,6 +38,11 @@ namespace fennec::test
fennec_test_containers_optional();
fennec_test_spacer(3);
fennec_test_subheader("tuple tests");
fennec_test_spacer(2);
fennec_test_containers_tuple();
fennec_test_spacer(3);
fennec_test_subheader("array tests");
fennec_test_spacer(2);
fennec_test_containers_array();