Merge branch 'thumbbehavior'

Author: calebtt

XMapLib/DelayManager.h

@@ -19,12 +19,10 @@ namespace sds::Utilities
 		DelayManager& operator=(const DelayManager& other) = default;
 		DelayManager& operator=(DelayManager&& other) = default;
 		~DelayManager() = default;
-		/// <summary>
-		/// Operator<< overload for std::ostream specialization,
+		/// <summary>Operator<< overload for std::ostream specialization,
 		///	writes more detailed delay details for debugging.
 		///	Thread-safe, provided all writes to the ostream object
-		///	are wrapped with std::osyncstream!
-		/// </summary>
+		///	are wrapped with std::osyncstream!</summary>
 		friend std::ostream& operator<<(std::ostream& os, const DelayManager& obj) noexcept
 		{
 			std::osyncstream ss(os);
@@ -35,9 +33,7 @@ namespace sds::Utilities
 				<< "[/DelayManager]";
 			return os;
 		}
-		/// <summary>
-		/// Check for elapsed.
-		/// </summary>
+		/// <summary>Check for elapsed.</summary>
 		bool IsElapsed() noexcept
 		{
 			if (std::chrono::high_resolution_clock::now() > (m_start_time + std::chrono::microseconds(m_duration)))
@@ -47,6 +43,7 @@ namespace sds::Utilities
 			}
 			return false;
 		}
+		/// <summary>Reset delay for elapsing.</summary>
 		void Reset(size_t microsec_delay) noexcept
 		{
 			m_start_time = std::chrono::high_resolution_clock::now();

XMapLib/MouseMapper.h

@@ -49,7 +49,7 @@ namespace sds
 		///	This will start processing if the stick is something other than "NEITHER"
 		///	**Arbitrary values outside of the enum constants will not be processed successfully.**</summary>
 		/// <param name="info"> a StickMap enum</param>
-		void SetStick(const StickMap info)
+		void SetStick(const StickMap info) noexcept
 		{
 			if (m_stickmap_info != info)
 			{
@@ -74,7 +74,7 @@ namespace sds
 		/// <summary>Setter for sensitivity value.</summary>
 		/// <returns> returns a std::string containing an error message
 		/// if there is an error, empty string otherwise. </returns>
-		std::string SetSensitivity(const int new_sens)
+		std::string SetSensitivity(const int new_sens) noexcept
 		{
 			if (!MouseSettings::IsValidSensitivityValue(new_sens))
 			{
@@ -115,7 +115,7 @@ namespace sds
 		}
 	protected:
 		/// <summary>Worker thread, protected visibility, gets updated data from ProcessState() function to use.
-		/// Accesses the std::atomic m_thread_x and m_thread_y members.</summary>
+		/// Accesses the std::atomic m_thread_x and m_thread_y members. chrono lib instances may throw exceptions.</summary>
 		void workThread(sds::LambdaArgs::LambdaArg1& stopCondition, sds::LambdaArgs::LambdaArg2&, int&)
 		{
 			ThumbstickToDelay xThread(this->GetSensitivity(), m_local_player, m_stickmap_info, true);

XMapLib/MouseMoveThread.h

@@ -25,7 +25,7 @@ namespace sds
 				([this](sds::LambdaArgs::LambdaArg1& stopCondition, sds::LambdaArgs::LambdaArg2& mut, auto& protectedData) { workThread(stopCondition, mut, protectedData); });
 		}
 	public:
-		MouseMoveThread()
+		MouseMoveThread() noexcept
 		{
 			InitWorkThread();
 			m_workThread->StartThread();
@@ -37,7 +37,7 @@ namespace sds
 		MouseMoveThread& operator=(MouseMoveThread&& other) = delete;
 		/// <summary>Called to update mouse mover thread with new microsecond delay values,
 		///	and whether the axis to move should move positive or negative.</summary>
-		void UpdateState(const size_t x, const size_t y, const bool isXPositive, const bool isYPositive, const bool isXMoving, const bool isYMoving)
+		void UpdateState(const size_t x, const size_t y, const bool isXPositive, const bool isYPositive, const bool isXMoving, const bool isYMoving) noexcept
 		{
 			m_x_axis_delay = x;
 			m_y_axis_delay = y;

XMapLibSharp/Form1.cs

@@ -18,8 +18,6 @@ right click -> outlining -> collapse to definitions */
     public partial class Form1 : Form
     {
         private const int DelayRedrawMs = 1000; // a whole second
-        private const string ErrNotRunning = "Started, but not running.";
-        private const string ErrPresetButtonStatus = "Error toggling preset button selected status.";
         private const string ErrUpdatingMaps = "Error updating maps!";
         private const string MsgStartMouse = "Start Mouse Processing";
         private const string MsgStopMouse = "Stop Mouse Processing";
@@ -82,7 +80,7 @@ private void InitDataGridView()
             dataGridView1.Columns.Add(col5);
             this.dataGridView1.DataSource = _currentKeymaps;
         }
-
+        /// <summary>Init preset buttons and add to the GUI</summary>
         private void InitPresetButtons()
         {
             _presets = KeymapPresetOperations.BuildPresetButtons();
@@ -102,30 +100,36 @@ private void InitPresetButtons()
                 KeymapPresetOperations.ChangeButtonTextForSelected(btn, true);
             }
         }
+        /// <summary>Starts running the background thread that updates the GUI elements.</summary>
         private void InitBackgroundWorker()
         {
             bgWorkThread.RunWorkerAsync(SynchronizationContext.Current);
         }
+        /// <summary>Helper to update the datagridview to a new List of keymaps.</summary>
         private void UpdateKeymapDatagrid(List<XMapLibKeymap> newMaps)
         {
             dataGridView1.AutoGenerateColumns = false;
             _currentKeymaps = newMaps;
             dataGridView1.DataSource = newMaps;
         }
+        /// <summary>Updates mouse sensitivity trackbar value based on mapper's internal reported value.</summary>
         private void UpdateMouseSensitivityTrackbar()
         {
             trackBar1.Value = _mapper.GetMouseSensitivity();
         }
+        /// <summary>Helper to update the status of the controller being connected.</summary>
         private void UpdateControllerConnectedButton()
         {
             bool isConnected = _mapper.IsControllerConnected();
             button2.Text = isConnected ? MsgController : MsgNocontroller;
             button2.BackColor = isConnected ? _clrNormal : _clrInfo;
         }
+        /// <summary>Helper to update the sensitivity value displayed on the button.</summary>
         private void UpdateMouseSensitivityButton()
         {
             btnSensitivityIndicator.Text = MsgSensbegin + " " + _mapper.GetMouseSensitivity().ToString() + MsgSensmax;
         }
+        /// <summary>Helper to update the status of the mouse movement processing based on the mapper's internal status and update the button text.</summary>
         private void UpdateIsMouseRunning()
         {
             bool isRunning = _mapper.IsMouseRunning();