Merge pull request #17 from Adwaith-Rajesh/release-build

added release mode to nobuild, fic the warnings that show up while building in release mode, and updated the docs.

Author: Adwaith-Rajesh

README.md

@@ -39,14 +39,22 @@ A search engine to search for local files based on their contents and not just t
 
 ```console
 git clone --depth=1 https://github.com/Adwaith-Rajesh/calsen.git
+cd calsen
 ```
 
-- compiling
-  [`Calsen`](https://github.com/Adwaith-Rajesh/calsen/) makes use of [nobuild](https://github.com/tsoding/nobuild) as it's build system. To compile run the following commands
+- dependencies (I've plans to make this optional [#2](https://github.com/Adwaith-Rajesh/calsen/issues/2))
+
+```console
+apt install libmagic-dev
+```
+
+#### Compiling
+
+[`Calsen`](https://github.com/Adwaith-Rajesh/calsen/) makes use of [nobuild](https://github.com/tsoding/nobuild) as it's build system. To compile run the following commands
 
 ```console
 gcc -o nobuild ./nobuild.c
-./nobuild
+./nobuild --release
 ln -s ./build/bin/calsen ./calsen
 ```
 

nobuild.c

@@ -1,16 +1,19 @@
 #define NOBUILD_IMPLEMENTATION
 #include "nobuild.h"
 
+#include <getopt.h>
 #include <stdio.h>
 #include <stdlib.h>
 #include <string.h>
 
 #define CC "cc"  // use the default compiler to compile the code
-#define C_FLAGS "-g", "-Wall", "-Wextra", "-std=c11", "-I./src", "-I./src/utils"
+#define C_FLAGS (in_release) ? "-O3" : "-g", "-Wall", "-Wextra", "-std=c11", "-I./src", "-I./src/utils"
 
 #define OUT_DIR "./build/out"
 #define BIN_DIR "./build/bin"
 
+int in_release = 0;
+
 typedef struct {
     char parser_file_name[20];
     Cmd cmd;
@@ -76,6 +79,9 @@ void build_calsen() {
     cmd_run_sync(cmd);
 }
 
+#pragma GCC diagnostic push
+#pragma GCC diagnostic ignored "-Wstringop-overread"
+
 int custom_parser_check_execute(Cstr file) {
     CParserCompileCommand cp_commands[] = {
         // sample code
@@ -94,6 +100,8 @@ int custom_parser_check_execute(Cstr file) {
 
     if (!cp_commands_len) return 0;
 
+    // this loop will only run if there is an element in the array
+    // so its safe to access it and also ignore the "-Wstringop-overread" warning
     for (size_t i = 0; i < cp_commands_len; i++) {
         if (strcmp(file, cp_commands[i].parser_file_name) == 0) {
             INFO("CMD: %s", cmd_show(cp_commands[i].cmd));
@@ -104,6 +112,8 @@ int custom_parser_check_execute(Cstr file) {
     return 0;
 }
 
+#pragma GCC diagnostic pop
+
 void build_parsers() {
     INFO("Building parsers");
     if (!IS_DIR("./src/parsers")) {
@@ -123,11 +133,19 @@ void build_parsers() {
 }
 
 int main(int argc, char **argv) {
+    GO_REBUILD_URSELF(argc, argv);
+
+    int option_index = 0;
+    struct option long_options[] = {
+        {"release", no_argument, &in_release, 1},
+        {0, 0, 0, 0},
+    };
+
+    int c = getopt_long(argc, argv, "", long_options, &option_index);
+
     MKDIRS("build", "out");
     MKDIRS("build", "bin");
     MKDIRS("build", "parsers");
-
-    GO_REBUILD_URSELF(argc, argv);
     build_src();
     build_src_utils();
     build_calsen();

src/indexer.c

@@ -159,7 +159,10 @@ static HashTable *_read_token(FILE *fp) {
 
         // read the TF val (14 bytes, after the '=')
         char tf_val[15];
-        fgets(tf_val, 15, fp);
+        if (fgets(tf_val, 15, fp) == NULL) {
+            fprintf(stderr, "Error reading token");
+            exit(1);
+        }
 
         double *db_val = malloc(sizeof(double));
         *db_val = strtod(tf_val, &tw);

src/parsers/text_plain.c

@@ -13,7 +13,10 @@ void parse_file(const char *pathname, String *str) {
         fprintf(stderr, "Could not open file: %s : %s\n", pathname, strerror(errno));
         exit(1);
     }
-    fread(str->str, str->size, 1, fp);
+    size_t read_bytes = fread(str->str, str->size, 1, fp);
+    if (read_bytes == 0) {
+        fprintf(stderr, "Error, reading contents of: %s", pathname);
+    }
     fclose(fp);
 }
 #pragma GCC diagnostic pop

src/utils/linked_list.c

@@ -65,7 +65,7 @@ Node *ll_pop(LinkedList *list) {
         list->size--;
         return temp;
     }
-    Node *prev;
+    Node *prev = NULL;
     Node *curr = list->head;
 
     while (curr->next != NULL) {