Merge pull request #27 from sandbox-science/update/structure/syntax

Refactor Syntax Highlighting for multi-lingual support

Author: chrisdedman

.github/workflows/cpp.yml

@@ -31,15 +31,15 @@ jobs:
       if: matrix.os == 'ubuntu-latest'
       run: |
         sudo apt-get update
-        sudo apt-get install -y g++ make cmake
+        sudo apt-get install -y g++ make cmake libyaml-cpp-dev
         g++ --version
         cmake --version
         make --version
 
     - name: Set up C++ environment (macOS)
       if: matrix.os == 'macos-latest'
       run: |
-        brew install make cmake
+        brew install make cmake yaml-cpp
         echo 'export PATH="/usr/local/opt/gcc/bin:$PATH"' >> ~/.bash_profile
         source ~/.bash_profile
         g++ --version
@@ -83,15 +83,8 @@ jobs:
     - name: Build project
       run: make build
 
-    # Install the Project with desktop shortcut
-    - name: Install project (Mac/Windows)
-      if: matrix.os != 'ubuntu-latest'
+    # Install the Project
+    - name: Install project
       run: |
         cd ${{ github.workspace }}
-        echo "y" | make install
-
-    # Install the Project without desktop shortcut (Linux)
-    # This is a work around for Linux shortcut bug
-    - name: Install project (Linux)
-      if: matrix.os == 'ubuntu-latest'
-      run: echo "n" | make install
+        make install

.github/workflows/test.yml

@@ -28,15 +28,15 @@ jobs:
         if: matrix.os == 'ubuntu-latest'
         run: |
           sudo apt-get update
-          sudo apt-get install -y g++ make cmake
+          sudo apt-get install -y g++ make cmake libyaml-cpp-dev
           g++ --version
           cmake --version
           make --version
   
       - name: Set up C++ environment (macOS)
         if: matrix.os == 'macos-latest'
         run: |
-          brew install make cmake
+          brew install make cmake yaml-cpp
           echo 'export PATH="/usr/local/opt/gcc/bin:$PATH"' >> ~/.bash_profile
           source ~/.bash_profile
           g++ --version

CMakeLists.txt

@@ -17,6 +17,7 @@ set(CMAKE_CXX_STANDARD_REQUIRED ON)
 
 # Set default build output directories
 set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_SOURCE_DIR})
+set(CMAKE_INSTALL_PREFIX ${CMAKE_BINARY_DIR})
 
 # Detect operating system
 if(WIN32)
@@ -47,31 +48,59 @@ endif()
 # Set Qt path for find_package
 set(CMAKE_PREFIX_PATH ${Qt_DIR})
 
-# Find Qt Widgets
-find_package(Qt${QT_MAJOR_VERSION} COMPONENTS Widgets Test REQUIRED)
+# Find Qt components
+find_package(Qt${QT_MAJOR_VERSION} REQUIRED COMPONENTS Core Widgets Test)
+
+# Locate yaml-cpp
+if(APPLE)
+    set(yaml-cpp_DIR "/opt/homebrew/Cellar/yaml-cpp/0.8.0/lib/cmake/yaml-cpp")
+endif()
+find_package(yaml-cpp REQUIRED CONFIG)
+
+# Copy YAML files to the build directory (non-macOS case)
+set(YAML_SOURCE_DIR ${CMAKE_SOURCE_DIR}/config)
+set(YAML_DEST_DIR ${CMAKE_BINARY_DIR}/config)
+file(MAKE_DIRECTORY ${YAML_DEST_DIR})
+file(GLOB YAML_FILES "${YAML_SOURCE_DIR}/*.yaml")
+
+foreach(YAML_FILE ${YAML_FILES})
+    file(COPY ${YAML_FILE} DESTINATION ${YAML_DEST_DIR})
+endforeach()
 
 # Create the CodeAstra library
 add_library(${TARGET_NAME}
     src/MainWindow.cpp
     src/CodeEditor.cpp
-    src/Syntax.cpp
     src/Tree.cpp
     src/FileManager.cpp
+    src/Syntax.cpp
+    src/SyntaxManager.cpp
     include/MainWindow.h
     include/CodeEditor.h
-    include/Syntax.h
     include/Tree.h
     include/LineNumberArea.h
     include/FileManager.h
+    include/SyntaxManager.h
+    include/Syntax.h
 )
 
+# Link YAML-CPP to the CodeAstra library
+target_link_libraries(${TARGET_NAME} PRIVATE yaml-cpp)
+
 # Create the executable for the application
-add_executable(${EXECUTABLE_NAME}
-    src/main.cpp
-)
+add_executable(${EXECUTABLE_NAME} src/main.cpp)
+
+# Ensure YAML config files are copied into macOS app bundle
+# if(APPLE)
+#     add_custom_command(TARGET ${EXECUTABLE_NAME} POST_BUILD
+#         COMMAND ${CMAKE_COMMAND} -E make_directory "$<TARGET_BUNDLE_DIR:${EXECUTABLE_NAME}>/Contents/Resources/config"
+#         COMMAND ${CMAKE_COMMAND} -E copy_directory "${YAML_SOURCE_DIR}" "$<TARGET_BUNDLE_DIR:${EXECUTABLE_NAME}>/Contents/Resources/config"
+#         COMMENT "Copying YAML config files into macOS app bundle..."
+#     )
+# endif()
 
 # Link the main executable with the CodeAstra library and Qt libraries
-target_link_libraries(${EXECUTABLE_NAME} PRIVATE ${TARGET_NAME} Qt${QT_MAJOR_VERSION}::Widgets)
+target_link_libraries(${EXECUTABLE_NAME} PRIVATE ${TARGET_NAME} Qt${QT_MAJOR_VERSION}::Core Qt${QT_MAJOR_VERSION}::Widgets)
 
 # Add the tests subdirectory
 add_subdirectory(tests)
@@ -85,7 +114,7 @@ if(MSVC)
     target_compile_options(${EXECUTABLE_NAME} PRIVATE /W4 /WX)
 elseif(APPLE)
     target_compile_options(${EXECUTABLE_NAME} PRIVATE -Wall -Wextra -pedantic -Werror)
-    set_target_properties(${EXECUTABLE_NAME} PROPERTIES MACOSX_BUNDLE TRUE)
+    # set_target_properties(${EXECUTABLE_NAME} PROPERTIES MACOSX_BUNDLE TRUE)
 else()
     target_compile_options(${EXECUTABLE_NAME} PRIVATE -Wall -Wextra -pedantic -Werror)
 endif()
@@ -103,4 +132,10 @@ set_target_properties(${EXECUTABLE_NAME} PROPERTIES
 )
 
 # Link necessary Qt libraries to CodeAstra library
-target_link_libraries(${TARGET_NAME} PRIVATE Qt${QT_MAJOR_VERSION}::Widgets)
+target_link_libraries(${TARGET_NAME} PRIVATE Qt${QT_MAJOR_VERSION}::Core Qt${QT_MAJOR_VERSION}::Widgets)
+
+# Ensure correct linking of yaml-cpp (macOS)
+if(APPLE)
+    target_include_directories(${EXECUTABLE_NAME} PRIVATE /opt/homebrew/include)
+    target_link_directories(${EXECUTABLE_NAME} PRIVATE /opt/homebrew/lib)
+endif()

Dockerfile

@@ -13,7 +13,8 @@ RUN apt-get install -y --no-install-recommends \
     qt6-base-dev \
     x11-utils \
     x11-xserver-utils \
-    xvfb
+    xvfb \
+    libyaml-cpp-dev
 RUN rm -rf /var/lib/apt/lists/*
 
 # Copy CodeAstra into the container

Makefile

@@ -10,7 +10,7 @@ all: build install
 
 # Run CMake to build the project
 build:
-	@echo "Building project with CMake..."
+	@echo "Building $(PROJECT) with CMake..."
 	@mkdir -p $(BUILD_DIR)
 	@cd $(BUILD_DIR) && cmake $(CMAKE_OPTIONS)
 
@@ -21,59 +21,13 @@ clean:
 
 # Uninstalling the software
 uninstall: clean
-	@echo "Uninstalling the software..."
+	@echo "Uninstalling $(PROJECT)..."
 	@rm -rf $(EXECUTABLE).app $(EXECUTABLE)d.app
-	@OS_NAME=$(shell uname -s 2>/dev/null || echo "Windows"); \
-	if [ "$$OS_NAME" = "Darwin" ]; then \
-		rm -rf "$(HOME)/Desktop/$(EXECUTABLE).app"; \
-		echo "MacOS: Shortcut removed..."; \
-	elif [ "$$OS_NAME" = "Linux" ] && grep -qi "microsoft" /proc/version 2>/dev/null; then \
-		rm -rf "$(HOME)/Desktop/$(EXECUTABLE)"; \
-		echo "WSL: Shortcut removed..."; \
-	elif [ "$$OS_NAME" = "Linux" ]; then \
-		rm -rf "$(HOME)/Desktop/$(EXECUTABLE)"; \
-		echo "Linux: Shortcut removed..."; \
-	elif echo "$$OS_NAME" | grep -qE "CYGWIN|MINGW|MSYS"; then \
-		rm -f "$(USERPROFILE)/Desktop/$(EXECUTABLE).exe"; \
-		echo "Cygwin/Mingw/MSYS: Shortcut removed..."; \
-	elif [ "$$OS_NAME" = "Windows" ]; then \
-		if [ -n "$$USERPROFILE" ]; then \
-			cmd /c "if exist \"$$USERPROFILE\\Desktop\\$(EXECUTABLE).exe\" del /f /q \"$$USERPROFILE\\Desktop\\$(EXECUTABLE).exe\"" && echo "Windows: Shortcut removed..."; \
-		else \
-			echo "Windows: Could not determine user profile directory."; \
-		fi \
-	fi
 
 # Install the project
 install: build
 	@echo "Installing $(PROJECT)..."
 	@cd $(BUILD_DIR) && make
-	@echo "Do you want to create a shortcut on the desktop? (Y/n)"
-	@read choice; \
-	if [ "$$choice" = "y" ] || [ "$$choice" = "Y" ]; then \
-		echo "Creating shortcut..."; \
-		OS_NAME=$(shell uname -s); \
-		if [ "$$OS_NAME" = "Darwin" ]; then \
-			echo "MacOS Detected..."; \
-			cp -R $(EXECUTABLE).app ~/Desktop/; \
-		elif [ "$$OS_NAME" = "Linux" ] && grep -qi "microsoft" /proc/version 2>/dev/null; then \
-			echo "WSL Detected..."; \
-			cp $(EXECUTABLE) ~/Desktop/; \
-		elif [ "$$OS_NAME" = "Linux" ]; then \
-			echo "Linux Detected..."; \
-			cp $(EXECUTABLE) ~/Desktop/; \
-		elif echo "$$OS_NAME" | grep -qE "CYGWIN|MINGW|MSYS"; then \
-			echo "Windows-like Environment Detected (Cygwin/MSYS)..."; \
-			cp $(EXECUTABLE).exe "$$USERPROFILE/Desktop/"; \
-		elif [ "$$OS_NAME" = "Windows" ]; then \
-			echo "Native Windows Detected..."; \
-			if [ -n "$$USERPROFILE" ]; then \
-				cp $(EXECUTABLE).exe "$$USERPROFILE/Desktop/"; \
-			else \
-				echo "Windows: Could not determine user profile directory."; \
-			fi \
-		fi \
-	fi
 	@echo "$(PROJECT) installed."
 
 build_tests: build

README.md

@@ -6,6 +6,7 @@
 
   <!-- C++ CI Badge -->
   [![C++ CI](https://github.com/sandbox-science/CodeAstra/actions/workflows/cpp.yml/badge.svg)](https://github.com/sandbox-science/CodeAstra/actions/workflows/cpp.yml)
+  [![Test CI](https://github.com/sandbox-science/CodeAstra/actions/workflows/test.yml/badge.svg)](https://github.com/sandbox-science/CodeAstra/actions/workflows/test.yml)
 
   <!-- CodeAstra Latest Release Badge -->
   <a href="https://github.com/sandbox-science/CodeAstra/releases">
@@ -51,6 +52,14 @@ Please, check the [wiki](https://github.com/sandbox-science/CodeAstra/wiki) for
   - [ ] Create a new file ~ in progress
 - [x] File tree navigation
 - [ ] Syntax highlighting ~ in progress
+  - Supported Languagues:
+    - [x] Markdown (**foundation**)
+    - [x] YAML (**foundation**)
+    - [ ] C/C++ (**in progress**)
+    - [ ] Golang (**in progress**)
+    - [ ] Python (**Backlog**)
+    - [ ] Elixir (**Backlog**)
+    - more to come ... ([contribution welcomed](https://github.com/sandbox-science/CodeAstra/issues/4))
 - [ ] Plugin system
 
 ## To-Do

config/cpp.syntax.yaml

@@ -0,0 +1,38 @@
+extensions: [cpp, c, h, hpp]
+
+keywords:
+  keyword:
+    - regex: "\\b(char|class|const|double|enum|explicit|friend|inline|int|long|namespace|operator|private|protected|public|short|signals|signed|slots|static|struct|template|typedef|typename|union|unsigned|virtual|void|volatile|foreach)\\b"
+      color: "#003478" # Dark Blue
+      bold: "true"
+    - regex: "\\b(for|while|do|if|else)\\b"
+      color: "#D9001D" # Bright Red
+    - regex: "(?<!\\w)#include(?!\\w)"
+      color: "#800080" # Purple
+
+  comment:
+    - regex: "//[^\n]*"
+      color: "#336934" # Dark Green
+      italic: "true"
+
+  string:
+    - regex: "\"(\\\\.|[^\"\\\\])*\""
+      color: "#E37100" # Orange
+    - regex: "\\\\"
+      color: "#FFDE00" # Yellow
+
+  number:
+    - regex: "\\b\\d+\\b"
+      color: "#0000FF" # Blue
+
+  parenthesis:
+    - regex: "[()]"
+      color: "#6495ED" # Cornflower Blue
+
+  function:
+    - regex: "\\b(?!for\\b|if\\b|else\\b|while\\b|do\\b)[a-zA-Z_][a-zA-Z0-9_]*(?=\\s*\\()"
+      color: "#DBA800" # Golden Yellow
+
+  qualifiedName:
+    - regex: "\\b\\w+(?=\\s*::)"
+      color: "#309676" # Teal Green

config/go.syntax.yaml

@@ -0,0 +1,14 @@
+extensions: [go]
+
+keywords:
+  comment:
+    - regex: "\"(\\\\.|[^\"\\\\])*\""
+      color: "#808080" # Gray
+
+  string:
+    - regex: "\"(\\\\.|[^\"\\\\])*\""
+      color: "#E37100" # Orange
+
+  number:
+    - regex: "\\b\\d+\\b"
+      color: "#0000FF" # Blue

config/markdown.syntax.yaml

@@ -0,0 +1,47 @@
+extensions: [md]
+
+keywords:
+  comment:
+    - regex: "#[^\n]*"
+      color: "#336934" # Dark Green
+      italic: "true"
+
+  heading:
+    - regex: "^#{1,6}\\s+.*"
+      color: "#003478" # Dark Blue
+      bold: "true"
+
+  bold:
+    - regex: "(?<!\\*)\\*\\*([^*]+)\\*\\*(?!\\*)|(?<!_)__([^_]+)__(?!_)"
+      color: "#D9001D" # Bright Red
+      bold: "true"
+
+  italic:
+    - regex: "(?<!\\*)\\*([^*]+)\\*(?!\\*)|(?<!_)_([^_]+)_(?!_)"
+      color: "#D97706" # Orange
+      italic: "true"
+
+  link:
+    - regex: "\\[([^\\]]+)\\]\\(([^\\)]+)\\)"
+      color: "#005FFF" # Bright Blue
+
+  inline_code:
+    - regex: "`([^`]+)`"
+      color: "#E37100" # Orange
+
+  list:
+    - regex: "^(\\s*[-+*]\\s+|\\s*\\d+\\.\\s+)"
+      color: "#309676" # Teal Green
+
+  blockquote:
+    - regex: "^>\\s+.*"
+      color: "#B48EAD" # Light Purple
+      italic: "true"
+
+  todo:
+    - regex: "- \\[ \\]"
+      color: "#FF8C00" # Orange for unchecked tasks
+    - regex: "- \\[x\\]"
+      color: "#32CD32" # Green for completed tasks
+    - regex: "(?<=\\[)[^\\]]*(?=\\])"
+      color: "#E37100"

config/python.syntax.yaml

@@ -0,0 +1,24 @@
+extensions: [py]
+
+keywords:
+  keyword:
+    - regex: "\\bimport\\b"
+      color: "#FF1493" # Deep Pink
+    - regex: "\\bdef\\b"
+      color: "#800080" # Purple
+    - regex: "\\bclass\\b"
+      color: "#008000" # Green
+      bold: "true"
+
+  comment:
+    - regex: "#[^\n]*"
+      color: "#808080" # Gray
+      italic: "true"
+
+  string:
+    - regex: "\"(\\\\.|[^\"\\\\])*\""
+      color: "#E37100" # Orange
+
+  number:
+    - regex: "\\b\\d+\\b"
+      color: "#0000FF" # Blue