Add Freescale Nexus decoder implementation

[babeltrace.git] / converter / nexus / NxMessageVisitor.h

diff --git a/converter/nexus/NxMessageVisitor.h b/converter/nexus/NxMessageVisitor.h
new file mode 100644 (file)
index 0000000..8accc13
--- /dev/null
+++ b/converter/nexus/NxMessageVisitor.h
@@ -0,0 +1,104 @@
+/*
+ * Copyright (C) 2013 Freescale Semiconductor, Inc.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included
+ * in all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
+ * IN THE SOFTWARE.
+ */
+
+#ifndef NXMESSAGEVISITOR_H
+#define NXMESSAGEVISITOR_H
+
+#include <string>
+
+using std::string;
+
+class NxDefaultMessage;
+class NxDebugStatusMessage;
+class NxDeviceIDMessage;
+class NxOwnershipTraceMessage;
+class NxDataAcquisitionMessage;
+class NxErrorMessage;
+class NxProgramTraceSync;
+class NxDataTraceWrite;
+class NxDataTraceRead;
+class NxDataTraceWriteSync;
+class NxDataTraceReadSync;
+class NxWatchpointMessage;
+class NxResourceFullMessage;
+class NxProgramTraceIndirectBranch;
+class NxProgramTraceIndirectBranchSync;
+class NxProgramTraceCorrelation;
+class NxDAMInCircuitTraceMessage;
+class NxCAMInCircuitTraceMessage;
+class NxCDMInCircuitTraceMessage;
+class NxDPQMInCircuitTraceMessage;
+class NxDPFMInCircuitTraceMessage;
+class NxCoreInCircuitTraceMessage;
+class NxInCircuitTraceMessage;
+class NxTimeStampCorrelation;
+
+// Nexus Message Visitor follows the standard visitor pattern.
+// It is the base class for the visitor protocol.
+class NxMessageVisitor
+{
+public:
+
+       NxMessageVisitor() :
+               useful_visit_(false)
+       {
+       }
+
+       virtual ~NxMessageVisitor()
+       {
+       }
+
+       // Must override in specific visitor.
+       virtual void visit(NxDefaultMessage *m) = 0;
+       virtual void visit(NxDebugStatusMessage *m) = 0;
+       virtual void visit(NxDeviceIDMessage *m) = 0;
+       virtual void visit(NxOwnershipTraceMessage *m) = 0;
+       virtual void visit(NxDataAcquisitionMessage *m) = 0;
+       virtual void visit(NxErrorMessage *m) = 0;
+       virtual void visit(NxProgramTraceSync *m) = 0;
+       virtual void visit(NxDataTraceWrite *m) = 0;
+       virtual void visit(NxDataTraceRead *m) = 0;
+       virtual void visit(NxDataTraceWriteSync *m) = 0;
+       virtual void visit(NxDataTraceReadSync *m) = 0;
+       virtual void visit(NxWatchpointMessage *m) = 0;
+       virtual void visit(NxResourceFullMessage *m) = 0;
+       virtual void visit(NxProgramTraceIndirectBranch *m) = 0;
+       virtual void visit(NxProgramTraceIndirectBranchSync *m) = 0;
+       virtual void visit(NxProgramTraceCorrelation *m) = 0;
+       virtual void visit(NxDAMInCircuitTraceMessage *m) = 0;
+       virtual void visit(NxCAMInCircuitTraceMessage *m) = 0;
+       virtual void visit(NxCDMInCircuitTraceMessage *m) = 0;
+       virtual void visit(NxDPQMInCircuitTraceMessage *m) = 0;
+       virtual void visit(NxDPFMInCircuitTraceMessage *m) = 0;
+       virtual void visit(NxCoreInCircuitTraceMessage *m) = 0;
+       virtual void visit(NxInCircuitTraceMessage *m) = 0;
+       virtual void visit(NxTimeStampCorrelation *m) = 0;
+
+       // output message information as a string
+       virtual string asString() const = 0;
+
+protected:
+
+       bool useful_visit_;
+};
+
+#endif // NXMESSAGEVISITOR_H