Merge pull request #1 from benji-utility/rework

Rework the base API

Author: kryllyxofficial01

.github/workflow/build.yml

@@ -0,0 +1,39 @@
+name: Build (Linux + Windows)
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  build:
+    name: Build on ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-latest, windows-latest]
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up build environment
+        if: matrix.os == 'ubuntu-latest'
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y make gcc
+
+      - name: Set up build environment (Windows)
+        if: matrix.os == 'windows-latest'
+        run: |
+          choco install make mingw
+        shell: pwsh
+
+      - name: Build library and tests
+        run: make all
+        shell: bash
+
+      - name: Show build output
+        run: ls -R build
+        shell: bash

.gitignore

@@ -53,3 +53,6 @@ dkms.conf
 
 # debug information files
 *.dwo
+
+# Build directory
+build

Makefile

@@ -3,48 +3,54 @@ GXX := gcc
 GXX_FLAGS := -g -Wno-discarded-qualifiers
 
 SRC := src
-TESTS := tests
 BUILD := build
+OBJ := $(BUILD)/obj
 
 SRCS := $(wildcard $(SRC)/*.c)
-TESTS_SRCS := $(wildcard $(TESTS)/*.c)
+OBJS := $(patsubst $(SRC)/%.c, $(OBJ)/%.o, $(SRCS))
 
-OBJS := $(patsubst $(SRC)/%.c, $(BUILD)/%.o, $(SRCS))
+TEST_DIR := tests
+TEST_OBJ := $(OBJ)/$(TEST_DIR)
+TEST_SRCS := $(wildcard $(TEST_DIR)/*.c)
+TEST_OBJS := $(patsubst $(TEST_DIR)/%.c, $(TEST_OBJ)/%.o, $(TEST_SRCS))
+TEST_BIN := $(patsubst $(TEST_DIR)/%.c, $(BUILD)/%, $(TEST_SRCS))
 
-TESTS_LINKED_LIBS := -lWs2_32
+ifeq ($(OS), Windows_NT)
+	LINKED_LIBS := -lWs2_32
+else
+	LINKED_LIBS :=
+endif
 
-# STATIC_LIB := $(BUILD)/libcrocket.a
+LIB := $(BUILD)/libcrocket.a
 
-# all: clean $(STATIC_LIB)
-all: clean
+.PHONY: all clean mkbuild
 
-# $(STATIC_LIB): $(OBJS)
-# 	ar rcs $@ $^
+all: mkbuild $(LIB) $(TEST_BIN)
 
 $(OBJ)/%.o: $(SRC)/%.c
 	$(GXX) $(GXX_FLAGS) -c $< -o $@
 
-ifeq ($(OS), Windows_NT)
-.SILENT: clean
-endif
+$(TEST_OBJ)/%.o: $(TEST_DIR)/%.c
+	$(GXX) $(GXX_FLAGS) -c $< -o $@
 
-.PHONY: clean mkbuild
+$(LIB): $(OBJS)
+	ar rcs $@ $(OBJS)
 
-clean: mkbuild
-ifeq ($(OS), Windows_NT)
-	del /Q /S $(BUILD)\*
-else
-	find $(BUILD) -maxdepth 1 -type f -exec rm {} \;
-	rm -rf $(OBJ)/*
-endif
+$(BUILD)/%: $(TEST_OBJ)/%.o $(LIB)
+	$(GXX) $(GXX_FLAGS) -o $@ $< -L$(BUILD) -lcrocket $(LINKED_LIBS)
 
 mkbuild:
 ifeq ($(OS), Windows_NT)
 	if not exist "$(BUILD)" mkdir "$(BUILD)"
+	if not exist "$(OBJ)" mkdir "$(OBJ)"
+	if not exist "$(TEST_OBJ)" mkdir "$(TEST_OBJ)"
 else
-	mkdir -p $(BUILD)
-	mkdir -p $(OBJ)
+	mkdir -p $(BUILD) $(OBJ) $(TEST_OBJ)
 endif
 
-test: clean
-	$(GXX) $(GXX_FLAGS) $(SRCS) $(TESTS_SRCS) -o $(BUILD)/tests $(TESTS_LINKED_LIBS)
+clean: mkbuild
+ifeq ($(OS), Windows_NT)
+	del /Q /S $(BUILD)\*
+else
+	rm -rf $(BUILD)/*
+endif

src/crocket.h

@@ -1,6 +1,8 @@
 #ifndef __CROCKET_H
 #define __CROCKET_H
 
+#include "crocket_base.h"
+
 #include "socket.h"
 
 #endif

src/crocket_base.c

@@ -1,37 +1,33 @@
 #include "crocket_base.h"
 
-#ifdef CROCKET_WINDOWS
-    CROCKET_API bool crocket_winsock_init() {
+#if defined(CROCKET_WINDOWS)
+    static bool _crocket_is_winsock_initialized = false;
+
+    CROCKET_API bool winsock_init() {
+        if (_crocket_is_winsock_initialized) return true;
+
         struct WSAData wsa_data;
 
-        if (WSAStartup(WINSOCK_VERSION, &wsa_data) != CROCKET_ERROR_NONE) {
-            _crocket_update_error_context(
-                WSAGetLastError(),
-                "WSAStartup() failed"
-            );
+        if (WSAStartup(WINSOCK_VERSION, &wsa_data) != CROCKET_SUCCESS) {
+            // todo: collect error info
 
             return false;
         }
 
+        _crocket_is_winsock_initialized = true;
+
         return true;
     }
 
-    CROCKET_API bool crocket_winsock_cleanup() {
-        if (WSACleanup() != CROCKET_ERROR_NONE) {
-            int error_code = WSAGetLastError();
-
-            if (error_code == WSANOTINITIALISED) {
-                _crocket_update_error_context(
-                    CROCKET_ERROR_WINSOCK_NOT_INITIALIZED,
-                    "Operation not permitted, Winsock not initialized"
-                );
-            }
-            else {
-                _crocket_update_error_context(
-                    error_code,
-                    "Failed to cleanup Winsock"
-                );
-            }
+    CROCKET_API bool winsock_cleanup() {
+        if (!_crocket_is_winsock_initialized) {
+            // todo: collect error info
+
+            return false;
+        }
+
+        if (WSACleanup() != CROCKET_SUCCESS) {
+            // todo: collect error info
 
             return false;
         }

src/crocket_base.h

@@ -1,10 +1,12 @@
 #ifndef __CROCKET_BASE_H
 #define __CROCKET_BASE_H
 
+#include <stdlib.h>
+#include <string.h>
+#include <stdint.h>
 #include <stdbool.h>
 
 #include "platform.h"
-#include "error.h"
 
 #if defined(CROCKET_WINDOWS)
     #pragma comment(lib, "ws2_32.lib")
@@ -15,48 +17,47 @@
 
     #include <winsock2.h>
     #include <ws2tcpip.h>
+    #include <windows.h>
 
     #ifndef CROCKET_API
-        #define CROCKET_API WINAPI
+        #define CROCKET_API WSAAPI
     #endif
 
-    #ifndef CROCKET_SOCKET_ERROR
-        #define CROCKET_SOCKET_ERROR SOCKET_ERROR
-    #endif
-
-    #ifndef CROCKET_INVALID_SOCKET
-        #define CROCKET_INVALID_SOCKET INVALID_SOCKET
-    #endif
-
-    #ifndef _CROCKET_SOCKADDR_IN_ADDRESS
-        #define _CROCKET_SOCKADDR_IN_ADDRESS(_sockaddr_in) (_sockaddr_in.sin_addr.S_un.S_addr)
-    #endif
+    typedef SOCKET socket_handle_t;
 #elif defined(CROCKET_LINUX)
+    #include <sys/types.h>
+    #include <sys/socket.h>
+    #include <netinet/in.h>
+    #include <arpa/inet.h>
+    #include <unistd.h>
     #include <errno.h>
 
     #ifndef CROCKET_API
         #define CROCKET_API
     #endif
 
-    // linux does not have a default socket type so we rollin' our own
-    typedef unsigned long long SOCKET;
+    typedef int socket_handle_t;
+#endif
 
-    #ifndef CROCKET_SOCKET_ERROR
-        #define CROCKET_SOCKET_ERROR (-1)
-    #endif
+#ifndef CROCKET_SUCCESS
+    #define CROCKET_SUCCESS (0)
+#endif
 
-    #ifndef CROCKET_INVALID_SOCKET
-        #define CROCKET_INVALID_SOCKET (CROCKET_SOCKET)(~0)
-    #endif
+#ifndef CROCKET_NO_FLAGS
+    #define CROCKET_NO_FLAGS (0)
+#endif
 
-    #ifndef _CROCKET_SOCKADDR_IN_ADDRESS
-        #define _CROCKET_SOCKADDR_IN_ADDRESS(_sockaddr_in) (_sockaddr_in.sin_addr.s_addr)
-    #endif
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+#if defined(CROCKET_WINDOWS)
+    CROCKET_API bool winsock_init();
+    CROCKET_API bool winsock_cleanup();
 #endif
 
-#ifdef CROCKET_WINDOWS
-    CROCKET_API bool crocket_winsock_init();
-    CROCKET_API bool crocket_winsock_cleanup();
+#ifdef __cplusplus
+}
 #endif
 
 #endif

src/error.c

@@ -1,11 +1,14 @@
 #ifndef __CROCKET_PLATFORM_H
-    #if defined(_WIN32) || defined(_WIN64)
-        #ifndef CROCKET_WINDOWS
-            #define CROCKET_WINDOWS
-        #endif
-    #elif defined(__linux__)
-        #ifndef CROCKET_LINUX
-            #define CROCKET_LINUX
-        #endif
+#define __CROCKET_PLATFORM_H
+
+#ifdef _WIN32
+    #ifndef CROCKET_WINDOWS
+        #define CROCKET_WINDOWS
     #endif
-#endif
+#elif defined(__linux__)
+    #ifndef CROCKET_LINUX
+        #define CROCKET_LINUX
+    #endif
+#endif
+
+#endif