Code Update

* Move the file path conversion logics into IOStreams
* Fix paths issue in APIs (Part 1)
* Consolidate the debug related options to be under debug mode in Loader
* Add documentation (Part 1)

Author: DAK404

.vscode/tasks.json

@@ -7,7 +7,7 @@
             "command": "make",
             "args": [
                 "project=Cataphract",
-                "kernel"
+                "all"
             ],
             "group": {
                 "kind": "build",

Source/Cataphract/API/IOStreams.java

@@ -16,6 +16,8 @@
 package Cataphract.API;
 
 import java.io.Console;
+import java.io.File;
+import java.util.regex.Matcher;
 
 /**
 * A class implementing console output with prefixes, colors, and a "Press RETURN To Continue" functionality
@@ -175,4 +177,26 @@ public static String confirmReturnToContinue(String prefix, String suffix)
     {
         return console.readLine(prefix + "Press RETURN to Continue" + suffix);
     }
+
+    /**
+    * Logic to convert from Nion File Separator format of file paths to an OS dependent file separator format.
+    *
+    * @param nionPath String that contains the file path in Nion File Separator format
+    * @return String The value of the String converted to the OS dependent file separator format
+    */
+    public static String convertFileSeparator(String nionPath)
+    {
+        return nionPath.replaceAll("\\|", Matcher.quoteReplacement(File.separator));
+    }
+        
+    /**
+    * Logic to convert from an OS dependent file separator format of file paths to Nion File Separator format.
+    *
+    * @param filePath String that contains the file path in OS dependent file separator format.
+    * @return String The value of the String converted to Nion File Separator format.
+    */
+    public static String convertToNionSeparator(String filePath)
+    {
+        return filePath.replaceAll(Matcher.quoteReplacement(File.separator), "|");
+    }
 }

Source/Cataphract/API/Wraith/FileManagement.java

@@ -61,7 +61,7 @@ public FileManagement(String username)throws Exception
         // Set the name of the user to the global variable
         _name = new Login(username).getNameLogic();
         // Initialize the present working directory
-        _presentWorkingDirectory = "./Users/Cataphract/" + _username + "/";
+        _presentWorkingDirectory = ".|Users|Cataphract|" + _username + "|";
     }
 
     /*****************************************
@@ -93,7 +93,7 @@ private final boolean login()throws Exception
      */
     private boolean checkEntityExistence(String fileName)throws Exception
     {
-        return new File(fileName).exists();
+        return new File(IOStreams.convertFileSeparator(fileName)).exists();
     }
 
     /**
@@ -106,7 +106,7 @@ private final void deleteEntity(String fileName)throws Exception
     {
         try
         {
-            fileName = _presentWorkingDirectory+fileName;
+            fileName = IOStreams.convertFileSeparator(_presentWorkingDirectory+fileName);
             if(checkEntityExistence(fileName))
             {
                 File f=new File(fileName);
@@ -150,7 +150,7 @@ private final void deleteEntityHelper(File fileName)throws Exception
     private void viewDirectoryTree()throws Exception
     {
         // Create a File object for the present working directory
-        File treeView = new File(_presentWorkingDirectory);
+        File treeView = new File(IOStreams.convertFileSeparator(_presentWorkingDirectory));
 
         // Print the header for the tree view
         IOStreams.println("\n--- [ TREE VIEW ] ---\n");
@@ -202,10 +202,11 @@ private final void navPreviousDirectory()throws Exception
 
         // Replace the last directory in the path with a single slash
         _presentWorkingDirectory = _presentWorkingDirectory.replace(
-            _presentWorkingDirectory.substring(_presentWorkingDirectory.lastIndexOf('/'), _presentWorkingDirectory.length()),"/");
+            _presentWorkingDirectory.substring(_presentWorkingDirectory.lastIndexOf('|'), _presentWorkingDirectory.length()),"|");
 
         // Check if the present working directory is the restricted user home directory
-        if (_presentWorkingDirectory.equals("./Users/Cataphract/")) {
+        if (_presentWorkingDirectory.equals(IOStreams.convertFileSeparator(".|Users|Cataphract|"))) 
+        {
             // Print an error message if access is denied
             IOStreams.printError("Permission Denied.");
 
@@ -219,7 +220,7 @@ private final void navPreviousDirectory()throws Exception
      */
     private final void resetToHomeDirectory()
     {
-        _presentWorkingDirectory = "./Users/Cataphract/" + _username + '/'  ;
+        _presentWorkingDirectory = ".|Users|Cataphract|" + _username + '|'  ;
     }
 
     /**
@@ -265,6 +266,10 @@ private final void renameEntity(String fileName, String newFileName) throws Exce
      */
     private final void copyMoveEntity(String fileName, String destination, boolean move)throws Exception
     {
+        // Convert paths from Nion paths to OS specific paths
+        fileName = IOStreams.convertFileSeparator(fileName);
+        destination = IOStreams.convertFileSeparator(destination);
+        
         // Check if the specified file or directory is valid
         if(!checkEntityExistence(fileName) && !checkEntityExistence(destination))
             IOStreams.printError("Invalid file name or destination.");
@@ -284,7 +289,8 @@ private final void copyMoveEntity(String fileName, String destination, boolean m
     private final void copyMoveHelper(File source, File destination, boolean move)throws Exception
     {
         // Check if the source is a directory
-        if (source.isDirectory()) {
+        if (source.isDirectory()) 
+        {
             // Create the destination directory
             destination.mkdirs();
 
@@ -319,11 +325,13 @@ private final void listEntities()throws Exception
         String format = "%1$-32s| %2$-24s| %3$-10s\n";
         String c = "-";
 
+        String ls = IOStreams.convertFileSeparator(_presentWorkingDirectory);
+
         // Check if the present working directory exists
-        if (checkEntityExistence(_presentWorkingDirectory))
+        if (checkEntityExistence(ls))
         {
             // Create a File object for the present working directory
-            File dPath = new File(_presentWorkingDirectory);
+            File dPath = new File(ls);
 
             // Print a newline for better formatting
             System.out.println("\n");
@@ -358,7 +366,8 @@ private final void listEntities()throws Exception
     private final void changeDirectory(String destination)throws Exception
     {
         // Check if the destination is the parent directory
-        if (destination.equals("..")) {
+        if (destination.equals("..")) 
+        {
             // Navigate to the previous directory
             navPreviousDirectory();
 
@@ -369,7 +378,7 @@ private final void changeDirectory(String destination)throws Exception
             if (checkEntityExistence(_presentWorkingDirectory + destination))
             {
                 // Update the present working directory to the new destination
-                _presentWorkingDirectory = _presentWorkingDirectory + destination + "/";
+                _presentWorkingDirectory = _presentWorkingDirectory + destination + "|";
             }
             else
             {
@@ -396,12 +405,13 @@ public void fileManagementLogic()throws Exception
             // Check if the user is logged in
             if (login())
             {
+                System.out.println(IOStreams.convertToNionSeparator(IOStreams.convertFileSeparator(_presentWorkingDirectory)));
                 String inputValue = "";
                 // Loop to continuously read and execute commands until 'exit' is entered
                 do 
                 {
                     // Read a line of input from the console
-                    inputValue = console.readLine(_name + "@" + _presentWorkingDirectory.replace(_username, _name) + "> ");
+                    inputValue = console.readLine(_name + "@" + IOStreams.convertFileSeparator(_presentWorkingDirectory).replace(_username, _name) + "> ");
 
                     // Interpret and execute the command
                     grinchInterpreter(inputValue);
@@ -432,7 +442,8 @@ public void fileManagementLogic(String scriptFileName)throws Exception
             else
             {
                 // Check if the user is logged in
-                if (login()) {
+                if (login()) 
+                {
                     // Initialize a stream to read the given file
                     BufferedReader br = new BufferedReader(new FileReader(scriptFileName));
 
@@ -489,7 +500,7 @@ private void grinchInterpreter(String command)throws Exception
                 else
                     // Call the method to move the entity
                     copyMoveEntity(commandArray[1], commandArray[2], true);
-                break;
+            break;
 
             case "copy":
             case "cp":
@@ -499,7 +510,7 @@ private void grinchInterpreter(String command)throws Exception
                 else
                     // Call the method to copy the entity
                     copyMoveEntity(commandArray[1], commandArray[2], false);
-                break;
+            break;
 
             case "delete":
             case "del":
@@ -510,7 +521,7 @@ private void grinchInterpreter(String command)throws Exception
                 else
                     // Call the method to delete the entity
                     deleteEntity(commandArray[1]);
-                break;
+            break;
 
             case "rename":
                 // Check if the command has the correct number of arguments
@@ -519,7 +530,7 @@ private void grinchInterpreter(String command)throws Exception
                 else
                     // Call the method to rename the entity
                     renameEntity(commandArray[1], commandArray[2]);
-                break;
+            break;
 
             case "mkdir":
                 // Check if the command has the correct number of arguments
@@ -528,7 +539,7 @@ private void grinchInterpreter(String command)throws Exception
                 else
                     // Call the method to create a directory
                     makeDirectory(commandArray[1]);
-                break;
+            break;
 
             case "edit":
                 // Check if the command has the correct number of arguments
@@ -537,7 +548,7 @@ private void grinchInterpreter(String command)throws Exception
                 else
                     // Call the method to edit a file
                     new FileWrite(_username).editFile(commandArray[1], _presentWorkingDirectory);
-                break;
+            break;
 
             case "read":
                 // Check if the command has the correct number of arguments
@@ -546,12 +557,12 @@ private void grinchInterpreter(String command)throws Exception
                 else
                     // Call the method to read a file
                     new FileRead(_username).readUserFile(_presentWorkingDirectory + commandArray[1]);
-                break;
+            break;
 
             case "pwd":
                 // Print the present working directory
                 IOStreams.println((_presentWorkingDirectory).replace(_username, _name));
-                break;
+            break;
 
             case "cd":
                 // Check if the command has the correct number of arguments
@@ -560,23 +571,23 @@ private void grinchInterpreter(String command)throws Exception
                 else
                     // Call the method to change the directory
                     changeDirectory(commandArray[1]);
-                break;
+            break;
 
             case "cd..":
                 // Navigate to the previous directory
                 navPreviousDirectory();
-                break;
+            break;
 
             case "tree":
                 // Display the directory tree
                 viewDirectoryTree();
-                break;
+            break;
 
             case "dir":
             case "ls":
                 // List the entities in the current directory
                 listEntities();
-                break;
+            break;
 
             case "download":
                 // Check if the command has the correct number of arguments
@@ -585,17 +596,17 @@ private void grinchInterpreter(String command)throws Exception
                 else
                     // Call the method to download a file
                     new FileDownload(_username).downloadFile(commandArray[1], commandArray[2]);
-                break;
+            break;
 
             case "home":
                 // Reset to the home directory
                 resetToHomeDirectory();
-                break;
+            break;
 
             case "exit":
             case "":
                 // Exit the interpreter
-                break;
+            break;
 
             default:
                 // Pass the command to the Anvil interpreter for further processing