From 6f20449e71d5589c2d1dc48b53e53214a4910bc3 Mon Sep 17 00:00:00 2001
From: Andrew Cooper <andrew.cooper@nearmap.com>
Date: Tue, 15 Feb 2022 22:11:35 +1100
Subject: [PATCH] Add IReadWrite interface

---
 .../dotnet/Games.Common/IO/IReadWrite.cs      | 69 +++++++++++++++++++
 1 file changed, 69 insertions(+)
 create mode 100644 00_Common/dotnet/Games.Common/IO/IReadWrite.cs

diff --git a/00_Common/dotnet/Games.Common/IO/IReadWrite.cs b/00_Common/dotnet/Games.Common/IO/IReadWrite.cs
new file mode 100644
index 00000000..883e069d
--- /dev/null
+++ b/00_Common/dotnet/Games.Common/IO/IReadWrite.cs
@@ -0,0 +1,69 @@
+namespace Games.Common.IO
+{
+    /// <summary>
+    /// Provides for input and output of strings and numbers.
+    /// </summary>
+    public interface IReadWrite
+    {
+        /// <summary>
+        /// Reads a <see cref="float" /> value from input.
+        /// </summary>
+        /// <param name="prompt">The text to display to prompt for the value.</param>
+        /// <returns>A <see cref="float" />, being the value entered.</returns>
+        float ReadNumber(string prompt);
+
+        /// <summary>
+        /// Reads 2 <see cref="float" /> values from input.
+        /// </summary>
+        /// <param name="prompt">The text to display to prompt for the values.</param>
+        /// <returns>A <see cref="ValueTuple{float, float}" />, being the values entered.</returns>
+        (float, float) Read2Numbers(string prompt);
+
+        /// <summary>
+        /// Reads 3 <see cref="float" /> values from input.
+        /// </summary>
+        /// <param name="prompt">The text to display to prompt for the values.</param>
+        /// <returns>A <see cref="ValueTuple{float, float, float}" />, being the values entered.</returns>
+        (float, float, float) Read3Numbers(string prompt);
+
+        /// <summary>
+        /// Reads 4 <see cref="float" /> values from input.
+        /// </summary>
+        /// <param name="prompt">The text to display to prompt for the values.</param>
+        /// <returns>A <see cref="ValueTuple{float, float, float, float}" />, being the values entered.</returns>
+        (float, float, float, float) Read4Numbers(string prompt);
+
+        /// <summary>
+        /// Read numbers from input to fill an array.
+        /// </summary>
+        /// <param name="prompt">The text to display to prompt for the values.</param>
+        /// <param name="numbers">A <see cref="float[]" /> to be filled with values from input.</param>
+        void ReadNumbers(string prompt, float[] numbers);
+
+        /// <summary>
+        /// Reads a <see cref="string" /> value from input.
+        /// </summary>
+        /// <param name="prompt">The text to display to prompt for the value.</param>
+        /// <returns>A <see cref="string" />, being the value entered.</returns>
+        string ReadString(string prompt);
+
+        /// <summary>
+        /// Reads 2 <see cref="string" /> values from input.
+        /// </summary>
+        /// <param name="prompt">The text to display to prompt for the values.</param>
+        /// <returns>A <see cref="ValueTuple{string, string}" />, being the values entered.</returns>
+        (string, string) Read2Strings(string prompt);
+
+        /// <summary>
+        /// Writes a <see cref="string" /> to output.
+        /// </summary>
+        /// <param name="message">The <see cref="string" /> to be written.</param>
+        void Write(string message);
+
+        /// <summary>
+        /// Writes a <see cref="string" /> to output, followed by a new-line.
+        /// </summary>
+        /// <param name="message">The <see cref="string" /> to be written.</param>
+        void WriteLine(string message);
+    }
+}
\ No newline at end of file