private static List <ArgumentGroupInfo> GetGroupsForProperty(TypeArgumentInfo tInfo, PropertyInfo property)
{
List <ArgumentGroupInfo> groupsForThisProperty = new List <ArgumentGroupInfo>();
var customAttributes = property.GetCustomAttributes <GroupAttribute>();
if (!customAttributes.Any())
{
// we need to make sure that we don't add this here is the attribute we are adding is the Action one (which is outside of groups)
if (!property.GetCustomAttributes <ActionArgumentAttribute>().Any())
{
// we have the simple case where we don't have groups defined
groupsForThisProperty.Add(GetArgumentInfoForSingleGroup(string.Empty, tInfo));
}
}
else
{
// we have the complex scenario where groups are present
// there are 2 types of arguments in a group:
// - common ones, flagged with the CommonArgumentAttribute
// - specific to each command group, flagged with ArgumentGroupAttribute
groupsForThisProperty.AddRange(GetArgumentInfoForGroups(tInfo, customAttributes, property));
}
return(groupsForThisProperty);
}
private static IEnumerable <ArgumentGroupInfo> GetArgumentInfoForGroups(TypeArgumentInfo tInfo, IEnumerable <GroupAttribute> customAttributes, PropertyInfo property)
{
foreach (var commandGroup in customAttributes)
{
if (commandGroup is ArgumentGroupAttribute)
{
var argGroupAttribute = commandGroup as ArgumentGroupAttribute;
ArgumentGroupInfo grpPropInfo;
if (!tInfo.ArgumentGroups.TryGetValue(argGroupAttribute.Name, out grpPropInfo))
{
grpPropInfo = new ArgumentGroupInfo();
tInfo.ArgumentGroups[argGroupAttribute.Name] = grpPropInfo;
}
// the list of groups is created eagerly if we have an action that is an enum.
if (argGroupAttribute.OverrideRequiredPosition >= 0)
{
grpPropInfo.OverridePositions[property] = argGroupAttribute.OverrideRequiredPosition;
}
yield return(grpPropInfo);
}
else if (commandGroup is CommonArgumentAttribute)
{
// return all the groups since this is a commond argument
foreach (var item in tInfo.ArgumentGroups.Values)
{
yield return(item);
}
}
}
}
private static IEnumerable <ArgumentGroupInfo> GetArgumentInfoForGroups(TypeArgumentInfo tInfo, IEnumerable <GroupAttribute> customAttributes)
{
foreach (var commandGroup in customAttributes)
{
if (commandGroup is ArgumentGroupAttribute)
{
var argGroupAttribute = commandGroup as ArgumentGroupAttribute;
ArgumentGroupInfo grpPropInfo;
if (!tInfo.ArgumentGroups.TryGetValue(argGroupAttribute.Name, out grpPropInfo))
{
grpPropInfo = new ArgumentGroupInfo();
tInfo.ArgumentGroups[argGroupAttribute.Name] = grpPropInfo;
}
yield return(grpPropInfo);
}
else if (commandGroup is CommonArgumentAttribute)
{
// return all the groups since this is a commond argument
foreach (var item in tInfo.ArgumentGroups.Values)
{
yield return(item);
}
}
}
}
public static void ScanTypeForProperties <TOptions>(out TypeArgumentInfo tInfo)
{
tInfo = new TypeArgumentInfo();
PropertyInfo[] propertiesOnType = typeof(TOptions).GetTypeInfo().GetProperties(BindingFlags.Instance | BindingFlags.Public);
// first of all, find the commandArgument, if any.
tInfo.ActionArgument = FindCommandProperty(propertiesOnType);
// we want to be able to support empty groups.
if (tInfo.ActionArgument != null && IsEnum(tInfo.ActionArgument.PropertyType))
{
// get the values of the enum.
var enumValues = Enum.GetValues(tInfo.ActionArgument.PropertyType);
// Sort the enum by the enum values
Array.Sort(enumValues);
// add them to the dictionary now to make sure we preserve the order
foreach (var val in enumValues)
{
if (!tInfo.ArgumentGroups.ContainsKey(val.ToString()))
{
tInfo.ArgumentGroups.Add(val.ToString(), new ArgumentGroupInfo());
}
}
}
// parse the rest of the properties
foreach (var property in propertiesOnType)
{
// get the group containing this property (note: more than one group can have the same property)
// this allows common required parameters
var groupsWhereThePropertyIsParticipating = GetGroupsForProperty(tInfo, property);
var actualAttribs = property.GetCustomAttributes <ActualArgumentAttribute>().ToList();
if (actualAttribs.Count > 1)
{
throw new ArgumentException($"Only one of Required/Optional attribute are allowed per property ({property.Name}). [Red!Help information might be incorrect!]");
}
// if we have no attributes on that property, move on
ActualArgumentAttribute baseAttrib = actualAttribs.FirstOrDefault();
if (baseAttrib == null)
{
continue;
}
// add the property to add the groups it is a part of
if (baseAttrib is RequiredArgumentAttribute)
{
foreach (ArgumentGroupInfo grpPropInfo in groupsWhereThePropertyIsParticipating)
{
// do we have an override for this property? If we do, use that, otherwise use the regular one.
if (!grpPropInfo.OverridePositions.TryGetValue(property, out int requiredPositionIndex))
{
requiredPositionIndex = (int)baseAttrib.GetArgumentId();
}
if (grpPropInfo.RequiredArguments.ContainsKey(requiredPositionIndex))
{
throw new ArgumentException("Two required arguments share the same position!!");
}
grpPropInfo.RequiredArguments[requiredPositionIndex] = property;
}
}
else if (baseAttrib is OptionalArgumentAttribute)
{
foreach (ArgumentGroupInfo grpPropInfo in groupsWhereThePropertyIsParticipating)
{
if (grpPropInfo.OptionalArguments.ContainsKey((string)baseAttrib.GetArgumentId()))
{
throw new ArgumentException("Two optional arguments share the same name!!");
}
grpPropInfo.OptionalArguments[(string)baseAttrib.GetArgumentId()] = property;
}
}
}
ArgumentGroupInfo grp;
// remove the empty one, if empty
if (tInfo.ArgumentGroups.TryGetValue(string.Empty, out grp))
{
if (grp.OptionalArguments.Count == 0 && grp.RequiredArguments.Count == 0)
{
tInfo.ArgumentGroups.Remove(string.Empty);
}
}
}
private static ArgumentGroupInfo GetArgumentInfoForSingleGroup(string groupName, TypeArgumentInfo tInfo)
{
ArgumentGroupInfo grpPropInfo;
if (!tInfo.ArgumentGroups.TryGetValue(groupName, out grpPropInfo))
{
grpPropInfo = new ArgumentGroupInfo();
tInfo.ArgumentGroups[groupName] = grpPropInfo;
}
return(grpPropInfo);
}