"Reverting 25035"

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.
  *
  *      $ dart docgen.dart [OPTIONS] [FILE/DIR]
  *
  * This creates files called `docs/<library_name>.yaml` in your current
  * working directory.
  */
 library docgen;
 
 import 'dart:io';
 import 'dart:json';
 import 'dart:async';
 
 import 'package:logging/logging.dart';
 import 'package:markdown/markdown.dart' as markdown;
-import 'package:pathos/path.dart' as path;
+import 'package:path/path.dart' as path;
 
 import 'dart2yaml.dart';
 import 'src/io.dart';
 import '../../../sdk/lib/_internal/compiler/compiler.dart' as api;
 import '../../../sdk/lib/_internal/compiler/implementation/filenames.dart';
 import '../../../sdk/lib/_internal/compiler/implementation/mirrors/dart2js_mirror.dart'
     as dart2js;
 import '../../../sdk/lib/_internal/compiler/implementation/mirrors/mirrors.dart';
 import '../../../sdk/lib/_internal/compiler/implementation/mirrors/mirrors_util.dart';
 import '../../../sdk/lib/_internal/compiler/implementation/source_file_provider.dart';
@@ skipping 224 matching lines @@
       CommentInstanceMirror comment = metadata;
       if (comment.isDocComment) {
         if (commentText == null) {
           commentText = comment.trimmedText;
         } else {
           commentText = '$commentText ${comment.trimmedText}';
         }
       }
     }
   });
-  
-  commentText = commentText == null ? '' : 
-      markdown.markdownToHtml(commentText.trim(), linkResolver: linkResolver);
+  commentText = commentText == null ? '' :
+      markdown.markdownToHtml(commentText.trim(), linkResolver: linkResolver)
+      .replaceAll('\n', ' ');
   return commentText;
 }
 
 /**
  * Converts all [foo] references in comments to <a>libraryName.foo</a>.
  */
 markdown.Node fixReference(String name, LibraryMirror currentLibrary,
     ClassMirror currentClass, MemberMirror currentMember) {
   var reference;
   var memberScope = currentMember == null ?
@@ skipping 11 matching lines @@
  * Returns a map of [Variable] objects constructed from inputted mirrors.
  */
 Map<String, Variable> _getVariables(Map<String, VariableMirror> mirrorMap,
     bool includePrivate) {
   var data = {};
   // TODO(janicejl): When map to map feature is created, replace the below with
   // a filter. Issue(#9590).
   mirrorMap.forEach((String mirrorName, VariableMirror mirror) {
     if (includePrivate || !mirror.isPrivate) {
       _currentMember = mirror;
-      data[mirrorName] = new Variable(mirrorName, mirror.isFinal, 
-          mirror.isStatic, mirror.type.qualifiedName, _getComment(mirror), 
-          _getAnnotations(mirror));
+      data[mirrorName] = new Variable(mirrorName, mirror.qualifiedName,
+          mirror.isFinal, mirror.isStatic, mirror.type.qualifiedName,
+          _getComment(mirror), _getAnnotations(mirror));
     }
   });
   return data;
 }
 
 /**
  * Returns a map of [Method] objects constructed from inputted mirrors.
  */
-Map<String, Map<String, Method>> _getMethods
-    (Map<String, MethodMirror> mirrorMap, bool includePrivate) {
-
-  var setters = {};
-  var getters = {};
-  var constructors = {};
-  var operators = {};
-  var methods = {};
-  
+Map<String, Method> _getMethods(Map<String, MethodMirror> mirrorMap,
+    bool includePrivate) {
+  var data = {};
   mirrorMap.forEach((String mirrorName, MethodMirror mirror) {
     if (includePrivate || !mirror.isPrivate) {
-      var method = new Method(mirrorName, mirror.isStatic, 
-          mirror.returnType.qualifiedName, _getComment(mirror), 
-          _getParameters(mirror.parameters), _getAnnotations(mirror));
       _currentMember = mirror;
-      if (mirror.isSetter) {
-        setters[mirrorName] = method;
-      } else if (mirror.isGetter) {
-        getters[mirrorName] = method;
-      } else if (mirror.isConstructor) {
-        constructors[mirrorName] = method;
-      } else if (mirror.isOperator) {
-        operators[mirrorName] = method;
-      } else if (mirror.isRegularMethod) {
-         methods[mirrorName] = method;
-      } else {
-        throw new StateError('${mirror.qualifiedName} - no method type match');
-      }
+      data[mirrorName] = new Method(mirrorName, mirror.qualifiedName,
+          mirror.isSetter, mirror.isGetter, mirror.isConstructor,
+          mirror.isOperator, mirror.isStatic, mirror.returnType.qualifiedName,
+          _getComment(mirror), _getParameters(mirror.parameters),
+          _getAnnotations(mirror));
     }
   });
-  return {'setters' : setters,
-          'getters' : getters,
-          'constructors' : constructors,
-          'operators' : operators,
-          'methods' : methods};
-} 
+  return data;
+}
 
 /**
  * Returns a map of [Class] objects constructed from inputted mirrors.
  */
 Map<String, Class> _getClasses(Map<String, ClassMirror> mirrorMap,
     bool includePrivate) {
   var data = {};
   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(),
+      data[mirrorName] = new Class(mirrorName, mirror.qualifiedName,
+          superclass, mirror.isAbstract, mirror.isTypedef,
+          _getComment(mirror), interfaces.toList(),
           _getVariables(mirror.variables, includePrivate),
           _getMethods(mirror.methods, includePrivate),
           _getAnnotations(mirror));
     }
   });
   return data;
 }
 
 /**
  * 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, 
-        mirror.isOptional, mirror.isNamed, mirror.hasDefaultValue, 
-        mirror.type.qualifiedName, mirror.defaultValue, 
-        _getAnnotations(mirror));
+    data[mirror.simpleName] = new Parameter(mirror.simpleName,
+        mirror.qualifiedName, mirror.isOptional, mirror.isNamed,
+        mirror.hasDefaultValue, mirror.type.qualifiedName,
+        mirror.defaultValue, _getAnnotations(mirror));
   });
   return data;
 }
 
 /**
  * Writes text to a file in the 'docs' directory.
  */
 void _writeToFile(String text, String filename) {
   Directory dir = new Directory('docs');
   if (!dir.existsSync()) {
     dir.createSync();
   }
   File file = new File('docs/$filename');
   if (!file.existsSync()) {
     file.createSync();
   }
   file.openSync();
   file.writeAsString(text);
 }
 
 /**
  * Transforms the map by calling toMap on each value in it.
  */
 Map recurseMap(Map inputMap) {
   var outputMap = {};
   inputMap.forEach((key, value) {
-    if (value is Map) {
-      outputMap[key] = recurseMap(value);
-    } else {
-      outputMap[key] = value.toMap();
-    }
+    outputMap[key] = value.toMap();
   });
   return outputMap;
 }
 
 /**
  * A class containing contents of a Dart library.
  */
 class Library {
 
   /// Documentation comment with converted markdown.
   String comment;
 
   /// Top-level variables in the library.
   Map<String, Variable> variables;
 
   /// Top-level functions in the library.
-  Map<String, Map<String, Method>> functions;
-  
+  Map<String, Method> functions;
+
   /// Classes defined within the library
   Map<String, Class> classes;
 
   String name;
 
   Library(this.name, this.comment, this.variables,
       this.functions, this.classes);
 
   /// Generates a map describing the [Library] object.
   Map toMap() {
@@ skipping 16 matching lines @@
   /// Documentation comment with converted markdown.
   String comment;
 
   /// List of the names of interfaces that this class implements.
   List<String> interfaces;
 
   /// Top-level variables in the class.
   Map<String, Variable> variables;
 
   /// Methods in the class.
-  Map<String, Map<String, Method>> methods;
-  
+  Map<String, Method> methods;
+
   String name;
+  String qualifiedName;
   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);
+
+  Class(this.name, this.qualifiedName, this.superclass, this.isAbstract,
+      this.isTypedef, this.comment, this.interfaces, this.variables,
+      this.methods, this.annotations);
 
   /// Generates a map describing the [Class] object.
   Map toMap() {
     var classMap = {};
     classMap['name'] = name;
+    classMap['qualifiedname'] = qualifiedName;
     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.
  */
 class Variable {
 
   /// Documentation comment with converted markdown.
   String comment;
 
   String name;
+  String qualifiedName;
   bool isFinal;
   bool isStatic;
   String type;
 
   /// List of the meta annotations on the variable.
   List<String> annotations;
-  
-  Variable(this.name, this.isFinal, this.isStatic, this.type, this.comment, 
-      this.annotations);
-  
+
+  Variable(this.name, this.qualifiedName, this.isFinal, this.isStatic,
+      this.type, this.comment, this.annotations);
+
   /// Generates a map describing the [Variable] object.
   Map toMap() {
     var variableMap = {};
     variableMap['name'] = name;
+    variableMap['qualifiedname'] = qualifiedName;
     variableMap['comment'] = comment;
     variableMap['final'] = isFinal.toString();
     variableMap['static'] = isStatic.toString();
     variableMap['type'] = type;
     variableMap['annotations'] = new List.from(annotations);
     return variableMap;
   }
 }
 
 /**
  * A class containing properties of a Dart method.
  */
 class Method {
 
   /// Documentation comment with converted markdown.
   String comment;
 
   /// Parameters for this method.
   Map<String, Parameter> parameters;
 
   String name;
+  String qualifiedName;
+  bool isSetter;
+  bool isGetter;
+  bool isConstructor;
+  bool isOperator;
   bool isStatic;
   String returnType;
 
   /// List of the meta annotations on the method.
   List<String> annotations;
-  
-  Method(this.name, this.isStatic, this.returnType, this.comment, 
-      this.parameters, this.annotations);
-  
+
+  Method(this.name, this.qualifiedName, this.isSetter, this.isGetter,
+      this.isConstructor, this.isOperator, this.isStatic, this.returnType,
+      this.comment, this.parameters, this.annotations);
+
   /// Generates a map describing the [Method] object.
   Map toMap() {
     var methodMap = {};
     methodMap['name'] = name;
+    methodMap['qualifiedname'] = qualifiedName;
     methodMap['comment'] = comment;
+    methodMap['type'] = isSetter ? 'setter' : isGetter ? 'getter' :
+      isOperator ? 'operator' : isConstructor ? 'constructor' : 'method';
     methodMap['static'] = isStatic.toString();
     methodMap['return'] = returnType;
     methodMap['parameters'] = recurseMap(parameters);
     methodMap['annotations'] = new List.from(annotations);
     return methodMap;
   }
 }
 
 /**
  * A class containing properties of a Dart method/function parameter.
  */
 class Parameter {
 
   String name;
+  String qualifiedName;
   bool isOptional;
   bool isNamed;
   bool hasDefaultValue;
   String type;
   String defaultValue;
 
   /// List of the meta annotations on the parameter.
   List<String> annotations;
-  
-  Parameter(this.name, this.isOptional, this.isNamed, this.hasDefaultValue, 
-      this.type, this.defaultValue, this.annotations);
-  
+
+  Parameter(this.name, this.qualifiedName, this.isOptional, this.isNamed,
+      this.hasDefaultValue, this.type, this.defaultValue, this.annotations);
+
   /// Generates a map describing the [Parameter] object.
   Map toMap() {
     var parameterMap = {};
     parameterMap['name'] = name;
+    parameterMap['qualifiedname'] = qualifiedName;
     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;
   }
 }