Merge pull request #20 from ryukinix/structs

Expose data structures to header

src/circle/circle.c

@@ -14,12 +14,6 @@
 #include "circle.h"
 #include "utils/check_alloc.h"
 
-struct circle {
-    Point* center; /**< the center point of circle */
-    float radius; /**< the radius size of the circle */
-};
-
-
 Circle* circle_create(Point *center, float radius) {
     Circle* c = (Circle *) malloc(sizeof(Circle));
     check_alloc(c);

src/circle/circle.h

@@ -20,7 +20,13 @@
  * Has the fields hidden by struct circle
  * as (Point* center) and (float radius)
  */
-typedef struct circle Circle;
+struct Circle {
+    Point* center; /**< the center point of circle */
+    float radius; /**< the radius size of the circle */
+};
+
+
+typedef struct Circle Circle;
 
 /**
  * @brief allocate a new circle on memory based on its parameters

src/list/circular/list-circular.c

@@ -14,12 +14,6 @@
 #include <stdlib.h>
 #include <stdio.h>
 
-struct listCircular {
-    int data;
-    struct listCircular *next;
-};
-
-
 ListCircular* list_circular__new_node(int data) {
     ListCircular* node = (ListCircular*) malloc(sizeof(ListCircular));
     node->data = data;

src/list/circular/list-circular.h

@@ -12,9 +12,18 @@
 
 #ifndef LIST_CIRCULAR_H
 #define LIST_CIRCULAR_H
+/**
+ * @brief A List circular data structure.
+ * The last *next pointer points to the first.
+ */
+struct ListCircular {
+    int data;
+    struct ListCircular *next;
+};
+
 
 /** List circular alias */
-typedef struct listCircular ListCircular;
+typedef struct ListCircular ListCircular;
 
 #define EMPTY_LIST_CIRCULAR (ListCircular*) 0
 

src/list/double/list-double.c

@@ -15,11 +15,6 @@
 #include "list-double.h"
 #include "utils/check_alloc.h"
 
-struct listDouble {
-    int data;
-    struct listDouble *next;
-    struct listDouble *prev;
-};
 
 ListDouble* list_double__new_node(int data) {
     ListDouble* node = (ListDouble*) malloc(sizeof(ListDouble));

src/list/double/list-double.h

@@ -13,7 +13,16 @@
 #ifndef LIST_DOUBLE_H
 #define LIST_DOUBLE_H
 
-typedef struct listDouble ListDouble;
+/**
+ * @brief Linked List with double pointers.
+ */
+struct ListDouble {
+    int data;
+    struct ListDouble *next;
+    struct ListDouble *prev;
+};
+
+typedef struct ListDouble ListDouble;
 
 #define EMPTY_LIST_DOUBLE (ListDouble*) 0
 

src/list/single/list.h

@@ -17,13 +17,13 @@
  * Shared struct definition because we have multiple source files
  * which need to know how the internal struct is implemented
  */
-struct list_node {
+struct ListNode {
     int data;
-    struct list_node *next;
+    struct ListNode *next;
 };
 
 /** Public type List for Singly Linked Lists */
-typedef struct list_node List;
+typedef struct ListNode List;
 
 #define EMPTY_LIST (List*) 0
 

src/point/point.c

@@ -15,11 +15,6 @@
 #include "point.h"
 #include "utils/check_alloc.h"
 
-struct point {
-    float x;
-    float y;
-};
-
 
 Point* point_create(float x, float y) {
     Point* p = (Point *) malloc(sizeof(Point));

src/point/point.h

@@ -14,9 +14,15 @@
 #define POINT_H
 
 /**
- * @brief struct Point as 2D space pointer
+ * @brief struct Point as 2D space pointer.
  */
-typedef struct point Point;
+struct Point {
+    float x; /**< x horizontal point on 2D plane */
+    float y; /**< y vertical point on 2D plane */
+};
+
+
+typedef struct Point Point;
 
 /**
  * @brief create a new Point and set x an y

src/pqueue/pqueue.c

@@ -14,11 +14,6 @@
 #include <stdlib.h>
 #include <stdio.h>
 
-struct pqueue_t {
-    int heap[PQUEUE_SIZE];
-    int size;
-};
-
 void swap_values(int *e1, int *e2) {
     int temp = *e1;
     *e1 = *e2;

src/pqueue/pqueue.h

@@ -17,7 +17,19 @@
 
 #define HEAP_EMPTY_CELL -1
 
-typedef struct pqueue_t PQueue;
+/**
+ * @brief Priority Queue Data Structure.
+ * Like a normal queue about push/pop logic,
+ *  but each individual now heave a weight. A inner
+ * heap implementation it's provided.
+ */
+struct PQueue {
+    int heap[PQUEUE_SIZE]; /**< inner heap for weights */
+    int size;              /**< the current size of PQueue */
+};
+
+
+typedef struct PQueue PQueue;
 
 PQueue* pqueue_create();
 

src/tree/binary-tree.h

@@ -20,12 +20,12 @@
 #define TypeFormat "%d"
 #endif
 
-struct node {
+struct BinaryNode {
     Type value;
-    struct node* left;
-    struct node* right;
+    struct BinaryNode* left;
+    struct BinaryNode* right;
 };
 
-typedef struct node BinaryTree;
+typedef struct BinaryNode BinaryTree;
 
 #endif

src/tree/bst/bst.h

@@ -23,7 +23,7 @@
 #include "tree/binary-tree.h"
 
 /* Binary Search Tree DataType Definition */
-typedef struct node BSTree;
+typedef struct BinaryNode BSTree;
 
 #define BST_EMPTY (BSTree*) 0