aziascreations/DotNet-ListComPort
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Added .NET Framework 4 target for application

Browse Source 
Update ErrorCodes.cs, NibblePoker.Application.ListComPort.csproj, and 2 more files...
This commit is contained in:
Herwin Bozet (NibblePoker)
2024-05-24 16:49:02 +02:00
parent 6e4462c8fa
commit 60a7cb0f6b
4 changed files with 256 additions and 214 deletions
Download Patch File Download Diff File Expand all files Collapse all files
NibblePoker.Application.ListComPort/ErrorCodes.cs
+15 -15
View File
@@ -1,20 +1,20 @@
namespace NibblePoker.Application.ListComPort; namespace NibblePoker.Application.ListComPort {
public static class ErrorCodes {
public const int NoError = 0;
public static class ErrorCodes { /* Fatal errors (1-9) */
public const int NoError = 0; // Not needed in C#
/* Fatal errors (1-9) */ /* Internal argument parser errors (10-19) */
// Not needed in C# 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".
/* Internal argument parser errors (10-19) */ /* External argument errors (20-29) */
public const int ArgumentParsingFailure = 10; public const int NoPaddingValue = 20;
// 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) */ /* Application & System errors (30-39) */
public const int NoPaddingValue = 20; // NoFriendlyNames = 30 => Causes problems with broad-range exit code checks.
public const int NoComPorts = 31;
/* Application & System errors (30-39) */ }
// NoFriendlyNames = 30 => Causes problems with broad-range exit code checks.
public const int NoComPorts = 31;
} }
NibblePoker.Application.ListComPort/NibblePoker.Application.ListComPort.csproj
+4 -4
View File
@@ -2,9 +2,11 @@
<PropertyGroup> <PropertyGroup>
<OutputType>Exe</OutputType> <OutputType>Exe</OutputType>
<TargetFrameworks>net6.0-windows;net7.0-windows;net8.0-windows</TargetFrameworks> <TargetFrameworks>net40;net6.0-windows;net7.0-windows;net8.0-windows</TargetFrameworks>
<ImplicitUsings>disable</ImplicitUsings> <ImplicitUsings>disable</ImplicitUsings>
<Nullable>enable</Nullable> <Nullable>disable</Nullable>
<RootNamespace>NibblePoker.Application.ListComPort</RootNamespace> <RootNamespace>NibblePoker.Application.ListComPort</RootNamespace>
<AssemblyName>NibblePoker.Application.ListComPort</AssemblyName> <AssemblyName>NibblePoker.Application.ListComPort</AssemblyName>
<AssemblyVersion>4.0.0</AssemblyVersion> <AssemblyVersion>4.0.0</AssemblyVersion>
@@ -14,8 +16,6 @@
<IsPackable>false</IsPackable> <IsPackable>false</IsPackable>
<Authors>Herwin Bozet (@NibblePoker)</Authors> <Authors>Herwin Bozet (@NibblePoker)</Authors>
<ApplicationIcon>..\NibblePoker.Packaging.ListComPort\Icons\lscom-v2-text-01.ico</ApplicationIcon> <ApplicationIcon>..\NibblePoker.Packaging.ListComPort\Icons\lscom-v2-text-01.ico</ApplicationIcon>
<Configurations>Release</Configurations>
<Platforms>AnyCPU</Platforms>
</PropertyGroup> </PropertyGroup>
<ItemGroup> <ItemGroup>
NibblePoker.Application.ListComPort/Program.cs
+202 -158
View File
@@ -4,204 +4,248 @@ using System.Linq;
using NibblePoker.Library.Arguments; using NibblePoker.Library.Arguments;
using NibblePoker.Library.ComPortWatcher; using NibblePoker.Library.ComPortWatcher;
namespace NibblePoker.Application.ListComPort; namespace NibblePoker.Application.ListComPort {
internal static class Program {
private const string Version = "4.0.0";
internal static class Program { // ReSharper disable once InconsistentNaming
private const string Version = "4.0.0"; private static readonly Verb RootVerb = new Verb(null);
private static readonly Verb RootVerb = new Verb(""); private static readonly Option OptionShowAll = new Option('a', "show-all",
"Display the complete port's name (Equal to '-dfn')");
private static readonly Option OptionShowDevice = new Option('d', "show-device",
"Displays the port's device name");
private static readonly Option OptionShowFriendly = new Option('f', "show-friendly",
"Displays the port's friendly name");
private static readonly Option OptionShowNameRaw = new Option('n', "show-name-raw",
"Displays the port's raw name (See remarks section)");
private static readonly Option OptionShowAll = new('a', "show-all", "Display the complete port's name (Equal to '-dfn')"); private static readonly Option OptionDivider = new Option('D', "divider",
private static readonly Option OptionShowDevice = new('d', "show-device", "Displays the port's device name"); "Uses the given string or char as a separator (Can be an empty string !)", OptionFlags.HasValue);
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 OptionTabPadding = new Option('t', "tab-padding",
private static readonly Option OptionShowFriendly = new('f', "show-friendly", "Displays the port's friendly name"); "Use tabs for padding between the types of names (Overrides '-D')");
private static readonly Option OptionHelp = new('h', "help", "Display the help text", OptionFlags.StopsParsing); private static readonly Option OptionNoPretty = new Option('P', "no-pretty",
private static readonly Option OptionHelpShort = new('H', "short-help", "Display the short help text", OptionFlags.StopsParsing); "Disables the pretty printing format (Equal to -D \" \"");
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 readonly Option OptionSort = new Option('s', "sort",
private static bool _shouldPrintDeviceNames = false; "Sorts the port based on their raw names in an ascending order");
private static bool _shouldPrintFriendlyNames = false; private static readonly Option OptionSortReverse = new Option('S', "sort-reverse",
"Sorts the port based on their raw names in a descending order");
private static string _paddingText = ""; private static readonly Option OptionHelp = new Option('h', "help",
"Display the help text", OptionFlags.StopsParsing);
private static readonly Option OptionHelpShort = new Option('H', "short-help",
"Display the short help text", OptionFlags.StopsParsing);
private static readonly Option OptionVersion = new Option('v', "version",
"Shows the utility's version number and other info");
private static readonly Option OptionVersionOnly = new Option('V', "version-only",
"Shows the utility's version number only (Overrides '-v')");
private static SortingOrder _sortingOrder = SortingOrder.None; // ReSharper disable RedundantDefaultMemberInitializer
private static bool _shouldPrintRawNames = true;
private static bool _shouldPrintDeviceNames = false;
private static bool _shouldPrintFriendlyNames = false;
// ReSharper enable RedundantDefaultMemberInitializer
private static int _exitCode = ErrorCodes.NoError; private static string _paddingText = "";
/// <summary> private static SortingOrder _sortingOrder = SortingOrder.None;
/// Checks if the program is the only owner of its console.
/// This check is used to detect if the program was run from the exe/lnk or via a console.
/// </summary>
/// <returns><c>True</c> if the process is the console's sole owner, <c>False</c> otherwise</returns>
private static bool IsProgramRunDirectly() {
return GetConsoleProcessList(new int[2], 2) <= 1;
}
private static int Main(string[] args) { private static int _exitCode = ErrorCodes.NoError;
try {
ArgumentsParser.ParseArguments(RootVerb.RegisterOption(OptionShowAll).RegisterOption(OptionShowDevice) /// <summary>
.RegisterOption(OptionDivider).RegisterOption(OptionShowFriendly).RegisterOption(OptionHelp) /// Checks if the program is the only owner of its console.
.RegisterOption(OptionShowNameRaw).RegisterOption(OptionNoPretty).RegisterOption(OptionSort) /// This check is used to detect if the program was run from the exe/lnk or via a console.
.RegisterOption(OptionSortReverse).RegisterOption(OptionTabPadding).RegisterOption(OptionVersion) /// </summary>
.RegisterOption(OptionVersionOnly), args); /// <returns><c>True</c> if the process is the console's sole owner, <c>False</c> otherwise</returns>
} catch(Exceptions.ArgumentsException) { private static bool IsProgramRunDirectly() {
Console.Error.WriteLine("Failed to parse the launch arguments, default options will be used."); return GetConsoleProcessList(new int[2], 2) <= 1;
_exitCode = ErrorCodes.ArgumentParsingFailure;
RootVerb.Clear();
} }
if(OptionHelp.WasUsed() || OptionHelpShort.WasUsed()) { private static int Main(string[] args) {
Console.WriteLine(HelpText.GetFullHelpText(RootVerb, "lscom.exe", (uint)Console.BufferWidth - 1, 1, 2, false)); // Preparing & parsing launch arguments
try {
if(OptionHelp.WasUsed()) { ArgumentsParser.ParseArguments(RootVerb.RegisterOption(OptionShowAll).RegisterOption(OptionShowDevice)
Console.WriteLine("\nRemarks:"); .RegisterOption(OptionDivider).RegisterOption(OptionShowFriendly).RegisterOption(OptionHelp)
Console.WriteLine(" * If '-d' or '-f' is used, the raw name will not be shown unless '-n' is used."); .RegisterOption(OptionShowNameRaw).RegisterOption(OptionNoPretty).RegisterOption(OptionSort)
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."); .RegisterOption(OptionSortReverse).RegisterOption(OptionTabPadding).RegisterOption(OptionVersion)
Console.WriteLine(" * If the program is raw without going through a console, the options '-n' and '-f' will be used."); .RegisterOption(OptionVersionOnly), args);
Console.WriteLine(" * By default, the ports are sorted in the order they are provided by the registry, which is often chronological."); } catch(Exceptions.ArgumentsException) {
Console.WriteLine(" * The 'raw name' refers to a port name. (e.g.: COM1, COM2, ...)"); Console.Error.WriteLine("Failed to parse the launch arguments, default options will be used.");
Console.WriteLine(" * The 'device name' refers to a port device path. (e.g.: \\Device\\Serial1, ...)"); _exitCode = ErrorCodes.ArgumentParsingFailure;
Console.WriteLine(" * The 'friendly name' refers to a port name as seen in the device manager. (e.g.: Communications Port, USB-SERIAL CH340, ...)"); RootVerb.Clear();
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; // Processing exiting options
} if(OptionHelp.WasUsed() || OptionHelpShort.WasUsed()) {
Console.WriteLine(HelpText.GetFullHelpText(
RootVerb, "lscom.exe",
(uint)Console.BufferWidth - 1, 1, 2, false));
if(OptionVersionOnly.WasUsed()) { if(OptionHelp.WasUsed()) {
Console.WriteLine(Version); Console.WriteLine("\nRemarks:");
return ErrorCodes.NoError; 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(
" * If the program is raw without going through a console, the options '-n' and '-f' will be used.");
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.");
}
if(OptionVersion.WasUsed()) { return ErrorCodes.NoError;
Console.WriteLine("NibblePoker.Application.ListComPort (lscom) v" + Version); }
Console.WriteLine("");
Console.WriteLine("Dependencies:");
Console.WriteLine("├─> NibblePoker.Library.Arguments v2.0.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-ListComPort");
Console.WriteLine("└─> https://github.com/aziascreations/DotNet-RegistryHelpers");
Console.WriteLine("");
Console.WriteLine("This software and all its libraries are released in the public domain under the CC0-1.0 license.");
return ErrorCodes.NoError;
}
if(OptionShowDevice.WasUsed()) { if(OptionVersionOnly.WasUsed()) {
_shouldPrintRawNames = false; Console.WriteLine(Version);
_shouldPrintDeviceNames = true; return ErrorCodes.NoError;
} }
if(OptionShowFriendly.WasUsed() || IsProgramRunDirectly()) { if(OptionVersion.WasUsed()) {
_shouldPrintRawNames = false; Console.WriteLine("NibblePoker.Application.ListComPort (lscom) v" + Version);
_shouldPrintFriendlyNames = true; Console.WriteLine("");
} Console.WriteLine("Dependencies:");
Console.WriteLine("├─> NibblePoker.Library.Arguments v2.0.0");
Console.WriteLine("├─> NibblePoker.Library.ComPortHelpers v" + Version);
Console.WriteLine("└─> NibblePoker.Library.RegistryHelpers v1.0.0");
Console.WriteLine("");
Console.WriteLine("GitHub repositories:");
Console.WriteLine("├─> https://github.com/aziascreations/DotNet-Arguments");
Console.WriteLine("├─> https://github.com/aziascreations/DotNet-ListComPort");
Console.WriteLine("└─> https://github.com/aziascreations/DotNet-RegistryHelpers");
Console.WriteLine("");
Console.WriteLine(
"This software and all its libraries are released in the public domain under the CC0-1.0 license.");
return ErrorCodes.NoError;
}
if(OptionShowNameRaw.WasUsed() || IsProgramRunDirectly()) { // Processing parameter options
_shouldPrintRawNames = true; if(OptionShowDevice.WasUsed()) {
} _shouldPrintRawNames = false;
_shouldPrintDeviceNames = true;
}
if(OptionShowAll.WasUsed()) { if(OptionShowFriendly.WasUsed() || IsProgramRunDirectly()) {
_shouldPrintRawNames = true; _shouldPrintRawNames = false;
_shouldPrintFriendlyNames = true; _shouldPrintFriendlyNames = true;
_shouldPrintDeviceNames = true; }
}
if(OptionSort.WasUsed()) { if(OptionShowNameRaw.WasUsed() || IsProgramRunDirectly()) {
_sortingOrder = SortingOrder.Ascending; _shouldPrintRawNames = true;
} }
if(OptionSortReverse.WasUsed()) { if(OptionShowAll.WasUsed()) {
_sortingOrder = SortingOrder.Descending; _shouldPrintRawNames = true;
} _shouldPrintFriendlyNames = true;
_shouldPrintDeviceNames = true;
}
if(OptionNoPretty.WasUsed()) { if(OptionSort.WasUsed()) {
_paddingText = " "; _sortingOrder = SortingOrder.Ascending;
} }
if(OptionDivider.WasUsed()) { if(OptionSortReverse.WasUsed()) {
_paddingText = OptionDivider.Arguments[0]; _sortingOrder = SortingOrder.Descending;
} }
if(OptionTabPadding.WasUsed()) { if(OptionNoPretty.WasUsed()) {
_paddingText = "\t"; _paddingText = " ";
} }
// Application's code if(OptionDivider.WasUsed()) {
_paddingText = OptionDivider.Arguments[0];
}
string rawToFriendlySeparator = " - "; if(OptionTabPadding.WasUsed()) {
bool addDeviceBrackets = true; _paddingText = "\t";
}
if(string.IsNullOrEmpty(_paddingText)) { // Application's code
_paddingText = " "; string rawToFriendlySeparator = " - ";
} else { bool addDeviceBrackets = true;
rawToFriendlySeparator = _paddingText;
addDeviceBrackets = false;
}
if(!_shouldPrintRawNames && !_shouldPrintFriendlyNames && _shouldPrintDeviceNames) { if(string.IsNullOrEmpty(_paddingText)) {
addDeviceBrackets = false; _paddingText = " ";
} } else {
rawToFriendlySeparator = _paddingText;
addDeviceBrackets = false;
}
List<ComPortInfo> comPortsInfo = ComPortHelper.GetComList(_shouldPrintFriendlyNames); if(!_shouldPrintRawNames && !_shouldPrintFriendlyNames && _shouldPrintDeviceNames) {
addDeviceBrackets = false;
}
if(comPortsInfo.Count > 0) { List<ComPortInfo> comPortsInfo = ComPortHelper.GetComList(_shouldPrintFriendlyNames);
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(comPortsInfo.Count > 0) {
if(_shouldPrintRawNames) { //comPortsInfo = _sortingOrder switch {
Console.Write(comPortInfo.RawName); // SortingOrder.Ascending => comPortsInfo.OrderBy(o => o.RawName).ToList(),
// SortingOrder.Descending => comPortsInfo.OrderByDescending(o => o.RawName).ToList(),
// _ => comPortsInfo
//};
switch(_sortingOrder) {
case SortingOrder.Ascending:
comPortsInfo = comPortsInfo.OrderBy(o => o.RawName).ToList();
break;
case SortingOrder.Descending:
comPortsInfo = comPortsInfo.OrderByDescending(o => o.RawName).ToList();
break;
case SortingOrder.None:
default:
break;
}
foreach(ComPortInfo comPortInfo in comPortsInfo) {
if(_shouldPrintRawNames) {
Console.Write(comPortInfo.RawName);
if(_shouldPrintFriendlyNames) {
Console.Write(rawToFriendlySeparator);
}
}
if(_shouldPrintFriendlyNames) { if(_shouldPrintFriendlyNames) {
Console.Write(rawToFriendlySeparator); Console.Write(comPortInfo.FriendlyName);
} }
}
if(_shouldPrintFriendlyNames) { if((_shouldPrintRawNames || _shouldPrintFriendlyNames) && _shouldPrintDeviceNames) {
Console.Write(comPortInfo.FriendlyName); Console.Write(_paddingText);
} }
if((_shouldPrintRawNames || _shouldPrintFriendlyNames) && _shouldPrintDeviceNames) { if(_shouldPrintDeviceNames) {
Console.Write(_paddingText); Console.Write((addDeviceBrackets ? "[" : "") + comPortInfo.DeviceName +
} (addDeviceBrackets ? "]" : ""));
}
if(_shouldPrintDeviceNames) { Console.WriteLine();
Console.Write((addDeviceBrackets ? "[" : "") + comPortInfo.DeviceName + (addDeviceBrackets ? "]" : ""));
} }
} else {
Console.WriteLine(); Console.Error.Write("No COM port could be found.");
_exitCode = ErrorCodes.NoComPorts;
} }
} else {
Console.Error.Write("No COM port could be found."); // Allows the program to be run from a shortcut without closing the console instantly.
_exitCode = ErrorCodes.NoComPorts; if(IsProgramRunDirectly()) {
Console.Write("\nPress any key to continue...");
Console.ReadKey();
}
return _exitCode;
} }
// Allows the program to be run from a shortcut without closing the console instantly. // Imports "GetConsoleProcessList(...)" in order to know if the program was run via a shortcut or a CLI prompt.
if(IsProgramRunDirectly()) { // See: https://learn.microsoft.com/en-us/windows/console/getconsoleprocesslist
Console.Write("\nPress any key to continue..."); [System.Runtime.InteropServices.DllImport("kernel32.dll")]
Console.ReadKey(); private static extern int GetConsoleProcessList(int[] buffer, int size);
}
return _exitCode;
} }
// Imports "GetConsoleProcessList(...)" in order to know if the program was run via a shortcut or CLI.
// See: https://learn.microsoft.com/en-us/windows/console/getconsoleprocesslist
[System.Runtime.InteropServices.DllImport("kernel32.dll")]
private static extern int GetConsoleProcessList(int[] buffer, int size);
} }
NibblePoker.Library.ComPortHelpers/NibblePoker.Library.ComPortHelpers.csproj
-2
View File
@@ -8,8 +8,6 @@
<RootNamespace>NibblePoker.Library.ComPortWatcher</RootNamespace> <RootNamespace>NibblePoker.Library.ComPortWatcher</RootNamespace>
<AssemblyName>NibblePoker.Library.ComPortHelpers</AssemblyName> <AssemblyName>NibblePoker.Library.ComPortHelpers</AssemblyName>
<Configurations>Release</Configurations>
<Platforms>AnyCPU</Platforms>
</PropertyGroup> </PropertyGroup>
<ItemGroup> <ItemGroup>