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 16 matching lines @@
 HtmlDiff _diff;
 
 final GET_PREFIX = 'get:';
 
 void main() {
   final args = new Options().arguments;
 
   int mode = doc.MODE_STATIC;
   String outputDir = 'docs';
   String compilerPath;
+  bool generateAppCache = true;
 
   // Parse the command-line arguments.
   for (int i = 0; i < args.length; i++) {
     final arg = args[i];
 
     switch (arg) {
       case '--mode=static':
         mode = doc.MODE_STATIC;
         break;
 
       case '--mode=live-nav':
         mode = doc.MODE_LIVE_NAV;
         break;
 
+      case '--generate-app-cache=false':
+        generateAppCache = false;
+        break;
+
       default:
         if (arg.startsWith('--out=')) {
           outputDir = arg.substring('--out='.length);
         } else if (arg.startsWith('--compiler=')) {
           compilerPath = arg.substring('--compiler='.length);
         } else {
           print('Unknown option: $arg');
           return;
         }
         break;
     }
   }
 
   final frogPath = joinPaths(doc.scriptDir, '../../frog/');
   final libDir = joinPaths(frogPath, 'lib');
 
   if (compilerPath === null) {
     compilerPath = joinPaths(frogPath, 'frog.py');
   }
 
   doc.cleanOutputDirectory(outputDir);
 
   // Compile the client-side code to JS.
   // TODO(bob): Right path.
 
   final clientScript = (mode == doc.MODE_STATIC) ?
       'static' : 'live-nav';
-  doc.compileScript(compilerPath, libDir,
+  Future scriptCompiled = doc.compileScript(compilerPath, libDir,

[Bob Nystrom, 2012/04/25 21:43:15]

"final"

[sethladd, 2012/04/25 23:13:28]

Done.

       '${doc.scriptDir}/../../lib/dartdoc/client-$clientScript.dart',
       '${outputDir}/client-$clientScript.js');
 
   // TODO(rnystrom): Use platform-specific path separator.
   // The basic dartdoc-provided static content.
-  doc.copyFiles('${doc.scriptDir}/../../lib/dartdoc/static', outputDir);
+  Future copiedStatic = doc.copyFiles('${doc.scriptDir}/../../lib/dartdoc/static', outputDir);

[Bob Nystrom, 2012/04/25 21:43:15]

Long line.

[sethladd, 2012/04/25 23:13:28]

Done.

 
   // The apidoc-specific static content.
-  doc.copyFiles('${doc.scriptDir}/static', outputDir);
+  Future copiedApiDocStatic = doc.copyFiles('${doc.scriptDir}/static', outputDir);

[Bob Nystrom, 2012/04/25 21:43:15]

Here too.

[sethladd, 2012/04/25 23:13:28]

Done.

 
   var files = new VMFileSystem();
   parseOptions(frogPath, ['', '', '--libdir=$frogPath/lib'], files);
   initializeWorld(files);
 
   print('Parsing MDN data...');
   final mdnFile = new File('${doc.scriptDir}/mdn/database.json');
   final mdn = JSON.parse(mdnFile.readAsTextSync());
 
   print('Cross-referencing dart:dom and dart:html...');
   HtmlDiff.initialize();
   _diff = new HtmlDiff(printWarnings:false);
   _diff.run();
   world.reset();
 
   // Add all of the core libraries.
   world.getOrAddLibrary('dart:core');
   world.getOrAddLibrary('dart:coreimpl');
   world.getOrAddLibrary('dart:json');
   world.getOrAddLibrary('dart:dom');
   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();
+  final apidoc = new Apidoc(mdn, outputDir, mode, generateAppCache);
+
+  // hackish: all I really need to do is run app cache when these
+  // futures are done, but app cache generation is inside document()

[Bob Nystrom, 2012/04/25 21:43:15]

Why not just have generateAppCache be a separate method on Dartdoc that is
invoked directly here separately from document()? Likewise, main() in
dartdoc.dart can do the same.

[sethladd, 2012/04/25 23:13:28]

class Dartdoc still needs the generateAppCache boolean flag, this proposal makes
us check for the flag in three places.

[Bob Nystrom, 2012/04/25 23:27:50]

Ah, OK.

+  Futures.wait([scriptCompiled, copiedStatic, copiedApiDocStatic]).then((_) {
+    apidoc.document();
+  });
 }
 
 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
    * type being documented. Will be `null` if the type doesn't use any MDN
    * content.
    */
   String mdnUrl;
 
-  Apidoc(this.mdn, String outputDir, int mode) {
+  Apidoc(this.mdn, String outputDir, int mode, bool generateAppCache) {
     this.outputDir = outputDir;
     this.mode = mode;
+    this.generateAppCache = generateAppCache;
 
     mainTitle = 'Dart API Reference';
     mainUrl = 'http://dartlang.org';
 
     final note    = 'http://code.google.com/policies.html#restrictions';
     final cca     = 'http://creativecommons.org/licenses/by/3.0/';
     final bsd     = 'http://code.google.com/google_bsd_license.html';
     final tos     = 'http://www.dartlang.org/tos.html';
     final privacy = 'http://www.google.com/intl/en/privacy/privacy-policy.html';
 
@@ skipping 348 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 '';
   }
+
 }