[feature] Play module initial implementation (#7)

Author: ValentinMassa

.github/workflows/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,24 @@
+---
+
+name: "REPORT A BUG, HERE YOU HAVE A PATTERN"
+about: "Lets talk about bug or changes that can help us to improve the project."
+title: " 👉 - Short description of the bug"
+labels: bug
+assignees: ""
+
+---
+
+## REPORT (Necessary)👀
+
+### EXPECTED BEHAVIOR
+
+Describe lo que esperabas que ocurriera al realizar los pasos anteriores.
+Explain to us what you were expecting from the program result after you introduced the data
+
+### SCREENSHOTS OR FILE THAT SUPPLY EVIDENCE
+
+If you could, please attach the log error or a screenshot
+
+### ADDITIONAL INFORMATIONl
+
+Any important information that you want to mention.

libs/libs.cbp

@@ -34,6 +34,10 @@
 				</Linker>
 			</Target>
 		</Build>
+		<Unit filename="list/main.c">
+			<Option compilerVar="CC" />
+		</Unit>
+		<Unit filename="list/main.h" />
 		<Unit filename="macros.h" />
 		<Unit filename="main.h" />
 		<Unit filename="structs.h" />

libs/list/main.c

@@ -0,0 +1,140 @@
+#include "./main.h"
+
+#include "../macros.h"
+
+Node* __getElementAt(List* _list, const size_t index);
+
+// Constructor
+void newList(List* list) { *list = NULL; }
+
+// Destroyer
+void destroyList(List* _list) {
+    Node* nextNode;
+
+    while ((*_list) != NULL) {
+        nextNode = *_list;
+        *(_list) = nextNode->__next;
+
+        free(nextNode->__data);
+        free(nextNode);
+    }
+}
+
+// Getters
+Node* __getElementAt(List* _list, const size_t index) {
+    size_t length = 0;
+
+    while ((*_list) != NULL && length != index) {
+        _list = &(*_list)->__next;
+        length++;
+    }
+
+    return *_list;
+}
+
+unsigned char getHead(const List* _list, void* store, const size_t sizeOfStore) {
+    if ((*_list) == NULL) return 0;
+
+    memcpy(store, (*_list)->__data, MIN(sizeOfStore, (*_list)->__sizeOfData));
+
+    return 1;
+}
+
+unsigned char isListEmpty(List* _list) { return (*_list) == NULL; }
+
+unsigned char isListFull(List* _list, const size_t sizeOfStore) {
+    Node* newNode;
+    void* newNodeData;
+
+    newNode = malloc(sizeof(Node));
+    newNodeData = malloc(sizeOfStore);
+
+    free(newNode);
+    free(newNodeData);
+
+    return ((newNode == NULL) || (newNodeData == NULL));
+}
+
+size_t getLength(List* _list) {
+    size_t length = 0;
+
+    while ((*_list) != NULL) {
+        length++;
+        _list = &(*_list)->__next;
+    }
+
+    return length;
+}
+// Methods
+unsigned char pushElement(List* _list, void* data, const size_t sizeOfData) {
+    Node* newNode;
+
+    while ((*_list) != NULL) {
+        _list = &(*_list)->__next;
+    };
+
+    if ((newNode = malloc(sizeof(Node))) == NULL ||
+        (newNode->__data = malloc(sizeOfData)) == NULL) {
+        free(newNode);
+        return 0;
+    }
+
+    memcpy(newNode->__data, data, sizeOfData);
+    newNode->__sizeOfData = sizeOfData;
+    newNode->__next = NULL;
+    *_list = newNode;
+
+    return 1;
+}
+
+unsigned char popElement(List* _list, void* store, const size_t sizeOfStore) {
+    if ((*_list) == NULL) {
+        return 0;
+    }
+
+    while ((*_list)->__next != NULL) {
+        _list = &(*_list)->__next;
+    }
+
+    memcpy(store, (*_list)->__data, MIN(sizeOfStore, (*_list)->__sizeOfData));
+    free((*_list)->__data);
+    free(*_list);
+    *_list = NULL;
+
+    return 1;
+}
+
+void randomSort(List* _list) {
+    size_t length = 0;
+    size_t index = 0;
+    size_t rndIndex;
+
+    void* auxPointer;
+    size_t elementSize;
+
+    List* head = _list;
+    Node* helper;
+
+    while ((*_list) != NULL) {
+        length++;
+        _list = &(*_list)->__next;
+    }
+
+    _list = head;
+
+    while ((*_list) != NULL) {
+        while ((rndIndex = (rand() % (length))) == index);
+        helper = __getElementAt(head, rndIndex);
+        auxPointer = (*_list)->__data;
+        elementSize = (*_list)->__sizeOfData;
+
+        (*_list)->__data = helper->__data;
+        (*_list)->__sizeOfData = helper->__sizeOfData;
+
+        helper->__data = auxPointer;
+        helper->__sizeOfData = elementSize;
+
+        _list = &(*_list)->__next;
+        index++;
+    }
+}

libs/list/main.h

@@ -0,0 +1,35 @@
+#ifndef LIBS__LIST_H_INCLUDED
+#define LIBS__LIST_H_INCLUDED
+
+#include <stdlib.h>
+#include <string.h>
+
+#include "../structs.h"
+
+/* ---------- List ---------- */
+
+typedef Node* List;
+
+// Constructor
+void newList(List* list);
+
+// Destroyer
+void destroyList(List* _list);
+
+// Getters
+unsigned char getHead(const List* _list, void* store, const size_t sizeOfStore);
+
+unsigned char isListEmpty(List* _list);
+
+unsigned char isListFull(List* _list, const size_t sizeOfStore);
+
+size_t getLength(List* _list);
+
+// Methods
+unsigned char pushElement(List* _list, void* data, const size_t sizeOfData);
+
+unsigned char popElement(List* _list, void* store, const size_t sizeOfStore);
+
+void randomSort(List* _list);
+
+#endif  // LIBS__LIST_H_INCLUDED

libs/macros.h

@@ -2,6 +2,6 @@
 #ifndef LIBS_MACROS_H_INCLUDED
 #define LIBS_MACROS_H_INCLUDED
 
-// TODO
+#define MIN(A, B) ((A) < (B) ? (A) : (B))
 
 #endif  // LIBS_MACROS_H_INCLUDED

libs/main.h

@@ -7,4 +7,7 @@
 #include "./structs.h"
 #include "./utilities.h"
 
+// List
+#include "./list/main.h"
+
 #endif  // LIBS_MAIN_H_INCLUDED

libs/structs.h

@@ -4,6 +4,12 @@
 
 #include <stdlib.h>
 
+typedef struct Node {
+    void* __data;
+    size_t __sizeOfData;
+    struct Node* __next;
+} Node;
+
 typedef struct {
     size_t x;
     size_t y;

src/api/main.c

@@ -0,0 +1,14 @@
+
+#include "../../libs/main.h"
+
+#include "./main.h"
+
+unsigned char postAPI(const Configuration* config, List* list) {
+    return 0;
+    // TODO
+}
+
+unsigned char createLocalFile(List* list, const char* localFilePath) {
+    // TODO
+    return 0;
+}

src/api/main.h

@@ -0,0 +1,11 @@
+#ifndef SRC__API_H_INCLUDED
+#define SRC__API_H_INCLUDED
+
+#include "../../libs/main.h"
+#include "../configuration/main.h"
+
+unsigned char postAPI(const Configuration* config, List* list);
+
+unsigned char createLocalFile(List* list, const char* localFilePath);
+
+#endif  // SRC__API_H_INCLUDED

src/macros.h

@@ -9,6 +9,10 @@
 
 #define CONFIGURATION_PATH "./statics/configuration.txt"
 
+#define LOCAL_FILE_PATH "./statics/local-storage/informe-juego_"
+
+#define LOCAL_FILE_PATH_LENGTH (sizeof(LOCAL_FILE_PATH) + sizeof("YYYY-MM-DD-HH-mm") + 1)
+
 /* --------------------------------- Player --------------------------------- */
 
 #define PLAYER_NAME_LENGTH 64