add appcache generation to apidocs

utils/apidoc/apidoc.dart

 // Copyright (c) 2012, 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.
 
 /**
  * This generates the reference documentation for the core libraries that come
  * with dart. It is built on top of dartdoc, which is a general-purpose library
  * for generating docs from any Dart code. This library extends that to include
  * additional information and styling specific to our standard library.
  *
@@ skipping 91 matching lines @@
   world.getOrAddLibrary('dart:html');
   world.getOrAddLibrary('dart:io');
   world.getOrAddLibrary('dart:isolate');
   world.getOrAddLibrary('dart:uri');
   world.getOrAddLibrary('dart:utf');
   world.process();
 
   print('Generating docs...');
   final apidoc = new Apidoc(mdn, outputDir, mode);
   apidoc.document();
+
+  print('Building App Cache manifest');
+  apidoc.generateAppCacheManifest();
 }
 
 class Apidoc extends doc.Dartdoc {
   /** Big ball of JSON containing the scraped MDN documentation. */
   final Map mdn;
 
   static final disqusShortname = 'dartapidocs';
 
   /**
    * The URL to the page on MDN that content was pulled from for the current
@@ skipping 44 matching lines @@
             (function() {
                 var dsq = document.createElement("script"); dsq.type = "text/javascript"; dsq.async = true;
                 dsq.src = "http://" + disqus_shortname + ".disqus.com/embed.js";
                 (document.getElementsByTagName("head")[0] || document.getElementsByTagName("body")[0]).appendChild(dsq);
             })();
         </script>
         <noscript>Please enable JavaScript to view the <a href="http://disqus.com/?ref_noscript">comments powered by Disqus.</a></noscript>
         </div> <!-- #comments -->
         ''';
 
+    htmlAttributes = 'manifest="appcache.manifest"';

[Bob Nystrom, 2012/04/24 16:30:33]

Is there any reason we wouldn't want dartdoc itself to just always do this?
Seems generally useful.

[sethladd, 2012/04/25 21:13:46]

moved to dartdoc

+
     searchEngineId = '011220921317074318178:i4mscbaxtru';
     searchResultsUrl = 'http://www.dartlang.org/search.html';
   }
 
   void writeHeadContents(String title) {
     super.writeHeadContents(title);
 
     // Include the apidoc-specific CSS.
     // TODO(rnystrom): Use our CSS pre-processor to combine these.
     writeln(
@@ skipping 302 matching lines @@
       var domTypesText = doc.joinWithCommas(map(domTypes, typeReference));
       return
           '''
           <p class="correspond">This corresponds to $domTypesText in the
           ${a("dom.html", "dart:dom")} library.</p>
           ''';
     }
 
     return '';
   }
+
+  generateAppCacheManifest() {
+    var manifestFile = new File('docs/appcache.manifest');

[Bob Nystrom, 2012/04/24 16:30:33]

The Dartdoc class has a more pleasant API for writing files. You should be able
to use this here and then do:

startFile('docs/appcache.manifest');
writeLine('CACHE MANIFEST\n\n');
...
endFile();

which is a lot more pleasant.

[sethladd, 2012/04/25 21:13:46]

current way works, will leave for now.

+    var writer = manifestFile.openOutputStream(FileMode.WRITE);
+    writer.writeString("CACHE MANIFEST\n\n");
+    writer.writeString("# VERSION: ${new Date.now()}\n\n");
+    writer.writeString("NETWORK:\n*\n\n");
+    writer.writeString("CACHE:\n");
+    var toCache = new Directory(outputDir);
+    var pathPrefix = new File(outputDir).fullPathSync();
+    var pathPrefixLength = pathPrefix.length;
+    toCache.list(recursive: true);
+    toCache.onFile = (filename) {
+      var relativePath = filename.substring(pathPrefixLength+1);

[Bob Nystrom, 2012/04/24 16:30:33]

Spaces around +

[sethladd, 2012/04/25 21:13:46]

Done.

+      writer.writeString("$relativePath\n");
+    };
+    toCache.onDone = (done) => writer.close();

[Bob Nystrom, 2012/04/24 16:30:33]

Ugh, async. I wonder if at some point, Dartdoc will just have to be rewritten in
async style. This code works and is fine, but it relies on the fact that
generating the docs themselves is done synchronously so we can rely on the files
being written before this starts walking the directory.

[sethladd, 2012/04/25 21:13:46]

See the added Futures.

+  }
 }