2 // parameter.cs: Parameter definition.
4 // Author: Miguel de Icaza (miguel@gnu.org)
5 // Marek Safar (marek.safar@seznam.cz)
7 // Licensed under the terms of the GNU GPL
9 // (C) 2001 Ximian, Inc (http://www.ximian.com)
14 using System.Reflection;
15 using System.Reflection.Emit;
16 using System.Collections;
19 namespace Mono.CSharp {
22 /// Abstract Base class for parameters of a method.
24 public abstract class ParameterBase : Attributable {
26 protected ParameterBuilder builder;
28 protected ParameterBase (Attributes attrs)
33 public override void ApplyAttributeBuilder (Attribute a, CustomAttributeBuilder cb)
35 if (a.Type == TypeManager.marshal_as_attr_type) {
36 UnmanagedMarshal marshal = a.GetMarshal (this);
37 if (marshal != null) {
38 builder.SetMarshal (marshal);
43 if (a.Type.IsSubclassOf (TypeManager.security_attr_type)) {
44 a.Error_InvalidSecurityParent ();
48 builder.SetCustomAttribute (cb);
51 public override bool IsClsComplianceRequired()
58 /// Class for applying custom attributes on the return type
60 public class ReturnParameter : ParameterBase {
61 public ReturnParameter (MethodBuilder mb, Location location):
65 builder = mb.DefineParameter (0, ParameterAttributes.None, "");
67 catch (ArgumentOutOfRangeException) {
68 Report.RuntimeMissingSupport (location, "custom attributes on the return type");
72 public override void ApplyAttributeBuilder(Attribute a, CustomAttributeBuilder cb)
74 if (a.Type == TypeManager.cls_compliant_attribute_type) {
75 Report.Warning (3023, 1, a.Location, "CLSCompliant attribute has no meaning when applied to return types. Try putting it on the method instead");
78 // This occurs after Warning -28
82 base.ApplyAttributeBuilder (a, cb);
85 public override AttributeTargets AttributeTargets {
87 return AttributeTargets.ReturnValue;
91 public override IResolveContext ResolveContext {
93 throw new NotSupportedException ();
100 public override string[] ValidAttributeTargets {
108 /// Class for applying custom attributes on the implicit parameter type
109 /// of the 'set' method in properties, and the 'add' and 'remove' methods in events.
112 // TODO: should use more code from Parameter.ApplyAttributeBuilder
113 public class ImplicitParameter : ParameterBase {
114 public ImplicitParameter (MethodBuilder mb):
117 builder = mb.DefineParameter (1, ParameterAttributes.None, "");
120 public override AttributeTargets AttributeTargets {
122 return AttributeTargets.Parameter;
126 public override IResolveContext ResolveContext {
128 throw new NotSupportedException ();
135 public override string[] ValidAttributeTargets {
142 public class ParamsParameter : Parameter {
143 public ParamsParameter (Expression type, string name, Attributes attrs, Location loc):
144 base (type, name, Parameter.Modifier.PARAMS, attrs, loc)
148 public override bool Resolve (IResolveContext ec)
150 if (!base.Resolve (ec))
153 if (!parameter_type.IsArray || parameter_type.GetArrayRank () != 1) {
154 Report.Error (225, Location, "The params parameter must be a single dimensional array");
160 public override void ApplyAttributes (MethodBuilder mb, ConstructorBuilder cb, int index)
162 base.ApplyAttributes (mb, cb, index);
164 CustomAttributeBuilder a = new CustomAttributeBuilder (
165 TypeManager.ConsParamArrayAttribute, new object [0]);
167 builder.SetCustomAttribute (a);
171 public class ArglistParameter : Parameter {
172 // Doesn't have proper type because it's never choosed for better conversion
173 public ArglistParameter () :
174 base (typeof (ArglistParameter), "", Parameter.Modifier.ARGLIST, null, Location.Null)
178 public override bool Resolve (IResolveContext ec)
183 public override string GetSignatureForError ()
190 /// Represents a single method parameter
192 public class Parameter : ParameterBase {
194 public enum Modifier : byte {
196 REF = REFMASK | ISBYREF,
197 OUT = OUTMASK | ISBYREF,
199 // This is a flag which says that it's either REF or OUT.
206 static string[] attribute_targets = new string [] { "param" };
208 public Expression TypeName;
209 public readonly Modifier ModFlags;
211 public bool IsCaptured;
212 protected Type parameter_type;
213 public readonly Location Location;
215 IResolveContext resolve_context;
218 public Variable Variable {
223 GenericConstraints constraints;
226 public Parameter (Expression type, string name, Modifier mod, Attributes attrs, Location loc)
235 public Parameter (Type type, string name, Modifier mod, Attributes attrs, Location loc)
240 parameter_type = type;
244 public override void ApplyAttributeBuilder (Attribute a, CustomAttributeBuilder cb)
246 if (a.Type == TypeManager.in_attribute_type && ModFlags == Modifier.OUT) {
247 Report.Error (36, a.Location, "An out parameter cannot have the `In' attribute");
251 if (a.Type == TypeManager.param_array_type) {
252 Report.Error (674, a.Location, "Do not use `System.ParamArrayAttribute'. Use the `params' keyword instead");
256 if (a.Type == TypeManager.out_attribute_type && (ModFlags & Modifier.REF) == Modifier.REF &&
257 !OptAttributes.Contains (TypeManager.in_attribute_type)) {
258 Report.Error (662, a.Location,
259 "Cannot specify only `Out' attribute on a ref parameter. Use both `In' and `Out' attributes or neither");
263 if (a.Type == TypeManager.cls_compliant_attribute_type) {
264 Report.Warning (3022, 1, a.Location, "CLSCompliant attribute has no meaning when applied to parameters. Try putting it on the method instead");
267 // TypeManager.default_parameter_value_attribute_type is null if !NET_2_0
268 if (a.Type == TypeManager.default_parameter_value_attribute_type) {
269 object val = a.GetParameterDefaultValue ();
271 Type t = val.GetType ();
272 if (t.IsArray || TypeManager.IsSubclassOf (t, TypeManager.type_type)) {
273 if (parameter_type == TypeManager.object_type) {
275 t = TypeManager.type_type;
277 Report.Error (1910, a.Location, "Argument of type `{0}' is not applicable for the DefaultValue attribute",
278 TypeManager.CSharpName (t));
280 Report.Error (1909, a.Location, "The DefaultValue attribute is not applicable on parameters of type `{0}'",
281 TypeManager.CSharpName (parameter_type)); ;
287 if (parameter_type == TypeManager.object_type ||
288 (val == null && !TypeManager.IsValueType (parameter_type)) ||
289 (val != null && TypeManager.TypeToCoreType (val.GetType ()) == parameter_type))
290 builder.SetConstant (val);
292 Report.Error (1908, a.Location, "The type of the default value should match the type of the parameter");
296 base.ApplyAttributeBuilder (a, cb);
299 public override IResolveContext ResolveContext {
301 return resolve_context;
306 // Resolve is used in method definitions
308 public virtual bool Resolve (IResolveContext ec)
310 if (parameter_type != null)
313 this.resolve_context = ec;
315 TypeExpr texpr = TypeName.ResolveAsTypeTerminal (ec, false);
320 TypeParameterExpr tparam = texpr as TypeParameterExpr;
322 constraints = tparam.TypeParameter.Constraints;
325 parameter_type = texpr.Type;
327 if (parameter_type.IsAbstract && parameter_type.IsSealed) {
328 Report.Error (721, Location, "`{0}': static types cannot be used as parameters", GetSignatureForError ());
332 if (parameter_type == TypeManager.void_type){
333 Report.Error (1536, Location, "Invalid parameter type 'void'");
337 if ((ModFlags & Parameter.Modifier.ISBYREF) != 0){
338 if (parameter_type == TypeManager.typed_reference_type ||
339 parameter_type == TypeManager.arg_iterator_type){
340 Report.Error (1601, Location, "Method or delegate parameter cannot be of type `{0}'",
341 GetSignatureForError ());
349 public void ResolveVariable (ToplevelBlock toplevel, int idx)
351 if (toplevel.RootScope != null)
352 var = toplevel.RootScope.GetCapturedParameter (this);
354 var = new ParameterVariable (this, idx);
357 public Type ExternalType ()
359 if ((ModFlags & Parameter.Modifier.ISBYREF) != 0)
360 return TypeManager.GetReferenceType (parameter_type);
362 return parameter_type;
365 public Type ParameterType {
367 return parameter_type;
372 public GenericConstraints GenericConstraints {
379 public ParameterAttributes Attributes {
383 return ParameterAttributes.None;
385 return ParameterAttributes.None;
387 return ParameterAttributes.Out;
388 case Modifier.PARAMS:
392 return ParameterAttributes.None;
396 public static ParameterAttributes GetParameterAttributes (Modifier mod)
398 int flags = ((int) mod) & ~((int) Parameter.Modifier.ISBYREF);
399 switch ((Modifier) flags) {
401 return ParameterAttributes.None;
403 return ParameterAttributes.None;
405 return ParameterAttributes.Out;
406 case Modifier.PARAMS:
410 return ParameterAttributes.None;
413 public override AttributeTargets AttributeTargets {
415 return AttributeTargets.Parameter;
419 public virtual string GetSignatureForError ()
422 if (parameter_type != null)
423 type_name = TypeManager.CSharpName (parameter_type);
425 type_name = TypeName.GetSignatureForError ();
427 string mod = GetModifierSignature (ModFlags);
429 return String.Concat (mod, ' ', type_name);
434 public static string GetModifierSignature (Modifier mod)
439 case Modifier.PARAMS:
443 case Modifier.ARGLIST:
450 public void IsClsCompliant ()
452 if (AttributeTester.IsClsCompliant (ExternalType ()))
455 Report.Error (3001, Location, "Argument type `{0}' is not CLS-compliant", GetSignatureForError ());
458 public virtual void ApplyAttributes (MethodBuilder mb, ConstructorBuilder cb, int index)
460 #if !GMCS_SOURCE || !MS_COMPATIBLE
461 // TODO: It should use mb.DefineGenericParameters
463 builder = cb.DefineParameter (index, Attributes, Name);
465 builder = mb.DefineParameter (index, Attributes, Name);
468 if (OptAttributes != null)
469 OptAttributes.Emit ();
472 public override string[] ValidAttributeTargets {
474 return attribute_targets;
478 protected class ParameterVariable : Variable
480 public readonly Parameter Parameter;
481 public readonly int Idx;
482 public readonly bool IsRef;
484 public ParameterVariable (Parameter par, int idx)
486 this.Parameter = par;
488 this.IsRef = (par.ModFlags & Parameter.Modifier.ISBYREF) != 0;
491 public override Type Type {
492 get { return Parameter.ParameterType; }
495 public override bool HasInstance {
496 get { return false; }
499 public override bool NeedsTemporary {
500 get { return false; }
503 public override void EmitInstance (EmitContext ec)
507 public override void Emit (EmitContext ec)
510 if (!ec.MethodIsStatic)
513 ParameterReference.EmitLdArg (ec.ig, arg_idx);
516 public override void EmitAssign (EmitContext ec)
519 if (!ec.MethodIsStatic)
523 ec.ig.Emit (OpCodes.Starg_S, (byte) arg_idx);
525 ec.ig.Emit (OpCodes.Starg, arg_idx);
528 public override void EmitAddressOf (EmitContext ec)
532 if (!ec.MethodIsStatic)
537 ec.ig.Emit (OpCodes.Ldarg_S, (byte) arg_idx);
539 ec.ig.Emit (OpCodes.Ldarg, arg_idx);
542 ec.ig.Emit (OpCodes.Ldarga_S, (byte) arg_idx);
544 ec.ig.Emit (OpCodes.Ldarga, arg_idx);
552 /// Represents the methods parameters
554 public class Parameters : ParameterData {
555 // Null object pattern
556 public Parameter [] FixedParameters;
557 public readonly bool HasArglist;
561 public static readonly Parameters EmptyReadOnlyParameters = new Parameters ();
562 static readonly Parameter ArgList = new ArglistParameter ();
565 public readonly TypeParameter[] TypeParameters;
568 private Parameters ()
570 FixedParameters = new Parameter[0];
571 types = new Type [0];
574 public Parameters (Parameter[] parameters, Type[] types)
576 FixedParameters = parameters;
578 count = types.Length;
581 public Parameters (Parameter[] parameters)
583 if (parameters == null)
584 throw new ArgumentException ("Use EmptyReadOnlyPatameters");
586 FixedParameters = parameters;
587 count = parameters.Length;
590 public Parameters (Parameter[] parameters, bool has_arglist):
593 HasArglist = has_arglist;
597 /// Use this method when you merge compiler generated argument with user arguments
599 public static Parameters MergeGenerated (Parameters userParams, params Parameter[] compilerParams)
601 Parameter[] all_params = new Parameter [userParams.count + compilerParams.Length];
602 Type[] all_types = new Type[all_params.Length];
603 userParams.FixedParameters.CopyTo(all_params, 0);
604 userParams.Types.CopyTo (all_types, 0);
606 int last_filled = userParams.Count;
607 foreach (Parameter p in compilerParams) {
608 for (int i = 0; i < last_filled; ++i) {
609 while (p.Name == all_params [i].Name) {
610 p.Name = '_' + p.Name;
613 all_params [last_filled] = p;
614 all_types [last_filled] = p.ParameterType;
618 return new Parameters (all_params, all_types);
629 return HasArglist ? count + 1 : count;
638 for (int i = 0; i < count; i++){
639 string base_name = FixedParameters [i].Name;
640 for (int j = i + 1; j < count; j++){
641 if (base_name != FixedParameters [j].Name)
644 Report.Error (100, FixedParameters [i].Location,
645 "The parameter name `{0}' is a duplicate", base_name);
654 /// Returns the paramenter information based on the name
656 public Parameter GetParameterByName (string name, out int idx)
665 foreach (Parameter par in FixedParameters){
666 if (par.Name == name){
675 public Parameter GetParameterByName (string name)
679 return GetParameterByName (name, out idx);
682 public bool Resolve (IResolveContext ec)
687 types = new Type [count];
694 for (int i = 0; i < FixedParameters.Length; ++i) {
695 p = FixedParameters [i];
696 if (!p.Resolve (ec)) {
700 types [i] = p.ExternalType ();
706 public void ResolveVariable (ToplevelBlock toplevel)
708 for (int i = 0; i < FixedParameters.Length; ++i) {
709 Parameter p = FixedParameters [i];
710 p.ResolveVariable (toplevel, i);
714 public CallingConventions CallingConvention
718 return CallingConventions.VarArgs;
720 return CallingConventions.Standard;
724 // Define each type attribute (in/out/ref) and
725 // the argument names.
726 public void ApplyAttributes (MethodBase builder)
731 MethodBuilder mb = builder as MethodBuilder;
732 ConstructorBuilder cb = builder as ConstructorBuilder;
734 for (int i = 0; i < FixedParameters.Length; i++) {
735 FixedParameters [i].ApplyAttributes (mb, cb, i + 1);
739 public void VerifyClsCompliance ()
741 foreach (Parameter p in FixedParameters)
745 public string GetSignatureForError ()
747 StringBuilder sb = new StringBuilder ("(");
749 for (int i = 0; i < FixedParameters.Length; ++i) {
750 sb.Append (FixedParameters[i].GetSignatureForError ());
751 if (i < FixedParameters.Length - 1)
759 sb.Append ("__arglist");
763 return sb.ToString ();
766 public Type[] Types {
772 public Parameter this [int pos]
775 if (pos >= count && (HasArglist || HasParams)) {
776 if (HasArglist && (pos == 0 || pos >= count))
781 return FixedParameters [pos];
785 #region ParameterData Members
787 public Type ParameterType (int pos)
789 return this [pos].ExternalType ();
792 public bool HasParams {
797 for (int i = count; i != 0; --i) {
798 if ((FixedParameters [i - 1].ModFlags & Parameter.Modifier.PARAMS) != 0)
805 public string ParameterName (int pos)
807 return this [pos].Name;
810 public string ParameterDesc (int pos)
812 return this [pos].GetSignatureForError ();
815 public Parameter.Modifier ParameterModifier (int pos)
817 return this [pos].ModFlags;