Binary Files

.gitignore

@@ -40,7 +40,7 @@ MANIFEST
 .vscode
 
 # Files saved
-saves/
+saves/*
 
 # PyInstaller
 #  Usually these files are written by a python script from a template

C/Makefile

@@ -47,8 +47,10 @@ $(COMP)%.o : $(SRC)%.c
 	$(CC) -c $< -o $@
 
 
+# Main --------------------------------------
 
-
+main: $(COMP)main.o $(COMP)mapGenerator.o $(COMP)map.o $(COMP)chunk.o $(COMP)layer.o $(COMP)gradientGrid.o $(COMP)loadingBar.o $(COMP)interpreter.o
+	$(CC) $^ -o $(BIN)$@ $(LFLAGS)
 
 # Tests -------------------------------------
 
@@ -58,22 +60,25 @@ test_unicode: $(COMP)test_unicode.o
 test_loadingBar: $(COMP)test_loadingBar.o $(COMP)loadingBar.o
 	$(CC) $^ -o $(BIN)$@
 
-test_gradientGrid: $(COMP)test_gradientGrid.o $(COMP)gradientGrid.o $(COMP)loadingBar.o
+test_gradientGrid: $(COMP)test_gradientGrid.o $(COMP)gradientGrid.o $(COMP)loadingBar.o $(COMP)interpreter.o
 	$(CC) $^ -o $(BIN)$@ $(LFLAGS)
 
-test_layer: $(COMP)test_layer.o $(COMP)layer.o $(COMP)gradientGrid.o $(COMP)loadingBar.o
+test_layer: $(COMP)test_layer.o $(COMP)layer.o $(COMP)gradientGrid.o $(COMP)loadingBar.o $(COMP)interpreter.o
 	$(CC) $^ -o $(BIN)$@ $(LFLAGS)
 
-test_chunk: $(COMP)test_chunk.o $(COMP)chunk.o $(COMP)layer.o $(COMP)gradientGrid.o $(COMP)loadingBar.o
+test_chunk: $(COMP)test_chunk.o $(COMP)chunk.o $(COMP)layer.o $(COMP)gradientGrid.o $(COMP)loadingBar.o $(COMP)interpreter.o
 	$(CC) $^ -o $(BIN)$@ $(LFLAGS)
 
-test_map: $(COMP)test_map.o $(COMP)map.o $(COMP)chunk.o $(COMP)layer.o $(COMP)gradientGrid.o $(COMP)loadingBar.o
+test_map: $(COMP)test_map.o $(COMP)map.o $(COMP)chunk.o $(COMP)layer.o $(COMP)gradientGrid.o $(COMP)loadingBar.o $(COMP)interpreter.o
 	$(CC) $^ -o $(BIN)$@ $(LFLAGS)
 
-test_mapGenerator: $(COMP)test_mapGenerator.o $(COMP)mapGenerator.o $(COMP)map.o $(COMP)chunk.o $(COMP)layer.o $(COMP)gradientGrid.o $(COMP)loadingBar.o
+test_mapGenerator: $(COMP)test_mapGenerator.o $(COMP)mapGenerator.o $(COMP)map.o $(COMP)chunk.o $(COMP)layer.o $(COMP)gradientGrid.o $(COMP)loadingBar.o $(COMP)interpreter.o
+	$(CC) $^ -o $(BIN)$@ $(LFLAGS)
+
+test_interpreter: $(COMP)test_interpreter.o $(COMP)interpreter.o $(COMP)mapGenerator.o $(COMP)map.o $(COMP)chunk.o $(COMP)layer.o $(COMP)gradientGrid.o $(COMP)loadingBar.o
 	$(CC) $^ -o $(BIN)$@ $(LFLAGS)
 
-test_all : test_unicode test_loadingBar test_gradientGrid test_layer test_chunk test_map test_mapGenerator
+test_all : test_unicode test_loadingBar test_gradientGrid test_layer test_chunk test_map test_mapGenerator test_interpreter
 
 # Valgrind ----------------------------------
 

C/headers/chunk.h

@@ -2,8 +2,8 @@
  * @file chunk.h
  * @author Zyno and BlueNZ
  * @brief Header to chunk structure and functions
- * @version 0.2
- * @date 2024-06-19
+ * @version 0.3
+ * @date 2024-07-29
  * 
  */
 
@@ -100,13 +100,22 @@ chunk* initChunk(int width, int height, int number_of_layers, double layers_fact
 
 
 
+/**
+ * @brief Generates a new base altitude to be set to a chunk.
+ * 
+ * @return double : the base_altitude value.
+ */
+double generateBaseAltitude();
+
 /**
  * @brief Regenerates the given chunk final altitude values from its layers and layers factors.
  * 
  * @param chunk (chunk*) : the pointer to the initialized chunk structure to regenerate the altitude values.
  * @param display_loading (unsigned int) : the given value defines the behaviour.
  *                                         * If `0` the loading bars won't be printed.
  *                                         * If `> 0` the loading bars will be printed with a number of indent equal to `display_loading - 1`.
+ *
+ * @note each layer will see its values free'd at this point. They can still be regenerated if needed using the dedicated function.
  */
 void regenerateChunk(chunk* chunk, unsigned int display_loading);
 
@@ -174,26 +183,17 @@ chunk* newChunkFromGradients(int width, int height, int number_of_layers, gradie
 chunk* newChunk(int number_of_layers, int gradGrids_width[number_of_layers], int gradGrids_height[number_of_layers], int size_factors[number_of_layers], 
                         double layers_factors[number_of_layers], unsigned int display_loading);
 
-//TODO ? signature could be changed to avoid passing useless parameters -> `chunk_width` and `chunk_height` instead of `gradGrids_width`, `gradGrids_height` and `size_factors`
 /**
  * @brief Generates a new virtual chunk structure with the given parameters. It does not possess any altitude values and is used as a way to store
  * the data of boundary conditions with its `base_altitude` parameter.
  * 
- * @param number_of_layers (int) : the number of layers passed.
- * @param gradGrids_width (int[number_of_layers]) : the array of gradientGrid width to compute the final width this virtual chunk should have.
- * @param gradGrids_height (int[number_of_layers]) : the array of gradientGrid height to compute the final height this virtual chunk should have.
- * @param size_factors (int[number_of_layers]) : the array of size factors to compute the final dimensions of this virtual chunk.
- * @param layers_factors (double[number_of_layers]) : the array of layers factors to be stored in the virtual chunk.
- * @return chunk* : the pointer to the newly generated virtual chunk structure.
+ * @param chunk_width (int) : the width size of the virtuak chunk if it had altitude values.
+ * @param chunk_height (int) : the height size of the virtuak chunk if it had altitude values.
+ * @param regenerate (bool) : should the base altitude value be generated.
  * 
- * @warning The `size_factors` array should match the `gradGrids_width` and `gradGrids_height` arrays such that
- *          `(gradGrid_dimensions - 1) * size_factor = constant`. In case it would not be the case, the chunk structure will still 
- *          be generated but its dimensions will be wrong : it will simply use the first value. 
- * 
- * @note The arrays does not need to be dynamically allocated and their content will be copied in the structure.
+ * @return chunk* : the pointer to the newly generated virtual chunk structure.
  */
-chunk* newVirtualChunk(int number_of_layers, int gradGrids_width[number_of_layers], int gradGrids_height[number_of_layers], int size_factors[number_of_layers],
-                                double layers_factors[number_of_layers]);
+chunk* newVirtualChunk(int chunk_width, int chunk_height, bool regenerate);
 
 
 /**
@@ -223,6 +223,23 @@ chunk* newAdjacentChunk(chunk* north_chunk, chunk* west_chunk, unsigned int disp
 chunk* copyChunk(chunk* p_chunk);
 
 
+/**
+ * @brief Encodes a chunk struct in a binary format.
+ * 
+ * @param chk (chunk*) : a pointer to the chunk struct.
+ * @return bytes : the byte string representing the encoded struct.
+ */
+bytes bytesChunk(chunk* chk);
+
+/**
+ * @brief Decodes a chunk struct from a formatted byte string.
+ * 
+ * @param bytes (bytes) : the formatted byte string.
+ * @return tuple_obj_bytes : the decoded chunk and the byte string (with the start index updated).
+ */
+tuple_obj_bytes nextChunk(bytes bytes);
+
+
 
 /**
  * @brief Writes the chunk structure to a file at the given path.

C/headers/gradientGrid.h

@@ -10,6 +10,8 @@
 #ifndef GRADIENT_GRID
 #define GRADIENT_GRID
 
+#include "interpreter.h"
+
 // ----- Structure definition -----
 
 /**
@@ -145,6 +147,23 @@ gradientGrid* readGradientGridFile(char path[]);
 
 
 
+/**
+ * @brief Encodes a gradient grid struct in a binary format.
+ * 
+ * @param gradGrid (gradientGrid*) : a pointer to the gradient grid struct.
+ * @return bytes : the byte string representing the encoded struct.
+ */
+bytes bytesGradientGrid(gradientGrid* grid);
+
+/**
+ * @brief Decodes a gradient grid struct from a formatted byte string.
+ * 
+ * @param bytes (bytes) : the formatted byte string.
+ * @return tuple_obj_bytes : the decoded gradient grid and the byte string (with the start index updated).
+ */
+tuple_obj_bytes nextGradientGrid(bytes bytes);
+
+
 /**
  * @brief Prints in the terminal the given gradient grid.
  * 

C/headers/interpreter.h

@@ -0,0 +1,178 @@
+/**
+ * @file interpreter.h
+ * @author BlueNZ
+ * @brief Header to interpreter functions
+ * @version 0.1
+ * @date 2024-07-27
+ * 
+ */
+
+#ifndef INTERP
+#define INTERP
+
+// ------- Structure definition ------- //
+
+typedef unsigned char byte; //type used as bytes
+typedef char* object; //an alias for pointers
+
+/**
+ * @brief a simple implementation of byte strings
+ */
+typedef struct bytes {
+    byte* bytes; // the byte array
+    int size; // to keep track of the size of the byte array
+    int start; // where to look for the current byte in the array
+} bytes;
+
+/**
+ * @brief a placeholder to return both an object (a number or a struct) and a byte string (bytes)
+ */
+typedef struct tuple_obj_bytes {
+    object object; // a pointer to the object
+    bytes bytes; // the byte string
+} tuple_obj_bytes;
+
+
+// ------- Constants ------- //
+
+#define BYTE_TRUE (byte) 1
+#define BYTE_FALSE (byte) 0
+#define INT_BITS_NBR 24 //24 should be a multiple of 8
+#define FLOAT_BITS_EXP 5 //5 should be < 8
+#define FLOAT_BITS_MANTISS 18 
+#define FLOAT_BITS_NBR (1 + FLOAT_BITS_EXP + FLOAT_BITS_MANTISS) //24 should be a multiple of 8
+
+#define GRID_ENCODING (byte) 1
+#define LAYER_ENCODING (byte) 2
+#define CHUNK_ENCODING (byte) 3
+#define MAP_ENCODING (byte) 4
+#define COMPLETE_MAP_ENCODING (byte) 5
+
+#define BYTES_VERSION (byte) 0
+
+
+
+// ------- Functions ------- //
+
+/**
+ * @brief 'Fast' int powers.
+ * 
+ * @param nbr (int) : the nbr to be exponantiated
+ * @param exp (int) : the exponant
+ * @return int : the result of nbr^exp.
+ */
+int intpow(int nbr, int exp);
+
+
+
+/**
+ * @brief Deallocates the byte array of a bytes struct
+ * 
+ * @param b (bytes) : the bytes struct
+ */
+void freeBytes(bytes b);
+
+/**
+ * @brief Auxiliary function to print bytes (update a string with the hexadecimal representation of a byte).
+ * 
+ * @param c (unsigned char) : the byte to print
+ * @param res (char*) : the string to update
+ * @return char* : the updated string
+ */
+char* hex(unsigned char c, char* res);
+
+/**
+ * @brief Prints a bytes struct
+ * 
+ * @param bytes (bytes) : the bytes to print
+ * @param start (char*) : a string to print beforehand
+ * @param end (char*) : a string to print after ("\n" for instance)
+ */
+void printBytes(bytes bytes, char* start, char* end);
+
+/**
+ * @brief Updates a byte string starting from a given index with the values of another byte string
+ * 
+ * @param b (bytes) : the bytes to update
+ * @param bb (bytes) : the bytes to use for updating
+ * @param start (int) : the starting index in b
+ */
+void concatBytes(bytes b, bytes bb, int start);
+
+
+
+/**
+ * @brief Encodes an unsigned 8bits int.
+ * 
+ * @param nbr (__uint8_t) : the unsigned int.
+ * @return bytes : the byte string representing the encoded number.
+ */
+bytes bytesUint8(__uint8_t nbr);
+
+/**
+ * @brief Encodes an int.
+ * 
+ * @param nbr (int) : the int.
+ * @return bytes : the byte string representing the encoded number.
+ */
+bytes bytesInt(int nbr);
+
+/**
+ * @brief Encodes a double.
+ * 
+ * @param nbr (double) : the double.
+ * @return bytes : the byte string representing the encoded number.
+ */
+bytes bytesDouble(double nbr);
+
+
+
+/**
+ * @brief Decodes an encoded unsigned 8bits int.
+ * 
+ * @param bytes (bytes) : the encoded byte string.
+ * @return tuple_obj_bytes : the byte string with updated start index and a pointer to the number decoded.
+ */
+tuple_obj_bytes nextUint8(bytes bytes);
+
+/**
+ * @brief Decodes an encoded int.
+ * 
+ * @param bytes (bytes) : the encoded byte string.
+ * @return tuple_obj_bytes : the byte string with updated start index and a pointer to the number decoded.
+ */
+tuple_obj_bytes nextInt(bytes bytes);
+
+/**
+ * @brief Decodes an encoded double.
+ * 
+ * @param bytes (bytes) : the encoded byte string.
+ * @return tuple_obj_bytes : the byte string with updated start index and a pointer to the number decoded.
+ */
+tuple_obj_bytes nextDouble(bytes bytes);
+
+
+
+/**
+ * @brief Writes a bytes string in a specified file
+ * 
+ * @param bytes (bytes) : the byte string.
+ * @param path (char*) : the folder path.
+ * @param name (char*) : the file name (should end with '.data').
+ */
+void writeBytesFile(bytes bytes, char* path, char* name);
+
+/**
+ * @brief Read bytes from a specified file
+ * 
+ * @param path (char*) : the file path.
+ * @return (bytes) : read bytes
+ */
+bytes readBytesFile(char* path);
+
+
+
+
+
+
+#endif