ProtoMemberAttribute.cs 8.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237
  1. using System;
  2. #if FEAT_IKVM
  3. using Type = IKVM.Reflection.Type;
  4. using IKVM.Reflection;
  5. #else
  6. using System.Reflection;
  7. #endif
  8. namespace ProtoBuf
  9. {
  10. /// <summary>
  11. /// Declares a member to be used in protocol-buffer serialization, using
  12. /// the given Tag. A DataFormat may be used to optimise the serialization
  13. /// format (for instance, using zigzag encoding for negative numbers, or
  14. /// fixed-length encoding for large values.
  15. /// </summary>
  16. [AttributeUsage(AttributeTargets.Property | AttributeTargets.Field,
  17. AllowMultiple = false, Inherited = true)]
  18. public class ProtoMemberAttribute : Attribute
  19. , IComparable
  20. #if !NO_GENERICS
  21. , IComparable<ProtoMemberAttribute>
  22. #endif
  23. {
  24. /// <summary>
  25. /// Compare with another ProtoMemberAttribute for sorting purposes
  26. /// </summary>
  27. public int CompareTo(object other) { return CompareTo(other as ProtoMemberAttribute); }
  28. /// <summary>
  29. /// Compare with another ProtoMemberAttribute for sorting purposes
  30. /// </summary>
  31. public int CompareTo(ProtoMemberAttribute other)
  32. {
  33. if (other == null) return -1;
  34. if ((object)this == (object)other) return 0;
  35. int result = this.tag.CompareTo(other.tag);
  36. if (result == 0) result = string.CompareOrdinal(this.name, other.name);
  37. return result;
  38. }
  39. /// <summary>
  40. /// Creates a new ProtoMemberAttribute instance.
  41. /// </summary>
  42. /// <param name="tag">Specifies the unique tag used to identify this member within the type.</param>
  43. public ProtoMemberAttribute(int tag) : this(tag, false)
  44. { }
  45. internal ProtoMemberAttribute(int tag, bool forced)
  46. {
  47. if (tag <= 0 && !forced) throw new ArgumentOutOfRangeException("tag");
  48. this.tag = tag;
  49. }
  50. #if !NO_RUNTIME
  51. internal MemberInfo Member, BackingMember;
  52. internal bool TagIsPinned;
  53. #endif
  54. /// <summary>
  55. /// Gets or sets the original name defined in the .proto; not used
  56. /// during serialization.
  57. /// </summary>
  58. public string Name { get { return name; } set { name = value; } }
  59. private string name;
  60. /// <summary>
  61. /// Gets or sets the data-format to be used when encoding this value.
  62. /// </summary>
  63. public DataFormat DataFormat { get { return dataFormat; } set { dataFormat = value; } }
  64. private DataFormat dataFormat;
  65. /// <summary>
  66. /// Gets the unique tag used to identify this member within the type.
  67. /// </summary>
  68. public int Tag { get { return tag; } }
  69. private int tag;
  70. internal void Rebase(int tag) { this.tag = tag; }
  71. public string TypeName { get { return typeName; } set { typeName = value; } }
  72. private string typeName;
  73. /// <summary>
  74. /// Gets or sets a value indicating whether this member is mandatory.
  75. /// </summary>
  76. public bool IsRequired {
  77. get { return (options & MemberSerializationOptions.Required) == MemberSerializationOptions.Required; }
  78. set {
  79. if (value) options |= MemberSerializationOptions.Required;
  80. else options &= ~MemberSerializationOptions.Required;
  81. }
  82. }
  83. /// <summary>
  84. /// Gets a value indicating whether this member is packed.
  85. /// This option only applies to list/array data of primitive types (int, double, etc).
  86. /// </summary>
  87. public bool IsPacked
  88. {
  89. get { return (options & MemberSerializationOptions.Packed) == MemberSerializationOptions.Packed;}
  90. set {
  91. if (value) options |= MemberSerializationOptions.Packed;
  92. else options &= ~MemberSerializationOptions.Packed;
  93. }
  94. }
  95. /// <summary>
  96. /// Indicates whether this field should *repace* existing values (the default is false, meaning *append*).
  97. /// This option only applies to list/array data.
  98. /// </summary>
  99. public bool OverwriteList
  100. {
  101. get { return (options & MemberSerializationOptions.OverwriteList) == MemberSerializationOptions.OverwriteList; }
  102. set
  103. {
  104. if (value) options |= MemberSerializationOptions.OverwriteList;
  105. else options &= ~MemberSerializationOptions.OverwriteList;
  106. }
  107. }
  108. /// <summary>
  109. /// Enables full object-tracking/full-graph support.
  110. /// </summary>
  111. public bool AsReference
  112. {
  113. get { return (options & MemberSerializationOptions.AsReference) == MemberSerializationOptions.AsReference; }
  114. set
  115. {
  116. if (value) options |= MemberSerializationOptions.AsReference;
  117. else options &= ~MemberSerializationOptions.AsReference;
  118. options |= MemberSerializationOptions.AsReferenceHasValue;
  119. }
  120. }
  121. internal bool AsReferenceHasValue
  122. {
  123. get { return (options & MemberSerializationOptions.AsReferenceHasValue) == MemberSerializationOptions.AsReferenceHasValue; }
  124. set {
  125. if (value) options |= MemberSerializationOptions.AsReferenceHasValue;
  126. else options &= ~MemberSerializationOptions.AsReferenceHasValue;
  127. }
  128. }
  129. /// <summary>
  130. /// Embeds the type information into the stream, allowing usage with types not known in advance.
  131. /// </summary>
  132. public bool DynamicType
  133. {
  134. get { return (options & MemberSerializationOptions.DynamicType) == MemberSerializationOptions.DynamicType; }
  135. set
  136. {
  137. if (value) options |= MemberSerializationOptions.DynamicType;
  138. else options &= ~MemberSerializationOptions.DynamicType;
  139. }
  140. }
  141. /// <summary>
  142. /// Gets or sets a value indicating whether this member is packed (lists/arrays).
  143. /// </summary>
  144. public MemberSerializationOptions Options { get { return options; } set { options = value; } }
  145. private MemberSerializationOptions options;
  146. }
  147. /// <summary>
  148. /// Additional (optional) settings that control serialization of members
  149. /// </summary>
  150. [Flags]
  151. public enum MemberSerializationOptions
  152. {
  153. /// <summary>
  154. /// Default; no additional options
  155. /// </summary>
  156. None = 0,
  157. /// <summary>
  158. /// Indicates that repeated elements should use packed (length-prefixed) encoding
  159. /// </summary>
  160. Packed = 1,
  161. /// <summary>
  162. /// Indicates that the given item is required
  163. /// </summary>
  164. Required = 2,
  165. /// <summary>
  166. /// Enables full object-tracking/full-graph support
  167. /// </summary>
  168. AsReference = 4,
  169. /// <summary>
  170. /// Embeds the type information into the stream, allowing usage with types not known in advance
  171. /// </summary>
  172. DynamicType = 8,
  173. /// <summary>
  174. /// Indicates whether this field should *repace* existing values (the default is false, meaning *append*).
  175. /// This option only applies to list/array data.
  176. /// </summary>
  177. OverwriteList = 16,
  178. /// <summary>
  179. /// Determines whether the types AsReferenceDefault value is used, or whether this member's AsReference should be used
  180. /// </summary>
  181. AsReferenceHasValue = 32
  182. }
  183. /// <summary>
  184. /// Declares a member to be used in protocol-buffer serialization, using
  185. /// the given Tag and MemberName. This allows ProtoMemberAttribute usage
  186. /// even for partial classes where the individual members are not
  187. /// under direct control.
  188. /// A DataFormat may be used to optimise the serialization
  189. /// format (for instance, using zigzag encoding for negative numbers, or
  190. /// fixed-length encoding for large values.
  191. /// </summary>
  192. [AttributeUsage(AttributeTargets.Class,
  193. AllowMultiple = true, Inherited = false)]
  194. public sealed class ProtoPartialMemberAttribute : ProtoMemberAttribute
  195. {
  196. /// <summary>
  197. /// Creates a new ProtoMemberAttribute instance.
  198. /// </summary>
  199. /// <param name="tag">Specifies the unique tag used to identify this member within the type.</param>
  200. /// <param name="memberName">Specifies the member to be serialized.</param>
  201. public ProtoPartialMemberAttribute(int tag, string memberName)
  202. : base(tag)
  203. {
  204. #if !NO_RUNTIME
  205. if (Helpers.IsNullOrEmpty(memberName)) throw new ArgumentNullException("memberName");
  206. #endif
  207. this.memberName = memberName;
  208. }
  209. /// <summary>
  210. /// The name of the member to be serialized.
  211. /// </summary>
  212. public string MemberName { get { return memberName; } }
  213. private readonly string memberName;
  214. }
  215. }