CodeDomSerializerBase.cs 37 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956
  1. //
  2. // System.ComponentModel.Design.Serialization.CodeDomSerializerBase
  3. //
  4. // Authors:
  5. // Ivan N. Zlatev (contact i-nZ.net)
  6. //
  7. // (C) 2007 Ivan N. Zlatev
  8. //
  9. // Permission is hereby granted, free of charge, to any person obtaining
  10. // a copy of this software and associated documentation files (the
  11. // "Software"), to deal in the Software without restriction, including
  12. // without limitation the rights to use, copy, modify, merge, publish,
  13. // distribute, sublicense, and/or sell copies of the Software, and to
  14. // permit persons to whom the Software is furnished to do so, subject to
  15. // the following conditions:
  16. //
  17. // The above copyright notice and this permission notice shall be
  18. // included in all copies or substantial portions of the Software.
  19. //
  20. // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  21. // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  22. // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  23. // NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  24. // LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  25. // OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  26. // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  27. //
  28. #if NET_2_0
  29. using System;
  30. using System.Collections;
  31. using System.Reflection;
  32. using System.ComponentModel;
  33. using System.ComponentModel.Design;
  34. using System.CodeDom;
  35. namespace System.ComponentModel.Design.Serialization
  36. {
  37. [EditorBrowsable (EditorBrowsableState.Never)]
  38. public abstract class CodeDomSerializerBase
  39. {
  40. // MSDN says that if the deserialization fails a CodeExpression is returned
  41. //
  42. private sealed class DeserializationErrorMarker : CodeExpression
  43. {
  44. public override bool Equals (object o)
  45. {
  46. return false;
  47. }
  48. public override int GetHashCode ()
  49. {
  50. return base.GetHashCode ();
  51. }
  52. }
  53. private static readonly DeserializationErrorMarker _errorMarker = new DeserializationErrorMarker ();
  54. internal CodeDomSerializerBase ()
  55. {
  56. }
  57. private class ExpressionTable : Hashtable // just so that we have a specific type to append to the context stack
  58. {
  59. }
  60. protected CodeExpression SerializeToExpression (IDesignerSerializationManager manager, object instance)
  61. {
  62. if (manager == null)
  63. throw new ArgumentNullException ("manager");
  64. CodeExpression expression = null;
  65. if (instance != null)
  66. expression = this.GetExpression (manager, instance); // 1 - IDesignerSerializationManager.GetExpression
  67. if (expression == null) {
  68. CodeDomSerializer serializer = this.GetSerializer (manager, instance); // 2 - manager.GetSerializer().Serialize()
  69. if (serializer != null) {
  70. object serialized = serializer.Serialize (manager, instance);
  71. expression = serialized as CodeExpression; // 3 - CodeStatement or CodeStatementCollection
  72. if (expression == null) {
  73. CodeStatement statement = serialized as CodeStatement;
  74. CodeStatementCollection statements = serialized as CodeStatementCollection;
  75. if (statement != null || statements != null) {
  76. CodeStatementCollection contextStatements = null;
  77. StatementContext context = manager.Context[typeof (StatementContext)] as StatementContext;
  78. if (context != null && instance != null)
  79. contextStatements = context.StatementCollection[instance];
  80. if (contextStatements == null)
  81. contextStatements = manager.Context[typeof (CodeStatementCollection)] as CodeStatementCollection;
  82. if (contextStatements != null) {
  83. if (statements != null)
  84. contextStatements.AddRange (statements);
  85. else
  86. contextStatements.Add (statement);
  87. }
  88. }
  89. }
  90. if (expression == null && instance != null)
  91. expression = this.GetExpression (manager, instance); // 4
  92. } else {
  93. ReportError (manager, "No serializer found for type '" + instance.GetType ().Name + "'");
  94. }
  95. }
  96. return expression;
  97. }
  98. protected CodeDomSerializer GetSerializer (IDesignerSerializationManager manager, object instance)
  99. {
  100. DesignerSerializerAttribute attrInstance, attrType;
  101. attrType = attrInstance = null;
  102. CodeDomSerializer serializer = null;
  103. if (instance == null)
  104. serializer = this.GetSerializer (manager, null);
  105. else {
  106. AttributeCollection attributes = TypeDescriptor.GetAttributes (instance);
  107. foreach (Attribute a in attributes) {
  108. DesignerSerializerAttribute designerAttr = a as DesignerSerializerAttribute;
  109. if (designerAttr != null && manager.GetType (designerAttr.SerializerBaseTypeName) == typeof (CodeDomSerializer)) {
  110. attrInstance = designerAttr;
  111. break;
  112. }
  113. }
  114. attributes = TypeDescriptor.GetAttributes (instance.GetType ());
  115. foreach (Attribute a in attributes) {
  116. DesignerSerializerAttribute designerAttr = a as DesignerSerializerAttribute;
  117. if (designerAttr != null && manager.GetType (designerAttr.SerializerBaseTypeName) == typeof (CodeDomSerializer)) {
  118. attrType = designerAttr;
  119. break;
  120. }
  121. }
  122. // if there is metadata modification in the instance then create the specified serializer instead of the one
  123. // in the Type.
  124. if (attrType != null && attrInstance != null && attrType.SerializerTypeName != attrInstance.SerializerTypeName)
  125. serializer = Activator.CreateInstance (manager.GetType (attrInstance.SerializerTypeName)) as CodeDomSerializer;
  126. else
  127. serializer = this.GetSerializer (manager, instance.GetType ());
  128. }
  129. return serializer;
  130. }
  131. protected CodeDomSerializer GetSerializer (IDesignerSerializationManager manager, Type instanceType)
  132. {
  133. return manager.GetSerializer (instanceType, typeof (CodeDomSerializer)) as CodeDomSerializer;
  134. }
  135. protected CodeExpression GetExpression (IDesignerSerializationManager manager, object instance)
  136. {
  137. if (manager == null)
  138. throw new ArgumentNullException ("manager");
  139. if (instance == null)
  140. throw new ArgumentNullException ("instance");
  141. CodeExpression expression = null;
  142. ExpressionTable expressions = manager.Context[typeof (ExpressionTable)] as ExpressionTable;
  143. if (expressions != null) // 1st try: ExpressionTable
  144. expression = expressions [instance] as CodeExpression;
  145. if (expression == null) { // 2nd try: RootContext
  146. RootContext context = manager.Context[typeof (RootContext)] as RootContext;
  147. if (context != null && context.Value == instance)
  148. expression = context.Expression;
  149. }
  150. if (expression == null) { // 3rd try: IReferenceService (instance.property.property.property
  151. string name = manager.GetName (instance);
  152. if (name == null || name.IndexOf (".") == -1) {
  153. IReferenceService service = manager.GetService (typeof (IReferenceService)) as IReferenceService;
  154. if (service != null) {
  155. name = service.GetName (instance);
  156. if (name != null && name.IndexOf (".") != -1) {
  157. string[] parts = name.Split (new char[] { ',' });
  158. instance = manager.GetInstance (parts[0]);
  159. if (instance != null) {
  160. expression = SerializeToExpression (manager, instance);
  161. if (expression != null) {
  162. for (int i=1; i < parts.Length; i++)
  163. expression = new CodePropertyReferenceExpression (expression, parts[i]);
  164. }
  165. }
  166. }
  167. }
  168. }
  169. }
  170. return expression;
  171. }
  172. protected void SetExpression (IDesignerSerializationManager manager, object instance, CodeExpression expression)
  173. {
  174. SetExpression (manager, instance, expression, false);
  175. }
  176. // XXX: isPreset - what does this do when set?
  177. //
  178. protected void SetExpression (IDesignerSerializationManager manager, object instance, CodeExpression expression, bool isPreset)
  179. {
  180. if (manager == null)
  181. throw new ArgumentNullException ("manager");
  182. if (instance == null)
  183. throw new ArgumentNullException ("instance");
  184. if (expression == null)
  185. throw new ArgumentNullException ("expression");
  186. ExpressionTable expressions = manager.Context[typeof (ExpressionTable)] as ExpressionTable;
  187. if (expressions == null) {
  188. expressions = new ExpressionTable ();
  189. manager.Context.Append (expressions);
  190. }
  191. expressions[instance] = expression;
  192. }
  193. protected bool IsSerialized (IDesignerSerializationManager manager, object value)
  194. {
  195. return this.IsSerialized (manager, value, false);
  196. }
  197. // XXX: What should honorPreset do?
  198. protected bool IsSerialized (IDesignerSerializationManager manager, object instance, bool honorPreset)
  199. {
  200. if (instance == null)
  201. throw new ArgumentNullException ("instance");
  202. if (manager == null)
  203. throw new ArgumentNullException ("manager");
  204. if (this.GetExpression (manager, instance) != null)
  205. return true;
  206. else
  207. return false;
  208. }
  209. protected CodeExpression SerializeCreationExpression (IDesignerSerializationManager manager, object value, out bool isComplete)
  210. {
  211. if (value == null)
  212. throw new ArgumentNullException ("value");
  213. if (manager == null)
  214. throw new ArgumentNullException ("manager");
  215. CodeExpression expression = null;
  216. TypeConverter converter = TypeDescriptor.GetConverter (value);
  217. if (converter != null && converter.CanConvertTo (typeof (InstanceDescriptor))) {
  218. InstanceDescriptor descriptor = converter.ConvertTo (value, typeof (InstanceDescriptor)) as InstanceDescriptor;
  219. isComplete = descriptor.IsComplete;
  220. if (descriptor != null || descriptor.MemberInfo != null)
  221. expression = this.SerializeInstanceDescriptor (manager, descriptor);
  222. else
  223. ReportError (manager, "Unable to serialize to InstanceDescriptor",
  224. "Value Type: " + value.GetType ().Name + System.Environment.NewLine +
  225. "Value (ToString): " + value.ToString ());
  226. } else {
  227. if (value.GetType().GetConstructor (new Type[0]) != null)
  228. expression = new CodeObjectCreateExpression (value.GetType ().FullName, new CodeExpression[0]);
  229. isComplete = false;
  230. }
  231. return expression;
  232. }
  233. private CodeExpression SerializeInstanceDescriptor (IDesignerSerializationManager manager, InstanceDescriptor descriptor)
  234. {
  235. CodeExpression expression = null;
  236. MemberInfo member = descriptor.MemberInfo;
  237. CodeExpression target = new CodeTypeReferenceExpression (member.DeclaringType);
  238. if (member is PropertyInfo) {
  239. expression = new CodePropertyReferenceExpression (target, member.Name);
  240. } else if (member is FieldInfo) {
  241. expression = new CodeFieldReferenceExpression (target, member.Name);
  242. } else if (member is MethodInfo) {
  243. CodeMethodInvokeExpression methodInvoke = new CodeMethodInvokeExpression (target, member.Name);
  244. if (descriptor.Arguments != null && descriptor.Arguments.Count > 0)
  245. methodInvoke.Parameters.AddRange (SerializeParameters (manager, descriptor.Arguments));
  246. expression = methodInvoke;
  247. } else if (member is ConstructorInfo) {
  248. CodeObjectCreateExpression createExpr = new CodeObjectCreateExpression (member.DeclaringType);
  249. if (descriptor.Arguments != null && descriptor.Arguments.Count > 0)
  250. createExpr.Parameters.AddRange (SerializeParameters (manager, descriptor.Arguments));
  251. expression = createExpr;
  252. }
  253. return expression;
  254. }
  255. private CodeExpression[] SerializeParameters (IDesignerSerializationManager manager, ICollection parameters)
  256. {
  257. CodeExpression[] expressions = null;
  258. if (parameters != null && parameters.Count > 0) {
  259. expressions = new CodeExpression[parameters.Count];
  260. int i = 0;
  261. foreach (object parameter in parameters) {
  262. expressions[i] = this.SerializeToExpression (manager, parameter);
  263. i++;
  264. }
  265. }
  266. return expressions;
  267. }
  268. protected void SerializeEvent (IDesignerSerializationManager manager, CodeStatementCollection statements,
  269. object value, EventDescriptor descriptor)
  270. {
  271. if (descriptor == null)
  272. throw new ArgumentNullException ("descriptor");
  273. if (value == null)
  274. throw new ArgumentNullException ("value");
  275. if (statements == null)
  276. throw new ArgumentNullException ("statements");
  277. if (manager == null)
  278. throw new ArgumentNullException ("manager");
  279. MemberCodeDomSerializer serializer = manager.GetSerializer (descriptor.GetType (), typeof (MemberCodeDomSerializer)) as MemberCodeDomSerializer;
  280. if (serializer != null && serializer.ShouldSerialize (manager, value, descriptor))
  281. serializer.Serialize (manager, value, descriptor, statements);
  282. }
  283. protected void SerializeEvents (IDesignerSerializationManager manager, CodeStatementCollection statements,
  284. object value, params Attribute[] filter)
  285. {
  286. if (filter == null)
  287. throw new ArgumentNullException ("filter");
  288. if (value == null)
  289. throw new ArgumentNullException ("value");
  290. if (statements == null)
  291. throw new ArgumentNullException ("statements");
  292. if (manager == null)
  293. throw new ArgumentNullException ("manager");
  294. EventDescriptorCollection events = TypeDescriptor.GetEvents (value, filter);
  295. foreach (EventDescriptor e in events)
  296. this.SerializeEvent (manager, statements, value, e);
  297. }
  298. protected void SerializeProperty (IDesignerSerializationManager manager, CodeStatementCollection statements,
  299. object value, PropertyDescriptor propertyToSerialize)
  300. {
  301. if (propertyToSerialize == null)
  302. throw new ArgumentNullException ("propertyToSerialize");
  303. if (value == null)
  304. throw new ArgumentNullException ("value");
  305. if (statements == null)
  306. throw new ArgumentNullException ("statements");
  307. if (manager == null)
  308. throw new ArgumentNullException ("manager");
  309. MemberCodeDomSerializer serializer = manager.GetSerializer (propertyToSerialize.GetType (),
  310. typeof (MemberCodeDomSerializer)) as MemberCodeDomSerializer;
  311. if (serializer != null && serializer.ShouldSerialize (manager, value, propertyToSerialize))
  312. serializer.Serialize (manager, value, propertyToSerialize, statements);
  313. }
  314. protected void SerializeProperties (IDesignerSerializationManager manager, CodeStatementCollection statements,
  315. object value, Attribute[] filter)
  316. {
  317. if (filter == null)
  318. throw new ArgumentNullException ("filter");
  319. if (value == null)
  320. throw new ArgumentNullException ("value");
  321. if (statements == null)
  322. throw new ArgumentNullException ("statements");
  323. if (manager == null)
  324. throw new ArgumentNullException ("manager");
  325. PropertyDescriptorCollection properties = TypeDescriptor.GetProperties (value, filter);
  326. foreach (PropertyDescriptor property in properties)
  327. this.SerializeProperty (manager, statements, value, property);
  328. }
  329. protected virtual object DeserializeInstance (IDesignerSerializationManager manager, Type type,
  330. object[] parameters, string name, bool addToContainer)
  331. {
  332. if (type == null)
  333. throw new ArgumentNullException ("type");
  334. if (manager == null)
  335. throw new ArgumentNullException ("manager");
  336. return manager.CreateInstance (type, parameters, name, addToContainer);
  337. }
  338. protected string GetUniqueName (IDesignerSerializationManager manager, object instance)
  339. {
  340. if (instance == null)
  341. throw new ArgumentNullException ("instance");
  342. if (manager == null)
  343. throw new ArgumentNullException ("manager");
  344. string name = manager.GetName (instance);
  345. if (name == null) {
  346. INameCreationService service = manager.GetService (typeof (INameCreationService)) as INameCreationService;
  347. name = service.CreateName (null, instance.GetType ());
  348. if (name == null)
  349. name = instance.GetType ().Name.ToLower ();
  350. manager.SetName (instance, name);
  351. }
  352. return name;
  353. }
  354. protected object DeserializeExpression (IDesignerSerializationManager manager, string name, CodeExpression expression)
  355. {
  356. if (expression == null)
  357. throw new ArgumentNullException ("expression");
  358. if (manager == null)
  359. throw new ArgumentNullException ("manager");
  360. bool errorOccurred = false;
  361. object deserialized = null;
  362. // CodeThisReferenceExpression
  363. //
  364. CodeThisReferenceExpression thisExpr = expression as CodeThisReferenceExpression;
  365. if (thisExpr != null) {
  366. RootContext context = manager.Context[typeof (RootContext)] as RootContext;
  367. if (context != null) {
  368. deserialized = context.Value;
  369. } else {
  370. IDesignerHost host = manager.GetService (typeof (IDesignerHost)) as IDesignerHost;
  371. if (host != null)
  372. deserialized = host.RootComponent;
  373. }
  374. }
  375. // CodeVariableReferenceExpression
  376. //
  377. CodeVariableReferenceExpression varRef = expression as CodeVariableReferenceExpression;
  378. if (deserialized == null && varRef != null) {
  379. deserialized = manager.GetInstance (varRef.VariableName);
  380. if (deserialized == null) {
  381. ReportError (manager, "Variable '" + varRef.VariableName + "' not initialized prior to reference");
  382. errorOccurred = true;
  383. }
  384. }
  385. // CodeFieldReferenceExpression
  386. //
  387. CodeFieldReferenceExpression fieldRef = expression as CodeFieldReferenceExpression;
  388. if (deserialized == null && fieldRef != null) {
  389. deserialized = manager.GetInstance (fieldRef.FieldName);
  390. if (deserialized == null) {
  391. ReportError (manager, "Field '" + fieldRef.FieldName + "' not initialized prior to reference");
  392. errorOccurred = true;
  393. }
  394. }
  395. // CodePrimitiveExpression
  396. //
  397. CodePrimitiveExpression primitiveExp = expression as CodePrimitiveExpression;
  398. if (deserialized == null && primitiveExp != null)
  399. deserialized = primitiveExp.Value;
  400. // CodePropertyReferenceExpression
  401. //
  402. CodePropertyReferenceExpression propRef = expression as CodePropertyReferenceExpression;
  403. if (deserialized == null && propRef != null) {
  404. object target = DeserializeExpression (manager, null, propRef.TargetObject);
  405. if (target != null && target != _errorMarker) {
  406. bool found = false;
  407. if (target is Type) {
  408. PropertyInfo property = ((Type)target).GetProperty (propRef.PropertyName,
  409. BindingFlags.GetProperty |
  410. BindingFlags.Public | BindingFlags.Static);
  411. if (property != null) {
  412. deserialized = property.GetValue (null, null);
  413. found = true;
  414. }
  415. // NRefactory seems to produce PropertyReferences to reference some fields and enums
  416. //
  417. FieldInfo field = ((Type)target).GetField (propRef.PropertyName,
  418. BindingFlags.GetField | BindingFlags.Public | BindingFlags.Static);
  419. if (field != null) {
  420. deserialized = field.GetValue (null);
  421. found = true;
  422. }
  423. } else {
  424. PropertyDescriptor property = TypeDescriptor.GetProperties (target)[propRef.PropertyName];
  425. if (property != null) {
  426. deserialized = property.GetValue (target);
  427. found = true;
  428. }
  429. FieldInfo field = target.GetType().GetField (propRef.PropertyName,
  430. BindingFlags.GetField | BindingFlags.Public | BindingFlags.Instance);
  431. if (field != null) {
  432. deserialized = field.GetValue (null);
  433. found = true;
  434. }
  435. }
  436. if (!found) {
  437. ReportError (manager, "Missing field '" + propRef.PropertyName + " 'in type " +
  438. (target is Type ? ((Type)target).Name : target.GetType ().Name) + "'");
  439. errorOccurred = true;
  440. }
  441. }
  442. }
  443. // CodeObjectCreateExpression
  444. //
  445. CodeObjectCreateExpression createExpr = expression as CodeObjectCreateExpression;
  446. if (deserialized == null && createExpr != null) {
  447. Type type = manager.GetType (createExpr.CreateType.BaseType);
  448. if (type == null) {
  449. ReportError (manager, "Type '" + createExpr.CreateType.BaseType + "' not found." +
  450. "Are you missing a reference?");
  451. errorOccurred = true;
  452. } else {
  453. object[] arguments = new object[createExpr.Parameters.Count];
  454. for (int i=0; i < createExpr.Parameters.Count; i++) {
  455. arguments[i] = this.DeserializeExpression (manager, null, createExpr.Parameters[i]);
  456. if (arguments[i] == _errorMarker) {
  457. errorOccurred = true;
  458. break;
  459. }
  460. }
  461. if (!errorOccurred) {
  462. bool addToContainer = false;
  463. if (typeof(IComponent).IsAssignableFrom (type))
  464. addToContainer = true;
  465. deserialized = this.DeserializeInstance (manager, type, arguments, name, addToContainer);
  466. if (deserialized == _errorMarker || deserialized == null) {
  467. string info = "Type to create: " + createExpr.CreateType.BaseType + System.Environment.NewLine +
  468. "Name: " + name + System.Environment.NewLine +
  469. "addToContainer: " + addToContainer.ToString () + System.Environment.NewLine +
  470. "Parameters Count: " + createExpr.Parameters.Count + System.Environment.NewLine;
  471. for (int i=0; i < arguments.Length; i++) {
  472. info += "Parameter Number: " + i.ToString () + System.Environment.NewLine +
  473. "Parameter Type: " + (arguments[i] == null ? "null" : arguments[i].GetType ().Name) +
  474. System.Environment.NewLine +
  475. "Parameter '" + i.ToString () + "' Value: " + arguments[i].ToString () + System.Environment.NewLine;
  476. }
  477. ReportError (manager,
  478. "Unable to create an instance of type '" + createExpr.CreateType.BaseType + "'",
  479. info);
  480. errorOccurred = true;
  481. }
  482. }
  483. }
  484. }
  485. // CodeArrayCreateExpression
  486. //
  487. CodeArrayCreateExpression arrayCreateExpr = expression as CodeArrayCreateExpression;
  488. if (deserialized == null && arrayCreateExpr != null) {
  489. Type arrayType = manager.GetType (arrayCreateExpr.CreateType.BaseType);
  490. if (arrayType == null) {
  491. ReportError (manager, "Type '" + arrayCreateExpr.CreateType.BaseType + "' not found." +
  492. "Are you missing a reference?");
  493. errorOccurred = true;
  494. } else {
  495. ArrayList initializers = new ArrayList ();
  496. Type elementType = arrayType.GetElementType ();
  497. deserialized = Array.CreateInstance (arrayType, arrayCreateExpr.Initializers.Count);
  498. for (int i = 0; i < arrayCreateExpr.Initializers.Count; i++) {
  499. object element = this.DeserializeExpression (manager, null, arrayCreateExpr.Initializers[i]);
  500. errorOccurred = (element == _errorMarker);
  501. if (!errorOccurred) {
  502. if (arrayType.IsInstanceOfType (element)) {
  503. initializers.Add (element);
  504. } else {
  505. ReportError (manager,
  506. "Array initializer element type incompatible with array type.",
  507. "Array Type: " + arrayType.Name + System.Environment.NewLine +
  508. "Array Element Type: " + elementType + System.Environment.NewLine +
  509. "Initializer Type: " + (element == null ? "null" : element.GetType ().Name));
  510. errorOccurred = true;
  511. }
  512. }
  513. }
  514. if (!errorOccurred)
  515. initializers.CopyTo ((Array)deserialized, 0);
  516. }
  517. }
  518. // CodeMethodInvokeExpression
  519. //
  520. CodeMethodInvokeExpression methodExpr = expression as CodeMethodInvokeExpression;
  521. if (deserialized == null && methodExpr != null) {
  522. object target = this.DeserializeExpression (manager, null, methodExpr.Method.TargetObject);
  523. object[] parameters = null;
  524. if (target == _errorMarker || target == null) {
  525. errorOccurred = true;
  526. } else {
  527. parameters = new object[methodExpr.Parameters.Count];
  528. for (int i=0; i < methodExpr.Parameters.Count; i++) {
  529. parameters[i] = this.DeserializeExpression (manager, null, methodExpr.Parameters[i]);
  530. if (parameters[i] == _errorMarker) {
  531. errorOccurred = true;
  532. break;
  533. }
  534. }
  535. }
  536. if (!errorOccurred) {
  537. MethodInfo method = null;
  538. if (target is Type) {
  539. method = GetExactMethod ((Type)target, methodExpr.Method.MethodName,
  540. BindingFlags.InvokeMethod | BindingFlags.Public | BindingFlags.Static,
  541. parameters);
  542. } else {
  543. method = GetExactMethod (target.GetType(), methodExpr.Method.MethodName,
  544. BindingFlags.InvokeMethod | BindingFlags.Public | BindingFlags.Instance,
  545. parameters);
  546. }
  547. if (method != null) {
  548. deserialized = method.Invoke (target, parameters);
  549. } else {
  550. string info =
  551. "Method Name: " + methodExpr.Method.MethodName + System.Environment.NewLine +
  552. "Method is: " + (target is Type ? "static" : "instance") + System.Environment.NewLine +
  553. "Method Holder Type: " + (target is Type ? ((Type)target).Name : target.GetType ().Name) + System.Environment.NewLine +
  554. "Parameters Count: " + methodExpr.Parameters.Count + System.Environment.NewLine +
  555. System.Environment.NewLine;
  556. for (int i = 0; i < parameters.Length; i++) {
  557. info += "Parameter Number: " + i.ToString () + System.Environment.NewLine +
  558. "Parameter Type: " + (parameters[i] == null ? "null" : parameters[i].GetType ().Name) +
  559. System.Environment.NewLine +
  560. "Parameter " + i.ToString () + " Value: " + parameters[i].ToString () + System.Environment.NewLine;
  561. }
  562. ReportError (manager,
  563. "Method '" + methodExpr.Method.MethodName + "' missing in type '" +
  564. (target is Type ? ((Type)target).Name : target.GetType ().Name + "'"),
  565. info);
  566. errorOccurred = true;
  567. }
  568. }
  569. }
  570. // CodeTypeReferenceExpression
  571. //
  572. CodeTypeReferenceExpression typeRef = expression as CodeTypeReferenceExpression;
  573. if (deserialized == null && typeRef != null) {
  574. deserialized = manager.GetType (typeRef.Type.BaseType);
  575. if (deserialized == null) {
  576. ReportError (manager, "Type '" + typeRef.Type.BaseType + "' not found." +
  577. "Are you missing a reference?");
  578. errorOccurred = true;
  579. }
  580. }
  581. // CodeCastExpression
  582. //
  583. CodeCastExpression castExpr = expression as CodeCastExpression;
  584. if (deserialized == null && castExpr != null) {
  585. Type targetType = manager.GetType (castExpr.TargetType.BaseType);
  586. object instance = DeserializeExpression (manager, null, castExpr.Expression);
  587. if (instance != null && instance != _errorMarker && targetType != null) {
  588. IConvertible convertible = instance as IConvertible;
  589. if (convertible != null) {
  590. try {
  591. instance = convertible.ToType (targetType, null);
  592. } catch {
  593. errorOccurred = true;
  594. }
  595. } else {
  596. errorOccurred = true;
  597. }
  598. if (errorOccurred) {
  599. ReportError (manager, "Unable to convert type '" + instance.GetType ().Name +
  600. "' to type '" + castExpr.TargetType.BaseType + "'",
  601. "Target Type: " + castExpr.TargetType.BaseType + System.Environment.NewLine +
  602. "Instance Type: " + (instance == null ? "null" : instance.GetType ().Name) + System.Environment.NewLine +
  603. "Instance Value: " + (instance == null ? "null" : instance.ToString()) + System.Environment.NewLine +
  604. "Instance is IConvertible: " + (instance is IConvertible).ToString());
  605. }
  606. deserialized = instance;
  607. }
  608. }
  609. // CodeBinaryOperatorExpression
  610. //
  611. CodeBinaryOperatorExpression binOperator = expression as CodeBinaryOperatorExpression;
  612. if (deserialized == null && binOperator != null) {
  613. string errorText = null;
  614. IConvertible left = null;
  615. IConvertible right = null;
  616. switch (binOperator.Operator) {
  617. case CodeBinaryOperatorType.BitwiseOr:
  618. left = DeserializeExpression (manager, null, binOperator.Left) as IConvertible;
  619. right = DeserializeExpression (manager, null, binOperator.Right) as IConvertible;
  620. if (left is Enum && right is Enum) {
  621. deserialized = Enum.ToObject (left.GetType (), Convert.ToInt64 (left) | Convert.ToInt64 (right));
  622. } else {
  623. errorText = "CodeBinaryOperatorType.BitwiseOr allowed only on Enum types";
  624. errorOccurred = true;
  625. }
  626. break;
  627. default:
  628. errorText = "Unsupported CodeBinaryOperatorType: " + binOperator.Operator.ToString ();
  629. errorOccurred = true;
  630. break;
  631. }
  632. if (errorOccurred) {
  633. string info = "BinaryOperator Type: " + binOperator.Operator.ToString() + System.Environment.NewLine +
  634. "Left Type: " + (left == null ? "null" : left.GetType().Name) + System.Environment.NewLine +
  635. "Left Value: " + (left == null ? "null" : left.ToString ()) + System.Environment.NewLine +
  636. "Left Expression Type: " + binOperator.Left.GetType ().Name + System.Environment.NewLine +
  637. "Right Type: " + (right == null ? "null" : right.GetType().Name) + System.Environment.NewLine +
  638. "Right Value: " + (right == null ? "null" : right.ToString ()) + System.Environment.NewLine +
  639. "Right Expression Type: " + binOperator.Right.GetType ().Name;
  640. ReportError (manager, errorText, info);
  641. }
  642. }
  643. if (!errorOccurred) {
  644. if (deserialized == null && !(expression is CodePrimitiveExpression) && !(expression is CodeMethodInvokeExpression)) {
  645. ReportError (manager, "Unsupported Expression Type: " + expression.GetType ().Name);
  646. errorOccurred = true;
  647. }
  648. }
  649. if (errorOccurred)
  650. return _errorMarker;
  651. else
  652. return deserialized;
  653. }
  654. // Searches for a method on type that matches argument types
  655. //
  656. private MethodInfo GetExactMethod (Type type, string methodName, BindingFlags flags, ICollection argsCollection)
  657. {
  658. object[] arguments = null;
  659. Type[] types = new Type[0];
  660. if (argsCollection != null) {
  661. arguments = new object[argsCollection.Count];
  662. types = new Type[argsCollection.Count];
  663. argsCollection.CopyTo (arguments, 0);
  664. for (int i=0; i < arguments.Length; i++) {
  665. if (arguments[i] == null)
  666. types[i] = null;
  667. else
  668. types[i] = arguments[i].GetType ();
  669. }
  670. }
  671. return type.GetMethod (methodName, flags, null, types, null);
  672. }
  673. protected void DeserializeStatement (IDesignerSerializationManager manager, CodeStatement statement)
  674. {
  675. if (statement == null)
  676. throw new ArgumentNullException ("statement");
  677. if (manager == null)
  678. throw new ArgumentNullException ("manager");
  679. // CodeAssignStatement
  680. //
  681. CodeAssignStatement assignment = statement as CodeAssignStatement;
  682. if (assignment != null)
  683. DeserializeAssignmentStatement (manager, assignment);
  684. // CodeExpressionStatement
  685. //
  686. CodeExpressionStatement expression = statement as CodeExpressionStatement;
  687. if (expression != null)
  688. this.DeserializeExpression (manager, null, expression.Expression);
  689. // CodeAttachEventStatement
  690. //
  691. CodeAttachEventStatement attachStatement = statement as CodeAttachEventStatement;
  692. if (attachStatement != null) {
  693. string methodName = null;
  694. CodeObjectCreateExpression createExpr = attachStatement.Listener as CodeObjectCreateExpression;
  695. if (createExpr != null && createExpr.Parameters.Count == 1 ) { // += new EventType (method)
  696. CodeMethodReferenceExpression handlerRef = createExpr.Parameters[0] as CodeMethodReferenceExpression;
  697. if (handlerRef != null)
  698. methodName = handlerRef.MethodName;
  699. }
  700. CodeDelegateCreateExpression delegateCreateExpr = attachStatement.Listener as CodeDelegateCreateExpression;
  701. if (delegateCreateExpr != null)// += new EventType (method)
  702. methodName = delegateCreateExpr.MethodName;
  703. CodeMethodReferenceExpression methodRef = attachStatement.Listener as CodeMethodReferenceExpression;
  704. if (methodRef != null) // += method
  705. methodName = methodRef.MethodName;
  706. object component = DeserializeExpression (manager, null, attachStatement.Event.TargetObject);
  707. if (component != null && component != _errorMarker && methodName != null) {
  708. string error = null;
  709. EventDescriptor eventDescriptor = TypeDescriptor.GetEvents (component)[attachStatement.Event.EventName];
  710. if (eventDescriptor != null) {
  711. IEventBindingService service = manager.GetService (typeof (IEventBindingService)) as IEventBindingService;
  712. if (service != null)
  713. service.GetEventProperty (eventDescriptor).SetValue (component, methodName);
  714. else
  715. error = "IEventBindingService missing";
  716. } else {
  717. error = "No event '" + attachStatement.Event.EventName +
  718. "' found in type '" + component.GetType ().Name + "'";
  719. }
  720. if (error != null) {
  721. ReportError (manager, error, "Method Name: " + methodName + System.Environment.NewLine +
  722. "Event Name: " + attachStatement.Event.EventName + System.Environment.NewLine +
  723. "Listener Expression Type: " + methodRef.GetType ().Name + System.Environment.NewLine +
  724. "Event Holder Type: " + component.GetType ().Name + System.Environment.NewLine +
  725. "Event Holder Expression Type: " + attachStatement.Event.TargetObject.GetType ().Name);
  726. }
  727. }
  728. }
  729. }
  730. private void DeserializeAssignmentStatement (IDesignerSerializationManager manager, CodeAssignStatement statement)
  731. {
  732. CodeExpression leftExpr = statement.Left;
  733. // Assign to a Property
  734. //
  735. CodePropertyReferenceExpression propRef = leftExpr as CodePropertyReferenceExpression;
  736. if (propRef != null) {
  737. object propertyHolder = DeserializeExpression (manager, null, propRef.TargetObject);
  738. object value = null;
  739. if (propertyHolder != null && propertyHolder != _errorMarker)
  740. value = DeserializeExpression (manager, null, statement.Right);
  741. if (value != null && value != _errorMarker && propertyHolder != null) {
  742. PropertyDescriptor property = TypeDescriptor.GetProperties (propertyHolder)[propRef.PropertyName];
  743. if (property != null) {
  744. property.SetValue (propertyHolder, value);
  745. } else {
  746. ReportError (manager,
  747. "Missing property '" + propRef.PropertyName +
  748. "' in type '" + propertyHolder.GetType ().Name + "'");
  749. }
  750. }
  751. }
  752. // Assign to a Field
  753. //
  754. CodeFieldReferenceExpression fieldRef = leftExpr as CodeFieldReferenceExpression;
  755. if (fieldRef != null && fieldRef.FieldName != null) {
  756. // Note that if the Right expression is a CodeCreationExpression the component will be created in this call
  757. //
  758. object fieldHolder = DeserializeExpression (manager, null, fieldRef.TargetObject);
  759. object value = null;
  760. if (fieldHolder != null && fieldHolder != _errorMarker)
  761. value = DeserializeExpression (manager, fieldRef.FieldName, statement.Right);
  762. FieldInfo field = null;
  763. RootContext context = manager.Context[typeof (RootContext)] as RootContext;
  764. if (fieldHolder != null && fieldHolder != _errorMarker && value != _errorMarker) {
  765. if (fieldRef.TargetObject is CodeThisReferenceExpression && context != null && context.Value == fieldHolder) {
  766. // Do not deserialize the fields of the root component, because the root component type
  767. // is actually an instance of the its parent type, e.g: CustomControl : _UserControl_
  768. // and thus it doesn't contain the fields. The trick is that once DeserializeExpression
  769. // is called on a CodeObjectCreateExpression the component is created and is added to the name-instance
  770. // table.
  771. //
  772. } else {
  773. if (fieldHolder is Type) // static field
  774. field = ((Type)fieldHolder).GetField (fieldRef.FieldName,
  775. BindingFlags.GetField | BindingFlags.Public | BindingFlags.Static);
  776. else // instance field
  777. field = fieldHolder.GetType().GetField (fieldRef.FieldName,
  778. BindingFlags.GetField | BindingFlags.Public | BindingFlags.Instance);
  779. if (field != null)
  780. field.SetValue (fieldHolder, value);
  781. else {
  782. ReportError (manager, "Field '" + fieldRef.FieldName + "' missing in type '" +
  783. fieldHolder.GetType ().Name + "'",
  784. "Field Name: " + fieldRef.FieldName + System.Environment.NewLine +
  785. "Field is: " + (fieldHolder is Type ? "static" : "instance") + System.Environment.NewLine +
  786. "Field Value: " + (value == null ? "null" : value.ToString()) + System.Environment.NewLine +
  787. "Field Holder Type: " + fieldHolder.GetType ().Name + System.Environment.NewLine +
  788. "Field Holder Expression Type: " + fieldRef.TargetObject.GetType ().Name);
  789. }
  790. }
  791. }
  792. }
  793. // Assign to a Variable
  794. //
  795. CodeVariableReferenceExpression varRef = leftExpr as CodeVariableReferenceExpression;
  796. if (varRef != null && varRef.VariableName != null) {
  797. object value = DeserializeExpression (manager, varRef.VariableName, statement.Right);
  798. // If .Right is not CodeObjectCreateExpression the instance won't be assigned a name,
  799. // so do it ourselves
  800. if (value != _errorMarker && manager.GetName (value) == null)
  801. manager.SetName (value, varRef.VariableName);
  802. }
  803. }
  804. internal void ReportError (IDesignerSerializationManager manager, string message)
  805. {
  806. this.ReportError (manager, message, "");
  807. }
  808. internal void ReportError (IDesignerSerializationManager manager, string message, string details)
  809. {
  810. try {
  811. throw new Exception (message);
  812. } catch (Exception e) {
  813. e.Data["Details"] = message + Environment.NewLine + Environment.NewLine + details;
  814. manager.ReportError (e);
  815. }
  816. }
  817. #region Resource Serialization - TODO
  818. protected CodeExpression SerializeToResourceExpression (IDesignerSerializationManager manager, object value)
  819. {
  820. throw new NotImplementedException ();
  821. }
  822. protected CodeExpression SerializeToResourceExpression (IDesignerSerializationManager manager, object value,
  823. bool ensureInvariant)
  824. {
  825. throw new NotImplementedException ();
  826. }
  827. protected void SerializePropertiesToResources (IDesignerSerializationManager manager, CodeStatementCollection statements,
  828. object value, Attribute[] filter)
  829. {
  830. throw new NotImplementedException ();
  831. }
  832. protected void SerializeResource (IDesignerSerializationManager manager, string resourceName, object value)
  833. {
  834. throw new NotImplementedException ();
  835. }
  836. protected void SerializeResourceInvariant (IDesignerSerializationManager manager, string resourceName, object value)
  837. {
  838. throw new NotImplementedException ();
  839. }
  840. protected void DeserializePropertiesFromResources (IDesignerSerializationManager manager, object value, Attribute[] filter)
  841. {
  842. throw new NotImplementedException ();
  843. }
  844. #endregion
  845. }
  846. }
  847. #endif