Merge pull request #2 from milosz275/cli

CLI

Author: milosz275

.gitignore

@@ -51,3 +51,6 @@ logs/
 
 # VSCode
 *.vc.*
+
+# BitLab history
+.*history.txt

.vscode/settings.json

@@ -1,11 +1,12 @@
 {
     "cSpell.language": "en,pl",
     "cSpell.words": [
+        "bitlab",
+        "Bitlab",
         "codespaces",
-        "Doxygen",
         "Doxyfile",
-        "bitlab",
-        "Bitlab"
+        "Doxygen",
+        "lineptr"
     ],
     "task.allowAutomaticTasks": "on",
     "editor.formatOnSave": true,
@@ -17,7 +18,9 @@
     "editor.formatOnPaste": true,
     "makefile.configureOnOpen": true,
     "files.associations": {
-        "bitlab.h": "c"
+        "bitlab.h": "c",
+        "utils.h": "c",
+        "state.h": "c"
     },
     "C_Cpp.formatting": "vcFormat",
     "C_Cpp.autoAddFileAssociations": true,

LICENSE

@@ -1,4 +1,4 @@
-MIT License
+# MIT License
 
 Copyright (c) 2024 Miłosz Maculewicz
 

Makefile

@@ -1,12 +1,18 @@
-SUBDIRS := $(filter-out assets/ build/ docs/, $(wildcard */))
+BITLAB = bitlab
 
-all: $(SUBDIRS)
-$(SUBDIRS):
-	$(MAKE) -C $@
+BITLAB_BIN = $(BITLAB)/build/bin/$(BITLAB)
 
-clean:
-	for dir in $(SUBDIRS); do \
-		$(MAKE) -C $$dir clean; \
-	done
+.PHONY: all bitlab
+all: bitlab
+debug: bitlab-debug
+
+bitlab:
+	$(MAKE) -C $(BITLAB)
 
-.PHONY: all $(SUBDIRS) clean
+bitlab-debug:
+	$(MAKE) -C $(BITLAB) debug
+
+clean:
+	find $(BITLAB)/build/src -name '*.o' -delete
+	find $(BITLAB)/build/src -name '*~' -delete
+	$(RM) $(BITLAB)/build/bin/$(BITLAB)

bitlab/include/bitlab.h

@@ -9,11 +9,11 @@ typedef enum
 
 /**
  * Run the BitLab program.
- * 
+ *
  * @param argc The number of arguments.
  * @param argv The arguments.
  * @return The result of the BitLab program.
  */
 bitlab_result run_bitlab(int argc, char* argv[]);
 
-#endif
+#endif // __BITLAB_H

bitlab/include/cli.h

@@ -0,0 +1,93 @@
+#ifndef __CLI_H
+#define __CLI_H
+
+#include <stdio.h>
+#include <stdlib.h>
+
+#define MAX_LINE_LEN 256
+#define CLI_BUFSIZE 64
+#define CLI_DELIM " "
+#define CLI_COMMANDS_NUM (int) (sizeof(cli_commands) / sizeof(cli_command))
+#define CLI_HISTORY_FILE ".bitlab_history.txt"
+
+/**
+ * CLI command structure.
+ *
+ * @param cli_command The function pointer to executed function.
+ * @param cli_command_name The name of command by which it is called.
+ * @param cli_command_description The description of command printed by !help.
+ */
+typedef struct
+{
+    int (*cli_command)(char**);
+    char* cli_command_name;
+    char* cli_command_description;
+} cli_command;
+
+/**
+ * Exits BitLab CLI command.
+ *
+ * @param args The arguments passed to the function should be empty.
+ * @return The exit code.
+ */
+int cli_exit(char** args);
+
+/**
+ * Prints CLI command history.
+ *
+ * @param args The arguments passed to the function should be empty.
+ * @return The exit code.
+ */
+int cli_history(char** args);
+
+/**
+ * Clears CLI window.
+ *
+ * @param args The arguments passed to the function should be empty.
+ * @return The exit code.
+ */
+int cli_clear(char** args);
+
+/**
+ * Prints CLI command help.
+ *
+ * @param args The arguments passed to this function should be empty.
+ * @return The exit code.
+ */
+int cli_help(char** args);
+
+/**
+ * Gets the line from the file stream.
+ *
+ * @param lineptr The pointer to the line.
+ * @param n The size of the line.
+ * @param stream The file stream.
+ * @return The number of characters read.
+ */
+int cli_get_line(char** lineptr, size_t* n, FILE* stream);
+
+/**
+ * Reads input from user.
+ *
+ * WARNING: char* returned from this function must be freed.
+ *
+ * @return The string containing input from user.
+ */
+char* cli_read_line(void);
+
+/**
+ * Execute command. This function executes a command from line.
+ *
+ * @param line The string containing input from user.
+ * @return The exit code.
+ */
+int cli_exec_line(char* line);
+
+/**
+ * CLI handler thread.
+ *
+ * @param arg Not used. Write dummy code for no warning.
+ */
+void* handle_cli(void* arg);
+
+#endif // __CLI_H

bitlab/include/log.h

@@ -10,6 +10,7 @@
 #define LOGS_DIR "logs"
 #define BITLAB_LOG "bitlab.log"
 #define LOG_BITLAB_STARTED "BitLab started ----------------------------------------------------------------------------------------"
+#define LOG_BITLAB_FINISHED "BitLab finished successfully"
 
 #define LOCKED_FILE_RETRY_TIME 1000 // in microseconds (1 millisecond)
 #define LOCKED_FILE_TIMEOUT 5000000 // in microseconds (5 seconds)
@@ -81,4 +82,4 @@ void log_message(log_level level, const char* filename, const char* source_file,
  */
 void finish_logging();
 
-#endif
+#endif // __LOG_H

bitlab/include/state.h

@@ -0,0 +1,31 @@
+#ifndef __STATE_H
+#define __STATE_H
+
+#include <signal.h>
+#include <unistd.h>
+#include <time.h>
+#include <fcntl.h>
+
+/**
+ * The program state structure used to store the state of the program.
+ *
+ * @param pid The process ID of the program.
+ * @param start_time The start time of the program.
+ * @param exit_flag The exit flag of the program.
+ */
+typedef struct
+{
+    pid_t pid;
+    time_t start_time;
+    volatile sig_atomic_t exit_flag;
+} program_state;
+
+extern program_state state;
+
+void init_program_state(program_state* state);
+
+void set_exit_flag(program_state* state, sig_atomic_t flag);
+
+sig_atomic_t get_exit_flag(program_state* state);
+
+#endif

bitlab/include/utils.h

@@ -1,10 +1,13 @@
 #ifndef __UTILS_H
 #define __UTILS_H
 
+#include <stdio.h>
 #include <stddef.h>
 
 #define TIMESTAMP_LENGTH 20
 
+void usleep(unsigned int usec);
+
 /**
  * Get the timestamp. This function is used to get the timestamp in a YYYYMMDDHHMMSS format.
  *
@@ -21,4 +24,9 @@ void get_timestamp(char* buffer, size_t buffer_size);
  */
 void get_formatted_timestamp(char* buffer, size_t buffer_size);
 
-#endif
+/**
+ * Clear the CLI window.
+ */
+void clear_cli();
+
+#endif // __UTILS_H

bitlab/src/bitlab.c

@@ -1,20 +1,37 @@
 #include "bitlab.h"
 
 #include <stdio.h>
+#include <pthread.h>
+#include <errno.h>
+#include <string.h>
 
+#include "state.h"
 #include "log.h"
+#include "cli.h"
+#include "utils.h"
 
 bitlab_result run_bitlab(int argc, char* argv[])
 {
-    // [ ] Utilize the argc and argv parameters.
+    // [ ] utilize the argc and argv parameters.
     if (argc != 1 && argv != NULL) {}
 
+    // init
     init_logging(BITLAB_LOG);
     log_message(LOG_INFO, BITLAB_LOG, __FILE__, LOG_BITLAB_STARTED);
+    init_program_state(&state);
 
+    pthread_t cli_thread;
+    if (pthread_create(&cli_thread, NULL, handle_cli, (void*)NULL) != 0)
+        log_message(LOG_WARN, BITLAB_LOG, __FILE__, "CLI thread creation failed: %s", strerror(errno));
+    log_message(LOG_INFO, BITLAB_LOG, __FILE__, "CLI thread started");
 
-    printf("BitLab is running!\n");
+    // main loop
+    while (!get_exit_flag(&state))
+        usleep(100000); // 100 ms
 
+    // cleanup
+    pthread_join(cli_thread, NULL);
+    log_message(LOG_INFO, BITLAB_LOG, __FILE__, LOG_BITLAB_FINISHED);
     finish_logging();
     return BITLAB_RESULT_SUCCESS;
 }