write a JSON index of all elements

Author: sethladd

lib/src/html_generator.dart

@@ -5,7 +5,8 @@
 library dartdoc.html_generator;
 
 import 'dart:async' show Future;
-import 'dart:io';
+import 'dart:io' show Directory, File;
+import 'dart:convert' show JSON;
 import 'dart:typed_data' show Uint8List;
 
 import 'package:mustache4dart/mustache4dart.dart';
@@ -17,6 +18,7 @@ import 'resources.g.dart' as resources;
 import '../generator.dart';
 import '../markdown_processor.dart';
 import '../resource_loader.dart' as loader;
+import 'io_utils.dart' show createOutputFile;
 
 String dartdocVersion = 'unknown';
 
@@ -156,7 +158,7 @@ class HtmlGeneratorInstance {
   final Package package;
   final Directory out;
 
-  final List<String> _htmlFiles = [];
+  final List<ModelElement> documentedElements = [];
 
   HtmlGeneratorInstance(this.url, this._templates, this.package, this.out);
 
@@ -166,13 +168,25 @@ class HtmlGeneratorInstance {
 
     if (package != null) {
       _generateDocs();
+      _generateJson();
+      // TODO: generate sitemap
     }
 
-    //if (url != null) generateSiteMap();
-
     await _copyResources();
   }
 
+  void _generateJson() {
+    File jsonFile = createOutputFile(out, 'index.json');
+    String json = JSON.encode(documentedElements.map((ModelElement e) {
+      Map data = {'name': e.name, 'href': e.href};
+      if (e is EnclosedElement) {
+        data['enclosedElementName'] =
+            (e as EnclosedElement).enclosingElement.name;
+      }
+    }).toList());
+    jsonFile.writeAsStringSync(json);
+  }
+
   void _generateDocs() {
     if (package == null) return;
 
@@ -354,22 +368,16 @@ class HtmlGeneratorInstance {
     }
   }
 
-  File _createOutputFile(String filename) {
-    File f = new File(path.join(out.path, filename));
-    if (!f.existsSync()) f.createSync(recursive: true);
-    _htmlFiles.add(filename);
-    return f;
-  }
-
   void _build(String filename, TemplateRenderer template, TemplateData data) {
     String content = template(data,
         assumeNullNonExistingProperty: false, errorOnMissingProperty: true);
 
     _writeFile(filename, content);
+    if (data.self is ModelElement) documentedElements.add(data.self);
   }
 
   void _writeFile(String filename, String content) {
-    File f = _createOutputFile(filename);
+    File f = createOutputFile(out, filename);
     f.writeAsStringSync(content);
   }
 }

lib/src/io_utils.dart

@@ -9,6 +9,12 @@ import 'dart:io';
 
 import 'package:path/path.dart' as path;
 
+File createOutputFile(Directory destination, String filename) {
+  File f = new File(path.join(destination.path, filename));
+  if (!f.existsSync()) f.createSync(recursive: true);
+  return f;
+}
+
 /// Lists the contents of [dir].
 ///
 /// If [recursive] is `true`, lists subdirectory contents (defaults to `false`).

lib/src/model.dart

@@ -5,19 +5,21 @@
 /// The models used to represent Dart code
 library dartdoc.models;
 
-import 'package:analyzer/src/generated/ast.dart';
+import 'package:analyzer/src/generated/ast.dart' show AnnotatedNode, Annotation;
 import 'package:analyzer/src/generated/element.dart';
-import 'package:analyzer/src/generated/resolver.dart';
+import 'package:analyzer/src/generated/resolver.dart'
+    show Namespace, NamespaceBuilder, InheritanceManager, MemberMap;
 import 'package:analyzer/src/generated/utilities_dart.dart' show ParameterKind;
-import 'package:quiver/core.dart';
+import 'package:quiver/core.dart' show hash3;
 
-import 'html_utils.dart';
-import 'model_utils.dart';
-import 'package_meta.dart';
+import 'html_utils.dart' show stripComments, htmlEscape;
+import 'model_utils.dart' show isPrivate, isPublic, getAllSupertypes;
+import 'package_meta.dart' show PackageMeta, FileContents;
 
-import '../markdown_processor.dart';
+import '../markdown_processor.dart' show Documentation, renderMarkdownToHtml;
 
-int byName(a, b) => a.name.toUpperCase().compareTo(b.name.toUpperCase());
+int byName(Nameable a, Nameable b) =>
+    a.name.toUpperCase().compareTo(b.name.toUpperCase());
 
 final Map<Class, List<Class>> _implementors = new Map();
 
@@ -48,7 +50,19 @@ void _addToImplementors(Class c) {
   }
 }
 
-abstract class ModelElement implements Comparable {
+/// An element that is enclosed by some other element.
+///
+/// Libraries are not enclosed.
+abstract class EnclosedElement {
+  ModelElement get enclosingElement;
+}
+
+/// Something that has a name.
+abstract class Nameable {
+  String get name;
+}
+
+abstract class ModelElement implements Comparable, Nameable {
   final Element element;
   final Library library;
 
@@ -359,14 +373,17 @@ abstract class ModelElement implements Comparable {
   }
 }
 
+// TODO: how do we get rid of this class?
 class Dynamic extends ModelElement {
   Dynamic(DynamicElementImpl element, Library library)
       : super(element, library);
 
+  ModelElement get enclosingElement => throw new UnsupportedError('');
+
   String get _href => throw new StateError('dynamic should not have an href');
 }
 
-class Package {
+class Package implements Nameable {
   final List<Library> _libraries = [];
   final PackageMeta packageMeta;
   String _docsAsHtml;
@@ -503,6 +520,9 @@ class Library extends ModelElement {
     return library;
   }
 
+  /// Libraries are not enclosed by anything.
+  ModelElement get enclosingElement => null;
+
   Library get library => this;
 
   Iterable<Element> get _exportedNamespace {
@@ -729,7 +749,7 @@ class Library extends ModelElement {
   String get _href => '$dirName/$fileName';
 }
 
-class Class extends ModelElement {
+class Class extends ModelElement implements EnclosedElement {
   List<ElementType> _mixins;
   ElementType _supertype;
   List<ElementType> _interfaces;
@@ -797,6 +817,9 @@ class Class extends ModelElement {
     }).where((it) => it != null).toList(growable: false);
   }
 
+  /// Returns the library that encloses this element.
+  ModelElement get enclosingElement => library;
+
   String get nameWithGenerics {
     if (!modelType.isParameterizedType) return name;
     return '$name&lt${_typeParameters.map((t) => t.name).join(', ')}&gt';
@@ -1271,12 +1294,16 @@ abstract class SourceCodeMixin {
   Element get element;
 }
 
-class ModelFunction extends ModelElement with SourceCodeMixin {
+class ModelFunction extends ModelElement
+    with SourceCodeMixin
+    implements EnclosedElement {
   ModelFunction(FunctionElement element, Library library)
       : super(element, library) {
     _modelType = new ElementType(_func.type, this);
   }
 
+  ModelElement get enclosingElement => library;
+
   FunctionElement get _func => (element as FunctionElement);
 
   bool get isStatic => _func.isStatic;
@@ -1289,7 +1316,7 @@ class ModelFunction extends ModelElement with SourceCodeMixin {
   String get _href => '${library.dirName}/$fileName';
 }
 
-class Typedef extends ModelElement {
+class Typedef extends ModelElement implements EnclosedElement {
   FunctionTypeAliasElement get _typedef =>
       (element as FunctionTypeAliasElement);
 
@@ -1300,6 +1327,9 @@ class Typedef extends ModelElement {
     }
   }
 
+  @override
+  ModelElement get enclosingElement => library;
+
   String get fileName => '$name.html';
 
   String get linkedReturnType => modelType != null
@@ -1309,7 +1339,7 @@ class Typedef extends ModelElement {
   String get _href => '${library.dirName}/$fileName';
 }
 
-class Field extends ModelElement {
+class Field extends ModelElement implements EnclosedElement {
   String _constantValue;
   bool _isInherited = false;
 
@@ -1325,6 +1355,10 @@ class Field extends ModelElement {
     _setModelType();
   }
 
+  @override
+  ModelElement get enclosingElement =>
+      new ModelElement.from(_field.enclosingElement, library);
+
   @override
   String get _computeDocumentationComment {
     var buffer = new StringBuffer();
@@ -1436,12 +1470,16 @@ class EnumField extends Field {
   String get linkedName => name;
 }
 
-class Constructor extends ModelElement {
+class Constructor extends ModelElement implements EnclosedElement {
   ConstructorElement get _constructor => (element as ConstructorElement);
 
   Constructor(ConstructorElement element, Library library)
       : super(element, library);
 
+  @override
+  ModelElement get enclosingElement =>
+      new ModelElement.from(_constructor.enclosingElement, library);
+
   @override
   String get _href =>
       '${library.dirName}/${_constructor.enclosingElement.name}/$name.html';
@@ -1468,7 +1506,9 @@ class Constructor extends ModelElement {
   }
 }
 
-class Method extends ModelElement with SourceCodeMixin {
+class Method extends ModelElement
+    with SourceCodeMixin
+    implements EnclosedElement {
   bool _isInherited = false;
 
   MethodElement get _method => (element as MethodElement);
@@ -1483,6 +1523,10 @@ class Method extends ModelElement with SourceCodeMixin {
     _isInherited = true;
   }
 
+  @override
+  ModelElement get enclosingElement =>
+      new ModelElement.from(_method.enclosingElement, library);
+
   Method get overriddenElement {
     ClassElement parent = element.enclosingElement;
     for (InterfaceType t in getAllSupertypes(parent)) {
@@ -1563,12 +1607,16 @@ class Operator extends Method {
 }
 
 /// Getters and setters.
-class Accessor extends ModelElement {
+class Accessor extends ModelElement implements EnclosedElement {
   PropertyAccessorElement get _accessor => (element as PropertyAccessorElement);
 
   Accessor(PropertyAccessorElement element, Library library)
       : super(element, library);
 
+  @override
+  ModelElement get enclosingElement =>
+      new ModelElement.from(_accessor.enclosingElement, library);
+
   bool get isGetter => _accessor.isGetter;
 
   @override
@@ -1577,7 +1625,7 @@ class Accessor extends ModelElement {
 }
 
 /// Top-level variables. But also picks up getters and setters?
-class TopLevelVariable extends ModelElement {
+class TopLevelVariable extends ModelElement implements EnclosedElement {
   TopLevelVariableElement get _variable => (element as TopLevelVariableElement);
 
   TopLevelVariable(TopLevelVariableElement element, Library library)
@@ -1594,6 +1642,9 @@ class TopLevelVariable extends ModelElement {
     }
   }
 
+  @override
+  ModelElement get enclosingElement => library;
+
   bool get isFinal => _variable.isFinal;
 
   bool get isConst => _variable.isConst;
@@ -1631,14 +1682,18 @@ class TopLevelVariable extends ModelElement {
   String get _href => '${library.dirName}/${name}.html';
 }
 
-class Parameter extends ModelElement {
+class Parameter extends ModelElement implements EnclosedElement {
   Parameter(ParameterElement element, Library library)
       : super(element, library) {
     var t = _parameter.type;
     _modelType = new ElementType(
         t, new ModelElement.from(t.element, package._getLibraryFor(t.element)));
   }
 
+  @override
+  ModelElement get enclosingElement =>
+      new ModelElement.from(_parameter.enclosingElement, library);
+
   ParameterElement get _parameter => element as ParameterElement;
 
   bool get isOptional => _parameter.parameterKind.isOptional;