Merge pull request #1 from thelink2012/develop

v1.1.0

Author: thelink2012

.gitignore

@@ -3,6 +3,7 @@
 /cmalcor-gui/obj/
 /cmalcor/bin/
 /cmalcor/obj/
+/cmalcor/build_temp/
 
 #################
 ## C++

README.md

@@ -4,6 +4,8 @@ Fortunately, it's not a device limitation: After reversing into the firmware, be
 
 I hope this is useful for the Alcor owners. I specially went after this because the brightness of any of the predefined colors except the red wasn't really confortable for my eyes.
 
+*This also works on the Mizar with the mizar_patch!*
+
 ## Installation
 
 ### Option 1: Binary

build-win32.bat

@@ -5,7 +5,12 @@
 @echo off
 
 cd cmalcor
-premake5 vs2015 && msbuild CmAlcor.sln /p:configuration=Release /p:platform=Win32
+mkdir build_temp
+mkdir build_temp\alcor
+mkdir build_temp\mizar
+premake5 vs2015 --outdir=build_temp/alcor && cd build_temp/alcor && msbuild CmAlcor.sln /p:configuration=Release /p:platform=Win32 && cd ../..
+if %errorlevel% neq 0 exit /b %errorlevel%
+premake5 vs2015 --outdir=build_temp/mizar --mizar && cd build_temp/mizar && msbuild CmAlcor.sln /p:configuration=Release /p:platform=Win32 && cd ../..
 if %errorlevel% neq 0 exit /b %errorlevel%
 cd ..
 
@@ -15,9 +20,12 @@ if %errorlevel% neq 0 exit /b %errorlevel%
 cd ..
 
 mkdir bin
+mkdir bin\mizar_patch
 
-copy /y /d "cmalcor\bin\cmalcor.exe" "bin\"
-copy /y /d "cmalcor\bin\cmalcor.dll" "bin\"
+copy /y /d "cmalcor\build_temp\alcor\bin\cmalcor.exe" "bin\"
+copy /y /d "cmalcor\build_temp\alcor\bin\cmalcor.dll" "bin\"
+copy /y /d "cmalcor\build_temp\mizar\bin\cmalcor.exe" "bin\mizar_patch\"
+copy /y /d "cmalcor\build_temp\mizar\bin\cmalcor.dll" "bin\mizar_patch\"
 ilmerge /targetplatform:v4 /out:bin/CmAlcorGUI.exe "cmalcor-gui/bin/Release/CmAlcorGUI.exe" "cmalcor-gui/bin/Release/Cyotek.Windows.Forms.ColorPicker.dll"
 copy /y /d "cmalcor-gui\bin\Release\DarkUI.dll" "bin\"
 copy /y /d "cmalcor-gui\bin\Release\CmAlcorGUI.exe.config" "bin\"
@@ -27,6 +35,15 @@ echo Better viewed on GitHub: https://github.com/thelink2012/cmalcor/blob/master
 echo. >> bin/readme.txt
 type README.md >> bin/readme.txt
 
+echo Those files allows the application to work with the CM Storm Mizar. >bin/mizar_patch/readme.txt
+echo. >>bin/mizar_patch/readme.txt
+echo Copy and replace the files in the directory CmAlcorGUI.exe is in. >>bin/mizar_patch/readme.txt
+echo. >>bin/mizar_patch/readme.txt
+echo I don't own a Mizar and did very small tests on someone that owns it, so I can't guarantee that this works great. >>bin/mizar_patch/readme.txt
+echo. >>bin/mizar_patch/readme.txt
+echo If it breaks something, see the 'Troubleshooting ^> CoolerMaster Warranty' section of the main readme as it explains how to erase the memory. >>bin/mizar_patch/readme.txt
+echo. >>bin/mizar_patch/readme.txt
+
 echo =================== https://github.com/thelink2012/cmalcor =================== > bin/license.txt
 echo. >> bin/license.txt
 type LICENSE >> bin/license.txt

cmalcor-gui/Firmware.cs

@@ -1,13 +1,14 @@
 using System;
 using System.Runtime.InteropServices;
+using System.Text;
 using System.Threading.Tasks;
 
 namespace CmAlcorGUI
 {
     public class FirmwareException : Exception
     {
         public FirmwareException(int error)
-            : base(String.Format("Firmware call failed with error code: {0}.", error))
+            : base(String.Format("{0}", Firmware.ErrorToString(error)))
         {
         }
     }
@@ -35,10 +36,41 @@ public static int LibraryVersion()
             return CmAlcor_LibraryVersion();
         }
 
+        /// <summary>
+        /// Gets the compilation flags of the unmanaged library (cmalcor.dll).
+        /// </summary>
+        public static int LibraryFlags()
+        {
+            return CmAlcor_LibraryFlags();
+        }
+
+        /// <summary>
+        /// Gets the error message from a error id.
+        /// </summary>
+        /// <returns>Returns the error message string for error, or `error.ToString()` if anything wrong happens on the call.</returns>
+        public static string ErrorToString(int error)
+        {
+            int capacity = 1024;
+            var stringBuilder = new StringBuilder(capacity);
+            if(CmAlcor_ErrorToString(error, stringBuilder, new UIntPtr((uint)capacity - 4)) != 0)
+            {
+                return stringBuilder.ToString();
+            }
+            return error.ToString();
+        }
+
+        /// <summary>
+        /// Whether the library was compiled for the CM Storm Mizar.
+        /// </summary>
+        public static bool IsLibraryForMizar()
+        {
+            return (LibraryFlags() & 0x4) != 0;
+        }
+
         /// <summary>
         /// Checks whether the mouse is connected on the computer.
         /// </summary>
-        public static bool IsAlcorPresent()
+        public static bool IsMousePresent()
         {
             return CmAlcor_IsMousePresent() != 0;
         }
@@ -134,6 +166,12 @@ public static void DisableCustomLED()
         [DllImport("cmalcor.dll", CallingConvention = CallingConvention.Cdecl)]
         private static extern int CmAlcor_LibraryVersion();
 
+        [DllImport("cmalcor.dll", CallingConvention = CallingConvention.Cdecl)]
+        private static extern int CmAlcor_LibraryFlags();
+
+        [DllImport("cmalcor.dll", CallingConvention = CallingConvention.Cdecl, CharSet = CharSet.Ansi)]
+        private static extern int CmAlcor_ErrorToString(int error, StringBuilder output, UIntPtr max_output);
+
         [DllImport("cmalcor.dll", CallingConvention = CallingConvention.Cdecl)]
         private static extern int CmAlcor_IsMousePresent();
 
@@ -155,6 +193,9 @@ public static void DisableCustomLED()
         [UnmanagedFunctionPointer(CallingConvention.Cdecl)]
         public delegate int Delegate_CmAlcor_LibraryVersion();
 
+        [UnmanagedFunctionPointer(CallingConvention.Cdecl)]
+        public delegate int Delegate_CmAlcor_LibraryFlags();
+
         #endregion
     }
 }

cmalcor-gui/MainForm.cs

@@ -86,8 +86,16 @@ private void MainForm_Load(object sender, EventArgs e)
                 Color.FromArgb(0xFF, 0xDA, 0xAA),
             });
 
-            this.startupHandlerBtn.Enabled = !HasStartupHandlerInstalled();
-            
+            if(Firmware.IsLibraryForMizar())
+            {
+                this.startupHandlerBtn.Enabled = false;
+                this.startupHandlerBtn.Visible = false;
+            }
+            else
+            {
+                this.startupHandlerBtn.Enabled = !HasStartupHandlerInstalled();
+            }
+
             UpdateUIFromMouseMemory();
         }
 
@@ -210,10 +218,13 @@ private bool IsStartupLibraryOlderThanCurrent()
             if(libCmAlcor != IntPtr.Zero) // when doesn't exist or any other error
             {
                 IntPtr ptrLibraryVersion = NativeMethods.GetProcAddress(libCmAlcor, "CmAlcor_LibraryVersion");
-                if(ptrLibraryVersion != IntPtr.Zero)
+                IntPtr ptrLibraryFlags = NativeMethods.GetProcAddress(libCmAlcor, "CmAlcor_LibraryFlags");
+                if(ptrLibraryVersion != IntPtr.Zero && ptrLibraryFlags != IntPtr.Zero)
                 {
                     var programDataLibraryVersion = (Firmware.Delegate_CmAlcor_LibraryVersion) Marshal.GetDelegateForFunctionPointer(ptrLibraryVersion, typeof(Firmware.Delegate_CmAlcor_LibraryVersion));
-                    isOlder = (programDataLibraryVersion() < Firmware.LibraryVersion());
+                    var programDataLibraryFlags = (Firmware.Delegate_CmAlcor_LibraryFlags) Marshal.GetDelegateForFunctionPointer(ptrLibraryFlags, typeof(Firmware.Delegate_CmAlcor_LibraryFlags));
+                    isOlder = (programDataLibraryVersion() < Firmware.LibraryVersion())
+                                || (programDataLibraryFlags() != Firmware.LibraryFlags());
                 }
                 NativeMethods.FreeLibrary(libCmAlcor);
             }

cmalcor-gui/Program.cs

@@ -17,14 +17,15 @@ static void Main()
             Application.EnableVisualStyles();
             Application.SetCompatibleTextRenderingDefault(false);
 
-            if(Firmware.IsAlcorPresent())
+            if(Firmware.IsMousePresent())
             {
                 Application.Run(new MainForm());
             }
             else
             {
-                MessageBox.Show("The CM Storm Alcor mouse is not connected or couldn't be found.",
-                                "CmAlcorGUI", MessageBoxButtons.OK, MessageBoxIcon.Error);
+                string message = String.Format("The CM Storm {0} mouse is not connected or couldn't be found.",
+                                               Firmware.IsLibraryForMizar()? "Mizar" : "Alcor");
+                MessageBox.Show(message, "CmAlcorGUI", MessageBoxButtons.OK, MessageBoxIcon.Error);
             }
         }
     }

cmalcor/include/cmalcor.h

@@ -6,8 +6,8 @@
 // Uses C99/C++ comments, can't bother to replace them.
 
 #if defined(CMALCOR_COMPILING) || defined(CMALCOR_COMPILING_CLI)
-#define CMALCOR_CAPI_VERSION            0x010001
-#define CMALCOR_CAPI_VERSION_STRING     "1.0.1"
+#define CMALCOR_CAPI_VERSION            0x010100
+#define CMALCOR_CAPI_VERSION_STRING     "1.1.0"
 #endif
 
 /*
@@ -77,6 +77,13 @@ extern "C" {
 #define CMALCOR_ERROR_BADSETTING        (-15)
 
 
+/*
+ * Library Compilation Flags
+ */
+#define CMALCOR_LIBFLAGS_DEBUG          (0x1)
+#define CMALCOR_LIBFLAGS_MIZARPATCH     (0x4)
+
+
 /*
  * Functions
  */
@@ -89,6 +96,14 @@ extern "C" {
 CMALCOR_API
 int CmAlcor_LibraryVersion();
 
+///
+/// Gets the compilation flags of this library.
+///
+/// See `CMALCOR_LIBFLAGS_*`.
+///
+CMALCOR_API
+int CmAlcor_LibraryFlags();
+
 ///
 /// Transforms a CMALCOR_ERROR_* into a string.
 /// 

cmalcor/premake5.lua

@@ -6,16 +6,31 @@
     Options and Actions
 --]]
 
+newoption {
+    trigger     = "outdir",
+    value       = "path",
+    description = "Output directory for the build files"
+}
+if not _OPTIONS["outdir"] then
+    _OPTIONS["outdir"] = "."
+end
+
+newoption {
+    trigger     = "mizar",
+    description = "Makes a project that builds the Mizar based library"
+}
+
 --[[
     The Solution
 --]]
 solution "CmAlcor"
 
     configurations { "Release", "Debug" }
 
+    location( _OPTIONS["outdir"] )
     targetprefix "" -- no 'lib' prefix on gcc
-    targetdir "bin"
-    implibdir "bin"
+    targetdir (_OPTIONS["outdir"] .. '/' .. "bin")
+    implibdir (_OPTIONS["outdir"] .. '/' .. "bin")
 
     startproject "cmalcor-cli"
 
@@ -29,6 +44,10 @@ solution "CmAlcor"
         "_SCL_SECURE_NO_WARNINGS"
     }
 
+    if _OPTIONS["mizar"] then
+        defines { "MIZAR_PATCH=1" }
+    end
+
     includedirs { "include" }
 
     configuration "Debug*"