User/ivberg/fix11 LTTng floating point trace load issue (#17)

* Add floating point support
Fixes #11

Author: ivberg

CtfPlayback/FieldValues/CtfDoubleValue.cs

@@ -0,0 +1,47 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+
+using System.Globalization;
+using CtfPlayback.Metadata;
+using CtfPlayback.Metadata.TypeInterfaces;
+
+namespace CtfPlayback.FieldValues
+{
+    /// <summary>
+    /// Represents a floating point field from a CTF event
+    /// </summary>
+    public class CtfDoubleValue
+        : CtfFieldValue
+    {
+        /// <summary>
+        /// Constructor
+        /// </summary>
+        /// <param name="value">Floating point value</param>
+        public CtfDoubleValue(double value, ICtfFloatingPointDescriptor descriptor)
+            : base(CtfTypes.FloatingPoint)
+        {
+            this.Value = value;
+            this.Descriptor = descriptor;
+        }
+
+        /// <summary>
+        /// Field value
+        /// </summary>
+        public double Value { get; }
+
+        /// <summary>
+        /// CTF floating point descriptor associated with the field
+        /// </summary>
+        public ICtfFloatingPointDescriptor Descriptor { get; }
+
+        /// <summary>
+        /// Returns a string representation of the field value.
+        /// Useful when text dumping the contents of an event stream.
+        /// </summary>
+        /// <returns>The field value as a string</returns>
+        public override string GetValueAsString(GetValueAsStringOptions options = GetValueAsStringOptions.NoOptions)
+        {
+            return string.Intern(Value.ToString(CultureInfo.InvariantCulture));
+        }
+    }
+}

CtfPlayback/FieldValues/CtfFloatValue.cs

@@ -3,30 +3,37 @@
 
 using System.Globalization;
 using CtfPlayback.Metadata;
+using CtfPlayback.Metadata.TypeInterfaces;
 
 namespace CtfPlayback.FieldValues
 {
     /// <summary>
-    /// Represents a float field from a CTF event
+    /// Represents a floating point field from a CTF event
     /// </summary>
     public class CtfFloatValue
         : CtfFieldValue
     {
         /// <summary>
         /// Constructor
         /// </summary>
-        /// <param name="value">Float value</param>
-        public CtfFloatValue(float value)
-            : base(CtfTypes.Float)
+        /// <param name="value">Floating point value</param>
+        public CtfFloatValue(float value, ICtfFloatingPointDescriptor descriptor)
+            : base(CtfTypes.FloatingPoint)
         {
             this.Value = value;
+            this.Descriptor = descriptor;
         }
 
         /// <summary>
         /// Field value
         /// </summary>
         public float Value { get; }
 
+        /// <summary>
+        /// CTF floating point descriptor associated with the field
+        /// </summary>
+        public ICtfFloatingPointDescriptor Descriptor { get; }
+
         /// <summary>
         /// Returns a string representation of the field value.
         /// Useful when text dumping the contents of an event stream.

CtfPlayback/Metadata/AntlrParser/CtfListener.cs

@@ -36,6 +36,7 @@ internal class CtfListener
         private int streamCount;
         private int eventCount;
         private int integerCount;
+        private int floatCount;
         private int enumCount;
         private int stringCount;
 
@@ -1037,6 +1038,33 @@ public override void EnterTypeSpecifierEmptyInteger(CtfParser.TypeSpecifierEmpty
                 $"An integer specifier without a 'size' value is undefined: line={context.Start.Line}.");
         }
 
+        // Float
+        public override void EnterTypeSpecifierFloatingPoint(CtfParser.TypeSpecifierFloatingPointContext context)
+        {
+            this.PushFloatScope();
+        }
+
+        // See CTF 1.82 section 4.1.7 FLOATING POINT
+        public override void ExitTypeSpecifierFloatingPoint(CtfParser.TypeSpecifierFloatingPointContext context)
+        {
+            this.PopFloatScope(true);
+            throw new CtfMetadataException(
+                $"An floating_point specifier without fields is undefined: line={context.Start.Line}.");
+        }
+
+        public override void EnterTypeSpecifierFloatingPointWithFields(CtfParser.TypeSpecifierFloatingPointWithFieldsContext context)
+        {
+            this.PushFloatScope();
+        }
+
+        public override void ExitTypeSpecifierFloatingPointWithFields(CtfParser.TypeSpecifierFloatingPointWithFieldsContext context)
+        {
+            var propertyBag = this.CurrentScope.PropertyBag;
+            this.PopFloatScope(true);
+
+            context.TypeSpecifier = new CtfFloatingPointDescriptor(propertyBag);
+        }
+
         // string {}
         public override void ExitTypeSpecifierEmptyString(CtfParser.TypeSpecifierEmptyStringContext context)
         {
@@ -1330,6 +1358,7 @@ private void PopEventScope()
             this.PopScope();
         }
 
+        // Integer
         private void PushIntegerScope()
         {
             string name = $"[integer]_{this.integerCount}";
@@ -1342,6 +1371,20 @@ private void PopIntegerScope(bool removeFromParent = false)
             this.PopScope(removeFromParent);
         }
 
+        // Float
+        private void PushFloatScope()
+        {
+            string name = $"[floating_point]_{this.floatCount}";
+            this.floatCount++;
+            this.PushScope(name);
+        }
+
+        private void PopFloatScope(bool removeFromParent = false)
+        {
+            this.PopScope(removeFromParent);
+        }
+
+        // String
         private void PushStringScope()
         {
             string name = $"[string]_{this.stringCount}";

CtfPlayback/Metadata/CtfTypes.cs

@@ -46,6 +46,6 @@ public enum CtfTypes
         /// <summary>
         /// A float CTF descriptor type
         /// </summary>
-        Float
+        FloatingPoint
     }
 }

…ta/TypeInterfaces/ICtfFloatDescriptor.cs …nterfaces/ICtfFloatingPointDescriptor.csCtfPlayback/Metadata/TypeInterfaces/ICtfFloatDescriptor.cs renamed to CtfPlayback/Metadata/TypeInterfaces/ICtfFloatingPointDescriptor.cs CtfPlayback/Metadata/TypeInterfaces/ICtfFloatDescriptor.cs renamed to CtfPlayback/Metadata/TypeInterfaces/ICtfFloatingPointDescriptor.cs

@@ -4,9 +4,9 @@
 namespace CtfPlayback.Metadata.TypeInterfaces
 {
     /// <summary>
-    /// This interface is not yet implemented
+    /// Describes the properties of a floating point type.
     /// </summary>
-    public interface ICtfFloatDescriptor
+    public interface ICtfFloatingPointDescriptor
         : ICtfTypeDescriptor
     {
         /// <summary>