From 981e65bf9761fb961bf8a5844a6543c75ff2c861 Mon Sep 17 00:00:00 2001 From: Totto16 Date: Fri, 21 Jun 2024 00:37:44 +0200 Subject: [PATCH 01/11] Wrapper: Add WIP C Wrapper --- wrapper/README.md | 2 + wrapper/c/meson.build | 54 ++++++++++++ wrapper/c/src/meson.build | 9 ++ wrapper/c/src/oopetris_wrapper.h | 142 ++++++++++++++++++++++++++++++ wrapper/c/src/wraper.cpp | 145 +++++++++++++++++++++++++++++++ 5 files changed, 352 insertions(+) create mode 100644 wrapper/c/meson.build create mode 100644 wrapper/c/src/meson.build create mode 100644 wrapper/c/src/oopetris_wrapper.h create mode 100644 wrapper/c/src/wraper.cpp diff --git a/wrapper/README.md b/wrapper/README.md index 5ca2d7bc..7802fde2 100644 --- a/wrapper/README.md +++ b/wrapper/README.md @@ -15,10 +15,12 @@ Planned: Current: - Node.js +- C Planned: - Python - Lua +- Haskell ## Other diff --git a/wrapper/c/meson.build b/wrapper/c/meson.build new file mode 100644 index 00000000..e637560c --- /dev/null +++ b/wrapper/c/meson.build @@ -0,0 +1,54 @@ +project( + 'oopetris_c_wrapper', + 'cpp', + 'c', + meson_version: '>=1.3.0', + default_options: { + 'buildtype': 'debug', + 'optimization': '3', + 'strip': true, + 'cpp_std': ['c++23', 'c++latest', 'vc++latest', 'c++20'], + 'b_ndebug': 'if-release', + + }, + version: '0.5.6', +) + +deps = [] + +deps += dependency('oopetris-recordings') + +src_files = [] + +subdir('src') + +src_files + +liboopetris_c_wrapper = library( + 'oopetris_c_wrapper', + src_files, + dependencies: deps, + override_options: { + 'warning_level': '3', + 'werror': true, + }, + version: meson.project_version(), + install: true, +) + +liboopetris_c_wrapper_dep = declare_dependency( + link_with: liboopetris_c_wrapper, + dependencies: deps, + version: meson.project_version(), +) +meson.override_dependency('liboopetris-c-wrapper', liboopetris_c_wrapper_dep) + +# generate pkgconfig files +pkg = import('pkgconfig') +pkg.generate( + liboopetris_c_wrapper, + description: 'The C Wrapper library for oopetris', + name: 'oopetris-c-wrapper', + filebase: 'oopetris-c-wrapper', + subdirs: 'oopetris' +) diff --git a/wrapper/c/src/meson.build b/wrapper/c/src/meson.build new file mode 100644 index 00000000..bcb225cb --- /dev/null +++ b/wrapper/c/src/meson.build @@ -0,0 +1,9 @@ +recordings_include_dir = include_dir / 'oopetris' + +install_headers( + files('oopetris_wrapper.h'), + install_dir: recordings_include_dir, + preserve_path: true, +) + +src_files += files('wrapper.cpp') diff --git a/wrapper/c/src/oopetris_wrapper.h b/wrapper/c/src/oopetris_wrapper.h new file mode 100644 index 00000000..72be4674 --- /dev/null +++ b/wrapper/c/src/oopetris_wrapper.h @@ -0,0 +1,142 @@ + + +#pragma once + + +#ifdef __cplusplus +extern "C" { +#else +#endif +#include +#include + +/** + * @brief this determines if a file (may be nonexistent) is a recording file, it is not guaranteed, tat a consecutive call to oopetris_get_recording_information never fails, if rthis returns true, but it's highly unliekely, and this is faster, as it doesn't do as much work + * + * @param file_path The FilePath of the potential recording file + * @return bool + */ +bool oopetris_is_recording_file(const char* file_path); + +// non opaque type, fields can be safely accessed, excpet the are opaque structs again +typedef struct { + bool i; + int z; +} OOPetrisRecordingInformation; + + +// opaque type +typedef struct OOPetrisRecordingReturnValueImpl OOPetrisRecordingReturnValue; + + +/** + * @brief Retrieve the Recording information of a file, returns an opaque struct pointer, that may be null and you have to use oopetris_is_error and similar functions to retrieve the internal value + * + * @param file_path The FilePath of the recording file + * @return OOPetrisRecordingReturnValue* + */ +OOPetrisRecordingReturnValue* oopetris_get_recording_information(const char* file_path); + +/** + * @brief Determine if the given OOPetrisRecordingReturnValue* is an error or not, after calling this you can call either oopetris_get_error or oopetris_get_information. This has to be freed later, but pay attention, which free function you use, read more in the description of oopetris_free_recording_value + * + * @param value The return value of oopetris_get_recording_information + * @return bool + */ +bool oopetris_is_error(OOPetrisRecordingReturnValue* value); + +const char* oopetris_get_error(OOPetrisRecordingReturnValue* value); + +OOPetrisRecordingInformation* oopetris_get_information(OOPetrisRecordingReturnValue* value); + +void oopetris_free_recording_information(OOPetrisRecordingInformation** information); + +void oopetris_free_recording_value_only(OOPetrisRecordingReturnValue** information); + +void oopetris_free_recording_value_whole(OOPetrisRecordingReturnValue** information); + +const char* oopetris_get_lib_version(); + +typedef struct { + uint32_t height; + uint32_t width; +} GridProperties; + +GridProperties* oopetris_get_grid_properties(); + +void oopetris_free_grid_properties(GridProperties** properties); + + +#ifdef __cplusplus +} +#endif + + +export type AdditionalInformation = Record + + export type InputEvent = + | "RotateLeftPressed" | "RotateRightPressed" | "MoveLeftPressed" | "MoveRightPressed" + | "MoveDownPressed" | "DropPressed" | "HoldPressed" | "RotateLeftReleased" | "RotateRightReleased" + | "MoveLeftReleased" | "MoveRightReleased" | "MoveDownReleased" | "DropReleased" + | "HoldReleased" + + export type TetrionRecord = { event: InputEvent simulation_step_index: number tetrion_index: number } + +export type MinoPosition = { x: number y: number } + +export type TetrominoType = "I" | "J" | "L" | "O" | "S" | "T" + | "Z" + + export type Mino = { position: MinoPosition type: TetrominoType } + +export type TetrionSnapshot = { + level: number lines_cleared: number mino_stack: Mino[] score: number simulation_step_index: number + tetrion_index: number +} + +export type TetrionHeader = { seed: number starting_level: number } + +export type RecordingInformation = { + information: AdditionalInformation records: TetrionRecord[] snapshots: TetrionSnapshot[] + tetrion_headers: TetrionHeader[] version: number +} + +export type GridProperties = { height: number width: number } + +export type RecordingsProperties = { gridProperties: GridProperties } + +export class RecordingsUtility { + static isRecordingFile(file : string) : boolean { + try { + // this throws, when file is not an string or not there at all, just be safe for JS land + return oopetris.isRecordingFile(file) + } catch (_err) { + return false + } + } + + static getInformation(file : string) : null | RecordingInformation { + if (!fs.existsSync(file)) { + return null + } + + try { + if (!RecordingsUtility.isRecordingFile(file)) { + return null + } + + // this throws, when file is not an string, not there at all, or some other error regarding serialization from c++ land to JS land occurs, just be safe for JS land + return oopetris.getInformation(file) + } catch (_err) { + return null + } + } + + static get properties() : GridProperties { + return oopetris.properties + } + + static get version() : string { + return oopetris.version + } +} diff --git a/wrapper/c/src/wraper.cpp b/wrapper/c/src/wraper.cpp new file mode 100644 index 00000000..90fdcea2 --- /dev/null +++ b/wrapper/c/src/wraper.cpp @@ -0,0 +1,145 @@ + + +#include "oopetris_wrapper.h" + +#include +#include +#include + + +bool oopetris_is_recording_file(const char* file_path) { + + if (file_path == nullptr) { + return false; + } + + if (not std::filesystem::exists(file_path)) { + return false; + } + + auto parsed = recorder::RecordingReader::from_path(file_path); + + return parsed.has_value(); +} + + +struct OOPetrisRecordingReturnValueImpl { + bool is_error; + union { + OOPetrisRecordingInformation* information; + const char* error; + } value; +}; + + +static OOPetrisRecordingReturnValue* +construct_error_from_cstr_impl(OOPetrisRecordingReturnValue* return_value, const char* value, size_t length) { + + const char* alloced_str = malloc(length + 1); + + if (alloced_str == nullptr) { + return nullptr; + } + + strcpy(alloced_str, value); + + return_value->is_error = true; + return_value->value.error = alloced_str; +} + +static OOPetrisRecordingReturnValue* +construct_error_from_cstr(OOPetrisRecordingReturnValue* return_value, const char* value) { + return construct_error_from_cstr_impl(return_value, value, strlen(value)); +} + +static OOPetrisRecordingReturnValue* +construct_error_from_string(OOPetrisRecordingReturnValue* return_value, const std::string& value) { + return construct_error_from_cstr_impl(return_value, value, value.size()); +} + +OOPetrisRecordingReturnValue* oopetris_get_recording_information(const char* file_path) { + + OOPetrisRecordingReturnValue* return_value = malloc(sizeof(OOPetrisRecordingReturnValue)); + + if (return_value == nullptr) { + return nullptr; + } + + if (file_path == nullptr) { + return construct_error_from_cstr(return_value, "FilePath is NULL"); + } + + + if (not std::filesystem::exists(file_path)) { + std::string error = "File '"; + error += filePath; + error += "' doesn't exist!"; + + return construct_error_from_string(return_value, error); + } + + auto parsed = recorder::RecordingReader::from_path(file_path); + + if (not parsed.has_value()) { + std::string error = "An error occurred during parsing of the recording file '"; + error += filePath; + error += "': "; + error += parsed.error(); + + return construct_error_from_string(return_value, error); + } + + const auto recording_reader = std::move(parsed.value()); + + + //TODO + return nullptr; +} + +bool oopetris_is_error(OOPetrisRecordingReturnValue* value) { + return value->is_error; +} + +const char* oopetris_get_error(OOPetrisRecordingReturnValue* value) { + return value->value.error; +} + +OOPetrisRecordingInformation* oopetris_get_information(OOPetrisRecordingReturnValue* value) { + return value->value.information; +} + +void oopetris_free_recording_information(OOPetrisRecordingInformation** information) { + //TODO: improve + free(*information); + *information = nullptr; +} + +void oopetris_free_recording_value_only(OOPetrisRecordingReturnValue** information) { + free(*information); + *information = nullptr; +} + +void oopetris_free_recording_value_whole(OOPetrisRecordingReturnValue** information) { + if (oopetris_is_error(*information)) { + free(**information->value->error); + } else { + oopetris_free_recording_information(&(*information->value->information)); + } + + oopetris_free_recording_value_only(information); +} + +const char* oopetris_get_lib_version() { + // this is a string literal and in static (global) storage, so safe to return and don't create a memory leak + return utils::version().c_str(); +} + +GridProperties* oopetris_get_grid_properties() { + GridProperties* properties = malloc(siezof(GridProperties)); + if (properties == nullptr) { + return nullptr; + } + + properties->height = grid::height_in_tiles; + properties->width = grid::width_in_tiles; +} From 845fd4e33a9b71f928fa69e5ea93a14d37b08d39 Mon Sep 17 00:00:00 2001 From: Totto16 Date: Fri, 21 Jun 2024 00:55:05 +0200 Subject: [PATCH 02/11] Wrapper: C, make it compile --- src/libs/core/helper/versions.hpp | 4 +- wrapper/c/src/meson.build | 5 +- wrapper/c/src/oopetris_wrapper.h | 72 +---------------------- wrapper/c/src/{wraper.cpp => wrapper.cpp} | 26 ++++---- 4 files changed, 20 insertions(+), 87 deletions(-) rename wrapper/c/src/{wraper.cpp => wrapper.cpp} (83%) diff --git a/src/libs/core/helper/versions.hpp b/src/libs/core/helper/versions.hpp index d4c48eda..6e5975dd 100644 --- a/src/libs/core/helper/versions.hpp +++ b/src/libs/core/helper/versions.hpp @@ -13,9 +13,7 @@ namespace utils { #endif - [[nodiscard]] inline std::string version() { - - + [[nodiscard]] inline const char* version() { return STRINGIFY(OOPETRIS_VERSION); } diff --git a/wrapper/c/src/meson.build b/wrapper/c/src/meson.build index bcb225cb..92b7c142 100644 --- a/wrapper/c/src/meson.build +++ b/wrapper/c/src/meson.build @@ -1,8 +1,9 @@ -recordings_include_dir = include_dir / 'oopetris' +include_dir = get_option('prefix') / get_option('includedir') +c_wrapper_include_dir = include_dir / 'oopetris' install_headers( files('oopetris_wrapper.h'), - install_dir: recordings_include_dir, + install_dir: c_wrapper_include_dir, preserve_path: true, ) diff --git a/wrapper/c/src/oopetris_wrapper.h b/wrapper/c/src/oopetris_wrapper.h index 72be4674..68bf8923 100644 --- a/wrapper/c/src/oopetris_wrapper.h +++ b/wrapper/c/src/oopetris_wrapper.h @@ -20,7 +20,7 @@ bool oopetris_is_recording_file(const char* file_path); // non opaque type, fields can be safely accessed, excpet the are opaque structs again typedef struct { - bool i; + bool i; //TODO int z; } OOPetrisRecordingInformation; @@ -70,73 +70,3 @@ void oopetris_free_grid_properties(GridProperties** properties); #ifdef __cplusplus } #endif - - -export type AdditionalInformation = Record - - export type InputEvent = - | "RotateLeftPressed" | "RotateRightPressed" | "MoveLeftPressed" | "MoveRightPressed" - | "MoveDownPressed" | "DropPressed" | "HoldPressed" | "RotateLeftReleased" | "RotateRightReleased" - | "MoveLeftReleased" | "MoveRightReleased" | "MoveDownReleased" | "DropReleased" - | "HoldReleased" - - export type TetrionRecord = { event: InputEvent simulation_step_index: number tetrion_index: number } - -export type MinoPosition = { x: number y: number } - -export type TetrominoType = "I" | "J" | "L" | "O" | "S" | "T" - | "Z" - - export type Mino = { position: MinoPosition type: TetrominoType } - -export type TetrionSnapshot = { - level: number lines_cleared: number mino_stack: Mino[] score: number simulation_step_index: number - tetrion_index: number -} - -export type TetrionHeader = { seed: number starting_level: number } - -export type RecordingInformation = { - information: AdditionalInformation records: TetrionRecord[] snapshots: TetrionSnapshot[] - tetrion_headers: TetrionHeader[] version: number -} - -export type GridProperties = { height: number width: number } - -export type RecordingsProperties = { gridProperties: GridProperties } - -export class RecordingsUtility { - static isRecordingFile(file : string) : boolean { - try { - // this throws, when file is not an string or not there at all, just be safe for JS land - return oopetris.isRecordingFile(file) - } catch (_err) { - return false - } - } - - static getInformation(file : string) : null | RecordingInformation { - if (!fs.existsSync(file)) { - return null - } - - try { - if (!RecordingsUtility.isRecordingFile(file)) { - return null - } - - // this throws, when file is not an string, not there at all, or some other error regarding serialization from c++ land to JS land occurs, just be safe for JS land - return oopetris.getInformation(file) - } catch (_err) { - return null - } - } - - static get properties() : GridProperties { - return oopetris.properties - } - - static get version() : string { - return oopetris.version - } -} diff --git a/wrapper/c/src/wraper.cpp b/wrapper/c/src/wrapper.cpp similarity index 83% rename from wrapper/c/src/wraper.cpp rename to wrapper/c/src/wrapper.cpp index 90fdcea2..53b44be6 100644 --- a/wrapper/c/src/wraper.cpp +++ b/wrapper/c/src/wrapper.cpp @@ -27,7 +27,7 @@ struct OOPetrisRecordingReturnValueImpl { bool is_error; union { OOPetrisRecordingInformation* information; - const char* error; + char* error; } value; }; @@ -35,9 +35,10 @@ struct OOPetrisRecordingReturnValueImpl { static OOPetrisRecordingReturnValue* construct_error_from_cstr_impl(OOPetrisRecordingReturnValue* return_value, const char* value, size_t length) { - const char* alloced_str = malloc(length + 1); + auto* alloced_str = static_cast(malloc(length + 1)); if (alloced_str == nullptr) { + free(return_value); return nullptr; } @@ -45,6 +46,8 @@ construct_error_from_cstr_impl(OOPetrisRecordingReturnValue* return_value, const return_value->is_error = true; return_value->value.error = alloced_str; + + return return_value; } static OOPetrisRecordingReturnValue* @@ -54,12 +57,12 @@ construct_error_from_cstr(OOPetrisRecordingReturnValue* return_value, const char static OOPetrisRecordingReturnValue* construct_error_from_string(OOPetrisRecordingReturnValue* return_value, const std::string& value) { - return construct_error_from_cstr_impl(return_value, value, value.size()); + return construct_error_from_cstr_impl(return_value, value.c_str(), value.size()); } OOPetrisRecordingReturnValue* oopetris_get_recording_information(const char* file_path) { - OOPetrisRecordingReturnValue* return_value = malloc(sizeof(OOPetrisRecordingReturnValue)); + auto* return_value = static_cast(malloc(sizeof(OOPetrisRecordingReturnValue))); if (return_value == nullptr) { return nullptr; @@ -72,7 +75,7 @@ OOPetrisRecordingReturnValue* oopetris_get_recording_information(const char* fil if (not std::filesystem::exists(file_path)) { std::string error = "File '"; - error += filePath; + error += file_path; error += "' doesn't exist!"; return construct_error_from_string(return_value, error); @@ -82,7 +85,7 @@ OOPetrisRecordingReturnValue* oopetris_get_recording_information(const char* fil if (not parsed.has_value()) { std::string error = "An error occurred during parsing of the recording file '"; - error += filePath; + error += file_path; error += "': "; error += parsed.error(); @@ -121,25 +124,26 @@ void oopetris_free_recording_value_only(OOPetrisRecordingReturnValue** informati void oopetris_free_recording_value_whole(OOPetrisRecordingReturnValue** information) { if (oopetris_is_error(*information)) { - free(**information->value->error); + free((*information)->value.error); } else { - oopetris_free_recording_information(&(*information->value->information)); + oopetris_free_recording_information(&((*information)->value.information)); } oopetris_free_recording_value_only(information); } const char* oopetris_get_lib_version() { - // this is a string literal and in static (global) storage, so safe to return and don't create a memory leak - return utils::version().c_str(); + return utils::version(); } GridProperties* oopetris_get_grid_properties() { - GridProperties* properties = malloc(siezof(GridProperties)); + auto* properties = static_cast(malloc(sizeof(GridProperties))); if (properties == nullptr) { return nullptr; } properties->height = grid::height_in_tiles; properties->width = grid::width_in_tiles; + + return properties; } From b307ad46083cd32e7aaed6cb71ca68fcb0b762b9 Mon Sep 17 00:00:00 2001 From: Totto16 Date: Fri, 21 Jun 2024 01:27:03 +0200 Subject: [PATCH 03/11] Wrapper: C add tests --- wrapper/c/meson.build | 5 +++++ wrapper/c/meson.options | 6 ++++++ wrapper/c/subprojects/criterion.wrap | 8 ++++++++ wrapper/c/tests/files/correct.rec | Bin 0 -> 18189 bytes wrapper/c/tests/files/incorrect.rec | Bin 0 -> 50 bytes wrapper/c/tests/main.c | 24 ++++++++++++++++++++++++ wrapper/c/tests/meson.build | 24 ++++++++++++++++++++++++ 7 files changed, 67 insertions(+) create mode 100644 wrapper/c/meson.options create mode 100644 wrapper/c/subprojects/criterion.wrap create mode 100644 wrapper/c/tests/files/correct.rec create mode 100644 wrapper/c/tests/files/incorrect.rec create mode 100644 wrapper/c/tests/main.c create mode 100644 wrapper/c/tests/meson.build diff --git a/wrapper/c/meson.build b/wrapper/c/meson.build index e637560c..5707694d 100644 --- a/wrapper/c/meson.build +++ b/wrapper/c/meson.build @@ -52,3 +52,8 @@ pkg.generate( filebase: 'oopetris-c-wrapper', subdirs: 'oopetris' ) + + +if get_option('tests') + subdir('tests') +endif diff --git a/wrapper/c/meson.options b/wrapper/c/meson.options new file mode 100644 index 00000000..c16616f6 --- /dev/null +++ b/wrapper/c/meson.options @@ -0,0 +1,6 @@ +option( + 'tests', + type: 'boolean', + value: false, + description: 'whether or not tests should be built', +) diff --git a/wrapper/c/subprojects/criterion.wrap b/wrapper/c/subprojects/criterion.wrap new file mode 100644 index 00000000..947a4128 --- /dev/null +++ b/wrapper/c/subprojects/criterion.wrap @@ -0,0 +1,8 @@ +[wrap-git] +url = https://github.com/Snaipe/Criterion.git +revision = master +depth = 1 + + +[provide] +criterion = criterion diff --git a/wrapper/c/tests/files/correct.rec b/wrapper/c/tests/files/correct.rec new file mode 100644 index 0000000000000000000000000000000000000000..4d1a9cead3d4679bc936f50937eb5609e3fbe034 GIT binary patch literal 18189 zcmdU%3$#?#dB@LtX70T1%tfn~g@lDduc*WadW{mKYO>l`sL_IrO??1rLW-71>d6B43OB7?9`kRR|2{wSjEiT?y72rU za&OK`_&e>4i>H_S`reoh2hMQ*tZCDOI&jgs7o0tF`k(WeOQv6V)Xx_DUGiYE>cvAB zuNpCT{(roD&7~XndFkM1uKLk|M;^2C;HQro{kd;U*mv0*XJ2voiajHg7)n z@ufpo+`4$el^Z5r-y8gu>ws6>8!XHz2z!I8gyr5~u~~04>(|VBn_2G_rU&%Hk$UU? z@kK5c_o}qgN;@sL(@Ia;8+<1>23@_uL&92b@O@#_8$2bf^aei_;_)wpeC%x@&WB;n zIA0May+KP@?G5%6((Z7pu%D1F4inN?pOD7J3+ecHA&vcskS;!J)-#24F-<5@mda80 zk1ujb;9f;h(w-#aXeXsMO;1-NM0&0efzB7=vPYb|XkdrW^*5dW@kKS+w$@?X3gdQ| zw8ONG2L4k7^9A!`j`{IL^TQ*4%(c26rGZ!7dEtw?x5K5R6{W2x#9-BFo+(J>&1aCj&aMnUcP9g-fznUEM|K#vx>u2 zl&k1sTnmy~kk*2%Mka1F8HdR!#2qQDv)Tz6{>eh3oFZfmJYT3xoTj%f8ecT}LkO+X z%qrbknWIHObL166ahZ^H(Pcf^uh+3{jOeF5gh@3Lz>l7E<9RAtK&k z);rC*T8OldT7}1isQiT0ea7lOXB9S@^%b)Y(YBJ2-baX&V}$f}h>$M&%sSDmQ-wrv znvf{w3pF?+edi2_FFI(K7@V-0hP5=RrD2^p@D;hu=qwSU%r}K7^U%P!e3H7;gD*N{ zmy0W@XDLS`%iNaW`xfI`i}9xx<1<1=|9K&!zgegey|gf*zG&Po9eG+!(pr*n)LHl6 zP&kZqnC54&^WnUrrI!Z{sjuRr$ zF+wEzxYeC#btefW+@}h{`JxHCv2bZumR7TbqsF=P(+U>lPBk^o79!UyA#%+XqUSuJ zG+HW++!XXhojx<<7X-GNRt>%eL}XLGNk~benp^2h^^ip^u19(Ll&W#L8s`~=3Te%$ zKmziup6~WSoq(@YXee@vkX%|Sq{7#QC~~_HMV4EIl~&;aAuV{Mh1K@4?^@k;LTS3D zps6qF^tol{Xc|_dh@%!ob#(Z-!bIO!g;;+hM9ESqpIr#mC8R=4i0Z?I66%G5P`;?s z3;)g+DyXDER~mMuL6vR&2!)J1qlD;pu#hvuI3bJSL?Qb9z7Wy=OeoQ2`jaPG`=UT$Uqv&#?bE>DO$;OtOKgL=vZtjsO=XD9?BpCu$QE*2uq0wH=_ zEkuuNg^K*9Lgc=v)BFC;MjqFbgrnwm|GmKt3I`SLw0Iw|cpny`&ErC}`H5M7X4aR4 z(#G%FoJ788r?2DNl@vaXm_KC8y8@?79jXz28s#r~GX9_ii-^Q0_fp8T#^_Z1@K zN36nVA)0jr$+u4lY4;?dn}1e!y49U+);VUqOsG*=SIAgjwA0T79T}CR8m1gw zVOl|*1qzc9T4XwWRY--Kg@}5Kkg-@IMAW;5jKyjpAA8g){6xqIJu9TK4MOSrT0vi5 zw9`)@9oILkW)Vj%i`_o&MTP8UgAk?O5+Y?%$)~cST8IzF3(<12)t%z&9?WlG?F~Z2dRd5AuLuz<(DNl&*|zt;uyzZ{n_)t7cRwMyJ66byKSIciA8&O}5Yp}> zA?;2TBDcGNG14y~urC^&JF(rFSG>i(CEB zhIhze;=D&loNI)P;SYq2;lBxyXPuB1o)wY>FA34)4I!GmBc!p!Jsii2#>zr^s|#s& zsE`)=gtXvMs?IB@>Wg;tY|yFXDXLnoCFOcj;c$2T$14sLK2eAgpBAFT6d_8?5Te8a zAxc~=M2YK#QsSr$!dW-A$$KSxq&CJ`d`>*yXf#a;IR+c>#R>U>Oyw#NyH_C%|2x>?UP>xDwU zb`=8mMLT-k>9^)qM*kzXdnI$ucs{Ed(yUo1qLzZEk2Hw%&R zTS8h`A>?EC2x;toAs_pJP};4Rc5dbKMPoXdGy~GbCkpw&(?%{onr@QinUPDAZyC~N znl;l>lbym^IgC=9gar4xMZ|-V{V(LH3DM+_go^WIZ71BM^F{j)R-E}+nh44F0b8JE z7;|*v|H*QXsAdWoz1c#B>`OxG&KELzYlN&6PY78lUbMO|Tis1U+WjA^@UD<9oSW`N zyCosL)yz6n=vE*h%JvF<21!{rAiik0YnIoRXR?crA8&aSm?v%rOt+SM-Y)-Y!X~HO zo#0@;jn0!O>2})jEuZIfOB^ly8Y^eeae{e!ig`Ojhzb`734M-GF_d-UcQN>)k^K=2 zehkI5=S#XABcA!@`B#Jt&tf4#+$d!HmRQ}}t?r#xVTD=mGwZ`b8hb=2MUE~g;)}Ly zd;OF4gEXo|MJkQ7(oDA1Uypra;v*Y zNQ^hw$8Ho7?#)74SY>q|u?mj~Y4=$nK0GgEJ=`c{J$yw-Z?6gI;%y-<)Y^Fx(83-< z>JAkW&M+O%oE? zc|yXu#H?R3>jI%7TUm(A7j4^m_`xH~y5mxJoVDVTyFzu993#rbLaet68L58|GCa$L z#D15M*jEaPeT`Y4H0wIEZZPYAn)ScT`fDLRyeFi$tS29JtTmy_ETPLRAwG<>x?`;F zVM50B7$JFliq$>M>Ygqn_;Z8=Kg+Ba3vuT!til(Ccy_7Poo^MsDpU^mZ!K=c@kQHq z2Iy=Kr1dD{Xhc~PC6~xa^5HfiVcso7l6!=N>5&Te%ZgB|t?r{{{gHjlqjVUeou<>l z7j4-g55me@oaM#2P}G5qu{$O5*PRvD%Xc){EJUea3(2{+g~$`=M@R@!6CzJrh-gEF zv@k+Q3!{Y6#D7_Hn)srz`5btkJ>THvMo|-dx|gvjF_`unm@ zsm|()q*%Z&G4uUl{tK|Qo#{t*?Fa#qb{4m@pdEzmDB|eB(@km|1xkD5A`@$mkXSw9 z|K76V|Nd6@P$3l#w~zH%-N{1Knj%E4vxM~a*Ft*ps92vW#OjOW@OH;q>PgBR?WE#< zjk!pD68A0U$?fLJau!G75hvWE4&{>se-BpRfxag@8p>){Z|$A z_eC;ohyGzZjN0xuv~drfmDL4f(GU{x-a;Zia-a`y7JTqUa(D-Q;1*)cjl@Qgy6OXfEe`(LTBE9f*i459L-;;c&C_ zoALs+zb!=V`-OP?pb(Fr6w1vP<0BIN3bTQf=I zwd#n$ep-lsuM2VN9U)G=E5z$mzw6~=ZJ}KCXB1c07x{If)RX3(L_Klb6XOhvSEVPx znUMegKo2LhAZZ6l4=1#})hyoZFJ#mY6f)|^4ea+R>EZhIMSgy4d%sCD + +#include + +Test(IsRecordingFile, NullptrAsArgument) { + bool is_recordings_file = oopetris_is_recording_file(NULL); + cr_assert(!is_recordings_file, "NULL is supported and doesn't crash"); +} + + +Test(IsRecordingFile, NonExistentFile) { + bool is_recordings_file = oopetris_is_recording_file("./NON_EXISTENT_FILE"); + cr_assert(!is_recordings_file, "Non existent recordings file is detected correctly"); +} + +Test(IsRecordingFile, IncorrectFile) { + bool is_recordings_file = oopetris_is_recording_file("./incorrect.rec"); + cr_assert(!is_recordings_file, "Incorrect recordings file is detected correctly"); +} + +Test(IsRecordingFile, CorrectFile) { + bool is_recordings_file = oopetris_is_recording_file("./correct.rec"); + cr_assert(is_recordings_file, "Correct recordings file is detected correctly"); +} diff --git a/wrapper/c/tests/meson.build b/wrapper/c/tests/meson.build new file mode 100644 index 00000000..d7a5724f --- /dev/null +++ b/wrapper/c/tests/meson.build @@ -0,0 +1,24 @@ +test_deps = [] + +test_src = [files('main.c')] + +test_deps += dependency('criterion') + +tests = executable( + 'tests', + test_src, + dependencies: [test_deps, liboopetris_c_wrapper_dep], + override_options: { + 'warning_level': '3', + 'werror': true, + 'b_coverage': false, + }, +) + +test( + 'tests', + tests, + protocol: 'tap', + workdir: meson.project_source_root() / 'tests' / 'files', + args: ['--tap'], +) From b8e5ff9fdfbbf689ffc4d0d00468d5515d8d2a90 Mon Sep 17 00:00:00 2001 From: Totto16 Date: Fri, 21 Jun 2024 01:49:38 +0200 Subject: [PATCH 04/11] wrapper: c, add more tests --- wrapper/c/meson.build | 3 +- wrapper/c/src/oopetris_wrapper.h | 6 ++-- wrapper/c/src/wrapper.cpp | 10 +++++-- wrapper/c/tests/information.c | 28 +++++++++++++++++++ .../c/tests/{main.c => is_recording_file.c} | 0 wrapper/c/tests/meson.build | 11 ++++++-- 6 files changed, 48 insertions(+), 10 deletions(-) create mode 100644 wrapper/c/tests/information.c rename wrapper/c/tests/{main.c => is_recording_file.c} (100%) diff --git a/wrapper/c/meson.build b/wrapper/c/meson.build index 5707694d..591bdccf 100644 --- a/wrapper/c/meson.build +++ b/wrapper/c/meson.build @@ -50,10 +50,9 @@ pkg.generate( description: 'The C Wrapper library for oopetris', name: 'oopetris-c-wrapper', filebase: 'oopetris-c-wrapper', - subdirs: 'oopetris' + subdirs: 'oopetris', ) - if get_option('tests') subdir('tests') endif diff --git a/wrapper/c/src/oopetris_wrapper.h b/wrapper/c/src/oopetris_wrapper.h index 68bf8923..a957033c 100644 --- a/wrapper/c/src/oopetris_wrapper.h +++ b/wrapper/c/src/oopetris_wrapper.h @@ -60,11 +60,11 @@ const char* oopetris_get_lib_version(); typedef struct { uint32_t height; uint32_t width; -} GridProperties; +} OOPetrisGridProperties; -GridProperties* oopetris_get_grid_properties(); +OOPetrisGridProperties* oopetris_get_grid_properties(); -void oopetris_free_grid_properties(GridProperties** properties); +void oopetris_free_grid_properties(OOPetrisGridProperties** properties); #ifdef __cplusplus diff --git a/wrapper/c/src/wrapper.cpp b/wrapper/c/src/wrapper.cpp index 53b44be6..e3fa2f9b 100644 --- a/wrapper/c/src/wrapper.cpp +++ b/wrapper/c/src/wrapper.cpp @@ -136,8 +136,8 @@ const char* oopetris_get_lib_version() { return utils::version(); } -GridProperties* oopetris_get_grid_properties() { - auto* properties = static_cast(malloc(sizeof(GridProperties))); +OOPetrisGridProperties* oopetris_get_grid_properties() { + auto* properties = static_cast(malloc(sizeof(OOPetrisGridProperties))); if (properties == nullptr) { return nullptr; } @@ -147,3 +147,9 @@ GridProperties* oopetris_get_grid_properties() { return properties; } + + +void oopetris_free_grid_properties(OOPetrisGridProperties** properties) { + free(*properties); + *properties = nullptr; +} diff --git a/wrapper/c/tests/information.c b/wrapper/c/tests/information.c new file mode 100644 index 00000000..d7820b87 --- /dev/null +++ b/wrapper/c/tests/information.c @@ -0,0 +1,28 @@ +#include +#include +#include + +#include + +// this tests likely fail, if we update the lib, but this failure on version bump serves as remainder,to check, if other things need changing too, since wrapper may become outdated otherwise + +Test(Information, LibVersion) { + const char* lib_version = oopetris_get_lib_version(); + char* dynamic_lib_version = malloc(strlen(lib_version) + 1); + + strcpy(dynamic_lib_version, lib_version); + + cr_assert(eq(str, dynamic_lib_version, "0.5.6")); + free(dynamic_lib_version); +} + + +Test(Information, GridProperties) { + OOPetrisGridProperties* properties = oopetris_get_grid_properties(); + cr_assert(properties != NULL, "returned properties are non-NULL"); + cr_assert(eq(u32, properties->height, 20)); + cr_assert(eq(u32, properties->width, 10)); + + oopetris_free_grid_properties(&properties); + cr_assert(properties == NULL, "properties are freed correctly"); +} diff --git a/wrapper/c/tests/main.c b/wrapper/c/tests/is_recording_file.c similarity index 100% rename from wrapper/c/tests/main.c rename to wrapper/c/tests/is_recording_file.c diff --git a/wrapper/c/tests/meson.build b/wrapper/c/tests/meson.build index d7a5724f..bc40127b 100644 --- a/wrapper/c/tests/meson.build +++ b/wrapper/c/tests/meson.build @@ -1,6 +1,11 @@ test_deps = [] -test_src = [files('main.c')] +test_src = [ + files( + 'information.c', + 'is_recording_file.c', + ), +] test_deps += dependency('criterion') @@ -18,7 +23,7 @@ tests = executable( test( 'tests', tests, - protocol: 'tap', + protocol: 'tap', ## use 'exitcode' to get better messages, of what exactly the failure was workdir: meson.project_source_root() / 'tests' / 'files', - args: ['--tap'], + args: ['--tap'], ## remove '--tap' and add '--verbose', '--full-stats' to get better failure messages ) From 78c17c1a7f8f339bb717848abcefb64e74503bf0 Mon Sep 17 00:00:00 2001 From: Totto16 Date: Fri, 21 Jun 2024 04:02:43 +0200 Subject: [PATCH 05/11] Wrapper: C, add conversion functions from C++ to C types --- src/libs/core/helper/input_event.hpp | 2 +- wrapper/c/src/oopetris_wrapper.h | 88 +- wrapper/c/src/thirdparty/stb_ds.h | 1895 ++++++++++++++++++++++++++ wrapper/c/src/wrapper.cpp | 366 ++++- 4 files changed, 2343 insertions(+), 8 deletions(-) create mode 100644 wrapper/c/src/thirdparty/stb_ds.h diff --git a/src/libs/core/helper/input_event.hpp b/src/libs/core/helper/input_event.hpp index a0fb4642..79c30f5b 100644 --- a/src/libs/core/helper/input_event.hpp +++ b/src/libs/core/helper/input_event.hpp @@ -3,7 +3,7 @@ #include "./types.hpp" enum class InputEvent : u8 { - RotateLeftPressed, + RotateLeftPressed = 0, RotateRightPressed, MoveLeftPressed, MoveRightPressed, diff --git a/wrapper/c/src/oopetris_wrapper.h b/wrapper/c/src/oopetris_wrapper.h index a957033c..78eaf8e5 100644 --- a/wrapper/c/src/oopetris_wrapper.h +++ b/wrapper/c/src/oopetris_wrapper.h @@ -2,6 +2,9 @@ #pragma once +#define STBDS_NO_SHORT_NAMES +#include "./thirdparty/stb_ds.h" + #ifdef __cplusplus extern "C" { @@ -11,17 +14,94 @@ extern "C" { #include /** - * @brief this determines if a file (may be nonexistent) is a recording file, it is not guaranteed, tat a consecutive call to oopetris_get_recording_information never fails, if rthis returns true, but it's highly unliekely, and this is faster, as it doesn't do as much work + * @brief this determines if a file (may be nonexistent) is a recording file, it is not guaranteed, tat a consecutive call to oopetris_get_recording_information never fails, if this returns true, but it's highly unliekely, and this is faster, as it doesn't do as much work * * @param file_path The FilePath of the potential recording file * @return bool */ bool oopetris_is_recording_file(const char* file_path); -// non opaque type, fields can be safely accessed, excpet the are opaque structs again +// opaque type +typedef struct OOPetrisAdditionalInformationImpl OOPetrisAdditionalInformation; + + +const char** oopetris_additional_information_get_keys(OOPetrisAdditionalInformation* information); + + +void oopetris_additional_information_keys_free(const char*** keys); + +//TODO: make functions to introspect this + + +typedef enum : uint8_t { + OOPetrisInputEvent_RotateLeftPressed = 0, + OOPetrisInputEvent_RotateRightPressed, + OOPetrisInputEvent_MoveLeftPressed, + OOPetrisInputEvent_MoveRightPressed, + OOPetrisInputEvent_MoveDownPressed, + OOPetrisInputEvent_DropPressed, + OOPetrisInputEvent_HoldPressed, + OOPetrisInputEvent_RotateLeftReleased, + OOPetrisInputEvent_RotateRightReleased, + OOPetrisInputEvent_MoveLeftReleased, + OOPetrisInputEvent_MoveRightReleased, + OOPetrisInputEvent_MoveDownReleased, + OOPetrisInputEvent_DropReleased, + OOPetrisInputEvent_HoldReleased, +} OOPetrisInputEvent; + +typedef struct { + uint64_t simulation_step_index; + OOPetrisInputEvent event; + uint8_t tetrion_index; +} OOPetrisTetrionRecord; + +typedef struct { + uint8_t x; + uint8_t y; +} OOpetrisMinoPosition; + +typedef enum : uint8_t { + OOPetrisTetrominoType_I = 0, + OOPetrisTetrominoType_J, + OOPetrisTetrominoType_L, + OOPetrisTetrominoType_O, + OOPetrisTetrominoType_S, + OOPetrisTetrominoType_T, + OOPetrisTetrominoType_Z, +} OOPetrisTetrominoType; + +typedef struct { + OOpetrisMinoPosition position; + OOPetrisTetrominoType type; +} OOPetrisMino; + +typedef struct { + uint32_t level; + OOPetrisMino* mino_stack; + uint64_t score; + uint64_t simulation_step_index; + uint32_t lines_cleared; + uint8_t tetrion_index; +} OOpetrisTetrionSnapshot; + +typedef struct { + uint64_t seed; + uint32_t starting_level; +} OOPetrisTetrionHeader; + + +/** + * @brief non opaque type, fields can be safely accessed, except they are opaque structs again + * The values that are pointers are dynamic array, as defined by stb_ds.h, see tests for usage example, an exception is the opaque type OOPetrisAdditionalInformation, you have to use some helper functions, to get access to it, it is a object / dict with dynamic types + * + */ typedef struct { - bool i; //TODO - int z; + OOPetrisAdditionalInformation* information; //NOT AN ARRAY + OOPetrisTetrionRecord* records; + OOpetrisTetrionSnapshot* snapshots; + OOPetrisTetrionHeader* tetrion_headers; + uint32_t version; } OOPetrisRecordingInformation; diff --git a/wrapper/c/src/thirdparty/stb_ds.h b/wrapper/c/src/thirdparty/stb_ds.h new file mode 100644 index 00000000..e84c82d1 --- /dev/null +++ b/wrapper/c/src/thirdparty/stb_ds.h @@ -0,0 +1,1895 @@ +/* stb_ds.h - v0.67 - public domain data structures - Sean Barrett 2019 + + This is a single-header-file library that provides easy-to-use + dynamic arrays and hash tables for C (also works in C++). + + For a gentle introduction: + http://nothings.org/stb_ds + + To use this library, do this in *one* C or C++ file: + #define STB_DS_IMPLEMENTATION + #include "stb_ds.h" + +TABLE OF CONTENTS + + Table of Contents + Compile-time options + License + Documentation + Notes + Notes - Dynamic arrays + Notes - Hash maps + Credits + +COMPILE-TIME OPTIONS + + #define STBDS_NO_SHORT_NAMES + + This flag needs to be set globally. + + By default stb_ds exposes shorter function names that are not qualified + with the "stbds_" prefix. If these names conflict with the names in your + code, define this flag. + + #define STBDS_SIPHASH_2_4 + + This flag only needs to be set in the file containing #define STB_DS_IMPLEMENTATION. + + By default stb_ds.h hashes using a weaker variant of SipHash and a custom hash for + 4- and 8-byte keys. On 64-bit platforms, you can define the above flag to force + stb_ds.h to use specification-compliant SipHash-2-4 for all keys. Doing so makes + hash table insertion about 20% slower on 4- and 8-byte keys, 5% slower on + 64-byte keys, and 10% slower on 256-byte keys on my test computer. + + #define STBDS_REALLOC(context,ptr,size) better_realloc + #define STBDS_FREE(context,ptr) better_free + + These defines only need to be set in the file containing #define STB_DS_IMPLEMENTATION. + + By default stb_ds uses stdlib realloc() and free() for memory management. You can + substitute your own functions instead by defining these symbols. You must either + define both, or neither. Note that at the moment, 'context' will always be NULL. + @TODO add an array/hash initialization function that takes a memory context pointer. + + #define STBDS_UNIT_TESTS + + Defines a function stbds_unit_tests() that checks the functioning of the data structures. + + Note that on older versions of gcc (e.g. 5.x.x) you may need to build with '-std=c++0x' + (or equivalentally '-std=c++11') when using anonymous structures as seen on the web + page or in STBDS_UNIT_TESTS. + +LICENSE + + Placed in the public domain and also MIT licensed. + See end of file for detailed license information. + +DOCUMENTATION + + Dynamic Arrays + + Non-function interface: + + Declare an empty dynamic array of type T + T* foo = NULL; + + Access the i'th item of a dynamic array 'foo' of type T, T* foo: + foo[i] + + Functions (actually macros) + + arrfree: + void arrfree(T*); + Frees the array. + + arrlen: + ptrdiff_t arrlen(T*); + Returns the number of elements in the array. + + arrlenu: + size_t arrlenu(T*); + Returns the number of elements in the array as an unsigned type. + + arrpop: + T arrpop(T* a) + Removes the final element of the array and returns it. + + arrput: + T arrput(T* a, T b); + Appends the item b to the end of array a. Returns b. + + arrins: + T arrins(T* a, int p, T b); + Inserts the item b into the middle of array a, into a[p], + moving the rest of the array over. Returns b. + + arrinsn: + void arrinsn(T* a, int p, int n); + Inserts n uninitialized items into array a starting at a[p], + moving the rest of the array over. + + arraddnptr: + T* arraddnptr(T* a, int n) + Appends n uninitialized items onto array at the end. + Returns a pointer to the first uninitialized item added. + + arraddnindex: + size_t arraddnindex(T* a, int n) + Appends n uninitialized items onto array at the end. + Returns the index of the first uninitialized item added. + + arrdel: + void arrdel(T* a, int p); + Deletes the element at a[p], moving the rest of the array over. + + arrdeln: + void arrdeln(T* a, int p, int n); + Deletes n elements starting at a[p], moving the rest of the array over. + + arrdelswap: + void arrdelswap(T* a, int p); + Deletes the element at a[p], replacing it with the element from + the end of the array. O(1) performance. + + arrsetlen: + void arrsetlen(T* a, int n); + Changes the length of the array to n. Allocates uninitialized + slots at the end if necessary. + + arrsetcap: + size_t arrsetcap(T* a, int n); + Sets the length of allocated storage to at least n. It will not + change the length of the array. + + arrcap: + size_t arrcap(T* a); + Returns the number of total elements the array can contain without + needing to be reallocated. + + Hash maps & String hash maps + + Given T is a structure type: struct { TK key; TV value; }. Note that some + functions do not require TV value and can have other fields. For string + hash maps, TK must be 'char *'. + + Special interface: + + stbds_rand_seed: + void stbds_rand_seed(size_t seed); + For security against adversarially chosen data, you should seed the + library with a strong random number. Or at least seed it with time(). + + stbds_hash_string: + size_t stbds_hash_string(char *str, size_t seed); + Returns a hash value for a string. + + stbds_hash_bytes: + size_t stbds_hash_bytes(void *p, size_t len, size_t seed); + These functions hash an arbitrary number of bytes. The function + uses a custom hash for 4- and 8-byte data, and a weakened version + of SipHash for everything else. On 64-bit platforms you can get + specification-compliant SipHash-2-4 on all data by defining + STBDS_SIPHASH_2_4, at a significant cost in speed. + + Non-function interface: + + Declare an empty hash map of type T + T* foo = NULL; + + Access the i'th entry in a hash table T* foo: + foo[i] + + Function interface (actually macros): + + hmfree + shfree + void hmfree(T*); + void shfree(T*); + Frees the hashmap and sets the pointer to NULL. + + hmlen + shlen + ptrdiff_t hmlen(T*) + ptrdiff_t shlen(T*) + Returns the number of elements in the hashmap. + + hmlenu + shlenu + size_t hmlenu(T*) + size_t shlenu(T*) + Returns the number of elements in the hashmap. + + hmgeti + shgeti + hmgeti_ts + ptrdiff_t hmgeti(T*, TK key) + ptrdiff_t shgeti(T*, char* key) + ptrdiff_t hmgeti_ts(T*, TK key, ptrdiff_t tempvar) + Returns the index in the hashmap which has the key 'key', or -1 + if the key is not present. + + hmget + hmget_ts + shget + TV hmget(T*, TK key) + TV shget(T*, char* key) + TV hmget_ts(T*, TK key, ptrdiff_t tempvar) + Returns the value corresponding to 'key' in the hashmap. + The structure must have a 'value' field + + hmgets + shgets + T hmgets(T*, TK key) + T shgets(T*, char* key) + Returns the structure corresponding to 'key' in the hashmap. + + hmgetp + shgetp + hmgetp_ts + hmgetp_null + shgetp_null + T* hmgetp(T*, TK key) + T* shgetp(T*, char* key) + T* hmgetp_ts(T*, TK key, ptrdiff_t tempvar) + T* hmgetp_null(T*, TK key) + T* shgetp_null(T*, char *key) + Returns a pointer to the structure corresponding to 'key' in + the hashmap. Functions ending in "_null" return NULL if the key + is not present in the hashmap; the others return a pointer to a + structure holding the default value (but not the searched-for key). + + hmdefault + shdefault + TV hmdefault(T*, TV value) + TV shdefault(T*, TV value) + Sets the default value for the hashmap, the value which will be + returned by hmget/shget if the key is not present. + + hmdefaults + shdefaults + TV hmdefaults(T*, T item) + TV shdefaults(T*, T item) + Sets the default struct for the hashmap, the contents which will be + returned by hmgets/shgets if the key is not present. + + hmput + shput + TV hmput(T*, TK key, TV value) + TV shput(T*, char* key, TV value) + Inserts a pair into the hashmap. If the key is already + present in the hashmap, updates its value. + + hmputs + shputs + T hmputs(T*, T item) + T shputs(T*, T item) + Inserts a struct with T.key into the hashmap. If the struct is already + present in the hashmap, updates it. + + hmdel + shdel + int hmdel(T*, TK key) + int shdel(T*, char* key) + If 'key' is in the hashmap, deletes its entry and returns 1. + Otherwise returns 0. + + Function interface (actually macros) for strings only: + + sh_new_strdup + void sh_new_strdup(T*); + Overwrites the existing pointer with a newly allocated + string hashmap which will automatically allocate and free + each string key using realloc/free + + sh_new_arena + void sh_new_arena(T*); + Overwrites the existing pointer with a newly allocated + string hashmap which will automatically allocate each string + key to a string arena. Every string key ever used by this + hash table remains in the arena until the arena is freed. + Additionally, any key which is deleted and reinserted will + be allocated multiple times in the string arena. + +NOTES + + * These data structures are realloc'd when they grow, and the macro + "functions" write to the provided pointer. This means: (a) the pointer + must be an lvalue, and (b) the pointer to the data structure is not + stable, and you must maintain it the same as you would a realloc'd + pointer. For example, if you pass a pointer to a dynamic array to a + function which updates it, the function must return back the new + pointer to the caller. This is the price of trying to do this in C. + + * The following are the only functions that are thread-safe on a single data + structure, i.e. can be run in multiple threads simultaneously on the same + data structure + hmlen shlen + hmlenu shlenu + hmget_ts shget_ts + hmgeti_ts shgeti_ts + hmgets_ts shgets_ts + + * You iterate over the contents of a dynamic array and a hashmap in exactly + the same way, using arrlen/hmlen/shlen: + + for (i=0; i < arrlen(foo); ++i) + ... foo[i] ... + + * All operations except arrins/arrdel are O(1) amortized, but individual + operations can be slow, so these data structures may not be suitable + for real time use. Dynamic arrays double in capacity as needed, so + elements are copied an average of once. Hash tables double/halve + their size as needed, with appropriate hysteresis to maintain O(1) + performance. + +NOTES - DYNAMIC ARRAY + + * If you know how long a dynamic array is going to be in advance, you can avoid + extra memory allocations by using arrsetlen to allocate it to that length in + advance and use foo[n] while filling it out, or arrsetcap to allocate the memory + for that length and use arrput/arrpush as normal. + + * Unlike some other versions of the dynamic array, this version should + be safe to use with strict-aliasing optimizations. + +NOTES - HASH MAP + + * For compilers other than GCC and clang (e.g. Visual Studio), for hmput/hmget/hmdel + and variants, the key must be an lvalue (so the macro can take the address of it). + Extensions are used that eliminate this requirement if you're using C99 and later + in GCC or clang, or if you're using C++ in GCC. But note that this can make your + code less portable. + + * To test for presence of a key in a hashmap, just do 'hmgeti(foo,key) >= 0'. + + * The iteration order of your data in the hashmap is determined solely by the + order of insertions and deletions. In particular, if you never delete, new + keys are always added at the end of the array. This will be consistent + across all platforms and versions of the library. However, you should not + attempt to serialize the internal hash table, as the hash is not consistent + between different platforms, and may change with future versions of the library. + + * Use sh_new_arena() for string hashmaps that you never delete from. Initialize + with NULL if you're managing the memory for your strings, or your strings are + never freed (at least until the hashmap is freed). Otherwise, use sh_new_strdup(). + @TODO: make an arena variant that garbage collects the strings with a trivial + copy collector into a new arena whenever the table shrinks / rebuilds. Since + current arena recommendation is to only use arena if it never deletes, then + this can just replace current arena implementation. + + * If adversarial input is a serious concern and you're on a 64-bit platform, + enable STBDS_SIPHASH_2_4 (see the 'Compile-time options' section), and pass + a strong random number to stbds_rand_seed. + + * The default value for the hash table is stored in foo[-1], so if you + use code like 'hmget(T,k)->value = 5' you can accidentally overwrite + the value stored by hmdefault if 'k' is not present. + +CREDITS + + Sean Barrett -- library, idea for dynamic array API/implementation + Per Vognsen -- idea for hash table API/implementation + Rafael Sachetto -- arrpop() + github:HeroicKatora -- arraddn() reworking + + Bugfixes: + Andy Durdin + Shane Liesegang + Vinh Truong + Andreas Molzer + github:hashitaku + github:srdjanstipic + Macoy Madson + Andreas Vennstrom + Tobias Mansfield-Williams +*/ + +#ifdef STBDS_UNIT_TESTS +#define _CRT_SECURE_NO_WARNINGS +#endif + +#ifndef INCLUDE_STB_DS_H +#define INCLUDE_STB_DS_H + +#include +#include + +#ifndef STBDS_NO_SHORT_NAMES +#define arrlen stbds_arrlen +#define arrlenu stbds_arrlenu +#define arrput stbds_arrput +#define arrpush stbds_arrput +#define arrpop stbds_arrpop +#define arrfree stbds_arrfree +#define arraddn stbds_arraddn // deprecated, use one of the following instead: +#define arraddnptr stbds_arraddnptr +#define arraddnindex stbds_arraddnindex +#define arrsetlen stbds_arrsetlen +#define arrlast stbds_arrlast +#define arrins stbds_arrins +#define arrinsn stbds_arrinsn +#define arrdel stbds_arrdel +#define arrdeln stbds_arrdeln +#define arrdelswap stbds_arrdelswap +#define arrcap stbds_arrcap +#define arrsetcap stbds_arrsetcap + +#define hmput stbds_hmput +#define hmputs stbds_hmputs +#define hmget stbds_hmget +#define hmget_ts stbds_hmget_ts +#define hmgets stbds_hmgets +#define hmgetp stbds_hmgetp +#define hmgetp_ts stbds_hmgetp_ts +#define hmgetp_null stbds_hmgetp_null +#define hmgeti stbds_hmgeti +#define hmgeti_ts stbds_hmgeti_ts +#define hmdel stbds_hmdel +#define hmlen stbds_hmlen +#define hmlenu stbds_hmlenu +#define hmfree stbds_hmfree +#define hmdefault stbds_hmdefault +#define hmdefaults stbds_hmdefaults + +#define shput stbds_shput +#define shputi stbds_shputi +#define shputs stbds_shputs +#define shget stbds_shget +#define shgeti stbds_shgeti +#define shgets stbds_shgets +#define shgetp stbds_shgetp +#define shgetp_null stbds_shgetp_null +#define shdel stbds_shdel +#define shlen stbds_shlen +#define shlenu stbds_shlenu +#define shfree stbds_shfree +#define shdefault stbds_shdefault +#define shdefaults stbds_shdefaults +#define sh_new_arena stbds_sh_new_arena +#define sh_new_strdup stbds_sh_new_strdup + +#define stralloc stbds_stralloc +#define strreset stbds_strreset +#endif + +#if defined(STBDS_REALLOC) && !defined(STBDS_FREE) || !defined(STBDS_REALLOC) && defined(STBDS_FREE) +#error "You must define both STBDS_REALLOC and STBDS_FREE, or neither." +#endif +#if !defined(STBDS_REALLOC) && !defined(STBDS_FREE) +#include +#define STBDS_REALLOC(c,p,s) realloc(p,s) +#define STBDS_FREE(c,p) free(p) +#endif + +#ifdef _MSC_VER +#define STBDS_NOTUSED(v) (void)(v) +#else +#define STBDS_NOTUSED(v) (void)sizeof(v) +#endif + +#ifdef __cplusplus +extern "C" { +#endif + +// for security against attackers, seed the library with a random number, at least time() but stronger is better +extern void stbds_rand_seed(size_t seed); + +// these are the hash functions used internally if you want to test them or use them for other purposes +extern size_t stbds_hash_bytes(void *p, size_t len, size_t seed); +extern size_t stbds_hash_string(char *str, size_t seed); + +// this is a simple string arena allocator, initialize with e.g. 'stbds_string_arena my_arena={0}'. +typedef struct stbds_string_arena stbds_string_arena; +extern char * stbds_stralloc(stbds_string_arena *a, char *str); +extern void stbds_strreset(stbds_string_arena *a); + +// have to #define STBDS_UNIT_TESTS to call this +extern void stbds_unit_tests(void); + +/////////////// +// +// Everything below here is implementation details +// + +extern void * stbds_arrgrowf(void *a, size_t elemsize, size_t addlen, size_t min_cap); +extern void stbds_arrfreef(void *a); +extern void stbds_hmfree_func(void *p, size_t elemsize); +extern void * stbds_hmget_key(void *a, size_t elemsize, void *key, size_t keysize, int mode); +extern void * stbds_hmget_key_ts(void *a, size_t elemsize, void *key, size_t keysize, ptrdiff_t *temp, int mode); +extern void * stbds_hmput_default(void *a, size_t elemsize); +extern void * stbds_hmput_key(void *a, size_t elemsize, void *key, size_t keysize, int mode); +extern void * stbds_hmdel_key(void *a, size_t elemsize, void *key, size_t keysize, size_t keyoffset, int mode); +extern void * stbds_shmode_func(size_t elemsize, int mode); + +#ifdef __cplusplus +} +#endif + +#if defined(__GNUC__) || defined(__clang__) +#define STBDS_HAS_TYPEOF +#ifdef __cplusplus +//#define STBDS_HAS_LITERAL_ARRAY // this is currently broken for clang +#endif +#endif + +#if !defined(__cplusplus) +#if defined(__STDC_VERSION__) && __STDC_VERSION__ >= 199901L +#define STBDS_HAS_LITERAL_ARRAY +#endif +#endif + +// this macro takes the address of the argument, but on gcc/clang can accept rvalues +#if defined(STBDS_HAS_LITERAL_ARRAY) && defined(STBDS_HAS_TYPEOF) + #if __clang__ + #define STBDS_ADDRESSOF(typevar, value) ((__typeof__(typevar)[1]){value}) // literal array decays to pointer to value + #else + #define STBDS_ADDRESSOF(typevar, value) ((typeof(typevar)[1]){value}) // literal array decays to pointer to value + #endif +#else +#define STBDS_ADDRESSOF(typevar, value) &(value) +#endif + +#define STBDS_OFFSETOF(var,field) ((char *) &(var)->field - (char *) (var)) + +#define stbds_header(t) ((stbds_array_header *) (t) - 1) +#define stbds_temp(t) stbds_header(t)->temp +#define stbds_temp_key(t) (*(char **) stbds_header(t)->hash_table) + +#define stbds_arrsetcap(a,n) (stbds_arrgrow(a,0,n)) +#define stbds_arrsetlen(a,n) ((stbds_arrcap(a) < (size_t) (n) ? stbds_arrsetcap((a),(size_t)(n)),0 : 0), (a) ? stbds_header(a)->length = (size_t) (n) : 0) +#define stbds_arrcap(a) ((a) ? stbds_header(a)->capacity : 0) +#define stbds_arrlen(a) ((a) ? (ptrdiff_t) stbds_header(a)->length : 0) +#define stbds_arrlenu(a) ((a) ? stbds_header(a)->length : 0) +#define stbds_arrput(a,v) (stbds_arrmaybegrow(a,1), (a)[stbds_header(a)->length++] = (v)) +#define stbds_arrpush stbds_arrput // synonym +#define stbds_arrpop(a) (stbds_header(a)->length--, (a)[stbds_header(a)->length]) +#define stbds_arraddn(a,n) ((void)(stbds_arraddnindex(a, n))) // deprecated, use one of the following instead: +#define stbds_arraddnptr(a,n) (stbds_arrmaybegrow(a,n), (n) ? (stbds_header(a)->length += (n), &(a)[stbds_header(a)->length-(n)]) : (a)) +#define stbds_arraddnindex(a,n)(stbds_arrmaybegrow(a,n), (n) ? (stbds_header(a)->length += (n), stbds_header(a)->length-(n)) : stbds_arrlen(a)) +#define stbds_arraddnoff stbds_arraddnindex +#define stbds_arrlast(a) ((a)[stbds_header(a)->length-1]) +#define stbds_arrfree(a) ((void) ((a) ? STBDS_FREE(NULL,stbds_header(a)) : (void)0), (a)=NULL) +#define stbds_arrdel(a,i) stbds_arrdeln(a,i,1) +#define stbds_arrdeln(a,i,n) (memmove(&(a)[i], &(a)[(i)+(n)], sizeof *(a) * (stbds_header(a)->length-(n)-(i))), stbds_header(a)->length -= (n)) +#define stbds_arrdelswap(a,i) ((a)[i] = stbds_arrlast(a), stbds_header(a)->length -= 1) +#define stbds_arrinsn(a,i,n) (stbds_arraddn((a),(n)), memmove(&(a)[(i)+(n)], &(a)[i], sizeof *(a) * (stbds_header(a)->length-(n)-(i)))) +#define stbds_arrins(a,i,v) (stbds_arrinsn((a),(i),1), (a)[i]=(v)) + +#define stbds_arrmaybegrow(a,n) ((!(a) || stbds_header(a)->length + (n) > stbds_header(a)->capacity) \ + ? (stbds_arrgrow(a,n,0),0) : 0) + +#define stbds_arrgrow(a,b,c) ((a) = stbds_arrgrowf_wrapper((a), sizeof *(a), (b), (c))) + +#define stbds_hmput(t, k, v) \ + ((t) = stbds_hmput_key_wrapper((t), sizeof *(t), (void*) STBDS_ADDRESSOF((t)->key, (k)), sizeof (t)->key, 0), \ + (t)[stbds_temp((t)-1)].key = (k), \ + (t)[stbds_temp((t)-1)].value = (v)) + +#define stbds_hmputs(t, s) \ + ((t) = stbds_hmput_key_wrapper((t), sizeof *(t), &(s).key, sizeof (s).key, STBDS_HM_BINARY), \ + (t)[stbds_temp((t)-1)] = (s)) + +#define stbds_hmgeti(t,k) \ + ((t) = stbds_hmget_key_wrapper((t), sizeof *(t), (void*) STBDS_ADDRESSOF((t)->key, (k)), sizeof (t)->key, STBDS_HM_BINARY), \ + stbds_temp((t)-1)) + +#define stbds_hmgeti_ts(t,k,temp) \ + ((t) = stbds_hmget_key_ts_wrapper((t), sizeof *(t), (void*) STBDS_ADDRESSOF((t)->key, (k)), sizeof (t)->key, &(temp), STBDS_HM_BINARY), \ + (temp)) + +#define stbds_hmgetp(t, k) \ + ((void) stbds_hmgeti(t,k), &(t)[stbds_temp((t)-1)]) + +#define stbds_hmgetp_ts(t, k, temp) \ + ((void) stbds_hmgeti_ts(t,k,temp), &(t)[temp]) + +#define stbds_hmdel(t,k) \ + (((t) = stbds_hmdel_key_wrapper((t),sizeof *(t), (void*) STBDS_ADDRESSOF((t)->key, (k)), sizeof (t)->key, STBDS_OFFSETOF((t),key), STBDS_HM_BINARY)),(t)?stbds_temp((t)-1):0) + +#define stbds_hmdefault(t, v) \ + ((t) = stbds_hmput_default_wrapper((t), sizeof *(t)), (t)[-1].value = (v)) + +#define stbds_hmdefaults(t, s) \ + ((t) = stbds_hmput_default_wrapper((t), sizeof *(t)), (t)[-1] = (s)) + +#define stbds_hmfree(p) \ + ((void) ((p) != NULL ? stbds_hmfree_func((p)-1,sizeof*(p)),0 : 0),(p)=NULL) + +#define stbds_hmgets(t, k) (*stbds_hmgetp(t,k)) +#define stbds_hmget(t, k) (stbds_hmgetp(t,k)->value) +#define stbds_hmget_ts(t, k, temp) (stbds_hmgetp_ts(t,k,temp)->value) +#define stbds_hmlen(t) ((t) ? (ptrdiff_t) stbds_header((t)-1)->length-1 : 0) +#define stbds_hmlenu(t) ((t) ? stbds_header((t)-1)->length-1 : 0) +#define stbds_hmgetp_null(t,k) (stbds_hmgeti(t,k) == -1 ? NULL : &(t)[stbds_temp((t)-1)]) + +#define stbds_shput(t, k, v) \ + ((t) = stbds_hmput_key_wrapper((t), sizeof *(t), (void*) (k), sizeof (t)->key, STBDS_HM_STRING), \ + (t)[stbds_temp((t)-1)].value = (v)) + +#define stbds_shputi(t, k, v) \ + ((t) = stbds_hmput_key_wrapper((t), sizeof *(t), (void*) (k), sizeof (t)->key, STBDS_HM_STRING), \ + (t)[stbds_temp((t)-1)].value = (v), stbds_temp((t)-1)) + +#define stbds_shputs(t, s) \ + ((t) = stbds_hmput_key_wrapper((t), sizeof *(t), (void*) (s).key, sizeof (s).key, STBDS_HM_STRING), \ + (t)[stbds_temp((t)-1)] = (s), \ + (t)[stbds_temp((t)-1)].key = stbds_temp_key((t)-1)) // above line overwrites whole structure, so must rewrite key here if it was allocated internally + +#define stbds_pshput(t, p) \ + ((t) = stbds_hmput_key_wrapper((t), sizeof *(t), (void*) (p)->key, sizeof (p)->key, STBDS_HM_PTR_TO_STRING), \ + (t)[stbds_temp((t)-1)] = (p)) + +#define stbds_shgeti(t,k) \ + ((t) = stbds_hmget_key_wrapper((t), sizeof *(t), (void*) (k), sizeof (t)->key, STBDS_HM_STRING), \ + stbds_temp((t)-1)) + +#define stbds_pshgeti(t,k) \ + ((t) = stbds_hmget_key_wrapper((t), sizeof *(t), (void*) (k), sizeof (*(t))->key, STBDS_HM_PTR_TO_STRING), \ + stbds_temp((t)-1)) + +#define stbds_shgetp(t, k) \ + ((void) stbds_shgeti(t,k), &(t)[stbds_temp((t)-1)]) + +#define stbds_pshget(t, k) \ + ((void) stbds_pshgeti(t,k), (t)[stbds_temp((t)-1)]) + +#define stbds_shdel(t,k) \ + (((t) = stbds_hmdel_key_wrapper((t),sizeof *(t), (void*) (k), sizeof (t)->key, STBDS_OFFSETOF((t),key), STBDS_HM_STRING)),(t)?stbds_temp((t)-1):0) +#define stbds_pshdel(t,k) \ + (((t) = stbds_hmdel_key_wrapper((t),sizeof *(t), (void*) (k), sizeof (*(t))->key, STBDS_OFFSETOF(*(t),key), STBDS_HM_PTR_TO_STRING)),(t)?stbds_temp((t)-1):0) + +#define stbds_sh_new_arena(t) \ + ((t) = stbds_shmode_func_wrapper(t, sizeof *(t), STBDS_SH_ARENA)) +#define stbds_sh_new_strdup(t) \ + ((t) = stbds_shmode_func_wrapper(t, sizeof *(t), STBDS_SH_STRDUP)) + +#define stbds_shdefault(t, v) stbds_hmdefault(t,v) +#define stbds_shdefaults(t, s) stbds_hmdefaults(t,s) + +#define stbds_shfree stbds_hmfree +#define stbds_shlenu stbds_hmlenu + +#define stbds_shgets(t, k) (*stbds_shgetp(t,k)) +#define stbds_shget(t, k) (stbds_shgetp(t,k)->value) +#define stbds_shgetp_null(t,k) (stbds_shgeti(t,k) == -1 ? NULL : &(t)[stbds_temp((t)-1)]) +#define stbds_shlen stbds_hmlen + +typedef struct +{ + size_t length; + size_t capacity; + void * hash_table; + ptrdiff_t temp; +} stbds_array_header; + +typedef struct stbds_string_block +{ + struct stbds_string_block *next; + char storage[8]; +} stbds_string_block; + +struct stbds_string_arena +{ + stbds_string_block *storage; + size_t remaining; + unsigned char block; + unsigned char mode; // this isn't used by the string arena itself +}; + +#define STBDS_HM_BINARY 0 +#define STBDS_HM_STRING 1 + +enum +{ + STBDS_SH_NONE, + STBDS_SH_DEFAULT, + STBDS_SH_STRDUP, + STBDS_SH_ARENA +}; + +#ifdef __cplusplus +// in C we use implicit assignment from these void*-returning functions to T*. +// in C++ these templates make the same code work +template static T * stbds_arrgrowf_wrapper(T *a, size_t elemsize, size_t addlen, size_t min_cap) { + return (T*)stbds_arrgrowf((void *)a, elemsize, addlen, min_cap); +} +template static T * stbds_hmget_key_wrapper(T *a, size_t elemsize, void *key, size_t keysize, int mode) { + return (T*)stbds_hmget_key((void*)a, elemsize, key, keysize, mode); +} +template static T * stbds_hmget_key_ts_wrapper(T *a, size_t elemsize, void *key, size_t keysize, ptrdiff_t *temp, int mode) { + return (T*)stbds_hmget_key_ts((void*)a, elemsize, key, keysize, temp, mode); +} +template static T * stbds_hmput_default_wrapper(T *a, size_t elemsize) { + return (T*)stbds_hmput_default((void *)a, elemsize); +} +template static T * stbds_hmput_key_wrapper(T *a, size_t elemsize, void *key, size_t keysize, int mode) { + return (T*)stbds_hmput_key((void*)a, elemsize, key, keysize, mode); +} +template static T * stbds_hmdel_key_wrapper(T *a, size_t elemsize, void *key, size_t keysize, size_t keyoffset, int mode){ + return (T*)stbds_hmdel_key((void*)a, elemsize, key, keysize, keyoffset, mode); +} +template static T * stbds_shmode_func_wrapper(T *, size_t elemsize, int mode) { + return (T*)stbds_shmode_func(elemsize, mode); +} +#else +#define stbds_arrgrowf_wrapper stbds_arrgrowf +#define stbds_hmget_key_wrapper stbds_hmget_key +#define stbds_hmget_key_ts_wrapper stbds_hmget_key_ts +#define stbds_hmput_default_wrapper stbds_hmput_default +#define stbds_hmput_key_wrapper stbds_hmput_key +#define stbds_hmdel_key_wrapper stbds_hmdel_key +#define stbds_shmode_func_wrapper(t,e,m) stbds_shmode_func(e,m) +#endif + +#endif // INCLUDE_STB_DS_H + + +////////////////////////////////////////////////////////////////////////////// +// +// IMPLEMENTATION +// + +#ifdef STB_DS_IMPLEMENTATION +#include +#include + +#ifndef STBDS_ASSERT +#define STBDS_ASSERT_WAS_UNDEFINED +#define STBDS_ASSERT(x) ((void) 0) +#endif + +#ifdef STBDS_STATISTICS +#define STBDS_STATS(x) x +size_t stbds_array_grow; +size_t stbds_hash_grow; +size_t stbds_hash_shrink; +size_t stbds_hash_rebuild; +size_t stbds_hash_probes; +size_t stbds_hash_alloc; +size_t stbds_rehash_probes; +size_t stbds_rehash_items; +#else +#define STBDS_STATS(x) +#endif + +// +// stbds_arr implementation +// + +//int *prev_allocs[65536]; +//int num_prev; + +void *stbds_arrgrowf(void *a, size_t elemsize, size_t addlen, size_t min_cap) +{ + stbds_array_header temp={0}; // force debugging + void *b; + size_t min_len = stbds_arrlen(a) + addlen; + (void) sizeof(temp); + + // compute the minimum capacity needed + if (min_len > min_cap) + min_cap = min_len; + + if (min_cap <= stbds_arrcap(a)) + return a; + + // increase needed capacity to guarantee O(1) amortized + if (min_cap < 2 * stbds_arrcap(a)) + min_cap = 2 * stbds_arrcap(a); + else if (min_cap < 4) + min_cap = 4; + + //if (num_prev < 65536) if (a) prev_allocs[num_prev++] = (int *) ((char *) a+1); + //if (num_prev == 2201) + // num_prev = num_prev; + b = STBDS_REALLOC(NULL, (a) ? stbds_header(a) : 0, elemsize * min_cap + sizeof(stbds_array_header)); + //if (num_prev < 65536) prev_allocs[num_prev++] = (int *) (char *) b; + b = (char *) b + sizeof(stbds_array_header); + if (a == NULL) { + stbds_header(b)->length = 0; + stbds_header(b)->hash_table = 0; + stbds_header(b)->temp = 0; + } else { + STBDS_STATS(++stbds_array_grow); + } + stbds_header(b)->capacity = min_cap; + + return b; +} + +void stbds_arrfreef(void *a) +{ + STBDS_FREE(NULL, stbds_header(a)); +} + +// +// stbds_hm hash table implementation +// + +#ifdef STBDS_INTERNAL_SMALL_BUCKET +#define STBDS_BUCKET_LENGTH 4 +#else +#define STBDS_BUCKET_LENGTH 8 +#endif + +#define STBDS_BUCKET_SHIFT (STBDS_BUCKET_LENGTH == 8 ? 3 : 2) +#define STBDS_BUCKET_MASK (STBDS_BUCKET_LENGTH-1) +#define STBDS_CACHE_LINE_SIZE 64 + +#define STBDS_ALIGN_FWD(n,a) (((n) + (a) - 1) & ~((a)-1)) + +typedef struct +{ + size_t hash [STBDS_BUCKET_LENGTH]; + ptrdiff_t index[STBDS_BUCKET_LENGTH]; +} stbds_hash_bucket; // in 32-bit, this is one 64-byte cache line; in 64-bit, each array is one 64-byte cache line + +typedef struct +{ + char * temp_key; // this MUST be the first field of the hash table + size_t slot_count; + size_t used_count; + size_t used_count_threshold; + size_t used_count_shrink_threshold; + size_t tombstone_count; + size_t tombstone_count_threshold; + size_t seed; + size_t slot_count_log2; + stbds_string_arena string; + stbds_hash_bucket *storage; // not a separate allocation, just 64-byte aligned storage after this struct +} stbds_hash_index; + +#define STBDS_INDEX_EMPTY -1 +#define STBDS_INDEX_DELETED -2 +#define STBDS_INDEX_IN_USE(x) ((x) >= 0) + +#define STBDS_HASH_EMPTY 0 +#define STBDS_HASH_DELETED 1 + +static size_t stbds_hash_seed=0x31415926; + +void stbds_rand_seed(size_t seed) +{ + stbds_hash_seed = seed; +} + +#define stbds_load_32_or_64(var, temp, v32, v64_hi, v64_lo) \ + temp = v64_lo ^ v32, temp <<= 16, temp <<= 16, temp >>= 16, temp >>= 16, /* discard if 32-bit */ \ + var = v64_hi, var <<= 16, var <<= 16, /* discard if 32-bit */ \ + var ^= temp ^ v32 + +#define STBDS_SIZE_T_BITS ((sizeof (size_t)) * 8) + +static size_t stbds_probe_position(size_t hash, size_t slot_count, size_t slot_log2) +{ + size_t pos; + STBDS_NOTUSED(slot_log2); + pos = hash & (slot_count-1); + #ifdef STBDS_INTERNAL_BUCKET_START + pos &= ~STBDS_BUCKET_MASK; + #endif + return pos; +} + +static size_t stbds_log2(size_t slot_count) +{ + size_t n=0; + while (slot_count > 1) { + slot_count >>= 1; + ++n; + } + return n; +} + +static stbds_hash_index *stbds_make_hash_index(size_t slot_count, stbds_hash_index *ot) +{ + stbds_hash_index *t; + t = (stbds_hash_index *) STBDS_REALLOC(NULL,0,(slot_count >> STBDS_BUCKET_SHIFT) * sizeof(stbds_hash_bucket) + sizeof(stbds_hash_index) + STBDS_CACHE_LINE_SIZE-1); + t->storage = (stbds_hash_bucket *) STBDS_ALIGN_FWD((size_t) (t+1), STBDS_CACHE_LINE_SIZE); + t->slot_count = slot_count; + t->slot_count_log2 = stbds_log2(slot_count); + t->tombstone_count = 0; + t->used_count = 0; + + #if 0 // A1 + t->used_count_threshold = slot_count*12/16; // if 12/16th of table is occupied, grow + t->tombstone_count_threshold = slot_count* 2/16; // if tombstones are 2/16th of table, rebuild + t->used_count_shrink_threshold = slot_count* 4/16; // if table is only 4/16th full, shrink + #elif 1 // A2 + //t->used_count_threshold = slot_count*12/16; // if 12/16th of table is occupied, grow + //t->tombstone_count_threshold = slot_count* 3/16; // if tombstones are 3/16th of table, rebuild + //t->used_count_shrink_threshold = slot_count* 4/16; // if table is only 4/16th full, shrink + + // compute without overflowing + t->used_count_threshold = slot_count - (slot_count>>2); + t->tombstone_count_threshold = (slot_count>>3) + (slot_count>>4); + t->used_count_shrink_threshold = slot_count >> 2; + + #elif 0 // B1 + t->used_count_threshold = slot_count*13/16; // if 13/16th of table is occupied, grow + t->tombstone_count_threshold = slot_count* 2/16; // if tombstones are 2/16th of table, rebuild + t->used_count_shrink_threshold = slot_count* 5/16; // if table is only 5/16th full, shrink + #else // C1 + t->used_count_threshold = slot_count*14/16; // if 14/16th of table is occupied, grow + t->tombstone_count_threshold = slot_count* 2/16; // if tombstones are 2/16th of table, rebuild + t->used_count_shrink_threshold = slot_count* 6/16; // if table is only 6/16th full, shrink + #endif + // Following statistics were measured on a Core i7-6700 @ 4.00Ghz, compiled with clang 7.0.1 -O2 + // Note that the larger tables have high variance as they were run fewer times + // A1 A2 B1 C1 + // 0.10ms : 0.10ms : 0.10ms : 0.11ms : 2,000 inserts creating 2K table + // 0.96ms : 0.95ms : 0.97ms : 1.04ms : 20,000 inserts creating 20K table + // 14.48ms : 14.46ms : 10.63ms : 11.00ms : 200,000 inserts creating 200K table + // 195.74ms : 196.35ms : 203.69ms : 214.92ms : 2,000,000 inserts creating 2M table + // 2193.88ms : 2209.22ms : 2285.54ms : 2437.17ms : 20,000,000 inserts creating 20M table + // 65.27ms : 53.77ms : 65.33ms : 65.47ms : 500,000 inserts & deletes in 2K table + // 72.78ms : 62.45ms : 71.95ms : 72.85ms : 500,000 inserts & deletes in 20K table + // 89.47ms : 77.72ms : 96.49ms : 96.75ms : 500,000 inserts & deletes in 200K table + // 97.58ms : 98.14ms : 97.18ms : 97.53ms : 500,000 inserts & deletes in 2M table + // 118.61ms : 119.62ms : 120.16ms : 118.86ms : 500,000 inserts & deletes in 20M table + // 192.11ms : 194.39ms : 196.38ms : 195.73ms : 500,000 inserts & deletes in 200M table + + if (slot_count <= STBDS_BUCKET_LENGTH) + t->used_count_shrink_threshold = 0; + // to avoid infinite loop, we need to guarantee that at least one slot is empty and will terminate probes + STBDS_ASSERT(t->used_count_threshold + t->tombstone_count_threshold < t->slot_count); + STBDS_STATS(++stbds_hash_alloc); + if (ot) { + t->string = ot->string; + // reuse old seed so we can reuse old hashes so below "copy out old data" doesn't do any hashing + t->seed = ot->seed; + } else { + size_t a,b,temp; + memset(&t->string, 0, sizeof(t->string)); + t->seed = stbds_hash_seed; + // LCG + // in 32-bit, a = 2147001325 b = 715136305 + // in 64-bit, a = 2862933555777941757 b = 3037000493 + stbds_load_32_or_64(a,temp, 2147001325, 0x27bb2ee6, 0x87b0b0fd); + stbds_load_32_or_64(b,temp, 715136305, 0, 0xb504f32d); + stbds_hash_seed = stbds_hash_seed * a + b; + } + + { + size_t i,j; + for (i=0; i < slot_count >> STBDS_BUCKET_SHIFT; ++i) { + stbds_hash_bucket *b = &t->storage[i]; + for (j=0; j < STBDS_BUCKET_LENGTH; ++j) + b->hash[j] = STBDS_HASH_EMPTY; + for (j=0; j < STBDS_BUCKET_LENGTH; ++j) + b->index[j] = STBDS_INDEX_EMPTY; + } + } + + // copy out the old data, if any + if (ot) { + size_t i,j; + t->used_count = ot->used_count; + for (i=0; i < ot->slot_count >> STBDS_BUCKET_SHIFT; ++i) { + stbds_hash_bucket *ob = &ot->storage[i]; + for (j=0; j < STBDS_BUCKET_LENGTH; ++j) { + if (STBDS_INDEX_IN_USE(ob->index[j])) { + size_t hash = ob->hash[j]; + size_t pos = stbds_probe_position(hash, t->slot_count, t->slot_count_log2); + size_t step = STBDS_BUCKET_LENGTH; + STBDS_STATS(++stbds_rehash_items); + for (;;) { + size_t limit,z; + stbds_hash_bucket *bucket; + bucket = &t->storage[pos >> STBDS_BUCKET_SHIFT]; + STBDS_STATS(++stbds_rehash_probes); + + for (z=pos & STBDS_BUCKET_MASK; z < STBDS_BUCKET_LENGTH; ++z) { + if (bucket->hash[z] == 0) { + bucket->hash[z] = hash; + bucket->index[z] = ob->index[j]; + goto done; + } + } + + limit = pos & STBDS_BUCKET_MASK; + for (z = 0; z < limit; ++z) { + if (bucket->hash[z] == 0) { + bucket->hash[z] = hash; + bucket->index[z] = ob->index[j]; + goto done; + } + } + + pos += step; // quadratic probing + step += STBDS_BUCKET_LENGTH; + pos &= (t->slot_count-1); + } + } + done: + ; + } + } + } + + return t; +} + +#define STBDS_ROTATE_LEFT(val, n) (((val) << (n)) | ((val) >> (STBDS_SIZE_T_BITS - (n)))) +#define STBDS_ROTATE_RIGHT(val, n) (((val) >> (n)) | ((val) << (STBDS_SIZE_T_BITS - (n)))) + +size_t stbds_hash_string(char *str, size_t seed) +{ + size_t hash = seed; + while (*str) + hash = STBDS_ROTATE_LEFT(hash, 9) + (unsigned char) *str++; + + // Thomas Wang 64-to-32 bit mix function, hopefully also works in 32 bits + hash ^= seed; + hash = (~hash) + (hash << 18); + hash ^= hash ^ STBDS_ROTATE_RIGHT(hash,31); + hash = hash * 21; + hash ^= hash ^ STBDS_ROTATE_RIGHT(hash,11); + hash += (hash << 6); + hash ^= STBDS_ROTATE_RIGHT(hash,22); + return hash+seed; +} + +#ifdef STBDS_SIPHASH_2_4 +#define STBDS_SIPHASH_C_ROUNDS 2 +#define STBDS_SIPHASH_D_ROUNDS 4 +typedef int STBDS_SIPHASH_2_4_can_only_be_used_in_64_bit_builds[sizeof(size_t) == 8 ? 1 : -1]; +#endif + +#ifndef STBDS_SIPHASH_C_ROUNDS +#define STBDS_SIPHASH_C_ROUNDS 1 +#endif +#ifndef STBDS_SIPHASH_D_ROUNDS +#define STBDS_SIPHASH_D_ROUNDS 1 +#endif + +#ifdef _MSC_VER +#pragma warning(push) +#pragma warning(disable:4127) // conditional expression is constant, for do..while(0) and sizeof()== +#endif + +static size_t stbds_siphash_bytes(void *p, size_t len, size_t seed) +{ + unsigned char *d = (unsigned char *) p; + size_t i,j; + size_t v0,v1,v2,v3, data; + + // hash that works on 32- or 64-bit registers without knowing which we have + // (computes different results on 32-bit and 64-bit platform) + // derived from siphash, but on 32-bit platforms very different as it uses 4 32-bit state not 4 64-bit + v0 = ((((size_t) 0x736f6d65 << 16) << 16) + 0x70736575) ^ seed; + v1 = ((((size_t) 0x646f7261 << 16) << 16) + 0x6e646f6d) ^ ~seed; + v2 = ((((size_t) 0x6c796765 << 16) << 16) + 0x6e657261) ^ seed; + v3 = ((((size_t) 0x74656462 << 16) << 16) + 0x79746573) ^ ~seed; + + #ifdef STBDS_TEST_SIPHASH_2_4 + // hardcoded with key material in the siphash test vectors + v0 ^= 0x0706050403020100ull ^ seed; + v1 ^= 0x0f0e0d0c0b0a0908ull ^ ~seed; + v2 ^= 0x0706050403020100ull ^ seed; + v3 ^= 0x0f0e0d0c0b0a0908ull ^ ~seed; + #endif + + #define STBDS_SIPROUND() \ + do { \ + v0 += v1; v1 = STBDS_ROTATE_LEFT(v1, 13); v1 ^= v0; v0 = STBDS_ROTATE_LEFT(v0,STBDS_SIZE_T_BITS/2); \ + v2 += v3; v3 = STBDS_ROTATE_LEFT(v3, 16); v3 ^= v2; \ + v2 += v1; v1 = STBDS_ROTATE_LEFT(v1, 17); v1 ^= v2; v2 = STBDS_ROTATE_LEFT(v2,STBDS_SIZE_T_BITS/2); \ + v0 += v3; v3 = STBDS_ROTATE_LEFT(v3, 21); v3 ^= v0; \ + } while (0) + + for (i=0; i+sizeof(size_t) <= len; i += sizeof(size_t), d += sizeof(size_t)) { + data = d[0] | (d[1] << 8) | (d[2] << 16) | (d[3] << 24); + data |= (size_t) (d[4] | (d[5] << 8) | (d[6] << 16) | (d[7] << 24)) << 16 << 16; // discarded if size_t == 4 + + v3 ^= data; + for (j=0; j < STBDS_SIPHASH_C_ROUNDS; ++j) + STBDS_SIPROUND(); + v0 ^= data; + } + data = len << (STBDS_SIZE_T_BITS-8); + switch (len - i) { + case 7: data |= ((size_t) d[6] << 24) << 24; // fall through + case 6: data |= ((size_t) d[5] << 20) << 20; // fall through + case 5: data |= ((size_t) d[4] << 16) << 16; // fall through + case 4: data |= (d[3] << 24); // fall through + case 3: data |= (d[2] << 16); // fall through + case 2: data |= (d[1] << 8); // fall through + case 1: data |= d[0]; // fall through + case 0: break; + } + v3 ^= data; + for (j=0; j < STBDS_SIPHASH_C_ROUNDS; ++j) + STBDS_SIPROUND(); + v0 ^= data; + v2 ^= 0xff; + for (j=0; j < STBDS_SIPHASH_D_ROUNDS; ++j) + STBDS_SIPROUND(); + +#ifdef STBDS_SIPHASH_2_4 + return v0^v1^v2^v3; +#else + return v1^v2^v3; // slightly stronger since v0^v3 in above cancels out final round operation? I tweeted at the authors of SipHash about this but they didn't reply +#endif +} + +size_t stbds_hash_bytes(void *p, size_t len, size_t seed) +{ +#ifdef STBDS_SIPHASH_2_4 + return stbds_siphash_bytes(p,len,seed); +#else + unsigned char *d = (unsigned char *) p; + + if (len == 4) { + unsigned int hash = d[0] | (d[1] << 8) | (d[2] << 16) | (d[3] << 24); + #if 0 + // HASH32-A Bob Jenkin's hash function w/o large constants + hash ^= seed; + hash -= (hash<<6); + hash ^= (hash>>17); + hash -= (hash<<9); + hash ^= seed; + hash ^= (hash<<4); + hash -= (hash<<3); + hash ^= (hash<<10); + hash ^= (hash>>15); + #elif 1 + // HASH32-BB Bob Jenkin's presumably-accidental version of Thomas Wang hash with rotates turned into shifts. + // Note that converting these back to rotates makes it run a lot slower, presumably due to collisions, so I'm + // not really sure what's going on. + hash ^= seed; + hash = (hash ^ 61) ^ (hash >> 16); + hash = hash + (hash << 3); + hash = hash ^ (hash >> 4); + hash = hash * 0x27d4eb2d; + hash ^= seed; + hash = hash ^ (hash >> 15); + #else // HASH32-C - Murmur3 + hash ^= seed; + hash *= 0xcc9e2d51; + hash = (hash << 17) | (hash >> 15); + hash *= 0x1b873593; + hash ^= seed; + hash = (hash << 19) | (hash >> 13); + hash = hash*5 + 0xe6546b64; + hash ^= hash >> 16; + hash *= 0x85ebca6b; + hash ^= seed; + hash ^= hash >> 13; + hash *= 0xc2b2ae35; + hash ^= hash >> 16; + #endif + // Following statistics were measured on a Core i7-6700 @ 4.00Ghz, compiled with clang 7.0.1 -O2 + // Note that the larger tables have high variance as they were run fewer times + // HASH32-A // HASH32-BB // HASH32-C + // 0.10ms // 0.10ms // 0.10ms : 2,000 inserts creating 2K table + // 0.96ms // 0.95ms // 0.99ms : 20,000 inserts creating 20K table + // 14.69ms // 14.43ms // 14.97ms : 200,000 inserts creating 200K table + // 199.99ms // 195.36ms // 202.05ms : 2,000,000 inserts creating 2M table + // 2234.84ms // 2187.74ms // 2240.38ms : 20,000,000 inserts creating 20M table + // 55.68ms // 53.72ms // 57.31ms : 500,000 inserts & deletes in 2K table + // 63.43ms // 61.99ms // 65.73ms : 500,000 inserts & deletes in 20K table + // 80.04ms // 77.96ms // 81.83ms : 500,000 inserts & deletes in 200K table + // 100.42ms // 97.40ms // 102.39ms : 500,000 inserts & deletes in 2M table + // 119.71ms // 120.59ms // 121.63ms : 500,000 inserts & deletes in 20M table + // 185.28ms // 195.15ms // 187.74ms : 500,000 inserts & deletes in 200M table + // 15.58ms // 14.79ms // 15.52ms : 200,000 inserts creating 200K table with varying key spacing + + return (((size_t) hash << 16 << 16) | hash) ^ seed; + } else if (len == 8 && sizeof(size_t) == 8) { + size_t hash = d[0] | (d[1] << 8) | (d[2] << 16) | (d[3] << 24); + hash |= (size_t) (d[4] | (d[5] << 8) | (d[6] << 16) | (d[7] << 24)) << 16 << 16; // avoid warning if size_t == 4 + hash ^= seed; + hash = (~hash) + (hash << 21); + hash ^= STBDS_ROTATE_RIGHT(hash,24); + hash *= 265; + hash ^= STBDS_ROTATE_RIGHT(hash,14); + hash ^= seed; + hash *= 21; + hash ^= STBDS_ROTATE_RIGHT(hash,28); + hash += (hash << 31); + hash = (~hash) + (hash << 18); + return hash; + } else { + return stbds_siphash_bytes(p,len,seed); + } +#endif +} +#ifdef _MSC_VER +#pragma warning(pop) +#endif + + +static int stbds_is_key_equal(void *a, size_t elemsize, void *key, size_t keysize, size_t keyoffset, int mode, size_t i) +{ + if (mode >= STBDS_HM_STRING) + return 0==strcmp((char *) key, * (char **) ((char *) a + elemsize*i + keyoffset)); + else + return 0==memcmp(key, (char *) a + elemsize*i + keyoffset, keysize); +} + +#define STBDS_HASH_TO_ARR(x,elemsize) ((char*) (x) - (elemsize)) +#define STBDS_ARR_TO_HASH(x,elemsize) ((char*) (x) + (elemsize)) + +#define stbds_hash_table(a) ((stbds_hash_index *) stbds_header(a)->hash_table) + +void stbds_hmfree_func(void *a, size_t elemsize) +{ + if (a == NULL) return; + if (stbds_hash_table(a) != NULL) { + if (stbds_hash_table(a)->string.mode == STBDS_SH_STRDUP) { + size_t i; + // skip 0th element, which is default + for (i=1; i < stbds_header(a)->length; ++i) + STBDS_FREE(NULL, *(char**) ((char *) a + elemsize*i)); + } + stbds_strreset(&stbds_hash_table(a)->string); + } + STBDS_FREE(NULL, stbds_header(a)->hash_table); + STBDS_FREE(NULL, stbds_header(a)); +} + +static ptrdiff_t stbds_hm_find_slot(void *a, size_t elemsize, void *key, size_t keysize, size_t keyoffset, int mode) +{ + void *raw_a = STBDS_HASH_TO_ARR(a,elemsize); + stbds_hash_index *table = stbds_hash_table(raw_a); + size_t hash = mode >= STBDS_HM_STRING ? stbds_hash_string((char*)key,table->seed) : stbds_hash_bytes(key, keysize,table->seed); + size_t step = STBDS_BUCKET_LENGTH; + size_t limit,i; + size_t pos; + stbds_hash_bucket *bucket; + + if (hash < 2) hash += 2; // stored hash values are forbidden from being 0, so we can detect empty slots + + pos = stbds_probe_position(hash, table->slot_count, table->slot_count_log2); + + for (;;) { + STBDS_STATS(++stbds_hash_probes); + bucket = &table->storage[pos >> STBDS_BUCKET_SHIFT]; + + // start searching from pos to end of bucket, this should help performance on small hash tables that fit in cache + for (i=pos & STBDS_BUCKET_MASK; i < STBDS_BUCKET_LENGTH; ++i) { + if (bucket->hash[i] == hash) { + if (stbds_is_key_equal(a, elemsize, key, keysize, keyoffset, mode, bucket->index[i])) { + return (pos & ~STBDS_BUCKET_MASK)+i; + } + } else if (bucket->hash[i] == STBDS_HASH_EMPTY) { + return -1; + } + } + + // search from beginning of bucket to pos + limit = pos & STBDS_BUCKET_MASK; + for (i = 0; i < limit; ++i) { + if (bucket->hash[i] == hash) { + if (stbds_is_key_equal(a, elemsize, key, keysize, keyoffset, mode, bucket->index[i])) { + return (pos & ~STBDS_BUCKET_MASK)+i; + } + } else if (bucket->hash[i] == STBDS_HASH_EMPTY) { + return -1; + } + } + + // quadratic probing + pos += step; + step += STBDS_BUCKET_LENGTH; + pos &= (table->slot_count-1); + } + /* NOTREACHED */ +} + +void * stbds_hmget_key_ts(void *a, size_t elemsize, void *key, size_t keysize, ptrdiff_t *temp, int mode) +{ + size_t keyoffset = 0; + if (a == NULL) { + // make it non-empty so we can return a temp + a = stbds_arrgrowf(0, elemsize, 0, 1); + stbds_header(a)->length += 1; + memset(a, 0, elemsize); + *temp = STBDS_INDEX_EMPTY; + // adjust a to point after the default element + return STBDS_ARR_TO_HASH(a,elemsize); + } else { + stbds_hash_index *table; + void *raw_a = STBDS_HASH_TO_ARR(a,elemsize); + // adjust a to point to the default element + table = (stbds_hash_index *) stbds_header(raw_a)->hash_table; + if (table == 0) { + *temp = -1; + } else { + ptrdiff_t slot = stbds_hm_find_slot(a, elemsize, key, keysize, keyoffset, mode); + if (slot < 0) { + *temp = STBDS_INDEX_EMPTY; + } else { + stbds_hash_bucket *b = &table->storage[slot >> STBDS_BUCKET_SHIFT]; + *temp = b->index[slot & STBDS_BUCKET_MASK]; + } + } + return a; + } +} + +void * stbds_hmget_key(void *a, size_t elemsize, void *key, size_t keysize, int mode) +{ + ptrdiff_t temp; + void *p = stbds_hmget_key_ts(a, elemsize, key, keysize, &temp, mode); + stbds_temp(STBDS_HASH_TO_ARR(p,elemsize)) = temp; + return p; +} + +void * stbds_hmput_default(void *a, size_t elemsize) +{ + // three cases: + // a is NULL <- allocate + // a has a hash table but no entries, because of shmode <- grow + // a has entries <- do nothing + if (a == NULL || stbds_header(STBDS_HASH_TO_ARR(a,elemsize))->length == 0) { + a = stbds_arrgrowf(a ? STBDS_HASH_TO_ARR(a,elemsize) : NULL, elemsize, 0, 1); + stbds_header(a)->length += 1; + memset(a, 0, elemsize); + a=STBDS_ARR_TO_HASH(a,elemsize); + } + return a; +} + +static char *stbds_strdup(char *str); + +void *stbds_hmput_key(void *a, size_t elemsize, void *key, size_t keysize, int mode) +{ + size_t keyoffset=0; + void *raw_a; + stbds_hash_index *table; + + if (a == NULL) { + a = stbds_arrgrowf(0, elemsize, 0, 1); + memset(a, 0, elemsize); + stbds_header(a)->length += 1; + // adjust a to point AFTER the default element + a = STBDS_ARR_TO_HASH(a,elemsize); + } + + // adjust a to point to the default element + raw_a = a; + a = STBDS_HASH_TO_ARR(a,elemsize); + + table = (stbds_hash_index *) stbds_header(a)->hash_table; + + if (table == NULL || table->used_count >= table->used_count_threshold) { + stbds_hash_index *nt; + size_t slot_count; + + slot_count = (table == NULL) ? STBDS_BUCKET_LENGTH : table->slot_count*2; + nt = stbds_make_hash_index(slot_count, table); + if (table) + STBDS_FREE(NULL, table); + else + nt->string.mode = mode >= STBDS_HM_STRING ? STBDS_SH_DEFAULT : 0; + stbds_header(a)->hash_table = table = nt; + STBDS_STATS(++stbds_hash_grow); + } + + // we iterate hash table explicitly because we want to track if we saw a tombstone + { + size_t hash = mode >= STBDS_HM_STRING ? stbds_hash_string((char*)key,table->seed) : stbds_hash_bytes(key, keysize,table->seed); + size_t step = STBDS_BUCKET_LENGTH; + size_t pos; + ptrdiff_t tombstone = -1; + stbds_hash_bucket *bucket; + + // stored hash values are forbidden from being 0, so we can detect empty slots to early out quickly + if (hash < 2) hash += 2; + + pos = stbds_probe_position(hash, table->slot_count, table->slot_count_log2); + + for (;;) { + size_t limit, i; + STBDS_STATS(++stbds_hash_probes); + bucket = &table->storage[pos >> STBDS_BUCKET_SHIFT]; + + // start searching from pos to end of bucket + for (i=pos & STBDS_BUCKET_MASK; i < STBDS_BUCKET_LENGTH; ++i) { + if (bucket->hash[i] == hash) { + if (stbds_is_key_equal(raw_a, elemsize, key, keysize, keyoffset, mode, bucket->index[i])) { + stbds_temp(a) = bucket->index[i]; + if (mode >= STBDS_HM_STRING) + stbds_temp_key(a) = * (char **) ((char *) raw_a + elemsize*bucket->index[i] + keyoffset); + return STBDS_ARR_TO_HASH(a,elemsize); + } + } else if (bucket->hash[i] == 0) { + pos = (pos & ~STBDS_BUCKET_MASK) + i; + goto found_empty_slot; + } else if (tombstone < 0) { + if (bucket->index[i] == STBDS_INDEX_DELETED) + tombstone = (ptrdiff_t) ((pos & ~STBDS_BUCKET_MASK) + i); + } + } + + // search from beginning of bucket to pos + limit = pos & STBDS_BUCKET_MASK; + for (i = 0; i < limit; ++i) { + if (bucket->hash[i] == hash) { + if (stbds_is_key_equal(raw_a, elemsize, key, keysize, keyoffset, mode, bucket->index[i])) { + stbds_temp(a) = bucket->index[i]; + return STBDS_ARR_TO_HASH(a,elemsize); + } + } else if (bucket->hash[i] == 0) { + pos = (pos & ~STBDS_BUCKET_MASK) + i; + goto found_empty_slot; + } else if (tombstone < 0) { + if (bucket->index[i] == STBDS_INDEX_DELETED) + tombstone = (ptrdiff_t) ((pos & ~STBDS_BUCKET_MASK) + i); + } + } + + // quadratic probing + pos += step; + step += STBDS_BUCKET_LENGTH; + pos &= (table->slot_count-1); + } + found_empty_slot: + if (tombstone >= 0) { + pos = tombstone; + --table->tombstone_count; + } + ++table->used_count; + + { + ptrdiff_t i = (ptrdiff_t) stbds_arrlen(a); + // we want to do stbds_arraddn(1), but we can't use the macros since we don't have something of the right type + if ((size_t) i+1 > stbds_arrcap(a)) + *(void **) &a = stbds_arrgrowf(a, elemsize, 1, 0); + raw_a = STBDS_ARR_TO_HASH(a,elemsize); + + STBDS_ASSERT((size_t) i+1 <= stbds_arrcap(a)); + stbds_header(a)->length = i+1; + bucket = &table->storage[pos >> STBDS_BUCKET_SHIFT]; + bucket->hash[pos & STBDS_BUCKET_MASK] = hash; + bucket->index[pos & STBDS_BUCKET_MASK] = i-1; + stbds_temp(a) = i-1; + + switch (table->string.mode) { + case STBDS_SH_STRDUP: stbds_temp_key(a) = *(char **) ((char *) a + elemsize*i) = stbds_strdup((char*) key); break; + case STBDS_SH_ARENA: stbds_temp_key(a) = *(char **) ((char *) a + elemsize*i) = stbds_stralloc(&table->string, (char*)key); break; + case STBDS_SH_DEFAULT: stbds_temp_key(a) = *(char **) ((char *) a + elemsize*i) = (char *) key; break; + default: memcpy((char *) a + elemsize*i, key, keysize); break; + } + } + return STBDS_ARR_TO_HASH(a,elemsize); + } +} + +void * stbds_shmode_func(size_t elemsize, int mode) +{ + void *a = stbds_arrgrowf(0, elemsize, 0, 1); + stbds_hash_index *h; + memset(a, 0, elemsize); + stbds_header(a)->length = 1; + stbds_header(a)->hash_table = h = (stbds_hash_index *) stbds_make_hash_index(STBDS_BUCKET_LENGTH, NULL); + h->string.mode = (unsigned char) mode; + return STBDS_ARR_TO_HASH(a,elemsize); +} + +void * stbds_hmdel_key(void *a, size_t elemsize, void *key, size_t keysize, size_t keyoffset, int mode) +{ + if (a == NULL) { + return 0; + } else { + stbds_hash_index *table; + void *raw_a = STBDS_HASH_TO_ARR(a,elemsize); + table = (stbds_hash_index *) stbds_header(raw_a)->hash_table; + stbds_temp(raw_a) = 0; + if (table == 0) { + return a; + } else { + ptrdiff_t slot; + slot = stbds_hm_find_slot(a, elemsize, key, keysize, keyoffset, mode); + if (slot < 0) + return a; + else { + stbds_hash_bucket *b = &table->storage[slot >> STBDS_BUCKET_SHIFT]; + int i = slot & STBDS_BUCKET_MASK; + ptrdiff_t old_index = b->index[i]; + ptrdiff_t final_index = (ptrdiff_t) stbds_arrlen(raw_a)-1-1; // minus one for the raw_a vs a, and minus one for 'last' + STBDS_ASSERT(slot < (ptrdiff_t) table->slot_count); + --table->used_count; + ++table->tombstone_count; + stbds_temp(raw_a) = 1; + STBDS_ASSERT(table->used_count >= 0); + //STBDS_ASSERT(table->tombstone_count < table->slot_count/4); + b->hash[i] = STBDS_HASH_DELETED; + b->index[i] = STBDS_INDEX_DELETED; + + if (mode == STBDS_HM_STRING && table->string.mode == STBDS_SH_STRDUP) + STBDS_FREE(NULL, *(char**) ((char *) a+elemsize*old_index)); + + // if indices are the same, memcpy is a no-op, but back-pointer-fixup will fail, so skip + if (old_index != final_index) { + // swap delete + memmove((char*) a + elemsize*old_index, (char*) a + elemsize*final_index, elemsize); + + // now find the slot for the last element + if (mode == STBDS_HM_STRING) + slot = stbds_hm_find_slot(a, elemsize, *(char**) ((char *) a+elemsize*old_index + keyoffset), keysize, keyoffset, mode); + else + slot = stbds_hm_find_slot(a, elemsize, (char* ) a+elemsize*old_index + keyoffset, keysize, keyoffset, mode); + STBDS_ASSERT(slot >= 0); + b = &table->storage[slot >> STBDS_BUCKET_SHIFT]; + i = slot & STBDS_BUCKET_MASK; + STBDS_ASSERT(b->index[i] == final_index); + b->index[i] = old_index; + } + stbds_header(raw_a)->length -= 1; + + if (table->used_count < table->used_count_shrink_threshold && table->slot_count > STBDS_BUCKET_LENGTH) { + stbds_header(raw_a)->hash_table = stbds_make_hash_index(table->slot_count>>1, table); + STBDS_FREE(NULL, table); + STBDS_STATS(++stbds_hash_shrink); + } else if (table->tombstone_count > table->tombstone_count_threshold) { + stbds_header(raw_a)->hash_table = stbds_make_hash_index(table->slot_count , table); + STBDS_FREE(NULL, table); + STBDS_STATS(++stbds_hash_rebuild); + } + + return a; + } + } + } + /* NOTREACHED */ +} + +static char *stbds_strdup(char *str) +{ + // to keep replaceable allocator simple, we don't want to use strdup. + // rolling our own also avoids problem of strdup vs _strdup + size_t len = strlen(str)+1; + char *p = (char*) STBDS_REALLOC(NULL, 0, len); + memmove(p, str, len); + return p; +} + +#ifndef STBDS_STRING_ARENA_BLOCKSIZE_MIN +#define STBDS_STRING_ARENA_BLOCKSIZE_MIN 512u +#endif +#ifndef STBDS_STRING_ARENA_BLOCKSIZE_MAX +#define STBDS_STRING_ARENA_BLOCKSIZE_MAX (1u<<20) +#endif + +char *stbds_stralloc(stbds_string_arena *a, char *str) +{ + char *p; + size_t len = strlen(str)+1; + if (len > a->remaining) { + // compute the next blocksize + size_t blocksize = a->block; + + // size is 512, 512, 1024, 1024, 2048, 2048, 4096, 4096, etc., so that + // there are log(SIZE) allocations to free when we destroy the table + blocksize = (size_t) (STBDS_STRING_ARENA_BLOCKSIZE_MIN) << (blocksize>>1); + + // if size is under 1M, advance to next blocktype + if (blocksize < (size_t)(STBDS_STRING_ARENA_BLOCKSIZE_MAX)) + ++a->block; + + if (len > blocksize) { + // if string is larger than blocksize, then just allocate the full size. + // note that we still advance string_block so block size will continue + // increasing, so e.g. if somebody only calls this with 1000-long strings, + // eventually the arena will start doubling and handling those as well + stbds_string_block *sb = (stbds_string_block *) STBDS_REALLOC(NULL, 0, sizeof(*sb)-8 + len); + memmove(sb->storage, str, len); + if (a->storage) { + // insert it after the first element, so that we don't waste the space there + sb->next = a->storage->next; + a->storage->next = sb; + } else { + sb->next = 0; + a->storage = sb; + a->remaining = 0; // this is redundant, but good for clarity + } + return sb->storage; + } else { + stbds_string_block *sb = (stbds_string_block *) STBDS_REALLOC(NULL, 0, sizeof(*sb)-8 + blocksize); + sb->next = a->storage; + a->storage = sb; + a->remaining = blocksize; + } + } + + STBDS_ASSERT(len <= a->remaining); + p = a->storage->storage + a->remaining - len; + a->remaining -= len; + memmove(p, str, len); + return p; +} + +void stbds_strreset(stbds_string_arena *a) +{ + stbds_string_block *x,*y; + x = a->storage; + while (x) { + y = x->next; + STBDS_FREE(NULL, x); + x = y; + } + memset(a, 0, sizeof(*a)); +} + +#endif + +////////////////////////////////////////////////////////////////////////////// +// +// UNIT TESTS +// + +#ifdef STBDS_UNIT_TESTS +#include +#ifdef STBDS_ASSERT_WAS_UNDEFINED +#undef STBDS_ASSERT +#endif +#ifndef STBDS_ASSERT +#define STBDS_ASSERT assert +#include +#endif + +typedef struct { int key,b,c,d; } stbds_struct; +typedef struct { int key[2],b,c,d; } stbds_struct2; + +static char buffer[256]; +char *strkey(int n) +{ +#if defined(_WIN32) && defined(__STDC_WANT_SECURE_LIB__) + sprintf_s(buffer, sizeof(buffer), "test_%d", n); +#else + sprintf(buffer, "test_%d", n); +#endif + return buffer; +} + +void stbds_unit_tests(void) +{ +#if defined(_MSC_VER) && _MSC_VER <= 1200 && defined(__cplusplus) + // VC6 C++ doesn't like the template<> trick on unnamed structures, so do nothing! + STBDS_ASSERT(0); +#else + const int testsize = 100000; + const int testsize2 = testsize/20; + int *arr=NULL; + struct { int key; int value; } *intmap = NULL; + struct { char *key; int value; } *strmap = NULL, s; + struct { stbds_struct key; int value; } *map = NULL; + stbds_struct *map2 = NULL; + stbds_struct2 *map3 = NULL; + stbds_string_arena sa = { 0 }; + int key3[2] = { 1,2 }; + ptrdiff_t temp; + + int i,j; + + STBDS_ASSERT(arrlen(arr)==0); + for (i=0; i < 20000; i += 50) { + for (j=0; j < i; ++j) + arrpush(arr,j); + arrfree(arr); + } + + for (i=0; i < 4; ++i) { + arrpush(arr,1); arrpush(arr,2); arrpush(arr,3); arrpush(arr,4); + arrdel(arr,i); + arrfree(arr); + arrpush(arr,1); arrpush(arr,2); arrpush(arr,3); arrpush(arr,4); + arrdelswap(arr,i); + arrfree(arr); + } + + for (i=0; i < 5; ++i) { + arrpush(arr,1); arrpush(arr,2); arrpush(arr,3); arrpush(arr,4); + stbds_arrins(arr,i,5); + STBDS_ASSERT(arr[i] == 5); + if (i < 4) + STBDS_ASSERT(arr[4] == 4); + arrfree(arr); + } + + i = 1; + STBDS_ASSERT(hmgeti(intmap,i) == -1); + hmdefault(intmap, -2); + STBDS_ASSERT(hmgeti(intmap, i) == -1); + STBDS_ASSERT(hmget (intmap, i) == -2); + for (i=0; i < testsize; i+=2) + hmput(intmap, i, i*5); + for (i=0; i < testsize; i+=1) { + if (i & 1) STBDS_ASSERT(hmget(intmap, i) == -2 ); + else STBDS_ASSERT(hmget(intmap, i) == i*5); + if (i & 1) STBDS_ASSERT(hmget_ts(intmap, i, temp) == -2 ); + else STBDS_ASSERT(hmget_ts(intmap, i, temp) == i*5); + } + for (i=0; i < testsize; i+=2) + hmput(intmap, i, i*3); + for (i=0; i < testsize; i+=1) + if (i & 1) STBDS_ASSERT(hmget(intmap, i) == -2 ); + else STBDS_ASSERT(hmget(intmap, i) == i*3); + for (i=2; i < testsize; i+=4) + hmdel(intmap, i); // delete half the entries + for (i=0; i < testsize; i+=1) + if (i & 3) STBDS_ASSERT(hmget(intmap, i) == -2 ); + else STBDS_ASSERT(hmget(intmap, i) == i*3); + for (i=0; i < testsize; i+=1) + hmdel(intmap, i); // delete the rest of the entries + for (i=0; i < testsize; i+=1) + STBDS_ASSERT(hmget(intmap, i) == -2 ); + hmfree(intmap); + for (i=0; i < testsize; i+=2) + hmput(intmap, i, i*3); + hmfree(intmap); + + #if defined(__clang__) || defined(__GNUC__) + #ifndef __cplusplus + intmap = NULL; + hmput(intmap, 15, 7); + hmput(intmap, 11, 3); + hmput(intmap, 9, 5); + STBDS_ASSERT(hmget(intmap, 9) == 5); + STBDS_ASSERT(hmget(intmap, 11) == 3); + STBDS_ASSERT(hmget(intmap, 15) == 7); + #endif + #endif + + for (i=0; i < testsize; ++i) + stralloc(&sa, strkey(i)); + strreset(&sa); + + { + s.key = "a", s.value = 1; + shputs(strmap, s); + STBDS_ASSERT(*strmap[0].key == 'a'); + STBDS_ASSERT(strmap[0].key == s.key); + STBDS_ASSERT(strmap[0].value == s.value); + shfree(strmap); + } + + { + s.key = "a", s.value = 1; + sh_new_strdup(strmap); + shputs(strmap, s); + STBDS_ASSERT(*strmap[0].key == 'a'); + STBDS_ASSERT(strmap[0].key != s.key); + STBDS_ASSERT(strmap[0].value == s.value); + shfree(strmap); + } + + { + s.key = "a", s.value = 1; + sh_new_arena(strmap); + shputs(strmap, s); + STBDS_ASSERT(*strmap[0].key == 'a'); + STBDS_ASSERT(strmap[0].key != s.key); + STBDS_ASSERT(strmap[0].value == s.value); + shfree(strmap); + } + + for (j=0; j < 2; ++j) { + STBDS_ASSERT(shgeti(strmap,"foo") == -1); + if (j == 0) + sh_new_strdup(strmap); + else + sh_new_arena(strmap); + STBDS_ASSERT(shgeti(strmap,"foo") == -1); + shdefault(strmap, -2); + STBDS_ASSERT(shgeti(strmap,"foo") == -1); + for (i=0; i < testsize; i+=2) + shput(strmap, strkey(i), i*3); + for (i=0; i < testsize; i+=1) + if (i & 1) STBDS_ASSERT(shget(strmap, strkey(i)) == -2 ); + else STBDS_ASSERT(shget(strmap, strkey(i)) == i*3); + for (i=2; i < testsize; i+=4) + shdel(strmap, strkey(i)); // delete half the entries + for (i=0; i < testsize; i+=1) + if (i & 3) STBDS_ASSERT(shget(strmap, strkey(i)) == -2 ); + else STBDS_ASSERT(shget(strmap, strkey(i)) == i*3); + for (i=0; i < testsize; i+=1) + shdel(strmap, strkey(i)); // delete the rest of the entries + for (i=0; i < testsize; i+=1) + STBDS_ASSERT(shget(strmap, strkey(i)) == -2 ); + shfree(strmap); + } + + { + struct { char *key; char value; } *hash = NULL; + char name[4] = "jen"; + shput(hash, "bob" , 'h'); + shput(hash, "sally" , 'e'); + shput(hash, "fred" , 'l'); + shput(hash, "jen" , 'x'); + shput(hash, "doug" , 'o'); + + shput(hash, name , 'l'); + shfree(hash); + } + + for (i=0; i < testsize; i += 2) { + stbds_struct s = { i,i*2,i*3,i*4 }; + hmput(map, s, i*5); + } + + for (i=0; i < testsize; i += 1) { + stbds_struct s = { i,i*2,i*3 ,i*4 }; + stbds_struct t = { i,i*2,i*3+1,i*4 }; + if (i & 1) STBDS_ASSERT(hmget(map, s) == 0); + else STBDS_ASSERT(hmget(map, s) == i*5); + if (i & 1) STBDS_ASSERT(hmget_ts(map, s, temp) == 0); + else STBDS_ASSERT(hmget_ts(map, s, temp) == i*5); + //STBDS_ASSERT(hmget(map, t.key) == 0); + } + + for (i=0; i < testsize; i += 2) { + stbds_struct s = { i,i*2,i*3,i*4 }; + hmputs(map2, s); + } + hmfree(map); + + for (i=0; i < testsize; i += 1) { + stbds_struct s = { i,i*2,i*3,i*4 }; + stbds_struct t = { i,i*2,i*3+1,i*4 }; + if (i & 1) STBDS_ASSERT(hmgets(map2, s.key).d == 0); + else STBDS_ASSERT(hmgets(map2, s.key).d == i*4); + //STBDS_ASSERT(hmgetp(map2, t.key) == 0); + } + hmfree(map2); + + for (i=0; i < testsize; i += 2) { + stbds_struct2 s = { { i,i*2 }, i*3,i*4, i*5 }; + hmputs(map3, s); + } + for (i=0; i < testsize; i += 1) { + stbds_struct2 s = { { i,i*2}, i*3, i*4, i*5 }; + stbds_struct2 t = { { i,i*2}, i*3+1, i*4, i*5 }; + if (i & 1) STBDS_ASSERT(hmgets(map3, s.key).d == 0); + else STBDS_ASSERT(hmgets(map3, s.key).d == i*5); + //STBDS_ASSERT(hmgetp(map3, t.key) == 0); + } +#endif +} +#endif + + +/* +------------------------------------------------------------------------------ +This software is available under 2 licenses -- choose whichever you prefer. +------------------------------------------------------------------------------ +ALTERNATIVE A - MIT License +Copyright (c) 2019 Sean Barrett +Permission is hereby granted, free of charge, to any person obtaining a copy of +this software and associated documentation files (the "Software"), to deal in +the Software without restriction, including without limitation the rights to +use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies +of the Software, and to permit persons to whom the Software is furnished to do +so, subject to the following conditions: +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. +------------------------------------------------------------------------------ +ALTERNATIVE B - Public Domain (www.unlicense.org) +This is free and unencumbered software released into the public domain. +Anyone is free to copy, modify, publish, use, compile, sell, or distribute this +software, either in source code form or as a compiled binary, for any purpose, +commercial or non-commercial, and by any means. +In jurisdictions that recognize copyright laws, the author or authors of this +software dedicate any and all copyright interest in the software to the public +domain. We make this dedication for the benefit of the public at large and to +the detriment of our heirs and successors. We intend this dedication to be an +overt act of relinquishment in perpetuity of all present and future rights to +this software under copyright law. +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN +ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION +WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. +------------------------------------------------------------------------------ +*/ diff --git a/wrapper/c/src/wrapper.cpp b/wrapper/c/src/wrapper.cpp index e3fa2f9b..2d4e8cf5 100644 --- a/wrapper/c/src/wrapper.cpp +++ b/wrapper/c/src/wrapper.cpp @@ -2,9 +2,28 @@ #include "oopetris_wrapper.h" + +#if defined(__GNUC__) +#pragma GCC diagnostic push +#pragma GCC diagnostic ignored "-Wmissing-field-initializers" +#endif + +#define STB_DS_IMPLEMENTATION +#define STBDS_NO_SHORT_NAMES +#define STBDS_SIPHASH_2_4 + +#include "./thirdparty/stb_ds.h" + + +#if defined(__GNUC__) +#pragma GCC diagnostic pop +#endif + + #include #include #include +#include bool oopetris_is_recording_file(const char* file_path) { @@ -60,11 +79,338 @@ construct_error_from_string(OOPetrisRecordingReturnValue* return_value, const st return construct_error_from_cstr_impl(return_value, value.c_str(), value.size()); } + +typedef enum : uint8_t { + OOPetrisAdditionalInformationType_String = 0, + OOPetrisAdditionalInformationType_Float, + OOPetrisAdditionalInformationType_Double, + OOPetrisAdditionalInformationType_Bool, + OOPetrisAdditionalInformationType_U8, + OOPetrisAdditionalInformationType_I8, + OOPetrisAdditionalInformationType_U32, + OOPetrisAdditionalInformationType_I32, + OOPetrisAdditionalInformationType_U64, + OOPetrisAdditionalInformationType_I64, + OOPetrisAdditionalInformationType_Vector, +} OOPetrisAdditionalInformationType; + +typedef struct OOPetrisAdditionalInformationFieldImpl OOPetrisAdditionalInformationField; + +struct OOPetrisAdditionalInformationFieldImpl { + OOPetrisAdditionalInformationType type; + union { + char* string; + float float_v; + double double_v; + bool bool_v; + uint8_t u8; + int8_t i8; + uint32_t u32; + int32_t i32; + uint64_t u64; + int64_t i64; + OOPetrisAdditionalInformationField** vector; + } value; +}; + +struct OOPetrisAdditionalInformationImpl { + char* key; + OOPetrisAdditionalInformationField* value; +}; + +static void vector_of_value_free(OOPetrisAdditionalInformationField*** vector, size_t until_index); + +static OOPetrisAdditionalInformationField* information_value_to_c(const recorder::InformationValue& value) { + + + auto* return_value = + static_cast(malloc(sizeof(OOPetrisAdditionalInformationField))); + + + if (return_value == nullptr) { + free(return_value); + return nullptr; + } + + return std::visit( + helper::overloaded{ [return_value](const std::string& value) -> OOPetrisAdditionalInformationField* { + auto* string = static_cast(malloc(value.size() + 1)); + + if (string == nullptr) { + free(string); + free(return_value); + return nullptr; + } + + strcpy(string, value.c_str()); + + return_value->type = OOPetrisAdditionalInformationType_String; + return_value->value.string = string; + return return_value; + }, + [return_value](const float& value) -> OOPetrisAdditionalInformationField* { + return_value->type = OOPetrisAdditionalInformationType_Float; + return_value->value.float_v = value; + return return_value; + }, + [return_value](const double& value) -> OOPetrisAdditionalInformationField* { + return_value->type = OOPetrisAdditionalInformationType_Double; + return_value->value.double_v = value; + return return_value; + }, + [return_value](const bool& value) -> OOPetrisAdditionalInformationField* { + return_value->type = OOPetrisAdditionalInformationType_Bool; + return_value->value.bool_v = value; + return return_value; + }, + [return_value](const u8& value) { + return_value->type = OOPetrisAdditionalInformationType_U8; + return_value->value.u8 = value; + return return_value; + }, + [return_value](const i8& value) -> OOPetrisAdditionalInformationField* { + return_value->type = OOPetrisAdditionalInformationType_I8; + return_value->value.i8 = value; + return return_value; + }, + [return_value](const u32& value) { + return_value->type = OOPetrisAdditionalInformationType_U32; + return_value->value.u32 = value; + return return_value; + }, + [return_value](const i32& value) -> OOPetrisAdditionalInformationField* { + return_value->type = OOPetrisAdditionalInformationType_I32; + return_value->value.i32 = value; + return return_value; + }, + [return_value](const u64& value) { + return_value->type = OOPetrisAdditionalInformationType_U64; + return_value->value.u64 = value; + return return_value; + }, + [return_value](const i64& value) -> OOPetrisAdditionalInformationField* { + return_value->type = OOPetrisAdditionalInformationType_Float; + return_value->value.i64 = value; + return return_value; + }, + [return_value](const std::vector& value + ) -> OOPetrisAdditionalInformationField* { + OOPetrisAdditionalInformationField** fields = NULL; + + + stbds_arrsetlen(fields, value.size()); + + for (std::size_t i = 0; i < value.size(); ++i) { + auto* result = information_value_to_c(value.at(i)); + if (result == nullptr) { + vector_of_value_free(&fields, i); + free(return_value); + return nullptr; + } + fields[i] = result; + } + + return_value->type = OOPetrisAdditionalInformationType_Vector; + return_value->value.vector = fields; + + return return_value; + } }, + value.underlying() + ); +} + +static void free_additional_value_field(OOPetrisAdditionalInformationField** field) { + + auto* orig_field = *field; + + if (orig_field->type == OOPetrisAdditionalInformationType_String) { + free(orig_field->value.string); + } else if (orig_field->type == OOPetrisAdditionalInformationType_Vector) { + auto* vector = orig_field->value.vector; + vector_of_value_free(&vector, stbds_arrlenu(vector)); + } + + + free(*field); + *field = NULL; +} + + +static void vector_of_value_free(OOPetrisAdditionalInformationField*** vector, size_t until_index) { + + + for (size_t i = 0; i < until_index; ++i) { + free_additional_value_field(&(*vector)[i]); + } + + + stbds_arrfree(*vector); + *vector = NULL; +} + + +static OOPetrisAdditionalInformation* recording_reader_get_additional_information( + const recorder::AdditionalInformation& information +) { + + stbds_rand_seed(time(NULL)); + + OOPetrisAdditionalInformation* result = NULL; + + //NOTE: We use stbds_sh_new_strdup, so keys are automatically copied (malloced) and freed and we don't need to manage those + stbds_sh_new_strdup(result); + + + for (const auto& [key, value] : information) { + + auto* insert_value = information_value_to_c(value); + + stbds_shput(result, key.c_str(), insert_value); + } + + return result; +} + +const char** oopetris_additional_information_get_keys(OOPetrisAdditionalInformation* information) { + + const char** result_arr = NULL; + + const auto length = stbds_shlen(information); + + stbds_arrsetlen(result_arr, length); + + for (int i = 0; i < length; ++i) { + + result_arr[i] = information[i].key; + } + + + return result_arr; +} + +void oopetris_additional_information_keys_free(const char*** keys) { + stbds_arrfree(*keys); + *keys = NULL; +} + + +static void oopetris_additional_information_free(OOPetrisAdditionalInformation** information) { + + + for (int i = 0; i < stbds_shlen(*information); ++i) { + + free_additional_value_field(&((*information)[i].value)); + } + + stbds_shfree(*information); + *information = NULL; +} + +static OOPetrisTetrionRecord record_to_c(const recorder::Record& record) { + return OOPetrisTetrionRecord{ .simulation_step_index = record.simulation_step_index, + .event = static_cast(record.event), + .tetrion_index = record.tetrion_index }; +} + +static OOPetrisMino mino_to_c(const Mino& mino) { + auto orig_pos = mino.position(); + + auto position = OOpetrisMinoPosition{ .x = orig_pos.x, .y = orig_pos.y }; + + return OOPetrisMino{ .position = position, .type = static_cast(mino.type()) }; +} + +static OOpetrisTetrionSnapshot snapshot_to_c(const TetrionSnapshot& snapshot) { + + + // convert mino_stack + + auto minos = snapshot.mino_stack().minos(); + + OOPetrisMino* mino_stack = NULL; + stbds_arrsetlen(mino_stack, minos.size()); + + for (std::size_t i = 0; i < minos.size(); ++i) { + mino_stack[i] = mino_to_c(minos.at(i)); + } + + + return OOpetrisTetrionSnapshot{ .level = snapshot.level(), + .mino_stack = mino_stack, + .score = snapshot.score(), + .simulation_step_index = snapshot.simulation_step_index(), + .lines_cleared = snapshot.lines_cleared(), + .tetrion_index = snapshot.tetrion_index() }; +} + +static OOPetrisTetrionHeader tetrion_header_to_c(const recorder::TetrionHeader& header) { + + + return OOPetrisTetrionHeader{ .seed = header.seed, .starting_level = header.starting_level }; +} + + +static OOPetrisRecordingInformation* recording_reader_to_c(const recorder::RecordingReader& value) { + + auto* return_value = static_cast(malloc(sizeof(OOPetrisRecordingInformation))); + + + if (return_value == nullptr) { + free(return_value); + return nullptr; + } + + return_value->version = recorder::Recording::current_supported_version_number; + + return_value->information = recording_reader_get_additional_information(value.information()); + if (return_value->information == nullptr) { + free(return_value); + return nullptr; + } + + // convert records + + auto records = value.records(); + + return_value->records = NULL; + stbds_arrsetlen(return_value->records, records.size()); + + for (std::size_t i = 0; i < records.size(); ++i) { + return_value->records[i] = record_to_c(records.at(i)); + } + + // convert snapshots + + auto snapshots = value.snapshots(); + + return_value->snapshots = NULL; + stbds_arrsetlen(return_value->snapshots, snapshots.size()); + + for (std::size_t i = 0; i < snapshots.size(); ++i) { + return_value->snapshots[i] = snapshot_to_c(snapshots.at(i)); + } + + // convert tetrion_headers + + auto tetrion_headers = value.tetrion_headers(); + + return_value->records = NULL; + stbds_arrsetlen(return_value->tetrion_headers, tetrion_headers.size()); + + for (std::size_t i = 0; i < tetrion_headers.size(); ++i) { + return_value->tetrion_headers[i] = tetrion_header_to_c(tetrion_headers.at(i)); + } + + return return_value; +} + + OOPetrisRecordingReturnValue* oopetris_get_recording_information(const char* file_path) { auto* return_value = static_cast(malloc(sizeof(OOPetrisRecordingReturnValue))); if (return_value == nullptr) { + free(return_value); return nullptr; } @@ -94,9 +440,15 @@ OOPetrisRecordingReturnValue* oopetris_get_recording_information(const char* fil const auto recording_reader = std::move(parsed.value()); + OOPetrisRecordingInformation* information = recording_reader_to_c(recording_reader); - //TODO - return nullptr; + if (information == nullptr) { + return construct_error_from_cstr(return_value, "Failure in internal conversion"); + } + + return_value->is_error = false; + return_value->value.information = information; + return return_value; } bool oopetris_is_error(OOPetrisRecordingReturnValue* value) { @@ -112,7 +464,15 @@ OOPetrisRecordingInformation* oopetris_get_information(OOPetrisRecordingReturnVa } void oopetris_free_recording_information(OOPetrisRecordingInformation** information) { - //TODO: improve + + oopetris_additional_information_free(&((*information)->information)); + + stbds_arrfree((*information)->records); + + stbds_arrfree((*information)->snapshots); + + stbds_arrfree((*information)->tetrion_headers); + free(*information); *information = nullptr; } From 4322219a9f9dc16bf0f252ffde6f878735e1e578 Mon Sep 17 00:00:00 2001 From: Totto16 Date: Fri, 21 Jun 2024 18:15:07 +0200 Subject: [PATCH 06/11] Wrapper: C: - add tests for oopetris_get_recording_information - add example, that does nothing special atm --- wrapper/c/example/main.c | 43 ++++++++++++ wrapper/c/example/meson.build | 13 ++++ wrapper/c/meson.build | 4 ++ wrapper/c/meson.options | 7 ++ wrapper/c/src/wrapper.cpp | 2 +- wrapper/c/tests/get_recording_information.c | 75 +++++++++++++++++++++ wrapper/c/tests/meson.build | 1 + 7 files changed, 144 insertions(+), 1 deletion(-) create mode 100644 wrapper/c/example/main.c create mode 100644 wrapper/c/example/meson.build create mode 100644 wrapper/c/tests/get_recording_information.c diff --git a/wrapper/c/example/main.c b/wrapper/c/example/main.c new file mode 100644 index 00000000..27eb2c82 --- /dev/null +++ b/wrapper/c/example/main.c @@ -0,0 +1,43 @@ + +#include +#include +#include + +int main(int argc, char** argv) { + + + if (argc != 2) { + fprintf(stderr, "usage: %s \n", argv[0]); + return EXIT_FAILURE; + } + + const char* file = argv[1]; + + const bool is_recordings_file = oopetris_is_recording_file(file); + + if (!is_recordings_file) { + fprintf(stderr, "Input file is no recordings file!\n"); + return EXIT_FAILURE; + } + + OOPetrisRecordingReturnValue* return_value = oopetris_get_recording_information(file); + + const bool is_error = oopetris_is_error(return_value); + + if (is_error) { + const char* error = oopetris_get_error(return_value); + fprintf(stderr, "An error occured: %s\n", error); + oopetris_free_recording_value_whole(&return_value); + return EXIT_FAILURE; + } + + OOPetrisRecordingInformation* information = oopetris_get_information(return_value); + + oopetris_free_recording_value_only(&return_value); + + //TODO: do something with information + + oopetris_free_recording_information(&information); + + return EXIT_SUCCESS; +} diff --git a/wrapper/c/example/meson.build b/wrapper/c/example/meson.build new file mode 100644 index 00000000..99e22341 --- /dev/null +++ b/wrapper/c/example/meson.build @@ -0,0 +1,13 @@ + +example = executable( + 'example', + files( + 'main.c', + ), + dependencies: [liboopetris_c_wrapper_dep], + override_options: { + 'warning_level': '3', + 'werror': true, + 'b_coverage': false, + }, +) diff --git a/wrapper/c/meson.build b/wrapper/c/meson.build index 591bdccf..e1d2cc4d 100644 --- a/wrapper/c/meson.build +++ b/wrapper/c/meson.build @@ -56,3 +56,7 @@ pkg.generate( if get_option('tests') subdir('tests') endif + +if get_option('example') + subdir('example') +endif diff --git a/wrapper/c/meson.options b/wrapper/c/meson.options index c16616f6..a1a48187 100644 --- a/wrapper/c/meson.options +++ b/wrapper/c/meson.options @@ -4,3 +4,10 @@ option( value: false, description: 'whether or not tests should be built', ) + +option( + 'example', + type: 'boolean', + value: false, + description: 'whether or not the example should be built', +) diff --git a/wrapper/c/src/wrapper.cpp b/wrapper/c/src/wrapper.cpp index 2d4e8cf5..89cda09a 100644 --- a/wrapper/c/src/wrapper.cpp +++ b/wrapper/c/src/wrapper.cpp @@ -394,7 +394,7 @@ static OOPetrisRecordingInformation* recording_reader_to_c(const recorder::Recor auto tetrion_headers = value.tetrion_headers(); - return_value->records = NULL; + return_value->tetrion_headers = NULL; stbds_arrsetlen(return_value->tetrion_headers, tetrion_headers.size()); for (std::size_t i = 0; i < tetrion_headers.size(); ++i) { diff --git a/wrapper/c/tests/get_recording_information.c b/wrapper/c/tests/get_recording_information.c new file mode 100644 index 00000000..f5b65801 --- /dev/null +++ b/wrapper/c/tests/get_recording_information.c @@ -0,0 +1,75 @@ +#include + +#include +#include + +Test(GetRecordingInformation, NullptrAsArgument) { + OOPetrisRecordingReturnValue* return_value = oopetris_get_recording_information(NULL); + cr_assert(return_value != NULL, "NULL is supported and returns an error"); + + + const bool is_error = oopetris_is_error(return_value); + + cr_assert(is_error, "Non existent recordings file is error"); + + const char* error = oopetris_get_error(return_value); + + char* dynamic_error = malloc(strlen(error) + 1); + strcpy(dynamic_error, error); + + cr_assert(eq(str, dynamic_error, "FilePath is NULL")); + free(dynamic_error); +} + + +Test(GetRecordingInformation, NonExistentFile) { + OOPetrisRecordingReturnValue* return_value = oopetris_get_recording_information("./NON_EXISTENT_FILE"); + cr_assert(return_value != NULL, "Non existent recordings file is detected correctly"); + + const bool is_error = oopetris_is_error(return_value); + + cr_assert(is_error, "Non existent recordings file is error"); + + const char* error = oopetris_get_error(return_value); + + char* dynamic_error = malloc(strlen(error) + 1); + strcpy(dynamic_error, error); + + cr_assert(eq(str, dynamic_error, "File './NON_EXISTENT_FILE' doesn't exist!")); + free(dynamic_error); +} + +Test(GetRecordingInformation, IncorrectFile) { + + OOPetrisRecordingReturnValue* return_value = oopetris_get_recording_information("./incorrect.rec"); + cr_assert(return_value != NULL, "Incorrect recordings file is detected correctly"); + + const bool is_error = oopetris_is_error(return_value); + + cr_assert(is_error, "Incorrect recordings file is error"); + + const char* error = oopetris_get_error(return_value); + + char* dynamic_error = malloc(strlen(error) + 1); + strcpy(dynamic_error, error); + + cr_assert( + eq(str, dynamic_error, + "An error occurred during parsing of the recording file './incorrect.rec': magic file bytes are not " + "correct, this is either an old format or no recording at all") + ); + free(dynamic_error); +} + + +Test(GetRecordingInformation, CorrectFile) { + + OOPetrisRecordingReturnValue* return_value = oopetris_get_recording_information("./correct.rec"); + cr_assert(return_value != NULL, "Correct recordings file is detected correctly"); + + const bool is_not_error = !oopetris_is_error(return_value); + + const char* maybe_error = is_not_error ? "" : oopetris_get_error(return_value); + + cr_assert(is_not_error, "Correct recordings file isn't an error: %s", maybe_error); +} diff --git a/wrapper/c/tests/meson.build b/wrapper/c/tests/meson.build index bc40127b..a3d35af0 100644 --- a/wrapper/c/tests/meson.build +++ b/wrapper/c/tests/meson.build @@ -2,6 +2,7 @@ test_deps = [] test_src = [ files( + 'get_recording_information.c', 'information.c', 'is_recording_file.c', ), From 7a60c261a5bbbfb42468b9b5736af33074b5bcb6 Mon Sep 17 00:00:00 2001 From: Totto16 Date: Fri, 21 Jun 2024 18:19:10 +0200 Subject: [PATCH 07/11] Wrapper: C: - fix memory leak --- wrapper/c/src/wrapper.cpp | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/wrapper/c/src/wrapper.cpp b/wrapper/c/src/wrapper.cpp index 89cda09a..421df4d9 100644 --- a/wrapper/c/src/wrapper.cpp +++ b/wrapper/c/src/wrapper.cpp @@ -469,6 +469,12 @@ void oopetris_free_recording_information(OOPetrisRecordingInformation** informat stbds_arrfree((*information)->records); + + for (std::size_t i = 0; i < stbds_arrlenu((*information)->snapshots); ++i) { + const auto* mino_stack = (*information)->snapshots[i].mino_stack; + stbds_arrfree(mino_stack); + } + stbds_arrfree((*information)->snapshots); stbds_arrfree((*information)->tetrion_headers); From b151cce3811518bbbf7412b036532ac67b6ae799 Mon Sep 17 00:00:00 2001 From: Totto16 Date: Fri, 21 Jun 2024 20:19:41 +0200 Subject: [PATCH 08/11] Wrapper: C: - improve examples, by printing the whole information - add more functions, to work with additional information in c - add (void) in c functions, where no arguments are expected --- wrapper/c/example/main.c | 259 +++++++++++++++++++- wrapper/c/meson.build | 1 + wrapper/c/src/meson.build | 6 + wrapper/c/src/oopetris_wrapper.h | 69 +++++- wrapper/c/src/wrapper.cpp | 107 ++++++-- wrapper/c/tests/get_recording_information.c | 4 +- wrapper/c/tests/information.c | 2 +- wrapper/c/tests/is_recording_file.c | 2 +- 8 files changed, 418 insertions(+), 32 deletions(-) diff --git a/wrapper/c/example/main.c b/wrapper/c/example/main.c index 27eb2c82..7ac12f32 100644 --- a/wrapper/c/example/main.c +++ b/wrapper/c/example/main.c @@ -1,7 +1,262 @@ -#include +#include "oopetris_wrapper.h" +#include +#include #include #include +#include + +#include "oopetris_wrapper.h" + + +// usage of a "typeof c++ operator in C, it's not the same, but it can do some stuff, first seen +// this in VO Eidp (Einführung in die Programmierung - PS 11)", _Generic makes this possible :) + +void print_bool(bool val) { + printf("%s", val ? "true" : "false"); +} + + +void print_u8(uint8_t x) { + printf("%" PRIu8, x); +} + +void print_i8(int8_t x) { + printf("%" PRIi8, x); +} + +void print_u32(uint32_t x) { + printf("%" PRIu32, x); +} + +void print_i32(int32_t x) { + printf("%" PRIi32, x); +} + +void print_u64(uint64_t x) { + printf("%" PRIu64, x); +} + +void print_i64(int64_t x) { + printf("%" PRIi64, x); +} + +void print_float(float x) { + printf("%f", x); +} + +void print_double(double x) { + printf("%f", x); +} + +void print_string(const char* x) { + printf("%s", x); +} + + +void print_field(const OOPetrisAdditionalInformationField* const field); + +void print_vector(const OOPetrisAdditionalInformationField* const* const field) { + + printf("\n"); + for (size_t i = 0; i < stbds_arrlenu(field); ++i) { + print_field(field[i]); + printf("\n"); + } +} + +// clang-format off +#define PRINT_VALUE(val) \ + _Generic((val),\ + _Bool : print_bool,\ + uint8_t : print_u8, \ + int8_t : print_i8,\ + uint32_t : print_u32,\ + int32_t : print_i32,\ + uint64_t : print_u64,\ + int64_t : print_i64,\ + float : print_float,\ + double : print_double,\ + const char* : print_string,\ + const OOPetrisAdditionalInformationField* const* : print_vector)(val) +// clang-format on + + +void print_field(const OOPetrisAdditionalInformationField* const field) { + switch (oopetris_additional_information_field_get_type(field)) { + case OOPetrisAdditionalInformationType_String: + PRINT_VALUE(oopetris_additional_information_field_get_string(field)); + return; + case OOPetrisAdditionalInformationType_Float: + PRINT_VALUE(oopetris_additional_information_field_get_float(field)); + return; + case OOPetrisAdditionalInformationType_Double: + PRINT_VALUE(oopetris_additional_information_field_get_double(field)); + return; + case OOPetrisAdditionalInformationType_Bool: + PRINT_VALUE(oopetris_additional_information_field_get_bool(field)); + return; + case OOPetrisAdditionalInformationType_U8: + PRINT_VALUE(oopetris_additional_information_field_get_u8(field)); + return; + case OOPetrisAdditionalInformationType_I8: + PRINT_VALUE(oopetris_additional_information_field_get_i8(field)); + return; + case OOPetrisAdditionalInformationType_U32: + PRINT_VALUE(oopetris_additional_information_field_get_u32(field)); + return; + case OOPetrisAdditionalInformationType_I32: + PRINT_VALUE(oopetris_additional_information_field_get_i32(field)); + return; + case OOPetrisAdditionalInformationType_U64: + PRINT_VALUE(oopetris_additional_information_field_get_u64(field)); + return; + case OOPetrisAdditionalInformationType_I64: + PRINT_VALUE(oopetris_additional_information_field_get_i64(field)); + return; + case OOPetrisAdditionalInformationType_Vector: + PRINT_VALUE(oopetris_additional_information_field_get_vector(field)); + return; + + default: + assert(false && "UNREACHABLE"); + return; + } +} + +void print_tetrion_header(const OOPetrisTetrionHeader* const header) { + + printf("seed: %" PRIu64 "\tstarting_level: %" PRIu32 "\n", header->seed, header->starting_level); +} + +const char* input_event_string(OOPetrisInputEvent event) { + switch (event) { + case OOPetrisInputEvent_RotateLeftPressed: + return "RotateLeftPressed"; + case OOPetrisInputEvent_RotateRightPressed: + return "RotateRightPressed"; + case OOPetrisInputEvent_MoveLeftPressed: + return "MoveLeftPressed"; + case OOPetrisInputEvent_MoveRightPressed: + return "MoveRightPressed"; + case OOPetrisInputEvent_MoveDownPressed: + return "MoveDownPressed"; + case OOPetrisInputEvent_DropPressed: + return "DropPressed"; + case OOPetrisInputEvent_HoldPressed: + return "HoldPressed"; + case OOPetrisInputEvent_RotateLeftReleased: + return "RotateLeftReleased"; + case OOPetrisInputEvent_RotateRightReleased: + return "RotateRightReleased"; + case OOPetrisInputEvent_MoveLeftReleased: + return "MoveLeftReleased"; + case OOPetrisInputEvent_MoveRightReleased: + return "MoveRightReleased"; + case OOPetrisInputEvent_MoveDownReleased: + return "MoveDownReleased"; + case OOPetrisInputEvent_DropReleased: + return "DropReleased"; + case OOPetrisInputEvent_HoldReleased: + return "HoldReleased"; + default: + assert(false && "UNREACHABLE"); + return ""; + } +} + +void print_record(const OOPetrisTetrionRecord* const record) { + printf("simulation_step_index: %" PRIu64 "\ttetrion_index: %" PRIu8 "\tevent: %s\n", record->simulation_step_index, + record->tetrion_index, input_event_string(record->event)); +} + +void print_mino_stack(const OOPetrisMino* const stack) { + + OOPetrisGridProperties* properties = oopetris_get_grid_properties(); + + if (properties == NULL) { + return; + } + + const size_t buffer_size = properties->height * properties->width; + + char* buffer = malloc(buffer_size); + + if (buffer == NULL) { + return; + } + + memset(buffer, '.', buffer_size); + + for (size_t i = 0; i < stbds_arrlenu(stack); ++i) { + const OOpetrisMinoPosition position = stack[i].position; + buffer[position.x + (position.y * properties->width)] = '#'; + } + + + for (size_t y = 0; y < properties->height; ++y) { + int result = write(STDOUT_FILENO, buffer + (y * properties->width), properties->width); + if (result < 0) { + free(buffer); + return; + } + printf("\n"); + } + + free(buffer); + oopetris_free_grid_properties(&properties); +} + +void print_snapshot(const OOpetrisTetrionSnapshot* const snapshot) { + printf("\tsimulation_step_index: %" PRIu64 "\ttetrion_index: %" PRIu8 "\n", snapshot->simulation_step_index, + snapshot->tetrion_index); + + printf("\tlevel: %" PRIu32 "\tscore: %" PRIu64 "\tlines_cleared: %" PRIu32 "\n", snapshot->level, snapshot->score, + snapshot->lines_cleared); + + print_mino_stack(snapshot->mino_stack); +} + + +void print_recording_information(const OOPetrisRecordingInformation* const information) { + + printf("Version: %d\n\n", information->version); + printf("Additional Information:\n"); + + const char** keys = oopetris_additional_information_get_keys(information->information); + + for (size_t i = 0; i < stbds_arrlenu(keys); ++i) { + printf("\t%s: ", keys[i]); + print_field(oopetris_additional_information_get_field(information->information, keys[i])); + printf("\n"); + } + printf("\n"); + + oopetris_additional_information_keys_free(&keys); + + printf("Headers:\n"); + + for (size_t i = 0; i < stbds_arrlenu(information->tetrion_headers); ++i) { + printf("\t"); + print_tetrion_header(&(information->tetrion_headers[i])); + } + printf("\n"); + + printf("Records:\n"); + + for (size_t i = 0; i < stbds_arrlenu(information->records); ++i) { + printf("\t"); + print_record(&(information->records[i])); + } + printf("\n"); + + printf("Snapshots:\n"); + + for (size_t i = 0; i < stbds_arrlenu(information->snapshots); ++i) { + print_snapshot(&(information->snapshots[i])); + } + printf("\n"); +} int main(int argc, char** argv) { @@ -35,7 +290,7 @@ int main(int argc, char** argv) { oopetris_free_recording_value_only(&return_value); - //TODO: do something with information + print_recording_information(information); oopetris_free_recording_information(&information); diff --git a/wrapper/c/meson.build b/wrapper/c/meson.build index e1d2cc4d..20f5fa21 100644 --- a/wrapper/c/meson.build +++ b/wrapper/c/meson.build @@ -40,6 +40,7 @@ liboopetris_c_wrapper_dep = declare_dependency( link_with: liboopetris_c_wrapper, dependencies: deps, version: meson.project_version(), + include_directories: include_directories('src'), ) meson.override_dependency('liboopetris-c-wrapper', liboopetris_c_wrapper_dep) diff --git a/wrapper/c/src/meson.build b/wrapper/c/src/meson.build index 92b7c142..6200b52b 100644 --- a/wrapper/c/src/meson.build +++ b/wrapper/c/src/meson.build @@ -7,4 +7,10 @@ install_headers( preserve_path: true, ) +install_headers( + files('thirdparty/stb_ds.h'), + install_dir: c_wrapper_include_dir / 'thirdparty', + preserve_path: true, +) + src_files += files('wrapper.cpp') diff --git a/wrapper/c/src/oopetris_wrapper.h b/wrapper/c/src/oopetris_wrapper.h index 78eaf8e5..c3aba062 100644 --- a/wrapper/c/src/oopetris_wrapper.h +++ b/wrapper/c/src/oopetris_wrapper.h @@ -2,13 +2,18 @@ #pragma once +// assure we only include the header and with correct defines +#ifndef STBDS_NO_SHORT_NAMES #define STBDS_NO_SHORT_NAMES +#endif +#ifdef STB_DS_IMPLEMENTATION +#undef STB_DS_IMPLEMENTATION +#endif #include "./thirdparty/stb_ds.h" #ifdef __cplusplus extern "C" { -#else #endif #include #include @@ -24,16 +29,66 @@ bool oopetris_is_recording_file(const char* file_path); // opaque type typedef struct OOPetrisAdditionalInformationImpl OOPetrisAdditionalInformation; +// opaque type +typedef struct OOPetrisAdditionalInformationFieldImpl OOPetrisAdditionalInformationField; const char** oopetris_additional_information_get_keys(OOPetrisAdditionalInformation* information); void oopetris_additional_information_keys_free(const char*** keys); -//TODO: make functions to introspect this +const OOPetrisAdditionalInformationField* +oopetris_additional_information_get_field(OOPetrisAdditionalInformation* information, const char* key); + + +//TODO(): once we only support C23 (which also the compiled lib has to support ), add underlying enum type uint8_t +typedef enum { + OOPetrisAdditionalInformationType_String = 0, + OOPetrisAdditionalInformationType_Float, + OOPetrisAdditionalInformationType_Double, + OOPetrisAdditionalInformationType_Bool, + OOPetrisAdditionalInformationType_U8, + OOPetrisAdditionalInformationType_I8, + OOPetrisAdditionalInformationType_U32, + OOPetrisAdditionalInformationType_I32, + OOPetrisAdditionalInformationType_U64, + OOPetrisAdditionalInformationType_I64, + OOPetrisAdditionalInformationType_Vector, +} OOPetrisAdditionalInformationType; + + +OOPetrisAdditionalInformationType oopetris_additional_information_field_get_type( + const OOPetrisAdditionalInformationField* const field +); + +const char* oopetris_additional_information_field_get_string(const OOPetrisAdditionalInformationField* const field); + +float oopetris_additional_information_field_get_float(const OOPetrisAdditionalInformationField* const field); + +double oopetris_additional_information_field_get_double(const OOPetrisAdditionalInformationField* const field); +bool oopetris_additional_information_field_get_bool(const OOPetrisAdditionalInformationField* const field); -typedef enum : uint8_t { +uint8_t oopetris_additional_information_field_get_u8(const OOPetrisAdditionalInformationField* const field); + +int8_t oopetris_additional_information_field_get_i8(const OOPetrisAdditionalInformationField* const field); + +uint32_t oopetris_additional_information_field_get_u32(const OOPetrisAdditionalInformationField* const field); + + +int32_t oopetris_additional_information_field_get_i32(const OOPetrisAdditionalInformationField* const field); + +uint64_t oopetris_additional_information_field_get_u64(const OOPetrisAdditionalInformationField* const field); + +int64_t oopetris_additional_information_field_get_i64(const OOPetrisAdditionalInformationField* const field); + +const OOPetrisAdditionalInformationField* const* oopetris_additional_information_field_get_vector( + const OOPetrisAdditionalInformationField* const field +); + + +//TODO(): once we only support C23 (which also the compiled lib has to support ), add underlying enum type uint8_t +typedef enum { OOPetrisInputEvent_RotateLeftPressed = 0, OOPetrisInputEvent_RotateRightPressed, OOPetrisInputEvent_MoveLeftPressed, @@ -61,7 +116,9 @@ typedef struct { uint8_t y; } OOpetrisMinoPosition; -typedef enum : uint8_t { + +//TODO(): once we only support C23 (which also the compiled lib has to support ), add underlying enum type uint8_t +typedef enum { OOPetrisTetrominoType_I = 0, OOPetrisTetrominoType_J, OOPetrisTetrominoType_L, @@ -135,14 +192,14 @@ void oopetris_free_recording_value_only(OOPetrisRecordingReturnValue** informati void oopetris_free_recording_value_whole(OOPetrisRecordingReturnValue** information); -const char* oopetris_get_lib_version(); +const char* oopetris_get_lib_version(void); typedef struct { uint32_t height; uint32_t width; } OOPetrisGridProperties; -OOPetrisGridProperties* oopetris_get_grid_properties(); +OOPetrisGridProperties* oopetris_get_grid_properties(void); void oopetris_free_grid_properties(OOPetrisGridProperties** properties); diff --git a/wrapper/c/src/wrapper.cpp b/wrapper/c/src/wrapper.cpp index 421df4d9..ab8bce68 100644 --- a/wrapper/c/src/wrapper.cpp +++ b/wrapper/c/src/wrapper.cpp @@ -11,7 +11,6 @@ #define STB_DS_IMPLEMENTATION #define STBDS_NO_SHORT_NAMES #define STBDS_SIPHASH_2_4 - #include "./thirdparty/stb_ds.h" @@ -22,8 +21,8 @@ #include #include +#include #include -#include bool oopetris_is_recording_file(const char* file_path) { @@ -80,22 +79,6 @@ construct_error_from_string(OOPetrisRecordingReturnValue* return_value, const st } -typedef enum : uint8_t { - OOPetrisAdditionalInformationType_String = 0, - OOPetrisAdditionalInformationType_Float, - OOPetrisAdditionalInformationType_Double, - OOPetrisAdditionalInformationType_Bool, - OOPetrisAdditionalInformationType_U8, - OOPetrisAdditionalInformationType_I8, - OOPetrisAdditionalInformationType_U32, - OOPetrisAdditionalInformationType_I32, - OOPetrisAdditionalInformationType_U64, - OOPetrisAdditionalInformationType_I64, - OOPetrisAdditionalInformationType_Vector, -} OOPetrisAdditionalInformationType; - -typedef struct OOPetrisAdditionalInformationFieldImpl OOPetrisAdditionalInformationField; - struct OOPetrisAdditionalInformationFieldImpl { OOPetrisAdditionalInformationType type; union { @@ -293,6 +276,90 @@ void oopetris_additional_information_keys_free(const char*** keys) { *keys = NULL; } +const OOPetrisAdditionalInformationField* +oopetris_additional_information_get_field(OOPetrisAdditionalInformation* information, const char* key) { + + const auto index = stbds_shgeti(information, key); + + if (index < 0) { + return nullptr; + } + + return information[index].value; +} + + +OOPetrisAdditionalInformationType oopetris_additional_information_field_get_type( + const OOPetrisAdditionalInformationField* const field +) { + return field->type; +} + +const char* oopetris_additional_information_field_get_string(const OOPetrisAdditionalInformationField* const field) { + assert(oopetris_additional_information_field_get_type(field) == OOPetrisAdditionalInformationType_String); + return field->value.string; +} + +float oopetris_additional_information_field_get_float(const OOPetrisAdditionalInformationField* const field) { + assert(oopetris_additional_information_field_get_type(field) == OOPetrisAdditionalInformationType_Float); + return field->value.float_v; +} + +double oopetris_additional_information_field_get_double(const OOPetrisAdditionalInformationField* const field) { + assert(oopetris_additional_information_field_get_type(field) == OOPetrisAdditionalInformationType_Double); + return field->value.double_v; +} + + +bool oopetris_additional_information_field_get_bool(const OOPetrisAdditionalInformationField* const field) { + assert(oopetris_additional_information_field_get_type(field) == OOPetrisAdditionalInformationType_Bool); + return field->value.bool_v; +} + + +uint8_t oopetris_additional_information_field_get_u8(const OOPetrisAdditionalInformationField* const field) { + assert(oopetris_additional_information_field_get_type(field) == OOPetrisAdditionalInformationType_U8); + return field->value.u8; +} + + +int8_t oopetris_additional_information_field_get_i8(const OOPetrisAdditionalInformationField* const field) { + assert(oopetris_additional_information_field_get_type(field) == OOPetrisAdditionalInformationType_I8); + return field->value.i8; +} + + +uint32_t oopetris_additional_information_field_get_u32(const OOPetrisAdditionalInformationField* const field) { + assert(oopetris_additional_information_field_get_type(field) == OOPetrisAdditionalInformationType_U32); + return field->value.u32; +} + + +int32_t oopetris_additional_information_field_get_i32(const OOPetrisAdditionalInformationField* const field) { + assert(oopetris_additional_information_field_get_type(field) == OOPetrisAdditionalInformationType_I32); + return field->value.i32; +} + + +uint64_t oopetris_additional_information_field_get_u64(const OOPetrisAdditionalInformationField* const field) { + assert(oopetris_additional_information_field_get_type(field) == OOPetrisAdditionalInformationType_U64); + return field->value.u64; +} + + +int64_t oopetris_additional_information_field_get_i64(const OOPetrisAdditionalInformationField* const field) { + assert(oopetris_additional_information_field_get_type(field) == OOPetrisAdditionalInformationType_I64); + return field->value.i64; +} + + +const OOPetrisAdditionalInformationField* const* oopetris_additional_information_field_get_vector( + const OOPetrisAdditionalInformationField* const field +) { + assert(oopetris_additional_information_field_get_type(field) == OOPetrisAdditionalInformationType_Vector); + return field->value.vector; +} + static void oopetris_additional_information_free(OOPetrisAdditionalInformation** information) { @@ -498,11 +565,11 @@ void oopetris_free_recording_value_whole(OOPetrisRecordingReturnValue** informat oopetris_free_recording_value_only(information); } -const char* oopetris_get_lib_version() { +const char* oopetris_get_lib_version(void) { return utils::version(); } -OOPetrisGridProperties* oopetris_get_grid_properties() { +OOPetrisGridProperties* oopetris_get_grid_properties(void) { auto* properties = static_cast(malloc(sizeof(OOPetrisGridProperties))); if (properties == nullptr) { return nullptr; diff --git a/wrapper/c/tests/get_recording_information.c b/wrapper/c/tests/get_recording_information.c index f5b65801..fd51c683 100644 --- a/wrapper/c/tests/get_recording_information.c +++ b/wrapper/c/tests/get_recording_information.c @@ -1,7 +1,7 @@ #include - #include -#include + +#include "oopetris_wrapper.h" Test(GetRecordingInformation, NullptrAsArgument) { OOPetrisRecordingReturnValue* return_value = oopetris_get_recording_information(NULL); diff --git a/wrapper/c/tests/information.c b/wrapper/c/tests/information.c index d7820b87..ba28c3c9 100644 --- a/wrapper/c/tests/information.c +++ b/wrapper/c/tests/information.c @@ -2,7 +2,7 @@ #include #include -#include +#include "oopetris_wrapper.h" // this tests likely fail, if we update the lib, but this failure on version bump serves as remainder,to check, if other things need changing too, since wrapper may become outdated otherwise diff --git a/wrapper/c/tests/is_recording_file.c b/wrapper/c/tests/is_recording_file.c index 6f6d7a72..3168ad42 100644 --- a/wrapper/c/tests/is_recording_file.c +++ b/wrapper/c/tests/is_recording_file.c @@ -1,6 +1,6 @@ #include -#include +#include "oopetris_wrapper.h" Test(IsRecordingFile, NullptrAsArgument) { bool is_recordings_file = oopetris_is_recording_file(NULL); From 2a9b38861ef88dc775773b18838a29a848b7a603 Mon Sep 17 00:00:00 2001 From: Totto16 Date: Fri, 21 Jun 2024 20:20:02 +0200 Subject: [PATCH 09/11] - add stb tests, and disable them, since they fail xD --- wrapper/c/tests/meson.build | 1 + wrapper/c/tests/stb_ds.c | 29 +++++++++++++++++++++++++++++ 2 files changed, 30 insertions(+) create mode 100644 wrapper/c/tests/stb_ds.c diff --git a/wrapper/c/tests/meson.build b/wrapper/c/tests/meson.build index a3d35af0..fb518bd8 100644 --- a/wrapper/c/tests/meson.build +++ b/wrapper/c/tests/meson.build @@ -5,6 +5,7 @@ test_src = [ 'get_recording_information.c', 'information.c', 'is_recording_file.c', + ## 'stb_ds.c', this test don't work atm ), ] diff --git a/wrapper/c/tests/stb_ds.c b/wrapper/c/tests/stb_ds.c new file mode 100644 index 00000000..eb54db94 --- /dev/null +++ b/wrapper/c/tests/stb_ds.c @@ -0,0 +1,29 @@ + + +#include + +#if defined(__GNUC__) +// these tests have a shit-ton of errors xD +#pragma GCC diagnostic push +#pragma GCC diagnostic ignored "-Wunused-variable" +#pragma GCC diagnostic ignored "-Wmissing-braces" +#pragma GCC diagnostic ignored "-Wint-conversion" +#pragma GCC diagnostic ignored "-Wunused-value" +#pragma GCC diagnostic ignored "-Wsign-compare" +#endif + + +#define STBDS_UNIT_TESTS +#define STBDS_ASSERT(x) cr_assert(x) + +#include "./thirdparty/stb_ds.h" + + +#if defined(__GNUC__) +#pragma GCC diagnostic pop +#endif + + +Test(StbDs, UniTests) { + stbds_unit_tests(); +} From 2e5b6354a7c2c349bee8fcd2397a7c1184115473 Mon Sep 17 00:00:00 2001 From: Totto16 Date: Fri, 21 Jun 2024 20:32:10 +0200 Subject: [PATCH 10/11] Wrapper:C: stb_ds: try to fix tests --- wrapper/c/src/thirdparty/stb_ds.h | 70 +++++++++++++++++-------------- wrapper/c/tests/stb_ds.c | 7 +++- 2 files changed, 45 insertions(+), 32 deletions(-) diff --git a/wrapper/c/src/thirdparty/stb_ds.h b/wrapper/c/src/thirdparty/stb_ds.h index e84c82d1..589e31c9 100644 --- a/wrapper/c/src/thirdparty/stb_ds.h +++ b/wrapper/c/src/thirdparty/stb_ds.h @@ -1695,31 +1695,35 @@ void stbds_unit_tests(void) hmdefault(intmap, -2); STBDS_ASSERT(hmgeti(intmap, i) == -1); STBDS_ASSERT(hmget (intmap, i) == -2); - for (i=0; i < testsize; i+=2) + for (i=0; i < testsize; i+=2){ hmput(intmap, i, i*5); + } for (i=0; i < testsize; i+=1) { - if (i & 1) STBDS_ASSERT(hmget(intmap, i) == -2 ); - else STBDS_ASSERT(hmget(intmap, i) == i*5); - if (i & 1) STBDS_ASSERT(hmget_ts(intmap, i, temp) == -2 ); - else STBDS_ASSERT(hmget_ts(intmap, i, temp) == i*5); + if (i & 1) {STBDS_ASSERT(hmget(intmap, i) == -2 );} + else { STBDS_ASSERT(hmget(intmap, i) == i*5);} + if (i & 1) {STBDS_ASSERT(hmget_ts(intmap, i, temp) == -2 );} + else {STBDS_ASSERT(hmget_ts(intmap, i, temp) == i*5);} } for (i=0; i < testsize; i+=2) hmput(intmap, i, i*3); - for (i=0; i < testsize; i+=1) - if (i & 1) STBDS_ASSERT(hmget(intmap, i) == -2 ); - else STBDS_ASSERT(hmget(intmap, i) == i*3); + for (i=0; i < testsize; i+=1){ + if (i & 1) {STBDS_ASSERT(hmget(intmap, i) == -2 );} + else {STBDS_ASSERT(hmget(intmap, i) == i*3);}} for (i=2; i < testsize; i+=4) hmdel(intmap, i); // delete half the entries - for (i=0; i < testsize; i+=1) - if (i & 3) STBDS_ASSERT(hmget(intmap, i) == -2 ); - else STBDS_ASSERT(hmget(intmap, i) == i*3); - for (i=0; i < testsize; i+=1) + for (i=0; i < testsize; i+=1){ + if (i & 3){ STBDS_ASSERT(hmget(intmap, i) == -2 );} + else { STBDS_ASSERT(hmget(intmap, i) == i*3);}} + for (i=0; i < testsize; i+=1){ hmdel(intmap, i); // delete the rest of the entries - for (i=0; i < testsize; i+=1) + } + for (i=0; i < testsize; i+=1){ STBDS_ASSERT(hmget(intmap, i) == -2 ); + } hmfree(intmap); - for (i=0; i < testsize; i+=2) + for (i=0; i < testsize; i+=2){ hmput(intmap, i, i*3); + } hmfree(intmap); #if defined(__clang__) || defined(__GNUC__) @@ -1735,7 +1739,7 @@ void stbds_unit_tests(void) #endif for (i=0; i < testsize; ++i) - stralloc(&sa, strkey(i)); + { stralloc(&sa, strkey(i));} strreset(&sa); { @@ -1778,18 +1782,22 @@ void stbds_unit_tests(void) STBDS_ASSERT(shgeti(strmap,"foo") == -1); for (i=0; i < testsize; i+=2) shput(strmap, strkey(i), i*3); - for (i=0; i < testsize; i+=1) - if (i & 1) STBDS_ASSERT(shget(strmap, strkey(i)) == -2 ); - else STBDS_ASSERT(shget(strmap, strkey(i)) == i*3); + for (i=0; i < testsize; i+=1){ + if (i & 1) {STBDS_ASSERT(shget(strmap, strkey(i)) == -2 );} + else { STBDS_ASSERT(shget(strmap, strkey(i)) == i*3);} + } for (i=2; i < testsize; i+=4) shdel(strmap, strkey(i)); // delete half the entries - for (i=0; i < testsize; i+=1) - if (i & 3) STBDS_ASSERT(shget(strmap, strkey(i)) == -2 ); - else STBDS_ASSERT(shget(strmap, strkey(i)) == i*3); - for (i=0; i < testsize; i+=1) + for (i=0; i < testsize; i+=1){ + if (i & 3){ STBDS_ASSERT(shget(strmap, strkey(i)) == -2 );} + else { STBDS_ASSERT(shget(strmap, strkey(i)) == i*3);} + } + for (i=0; i < testsize; i+=1){ shdel(strmap, strkey(i)); // delete the rest of the entries - for (i=0; i < testsize; i+=1) + } + for (i=0; i < testsize; i+=1){ STBDS_ASSERT(shget(strmap, strkey(i)) == -2 ); + } shfree(strmap); } @@ -1814,10 +1822,10 @@ void stbds_unit_tests(void) for (i=0; i < testsize; i += 1) { stbds_struct s = { i,i*2,i*3 ,i*4 }; stbds_struct t = { i,i*2,i*3+1,i*4 }; - if (i & 1) STBDS_ASSERT(hmget(map, s) == 0); - else STBDS_ASSERT(hmget(map, s) == i*5); - if (i & 1) STBDS_ASSERT(hmget_ts(map, s, temp) == 0); - else STBDS_ASSERT(hmget_ts(map, s, temp) == i*5); + if (i & 1) {STBDS_ASSERT(hmget(map, s) == 0);} + else {STBDS_ASSERT(hmget(map, s) == i*5);} + if (i & 1) {STBDS_ASSERT(hmget_ts(map, s, temp) == 0);} + else { STBDS_ASSERT(hmget_ts(map, s, temp) == i*5);} //STBDS_ASSERT(hmget(map, t.key) == 0); } @@ -1830,8 +1838,8 @@ void stbds_unit_tests(void) for (i=0; i < testsize; i += 1) { stbds_struct s = { i,i*2,i*3,i*4 }; stbds_struct t = { i,i*2,i*3+1,i*4 }; - if (i & 1) STBDS_ASSERT(hmgets(map2, s.key).d == 0); - else STBDS_ASSERT(hmgets(map2, s.key).d == i*4); + if (i & 1){ STBDS_ASSERT(hmgets(map2, s.key).d == 0);} + else {STBDS_ASSERT(hmgets(map2, s.key).d == i*4);} //STBDS_ASSERT(hmgetp(map2, t.key) == 0); } hmfree(map2); @@ -1843,8 +1851,8 @@ void stbds_unit_tests(void) for (i=0; i < testsize; i += 1) { stbds_struct2 s = { { i,i*2}, i*3, i*4, i*5 }; stbds_struct2 t = { { i,i*2}, i*3+1, i*4, i*5 }; - if (i & 1) STBDS_ASSERT(hmgets(map3, s.key).d == 0); - else STBDS_ASSERT(hmgets(map3, s.key).d == i*5); + if (i & 1) {STBDS_ASSERT(hmgets(map3, s.key).d == 0);} + else { STBDS_ASSERT(hmgets(map3, s.key).d == i*5);} //STBDS_ASSERT(hmgetp(map3, t.key) == 0); } #endif diff --git a/wrapper/c/tests/stb_ds.c b/wrapper/c/tests/stb_ds.c index eb54db94..37073e9e 100644 --- a/wrapper/c/tests/stb_ds.c +++ b/wrapper/c/tests/stb_ds.c @@ -13,8 +13,13 @@ #endif +void assert_impl(bool x) { + cr_assert(x); +} + #define STBDS_UNIT_TESTS -#define STBDS_ASSERT(x) cr_assert(x) +#define STBDS_ASSERT(x) assert_impl(x); + #include "./thirdparty/stb_ds.h" From 448a3c7c6d30624ecb26a22710990f1349cfd000 Mon Sep 17 00:00:00 2001 From: Totto16 Date: Fri, 21 Jun 2024 21:57:56 +0200 Subject: [PATCH 11/11] Wrapper: update readmes --- wrapper/c/README.md | 26 ++++++++++++++++++++++++++ wrapper/javascript/README.md | 2 +- 2 files changed, 27 insertions(+), 1 deletion(-) create mode 100644 wrapper/c/README.md diff --git a/wrapper/c/README.md b/wrapper/c/README.md new file mode 100644 index 00000000..9b738ac6 --- /dev/null +++ b/wrapper/c/README.md @@ -0,0 +1,26 @@ +# OOpetris C Wrapper + + +## What is this? + +This wraps oopetris functionality for C + + + + + +## Platform support + +We officially support Linux, Windows and MacOS, if any error occurs regarding those platform, feel free to open an issue + +## How to obtain + +You have to compile it yourself, we don't provide prebuilt-packages atm. The Ci may produce some artifacts, that are useable, but not optimized for installation or usage. + +## How to build it yourself + +This uses meson to build the wrapper, you need to install `libboopetris_recordings` to be able to use this. + +Than you just can invoke `meson setup build` and `meson compile -C build` to build the library. + +You can install this library by using `meson install -C build`. It comes with a pkg-config file, so it is usable for usage with other build systems. diff --git a/wrapper/javascript/README.md b/wrapper/javascript/README.md index 29965db2..1015e4ec 100644 --- a/wrapper/javascript/README.md +++ b/wrapper/javascript/README.md @@ -1,4 +1,4 @@ -# OOpetris Noe.js Wrapper +# OOpetris Node.js Wrapper ## What is this?