Added real-time rendering with Vivify and added more configuration options

README.md

@@ -19,6 +19,9 @@ make
 4. configure `./config.json`
 5. run the binary `notewrapper`
 
+### Usage
+If you want to render with Vivify with the flags `-r`, `--render` or with the option in the config file, you must have installed the plugins for your specific editor ([for Vim and Neovim](https://github.com/jannis-baum/vivify.vim))
+
 ### Configuration
 Change `$/.config/notewrapper/config.json`. If it does not exist. On building, it should copy a default config.
 
@@ -27,17 +30,18 @@ Change `$/.config/notewrapper/config.json`. If it does not exist. On building, i
 - [x] Add a way to delete vaults
 - [ ] Add a way to delete notes
 - [x] Stylisize a bit the TUI
-- [ ] Add more options to the config file
+- [x] Add more options to the config file
 - [x] Search for config.json in other directories such as ~/.config/notewrapper/ and not only this directory
 - [x] Port vivify.vim to nixpkgs
 - [ ] Add a way to have vaults in different directories
-- [ ] Actually open vivify when opening nvim
+- [x] Actually open vivify when opening nvim
 - [ ] Write the journaling code (separate files or one big journal files)
 - [ ] Automatic backups
-- [ ] Add flags for customization
+- [x] Add flags for customization
 - [ ] Write a good README.md
-- [ ] Option to not render and to only open nvim
+- [x] Option to not render and to only open nvim
 - [ ] Figure out this vivify issue https://github.com/jannis-baum/Vivify/issues/291
 - [ ] Maybe port this to other editors
+- [ ] Port to vim
 - [ ] Fixe all the small stuff marked //(TODO LATER) in the code
 - [ ] Add a way to delete notes

config.json

@@ -1,6 +1,6 @@
 {
-  "directory": "$/Documents/Notes/"
+  "directory": "$/Documents/Notes/",
-
+  "render": true,
-
+  "jumpToEndOfFileOnLaunch": true,
-
+  "editor": "neovim"
 }

startup.c

@@ -90,7 +90,7 @@ char *createNewNote(char dirToVault[PATH_MAX], char *vaultFromDir, char *bypass,
   }
   if (debug) {printf("\e[0;32m[DEBUG]\e[0m sanitize(fileName)=%s\n", fileName);} // (TODO LATER) Check if dirToVault+vaultFromDir+fileName > PATH_MAX
 
-  char *fileFullPath = malloc(PATH_MAX); // this dinamically allocated because we use it in the main function to call openNvim
+  char *fileFullPath = malloc(PATH_MAX); // this dinamically allocated because we use it in the main function to call openEditor
   sprintf(fileFullPath, "%s/%s/%s", dirToVault, vaultFromDir, fileName);
   FILE *filePointer;
   filePointer = fopen(fileFullPath, "w"); // creates and opens the file
@@ -315,22 +315,41 @@ char* ncursesSelect(char **options, char *optionsText, size_t optionsNumber, siz
 }
 
 
-int openNvim(char *path, int debug) {
+int openEditor(char *path, char *editor, int render, int endOfFile, int debug) {
   pid_t pid = fork(); // this forking allows the programs to return when nvim is closed
   if (pid < 0) {
     perror("\e[0;31mERROR: fork failed\e[0m\n");
     return 1;
   } else if (pid == 0) {
-    // Child process: replace with nvim
+      // Child process: replace with editor of choice
+    if (strcmp(editor, "neovim") == 0) { 
     //(TODO LATER) we should (with a config option) append a new line every time it opens
-    if (debug) {printf("\e[0;32m[DEBUG]\e[0m Opening with command:\nnvim +:NvimTreeOpen %s\n", path);}
+      if (render) { // don't render using vivify
-    execlp("nvim",
+        if (endOfFile) { // goes to the end of the file on opening. (TODO LATER) find a better way to do this loops. Maybe an array of args and if () we add the arg to the array and we pass the whole array to execlp
-           "nvim",
+          if (debug) {printf("\e[0;32m[DEBUG]\e[0m Opening with command:\nnvim +:$ +:Vivify %s\n", path);} // :$ goes to the end of the file. :Vivify runs vivify
-           "+:$", // goes to end of the line // we can specify each argument for nvim by passing more args to execlp
+            execlp("nvim", "nvim", "+:$", "+:Vivify", path, NULL);
-           path,
+            perror("\e[0;31mERROR: execlp failed. Nvim might be not installed or not in path.\e[0m\n"); // (TODO LATER) We should verify at the start when the editor is choosen if it exists
-           NULL);
+            exit(1); // (TODO LATER) This exist only if error or everytime. If it does every time change to exit(0);
-    perror("\e[0;31mERROR: execlp failed. Nvim might be not installed or not in path.\e[0m\n");
+        } else { // don't go to the end of the file
+          if (debug) {printf("\e[0;32m[DEBUG]\e[0m Opening with command:\nnvim +:Vivify %s\n", path);}
+            execlp("nvim", "nvim", "+:Vivify", path, NULL);
+            perror("\e[0;31mERROR: execlp failed. Nvim might be not installed or not in path.\e[0m\n"); // (TODO LATER) We should verify at the start when the editor is choosen if it exists
             exit(1);
+        }
+      } else { // don't render using vivify
+        if (endOfFile) { // go to end of the file on opening
+          if (debug) {printf("\e[0;32m[DEBUG]\e[0m Opening with command:\nnvim +:$ %s\n", path);}
+            execlp("nvim", "nvim", "+:$", path, NULL);
+            perror("\e[0;31mERROR: execlp failed. Nvim might be not installed or not in path.\e[0m\n"); // (TODO LATER) We should verify at the start when the editor is choosen if it exists
+            exit(1);
+        } else { // don't go to the end of the file on opening
+          if (debug) {printf("\e[0;32m[DEBUG]\e[0m Opening with command:\nnvim %s\n", path);}
+            execlp("nvim", "nvim", path, NULL);
+            perror("\e[0;31mERROR: execlp failed. Nvim might be not installed or not in path.\e[0m\n"); // (TODO LATER) We should verify at the start when the editor is choosen if it exists
+            exit(1);
+        }
+      }
+    }
   } else {
     // Parent process: wait for child to finish
     int status;
@@ -370,6 +389,7 @@ int main(int argc, char *argv[]) {
       exit(1);
     }
     
+    // (TODO LATER) This might lack of debug info
     // opens config.json
     FILE *f = fopen(configPath, "r");
     if (!f) {
@@ -421,6 +441,23 @@ int main(int argc, char *argv[]) {
       // default vault path if it is not set in the config
       snprintf(notesDirectoryString, PATH_MAX, "%s/Documents/Notes/", homedir);
     }
+
+    // fetch the render and jumpToEnfOfFileOnLaunch bools // (TODO LATER) For all this JSON output warnings if there is some json but not the expected type. And add a warning if unsupported editor. if warning -> default
+    int shouldRender = 1;
+    cJSON *shouldRenderJSON = cJSON_GetObjectItem(json, "render");
+    if (shouldRenderJSON && cJSON_IsBool(shouldRenderJSON)) {
+        shouldRender = cJSON_IsTrue(shouldRenderJSON) ? 1 : 0;
+    }
+    int shouldJumpToEnd = 1;
+    cJSON *shouldJumpToEndJSON = cJSON_GetObjectItem(json, "jumpToEndOfFileOnLaunch");
+    if (shouldJumpToEndJSON && cJSON_IsBool(shouldJumpToEndJSON)) {
+      shouldJumpToEnd = cJSON_IsTrue(shouldJumpToEndJSON) ? 1 : 0;
+    }
+    char *editorToOpen = "neovim"; // default
+    cJSON *editorToOpenJSON = cJSON_GetObjectItem(json, "editor");
+    if (editorToOpenJSON || cJSON_IsString(editorToOpenJSON)) {
+      editorToOpen = strdup(editorToOpenJSON->valuestring); // we must strdup and not just = as we will free all the json after (before parsing args)
+    }
     //cleans up 
     cJSON_Delete(json);
     free(data);
@@ -438,11 +475,17 @@ int main(int argc, char *argv[]) {
           printf("Options:\n");
           printf("  -d, --directory <path/to/directory>         Specify the vaults' directory.\n");
           printf("  -h, --help                                  Display this message.\n");
+          printf("  -e, --editor                                Specify the editor to open.\n");
+          printf("  -j, --jump                                  Jumps to the end of the file on opening.\n");
+          printf("  -J, --no-jump                               Do not jump to the end of the file\n");
           printf("  -n, --note  <note's name>                   Specify the note.");
+          printf("  -r, --render                                Renders the note with Vivify.\n");
+          printf("  -R, --no-render                             Do not render.\n");
           printf("  -v, --vault <vault's name>                  Specify the vault.\n");
           printf("  --version                                   Display the program version.\n");
           printf("  -V, --verbose                               Show debug information.\n");
           return 1;
+        // (TODO LATER) Organize alphabetically these conditions
         } else if (strcmp(argv[i], "--version") == 0) {
           printf("There is still no released version\n");
           return 0;
@@ -461,6 +504,16 @@ int main(int argc, char *argv[]) {
             bypassNoteSelection = argv[i+1];
           }
 
+        } else if (strcmp(argv[i], "-j") == 0 || strcmp(argv[i], "--jump") == 0) {
+          shouldJumpToEnd = 1;
+        } else if (strcmp(argv[i], "-J") == 0 || strcmp(argv[i], "--no-jump") == 0) {
+          shouldJumpToEnd = 0;
+        } else if (strcmp(argv[i], "-r") == 0 || strcmp(argv[i], "--render") == 0) {
+          shouldRender = 1;
+        } else if (strcmp(argv[i], "-R") == 0 || strcmp(argv[i], "--no-render") == 0) {
+          shouldRender = 0;
+        } else if (strcmp(argv[i], "-e") == 0 || strcmp(argv[i], "--editor") == 0) {
+          editorToOpen = argv[i+1];
         }
     }
 
@@ -554,12 +607,12 @@ open_note:
             bypassNoteSelection =  HASH_MACRO; // we must reset bypassNoteSelection to avoid getting into an infinite loop of bypassing the note selection
             char fullPath[PATH_MAX]; // (TODO LATER) Find a more appropriate and descriptive name for the variable
             sprintf(fullPath, "%s/%s/%s", notesDirectoryString, vaultSelected, noteSelected); // (TODO LATER) change all sprintf to snprintf which checks for buffer size
-            openNvim(fullPath, debug);
+            openEditor(fullPath, editorToOpen, shouldRender, shouldJumpToEnd, debug);
           } else if (strcmp(noteSelected,"Create new note") == 0) {
 note_creation:
             char *pathForNoteCreation = createNewNote(notesDirectoryString, vaultSelected, bypassNoteSelection, debug);
             bypassNoteSelection =  HASH_MACRO; // we must reset bypassNoteSelection to avoid getting into an infinite loop of bypassing the note selection
-            openNvim(pathForNoteCreation, debug);
+            openEditor(pathForNoteCreation, editorToOpen, shouldRender, shouldJumpToEnd, debug);
             //free(pathForNoteCreation);
           } else if (strcmp(noteSelected,"Back to vault selection") == 0) {
             shouldChangeVault = 1;
@@ -585,7 +638,7 @@ note_creation:
         createNewVault(notesDirectoryString, debug);
       } else if (strcmp(vaultSelected,"Settings") == 0) {
         // (TODO LATER) add a way to modify the path to config.json
-        openNvim(configPath, debug);
+        openEditor(configPath, editorToOpen, 0, 0, debug); // as this is not a md file we set render and jumptoEnfOfFile to 0
       } else if (strcmp(vaultSelected,"Quit (Ctrl+C)") == 0) {
         if (debug) {printf("\e[0;32m[DEBUG]\e[0m The program was exited.\n");}
         shouldExit = 1;