Various review tweaks

Author: blackspherefollower

Buttplug.Apps.DeviceSimulatorGUI/PipeMessages.cs

@@ -185,7 +185,7 @@ public IDeviceSimulatorPipeMessage Deserialize(string aJsonMsg)
                 }
 
                 var msgName = o.Properties().First().Name;
-                if (!_messageTypes.Keys.Any() || !_messageTypes.Keys.Contains(msgName))
+                if (!_messageTypes.Any() || !_messageTypes.ContainsKey(msgName))
                 {
                     return new ErrorMsg($"{msgName} is not a valid message class");
                 }

Buttplug.Apps.ExampleClientGUI/ExampleClientPanel.xaml.cs

@@ -166,8 +166,8 @@ private void SendVibrate_Click(object sender, RoutedEventArgs e)
                         {
                             _client.SendDeviceMessage(dev,
                                 new VibrateCmd(dev.Index,
-                                    new List<VibrateCmd.VibrateIndex>
-                                    { new VibrateCmd.VibrateIndex(i, VibrateSpeed.Value) },
+                                    new List<VibrateCmd.VibrateSubcommand>
+                                    { new VibrateCmd.VibrateSubcommand(i, VibrateSpeed.Value) },
                                     _client.nextMsgId));
                         }
                     }
@@ -198,8 +198,8 @@ private void SendRotate_Click(object sender, RoutedEventArgs e)
                             bool clockwise = RotateSpeed.Value > 0;
                             _client.SendDeviceMessage(dev,
                                 new RotateCmd(dev.Index,
-                                    new List<RotateCmd.RotateIndex>
-                                            { new RotateCmd.RotateIndex(i, RotateSpeed.Value * (clockwise ? 1 : -1), clockwise) },
+                                    new List<RotateCmd.RotateSubcommand>
+                                            { new RotateCmd.RotateSubcommand(i, RotateSpeed.Value * (clockwise ? 1 : -1), clockwise) },
                                     _client.nextMsgId));
                         }
                     }
@@ -222,9 +222,11 @@ private void SendLinear2_Click(object sender, RoutedEventArgs e)
                 if (dev.AllowedMessages.ContainsKey("FleshlightLaunchFW12Cmd"))
                 {
                     _client.SendDeviceMessage(dev,
-                        new LinearCmd(dev.Index, new List<LinearCmd.VectorIndex>()
+                        new LinearCmd(dev.Index, new List<LinearCmd.VectorSubcommands>()
                         {
-                            new LinearCmd.VectorIndex(0, Convert.ToUInt32(LinearDuration.Text), Linear2Position.Value),
+                            new LinearCmd.VectorSubcommands(0,
+                                Convert.ToUInt32(LinearDuration.Text),
+                                Linear2Position.Value),
                         }, _client.nextMsgId));
                 }
             }

Buttplug.Apps.GameVibrationRouter.GUI/MainWindow.xaml.cs

@@ -107,7 +107,7 @@ await Dispatcher.Invoke(async () =>
                 foreach (var device in _devices)
                 {
                     // For now, we only handle devices that can take vibration messages.
-                    if (!device.Messages.Keys.Contains(typeof(SingleMotorVibrateCmd).Name))
+                    if (!device.SupportsMessage(typeof(SingleMotorVibrateCmd)))
                     {
                         continue;
                     }

Buttplug.Apps.KiirooEmulatorGUI/MainWindow.xaml.cs

@@ -80,7 +80,7 @@ private void ClosingHandler(object aObj, CancelEventArgs e)
         private void SelectionChangedHandler(object aObj, List<ButtplugDeviceInfo> aDevices)
         {
             _devices = aDevices;
-            if (_devices.Any(aDevice => aDevice.Messages.Keys.Contains("SingleMotorVibrateCmd")))
+            if (_devices.Any(aDevice => aDevice.SupportsMessage(typeof(SingleMotorVibrateCmd))))
             {
                 _translator.StartVibrateTimer();
                 return;
@@ -133,7 +133,7 @@ private void OnVibrateEvent(object aObj, VibrateEventArgs aEvent)
             {
                 foreach (var device in _devices)
                 {
-                    if (device.Messages.Keys.Contains("SingleMotorVibrateCmd"))
+                    if (device.SupportsMessage(typeof(SingleMotorVibrateCmd)))
                     {
                         await _bpServer.SendMessage(new SingleMotorVibrateCmd(device.Index, aEvent.VibrateValue));
                     }
@@ -150,19 +150,19 @@ await Dispatcher.InvokeAsync(async () =>
                 FleshlightLaunchFW12Cmd currentTranslatedCommand = null;
                 foreach (var device in _devices)
                 {
-                    if (device.Messages.Keys.Contains(typeof(KiirooCmd).Name))
+                    if (device.SupportsMessage(typeof(KiirooCmd)))
                     {
                         await _bpServer.SendMessage(new KiirooCmd(device.Index, aEvent.Position));
                     }
-                    else if (device.Messages.Keys.Contains("FleshlightLaunchFW12Cmd") ||
-                             device.Messages.Keys.Contains("SingleMotorVibrateCmd"))
+                    else if (device.SupportsMessage(typeof(FleshlightLaunchFW12Cmd)) ||
+                             device.SupportsMessage(typeof(SingleMotorVibrateCmd)))
                     {
                         if (currentTranslatedCommand == null)
                         {
                             currentTranslatedCommand = _translator.Translate(new KiirooCmd(device.Index, aEvent.Position));
                         }
                         currentTranslatedCommand.DeviceIndex = device.Index;
-                        if (device.Messages.Keys.Contains("FleshlightLaunchFW12Cmd"))
+                        if (device.SupportsMessage(typeof(FleshlightLaunchFW12Cmd)))
                         {
                             await _bpServer.SendMessage(currentTranslatedCommand);
                         }

Buttplug.Client/ButtplugWSClient.cs

@@ -154,11 +154,11 @@ public async Task Connect(Uri aURL, bool aIgnoreSSLErrors = false)
                     }
 
                     _messageSchemaVersion = si.MessageVersion;
-                    if (_messageSchemaVersion < ButtplugMessage.CurrentMessageVersion)
+                    if (_messageSchemaVersion < ButtplugMessage.CurrentSchemaVersion)
                     {
                         throw new Exception("Buttplug Server's schema version (" + _messageSchemaVersion +
-                            ") is less than the client's (" + ButtplugMessage.CurrentMessageVersion +
-                            "). A newer server is required!");
+                            ") is less than the client's (" + ButtplugMessage.CurrentSchemaVersion +
+                            "). A newer server is required.");
                     }
 
                     break;
@@ -447,12 +447,12 @@ protected async Task<ButtplugMessage> SendMessage(ButtplugMessage aMsg)
 
         protected string Serialize(ButtplugMessage aMsg)
         {
-            return _parser.Serialize(aMsg, ButtplugMessage.CurrentMessageVersion);
+            return _parser.Serialize(aMsg, ButtplugMessage.CurrentSchemaVersion);
         }
 
         protected string Serialize(ButtplugMessage[] aMsgs)
         {
-            return _parser.Serialize(aMsgs, ButtplugMessage.CurrentMessageVersion);
+            return _parser.Serialize(aMsgs, ButtplugMessage.CurrentSchemaVersion);
         }
 
         protected ButtplugMessage[] Deserialize(string aMsg)

Buttplug.Components.Controls/ButtplugDeviceInfo.cs

@@ -1,5 +1,6 @@
 using System.Collections.Generic;
 using Buttplug.Core.Messages;
+using System;
 
 namespace Buttplug.Components.Controls
 {
@@ -23,5 +24,10 @@ public override string ToString()
         {
             return $"{Index}: {Name}";
         }
+
+        public bool SupportsMessage(Type aMsg)
+        {
+            return Messages.ContainsKey(aMsg.Name);
+        }
     }
 }

Buttplug.Core/ButtplugDeviceMessage.cs

@@ -1,4 +1,5 @@
-using Newtonsoft.Json;
+using System;
+using Newtonsoft.Json;
 
 namespace Buttplug.Core
 {
@@ -7,8 +8,8 @@ public class ButtplugDeviceMessage : ButtplugMessage
         [JsonProperty(Required = Required.Always)]
         public uint DeviceIndex { get; set; }
 
-        public ButtplugDeviceMessage(uint aId, uint aDeviceIndex)
-            : base(aId)
+        public ButtplugDeviceMessage(uint aId, uint aDeviceIndex, uint aSchemaVersion = 0, Type aPreviousType = null)
+            : base(aId, aSchemaVersion, aPreviousType)
         {
             DeviceIndex = aDeviceIndex;
         }

Buttplug.Core/ButtplugJsonMessageParser.cs

@@ -123,7 +123,7 @@ public ButtplugMessage[] Deserialize(string aJsonMsg)
                 }
 
                 var msgName = o.Properties().First().Name;
-                if (!_messageTypes.Keys.Any() || !_messageTypes.Keys.Contains(msgName))
+                if (!_messageTypes.Any() || !_messageTypes.ContainsKey(msgName))
                 {
                     var err = new Error($"{msgName} is not a valid message class", ErrorClass.ERROR_MSG, ButtplugConsts.SystemMsgId);
                     _bpLogger?.LogErrorMsg(err);
@@ -163,9 +163,9 @@ public string Serialize([NotNull] ButtplugMessage aMsg, uint clientSchemaVersion
 
             // Support downgrading messages
             var tmp = aMsg;
-            while (tmp.MessageVersioningVersion > clientSchemaVersion)
+            while (tmp.SchemaVersion > clientSchemaVersion)
             {
-                if (tmp.MessageVersioningPrevious == null)
+                if (tmp.PreviousType == null)
                 {
                     if (tmp.Id == ButtplugConsts.SystemMsgId)
                     {
@@ -179,7 +179,7 @@ public string Serialize([NotNull] ButtplugMessage aMsg, uint clientSchemaVersion
                     continue;
                 }
 
-                tmp = (ButtplugMessage)aMsg.MessageVersioningPrevious.GetConstructor(
+                tmp = (ButtplugMessage)aMsg.PreviousType.GetConstructor(
                     new Type[] { tmp.GetType() }).Invoke(new object[] { tmp });
             }
 
@@ -197,9 +197,9 @@ public string Serialize([NotNull] IEnumerable<ButtplugMessage> aMsgs, uint clien
             {
                 // Support downgrading messages
                 var tmp = msg;
-                while (tmp.MessageVersioningVersion > clientSchemaVersion)
+                while (tmp.SchemaVersion > clientSchemaVersion)
                 {
-                    if (tmp.MessageVersioningPrevious == null)
+                    if (tmp.PreviousType == null)
                     {
                         if (tmp.Id == ButtplugConsts.SystemMsgId)
                         {
@@ -212,7 +212,7 @@ public string Serialize([NotNull] IEnumerable<ButtplugMessage> aMsgs, uint clien
                         continue;
                     }
 
-                    tmp = (ButtplugMessage)tmp.MessageVersioningPrevious.GetConstructor(
+                    tmp = (ButtplugMessage)tmp.PreviousType.GetConstructor(
                         new Type[] { tmp.GetType() }).Invoke(new object[] { tmp });
                 }
 

Buttplug.Core/ButtplugMessage.cs

@@ -6,7 +6,7 @@ namespace Buttplug.Core
     public class ButtplugMessage
     {
         /*
-         * Message versions
+         * Message schema versions
          *
          * These are here for backwards compatibility support, but
          * this also serves as a changelog of sorts.
@@ -19,50 +19,52 @@ public class ButtplugMessage
          *   Addition of message attributes
          */
         [JsonIgnore]
-        public const uint CurrentMessageVersion = 1;
+        public const uint CurrentSchemaVersion = 1;
 
         [JsonProperty(Required = Required.Always)]
         public uint Id { get; set; }
 
         [JsonIgnore]
-        public uint MessageVersioningVersion
+        public uint SchemaVersion
         {
             get
             {
-                return _messageVersioningVersion;
+                return _schemaVersion;
             }
 
             protected set
             {
-                _messageVersioningVersion = value;
+                _schemaVersion = value;
             }
         }
 
         [JsonIgnore]
-        public Type MessageVersioningPrevious
+        public Type PreviousType
         {
             get
             {
-                return _messageVersioningPrevious;
+                return _previousType;
             }
 
             protected set
             {
-                _messageVersioningPrevious = value;
+                _previousType = value;
             }
         }
 
         // Base class starts at version 0
         [JsonIgnore]
-        private uint _messageVersioningVersion = 0;
+        private uint _schemaVersion = 0;
 
         // No previous version for base classes
         [JsonIgnore]
-        private Type _messageVersioningPrevious = null;
+        private Type _previousType = null;
 
-        public ButtplugMessage(uint aId)
+        public ButtplugMessage(uint aId, uint aSchemaVersion = 0, Type aPreviousType = null)
         {
             Id = aId;
+            SchemaVersion = aSchemaVersion;
+            PreviousType = aPreviousType;
         }
     }