ctf: Make Events use IComposite instead of Structured definitions

Baby steps towards a more general API.

Change-Id: I38af394a23b31ecbf8bad45005dce5d9042b9378
Signed-off-by: Matthew Khouzam <matthew.khouzam@ericsson.com>
Reviewed-on: https://git.eclipse.org/r/46462
Reviewed-by: Hudson CI

diff --git a/org.eclipse.tracecompass.ctf.core.tests/src/org/eclipse/tracecompass/ctf/core/tests/event/CTFEventDefinitionTest.java b/org.eclipse.tracecompass.ctf.core.tests/src/org/eclipse/tracecompass/ctf/core/tests/event/CTFEventDefinitionTest.java
index f67138c3273f6a4e39ffde0ccb6c470724120f09..576b206bf19f74ccf3edf07764b665bd4ba84da9 100644 (file)
--- a/org.eclipse.tracecompass.ctf.core.tests/src/org/eclipse/tracecompass/ctf/core/tests/event/CTFEventDefinitionTest.java
+++ b/org.eclipse.tracecompass.ctf.core.tests/src/org/eclipse/tracecompass/ctf/core/tests/event/CTFEventDefinitionTest.java
@@ -24,6 +24,7 @@ import org.eclipse.tracecompass.ctf.core.event.EventDefinition;
 import org.eclipse.tracecompass.ctf.core.event.scope.ILexicalScope;
 import org.eclipse.tracecompass.ctf.core.event.types.Definition;
 import org.eclipse.tracecompass.ctf.core.event.types.Encoding;
+import org.eclipse.tracecompass.ctf.core.event.types.ICompositeDefinition;
 import org.eclipse.tracecompass.ctf.core.event.types.IntegerDeclaration;
 import org.eclipse.tracecompass.ctf.core.event.types.IntegerDefinition;
 import org.eclipse.tracecompass.ctf.core.event.types.StructDeclaration;
@@ -110,7 +111,7 @@ public class CTFEventDefinitionTest {
     private static void test(int rank, EventDefinition ed) {
         String title = "event #" + rank;
         assertEquals(title, 100L, ed.getTimestamp());
-        StructDefinition context = ed.getContext();
+        ICompositeDefinition context = ed.getContext();
         if (rank >= 4) {
             assertNotNull(title, context);
             if (rank >= 12) {

diff --git a/org.eclipse.tracecompass.ctf.core.tests/src/org/eclipse/tracecompass/ctf/core/tests/trace/CTFStreamInputReaderTest.java b/org.eclipse.tracecompass.ctf.core.tests/src/org/eclipse/tracecompass/ctf/core/tests/trace/CTFStreamInputReaderTest.java
index a7e4e70e339781218e5b903ab9a50427b9038dc6..90e2d23d3fab72d2e318561e2a9f37c59ba16308 100644 (file)
--- a/org.eclipse.tracecompass.ctf.core.tests/src/org/eclipse/tracecompass/ctf/core/tests/trace/CTFStreamInputReaderTest.java
+++ b/org.eclipse.tracecompass.ctf.core.tests/src/org/eclipse/tracecompass/ctf/core/tests/trace/CTFStreamInputReaderTest.java
@@ -23,6 +23,7 @@ import org.eclipse.tracecompass.ctf.core.CTFException;
 import org.eclipse.tracecompass.ctf.core.event.EventDefinition;
 import org.eclipse.tracecompass.ctf.core.event.types.Definition;
 import org.eclipse.tracecompass.ctf.core.event.types.Encoding;
+import org.eclipse.tracecompass.ctf.core.event.types.ICompositeDefinition;
 import org.eclipse.tracecompass.ctf.core.event.types.StringDeclaration;
 import org.eclipse.tracecompass.ctf.core.event.types.StringDefinition;
 import org.eclipse.tracecompass.ctf.core.event.types.StructDeclaration;
@@ -137,7 +138,7 @@ public class CTFStreamInputReaderTest {
      */
     @Test
     public void testGetCurrentPacketContext() {
-        StructDefinition result = fixture.getCurrentEvent().getPacketContext();
+        ICompositeDefinition result = fixture.getCurrentEvent().getPacketContext();
         assertNotNull(result);
     }
 

diff --git a/org.eclipse.tracecompass.ctf.core/src/org/eclipse/tracecompass/ctf/core/event/EventDefinition.java b/org.eclipse.tracecompass.ctf.core/src/org/eclipse/tracecompass/ctf/core/event/EventDefinition.java
index 7bb269bd50617b41b0dcc76d3294c011015ff6b7..aa75dd638859f73ab9b00a3056c9f78240cbb73a 100644 (file)
--- a/org.eclipse.tracecompass.ctf.core/src/org/eclipse/tracecompass/ctf/core/event/EventDefinition.java
+++ b/org.eclipse.tracecompass.ctf.core/src/org/eclipse/tracecompass/ctf/core/event/EventDefinition.java
@@ -20,6 +20,7 @@ import org.eclipse.tracecompass.ctf.core.event.scope.IDefinitionScope;
 import org.eclipse.tracecompass.ctf.core.event.scope.ILexicalScope;
 import org.eclipse.tracecompass.ctf.core.event.scope.LexicalScope;
 import org.eclipse.tracecompass.ctf.core.event.types.Definition;
+import org.eclipse.tracecompass.ctf.core.event.types.ICompositeDefinition;
 import org.eclipse.tracecompass.ctf.core.event.types.IDefinition;
 import org.eclipse.tracecompass.ctf.core.event.types.StructDeclaration;
 import org.eclipse.tracecompass.ctf.core.event.types.StructDefinition;
@@ -54,16 +55,16 @@ public final class EventDefinition implements IDefinitionScope {
     /**
      * The event context structure definition.
      */
-    private final StructDefinition fEventContext;
+    private final ICompositeDefinition fEventContext;
 
-    private final StructDefinition fStreamContext;
+    private final ICompositeDefinition fStreamContext;
 
-    private final StructDefinition fPacketContext;
+    private final ICompositeDefinition fPacketContext;
 
     /**
      * The event fields structure definition.
      */
-    private final StructDefinition fFields;
+    private final ICompositeDefinition fFields;
 
     /**
      * The StreamInputReader that reads this event definition.
@@ -91,14 +92,15 @@ public final class EventDefinition implements IDefinitionScope {
      *            the stream context
      * @param fields
      *            The event fields
+     * @since 1.0
      */
     public EventDefinition(IEventDeclaration declaration,
             CTFStreamInputReader streamInputReader,
             long timestamp,
-            StructDefinition streamContext,
-            StructDefinition eventContext,
-            StructDefinition packetContext,
-            StructDefinition fields) {
+            ICompositeDefinition streamContext,
+            ICompositeDefinition eventContext,
+            ICompositeDefinition packetContext,
+            ICompositeDefinition fields) {
         fDeclaration = declaration;
         fStreamInputReader = streamInputReader;
         fTimestamp = timestamp;
@@ -141,8 +143,9 @@ public final class EventDefinition implements IDefinitionScope {
      * Gets the fields of a definition
      *
      * @return the fields of a definition in struct form. Can be null.
+     * @since 1.0
      */
-    public StructDefinition getFields() {
+    public ICompositeDefinition getFields() {
         return fFields;
     }
 
@@ -150,8 +153,9 @@ public final class EventDefinition implements IDefinitionScope {
      * Gets the context of this event without the context of the stream
      *
      * @return the context in struct form
+     * @since 1.0
      */
-    public StructDefinition getEventContext() {
+    public ICompositeDefinition getEventContext() {
         return fEventContext;
     }
 
@@ -159,8 +163,9 @@ public final class EventDefinition implements IDefinitionScope {
      * Gets the context of this event within a stream
      *
      * @return the context in struct form
+     * @since 1.0
      */
-    public StructDefinition getContext() {
+    public ICompositeDefinition getContext() {
 
         /* Most common case so far */
         if (fStreamContext == null) {
@@ -217,8 +222,9 @@ public final class EventDefinition implements IDefinitionScope {
      * Gets the context of packet the event is in.
      *
      * @return the packet context
+     * @since 1.0
      */
-    public StructDefinition getPacketContext() {
+    public ICompositeDefinition getPacketContext() {
         return fPacketContext;
     }
 

diff --git a/org.eclipse.tracecompass.ctf.core/src/org/eclipse/tracecompass/internal/ctf/core/event/EventDeclaration.java b/org.eclipse.tracecompass.ctf.core/src/org/eclipse/tracecompass/internal/ctf/core/event/EventDeclaration.java
index 4dfd8d5ad3a40595a9901fb911f73b05f1bfcb18..c519e94f077c74e3df1e6c3d7ea6c67b16ee3fdb 100644 (file)
--- a/org.eclipse.tracecompass.ctf.core/src/org/eclipse/tracecompass/internal/ctf/core/event/EventDeclaration.java
+++ b/org.eclipse.tracecompass.ctf.core/src/org/eclipse/tracecompass/internal/ctf/core/event/EventDeclaration.java
@@ -23,6 +23,7 @@ import org.eclipse.tracecompass.ctf.core.event.EventDefinition;
 import org.eclipse.tracecompass.ctf.core.event.IEventDeclaration;
 import org.eclipse.tracecompass.ctf.core.event.io.BitBuffer;
 import org.eclipse.tracecompass.ctf.core.event.scope.ILexicalScope;
+import org.eclipse.tracecompass.ctf.core.event.types.ICompositeDefinition;
 import org.eclipse.tracecompass.ctf.core.event.types.IntegerDeclaration;
 import org.eclipse.tracecompass.ctf.core.event.types.StructDeclaration;
 import org.eclipse.tracecompass.ctf.core.event.types.StructDefinition;
@@ -90,7 +91,7 @@ public class EventDeclaration implements IEventDeclaration {
     public EventDefinition createDefinition(CTFStreamInputReader streamInputReader, @NonNull BitBuffer input, long timestamp) throws CTFException {
         StructDeclaration streamEventContextDecl = streamInputReader.getStreamEventContextDecl();
         StructDefinition streamEventContext = streamEventContextDecl != null ? streamEventContextDecl.createDefinition(fStream.getTrace(), ILexicalScope.STREAM_EVENT_CONTEXT, input) : null;
-        StructDefinition packetContext = streamInputReader.getPacketReader().getCurrentPacketEventHeader();
+        ICompositeDefinition packetContext = streamInputReader.getPacketReader().getCurrentPacketEventHeader();
         StructDefinition eventContext = fContext != null ? fContext.createDefinition(fStream.getTrace(), ILexicalScope.CONTEXT, input) : null;
         StructDefinition eventPayload = fFields != null ? fFields.createDefinition(fStream.getTrace(), ILexicalScope.FIELDS, input) : null;