- UI tweak: clear up wording on the 'Import Keys..' dialog

- UX tweak: friendlier error to handle key files with malformed lines (this may be common)
- improved logging, exception-handling and msgboxes
- improved build/staging consistency - remove redundant copies of BMS-Full*.key

Author: arithex

Falcon BMS Alternative Launcher/App.xaml.cs

@@ -13,8 +13,7 @@ public partial class App
         public App()
         {
             Current.DispatcherUnhandledException += App_DispatcherUnhandledException;
-            Diagnostics.WriteLogFile(false, "Log Start");
-            Diagnostics.Log("Application Initialization completed successfully.", Diagnostics.LogLevels.Info);
+            Diagnostics.Log("Application Initialization starting.");
         }
 
         private static void App_DispatcherUnhandledException(object sender, DispatcherUnhandledExceptionEventArgs e)
@@ -25,23 +24,20 @@ private static void App_DispatcherUnhandledException(object sender, DispatcherUn
                     MessageBoxButton.OK, MessageBoxImage.Information);
 
                 e.Handled = true;
+                return;
             }
 
-            else
+            if (Debugger.IsAttached)
             {
-                Debug.WriteLine(e.ToString());
-
-                // Skip this step if debugging so the debugger can catch errors.
-                if (Debugger.IsAttached) return;
-
-                MessageBox.Show("An unknown error has occured. Contact support if this problem persists.", "Error",
-                    MessageBoxButton.OK, MessageBoxImage.Error);
+                Debug.WriteLine(e.Exception.ToString());
+                Debugger.Break();
+            }
 
-                Diagnostics.Log(e.ToString());
-                Diagnostics.WriteLogFile();
+            Diagnostics.Log(e.Exception);
+            Diagnostics.ShowErrorMsgbox(e.Exception);
 
-                e.Handled = true;
-            }
+            e.Handled = true;
+            return;
         }
     }
 }

Falcon BMS Alternative Launcher/BMS - Full-F15ABCD.key

@@ -1,7 +1,8 @@
 using System;
+using System.Diagnostics;
 using System.IO;
 using System.Text;
-using System.Windows.Forms;
+using System.Windows;
 
 namespace FalconBMS.Launcher
 {
@@ -15,94 +16,68 @@ public enum LogLevels
             Exception,
         }
 
-        #region Fields
+        static StreamWriter logWriter;
 
-        internal static string logData;
-
-        public static readonly string AppDataPath = $"{Environment.GetFolderPath(Environment.SpecialFolder.LocalApplicationData, Environment.SpecialFolderOption.Create)}" + "\\Benchmark_Sims";
+        static Diagnostics()
+        {
+            string appDataPath = $"{Environment.GetFolderPath(Environment.SpecialFolder.LocalApplicationData, Environment.SpecialFolderOption.Create)}";
+            string logFileDirectory = Path.Combine(appDataPath, @"Benchmark_Sims");
 
-        public static readonly string LogFilePath = $"{AppDataPath}" + "\\Launcher_Log.txt";
+            if (false == Directory.Exists(logFileDirectory))
+                Directory.CreateDirectory(logFileDirectory);
 
-        #endregion
+            string logFilePath = Path.Combine(logFileDirectory, @"Launcher_Log.txt");
 
-        #region Methods
+            logWriter = Utils.CreateUtf8TextWihoutBom(logFilePath, append:false);
+            logWriter.AutoFlush = true;
+        }
 
         public static void Log(string message)
         {
-            string message2 = $"[{DateTime.Now}] [INFO] :: {message}";
-            logData = logData + message2 + "\r\n";
-            //WriteLogFile(logData);
+            Log(message, LogLevels.Info);
         }
 
         public static void Log(string message, LogLevels logLevel)
         {
-            string message2 = $"[{DateTime.Now}] [{GetLogLevelText(logLevel)}] :: {message}";
-            logData = logData + message2 + "\r\n";
-            //WriteLogFile(logData);
+            string level = GetLogLevelText(logLevel);
+
+            Debug.WriteLine($"LOG_{level}: " + message);
+
+            string message2 = $"[{DateTime.Now}] [{level}] :: {message}";
+            logWriter.WriteLine(message2);
         }
 
         public static void Log(Exception exception)
         {
+            Debug.WriteLine("LOG_EXCEPTION: " + exception.Message);
+
             string message2 = $"[{DateTime.Now}] [EXCEPTION] {exception.Message}:: \r\n \r\n Source: {exception.Source} \r\n Target Site: {exception.TargetSite} \r\n Message: {exception.Message} \r\n Details: {exception.InnerException} \r\n \r\n Exception Data: {exception.Data} \r\n \r\n Stack Trace: {exception.StackTrace} \r\n ============ \r\n";
-            logData = logData + message2 + "\r\n";
-            //WriteLogFile(logData);
+            logWriter.WriteLine(message2);
         }
 
-        public static void Log(Exception exception, string message)
+        public static void ShowErrorMsgbox(Exception ex)
         {
-            string message2 = $"[{DateTime.Now}] [EXCEPTION] {exception.Message} \r\n {message} \r\n Source: {exception.Source} \r\n Target Site: {exception.TargetSite} \r\n Message: {exception.Message} \r\n Details: {exception.InnerException} \r\n \r\n Exception Data: {exception.Data} \r\n \r\n Stack Trace: {exception.StackTrace} \r\n ============ \r\n";
-            logData = logData + message2 + "\r\n";
-            //WriteLogFile(logData);
+            ShowErrorMsgbox(
+                "An unknown problem occurred, check error log for details:\r\n\r\n"+
+                "%LocalAppData%\\Benchmark_Sims\\Launcher_Log.txt", ex);
         }
 
-        public static void WriteLogFile()
+        public static void ShowErrorMsgbox(string message, Exception ex = null)
         {
-            WriteLogFile(false, logData);
-        }
+            if (ex != null)
+                message += "\r\n\r\n" + ex.GetType() + "\r\n" + ex.Message;
 
-        public static void WriteLogFile(Exception e)
-        {
-            WriteLogFile(false, logData + $"{e}");
-            MessageBox.Show("Error Log Saved to " + LogFilePath);
+            MessageBox.Show(message, "Error",
+                MessageBoxButton.OK, MessageBoxImage.Error);
         }
 
-        public static void WriteLogFile(bool append, Exception e)
+        public static void FinalizeLogfile()
         {
-            WriteLogFile(append, $"{e}");
-            MessageBox.Show("Error Log Saved to " + LogFilePath);
-        }
-
-        public static void WriteLogFile(bool append, string args)
-        {
-            try
-            {
-                if (!Directory.Exists(AppDataPath))
-                {
-                    Directory.CreateDirectory(AppDataPath);
-                }
-
-                DirectoryInfo dirInfo = new DirectoryInfo(AppDataPath);
-                dirInfo.Attributes = dirInfo.Attributes & ~FileAttributes.ReadOnly;
-
-                if (!File.Exists(LogFilePath))
-                {
-                    FileStream fs = File.Create(LogFilePath);
-                    fs.Close();
-                    File.SetCreationTimeUtc(LogFilePath, DateTime.UtcNow);
-                }
-
-                StreamWriter file = new StreamWriter(LogFilePath, append, Encoding.Default);
-
-                file.Write(args);
-                file.Close(); 
-            }
-            catch
-            {
-                MessageBox.Show(args);
-            }
+            logWriter.Close();
+            logWriter = null;
         }
 
-        internal static string GetLogLevelText(LogLevels logLevel)
+        private static string GetLogLevelText(LogLevels logLevel)
         {
             switch (logLevel)
             {
@@ -115,10 +90,9 @@ internal static string GetLogLevelText(LogLevels logLevel)
                 case LogLevels.Exception:
                     return "EXCEPTION";
                 default:
-                    throw new ArgumentOutOfRangeException(nameof(logLevel), logLevel, null);
+                    throw new InvalidProgramException("GetLogLevelText");
             }
         }
 
-        #endregion
     }
 }

Falcon BMS Alternative Launcher/BMS - Full.key

@@ -44,9 +44,10 @@
   </PropertyGroup>
   <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|AnyCPU' ">
     <PlatformTarget>x86</PlatformTarget>
-    <DebugType>none</DebugType>
+    <DebugSymbols>true</DebugSymbols>
+    <DebugType>pdbonly</DebugType>
     <Optimize>true</Optimize>
-    <OutputPath>bin\Release\</OutputPath>
+    <OutputPath>..\bin\Release\</OutputPath>
     <DefineConstants>TRACE</DefineConstants>
     <ErrorReport>prompt</ErrorReport>
     <WarningLevel>4</WarningLevel>
@@ -212,12 +213,6 @@
       <LastGenOutput>Resources.Designer.cs</LastGenOutput>
     </EmbeddedResource>
     <None Include="app.manifest" />
-    <Content Include="BMS - Full-F15ABCD.key">
-      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
-    </Content>
-    <Content Include="BMS - Full.key">
-      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
-    </Content>
     <None Include="packages.config">
       <SubType>Designer</SubType>
     </None>

Falcon BMS Alternative Launcher/Diagnostics.cs

@@ -191,7 +191,8 @@ public void SaveXml()
             }
             catch (Exception ex)
             {
-                Diagnostics.WriteLogFile(ex);
+                Diagnostics.Log(ex);
+                Diagnostics.ShowErrorMsgbox(ex);
             }
             finally
             {

Falcon BMS Alternative Launcher/Falcon BMS Alternative Launcher.csproj

@@ -196,7 +196,7 @@ public int JoyAxisState(int joyAxisNumber)
             }
             catch
             {
-                System.Diagnostics.Debug.WriteLine("(Catching exception from hwDevice.CurrentJoystickState.)");
+                Diagnostics.Log("JoyAssgn: catching exception from hwDevice.CurrentJoystickState.");
                 return 0;
             }
         }

Falcon BMS Alternative Launcher/Input/DeviceControl.cs

@@ -60,6 +60,41 @@ public KeyFile(string filename)
             return;
         }
 
+        public static bool ValidateKeyfileLines(string filename)
+        {
+            if (false == File.Exists(filename)) return false;
+
+            List<string> errors = new List<string>(50);
+
+            using (StreamReader reader = File.OpenText(filename))
+            {
+                int lineNum = 0;
+                while (true)
+                {
+                    ++lineNum;
+
+                    string line = reader.ReadLine();
+                    if (line == null) break;
+
+                    if (string.IsNullOrWhiteSpace(line))
+                        continue;
+                    if (RegexFactory.LineComment.IsMatch(line))
+                        continue;
+                    if (RegexFactory.ButtonOrHatBindingLine.IsMatch(line))
+                        continue;
+                    if (RegexFactory.KeyBindingLine.IsMatch(line))
+                        continue;
+
+                    // Unrecognized line.
+                    string err = $"Unrecognized line #{lineNum}: " + line;
+                    Diagnostics.Log(err, Diagnostics.LogLevels.Warning);
+
+                    errors.Add(err);
+                }
+            }
+            return (errors.Count == 0);
+        }
+
         private static string ParseCategoryHeaderLabel(string line)
         {
             Match m = RegexFactory.CategoryHeaderLine.Match(line);

Falcon BMS Alternative Launcher/Input/JoyAssgn.cs

@@ -18,46 +18,28 @@ public class Program
         [STAThread]
         public static void Main()
         {
-            // Set cwd to the EXE location.
-            string thisExe = Assembly.GetExecutingAssembly().Location;
-            string thisExeDir = Path.GetDirectoryName(thisExe);
-            Environment.CurrentDirectory = thisExeDir;
-
-            // Launch the WPF app.
-            AppDomain.CurrentDomain.AssemblyResolve += OnResolveAssembly;
-            App.Main();
-        }
-
-        private static void CurrentDomain_UnhandledException(object sender, UnhandledExceptionEventArgs e)
-        {
-            if (e.ExceptionObject is NotImplementedException)
+            try
             {
-                Exception ex = e.ExceptionObject as Exception;
-
-                MessageBox.Show("This feature has not yet been implemented.", "Feature not Implemented",
-                    MessageBoxButton.OK, MessageBoxImage.Information);
-               
-                
-                //ex.Handled = true;
+                // Set cwd to the EXE location.
+                string thisExe = Assembly.GetExecutingAssembly().Location;
+                string thisExeDir = Path.GetDirectoryName(thisExe);
+                Environment.CurrentDirectory = thisExeDir;
+
+                // Launch the WPF app.
+                AppDomain.CurrentDomain.AssemblyResolve += OnResolveAssembly;
+                App.Main();
             }
-
-            else
+            catch (Exception ex)
             {
-                // Skip this step if debugging so the debugger can catch errors.
-                if (Debugger.IsAttached) return;
-
-                MessageBox.Show("An unknown error has occured. Contact support if this problem persists.", "Error",
-                    MessageBoxButton.OK, MessageBoxImage.Error);
-                Diagnostics.Log(e.ExceptionObject.ToString());
-                Diagnostics.WriteLogFile();
-
-                //e.Handled = true;
+                Diagnostics.Log(ex);
+                Diagnostics.ShowErrorMsgbox(ex);
             }
-        }
-
-        private static void Current_DispatcherUnhandledException(object sender, DispatcherUnhandledExceptionEventArgs e)
-        {
-            
+            finally
+            {
+                Diagnostics.Log("Process exiting - closing logfile.");
+                Diagnostics.FinalizeLogfile();
+            }
+            return;
         }
 
         private static Assembly OnResolveAssembly(object sender, ResolveEventArgs args)

Falcon BMS Alternative Launcher/Input/KeyFile.cs

@@ -50,5 +50,5 @@
 // 既定値にすることができます:
 //[assembly: AssemblyVersion("2023.10.19.3")]
 //[assembly: AssemblyFileVersion("2023.10.19.3")]
-[assembly: AssemblyVersion("2.4.0.5")]
-[assembly: AssemblyFileVersion("2.4.0.5")]
+[assembly: AssemblyVersion("2.4.0.6")]
+[assembly: AssemblyFileVersion("2.4.0.6")]

Falcon BMS Alternative Launcher/Program.cs

@@ -125,7 +125,7 @@ private void KeyMappingtimerCode(object sender, EventArgs e)
             }
             catch (Exception ex)
             {
-                Diagnostics.WriteLogFile(ex);
+                Diagnostics.Log(ex);
             }
         }