/// <summary>
/// Occurs whenever a key is pressed in any of the child controls.
/// </summary>
/// <param name="keyData">The key that was pressed.</param>
/// <returns>True if the parent control can handle the key itself,
/// false otherwise.</returns>
protected override bool ProcessDialogKey(Keys keyData)
{
if ((keyData == Keys.Escape || keyData == Keys.Enter) && this.SuppressKeyPress)
{
return(false);
}
if (keyData == Keys.F1)
{
string wizName = wizardName.Replace("TXT_", "").ToLowerInvariant();
HelpTarget.HelpRequest(wizName, wizardPage.Name);
}
return(base.ProcessDialogKey(keyData));
}
public override void FireHelpRequest()
{
BaseCfgPanel panel = null;
try
{
panel = tabOptions.SelectedTab.Controls[0] as BaseCfgPanel;
}
catch
{
panel = null;
}
if (panel != null)
{
HelpTarget.HelpRequest(this.Name, panel.GetHelpTopic());
}
else
{
base.FireHelpRequest();
}
}
public override void FireHelpRequest()
{
if (this.IsActive)
{
string sectionName = AddonAppConfig.LastNavAddon.Replace(".", "");
string topicName = "";
BaseAddonCtl addon = null;
try
{
if (pnlNavContainer.ContainsFocus)
{
addon = pnlNavContainer.Controls[0] as BaseAddonCtl;
}
else if (pnlProperties.ContainsFocus)
{
addon = pnlProperties.Controls[0] as BaseAddonCtl;
}
else if (pnlPreview.ContainsFocus)
{
addon = pnlPreview.Controls[0] as BaseAddonCtl;
}
}
catch { }
if (addon != null)
{
topicName = addon.GetHelpTopic();
}
HelpTarget.HelpRequest(sectionName, topicName);
}
else
{
base.FireHelpRequest();
}
}
public override bool Execute()
{
var collection = new ProjectCollection();
var xml = new ConcurrentDictionary <string, XDocument>(StringComparer.OrdinalIgnoreCase);
var root = ProjectRootElement.Open(HelpProject, collection);
var eval = new Project(root, null, null, collection);
var logical = eval.GetLogicalProject().ToArray();
var allProps = logical
.OfType <ProjectPropertyElement>()
// Add the local props first
.Where(x => x.Location.File.Equals(HelpProject, StringComparison.OrdinalIgnoreCase))
.Concat(logical
.OfType <ProjectPropertyElement>()
.Where(x => !x.Location.File.Equals(HelpProject, StringComparison.OrdinalIgnoreCase)))
.ToArray();
var allTargets = logical
.OfType <ProjectTargetElement>()
// Add the local props first
.Where(x => x.Location.File.Equals(HelpProject, StringComparison.OrdinalIgnoreCase))
.Concat(logical
.OfType <ProjectTargetElement>()
.Where(x => !x.Location.File.Equals(HelpProject, StringComparison.OrdinalIgnoreCase)))
.ToArray();
var includeExpr = new Regex(HelpInclude, RegexOptions.IgnoreCase);
var excludeExpr = new Regex(HelpExclude, RegexOptions.IgnoreCase);
var searchExpr = new Regex(HelpSearch, RegexOptions.IgnoreCase);
// Should exclude it if it doesn't match the include or matches the exclude
bool ShouldExclude(string value)
=> (!includeExpr.IsMatch(value) || excludeExpr.IsMatch(value));
bool SatisfiesSearch(string value)
=> string.IsNullOrWhiteSpace(HelpSearch) || searchExpr.IsMatch(value);
var helpProperties = bool.Parse(HelpProperties);
var helpTargets = bool.Parse(HelpTargets);
var helpImports = bool.Parse(HelpImports);
var metaHelp = new StringBuilder();
metaHelp.Append("Help: properties to customize what 'Help' reports");
var help = new StringBuilder();
var standard =
allTargets.Any(t => t.Name == "Configure") &&
allTargets.Any(t => t.Name == "Build") &&
allTargets.Any(t => t.Name == "Test");
if (standard)
{
help.AppendLine(UseColors ?
"Standard: {YES:LawnGreen} √ (Configure, Build and Test targets supported)" :
"Standard: YES √ (Configure, Build and Test targets supported)").AppendLine();
}
else
{
help.AppendLine(UseColors ?
"Standard: {NO:Tomato} x (Missing Configure, Build, Test or Run targets. Lean more at http://corebuild.io" :
"Standard: NO x (Missing Configure, Build, Test or Run targets. Lean more at http://corebuild.io").AppendLine();
Log.LogWarning(null, "CB01", null, null, 0, 0, 0, 0, "This project is NOT CoreBuild Standard compatible. Please provide Configure, Build and Test targets. Lean more at http://corebuild.io");
}
var hasProps = false;
if (helpProperties)
{
var propsHelp = new StringBuilder();
propsHelp.Append("Properties:");
var processed = new HashSet <string>();
var alwaysInclude = new HashSet <string>(HelpProperty.Select(x => x.ItemSpec));
foreach (var prop in allProps
.Where(x => x != null && !x.Name.StartsWith("_"))
.OrderBy(x => x.Name))
{
// First property to make it to the list wins.
// Target project source is loaded first, followed by imported properties.
if (processed.Contains(prop.Name))
{
continue;
}
var isMeta = Path.GetFileName(prop.Location.File) == "CoreBuild.Help.targets";
var builder = isMeta ? metaHelp : propsHelp;
if (!alwaysInclude.Contains(prop.Name))
{
// Skip non-meta props that should be excluded
if (!isMeta && ShouldExclude(prop.Name))
{
processed.Add(prop.Name);
continue;
}
var isLocal = prop.Location.File.Equals(HelpProject, StringComparison.OrdinalIgnoreCase);
// Skip non-meta props that are from imports as needed
if (!isMeta && !helpImports && !isLocal)
{
processed.Add(prop.Name);
continue;
}
}
var candidate = new CandidateElement(prop.Name, allProps.Where(x => x.Name == prop.Name), xml);
if (candidate.IsHidden)
{
processed.Add(prop.Name);
continue;
}
if (isMeta || alwaysInclude.Contains(prop.Name) || SatisfiesSearch(prop.Name) || SatisfiesSearch(candidate.Comment))
{
// We got a prop. Flag if non-meta
if (!isMeta)
{
hasProps = true;
}
if (isMeta)
{
builder.AppendLine().Append($"\t- {prop.Name}");
}
else
{
builder.AppendLine().Append(UseColors ?
$"\t- {{{prop.Name}:Aqua}}" :
$"\t- {prop.Name}");
}
if (!string.IsNullOrWhiteSpace(candidate.Comment))
{
AppendComment(builder, prop.Name, candidate.Comment);
}
processed.Add(prop.Name);
}
}
if (hasProps)
{
help.Append(propsHelp.ToString());
}
}
if (helpTargets)
{
var hasTargets = false;
var targetsHelp = new StringBuilder();
if (hasProps)
{
targetsHelp.AppendLine().AppendLine();
}
targetsHelp.Append("Targets:");
var processed = new HashSet <string>();
var alwaysInclude = new HashSet <string>(HelpTarget.Select(x => x.ItemSpec));
foreach (var target in allTargets
.Where(x => x.Name != "Help" && !x.Name.StartsWith("_"))
.OrderBy(x => x.Name))
{
// First target to make it to the list wins.
// Target project source is loaded first, followed by imported targets.
if (processed.Contains(target.Name))
{
continue;
}
if (!alwaysInclude.Contains(target.Name))
{
var isLocal = target.Location.File.Equals(HelpProject, StringComparison.OrdinalIgnoreCase);
// Skip targets that should be excluded
if (ShouldExclude(target.Name) ||
// Skip targets that are from imports as needed
(!helpImports && !isLocal))
{
processed.Add(target.Name);
continue;
}
}
var candidate = new CandidateElement(target.Name, allTargets.Where(x => x.Name == target.Name), xml);
if (candidate.IsHidden)
{
processed.Add(target.Name);
continue;
}
if (alwaysInclude.Contains(target.Name) || SatisfiesSearch(target.Name) || SatisfiesSearch(candidate.Comment))
{
hasTargets = true;
targetsHelp.AppendLine().Append(UseColors ?
$"\t- {{{target.Name}:Yellow}}" :
$"\t- {target.Name}");
if (!string.IsNullOrWhiteSpace(candidate.Comment))
{
AppendComment(targetsHelp, target.Name, candidate.Comment);
}
}
}
if (hasTargets)
{
help.Append(targetsHelp.ToString());
}
}
help.AppendLine();
metaHelp.AppendLine();
Log.LogMessage(MessageImportance.High, help.ToString());
Log.LogMessage(MessageImportance.Normal, metaHelp.ToString());
return(true);
}
public virtual void FireHelpRequest()
{
HelpTarget.HelpRequest(this.Name);
}
