Update to 0.4.1

- Added command `orca_toc: Toggle Collapse/Expand All TOC Entries` to toggle collapse/expand all TOC entries at once. The collapsed status of the TOC view will be preserved when navigating between different ORCA output files. The default collapsed status of the TOC view can be changed in the settings of the extension.
- Update of the `patterns.json` file for better parsing of the ORCA output file.

Author: liqunkang

CHANGELOG.md

@@ -64,3 +64,8 @@ Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how
 - Added cursor position tracking for the ORCA output file. The TOC view will automatically highlight and expand the corresponding TOC entry when the user is navigating through the ORCA output file based on the current line number. The highlight and expand status of the TOC view will be updated when the user is moving the cursor to a different line in the ORCA output file.
 - Added support for changing the highlight symbols for the TOC entries.
 - Added support for saving the collapsed status of the TOC view in the settings of the extension. When navigating to different ORCA output files, the TOC view status for each file will be restored.
+
+## [0.4.1] - 2023-12-30
+
+- Added command `orca_toc: Toggle Collapse/Expand All TOC Entries` to toggle collapse/expand all TOC entries at once. The collapsed status of the TOC view will be preserved when navigating between different ORCA output files. The default collapsed status of the TOC view can be changed in the settings of the extension.
+- Update of the `patterns.json` file for better parsing of the ORCA output file.

README.md

@@ -19,11 +19,13 @@ By default all the parent entries are collapsed. While navigating through the OR
 
 The collapsed status of the TOC view could also be changed by clicking the toggle arrow next to each parent entry. The manually changed collapsed status of the TOC view for each ORCA output file will be preserved when navigating between different ORCA output files.
 
+Settings of this extension can be changed in the settings of VS Code (click on the gear icon in the bottom left corner of the VS Code window or press `Ctrl+,` on Windows or `Cmd+,` on Mac). The configuration options are listed under `Extensions` -> `ORCA_TOC`, or could be accessed by searching `ORCA_TOC` in the search bar of the settings window.
+
 ![Outline Example](images/outline_example.png)
 
 ![Outline Example Expanded](images/outline_example_expanded.png)
 
-The TOC view can also be triggered manually by running the command `Show ORCA Outline` from the command palette. On Windows, the command palette can be opened with `Ctrl+Shift+P`, on Mac it is `Cmd+Shift+P`. The TOC view is automatically updated when navigating to a different ORCA output file, or when an ORCA output file is opened.
+The TOC view can also be triggered manually by running the command `orca_toc: Show ORCA Outline` from the command palette. On Windows, the command palette can be opened with `Ctrl+Shift+P`, on Mac it is `Cmd+Shift+P`. The TOC view is automatically updated when navigating to a different ORCA output file, or when an ORCA output file is opened.
 
 ![Command Palette Example](images/command_palette_example.png)
 
@@ -48,7 +50,7 @@ For a list of available highlight symbols, please see [here](https://code.visual
 
 - If you have very large ORCA output files, please first consider splitting them into smaller chunks or remove the parts that are not needed (for example full print of the MOs).
 
-- :warning: For large ORCA output files, The current solution is using the `FileSystemProvider` API to read the contents of the ORCA output file directly from the file system. This will allow the extension to parse ORCA output files that are larger than 50MB.  please use the command `Show ORCA Outline External` from the command palette and load the large ORCA output file manually from your file system. The loaded ORCA output file will be displayed in a new tab in the editor of the current VS Code window, with a :lock: symbol at the end of the file name. This is because the file is read-only and cannot be modified. The TOC view will be automatically populated with the contents of this ORCA output file.
+- :warning: For large ORCA output files, The current solution is using the `FileSystemProvider` API to read the contents of the ORCA output file directly from the file system. This will allow the extension to parse ORCA output files that are larger than 50MB.  please use the command `orca_toc: Show ORCA Outline External` from the command palette and load the large ORCA output file manually from your file system. The loaded ORCA output file will be displayed in a new tab in the editor of the current VS Code window, with a :lock: symbol at the end of the file name. This is because the file is read-only and cannot be modified. The TOC view will be automatically populated with the contents of this ORCA output file.
 
 - :construction: A known issue is that clicking the heading titles in the `ORCA FILE OUTLINE` view for large ORCA output files will not navigate to the corresponding line in the opened tab. Instead a new tab with the same name file name will pop up, showing identical contents and TOC view at the respective line. This bug will be fixed in a future release.
 
@@ -60,11 +62,10 @@ For a list of available highlight symbols, please see [here](https://code.visual
 
 For detailed release notes, please see [CHANGELOG.md](CHANGELOG.md).
 
-### 0.4.0
+### 0.4.1
 
-- Added cursor position tracking for the ORCA output file. The TOC view will automatically highlight and expand the corresponding TOC entry when the user is navigating through the ORCA output file based on the current line number. The highlight and expand status of the TOC view will be updated when the user is moving the cursor to a different line in the ORCA output file.
-- Added support for changing the highlight symbols for the TOC entries.
-- Added support for saving the collapsed status of the TOC view in the settings of the extension. When navigating to different ORCA output files, the TOC view status for each file will be restored.
+- Added command `orca_toc: Toggle Collapse/Expand All TOC Entries` to toggle collapse/expand all TOC entries at once. The collapsed status of the TOC view will be preserved when navigating between different ORCA output files. The default collapsed status of the TOC view can be changed in the settings of the extension.
+- Update of the `patterns.json` file for better parsing of the ORCA output file.
 
 ## TODO
 
@@ -73,15 +74,12 @@ For detailed release notes, please see [CHANGELOG.md](CHANGELOG.md).
 - [x] Add support for the `ORCA FILE OUTLINE` view to automatically scroll to the current line in the ORCA output file.
 - [x] Syntax highliting for the ORCA output file based on the TOC entries.
 - [x] Add settings for enabling/disabling the syntax highlighting for the ORCA output file.
-- [ ] Add command for unfold/fold all TOC entries
+- [x] Add command for toggle collapse/expand the TOC view.
 - [x] Add option to choose different highlight symbols for the TOC entries
 - [ ] Update illustration figures in this README
-
-## Roadmap
-
-The current version represents an early release of this extension.
-
-An important feature that will be added in the next major release is to enable the scrolling of the `ORCA FILE OUTLINE` view to the current line in the ORCA output file. This will be useful when the ORCA output file is very long and the user is navigating through the file. The `ORCA FILE OUTLINE` view will automatically scroll to the current line in the ORCA output file.
+- [ ] Update the `orca.tmLanguage.json` file to include more syntax definitions for the ORCA output file
+- [ ] Update the `patterns.json` file to include more regular expressions for parsing the ORCA output file
+- [ ] Update the `keywords.json` file to include more keywords for replacing the matched text
 
 ## For Developers
 

extension.js

@@ -51,17 +51,29 @@ class OrcaOutlineProvider {
         // console.log('treeItem.iconPath: ', treeItem.iconPath);
         // console.log('element.children: ', element.children);
 
-        // Check if the element has children and set the collapsible state accordingly based on the highlighted state, isExpanded state, or the default collapsed state
-        if (element.children && element.children.length > 0) {
-            // Check if an expanded state has been set, otherwise use the default, or set to expanded if highlighted
-            const isExpanded = this._expandedState[element.label || element.title];
+        // Check the expanded state for the element saved in the global expanded state object
+        const isExpanded = this._expandedState[element.label || element.title]; // Get the expanded state from the expanded state object
 
-            if (isExpanded !== undefined) {
-                // If there is an expanded state, use it, or set to expanded if highlighted
-                treeItem.collapsibleState = element.highlighted ? vscode.TreeItemCollapsibleState.Expanded : isExpanded ? vscode.TreeItemCollapsibleState.Expanded : vscode.TreeItemCollapsibleState.Collapsed
+        // Check if the element has children and set the collapsible state accordingly
+        if (element.children && element.children.length > 0) {
+            if (element.highlighted) {
+                // If highlighted, set to expanded
+                treeItem.collapsibleState = vscode.TreeItemCollapsibleState.Expanded;
             } else {
-                // If there is no expanded state, use the default collapsed state, or set to expanded if highlighted
-                treeItem.collapsibleState = element.highlighted ? vscode.TreeItemCollapsibleState.Expanded : defaultCollapsed ? vscode.TreeItemCollapsibleState.Collapsed : vscode.TreeItemCollapsibleState.Expanded;
+                if (element.collapsed !== undefined) {
+                    // If the collapsed state is set, use it
+                    treeItem.collapsibleState = element.collapsed ? vscode.TreeItemCollapsibleState.Collapsed : vscode.TreeItemCollapsibleState.Expanded;
+                    this._expandedState[element.label || element.title] = !element.collapsed; // Save the expanded state in the expanded state object
+                } else {
+                    if (isExpanded !== undefined) {
+                        // If the expanded state is set, use it
+                        treeItem.collapsibleState = isExpanded ? vscode.TreeItemCollapsibleState.Expanded : vscode.TreeItemCollapsibleState.Collapsed;
+                    }
+                    else {
+                        // If neither the collapsed state nor the expanded state is set, use the default collapsed state
+                        treeItem.collapsibleState = defaultCollapsed ? vscode.TreeItemCollapsibleState.Collapsed : vscode.TreeItemCollapsibleState.Expanded;
+                    }
+                }
             }
         } else {
             // If there are no children, set the collapsible state to none
@@ -77,7 +89,7 @@ class OrcaOutlineProvider {
 
         // Create a unique id for each treeItem using the file path and the label and the level and the collapsed state
         // by creating a unique id will force the tree view to refresh when the collapsed state changes
-        treeItem.id = `${this._filePath}::${treeItem.label}::${element.level}::${treeItem.collapsibleState}::${element.highlighted}`;
+        treeItem.id = `${this._filePath}::${treeItem.label}::${element.level}::${treeItem.collapsibleState}::${element.highlighted}::${element.collapsed}`;
         return treeItem;
     }
 
@@ -145,7 +157,7 @@ class OrcaOutlineProvider {
 
     // Method to refresh the tree view
     refresh() {
-        this._onDidChangeTreeData.fire(undefined);
+        this._onDidChangeTreeData.fire(undefined); // Trigger the event emitter
     }
 
     // share the matches
@@ -317,8 +329,8 @@ function parseOrcaFile(document, filePath) {
                             title: 'Open File'
                         },
                         tooltip: `${pattern.title} (Line ${line + 1})`, // This will be the tooltip for the tree item
-                        highlighted: false, // This will be the highlighted state for the tree item
-                        collapsed: defaultCollapsed // This will be the collapsed state for the tree item based on the default collapsed state configuration
+                        highlighted: false, // This will be the default highlighted state for the tree item
+                        collapsed: undefined // This will be the default collapsed state for the tree item
                     });
                 }
 
@@ -367,7 +379,7 @@ function insertDummyHeadings(allMatches) {
                     command: null,
                     tooltip: `Dummy for missing level`,
                     highlighted: false,
-                    collapsed: defaultCollapsed
+                    collapsed: undefined
                 });
             }
         }
@@ -409,7 +421,7 @@ function resetAllHighlights(matches) {
     // Iterate through the matches and reset the highlighted property
     matches.forEach(match => {
         match.highlighted = false;
-        match.collapsed = defaultCollapsed; // Reset the collapsed state to the default
+        // match.collapsed = undefined;
         // Recursively reset the highlighted property for the children
         if (match.children) {
             resetAllHighlights(match.children);
@@ -427,7 +439,7 @@ function updateTOCHighlight(lineNumber) {
         let matchForLevel = findClosestMatchForLevel(currentLevelMatches, lineNumber); // Find the closest match for the current level
         if (matchForLevel) {
             matchForLevel.highlighted = true; // Highlight the entry
-            matchForLevel.collapsed = false; // Expand the entry
+            // matchForLevel.collapsed = false; // Expand the entry
             currentLevelMatches = matchForLevel.children || []; // Set the current level matches to the children of the match
         } else {
             break; // Exit if no match is found at the current level
@@ -477,6 +489,27 @@ async function showOrcaOutlineExternal(context, uri) {
     }
 }
 
+// Function to reset all collapse states to a specific state
+function resetAllCollapseStates(matches, collapsedState) {
+    // console.log('resetAllCollapseStates');
+    matches.forEach(match => {
+        match.collapsed = collapsedState;
+        // Recursively reset the collapsed state for the children
+        if (match.children) {
+            resetAllCollapseStates(match.children, collapsedState);
+        }
+    });
+}
+
+let isAllCollapsed = defaultCollapsed; // Initialize the collapse/expand state of all TOC entries as a global variable
+
+// Function to toggle the collapse/expand state of all TOC entries
+function toggleCollapseExpandAll() {
+    isAllCollapsed = !isAllCollapsed; // Toggle the collapse/expand state
+    resetAllCollapseStates(orcaOutlineProvider.getParsedMatches(), isAllCollapsed); // Reset all collapse states
+    orcaOutlineProvider.refresh(); // Refresh the TOC view
+}
+
 // Function to activate the extension
 function activate(context) {
     // Register the custom file system provider
@@ -511,10 +544,15 @@ function activate(context) {
     // listen to changes in the configuration
     context.subscriptions.push(vscode.workspace.onDidChangeConfiguration(e => {
         if (e.affectsConfiguration('orcatoc.defaultCollapsed')) {
-            orcaOutlineProvider.refresh();
+            console.log('orcatoc.defaultCollapsed changed');
+            resetAllCollapseStates(orcaOutlineProvider.getParsedMatches(), undefined); // Reset all collapse states to undefined
+            orcaOutlineProvider.refresh(); // Refresh the TOC view
         }
     }));
 
+    // Register the command to collapse/expand all TOC entries
+    context.subscriptions.push(vscode.commands.registerCommand('extension.toggleCollapseExpandAll', toggleCollapseExpandAll));
+
     // Highlight the TOC entry corresponding to the current cursor position
     context.subscriptions.push(vscode.window.onDidChangeTextEditorSelection(event => {
         if (event.textEditor.document.languageId === 'orcaOut' && event.textEditor.document.fileName.endsWith('.out')) {

package.json

@@ -2,7 +2,7 @@
   "name": "orcatoc",
   "displayName": "orca_toc",
   "description": "Provides an outline for ORCA files in the VS Code sidebar.",
-  "version": "0.4.0",
+  "version": "0.4.1",
   "engines": {
     "vscode": "^1.82.0"
   },
@@ -17,11 +17,15 @@
     "commands": [
       {
         "command": "extension.showOrcaOutline",
-        "title": "Show ORCA Outline"
+        "title": "orca_toc: Show ORCA Outline"
       },
       {
         "command": "extension.showOrcaOutlineExternal",
-        "title": "Show ORCA Outline External"
+        "title": "orca_toc: Show ORCA Outline External"
+      },
+      {
+        "command": "extension.toggleCollapseExpandAll",
+        "title": "orca_toc: Toggle Collapse/Expand All TOC Entries"
       }
     ],
     "views": {
@@ -46,7 +50,7 @@
       }
     ],
     "configuration": {
-      "title": "ORCA Table of Contents",
+      "title": "ORCA_TOC",
       "properties": {
         "orcatoc.defaultCollapsed": {
           "type": "boolean",

patterns.json

@@ -8,7 +8,7 @@
         "level": 2
     },
     {
-        "regex": "^\\-+\\r?\\n +([^\\r?\\n]+)\\r?\\n\\-+",
+        "regex": "^\\-+\\r?\\n +([^\\r?\\n\\[]+)\\r?\\n\\-+",
         "level": 2
     },
     {