Merge pull request mathworks#44 from development/feature-section-highlighting

Feature section highlighting

Author: dklilley

matlab/+matlabls/+internal/computeCodeData.m

@@ -262,7 +262,9 @@
         end
 
     catch exception
-        disp(['Error occurred while fetching sections: ', exception.message]);        
+        disp(['Error occurred while fetching sections: ', exception.message]);
+        % Add the error message to the codeInfo for syntax errors
+        codeInfo.errorInfo = struct('message', exception.message);
     end
 
     %% Finalize Data

src/indexing/FileInfoIndex.ts

@@ -12,6 +12,12 @@ export interface RawCodeData {
     packageName: string
     references: CodeDataReference[]
     sections: CodeDataSectionInfo[]
+    errorInfo: CodeDataErrorInfo | undefined
+}
+
+
+interface CodeDataErrorInfo {
+    message: string
 }
 
 /**
@@ -373,16 +379,25 @@ export class MatlabCodeData {
     readonly references: Map<string, Range[]>
     readonly sections: Map<string, Range[]>
     readonly packageName: string
+    errorMessage: string | undefined
 
     constructor (public uri: string, rawCodeData: RawCodeData, public classInfo?: MatlabClassInfo) {
         this.functions = new Map<string, MatlabFunctionInfo>()
         this.references = new Map<string, Range[]>()
         this.sections = new Map<string, Range[]>()
         this.packageName = rawCodeData.packageName
-
+        this.errorMessage = undefined
         this.parseFunctions(rawCodeData.functionInfo)
         this.parseReferences(rawCodeData.references)
         this.parseSectionInfo(rawCodeData.sections)
+        this.parseErrorInfo(rawCodeData.errorInfo)
+    }
+    parseErrorInfo (errorInfo: CodeDataErrorInfo | undefined) {
+        if(errorInfo == undefined) {
+            this.errorMessage = undefined
+            return
+        }
+        this.errorMessage = errorInfo.message
     }
 
     /**

src/notifications/NotificationService.ts

@@ -34,6 +34,9 @@ export enum Notification {
     // Telemetry
     LogTelemetryData = 'telemetry/logdata',
 
+    // MATLAB File Sections Updates
+    MatlabSections = 'matlab/sections',
+
     // Licensing
     LicensingServerUrl = 'licensing/server/url',
     LicensingData = 'licensing/data',

src/providers/navigation/NavigationSupportProvider.ts

@@ -12,6 +12,7 @@ import MatlabLifecycleManager from '../../lifecycle/MatlabLifecycleManager'
 import Indexer from '../../indexing/Indexer'
 import DocumentIndexer from '../../indexing/DocumentIndexer'
 import PathResolver from './PathResolver'
+import NotificationService, { Notification } from '../../notifications/NotificationService'
 
 class NavigationSupportProvider {
     constructor (
@@ -141,20 +142,31 @@ class NavigationSupportProvider {
             })
         })
 
+
         /**
          * Handle a case when the indexer fails due to the user being in the middle of an edit.
          * Here the documentSymbol cache has some symbols but the codeData cache has none. So we
          * assume that the user will soon fix their code and just fall back to what we knew for now.
          */
-        if (result.length === 0) {
+        if (result.length === 0 && codeData.errorMessage !== undefined) {
             const cached = this._documentSymbolCache.get(uri) ?? result
             if (cached.length > 0) {
                 return cached
             }
         }
         this._documentSymbolCache.set(uri, result)
+        this._sendSectionRangesForHighlighting(result, uri)
         return result
     }
+
+    private _sendSectionRangesForHighlighting(result: SymbolInformation[], uri: string) {
+        const sections = result.filter(result => result.kind === SymbolKind.Module)
+        const sectionRanges: Range[] = []
+        sections.forEach((section) => {
+            sectionRanges.push(section.location.range)
+        })
+        NotificationService.sendNotification(Notification.MatlabSections, { uri, sectionRanges })
+    }
 }
 
 export default NavigationSupportProvider