You can not select more than 25 topics Topics must start with a chinese character,a letter or number, can include dashes ('-') and can be up to 35 characters long.

ModuleClassBuilder.cs 12 kB

8 years ago
8 years ago
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305
  1. using System;
  2. using System.Linq;
  3. using System.Collections.Generic;
  4. using System.Reflection;
  5. using System.Threading.Tasks;
  6. using Discord.Commands.Builders;
  7. namespace Discord.Commands
  8. {
  9. internal static class ModuleClassBuilder
  10. {
  11. private static readonly TypeInfo _moduleTypeInfo = typeof(IModuleBase).GetTypeInfo();
  12. public static IEnumerable<TypeInfo> Search(Assembly assembly)
  13. {
  14. foreach (var type in assembly.ExportedTypes)
  15. {
  16. var typeInfo = type.GetTypeInfo();
  17. if (IsValidModuleDefinition(typeInfo) &&
  18. !typeInfo.IsDefined(typeof(DontAutoLoadAttribute)))
  19. {
  20. yield return typeInfo;
  21. }
  22. }
  23. }
  24. public static Dictionary<Type, ModuleInfo> Build(CommandService service, params TypeInfo[] validTypes) => Build(validTypes, service);
  25. public static Dictionary<Type, ModuleInfo> Build(IEnumerable<TypeInfo> validTypes, CommandService service)
  26. {
  27. /*if (!validTypes.Any())
  28. throw new InvalidOperationException("Could not find any valid modules from the given selection");*/
  29. var topLevelGroups = validTypes.Where(x => x.DeclaringType == null);
  30. var subGroups = validTypes.Intersect(topLevelGroups);
  31. var builtTypes = new List<TypeInfo>();
  32. var result = new Dictionary<Type, ModuleInfo>();
  33. foreach (var typeInfo in topLevelGroups)
  34. {
  35. // TODO: This shouldn't be the case; may be safe to remove?
  36. if (result.ContainsKey(typeInfo.AsType()))
  37. continue;
  38. var module = new ModuleBuilder(service, null);
  39. BuildModule(module, typeInfo, service);
  40. BuildSubTypes(module, typeInfo.DeclaredNestedTypes, builtTypes, service);
  41. result[typeInfo.AsType()] = module.Build(service);
  42. }
  43. return result;
  44. }
  45. private static void BuildSubTypes(ModuleBuilder builder, IEnumerable<TypeInfo> subTypes, List<TypeInfo> builtTypes, CommandService service)
  46. {
  47. foreach (var typeInfo in subTypes)
  48. {
  49. if (!IsValidModuleDefinition(typeInfo))
  50. continue;
  51. if (builtTypes.Contains(typeInfo))
  52. continue;
  53. builder.AddModule((module) =>
  54. {
  55. BuildModule(module, typeInfo, service);
  56. BuildSubTypes(module, typeInfo.DeclaredNestedTypes, builtTypes, service);
  57. });
  58. builtTypes.Add(typeInfo);
  59. }
  60. }
  61. private static void BuildModule(ModuleBuilder builder, TypeInfo typeInfo, CommandService service)
  62. {
  63. var attributes = typeInfo.GetCustomAttributes();
  64. foreach (var attribute in attributes)
  65. {
  66. switch (attribute)
  67. {
  68. case NameAttribute name:
  69. builder.Name = name.Text;
  70. break;
  71. case SummaryAttribute summary:
  72. builder.Summary = summary.Text;
  73. break;
  74. case RemarksAttribute remarks:
  75. builder.Remarks = remarks.Text;
  76. break;
  77. case AliasAttribute alias:
  78. builder.AddAliases(alias.Aliases);
  79. break;
  80. case GroupAttribute group:
  81. builder.Name = builder.Name ?? group.Prefix;
  82. builder.AddAliases(group.Prefix);
  83. break;
  84. case PreconditionAttribute precondition:
  85. builder.AddPrecondition(precondition);
  86. break;
  87. }
  88. }
  89. //Check for unspecified info
  90. if (builder.Aliases.Count == 0)
  91. builder.AddAliases("");
  92. if (builder.Name == null)
  93. builder.Name = typeInfo.Name;
  94. var validCommands = typeInfo.DeclaredMethods.Where(x => IsValidCommandDefinition(x));
  95. var groupedCommands = validCommands.GroupBy(x => x.GetCustomAttribute<CommandAttribute>().Text);
  96. foreach (var overloads in groupedCommands)
  97. {
  98. builder.AddCommand((command) =>
  99. {
  100. string firstName = null;
  101. foreach (var method in overloads)
  102. {
  103. if (firstName == null)
  104. firstName = method.Name;
  105. command.AddOverload((overload) =>
  106. {
  107. BuildOverload(overload, typeInfo, method, service);
  108. });
  109. }
  110. var allAttributes = overloads.SelectMany(x => x.GetCustomAttributes());
  111. BuildCommand(command, firstName, allAttributes, service);
  112. });
  113. }
  114. }
  115. private static void BuildCommand(CommandBuilder builder, string defaultName, IEnumerable<Attribute> attributes, CommandService service)
  116. {
  117. foreach (var attribute in attributes)
  118. {
  119. switch (attribute)
  120. {
  121. case CommandAttribute command:
  122. builder.AddAliases(command.Text);
  123. builder.Name = builder.Name ?? command.Text;
  124. break;
  125. case NameAttribute name:
  126. builder.Name = name.Text;
  127. break;
  128. case SummaryAttribute summary:
  129. builder.Summary = summary.Text;
  130. break;
  131. case RemarksAttribute remarks:
  132. builder.Remarks = remarks.Text;
  133. break;
  134. case AliasAttribute alias:
  135. builder.AddAliases(alias.Aliases);
  136. break;
  137. }
  138. }
  139. if (builder.Name == null)
  140. builder.Name = defaultName;
  141. }
  142. private static void BuildOverload(OverloadBuilder builder, TypeInfo typeInfo, MethodInfo method, CommandService service)
  143. {
  144. var attributes = method.GetCustomAttributes();
  145. foreach (var attribute in attributes)
  146. {
  147. switch (attribute)
  148. {
  149. case CommandAttribute command:
  150. builder.RunMode = command.RunMode;
  151. break;
  152. case PriorityAttribute priority:
  153. builder.Priority = priority.Priority;
  154. break;
  155. case PreconditionAttribute precondition:
  156. builder.AddPrecondition(precondition);
  157. break;
  158. }
  159. }
  160. var parameters = method.GetParameters();
  161. int pos = 0, count = parameters.Length;
  162. foreach (var paramInfo in parameters)
  163. {
  164. builder.AddParameter((parameter) =>
  165. {
  166. BuildParameter(parameter, paramInfo, pos++, count, service);
  167. });
  168. }
  169. var createInstance = ReflectionUtils.CreateBuilder<IModuleBase>(typeInfo, service);
  170. builder.Callback = async (ctx, args, map) =>
  171. {
  172. var instance = createInstance(map);
  173. instance.SetContext(ctx);
  174. try
  175. {
  176. instance.BeforeExecute();
  177. var task = method.Invoke(instance, args) as Task ?? Task.Delay(0);
  178. await task.ConfigureAwait(false);
  179. }
  180. finally
  181. {
  182. instance.AfterExecute();
  183. (instance as IDisposable)?.Dispose();
  184. }
  185. };
  186. }
  187. private static void BuildParameter(ParameterBuilder builder, System.Reflection.ParameterInfo paramInfo, int position, int count, CommandService service)
  188. {
  189. var attributes = paramInfo.GetCustomAttributes();
  190. var paramType = paramInfo.ParameterType;
  191. builder.Name = paramInfo.Name;
  192. builder.IsOptional = paramInfo.IsOptional;
  193. builder.DefaultValue = paramInfo.HasDefaultValue ? paramInfo.DefaultValue : null;
  194. foreach (var attribute in attributes)
  195. {
  196. // TODO: C#7 type switch
  197. switch (attribute)
  198. {
  199. case SummaryAttribute summary:
  200. builder.Summary = summary.Text;
  201. break;
  202. case OverrideTypeReaderAttribute typeReader:
  203. builder.TypeReader = GetTypeReader(service, paramType, typeReader.TypeReader);
  204. break;
  205. case ParameterPreconditionAttribute precondition:
  206. builder.AddPrecondition(precondition);
  207. break;
  208. case ParamArrayAttribute paramArray:
  209. if (position != count - 1)
  210. throw new InvalidOperationException("Params parameters must be the last parameter in a command.");
  211. builder.IsMultiple = true;
  212. paramType = paramType.GetElementType();
  213. break;
  214. case RemainderAttribute remainder:
  215. if (position != count - 1)
  216. throw new InvalidOperationException("Remainder parameters must be the last parameter in a command.");
  217. builder.IsRemainder = true;
  218. break;
  219. }
  220. }
  221. builder.ParameterType = paramType;
  222. if (builder.TypeReader == null)
  223. {
  224. var readers = service.GetTypeReaders(paramType);
  225. TypeReader reader = null;
  226. if (readers != null)
  227. reader = readers.FirstOrDefault().Value;
  228. else
  229. reader = service.GetDefaultTypeReader(paramType);
  230. builder.TypeReader = reader;
  231. }
  232. }
  233. private static TypeReader GetTypeReader(CommandService service, Type paramType, Type typeReaderType)
  234. {
  235. var readers = service.GetTypeReaders(paramType);
  236. TypeReader reader = null;
  237. if (readers != null)
  238. {
  239. if (readers.TryGetValue(typeReaderType, out reader))
  240. return reader;
  241. }
  242. //We dont have a cached type reader, create one
  243. reader = ReflectionUtils.CreateObject<TypeReader>(typeReaderType.GetTypeInfo(), service, EmptyServiceProvider.Instance);
  244. service.AddTypeReader(paramType, reader);
  245. return reader;
  246. }
  247. private static bool IsValidModuleDefinition(TypeInfo typeInfo)
  248. {
  249. return _moduleTypeInfo.IsAssignableFrom(typeInfo) &&
  250. !typeInfo.IsAbstract;
  251. }
  252. private static bool IsValidCommandDefinition(MethodInfo methodInfo)
  253. {
  254. return methodInfo.IsDefined(typeof(CommandAttribute)) &&
  255. (methodInfo.ReturnType == typeof(Task) || methodInfo.ReturnType == typeof(void)) &&
  256. !methodInfo.IsStatic &&
  257. !methodInfo.IsGenericMethod;
  258. }
  259. }
  260. }