Refactored advanced decoder interface

Author: haneefdm

src/frontend/swo/advanced-decoder.ts

@@ -0,0 +1,53 @@
+import { SWODecoderConfig } from './common';
+
+export interface SWOAdvancedDecoderConfig extends SWODecoderConfig {
+    decoder: string;
+    config: any;
+    ports: number[];
+}
+
+export interface AdvancedDecoder {
+    /**
+     * @param config: Contains the swo configuration from launch.json. Do not modify this object
+     * @param outputData: function to call to output data to the OUTPUT Window
+     * @param graphData: Function that emits a message to the grapher. Not sure how this works
+     *
+     * I am documenting what I know. Please make a PR with edits if you know more. Do not use
+     * the parameters outputData or graphData until after init is ready. If you wish to do any debug
+     * prints, use console.log(...)
+     *
+     * Note that typeName() and outputLabel() are used to create a name for the OUTPUT panel. So, you
+     * can't use outputData/graphData in those methods either.
+     */
+    init(
+        config: SWOAdvancedDecoderConfig,
+        outputData: (output: string, timestamp?: boolean) => void,
+        graphData: (data: number, id: string) => void
+    ): void;
+
+    typeName(): string;     // Used to create the OUTPUT Panel name
+    outputLabel(): string;  // Used to create the OUTPUT Panel name
+
+    /**
+     *
+     * @param port: the ITM Port
+     * @param data: Data just received
+     */
+    softwareEvent(port: number, data: Buffer): void;
+
+    /**
+     * SWV Sync packet received. Probably can be ignored
+     */
+    synchronized(): void;
+    /**
+     * SWV Sync lost. Probably can be ignored
+     */
+    lostSynchronization(): void;
+
+    /**
+     * Do any cleanup you want to. Again do not use any functions passed to init from here
+     * because they are in the process of being destroyed. Even if it works, we cannot guarantee
+     * that in the future
+     */
+    dispose?(): void;
+}

src/frontend/swo/common.ts

@@ -28,12 +28,6 @@ export interface SWOGraphDecoderConfig extends SWOBasicDecoderConfig {
     graphId: string;
 }
 
-export interface SWOAdvancedDecoderConfig extends SWODecoderConfig {
-    decoder: string;
-    config: any;
-    ports: number[];
-}
-
 export interface GraphConfiguration {
     type: string;
     label: string;
@@ -88,20 +82,6 @@ export interface GrapherConfigurationMessage extends GrapherMessage {
     status: 'stopped' | 'terminated' | 'continued';
 }
 
-export interface AdvancedDecoder {
-    init(
-        config: SWOAdvancedDecoderConfig,
-        outputData: (output: string, timestamp?: boolean) => void,
-        graphData: (data: number, id: string) => void
-    ): void;
-    typeName(): string;
-    outputLabel(): string;
-    softwareEvent(port: number, data: Buffer): void;
-    synchronized(): void;
-    lostSynchronization(): void;
-    dispose?(): void;
-}
-
 export enum PacketType {
     HARDWARE = 1,
     SOFTWARE,

src/frontend/swo/core.ts

@@ -7,10 +7,9 @@ import { SWOBinaryProcessor } from './decoders/binary';
 import { SWORTTGraphProcessor } from './decoders/graph';
 import { SWORTTDecoder } from './decoders/common';
 import { SWORTTSource } from './sources/common';
-import { SWODecoderConfig, GraphConfiguration, SWOAdvancedDecoderConfig,
-    SWOBinaryDecoderConfig, SWOConsoleDecoderConfig, SWOGraphDecoderConfig,
-    SWOBasicDecoderConfig, GrapherMessage, GrapherStatusMessage,
-    GrapherProgramCounterMessage } from './common';
+import { SWODecoderConfig, GraphConfiguration, SWOBinaryDecoderConfig, SWOConsoleDecoderConfig, SWOGraphDecoderConfig,
+    SWOBasicDecoderConfig, GrapherMessage, GrapherStatusMessage, GrapherProgramCounterMessage } from './common';
+import { SWOAdvancedDecoderConfig } from './advanced-decoder';
 import { SWORTTAdvancedProcessor } from './decoders/advanced';
 import { EventEmitter } from 'events';
 import { PacketType, Packet } from './common';

src/frontend/swo/decoders/advanced.ts

@@ -1,6 +1,7 @@
 import * as vscode from 'vscode';
 import { SWORTTDecoder } from './common';
-import { SWOAdvancedDecoderConfig, AdvancedDecoder, GrapherDataMessage } from '../common';
+import { GrapherDataMessage } from '../common';
+import { SWOAdvancedDecoderConfig, AdvancedDecoder } from '../advanced-decoder';
 import { EventEmitter } from 'events';
 import { Packet } from '../common';
 import { CortexDebugChannel } from '../../../dbgmsgs';