StartupConfiguration.cs 8.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237
  1. using System;
  2. using System.Collections.Generic;
  3. using System.Linq;
  4. using System.Reflection;
  5. using System.Xml.XPath;
  6. using Quadarax.Foundation.Core.Console;
  7. using Quadarax.Foundation.Core.Logging;
  8. using Quadarax.Foundation.Core.QConsole.Handlers;
  9. namespace Quadarax.Foundation.Core.QConsole.Configuration
  10. {
  11. public class StartupConfiguration
  12. {
  13. #region *** Private Fields ***
  14. private bool _isConsoleDebug;
  15. private string[] _defaultCommands = {"CmdClear", "CmdExit", "CmdPrint", "CmdSelection"};
  16. private readonly IList<string> _disabledCommands = new List<string>();
  17. #endregion
  18. #region *** Properties ***
  19. /// <summary>
  20. /// Name of console application, If not defined uses default name from entryAssembly.
  21. /// </summary>
  22. public string ConsoleName { get; }
  23. /// <summary>
  24. /// Console application version. If not defined uses version of entryAssembly.
  25. /// </summary>
  26. public Version ConsoleVersion { get; }
  27. /// <summary>
  28. /// Console application copyright message. If not set skip this info.
  29. /// </summary>
  30. public string ConsoleCopyright { get; set; }
  31. /// <summary>
  32. /// Defines if console is initialized from XML definition.
  33. /// </summary>
  34. public bool IsInitFromXml { get; }
  35. /// <summary>
  36. /// Left introducing of interactive mode character.
  37. /// </summary>
  38. public string CharacterLineIntroduce { get; set; }
  39. /// <summary>
  40. /// Separator between two ordinal arguments
  41. /// </summary>
  42. public string CharacterOrdinalArgumentSeparator { get; set; }
  43. /// <summary>
  44. /// Named argument prefix character.
  45. /// </summary>
  46. public string CharacterNamedArgumentSeparator { get; set; }
  47. /// <summary>
  48. /// Named argument postfix character {defines end of argument code and value)
  49. /// </summary>
  50. public string CharacterNamedArgumentValueSeparator { get; set; }
  51. /// <summary>
  52. /// Start end end string value character
  53. /// </summary>
  54. public string CharacterTextValueBraceSeparator { get; set; }
  55. /// <summary>
  56. /// Separator between two selection inputs
  57. /// </summary>
  58. public string CharacterSelectionInputValueSeparator { get; set; }
  59. /// <summary>
  60. /// Date input/output value format
  61. /// </summary>
  62. public string DateFormat { get; set; }
  63. /// <summary>
  64. /// Time input/output value format
  65. /// </summary>
  66. public string TimeFormat { get; set; }
  67. /// <summary>
  68. /// Defines if interactive mode is enabled
  69. /// </summary>
  70. public bool AllowInteractive { get; set; }
  71. /// <summary>
  72. /// Defines if initial variables is allowed for interactive mode.
  73. /// </summary>
  74. public bool AllowPreset { get; set; }
  75. /// <summary>
  76. /// Defines assembly list where custom commands are defined (in case explicit command definition).
  77. /// </summary>
  78. public Assembly[] CommandDefinitionAssebmly { get; set; }
  79. /// <summary>
  80. /// Returns name of command classes that will be disabled (hidden)
  81. /// </summary>
  82. public string[] DisabledCommands => _disabledCommands.ToArray();
  83. /// <summary>
  84. /// Defines if waits on key at the end of process in non-interactive mode (inline mode)
  85. /// </summary>
  86. public bool WaitOnKeyInNonInteractiveMode { get; set; }
  87. /// <summary>
  88. /// Defines if show status of engine and command context before every command executed.
  89. /// </summary>
  90. public bool ShowStatusOnEveryCommand { get; set; }
  91. public bool UseDefaultHandlers { get; set; }
  92. /// <summary>
  93. /// Handler when no arguments input specified. If not set then do nothing.
  94. /// </summary>
  95. public NothingToDo HandlerNothingToDo { get; set; }
  96. public bool IsConsoleDebug {
  97. get
  98. {
  99. return _isConsoleDebug;
  100. }
  101. set
  102. {
  103. _isConsoleDebug = value;
  104. DebugConsoleWriter.IsWriteDebugEnabled = value;
  105. }
  106. }
  107. public ILogger? DefaultLoggerFactory { get; set; }
  108. #endregion
  109. #region *** Constructor ***
  110. public StartupConfiguration(string consoleName, Version consoleVersion)
  111. {
  112. ConsoleName = consoleName;
  113. ConsoleVersion = consoleVersion;
  114. IsInitFromXml = false;
  115. InitDefaults();
  116. }
  117. public StartupConfiguration(string consoleXmlFileName)
  118. {
  119. IsInitFromXml = true;
  120. InitDefaults();
  121. }
  122. public StartupConfiguration(XPathNavigator configurationNavigator)
  123. {
  124. IsInitFromXml = true;
  125. InitDefaults();
  126. }
  127. #endregion
  128. #region *** Public Operations ***
  129. public StartupConfiguration EnableDebugMode()
  130. {
  131. IsConsoleDebug = true;
  132. return this;
  133. }
  134. public StartupConfiguration DisableDebugMode()
  135. {
  136. IsConsoleDebug = false;
  137. return this;
  138. }
  139. public StartupConfiguration DisableDefaultCommands()
  140. {
  141. return DisableCommands(_defaultCommands);
  142. }
  143. public StartupConfiguration EnableDefaultCommands()
  144. {
  145. return EnableCommands(_defaultCommands);
  146. }
  147. public StartupConfiguration EnableCommands(params string[] commandClassNames)
  148. {
  149. if (commandClassNames == null)
  150. return this;
  151. foreach (var className in commandClassNames)
  152. {
  153. if (_disabledCommands.Contains(className))
  154. _disabledCommands.Remove(className);
  155. }
  156. return this;
  157. }
  158. public StartupConfiguration DisableCommands(params string[] commandClassNames)
  159. {
  160. if (commandClassNames == null)
  161. return this;
  162. foreach (var className in commandClassNames)
  163. {
  164. if (!_disabledCommands.Contains(className))
  165. _disabledCommands.Add(className);
  166. }
  167. return this;
  168. }
  169. #endregion
  170. #region *** Private Operations ***
  171. private void InitDefaults()
  172. {
  173. CharacterLineIntroduce = Defaults.RoleCharacters.ConsoleLineIntroduce;
  174. CharacterOrdinalArgumentSeparator = Defaults.RoleCharacters.OrdinalArgumentSeparator;
  175. CharacterNamedArgumentSeparator = Defaults.RoleCharacters.NamedArgumentSeparator;
  176. CharacterNamedArgumentValueSeparator = Defaults.RoleCharacters.NamedArgumentValueSeparator;
  177. CharacterTextValueBraceSeparator = Defaults.RoleCharacters.TextValueBraceSeparator;
  178. CharacterSelectionInputValueSeparator = Defaults.RoleCharacters.InputSelectionValueSeparator;
  179. DateFormat = Defaults.Formats.DateFormat;
  180. TimeFormat = Defaults.Formats.TimeFormat;
  181. AllowInteractive = Defaults.Console.InteractiveAllowed;
  182. AllowPreset = Defaults.Console.PresetAllowed;
  183. IsConsoleDebug = Defaults.Console.ConsoleDebugMode;
  184. WaitOnKeyInNonInteractiveMode = Defaults.Console.WaitOnKeyInNonInteractiveMode;
  185. ShowStatusOnEveryCommand = Defaults.Console.ShowStatusOnEveryCommand;
  186. UseDefaultHandlers = Defaults.Console.UseDefaultHadlers;
  187. if (UseDefaultHandlers)
  188. {
  189. HandlerNothingToDo += engine =>
  190. {
  191. using (var writer = new ConsoleWriter(ConsoleColor.Yellow))
  192. {
  193. writer.WriteLine("Nothing to do.");
  194. }
  195. using (var writer = new ConsoleWriter(ConsoleColor.DarkGreen))
  196. {
  197. writer.WriteLine("Put some arguments to do something. For example -help to list commands and arguments.");
  198. }
  199. };
  200. }
  201. }
  202. #endregion
  203. }
  204. }