Some better readability changes

Author: pradosh-arduino

source/Makefile

@@ -54,7 +54,7 @@ $(eval $(call DEFAULT_VAR,LDFLAGS,$(DEFAULT_LDFLAGS)))
 
 # Internal C flags that should not be changed by the user.
 override CFLAGS += \
-    -Wall \
+    -w \
     -std=gnu11 \
     -ffreestanding \
     -fno-stack-protector \
@@ -163,23 +163,27 @@ all: ./kernel/typescript/compile.sh $(KERNEL)
 $(KERNEL): linker/$(ARCH).ld $(OBJ)
 	@mkdir -p "$$(dirname $@)"
 	@$(LD) $(OBJ) $(LDFLAGS) -o $@
+	@echo "\033[1;32mLinking using\033[0m $<"
 
 # Include header dependencies.
 -include $(HEADER_DEPS)
 
 # Compilation rules for *.c files.
 obj/%.c.o: %.c includes/limine.h
 	@mkdir -p "$$(dirname $@)"
+	@echo "\033[1;34mCompiling\033[0m $<"
 	@$(CC) $(CFLAGS) $(CPPFLAGS) -c $< -o $@
 
 # Compilation rules for *.S files.
 obj/%.S.o: %.S
 	@mkdir -p "$$(dirname $@)"
+	@echo "\033[1;34mAssembling\033[0m $<"
 	@$(CC) $(CFLAGS) $(CPPFLAGS) -c $< -o $@
 
 # Compilation rules for *.asm (nasm) files.
 obj/%.asm.o: %.asm
 	@mkdir -p "$$(dirname $@)"
+	@echo "\033[1;34mAssembling\033[0m $<"
 	@nasm $(NASMFLAGS) $< -o $@
 
 # Remove object files

source/includes/acpi-shutdown.h

@@ -13,13 +13,14 @@
 
 #include <stddef.h>
 #include <stdint.h>
+#include <basics.h>
 
 int acpi_shutdown_hack(
         uintptr_t direct_map_base,
-        void   *(*find_sdt)(const char *signature, size_t index),
-        uint8_t (*inb)(uint16_t port),
-        uint16_t (*inw)(uint16_t port),
-        void    (*outb)(uint16_t port, uint8_t value),
-        void    (*outw)(uint16_t port, uint16_t value)
+        void   *(*find_sdt)(cstring signature, size_t index),
+        int8 (*inb)(int16 port),
+        int16 (*inw)(int16 port),
+        void    (*outb)(int16 port, int8 value),
+        void    (*outw)(int16 port, int16 value)
     );
 #endif

source/includes/basics.h

@@ -0,0 +1,12 @@
+#include <stdint.h>
+#include <stddef.h>
+
+typedef uint64_t int64;
+typedef uint32_t int32;
+typedef uint16_t int16;
+typedef uint8_t int8;
+
+#define null NULL
+
+typedef const char* cstring;
+typedef char* string;

source/includes/debugger.h

@@ -10,6 +10,7 @@
  */
 #include <stdint.h>
 #include <stddef.h>
+#include <basics.h>
 #include <hal.h>
 
 /**
@@ -32,4 +33,4 @@ void debug_putc(char c);
  * 
  * @param msg 
  */
-void debug_print(const char * msg);
+void debug_print(cstring msg);

source/includes/graphics.h

@@ -15,13 +15,14 @@
 #include <stddef.h>
 #include <stdarg.h>
 #include <stdbool.h>
+#include <basics.h>
 
 // ANSI color codes for text formatting
-#define ANSI_COLOR_RESET "\x1b[0m"
-#define ANSI_COLOR_RED "\x1b[91m"
-#define ANSI_COLOR_YELLOW "\x1b[93m"
-#define ANSI_COLOR_BLUE "\x1b[36m"
-#define ANSI_COLOR_GREEN "\x1b[32m"
+#define reset_color  "\x1b[0m"
+#define red_color    "\x1b[91m"
+#define yellow_color "\x1b[93m"
+#define blue_color   "\x1b[36m"
+#define green_color  "\x1b[32m"
 
 /**
  * @brief Display a warning message.
@@ -31,7 +32,7 @@
  * @param message The warning message to be displayed.
  * @param file The file name where the warning occurred.
  */
-void warn(const char *message, const char* file);
+void warn(cstring message, cstring  file);
 
 /**
  * @brief Display an error message.
@@ -41,7 +42,7 @@ void warn(const char *message, const char* file);
  * @param message The error message to be displayed.
  * @param file The file name where the error occurred.
  */
-void error(const char *message, const char* file);
+void error(cstring message, cstring  file);
 
 /**
  * @brief Display an informational message.
@@ -51,7 +52,7 @@ void error(const char *message, const char* file);
  * @param message The informational message to be displayed.
  * @param file The file name where the information is coming from.
  */
-void info(const char *message, const char* file);
+void info(cstring message, cstring  file);
 
 /**
  * @brief Display a success message.
@@ -61,7 +62,7 @@ void info(const char *message, const char* file);
  * @param message The success message to be displayed.
  * @param file The file name associated with the success.
  */
-void done(const char *message, const char* file);
+void done(cstring message, cstring  file);
 
 /* Normal Hybrid printing functions ahead */
 
@@ -93,6 +94,6 @@ void printhex(int hex);
  * @param format 
  * @param ... 
  */
-void printf(const char *format, ...);
+void printf(cstring format, ...);
 
 #endif

source/includes/hal.h

@@ -10,6 +10,7 @@
  */
 
 #include <stdint.h>
+#include <basics.h>
 
 /**
  * @brief Output a byte to the specified I/O port.
@@ -19,7 +20,7 @@
  * @param port  The 16-bit I/O port number.
  * @param value The 8-bit value to be sent to the port.
  */
-void outb(uint16_t port, uint8_t value);
+void outb(int16 port, int8 value);
 
 /**
  * @brief Read a byte from the specified I/O port.
@@ -29,7 +30,7 @@ void outb(uint16_t port, uint8_t value);
  * @param port The 16-bit I/O port number.
  * @return    The 8-bit value read from the port.
  */
-uint8_t inb(uint16_t port);
+int8 inb(int16 port);
 
 /**
  * @brief Output a 16-bit value to the specified I/O port.
@@ -39,7 +40,7 @@ uint8_t inb(uint16_t port);
  * @param portNumber The 16-bit I/O port number.
  * @param data       The 16-bit value to be sent to the port.
  */
-void outw(uint16_t portNumber, uint16_t data);
+void outw(int16 portNumber, int16 data);
 
 /**
  * @brief Read a 16-bit value from the specified I/O port.
@@ -49,7 +50,7 @@ void outw(uint16_t portNumber, uint16_t data);
  * @param portNumber The 16-bit I/O port number.
  * @return           The 16-bit value read from the port.
  */
-uint16_t inw(uint16_t portNumber);
+int16 inw(int16 portNumber);
 
 /**
  * @brief Read a 32-bit value from the specified I/O port.
@@ -59,7 +60,7 @@ uint16_t inw(uint16_t portNumber);
  * @param portNumber The 16-bit I/O port number.
  * @return           The 32-bit value read from the port.
  */
-uint32_t inl(uint16_t portNumber);
+int32 inl(int16 portNumber);
 
 /**
  * @brief Output a 32-bit value to the specified I/O port.
@@ -69,7 +70,7 @@ uint32_t inl(uint16_t portNumber);
  * @param portNumber The 16-bit I/O port number.
  * @param data       The 32-bit value to be sent to the port.
  */
-void outl(uint16_t portNumber, uint32_t data);
+void outl(int16 portNumber, int32 data);
 
 /**
  * @brief Perform an I/O wait operation.

source/includes/kernel.h

@@ -27,12 +27,13 @@
 #include <typescript-loader.h>
 #include <debugger.h>
 #include <drivers/serial.h>
+#include <basics.h>
 
 /**
  * @brief The memory address pointer where the kernel ends.
  * 
  */
-extern uint64_t* kend;
+extern int64* kend;
 
 /**
  * @brief Halt and catch fire function.
@@ -69,10 +70,10 @@ extern int terminal_columns;
  * @brief The fake or pseudo frame buffer in the memory which will be queued for next frame update
  * 
  */
-extern uint64_t* back_buffer;
+extern int64* back_buffer;
 
 /**
  * @brief Direct pointer to framebuffer->address. It doesn't queue, directly writes to the memory
  * 
  */
-extern uint64_t* front_buffer;
+extern int64* front_buffer;

source/includes/pci.h

@@ -12,50 +12,50 @@
 #include <hal.h>
 #include <graphics.h>
 
-extern const char* display_adapter_name;
-extern const char* GPUName[1]; //Max 2 GPUs allowed
+extern cstring display_adapter_name;
+extern cstring GPUName[1]; //Max 2 GPUs allowed
 
-uint16_t pci_read_word(uint16_t bus, uint16_t slot, uint16_t func, uint16_t offset);
+int16 pci_read_word(int16 bus, int16 slot, int16 func, int16 offset);
 
 /**
  * @brief Gets the Vendor ID from PCI
  * 
  * @param bus 
  * @param device 
  * @param function 
- * @return uint16_t Vendor ID
+ * @return int16 Vendor ID
  */
-uint16_t getVendorID(uint16_t bus, uint16_t device, uint16_t function);
+int16 getVendorID(int16 bus, int16 device, int16 function);
 
 /**
  * @brief Gets the Device ID from PCI
  * 
  * @param bus 
  * @param device 
  * @param function 
- * @return uint16_t  Device ID
+ * @return int16  Device ID
  */
-uint16_t getDeviceID(uint16_t bus, uint16_t device, uint16_t function);
+int16 getDeviceID(int16 bus, int16 device, int16 function);
 
 /**
  * @brief Gets the Class ID from PCI
  * 
  * @param bus 
  * @param device 
  * @param function 
- * @return uint16_t Class ID
+ * @return int16 Class ID
  */
-uint16_t getClassId(uint16_t bus, uint16_t device, uint16_t function);
+int16 getClassId(int16 bus, int16 device, int16 function);
 
 /**
  * @brief Gets the Sub-class ID from PCI
  * 
  * @param bus 
  * @param device 
  * @param function 
- * @return uint16_t Sub-class ID
+ * @return int16 Sub-class ID
  */
-uint16_t getSubClassId(uint16_t bus, uint16_t device, uint16_t function);
+int16 getSubClassId(int16 bus, int16 device, int16 function);
 
 /**
  * @brief Scans (Probes) PCI Devices

source/includes/strings.h

@@ -11,8 +11,9 @@
 #include <stdint.h>
 #include <stddef.h>
 #include <stdbool.h>
+#include <basics.h>
 
-typedef char symbol[];
+// typedef char symbol[];
 
 /**
  * @brief Calculate the length of a null-terminated string.
@@ -32,7 +33,7 @@ int strlen_(char s[]);
  * @param src Source string
  * @returns The resulting copy of the string `src`
  */
-char *strcpy(char *dest, const char *src);
+string strcpy(string dest, cstring src);
 
 /**
  * @brief Copies `n` characters from `src` to `dest`
@@ -42,7 +43,7 @@ char *strcpy(char *dest, const char *src);
  * @param n Number of characters that will be copies
  * @returns The resulting copy of the string `src`
  */
-char *strncpy(char *dest, const char *src, size_t n);
+string strncpy(string dest, cstring src, size_t n);
 
 /**
  * @brief Compares two strings lexicographically.
@@ -56,7 +57,7 @@ char *strncpy(char *dest, const char *src, size_t n);
  * @returns An integer less than, equal to, or greater than zero, depending on the
  *         comparison result.
  */
-int strcmp(const char *s1, const char *s2);
+int strcmp(cstring s1, cstring s2);
 
 /**
  * @brief Compares two strings, up to a specified number of characters.
@@ -71,7 +72,7 @@ int strcmp(const char *s1, const char *s2);
  * @return An integer less than, equal to, or greater than zero, depending on the
  *         comparison result.
  */
-int strncmp(const char *s1, const char *s2, size_t n);
+int strncmp(cstring s1, cstring s2, size_t n);
 
 /**
  * @brief Check if a substring is found within a string.
@@ -82,4 +83,4 @@ int strncmp(const char *s1, const char *s2, size_t n);
  * @param substr The substring to search for.
  * @return true if the substring is found in the string, false otherwise.
  */
-bool contains(const char *str, const char *substr);
+bool contains(cstring str, cstring substr);

source/includes/unifont.h

@@ -9,11 +9,12 @@
  * 
  */
 #include <stdint.h>
+#include <basics.h>
 
 #define UNIFONT_WIDTH 8
 #define UNIFONT_HEIGHT 16
 
-static const uint8_t unifont[] = {
+static const int8 unifont[] = {
     0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
     0x00, 0x00, 0x00, 0x00, 0x3c, 0x42, 0x81, 0xa5, 0x81, 0xa5, 0x99, 0x42, 0x3c, 0x00, 0x00, 0x00,
     0x00, 0x00, 0x00, 0x00, 0x3c, 0x7e, 0xff, 0xdb, 0xff, 0xdb, 0xe7, 0x7e, 0x3c, 0x00, 0x00, 0x00,