/// <summary>
/// Attempts to extract the items in the given item vector. Item vectors embedded in strings, and item vectors with
/// separator specifications are considered invalid, because it is not clear if those item vectors are meant to be lists
/// or strings -- if the latter, the ExpandEmbeddedItemVectors() method should be used instead.
/// </summary>
/// <owner>SumedhK;RGoel</owner>
/// <param name="itemVectorExpression"></param>
/// <param name="parentNode"></param>
/// <param name="itemsByType"></param>
/// <returns>a virtual BuildItemGroup containing the items resulting from the expression, or null if the expression was invalid.</returns>
internal static BuildItemGroup ItemizeItemVector
(
string itemVectorExpression,
XmlNode parentNode,
ReadOnlyLookup readOnlyLookup
)
{
Match throwAwayMatch;
return(ItemExpander.ItemizeItemVector(itemVectorExpression, parentNode, readOnlyLookup, out throwAwayMatch));
}
/// <summary>
/// Attempts to extract the items in the given item vector expression. Item vectors embedded in strings,
/// and item vectors with separator specifications are considered invalid, because it is not clear
/// if those item vectors are meant to be lists or strings -- if the latter, the ExpandEmbeddedItemVectors()
/// method should be used instead.
/// </summary>
/// <param name="itemVectorExpression"></param>
/// <param name="parentNode"></param>
/// <param name="readOnlyLookup"></param>
/// <param name="itemVectorMatch"></param>
/// <returns>a virtual BuildItemGroup containing the items resulting from the expression, or null if the expression was invalid.</returns>
/// <owner>SumedhK;RGoel</owner>
internal static BuildItemGroup ItemizeItemVector
(
string itemVectorExpression,
XmlNode parentNode,
ReadOnlyLookup readOnlyLookup,
out Match itemVectorMatch
)
{
itemVectorMatch = null;
BuildItemGroup items = null;
itemVectorMatch = GetItemVectorMatches(itemVectorExpression);
if (itemVectorMatch != null && itemVectorMatch.Success)
{
// The method above reports a match if there are any
// valid @(itemlist) references in the given expression.
// If the passed-in expression contains exactly one item list reference,
// with nothing else concatenated to the beginning or end, then proceed
// with itemizing it, otherwise error.
ProjectErrorUtilities.VerifyThrowInvalidProject(itemVectorMatch.Value == itemVectorExpression,
parentNode, "EmbeddedItemVectorCannotBeItemized", itemVectorExpression);
ItemExpander itemExpander = new ItemExpander(parentNode, readOnlyLookup);
// If the reference contains a separator, we need to flatten the list into a scalar and then create
// an item group with a single item. This is necessary for VSWhidbey 525917 - basically we need this
// to be able to convert item lists with user specified separators into properties.
if (itemVectorMatch.Groups["SEPARATOR_SPECIFICATION"].Length > 0)
{
string expandedItemVector = itemExpander.ExpandItemVector(itemVectorMatch);
string itemType = itemVectorMatch.Groups["TYPE"].Value;
items = new BuildItemGroup();
if (expandedItemVector.Length > 0)
{
items.AddNewItem(itemType, expandedItemVector);
}
}
else
{
items = itemExpander.ItemizeItemVector(itemVectorMatch);
}
ErrorUtilities.VerifyThrow(items != null, "ItemizeItemVector shouldn't give us null.");
}
return(items);
}
/// <summary>
/// Expands all item vectors embedded in the given string.
/// </summary>
/// <owner>SumedhK</owner>
/// <param name="s"></param>
/// <param name="parentNode"></param>
/// <param name="itemsByType"></param>
/// <returns>Given string, with embedded item vectors expanded.</returns>
internal static string ExpandEmbeddedItemVectors(string s, XmlNode parentNode, ReadOnlyLookup readOnlyLookup)
{
// Before we do the expensive RegEx stuff, at least make sure there's
// an @ sign in the expression somewhere. If not, skip all the hard work.
if (s.IndexOf('@') != -1)
{
ItemExpander itemExpander = new ItemExpander(parentNode, readOnlyLookup);
return(itemVectorPattern.Replace(s, new MatchEvaluator(itemExpander.ExpandItemVector)));
}
else
{
return(s);
}
}
/// <summary>
/// Given the properties and dictionary of previously encountered item definitions, evaluates
/// this specific item definition child element and adds to the dictionary as necessary.
/// </summary>
/// <exception cref="InvalidProjectFileException">If the item definition is incorrectly defined</exception>
private void EvaluateItemDefinitionChildElement(XmlElement itemDefinitionChildElement, BuildPropertyGroup properties, ItemDefinitionsDictionary itemDefinitionsDictionary)
{
ProjectXmlUtilities.VerifyThrowProjectValidNameAndNamespace(itemDefinitionChildElement);
ProjectErrorUtilities.VerifyThrowInvalidProject(!FileUtilities.IsItemSpecModifier(itemDefinitionChildElement.Name), itemDefinitionChildElement, "ItemSpecModifierCannotBeCustomMetadata", itemDefinitionChildElement.Name);
ProjectErrorUtilities.VerifyThrowInvalidProject(XMakeElements.IllegalItemPropertyNames[itemDefinitionChildElement.Name] == null, itemDefinitionChildElement, "CannotModifyReservedItemMetadata", itemDefinitionChildElement.Name);
XmlAttribute conditionAttribute = ProjectXmlUtilities.GetConditionAttribute(itemDefinitionChildElement, /* sole attribute */ true);
string condition = ProjectXmlUtilities.GetAttributeValue(conditionAttribute);
MetadataDictionary metadataDictionary = null;
string itemType = itemDefinitionChildElement.ParentNode.Name;
itemDefinitionsDictionary.TryGetValue(itemType, out metadataDictionary);
Expander expander = new Expander(properties, itemType, metadataDictionary);
if (!Utilities.EvaluateCondition(condition, conditionAttribute, expander, ParserOptions.AllowPropertiesAndItemMetadata, parentProject))
{
return;
}
string unevaluatedMetadataValue = Utilities.GetXmlNodeInnerContents(itemDefinitionChildElement);
bool containsItemVector = ItemExpander.ExpressionContainsItemVector(unevaluatedMetadataValue);
// We don't allow expressions like @(foo) in the value, as no items exist at this point.
ProjectErrorUtilities.VerifyThrowInvalidProject(!containsItemVector, itemDefinitionChildElement, "MetadataDefinitionCannotContainItemVectorExpression", unevaluatedMetadataValue, itemDefinitionChildElement.Name);
string evaluatedMetadataValue = expander.ExpandAllIntoStringLeaveEscaped(unevaluatedMetadataValue, itemDefinitionChildElement);
if (metadataDictionary == null)
{
metadataDictionary = new MetadataDictionary(StringComparer.OrdinalIgnoreCase);
itemDefinitionsDictionary.Add(itemType, metadataDictionary);
}
// We only store the evaluated value; build items store the unevaluated value as well, but apparently only to
// gather recursive portions (its re-evaluation always goes back to the XML).
// Overwrite any existing default value for this particular metadata
metadataDictionary[itemDefinitionChildElement.Name] = evaluatedMetadataValue;
}
