Catergorized classes to abstract, class, typedef, and error/exception

pkg/docgen/lib/docgen.dart

 // Copyright (c) 2013, 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.
 
 /**
  * **docgen** is a tool for creating machine readable representations of Dart
  * code metadata, including: classes, members, comments and annotations.
  *
  * docgen is run on a `.dart` file or a directory containing `.dart` files.
  *
@@ skipping 342 matching lines @@
           'constructors' : constructors,
           'operators' : operators,
           'methods' : methods};
 } 
 
 /**
  * Returns a map of [Class] objects constructed from inputted mirrors.
  */
 Map<String, Class> _getClasses(Map<String, ClassMirror> mirrorMap,
     bool includePrivate) {
-  var data = {};
+  
+  var abstract = {};
+  var classes = {};
+  var typedefs = {};
+  var errors = {};
+  
   mirrorMap.forEach((String mirrorName, ClassMirror mirror) {
     if (includePrivate || !mirror.isPrivate) {
-      _currentClass = mirror;
       var superclass = (mirror.superclass != null) ?
           mirror.superclass.qualifiedName : '';
       var interfaces =
           mirror.superinterfaces.map((interface) => interface.qualifiedName);
-      data[mirrorName] = new Class(mirrorName, superclass, mirror.isAbstract, 
-          mirror.isTypedef, _getComment(mirror), interfaces.toList(),
-          _getVariables(mirror.variables, includePrivate),
+      var clazz = new Class(mirrorName, superclass, _getComment(mirror), 
+          interfaces.toList(), _getVariables(mirror.variables, includePrivate),
           _getMethods(mirror.methods, includePrivate),
           _getAnnotations(mirror), mirror.qualifiedName);
+      _currentClass = mirror;
+      
+      if (isError(mirror.qualifiedName)) {
+        errors[mirrorName] = clazz;
+      } else if (mirror.isTypedef) {
+        typedefs[mirrorName] = clazz;
+      } else if (mirror.isAbstract) {
+        abstract[mirrorName] = clazz;
+      } else if (mirror.isClass) {
+        classes[mirrorName] = clazz;
+      } else {
+        throw new StateError('$mirrorName - no class tyle match. ');

[Bob Nystrom, 2013/07/18 17:08:07]

"tyle" -> "style".

Also, throw ArgumentError instead of StateError.

+      }
     }
   });
-  return data;
+  return {'abstract' : abstract, 
+          'class' : classes,
+          'typedef' : typedefs,
+          'error' : errors};

[Bob Nystrom, 2013/07/18 17:08:07]

A couple of style nits: no space before ":", and put the items and the closing
"}" on their own lines, like:

return {
  'abstract': abstract,
  ...
};

 }
 
 /**
  * Returns a map of [Parameter] objects constructed from inputted mirrors.
  */
 Map<String, Parameter> _getParameters(List<ParameterMirror> mirrorList) {
   var data = {};
   mirrorList.forEach((ParameterMirror mirror) {
     _currentMember = mirror;
     data[mirror.simpleName] = new Parameter(mirror.simpleName, 
@@ skipping 28 matching lines @@
   inputMap.forEach((key, value) {
     if (value is Map) {
       outputMap[key] = recurseMap(value);
     } else {
       outputMap[key] = value.toMap();
     }
   });
   return outputMap;
 }
 
+bool isError(String qualifiedName) {
+  return qualifiedName.toLowerCase().contains('error') || 
+      qualifiedName.toLowerCase().contains('exception');
+}
+
 /**
  * A class representing all programming constructs, like library or class. 
  */
 class IndexableItem {
   IndexableItem(String qualifiedName) {
     qualifiedNameIndex.add(qualifiedName);
   }
 }
 
 /**
@@ skipping 45 matching lines @@
   List<String> interfaces;
 
   /// Top-level variables in the class.
   Map<String, Variable> variables;
 
   /// Methods in the class.
   Map<String, Map<String, Method>> methods;
   
   String name;
   String superclass;
-  bool isAbstract;
-  bool isTypedef;
 
   /// List of the meta annotations on the class.
   List<String> annotations;
   
-  Class(this.name, this.superclass, this.isAbstract, this.isTypedef, 
-      this.comment, this.interfaces, this.variables, this.methods, 
-      this.annotations, String qualifiedName) : super(qualifiedName) {}
+  Class(this.name, this.superclass, this.comment, this.interfaces, 
+      this.variables, this.methods, this.annotations, 
+      String qualifiedName) : super(qualifiedName) {}
 
   /// Generates a map describing the [Class] object.
   Map toMap() {
     var classMap = {};
     classMap['name'] = name;
     classMap['comment'] = comment;
     classMap['superclass'] = superclass;
-    classMap['abstract'] = isAbstract.toString();
-    classMap['typedef'] = isTypedef.toString();
     classMap['implements'] = new List.from(interfaces);
     classMap['variables'] = recurseMap(variables);
     classMap['methods'] = recurseMap(methods);
     classMap['annotations'] = new List.from(annotations);
     return classMap;
   }
 }
 
 /**
  * A class containing properties of a Dart variable.
@@ skipping 86 matching lines @@
     parameterMap['name'] = name;
     parameterMap['optional'] = isOptional.toString();
     parameterMap['named'] = isNamed.toString();
     parameterMap['default'] = hasDefaultValue.toString();
     parameterMap['type'] = type;
     parameterMap['value'] = defaultValue;
     parameterMap['annotations'] = new List.from(annotations);
     return parameterMap;
   }
 }