Merge branch 'v2'

Author: nhmkdev

Format/BaseIOConfig.cs

@@ -0,0 +1,81 @@
+////////////////////////////////////////////////////////////////////////////////
+// The MIT License (MIT)
+//
+// Copyright (c) 2019 Tim Stair
+//
+// 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.
+////////////////////////////////////////////////////////////////////////////////
+
+using System.IO;
+using KeyCap.Util;
+
+namespace KeyCap.Format
+{
+    public abstract class BaseIOConfig
+    {
+        public int Flags { get; set; }
+        // https://docs.microsoft.com/en-us/windows/win32/inputdev/virtual-key-codes
+        public byte VirtualKey { get; set; }
+        public int Parameter { get; set; }
+
+        public BaseIOConfig() { }
+
+        /// <summary>
+        /// Clone constructor
+        /// </summary>
+        /// <param name="config"></param>
+        public BaseIOConfig(BaseIOConfig config)
+        {
+            Flags = config.Flags;
+            VirtualKey = config.VirtualKey;
+            Parameter = config.Parameter;
+        }
+
+        public BaseIOConfig(Stream zStream)
+        {
+            Flags = StreamUtil.ReadIntFromStream(zStream);
+            VirtualKey = StreamUtil.ReadByteFromStream(zStream);
+            StreamUtil.ReadBytesFromStream(zStream, 3);
+            Parameter = StreamUtil.ReadIntFromStream(zStream);
+        }
+
+        /// <summary>
+        /// Determines if the input type is flagged (as the there are multiple flags)
+        /// </summary>
+        /// <param name="eFlag">Flag to check for</param>
+        /// <returns>true if the flag bit is 1, false otherwise</returns>
+        public bool IsFlaggedAs(System.Enum eFlag)
+        {
+            return BitUtil.IsFlagged(Flags, eFlag);
+        }
+
+        public abstract string GetDescription();
+
+        public void SerializeToStream(Stream zStream)
+        {
+            // Due to the struct format on the C side the data is written as 3 32-bit ints
+            StreamUtil.WriteIntToStream(zStream, Flags);
+            zStream.WriteByte(VirtualKey);
+            zStream.WriteByte(0);
+            zStream.WriteByte(0);
+            zStream.WriteByte(0);
+            StreamUtil.WriteIntToStream(zStream, Parameter);
+        }
+    }
+}

Format/ConfigFileManager.cs

@@ -0,0 +1,97 @@
+////////////////////////////////////////////////////////////////////////////////
+// The MIT License (MIT)
+//
+// Copyright (c) 2019 Tim Stair
+//
+// 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.
+////////////////////////////////////////////////////////////////////////////////
+
+using System;
+using System.Collections.Generic;
+using System.IO;
+using System.Windows.Forms;
+using Support.UI;
+
+namespace KeyCap.Format
+{
+    public class ConfigFileManager
+    {
+        private static readonly int FILE_DATA_PREFIX = (int)0x0E0CA000;
+        private static readonly int DATA_FORMAT_VERSION = (int)0x1;
+
+        /// <summary>
+        /// Saves the remap entries to a versioned file format
+        /// </summary>
+        /// <param name="listRemapEntries">The entries to persist</param>
+        /// <param name="sFileName">The name of the file to save to</param>
+        public void SaveFile(List<RemapEntry> listRemapEntries, string sFileName)
+        {
+            var zFileStream = new FileStream(sFileName, FileMode.Create, FileAccess.Write, FileShare.None);
+            StreamUtil.WriteIntToStream(zFileStream, FILE_DATA_PREFIX);
+            StreamUtil.WriteIntToStream(zFileStream, DATA_FORMAT_VERSION);
+            listRemapEntries.ForEach(zEntry =>
+            {
+                var arrayBytes = zEntry.SerializeToBytes();
+                zFileStream.Write(arrayBytes, 0, arrayBytes.Length);
+            });
+            zFileStream.Close();
+        }
+
+        /// <summary>
+        /// Loads the remap entries from the specified file
+        /// </summary>
+        /// <param name="sFileName"></param>
+        /// <returns></returns>
+        public List<RemapEntry> LoadFile(string sFileName)
+        {
+            FileStream zFileStream = null;
+            var listConfigs = new List<RemapEntry>();
+            try
+            {
+                zFileStream = new FileStream(sFileName, FileMode.Open, FileAccess.Read, FileShare.Read);
+                var nPrefix = StreamUtil.ReadIntFromStream(zFileStream);
+                if (nPrefix != FILE_DATA_PREFIX)
+                {
+                    throw new Exception("{} does not have the correct data prefix. This is likely an unsupported format.".FormatString(sFileName));
+                }
+
+                var nDataFormatVersion = StreamUtil.ReadIntFromStream(zFileStream);
+                if (nDataFormatVersion != DATA_FORMAT_VERSION)
+                {
+                    throw new Exception("{} indicates an unsupported data format.".FormatString(sFileName));
+                }
+
+                while (zFileStream.Position < zFileStream.Length)
+                {
+                    listConfigs.Add(new RemapEntry(zFileStream));
+                }
+            }
+            catch (Exception e)
+            {
+                MessageBox.Show(e.Message);
+            }
+            finally
+            {
+                zFileStream?.Close();
+            }
+
+            return listConfigs;
+        }
+    }
+}