Merge pull request #9 from ccassise/small-cleanup

Small cleanup

Author: ccassise

CMakeLists.txt

@@ -7,17 +7,47 @@ set(
 
 project(
     wowpkg
-    VERSION 0.3.0
+    VERSION 0.3.1
     DESCRIPTION "A CLI World of Warcraft addon manager"
     LANGUAGES C
 )
 
-set(CMAKE_C_STANDARD 11)
+set(WOWPKG_C_STANDARD 11)
 
 option(WOWPKG_ENABLE_SANITIZERS "Build with or without sanitizers" OFF)
 option(WOWPKG_ENABLE_TESTS "Build tests" OFF)
 option(WOWPKG_USE_DEVELOPMENT_PATHS "Determines what paths will be used to find some files" OFF)
 
+# Compiler flags that enable warnings.
+set(WFLAGS) 
+
+# Mainly used for Windows. Adds extra optimization flags when building for
+# release builds. These flags get added to WFLAGS.
+set(WFLAGS_RELEASE)
+
+# Linker flags.
+set(LDFLAGS)
+
+# Mainly used for Windows. Adds extra optimization linker flags for release
+# builds. These flags get added to LDFLAGS.
+set(LDFLAGS_RELEASE)
+
+# Sanitizer flags.
+set(SANSFLAGS)
+
+# Path to catalog directory in project.
+set(WOWPKG_CATALOG_PATH)
+
+# Includes all compile time defines.
+set(WOWPKG_DEFINES)
+
+# List of libraries that will be linked to targets.
+set(WOWPKG_LIBS)
+
+# Path to user files for project. This location is where the program will search
+# for user config files and is where it will save user specific data.
+set(WOWPKG_USER_FILE_DIR)
+
 if (WOWPKG_ENABLE_TESTS AND NOT WOWPKG_USE_DEVELOPMENT_PATHS)
     message(WARNING "[${PROJECT_NAME}] enabling tests without using development paths may cause tests to fail")
 endif()
@@ -41,7 +71,7 @@ if (MSVC)
     set(LDFLAGS_RELEASE /DEBUG /INCREMENTAL:NO /OPT:REF /OPT:ICF)
     set(LDFLAGS "$<$<CONFIG:Release>:${LDFLAGS_RELEASE}>")
 
-    # Alot of the functions suggested by this are not available on other
+    # A lot of the functions suggested by this are not available on other
     # systems -- so just ignore the warnings.
     set(WOWPKG_DEFINES _CRT_SECURE_NO_WARNINGS)
 else()
@@ -84,9 +114,9 @@ if (WOWPKG_ENABLE_SANITIZERS)
 
             -fsanitize=address
             -fsanitize=undefined
-            -fno-sanitize-recover=all
             -fsanitize=float-divide-by-zero
             -fsanitize=float-cast-overflow
+            -fno-sanitize-recover=all
             -fno-sanitize=null
             -fno-sanitize=alignment
         )
@@ -156,7 +186,6 @@ if (WIN32)
     install(FILES ${PROJECT_SOURCE_DIR}/build/src/Release/cjson.dll DESTINATION bin)
     install(FILES ${PROJECT_SOURCE_DIR}/build/src/Release/libcurl.dll DESTINATION bin)
     install(FILES ${PROJECT_SOURCE_DIR}/build/src/Release/zlib1.dll DESTINATION bin)
-    install(FILES ${PROJECT_SOURCE_DIR}/build/src/Release/wowpkg.pdb DESTINATION bin)
 endif()
 
 set(CPACK_VERBATIM_VARIABLES true)

src/CMakeLists.txt

@@ -5,3 +5,4 @@ target_link_libraries(wowpkg PRIVATE ${WOWPKG_LIBS})
 target_compile_options(wowpkg PRIVATE ${WFLAGS})
 target_link_options(wowpkg PRIVATE ${LDFLAGS})
 target_compile_definitions(wowpkg PRIVATE ${WOWPKG_DEFINES})
+set_target_properties(wowpkg PROPERTIES C_STANDARD ${WOWPKG_C_STANDARD})

src/addon.c

@@ -118,8 +118,6 @@ static int move_filename(const char *restrict srcdir, const char *restrict destd
         return ADDON_ENAMETOOLONG;
     }
 
-    // TODO: If this fails should check if errno is EXDEV and if so it should
-    // copy the directory and then delete.
     if (os_rename(src, dest) != 0) {
         return ADDON_EINTERNAL;
     }

src/command.c

@@ -110,14 +110,14 @@ int cmd_help(Context *ctx, int argc, const char *argv[], FILE *stream)
     UNUSED(argv);
 
     fprintf(stream, "Example usage:\n");
-    fprintf(stream, "\twowpkg info ADDON...\n");
-    fprintf(stream, "\twowpkg install ADDON...\n");
-    fprintf(stream, "\twowpkg list\n");
-    fprintf(stream, "\twowpkg outdated\n");
-    fprintf(stream, "\twowpkg remove ADDON...\n");
-    fprintf(stream, "\twowpkg search TEXT\n");
-    fprintf(stream, "\twowpkg update [ADDON...]\n");
-    fprintf(stream, "\twowpkg upgrade [ADDON...]\n");
+    fprintf(stream, "\t" WOWPKG_NAME " info ADDON...\n");
+    fprintf(stream, "\t" WOWPKG_NAME " install ADDON...\n");
+    fprintf(stream, "\t" WOWPKG_NAME " list\n");
+    fprintf(stream, "\t" WOWPKG_NAME " outdated\n");
+    fprintf(stream, "\t" WOWPKG_NAME " remove ADDON...\n");
+    fprintf(stream, "\t" WOWPKG_NAME " search TEXT\n");
+    fprintf(stream, "\t" WOWPKG_NAME " update [ADDON...]\n");
+    fprintf(stream, "\t" WOWPKG_NAME " upgrade [ADDON...]\n");
 
     return 0;
 }

src/config.c

@@ -1,11 +1,7 @@
-#include <stdio.h>
 #include <stdlib.h>
 
-#include <cjson/cJSON.h>
-
 #include "config.h"
 #include "ini.h"
-#include "osapi.h"
 #include "osstring.h"
 
 Config *config_create(void)
@@ -28,56 +24,6 @@ void config_free(Config *cfg)
     free(cfg);
 }
 
-int config_from_json(Config *cfg, const char *json_str)
-{
-    int err = 0;
-
-    cJSON *json = cJSON_Parse(json_str);
-    if (json == NULL) {
-        err = -1;
-        goto cleanup;
-    }
-
-    cJSON *addons_path = cJSON_GetObjectItemCaseSensitive(json, "addons_path");
-    if (addons_path == NULL || !cJSON_IsString(addons_path)) {
-        err = -1;
-        goto cleanup;
-    }
-
-    cfg->addons_path = strdup(addons_path->valuestring);
-
-cleanup:
-    cJSON_Delete(json);
-
-    return err;
-}
-
-char *config_to_json(Config *cfg)
-{
-    int err = 0;
-    char *result = NULL;
-
-    cJSON *json = cJSON_CreateObject();
-    if (json == NULL) {
-        err = -1;
-        goto cleanup;
-    }
-
-    if (cJSON_AddStringToObject(json, "addons_path", cfg->addons_path) == NULL) {
-        err = -1;
-        goto cleanup;
-    }
-
-cleanup:
-    if (err == 0) {
-        result = cJSON_PrintUnformatted(json);
-    }
-
-    cJSON_Delete(json);
-
-    return result;
-}
-
 int config_load(Config *cfg, const char *path)
 {
     INI *ini = ini_open(path);

src/config.h

@@ -14,7 +14,4 @@ Config *config_create(void);
  */
 void config_free(Config *cfg);
 
-int config_from_json(Config *cfg, const char *json);
-char *config_to_json(Config *cfg);
-
 int config_load(Config *cfg, const char *path);

src/list.c

@@ -95,6 +95,8 @@ void list_remove(List *l, ListNode *node)
 
 void list_sort(List *l, ListCompareFn cmp)
 {
+    // Based on Simon Tatham's Mergesort For Linked List.
+    // https://www.chiark.greenend.org.uk/~sgtatham/algorithms/listsort.html
     size_t insize = 1;
 
     while (1) {

src/osapi.h

@@ -128,8 +128,7 @@ char *os_mkdtemp(char *template);
 
 /**
  * Attempts to get the temp directory for the current OS. If no value was found
- * then it returns the current working directory ".". This functions promises
- * that, at least at the time of the call, the directory exists.
+ * then it returns the current working directory ".".
  *
  * WARNING: The returned string may be statically allocated and as such shall
  * not be modified. Future calls of this function may change the contents of

src/zipper.c

@@ -1,6 +1,6 @@
-#include <stdbool.h>
 #include <stdio.h>
-#include <sys/stat.h>
+
+#include <minizip/unzip.h>
 
 #include "osapi.h"
 #include "osstring.h"

src/zipper.h

@@ -1,7 +1,5 @@
 #pragma once
 
-#include <minizip/unzip.h>
-
 enum {
     ZIPPER_OK = 0,