mcs/mcs/doc.cs

   1 //
   2 // doc.cs: Support for XML documentation comment.
   3 //
   4 // Author:
   5 //      Atsushi Enomoto <atsushi@ximian.com>
   6 //
   7 // Licensed under the terms of the GNU GPL
   8 //
   9 // (C) 2004 Novell, Inc.
  10 //
  11 //
  12
  13 #if ! BOOTSTRAP_WITH_OLDLIB
  14 using System;
  15 using System.Collections;
  16 using System.Collections.Specialized;
  17 using System.IO;
  18 using System.Reflection;
  19 using System.Reflection.Emit;
  20 using System.Runtime.CompilerServices;
  21 using System.Runtime.InteropServices;
  22 using System.Security;
  23 using System.Security.Permissions;
  24 using System.Text;
  25 using System.Xml;
  26
  27 using Mono.CompilerServices.SymbolWriter;
  28
  29 namespace Mono.CSharp {
  30
  31         //
  32         // Support class for XML documentation.
  33         //
  34         public class DocUtil
  35         {
  36                 // TypeContainer
  37
  38                 //
  39                 // Generates xml doc comments (if any), and if required,
  40                 // handle warning report.
  41                 //
  42                 internal static void GenerateTypeDocComment (TypeContainer t,
  43                         DeclSpace ds)
  44                 {
  45                         GenerateDocComment (t, ds);
  46
  47                         if (t.DefaultStaticConstructor != null)
  48                                 t.DefaultStaticConstructor.GenerateDocComment (t);
  49
  50                         if (t.InstanceConstructors != null)
  51                                 foreach (Constructor c in t.InstanceConstructors)
  52                                         c.GenerateDocComment (t);
  53
  54                         if (t.Types != null)
  55                                 foreach (TypeContainer tc in t.Types)
  56                                         tc.GenerateDocComment (t);
  57
  58                         if (t.Parts != null) {
  59                                 IDictionary comments = RootContext.Documentation.PartialComments;
  60                                 foreach (ClassPart cp in t.Parts) {
  61                                         if (cp.DocComment == null)
  62                                                 continue;
  63                                         comments [cp] = cp;
  64                                 }
  65                         }
  66
  67                         if (t.Enums != null)
  68                                 foreach (Enum en in t.Enums)
  69                                         en.GenerateDocComment (t);
  70
  71                         if (t.Constants != null)
  72                                 foreach (Const c in t.Constants)
  73                                         c.GenerateDocComment (t);
  74
  75                         if (t.Fields != null)
  76                                 foreach (Field f in t.Fields)
  77                                         f.GenerateDocComment (t);
  78
  79                         if (t.Events != null)
  80                                 foreach (Event e in t.Events)
  81                                         e.GenerateDocComment (t);
  82
  83                         if (t.Indexers != null)
  84                                 foreach (Indexer ix in t.Indexers)
  85                                         ix.GenerateDocComment (t);
  86
  87                         if (t.Properties != null)
  88                                 foreach (Property p in t.Properties)
  89                                         p.GenerateDocComment (t);
  90
  91                         if (t.Methods != null)
  92                                 foreach (Method m in t.Methods)
  93                                         m.GenerateDocComment (t);
  94
  95                         if (t.Operators != null)
  96                                 foreach (Operator o in t.Operators)
  97                                         o.GenerateDocComment (t);
  98                 }
  99
 100                 // MemberCore
 101                 private static readonly string lineHead =
 102                         Environment.NewLine + "            ";
 103
 104                 private static XmlNode GetDocCommentNode (MemberCore mc,
 105                         string name)
 106                 {
 107                         // FIXME: It could be even optimizable as not
 108                         // to use XmlDocument. But anyways the nodes
 109                         // are not kept in memory.
 110                         XmlDocument doc = RootContext.Documentation.XmlDocumentation;
 111                         try {
 112                                 XmlElement el = doc.CreateElement ("member");
 113                                 el.SetAttribute ("name", name);
 114                                 string normalized = mc.DocComment;
 115                                 el.InnerXml = normalized;
 116                                 // csc keeps lines as written in the sources
 117                                 // and inserts formatting indentation (which
 118                                 // is different from XmlTextWriter.Formatting
 119                                 // one), but when a start tag contains an
 120                                 // endline, it joins the next line. We don't
 121                                 // have to follow such a hacky behavior.
 122                                 string [] split =
 123                                         normalized.Split ('\n');
 124                                 int j = 0;
 125                                 for (int i = 0; i < split.Length; i++) {
 126                                         string s = split [i].TrimEnd ();
 127                                         if (s.Length > 0)
 128                                                 split [j++] = s;
 129                                 }
 130                                 el.InnerXml = lineHead + String.Join (
 131                                         lineHead, split, 0, j);
 132                                 return el;
 133                         } catch (XmlException ex) {
 134                                 Report.Warning (1570, 1, mc.Location, "XML comment on '{0}' has non-well-formed XML ({1}).", name, ex.Message);
 135                                 XmlComment com = doc.CreateComment (String.Format ("FIXME: Invalid documentation markup was found for member {0}", name));
 136                                 return com;
 137                         }
 138                 }
 139
 140                 //
 141                 // Generates xml doc comments (if any), and if required,
 142                 // handle warning report.
 143                 //
 144                 internal static void GenerateDocComment (MemberCore mc,
 145                         DeclSpace ds)
 146                 {
 147                         if (mc.DocComment != null) {
 148                                 string name = mc.GetDocCommentName (ds);
 149
 150                                 XmlNode n = GetDocCommentNode (mc, name);
 151
 152                                 XmlElement el = n as XmlElement;
 153                                 if (el != null) {
 154                                         mc.OnGenerateDocComment (ds, el);
 155
 156                                         // FIXME: it could be done with XmlReader
 157                                         foreach (XmlElement inc in n.SelectNodes (".//include"))
 158                                                 HandleInclude (mc, inc);
 159
 160                                         // FIXME: it could be done with XmlReader
 161                                         DeclSpace dsTarget = mc as DeclSpace;
 162                                         if (dsTarget == null)
 163                                                 dsTarget = ds;
 164
 165                                         foreach (XmlElement see in n.SelectNodes (".//see"))
 166                                                 HandleSee (mc, dsTarget, see);
 167                                         foreach (XmlElement seealso in n.SelectNodes (".//seealso"))
 168                                                 HandleSeeAlso (mc, dsTarget, seealso);
 169                                         foreach (XmlElement see in n.SelectNodes (".//exception"))
 170                                                 HandleException (mc, dsTarget, see);
 171                                 }
 172
 173                                 n.WriteTo (RootContext.Documentation.XmlCommentOutput);
 174                         }
 175                         else if (mc.IsExposedFromAssembly (ds)) {
 176                                 Constructor c = mc as Constructor;
 177                                 if (c == null || !c.IsDefault ())
 178                                         Report.Warning (1591, 4, mc.Location,
 179                                                 "Missing XML comment for publicly visible type or member '{0}'", mc.GetSignatureForError ());
 180                         }
 181                 }
 182
 183                 //
 184                 // Processes "include" element. Check included file and
 185                 // embed the document content inside this documentation node.
 186                 //
 187                 private static void HandleInclude (MemberCore mc, XmlElement el)
 188                 {
 189                         string file = el.GetAttribute ("file");
 190                         string path = el.GetAttribute ("path");
 191                         if (file == "") {
 192                                 Report.Warning (1590, 1, mc.Location, "Invalid XML 'include' element; Missing 'file' attribute.");
 193                                 el.ParentNode.InsertBefore (el.OwnerDocument.CreateComment (" Include tag is invalid "), el);
 194                         }
 195                         else if (path == "") {
 196                                 Report.Warning (1590, 1, mc.Location, "Invalid XML 'include' element; Missing 'path' attribute.");
 197                                 el.ParentNode.InsertBefore (el.OwnerDocument.CreateComment (" Include tag is invalid "), el);
 198                         }
 199                         else {
 200                                 XmlDocument doc = RootContext.Documentation.StoredDocuments [file] as XmlDocument;
 201                                 if (doc == null) {
 202                                         try {
 203                                                 doc = new XmlDocument ();
 204                                                 doc.Load (file);
 205                                                 RootContext.Documentation.StoredDocuments.Add (file, doc);
 206                                         } catch (Exception) {
 207                                                 el.ParentNode.InsertBefore (el.OwnerDocument.CreateComment (String.Format (" Badly formed XML in at comment file '{0}': cannot be included ", file)), el);
 208                                                 Report.Warning (1592, 1, mc.Location, "Badly formed XML in included comments file -- '{0}'", file);
 209                                         }
 210                                 }
 211                                 bool keepIncludeNode = false;
 212                                 if (doc != null) {
 213                                         try {
 214                                                 XmlNodeList nl = doc.SelectNodes (path);
 215                                                 if (nl.Count == 0) {
 216                                                         el.ParentNode.InsertBefore (el.OwnerDocument.CreateComment (" No matching elements were found for the include tag embedded here. "), el);
 217
 218                                                         keepIncludeNode = true;
 219                                                 }
 220                                                 foreach (XmlNode n in nl)
 221                                                         el.ParentNode.InsertBefore (el.OwnerDocument.ImportNode (n, true), el);
 222                                         } catch (Exception ex) {
 223                                                 el.ParentNode.InsertBefore (el.OwnerDocument.CreateComment (" Failed to insert some or all of included XML "), el);
 224                                                 Report.Warning (1589, 1, mc.Location, "Unable to include XML fragment '{0}' of file {1} -- {2}.", path, file, ex.Message);
 225                                         }
 226                                 }
 227                                 if (!keepIncludeNode)
 228                                         el.ParentNode.RemoveChild (el);
 229                         }
 230                 }
 231
 232                 //
 233                 // Handles <see> elements.
 234                 //
 235                 private static void HandleSee (MemberCore mc,
 236                         DeclSpace ds, XmlElement see)
 237                 {
 238                         HandleXrefCommon (mc, ds, see);
 239                 }
 240
 241                 //
 242                 // Handles <seealso> elements.
 243                 //
 244                 private static void HandleSeeAlso (MemberCore mc,
 245                         DeclSpace ds, XmlElement seealso)
 246                 {
 247                         HandleXrefCommon (mc, ds, seealso);
 248                 }
 249
 250                 //
 251                 // Handles <exception> elements.
 252                 //
 253                 private static void HandleException (MemberCore mc,
 254                         DeclSpace ds, XmlElement seealso)
 255                 {
 256                         HandleXrefCommon (mc, ds, seealso);
 257                 }
 258
 259                 static readonly char [] wsChars =
 260                         new char [] {' ', '\t', '\n', '\r'};
 261
 262                 //
 263                 // returns a full runtime type name from a name which might
 264                 // be C# specific type name.
 265                 //
 266                 private static Type FindDocumentedType (MemberCore mc, string name, DeclSpace ds, string cref)
 267                 {
 268                         bool isArray = false;
 269                         string identifier = name;
 270                         if (name [name.Length - 1] == ']') {
 271                                 string tmp = name.Substring (0, name.Length - 1).Trim (wsChars);
 272                                 if (tmp [tmp.Length - 1] == '[') {
 273                                         identifier = tmp.Substring (0, tmp.Length - 1).Trim (wsChars);
 274                                         isArray = true;
 275                                 }
 276                         }
 277                         Type t = FindDocumentedTypeNonArray (mc, identifier, ds, cref);
 278                         if (t != null && isArray)
 279                                 t = Array.CreateInstance (t, 0).GetType ();
 280                         return t;
 281                 }
 282
 283                 private static Type FindDocumentedTypeNonArray (MemberCore mc,
 284                         string identifier, DeclSpace ds, string cref)
 285                 {
 286                         switch (identifier) {
 287                         case "int":
 288                                 return typeof (int);
 289                         case "uint":
 290                                 return typeof (uint);
 291                         case "short":
 292                                 return typeof (short);
 293                         case "ushort":
 294                                 return typeof (ushort);
 295                         case "long":
 296                                 return typeof (long);
 297                         case "ulong":
 298                                 return typeof (ulong);
 299                         case "float":
 300                                 return typeof (float);
 301                         case "double":
 302                                 return typeof (double);
 303                         case "char":
 304                                 return typeof (char);
 305                         case "decimal":
 306                                 return typeof (decimal);
 307                         case "byte":
 308                                 return typeof (byte);
 309                         case "sbyte":
 310                                 return typeof (sbyte);
 311                         case "object":
 312                                 return typeof (object);
 313                         case "bool":
 314                                 return typeof (bool);
 315                         case "string":
 316                                 return typeof (string);
 317                         case "void":
 318                                 return typeof (void);
 319                         }
 320                         FullNamedExpression e = ds.LookupType (identifier, mc.Location, false);
 321                         if (e != null) {
 322                                 if (!(e is TypeExpr))
 323                                         return null;
 324                                 return ((TypeExpr) e).ResolveType (ds.EmitContext);
 325                         }
 326                         int index = identifier.LastIndexOf ('.');
 327                         if (index < 0)
 328                                 return null;
 329                         int warn;
 330                         Type parent = FindDocumentedType (mc, identifier.Substring (0, index), ds, cref);
 331                         if (parent == null)
 332                                 return null;
 333                         // no need to detect warning 419 here
 334                         return FindDocumentedMember (mc, parent,
 335                                 identifier.Substring (index + 1),
 336                                 emptyParamList,
 337                                 ds, out warn, cref) as Type;
 338                 }
 339
 340                 //
 341                 // Returns a MemberInfo that is referenced in XML documentation
 342                 // (by "see" or "seealso" elements).
 343                 //
 344                 private static MemberInfo FindDocumentedMember (MemberCore mc,
 345                         Type type, string memberName, Type [] paramList,
 346                         DeclSpace ds, out int warningType, string cref)
 347                 {
 348                         warningType = 0;
 349                         MethodSignature msig = new MethodSignature (memberName, null, paramList);
 350                         MemberInfo [] mis = type.FindMembers (
 351                                 MemberTypes.All,
 352                                 BindingFlags.Public | BindingFlags.NonPublic | BindingFlags.Static | BindingFlags.Instance,
 353                                 MethodSignature.method_signature_filter,
 354                                 msig);
 355                         if (mis.Length > 0) {
 356                                 if (mis.Length > 1)
 357                                         warningType = 419;
 358                                 return mis [0];
 359                         }
 360
 361                         if (paramList.Length == 0) {
 362                                 // search for fields/events etc.
 363                                 mis = type.FindMembers (
 364                                         MemberTypes.All,
 365                                         BindingFlags.Public | BindingFlags.NonPublic | BindingFlags.Static | BindingFlags.Instance,
 366                                         Type.FilterName,
 367                                         memberName);
 368                                 if (mis.Length == 0)
 369                                         return null;
 370                                 if (mis.Length > 1)
 371                                         warningType = 419;
 372                                 return mis [0];
 373                         }
 374
 375                         // search for operators (whose parameters exactly
 376                         // matches with the list) and possibly report CS1581.
 377                         string oper = null;
 378                         string returnTypeName = null;
 379                         if (memberName.StartsWith ("implicit operator ")) {
 380                                 oper = "op_Implicit";
 381                                 returnTypeName = memberName.Substring (18).Trim (wsChars);
 382                         }
 383                         else if (memberName.StartsWith ("explicit operator ")) {
 384                                 oper = "op_Explicit";
 385                                 returnTypeName = memberName.Substring (18).Trim (wsChars);
 386                         }
 387                         else if (memberName.StartsWith ("operator ")) {
 388                                 oper = memberName.Substring (9).Trim (wsChars);
 389                                 switch (oper) {
 390                                 // either unary or binary
 391                                 case "+":
 392                                         oper = paramList.Length == 2 ?
 393                                                 Binary.oper_names [(int) Binary.Operator.Addition] :
 394                                                 Unary.oper_names [(int) Unary.Operator.UnaryPlus];
 395                                         break;
 396                                 case "-":
 397                                         oper = paramList.Length == 2 ?
 398                                                 Binary.oper_names [(int) Binary.Operator.Subtraction] :
 399                                                 Unary.oper_names [(int) Unary.Operator.UnaryNegation];
 400                                         break;
 401                                 // unary
 402                                 case "!":
 403                                         oper = Unary.oper_names [(int) Unary.Operator.LogicalNot]; break;
 404                                 case "~":
 405                                         oper = Unary.oper_names [(int) Unary.Operator.OnesComplement]; break;
 406
 407                                 case "++":
 408                                         oper = "op_Increment"; break;
 409                                 case "--":
 410                                         oper = "op_Decrement"; break;
 411                                 case "true":
 412                                         oper = "op_True"; break;
 413                                 case "false":
 414                                         oper = "op_False"; break;
 415                                 // binary
 416                                 case "*":
 417                                         oper = Binary.oper_names [(int) Binary.Operator.Multiply]; break;
 418                                 case "/":
 419                                         oper = Binary.oper_names [(int) Binary.Operator.Division]; break;
 420                                 case "%":
 421                                         oper = Binary.oper_names [(int) Binary.Operator.Modulus]; break;
 422                                 case "&":
 423                                         oper = Binary.oper_names [(int) Binary.Operator.BitwiseAnd]; break;
 424                                 case "|":
 425                                         oper = Binary.oper_names [(int) Binary.Operator.BitwiseOr]; break;
 426                                 case "^":
 427                                         oper = Binary.oper_names [(int) Binary.Operator.ExclusiveOr]; break;
 428                                 case "<<":
 429                                         oper = Binary.oper_names [(int) Binary.Operator.LeftShift]; break;
 430                                 case ">>":
 431                                         oper = Binary.oper_names [(int) Binary.Operator.RightShift]; break;
 432                                 case "==":
 433                                         oper = Binary.oper_names [(int) Binary.Operator.Equality]; break;
 434                                 case "!=":
 435                                         oper = Binary.oper_names [(int) Binary.Operator.Inequality]; break;
 436                                 case "<":
 437                                         oper = Binary.oper_names [(int) Binary.Operator.LessThan]; break;
 438                                 case ">":
 439                                         oper = Binary.oper_names [(int) Binary.Operator.GreaterThan]; break;
 440                                 case "<=":
 441                                         oper = Binary.oper_names [(int) Binary.Operator.LessThanOrEqual]; break;
 442                                 case ">=":
 443                                         oper = Binary.oper_names [(int) Binary.Operator.GreaterThanOrEqual]; break;
 444                                 default:
 445                                         warningType = 1584;
 446                                         Report.Warning (1020, 1, mc.Location, "Overloadable {0} operator is expected", paramList.Length == 2 ? "binary" : "unary");
 447                                         Report.Warning (1584, 1, mc.Location, "XML comment on '{0}' has syntactically incorrect attribute '{1}'", mc.GetSignatureForError (), cref);
 448                                         return null;
 449                                 }
 450                         }
 451                         // here we still don't consider return type (to
 452                         // detect CS1581 or CS1002+CS1584).
 453                         msig = new MethodSignature (oper, null, paramList);
 454                         mis = type.FindMembers (
 455                                 MemberTypes.Method,
 456                                 BindingFlags.Public | BindingFlags.NonPublic | BindingFlags.Static,
 457                                 MethodSignature.method_signature_filter,
 458                                 msig);
 459                         if (mis.Length == 0)
 460                                 return null; // CS1574
 461                         MemberInfo mi = mis [0];
 462                         Type expected = mi is MethodInfo ?
 463                                 ((MethodInfo) mi).ReturnType :
 464                                 mi is PropertyInfo ?
 465                                 ((PropertyInfo) mi).PropertyType :
 466                                 null;
 467                         if (returnTypeName != null) {
 468                                 Type returnType = FindDocumentedType (mc, returnTypeName, ds, cref);
 469                                 if (returnType == null || returnType != expected) {
 470                                         warningType = 1581;
 471                                         Report.Warning (1581, 1, mc.Location, "Invalid return type in XML comment cref attribute '{0}'", cref);
 472                                         return null;
 473                                 }
 474                         }
 475                         return mis [0];
 476                 }
 477
 478                 private static Type [] emptyParamList = new Type [0];
 479
 480                 //
 481                 // Processes "see" or "seealso" elements.
 482                 // Checks cref attribute.
 483                 //
 484                 private static void HandleXrefCommon (MemberCore mc,
 485                         DeclSpace ds, XmlElement xref)
 486                 {
 487                         string cref = xref.GetAttribute ("cref").Trim (wsChars);
 488                         // when, XmlReader, "if (cref == null)"
 489                         if (!xref.HasAttribute ("cref"))
 490                                 return;
 491                         if (cref.Length == 0)
 492                                 Report.Warning (1001, 1, mc.Location, "Identifier expected");
 493                                 // ... and continue until CS1584.
 494
 495                         string signature; // "x:" are stripped
 496                         string name; // method invokation "(...)" are removed
 497                         string parameters; // method parameter list
 498
 499                         // strip 'T:' 'M:' 'F:' 'P:' 'E:' etc.
 500                         // Here, MS ignores its member kind. No idea why.
 501                         if (cref.Length > 2 && cref [1] == ':')
 502                                 signature = cref.Substring (2).Trim (wsChars);
 503                         else
 504                                 signature = cref;
 505
 506                         int parensPos = signature.IndexOf ('(');
 507                         if (parensPos > 0 && signature [signature.Length - 1] == ')') {
 508                                 name = signature.Substring (0, parensPos).Trim (wsChars);
 509                                 parameters = signature.Substring (parensPos + 1, signature.Length - parensPos - 2);
 510                         }
 511                         else {
 512                                 name = signature;
 513                                 parameters = String.Empty;
 514                         }
 515                         Normalize (mc, ref name);
 516
 517                         string identifier = name;
 518
 519                         if (name.Length > 0 && name [name.Length - 1] == ']') {
 520                                 string tmp = name.Substring (0, name.Length - 1).Trim (wsChars);
 521                                 if (tmp [tmp.Length - 1] == '[')
 522                                         identifier = tmp.Substring (0, tmp.Length - 1).Trim (wsChars);
 523                         }
 524
 525                         // Check if identifier is valid.
 526                         // This check is not necessary to mark as error, but
 527                         // csc specially reports CS1584 for wrong identifiers.
 528                         string [] nameElems = identifier.Split ('.');
 529                         for (int i = 0; i < nameElems.Length; i++) {
 530                                 string nameElem = nameElems [i];
 531                                 if (nameElem.EndsWith ("[]"))
 532                                         nameElem = nameElem.Substring (
 533                                                 nameElem.Length - 2);
 534                                 if (i > 0)
 535                                         Normalize (mc, ref nameElem);
 536                                 if (!Tokenizer.IsValidIdentifier (nameElem)
 537                                         && nameElem.IndexOf ("operator") < 0) {
 538                                         Report.Warning (1584, 1, mc.Location, "XML comment on '{0}' has syntactically incorrect attribute '{1}'", mc.GetSignatureForError (), cref);
 539                                         xref.SetAttribute ("cref", "!:" + signature);
 540                                         return;
 541                                 }
 542                         }
 543
 544                         // check if parameters are valid
 545                         Type [] parameterTypes = emptyParamList;
 546                         if (parameters.Length > 0) {
 547                                 string [] paramList = parameters.Split (',');
 548                                 ArrayList plist = new ArrayList ();
 549                                 for (int i = 0; i < paramList.Length; i++) {
 550                                         string paramTypeName = paramList [i].Trim (wsChars);
 551                                         Normalize (mc, ref paramTypeName);
 552                                         Type paramType = FindDocumentedType (mc, paramTypeName, ds, cref);
 553                                         if (paramType == null) {
 554                                                 Report.Warning (1580, 1, mc.Location, "Invalid type for parameter '{0}' in XML comment cref attribute '{1}'", i + 1, cref);
 555                                                 return;
 556                                         }
 557                                         plist.Add (paramType);
 558                                 }
 559                                 parameterTypes = plist.ToArray (typeof (Type)) as Type [];
 560                                 StringBuilder sb = new StringBuilder ();
 561                                 sb.Append ('(');
 562                                 for (int i = 0; i < parameterTypes.Length; i++) {
 563                                         Type t = parameterTypes [i];
 564                                         if (sb.Length > 1)
 565                                                 sb.Append (',');
 566                                         sb.Append (t.FullName.Replace ('+', '.'));
 567                                 }
 568                                 sb.Append (')');
 569                                 parameters = sb.ToString ();
 570                         }
 571
 572                         Type type = FindDocumentedType (mc, name, ds, cref);
 573                         if (type != null
 574                                 // delegate must not be referenced with args
 575                                 && (!type.IsSubclassOf (typeof (System.Delegate))
 576                                 || parameterTypes.Length == 0)) {
 577                                 xref.SetAttribute ("cref", "T:" + type.FullName.Replace ("+", "."));
 578                                 return; // a type
 579                         }
 580
 581                         // don't use identifier here. System[] is not alloed.
 582                         if (Namespace.IsNamespace (name)) {
 583                                 xref.SetAttribute ("cref", "N:" + name);
 584                                 return; // a namespace
 585                         }
 586
 587                         int period = name.LastIndexOf ('.');
 588                         if (period > 0) {
 589                                 string typeName = name.Substring (0, period);
 590                                 string memberName = name.Substring (period + 1);
 591                                 Normalize (mc, ref memberName);
 592                                 type = FindDocumentedType (mc, typeName, ds, cref);
 593                                 int warnResult;
 594                                 if (type != null) {
 595                                         MemberInfo mi = FindDocumentedMember (mc, type, memberName, parameterTypes, ds, out warnResult, cref);
 596                                         if (warnResult == 419)
 597                                                 Report419 (mc, memberName);
 598                                         else if (warnResult > 0)
 599                                                 return;
 600                                         if (mi != null) {
 601                                                 xref.SetAttribute ("cref", GetMemberDocHead (mi.MemberType) + type.FullName.Replace ("+", ".") + "." + memberName + parameters);
 602                                                 return; // a member of a type
 603                                         }
 604                                 }
 605                         }
 606                         else {
 607                                 int warnResult;
 608                                 MemberInfo mi = FindDocumentedMember (mc, ds.TypeBuilder, name, parameterTypes, ds, out warnResult, cref);
 609                                 if (warnResult == 419)
 610                                         Report419 (mc, name);
 611                                 else if (warnResult > 0)
 612                                         return;
 613                                 if (mi != null) {
 614                                         xref.SetAttribute ("cref", GetMemberDocHead (mi.MemberType) + ds.TypeBuilder.FullName.Replace ("+", ".") + "." + name);
 615                                         return; // local member name
 616                                 }
 617                         }
 618
 619                         Report.Warning (1574, 1, mc.Location, "XML comment on '{0}' has cref attribute '{1}' that could not be resolved in '{2}'.", mc.GetSignatureForError (), cref, ds.GetSignatureForError ());
 620
 621                         xref.SetAttribute ("cref", "!:" + name);
 622                 }
 623
 624                 static void Report419 (MemberCore mc, string memberName)
 625                 {
 626                         Report.Warning (419, 3, mc.Location, "Ambiguous member specification in cref attribute: '{0}'. Check overloaded members and supply exact parameters.", memberName);
 627                 }
 628
 629                 //
 630                 // Get a prefix from member type for XML documentation (used
 631                 // to formalize cref target name).
 632                 //
 633                 static string GetMemberDocHead (MemberTypes type)
 634                 {
 635                         switch (type) {
 636                         case MemberTypes.Constructor:
 637                         case MemberTypes.Method:
 638                                 return "M:";
 639                         case MemberTypes.Event:
 640                                 return "E:";
 641                         case MemberTypes.Field:
 642                                 return "F:";
 643                         case MemberTypes.NestedType:
 644                         case MemberTypes.TypeInfo:
 645                                 return "T:";
 646                         case MemberTypes.Property:
 647                                 return "P:";
 648                         }
 649                         return "!:";
 650                 }
 651
 652                 // MethodCore
 653
 654                 //
 655                 // Returns a string that represents the signature for this
 656                 // member which should be used in XML documentation.
 657                 //
 658                 public static string GetMethodDocCommentName (MethodCore mc, DeclSpace ds)
 659                 {
 660                         Parameter [] plist = mc.Parameters.FixedParameters;
 661                         Parameter parr = mc.Parameters.ArrayParameter;
 662                         string paramSpec = String.Empty;
 663                         if (plist != null) {
 664                                 StringBuilder psb = new StringBuilder ();
 665                                 foreach (Parameter p in plist) {
 666                                         psb.Append (psb.Length != 0 ? "," : "(");
 667                                         psb.Append (p.ParameterType.FullName.Replace ("+", "."));
 668                                 }
 669                                 paramSpec = psb.ToString ();
 670                         }
 671                         if (parr != null)
 672                                 paramSpec += String.Concat (
 673                                         paramSpec == String.Empty ? "(" : ",",
 674                                         parr.ParameterType.FullName.Replace ("+", "."));
 675
 676                         if (paramSpec.Length > 0)
 677                                 paramSpec += ")";
 678
 679                         string name = mc is Constructor ? "#ctor" : mc.Name;
 680                         string suffix = String.Empty;
 681                         Operator op = mc as Operator;
 682                         if (op != null) {
 683                                 switch (op.OperatorType) {
 684                                 case Operator.OpType.Implicit:
 685                                 case Operator.OpType.Explicit:
 686                                         suffix = "~" + op.OperatorMethodBuilder.ReturnType.FullName.Replace ('+', '.');
 687                                         break;
 688                                 }
 689                         }
 690                         return String.Concat (mc.DocCommentHeader, ds.Name, ".", name, paramSpec, suffix);
 691                 }
 692
 693                 //
 694                 // Raised (and passed an XmlElement that contains the comment)
 695                 // when GenerateDocComment is writing documentation expectedly.
 696                 //
 697                 // FIXME: with a few effort, it could be done with XmlReader,
 698                 // that means removal of DOM use.
 699                 //
 700                 internal static void OnMethodGenerateDocComment (
 701                         MethodCore mc, DeclSpace ds, XmlElement el)
 702                 {
 703                         Hashtable paramTags = new Hashtable ();
 704                         foreach (XmlElement pelem in el.SelectNodes ("param")) {
 705                                 int i;
 706                                 string xname = pelem.GetAttribute ("name");
 707                                 if (xname == "")
 708                                         continue; // really? but MS looks doing so
 709                                 if (xname != "" && mc.Parameters.GetParameterByName (xname, out i) == null)
 710                                         Report.Warning (1572, 2, mc.Location, "XML comment on '{0}' has a 'param' tag for '{1}', but there is no such parameter.", mc.Name, xname);
 711                                 else if (paramTags [xname] != null)
 712                                         Report.Warning (1571, 2, mc.Location, "XML comment on '{0}' has a duplicate param tag for '{1}'", mc.Name, xname);
 713                                 paramTags [xname] = xname;
 714                         }
 715                         Parameter [] plist = mc.Parameters.FixedParameters;
 716                         if (plist != null) {
 717                                 foreach (Parameter p in plist) {
 718                                         if (paramTags.Count > 0 && paramTags [p.Name] == null)
 719                                                 Report.Warning (1573, 4, mc.Location, "Parameter '{0}' has no matching param tag in the XML comment for '{1}' (but other parameters do)", mc.Name, p.Name);
 720                                 }
 721                         }
 722                 }
 723
 724                 // Enum
 725                 public static void GenerateEnumDocComment (Enum e, DeclSpace ds)
 726                 {
 727                         GenerateDocComment (e, ds);
 728                         foreach (string name in e.ordered_enums) {
 729                                 MemberCore mc = e.GetDefinition (name);
 730                                 GenerateDocComment (mc, e);
 731                         }
 732                 }
 733
 734                 private static void Normalize (MemberCore mc, ref string name)
 735                 {
 736                         if (name.Length > 0 && name [0] == '@')
 737                                 name = name.Substring (1);
 738                         else if (Tokenizer.IsKeyword (name) && !IsTypeName (name))
 739                                 Report.Warning (1041, 1, mc.Location, String.Format ("Identifier expected, '{0}' is a keyword", name));
 740                 }
 741
 742                 private static bool IsTypeName (string name)
 743                 {
 744                         switch (name) {
 745                         case "bool":
 746                         case "byte":
 747                         case "char":
 748                         case "decimal":
 749                         case "double":
 750                         case "float":
 751                         case "int":
 752                         case "long":
 753                         case "object":
 754                         case "sbyte":
 755                         case "short":
 756                         case "string":
 757                         case "uint":
 758                         case "ulong":
 759                         case "ushort":
 760                         case "void":
 761                                 return true;
 762                         }
 763                         return false;
 764                 }
 765         }
 766
 767         //
 768         // Implements XML documentation generation.
 769         //
 770         public class Documentation
 771         {
 772                 public Documentation (string xml_output_filename)
 773                 {
 774                         docfilename = xml_output_filename;
 775                         XmlDocumentation = new XmlDocument ();
 776                         XmlDocumentation.PreserveWhitespace = false;
 777                 }
 778
 779                 private string docfilename;
 780
 781                 //
 782                 // Used to create element which helps well-formedness checking.
 783                 //
 784                 public XmlDocument XmlDocumentation;
 785
 786                 //
 787                 // The output for XML documentation.
 788                 //
 789                 public XmlWriter XmlCommentOutput;
 790
 791                 //
 792                 // Stores XmlDocuments that are included in XML documentation.
 793                 // Keys are included filenames, values are XmlDocuments.
 794                 //
 795                 public Hashtable StoredDocuments = new Hashtable ();
 796
 797                 //
 798                 // Stores comments on partial types (should handle uniquely).
 799                 // Keys are PartialContainers, values are comment strings
 800                 // (didn't use StringBuilder; usually we have just 2 or more).
 801                 //
 802                 public IDictionary PartialComments = new ListDictionary ();
 803
 804                 //
 805                 // Outputs XML documentation comment from tokenized comments.
 806                 //
 807                 public bool OutputDocComment (string asmfilename)
 808                 {
 809                         XmlTextWriter w = null;
 810                         try {
 811                                 w = new XmlTextWriter (docfilename, null);
 812                                 w.Indentation = 4;
 813                                 w.Formatting = Formatting.Indented;
 814                                 w.WriteStartDocument ();
 815                                 w.WriteStartElement ("doc");
 816                                 w.WriteStartElement ("assembly");
 817                                 w.WriteStartElement ("name");
 818                                 w.WriteString (Path.ChangeExtension (asmfilename, null));
 819                                 w.WriteEndElement (); // name
 820                                 w.WriteEndElement (); // assembly
 821                                 w.WriteStartElement ("members");
 822                                 XmlCommentOutput = w;
 823                                 GenerateDocComment ();
 824                                 w.WriteFullEndElement (); // members
 825                                 w.WriteEndElement ();
 826                                 w.WriteWhitespace (Environment.NewLine);
 827                                 w.WriteEndDocument ();
 828                                 return true;
 829                         } catch (Exception ex) {
 830                                 Report.Error (1569, "Error generating XML documentation file '{0}' ('{1}')", docfilename, ex.Message);
 831                                 return false;
 832                         } finally {
 833                                 if (w != null)
 834                                         w.Close ();
 835                         }
 836                 }
 837
 838                 //
 839                 // Fixes full type name of each documented types/members up.
 840                 //
 841                 public void GenerateDocComment ()
 842                 {
 843                         TypeContainer root = RootContext.Tree.Types;
 844                         if (root.Interfaces != null)
 845                                 foreach (Interface i in root.Interfaces)
 846                                         DocUtil.GenerateTypeDocComment (i, null);
 847
 848                         if (root.Types != null)
 849                                 foreach (TypeContainer tc in root.Types)
 850                                         DocUtil.GenerateTypeDocComment (tc, null);
 851
 852                         if (root.Parts != null) {
 853                                 IDictionary comments = PartialComments;
 854                                 foreach (ClassPart cp in root.Parts) {
 855                                         if (cp.DocComment == null)
 856                                                 continue;
 857                                         comments [cp] = cp;
 858                                 }
 859                         }
 860
 861                         if (root.Delegates != null)
 862                                 foreach (Delegate d in root.Delegates)
 863                                         DocUtil.GenerateDocComment (d, null);
 864
 865                         if (root.Enums != null)
 866                                 foreach (Enum e in root.Enums)
 867                                         DocUtil.GenerateEnumDocComment (e, null);
 868
 869                         IDictionary table = new ListDictionary ();
 870                         foreach (ClassPart cp in PartialComments.Keys) {
 871                                 table [cp.PartialContainer] += cp.DocComment;
 872                         }
 873                         foreach (PartialContainer pc in table.Keys) {
 874                                 pc.DocComment = table [pc] as string;
 875                                 DocUtil.GenerateDocComment (pc, null);
 876                         }
 877                 }
 878         }
 879 }
 880
 881 #endif