Initial Commit

Update .drone.yml, .gitignore, and 12 more files...
2022-10-24 20:08:14 +02:00
commit b595208830
14 changed files with 467 additions and 0 deletions
@@ -0,0 +1,20 @@
+namespace NibblePoker.Application.ListComPort; 
+
+public static class ErrorCodes {
+	public const int NoError = 0;
+	
+	/* Fatal errors (1-9) */
+	// Not needed in C#
+	
+	/* Internal argument parser errors (10-19) */
+	public const int ArgumentParsingFailure = 10;
+	// ArgumentDefinitionFailure = 11 => Cannot happen due to the way options are declared.  (Caught in development)
+	// ArgumentInitFailure = 12 => Cannot happen with "NibblePoker.Library.Arguments".
+	
+	/* External argument errors (20-29) */
+	public const int NoPaddingValue = 20;
+	
+	/* Application & System errors (30-39) */
+	// NoFriendlyNames = 30 => Causes problems with broad-range exit code checks.
+	public const int NoComPorts = 31;
+}
@@ -0,0 +1,33 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+    <PropertyGroup>
+        <OutputType>Exe</OutputType>
+        <TargetFramework>net6.0-windows</TargetFramework>
+        <ImplicitUsings>enable</ImplicitUsings>
+        <Nullable>enable</Nullable>
+        <RootNamespace>NibblePoker.Application.ListComPort</RootNamespace>
+        <AssemblyName>NibblePoker.Application.ListComPort</AssemblyName>
+        <AssemblyVersion>3.0.0</AssemblyVersion>
+        <FileVersion>3.0.0</FileVersion>
+        <Version>3.0.0</Version>
+        <NeutralLanguage>en-001</NeutralLanguage>
+        <ApplicationIcon>..\lscom-v2-text-01.ico</ApplicationIcon>
+        <IsPackable>false</IsPackable>
+        <Authors>Herwin Bozet (@NibblePoker)</Authors>
+    </PropertyGroup>
+
+    <ItemGroup>
+      <ProjectReference Include="..\NibblePoker.Library.ComPortHelpers\NibblePoker.Library.ComPortHelpers.csproj" />
+    </ItemGroup>
+
+    <ItemGroup>
+      <PackageReference Include="NibblePoker.Library.Arguments" Version="1.1.0" />
+    </ItemGroup>
+
+    <ItemGroup>
+      <None Include="..\lscom-v2-text-01.ico">
+        <Link>lscom-v2-text-01.ico</Link>
+      </None>
+    </ItemGroup>
+
+</Project>
@@ -0,0 +1,183 @@
+using NibblePoker.Library.Arguments;
+using NibblePoker.Library.ComPortWatcher;
+
+namespace NibblePoker.Application.ListComPort;
+
+internal static class Program {
+	private const string Version = "3.0.0-indev";
+	
+	private static readonly Verb RootVerb = new Verb("");
+	
+	private static readonly Option OptionShowAll      = new('a', "show-all", "Display the complete port's name (Equal to '-dfn')");
+	private static readonly Option OptionShowDevice   = new('d', "show-device", "Displays the port's device name");
+	private static readonly Option OptionDivider      = new('D', "divider", "Uses the given string or char as a separator (Can be an empty string !)", OptionFlags.HasValue);
+	private static readonly Option OptionShowFriendly = new('f', "show-friendly", "Displays the port's friendly name");
+	private static readonly Option OptionHelp         = new('h', "help", "Display the help text", OptionFlags.StopsParsing);
+	private static readonly Option OptionHelpShort    = new('H', "short-help", "Display the short help text", OptionFlags.StopsParsing);
+	private static readonly Option OptionShowNameRaw  = new('n', "show-name-raw", "Displays the port's raw name (See remarks section)");
+	private static readonly Option OptionNoPretty     = new('P', "no-pretty", "Disables the pretty printing format (Equal to -D \" \"");
+	private static readonly Option OptionSort         = new('s', "sort", "Sorts the port based on their raw names in an ascending order");
+	private static readonly Option OptionSortReverse  = new('S', "sort-reverse", "Sorts the port based on their raw names in a descending order");
+	private static readonly Option OptionTabPadding   = new('t', "tab-padding", "Use tabs for padding between the types of names (Overrides '-D')");
+	private static readonly Option OptionVersion      = new('v', "version", "Shows the utility's version number and other info");
+	private static readonly Option OptionVersionOnly  = new('V', "version-only", "Shows the utility's version number only (Overrides '-v')");
+	
+	private static bool _shouldPrintRawNames = true;
+	private static bool _shouldPrintDeviceNames = false;
+	private static bool _shouldPrintFriendlyNames = false;
+	
+	private static string _paddingText = "";
+
+	private static SortingOrder _sortingOrder = SortingOrder.None;
+	
+	private static int _exitCode = ErrorCodes.NoError;
+	
+	private static int Main(string[] args) {
+		try {
+			ArgumentsParser.ParseArguments(RootVerb.RegisterOption(OptionShowAll).RegisterOption(OptionShowDevice)
+				.RegisterOption(OptionDivider).RegisterOption(OptionShowFriendly).RegisterOption(OptionHelp)
+				.RegisterOption(OptionShowNameRaw).RegisterOption(OptionNoPretty).RegisterOption(OptionSort)
+				.RegisterOption(OptionSortReverse).RegisterOption(OptionTabPadding).RegisterOption(OptionVersion)
+				.RegisterOption(OptionVersionOnly), args);
+		} catch(ArgumentException) {
+			Console.Error.Write("Failed to parse the launch arguments, default options will be used.");
+			_exitCode = ErrorCodes.ArgumentParsingFailure;
+			RootVerb.Clear();
+		}
+		
+		if(OptionHelp.WasUsed() || OptionHelpShort.WasUsed()) {
+			Console.WriteLine(HelpText.GetFullHelpText(RootVerb, "lscom.exe", (uint)Console.BufferWidth - 1, 1, 2, false));
+			
+			if(OptionHelp.WasUsed()) {
+				Console.WriteLine("\nRemarks:");
+				Console.WriteLine(" * If '-d' or '-f' is used, the raw name will not be shown unless '-n' is used.");
+				Console.WriteLine(" * If '-D', '-t' or '-p' are used, the special separator between the raw and friendly name and the square brackets are not shown.");
+				Console.WriteLine(" * By default, the ports are sorted in the order they are provided by the registry, which is often chronological.");
+				Console.WriteLine(" * The 'raw name' refers to a port name. (e.g.: COM1, COM2, ...)");
+				Console.WriteLine(" * The 'device name' refers to a port device path. (e.g.: \\Device\\Serial1, ...)");
+				Console.WriteLine(" * The 'friendly name' refers to a port name as seen in the device manager. (e.g.: Communications Port, USB-SERIAL CH340, ...)");
+				Console.WriteLine(" * Any result returned with an error code between 1-9 and 30-39 should be considered as invalid.");
+				Console.WriteLine(" * Any result returned with another error code is valid but probably not formatted properly.");
+			}
+			
+			return ErrorCodes.NoError;
+		}
+		
+		if(OptionVersionOnly.WasUsed()) {
+			Console.WriteLine(Version);
+			return ErrorCodes.NoError;
+		}
+		
+		if(OptionVersion.WasUsed()) {
+			Console.WriteLine("NibblePoker.Application.ListComPort (lscom) v" + Version);
+			Console.WriteLine("");
+			Console.WriteLine("Dependencies:");
+			Console.WriteLine("├─> NibblePoker.Library.Arguments v1.1.0");
+			Console.WriteLine("├─> NibblePoker.Library.ComPortHelpers v" + Version);
+			Console.WriteLine("└─> NibblePoker.Library.RegistryHelpers v0.0.1");
+			Console.WriteLine("");
+			Console.WriteLine("GitHub repositories:");
+			Console.WriteLine("├─> https://github.com/aziascreations/DotNet-Arguments");
+			Console.WriteLine("└─> https://github.com/aziascreations/DotNet-RegistryHelpers");
+			// TODO: Add final repo link here !
+			Console.WriteLine("");
+			Console.WriteLine("This software and all its libraries are licensed under the MIT license.");
+			return ErrorCodes.NoError;
+		}
+		
+		if(OptionShowDevice.WasUsed()) {
+			_shouldPrintRawNames = false;
+			_shouldPrintDeviceNames = true;
+		}
+		
+		if(OptionShowFriendly.WasUsed()) {
+			_shouldPrintRawNames = false;
+			_shouldPrintFriendlyNames = true;
+		}
+		
+		if(OptionShowNameRaw.WasUsed()) {
+			_shouldPrintRawNames = true;
+		}
+		
+		if(OptionShowAll.WasUsed()) {
+			_shouldPrintRawNames = true;
+			_shouldPrintFriendlyNames = true;
+			_shouldPrintDeviceNames = true;
+		}
+		
+		if(OptionSort.WasUsed()) {
+			_sortingOrder = SortingOrder.Ascending;
+		}
+		
+		if(OptionSortReverse.WasUsed()) {
+			_sortingOrder = SortingOrder.Descending;
+		}
+		
+		if(OptionNoPretty.WasUsed()) {
+			_paddingText = " ";
+		}
+		
+		if(OptionDivider.WasUsed()) {
+			_paddingText = OptionDivider.Arguments[0];
+		}
+		
+		if(OptionTabPadding.WasUsed()) {
+			_paddingText = "\t";
+		}
+		
+		// Application's code
+		
+		string rawToFriendlySeparator = " - ";
+		bool addDeviceBrackets = true;
+		
+		if(string.IsNullOrEmpty(_paddingText)) {
+			_paddingText = " ";
+		} else {
+			rawToFriendlySeparator = _paddingText;
+			addDeviceBrackets = false;
+		}
+		
+		if(!_shouldPrintRawNames && !_shouldPrintFriendlyNames && _shouldPrintDeviceNames) {
+			addDeviceBrackets = false;
+		}
+		
+		List<ComPortInfo> comPortsInfo = ComPortHelper.GetComList(_shouldPrintFriendlyNames);
+		
+		if(comPortsInfo.Count > 0) {
+			comPortsInfo = _sortingOrder switch {
+				SortingOrder.Ascending => comPortsInfo.OrderBy(o => o.RawName).ToList(),
+				SortingOrder.Descending => comPortsInfo.OrderByDescending(o => o.RawName).ToList(),
+				_ => comPortsInfo
+			};
+			
+			foreach(ComPortInfo comPortInfo in comPortsInfo) {
+				if(_shouldPrintRawNames) {
+					Console.Write(comPortInfo.RawName);
+
+					if(_shouldPrintFriendlyNames) {
+						Console.Write(rawToFriendlySeparator);
+					}
+				}
+				
+				if(_shouldPrintFriendlyNames) {
+					Console.Write(comPortInfo.FriendlyName);
+				}
+				
+				if((_shouldPrintRawNames || _shouldPrintFriendlyNames) && _shouldPrintDeviceNames) {
+					Console.Write(_paddingText);
+				}
+				
+				if(_shouldPrintDeviceNames) {
+					Console.Write((addDeviceBrackets ? "[" : "") + comPortInfo.DeviceName + (addDeviceBrackets ? "]" : ""));
+				}
+				
+				Console.WriteLine();
+			}
+		} else {
+			Console.Error.Write("No COM port could be found.");
+			_exitCode = ErrorCodes.NoComPorts;
+		}
+		
+		return _exitCode;
+	}
+}