Resolve #204: Add option to prefer 24-hour time when parsing

Author: dziemborowicz

Hourglass/App.config

@@ -22,6 +22,9 @@
             <setting name="UpgradeRequired" serializeAs="String">
                 <value>True</value>
             </setting>
+            <setting name="Prefer24HourTime" serializeAs="String">
+                <value>False</value>
+            </setting>
         </Hourglass.Properties.Settings>
     </userSettings>
 </configuration>

Hourglass/AppEntry.cs

@@ -172,6 +172,7 @@ private static void SetGlobalSettingsFromArguments(CommandLineArguments argument
         {
             Settings.Default.ShowInNotificationArea = arguments.ShowInNotificationArea;
             Settings.Default.OpenSavedTimersOnStartup = arguments.OpenSavedTimers;
+            Settings.Default.Prefer24HourTime = arguments.Prefer24HourTime;
         }
 
         /// <summary>

Hourglass/CommandLineArguments.cs

@@ -149,6 +149,11 @@ public static string Usage
         /// </summary>
         public bool OpenSavedTimers { get; private set; }
 
+        /// <summary>
+        /// Gets a value indicating whether to prefer interpreting time of day values as 24-hour time.
+        /// </summary>
+        public bool Prefer24HourTime { get; private set; }
+
         /// <summary>
         /// Gets or sets a value indicating what information to display in the timer window title.
         /// </summary>
@@ -292,6 +297,7 @@ private static CommandLineArguments GetArgumentsFromMostRecentOptions()
                 Sound = options.Sound,
                 LoopSound = options.LoopSound,
                 OpenSavedTimers = Settings.Default.OpenSavedTimersOnStartup,
+                Prefer24HourTime = Settings.Default.Prefer24HourTime,
                 WindowTitleMode = options.WindowTitleMode,
                 WindowState = windowSize.WindowState != WindowState.Minimized ? windowSize.WindowState : windowSize.RestoreWindowState,
                 RestoreWindowState = windowSize.RestoreWindowState,
@@ -331,6 +337,7 @@ private static CommandLineArguments GetArgumentsFromFactoryDefaults()
                 Sound = defaultOptions.Sound,
                 LoopSound = defaultOptions.LoopSound,
                 OpenSavedTimers = false,
+                Prefer24HourTime = false,
                 WindowTitleMode = WindowTitleMode.ApplicationName,
                 WindowState = defaultOptions.WindowSize.WindowState,
                 RestoreWindowState = defaultOptions.WindowSize.RestoreWindowState,
@@ -587,6 +594,19 @@ private static CommandLineArguments GetCommandLineArguments(IEnumerable<string>
                         argumentsBasedOnFactoryDefaults.OpenSavedTimers = openSavedTimers;
                         break;
 
+                    case "--prefer-24h-time":
+                    case "-j":
+                        ThrowIfDuplicateSwitch(specifiedSwitches, "--prefer-24h-time");
+
+                        bool prefer24HourTime = GetBoolValue(
+                            arg,
+                            remainingArgs,
+                            argumentsBasedOnMostRecentOptions.Prefer24HourTime);
+
+                        argumentsBasedOnMostRecentOptions.Prefer24HourTime = prefer24HourTime;
+                        argumentsBasedOnFactoryDefaults.Prefer24HourTime = prefer24HourTime;
+                        break;
+
                     case "--window-title":
                     case "-i":
                         ThrowIfDuplicateSwitch(specifiedSwitches, "--window-title");

Hourglass/Parsing/NormalTimeToken.cs

@@ -148,13 +148,35 @@ public override string ToString(IFormatProvider provider)
                 StringBuilder stringBuilder = new StringBuilder();
 
                 // Hour
+                int adjustedHour;
+                if (Settings.Default.Prefer24HourTime)
+                {
+                    // This class stores its data in 12-hour format, so adust it back to 24-hour time.
+                    if (this.Hour == 12 && this.HourPeriod == HourPeriod.Am)
+                    {
+                        adjustedHour = 0;
+                    }
+                    else if (this.HourPeriod == HourPeriod.Pm)
+                    {
+                        adjustedHour = this.Hour + 12;
+                    }
+                    else
+                    {
+                        adjustedHour = this.Hour;
+                    }
+                }
+                else
+                {
+                    adjustedHour = this.Hour;
+                }
+
                 stringBuilder.AppendFormat(
                     Resources.ResourceManager.GetEffectiveProvider(provider),
                     Resources.ResourceManager.GetString("NormalTimeTokenHourPartFormatString", provider),
-                    this.Hour);
+                    adjustedHour);
 
                 // Minute
-                if (this.Minute != 0 || this.Second != 0)
+                if (this.Minute != 0 || this.Second != 0 || this.HourPeriod == HourPeriod.Undefined || Settings.Default.Prefer24HourTime)
                 {
                     stringBuilder.AppendFormat(
                         Resources.ResourceManager.GetEffectiveProvider(provider),
@@ -172,7 +194,11 @@ public override string ToString(IFormatProvider provider)
                 }
 
                 // Hour period
-                if (this.IsMidday)
+                if (Settings.Default.Prefer24HourTime)
+                {
+                    // No suffix when outputting 24-hour time.
+                }
+                else if (this.IsMidday)
                 {
                     stringBuilder.Append(Resources.ResourceManager.GetString("NormalTimeTokenMiddaySuffix", provider));
                 }
@@ -272,7 +298,7 @@ protected override TimeToken ParseInternal(Match match, IFormatProvider provider
                 {
                     timeToken.HourPeriod = HourPeriod.Pm;
                 }
-                else if (match.Groups["military"].Success)
+                else if (match.Groups["military"].Success || Settings.Default.Prefer24HourTime)
                 {
                     if (timeToken.Hour == 0)
                     {

Hourglass/Properties/Resources.Designer.cs

@@ -1257,4 +1257,8 @@ $</value>
     <value>Rest_ore</value>
     <comment>The text for the restore menu item, where the character following the optional underscore (_) is the access key</comment>
   </data>
+  <data name="ContextMenuPrefer24HourTimeMenuItem" xml:space="preserve">
+    <value>Prefer 24-_hour time when parsing</value>
+    <comment>The text for the prefer 24-hour time when parsing menu item, where the character following the optional underscore (_) is the access key</comment>
+  </data>
 </root>

Hourglass/Properties/Resources.resx

@@ -29,5 +29,8 @@
     <Setting Name="UpgradeRequired" Type="System.Boolean" Scope="User">
       <Value Profile="(Default)">True</Value>
     </Setting>
+    <Setting Name="Prefer24HourTime" Type="System.Boolean" Scope="User">
+      <Value Profile="(Default)">False</Value>
+    </Setting>
   </Settings>
 </SettingsFile>

Hourglass/Properties/Settings.Designer.cs

@@ -160,6 +160,20 @@ Options:
         Default value   last
         Alias           -v
 
+  --prefer-24h-time on|off|last
+        When the input used to start the timer contains a time of day that does
+        not explicitly specify "am" or "pm", prefer interpreting the input as a
+        24-hour time rather than the closest 12-hour time to the current time.
+
+        For example, if the current time is 3:00 pm (15:00) and the input is
+        "until 05:00" the timer will --
+        - if this setting is on, count down until 5:00 am (05:00); or
+        - if this setting is off, count down until 5:00 pm (17:00).
+
+        Required        no
+        Default value   last
+        Alias           -j
+
   --window-title none|app|left|elapsed|title|last
         Sets the timer window title.
 
@@ -244,6 +258,7 @@ Options:
             --sound                         normal beep
             --loop-sound                    off
             --open-saved-timers             off
+            --prefer-24h-time               off
             --window-state                  normal
             --window-bounds                 auto,auto,350,150
             --lock-interface                off

Hourglass/Properties/Settings.settings

@@ -161,6 +161,11 @@ public class ContextMenu : System.Windows.Controls.ContextMenu
         /// </summary>
         private MenuItem openSavedTimersOnStartupMenuItem;
 
+        /// <summary>
+        /// The "Prefer 24-hour time when parsing" <see cref="MenuItem"/>.
+        /// </summary>
+        private MenuItem prefer24HourTimeMenuItem;
+
         /// <summary>
         /// The "Reverse progress bar" <see cref="MenuItem"/>.
         /// </summary>
@@ -460,6 +465,9 @@ private void UpdateMenuFromOptions()
             // Open saved timers on startup
             this.openSavedTimersOnStartupMenuItem.IsChecked = Settings.Default.OpenSavedTimersOnStartup;
 
+            // Prefer 24-hour time when parsing
+            this.prefer24HourTimeMenuItem.IsChecked = Settings.Default.Prefer24HourTime;
+
             // Reverse progress bar
             this.reverseProgressBarMenuItem.IsChecked = this.timerWindow.Options.ReverseProgressBar;
 
@@ -534,6 +542,9 @@ private void UpdateOptionsFromMenu()
             // Open saved timers on startup
             Settings.Default.OpenSavedTimersOnStartup = this.openSavedTimersOnStartupMenuItem.IsChecked;
 
+            // Prefer 24-hour time when parsing
+            Settings.Default.Prefer24HourTime = this.prefer24HourTimeMenuItem.IsChecked;
+
             // Reverse progress bar
             this.timerWindow.Options.ReverseProgressBar = this.reverseProgressBarMenuItem.IsChecked;
 
@@ -686,6 +697,13 @@ private void BuildMenu()
             this.openSavedTimersOnStartupMenuItem.Click += this.CheckableMenuItemClick;
             this.advancedOptionsMenuItem.Items.Add(this.openSavedTimersOnStartupMenuItem);
 
+            // Prefer 24-hour time when parsing
+            this.prefer24HourTimeMenuItem = new MenuItem();
+            this.prefer24HourTimeMenuItem.Header = Properties.Resources.ContextMenuPrefer24HourTimeMenuItem;
+            this.prefer24HourTimeMenuItem.IsCheckable = true;
+            this.prefer24HourTimeMenuItem.Click += this.CheckableMenuItemClick;
+            this.advancedOptionsMenuItem.Items.Add(this.prefer24HourTimeMenuItem);
+
             // Reverse progress bar
             this.reverseProgressBarMenuItem = new MenuItem();
             this.reverseProgressBarMenuItem.Header = Properties.Resources.ContextMenuReverseProgressBarMenuItem;