Add the ability to link to members and constructors of other classes in Dartdoc.

utils/dartdoc/dartdoc.dart

 // Copyright (c) 2011, the Dart project authors.  Please see the AUTHORS file
 // for details. All rights reserved. Use of this source code is governed by a
 // BSD-style license that can be found in the LICENSE file.
 
 /**
  * To use it, from this directory, run:
  *
  *     $ ./dartdoc <path to .dart file>
  *
  * This will create a "docs" directory with the docs for your libraries. To
@@ skipping 773 matching lines @@
    */
   md.Node resolveNameReference(String name, [Member member = null,
       Type type = null, Library library = null]) {
     makeLink(String href) {
       final anchor = new md.Element.text('a', name);
       anchor.attributes['href'] = relativePath(href);
       anchor.attributes['class'] = 'crossref';
       return anchor;
     }
 
-    findMember(Type type) {
+    findMember(Type type, String name) {

[Bob Nystrom, 2012/01/10 00:40:41]

Shadowing name here, makes this already-confusing method even more confusing.
Can you rename one of them?

[nweiz, 2012/01/10 01:51:55]

Done.

       final member = type.members[name];
       if (member == null) return null;
 
       // Special case: if the member we've resolved is a property (i.e. it wraps
       // a getter and/or setter then *that* member itself won't be on the docs,
       // just the getter or setter will be. So pick one of those to link to.
       if (member.isProperty) {
         return member.canGet ? member.getter : member.setter;
       }
 
       return member;
     }
 
     // See if it's a parameter of the current method.
     if (member != null) {
       for (final parameter in member.parameters) {
         if (parameter.name == name) {
           final element = new md.Element.text('span', name);
           element.attributes['class'] = 'param';
           return element;
         }
       }
     }
 
     // See if it's another member of the current type.
     if (type != null) {
-      final member = findMember(type);
+      final member = findMember(type, name);
       if (member != null) {
         return makeLink(memberUrl(member));
       }
     }
 
-    // See if it's another type in the current library.
+    // See if it's another type or a member of another type in the current
+    // library.
     if (library != null) {
+      // See if it's a constructor
+      final constructorLink = (() {
+        if (!name.startsWith('new ')) return;
+        final classAndName = name.substring(4).split('.');

[Bob Nystrom, 2012/01/10 00:40:41]

I think a regex would be simpler here: 'new (\w+).(\w+)'.

[nweiz, 2012/01/10 01:51:55]

Done.

+        if (classAndName.length > 2) return;
+        final type = library.types[classAndName[0]];
+        if (type == null) return;
+        final constructor = type.getConstructor(
+            classAndName.length == 2 ? classAndName[1] : '');
+        if (constructor == null) return;
+        return makeLink(memberUrl(constructor));
+      })();

[Bob Nystrom, 2012/01/10 00:40:41]

This is clever, but perverse. :) If using a regex simplifies your control flow
enough that you don't need all of the early returns, I'd try to get rid of this.
Otherwise, maybe just make this a standalone method, or a local named function
that you call after defining.

[nweiz, 2012/01/10 01:51:55]

I had this as a local named function before this, but it felt spaghetti-esque
when reading the code, what with having to jump backwards to figure out what the
function was doing. I think this approach better captures the control flow I'm
trying to express, despite being somewhat unconventional.

+      if (constructorLink != null) return constructorLink;
+
+      // See if it's a member of another type
+      final foreignMemberLink = (() {
+        final nameAndMember = name.split('.');
+        if (nameAndMember.length != 2) return;
+        final type = library.types[nameAndMember[0]];
+        if (type == null) return;
+        final member = findMember(type, nameAndMember[1]);
+        if (member == null) return;
+        return makeLink(memberUrl(member));
+      })();
+      if (foreignMemberLink != null) return foreignMemberLink;
+
       final type = library.types[name];
       if (type != null) {
         return makeLink(typeUrl(type));
       }
 
       // See if it's a top-level member in the current library.
-      final member = findMember(library.topType);
+      final member = findMember(library.topType, name);
       if (member != null) {
         return makeLink(memberUrl(member));
       }
     }
 
     // TODO(rnystrom): Should also consider:
     // * Names imported by libraries this library imports.
     // * Type parameters of the enclosing type.
 
     return new md.Element.text('code', name);
   }
 
   // TODO(rnystrom): Move into SourceSpan?
   int getSpanColumn(SourceSpan span) {
     final line = span.file.getLine(span.start);
     return span.file.getColumn(line, span.start);
   }
 }