Allow RTT advanced decoder to displose(). Recycle output panels

Author: haneefdm

CHANGELOG.md

@@ -1,4 +1,9 @@
 # ChangeLog
+
+# V1.13.0-pre6
+* Make the advanced decoder work properly for RTT. It now allows a dispose.
+* Both SWO/RTT OUTPUT panels are now recycled instead of creating a new one every time. You can for a new one by supplying a new outputLabel and/or typeName.
+
 # V1.13.0-pre5
 * Refactored all the SWO initialization gdb commands to one common method used by all gdb servers. This eliminated tons of duplicate code.
 * All gdb servers that have SWO will now use the SWO_Init (you can override it) GDB macro. See https://github.com/Marus/cortex-debug/wiki/SWO-Output and https://github.com/Marus/cortex-debug/blob/master/support/gdb-swo.init

package.json

@@ -1,5 +1,5 @@
 {
-    "version": "1.13.0-pre5",
+    "version": "1.13.0-pre6",
     "preview": false,
     "activationEvents": [
         "onDebugResolve:cortex-debug",

src/frontend/swo/advanced-decoder.ts

@@ -1,9 +1,9 @@
 import { SWODecoderConfig } from './common';
 
 export interface SWOAdvancedDecoderConfig extends SWODecoderConfig {
-    decoder: string;
+    decoder: string;        // Path to decoder JS file
     config: any;
-    ports: number[];
+    ports: number[];        // List of ITM/RTT ports
 }
 
 export interface AdvancedDecoder {

src/frontend/swo/core.ts

@@ -444,7 +444,7 @@ class RTTDecoder extends EventEmitter {
 
     constructor(
         public readonly source: SocketSWOSource,
-        public readonly port: number,       // Thisis the rtt channel
+        public readonly port: number,       // This is the rtt channel
         public readonly bytesNeeded: number) {
         super();
         this.buffer = Buffer.alloc(bytesNeeded);
@@ -460,6 +460,7 @@ class RTTDecoder extends EventEmitter {
         this.source.on('data', this.onData.bind(this));
         this.source.on('disconnected', () => {
             this.connected = false;
+            this.emit('disconnected');
         });
     }
 
@@ -526,6 +527,7 @@ export class RTTCore extends SWORTTCoreBase {
         if (src) {
             const dec = new RTTDecoder(src, src.channel, 4);
             dec.on('software-event', this.onPacket.bind(this));
+            dec.on('disconnected', this.dispose.bind(this));
             this.decoders.push(dec);
         } else {
             console.error('Null source?');

src/frontend/swo/decoders/advanced.ts

@@ -17,6 +17,7 @@ export class SWORTTAdvancedProcessor extends EventEmitter implements SWORTTDecod
     private ports: number[];
     private decoder: AdvancedDecoder;
     private timer = new HrTimer();
+    private static outputPanels = new Map<string, vscode.OutputChannel>();
 
     constructor(config: SWOAdvancedDecoderConfig) {
         super();
@@ -39,7 +40,15 @@ export class SWORTTAdvancedProcessor extends EventEmitter implements SWORTTDecod
             }
             try {
                 this.decoder.init(config, this.displayOutput.bind(this), this.graphData.bind(this));
-                this.output = vscode.window.createOutputChannel(`SWO/RTT: ${this.decoder.outputLabel() || ''} [type: ${this.decoder.typeName()}]`);
+                const name = `SWO/RTT: ${this.decoder.outputLabel() || ''} [type: ${this.decoder.typeName()}]`;
+                let panel = SWORTTAdvancedProcessor.outputPanels.get(name);
+                if (!panel) {
+                    panel = vscode.window.createOutputChannel(name);
+                    SWORTTAdvancedProcessor.outputPanels.set(name, panel);
+                } else {
+                    panel.clear();
+                }
+                this.output = panel;
             } catch (e) {
                 throw new Error(`Error initializing decoder class. Potential issues with outputLabel(), typeName() or init(): ${e.toString()}`);
             }
@@ -96,7 +105,8 @@ export class SWORTTAdvancedProcessor extends EventEmitter implements SWORTTDecod
 
     public dispose() {
         try {
-            this.output.dispose();
+            // We are recycling these now. So, do not dispose()
+            // this.output.dispose();
         } finally {
             this.output = undefined;
             this.close();
@@ -110,7 +120,7 @@ export class SWORTTAdvancedProcessor extends EventEmitter implements SWORTTDecod
             } catch (e) {
                 CortexDebugChannel.debugMessage('Error: in dispose() for decoder ' + e.toString());
             }
-            this.decoder = undefined;
         }
+        this.decoder = undefined;
     }
 }