File size: 6,033 Bytes
8c763fb | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 | // Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
namespace System.Management.Automation
{
/// <summary>
/// Help request is a set of data to be passed into monad help engine for requesting help contents.
///
/// Help request track information including
///
/// 1. target
/// 2. category filter
/// 3. provider
/// 4. dynamic parameters
/// 5. components
/// 6. functionalities
/// 7. roles
///
/// Upon getting a help request, help engine will validate the help request and send the request to
/// necessary help providers for processing.
/// </summary>
internal class HelpRequest
{
/// <summary>
/// Constructor for HelpRequest.
/// </summary>
/// <param name="target"></param>
/// <param name="helpCategory"></param>
internal HelpRequest(string target, HelpCategory helpCategory)
{
Target = target;
HelpCategory = helpCategory;
CommandOrigin = CommandOrigin.Runspace;
}
/// <summary>
/// Create a copy of current help request object.
/// </summary>
/// <returns></returns>
internal HelpRequest Clone()
{
HelpRequest helpRequest = new HelpRequest(this.Target, this.HelpCategory);
helpRequest.Provider = this.Provider;
helpRequest.MaxResults = this.MaxResults;
helpRequest.Component = this.Component;
helpRequest.Role = this.Role;
helpRequest.Functionality = this.Functionality;
helpRequest.ProviderContext = this.ProviderContext;
helpRequest.CommandOrigin = CommandOrigin;
return helpRequest;
}
/// <summary>
/// Defines which provider the user seeking help is curious about.
/// </summary>
internal ProviderContext ProviderContext { get; set; }
/// <summary>
/// Target for help.
/// </summary>
/// <value></value>
internal string Target { get; set; }
/// <summary>
/// Help category filter.
/// </summary>
/// <value></value>
internal HelpCategory HelpCategory { get; set; } = HelpCategory.None;
/// <summary>
/// Provider for this help.
///
/// If provider is set and helpCategory is 'Provider', provider help will be returned. (Also
/// the value of target will be set to this one).
///
/// If provider is set and helpCategory is 'Command', this will add provider specific help
/// to provider.
/// </summary>
/// <value></value>
internal string Provider { get; set; }
/// <summary>
/// Maximum number of result to return for this request.
/// </summary>
/// <value></value>
internal int MaxResults { get; set; } = -1;
/// <summary>
/// Component filter for command help.
/// </summary>
/// <value></value>
internal string[] Component { get; set; }
/// <summary>
/// Role filter for command help.
/// </summary>
/// <value></value>
internal string[] Role { get; set; }
/// <summary>
/// Functionality filter for command help.
/// </summary>
/// <value></value>
internal string[] Functionality { get; set; }
/// <summary>
/// Keeps track of get-help cmdlet call origin. It can be called
/// directly by the user or indirectly by a script that a user calls.
/// </summary>
internal CommandOrigin CommandOrigin { get; set; }
/// <summary>
/// Following validation will be done, (in order)
///
/// 1. If everything is empty, do default help.
/// 2. If target is empty, set it to be provider if currently doing provider help only. Otherwise, set it to be *
/// 3. If any special parameters like component, role, functionality are specified, do command help only.
/// 4. If command help is requested, search for alias also.
/// 5. If help category is none, set it to be all.
/// 6. Don't do default help.
/// </summary>
internal void Validate()
{
if (string.IsNullOrEmpty(Target)
&& HelpCategory == HelpCategory.None
&& string.IsNullOrEmpty(Provider)
&& Component == null
&& Role == null
&& Functionality == null
)
{
Target = "default";
HelpCategory = HelpCategory.DefaultHelp;
return;
}
if (string.IsNullOrEmpty(Target))
{
if (!string.IsNullOrEmpty(Provider) &&
(HelpCategory == HelpCategory.None || HelpCategory == HelpCategory.Provider)
)
{
Target = Provider;
}
else
{
Target = "*";
}
}
// if either of component/role/functionality is specified then look in the
// following help categories
if ((!(Component == null && Role == null && Functionality == null)) &&
(HelpCategory == HelpCategory.None))
{
HelpCategory = HelpCategory.Alias | HelpCategory.Cmdlet | HelpCategory.Function | HelpCategory.Filter | HelpCategory.ExternalScript | HelpCategory.ScriptCommand;
return;
}
if ((HelpCategory & HelpCategory.Cmdlet) > 0)
{
HelpCategory |= HelpCategory.Alias;
}
if (HelpCategory == HelpCategory.None)
{
HelpCategory = HelpCategory.All;
}
HelpCategory &= ~HelpCategory.DefaultHelp;
return;
}
}
}
|