Get dartdoc in the SDK and working correctly.

tools/create_sdk.py

 #!/usr/bin/env python
 #
 # Copyright (c) 2011, 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.
 #
-# A script which will be invoked from gyp to create an SDK. 
+# A script which will be invoked from gyp to create an SDK.
 #
 # Usage: create_sdk.py sdk_directory
 #
-# The SDK will be used either from the command-line or from the editor. 
+# The SDK will be used either from the command-line or from the editor.
 # Top structure is
 #
 # ..dart-sdk/
 # ....bin/
 # ......dart or dart.exe (executable)
 # ......frogc.dart
 # ......frogsh (coming later)
 # ....lib/
 # ......builtin/
 # ........builtin_runtime.dart
 # ......io/
 # ........io_runtime.dart
 # ........runtime/
 # ......core/
 # ........core_{frog, runtime}.dart
-# ........{frog, runtime}/ 
+# ........{frog, runtime}/
 # ......coreimpl/
 # ........coreimpl_{frog, runtime}.dart
-# ........{frog, runtime}/ 
+# ........{frog, runtime}/
+# ......dartdoc/
 # ......isolate/
 # ........isolate_{frog, runtime}.dart
-# ........{frog, runtime}/ 
+# ........{frog, runtime}/
 # ......dom/
 # ........dom.dart
 # ......frog/
-# ......html/ 
+# ......html/
 # ........html.dart
-# ......htmlimpl/ 
+# ......htmlimpl/
 # ........htmlimpl.dart
 # ......json/
 # ........json_frog.dart
 #.........json.dart
 # ........{frog}/
 # ......uri/
 # ........uri.dart
 # ......utf8/
 # ........utf8.dart
 # ......(more will come here)
 # ....util/
 # ......(more will come here)
 
 
 
 import os
 import re
 import sys
 import tempfile
 import utils
 
 from os.path import dirname, join, realpath, exists, isdir
 from shutil import copyfile, copymode, copytree, ignore_patterns, rmtree, move
 
+def ReplaceInFile(path, subs):
+  '''Reads a file, applies a series of substitutions to it, and saves it back
+     out. subs should by a list of (pattern, replace) tuples.'''
+  contents = open(path).read()
+  for pattern, replace in subs:
+    contents = re.sub(pattern, replace, contents)
+
+  dest = open(path, 'w')
+  dest.write(contents)
+  dest.close()
+
 def Main(argv):
   # Pull in all of the gpyi files which will be munged into the sdk.
   builtin_runtime_sources = \
     (eval(open("runtime/bin/builtin_sources.gypi").read()))['sources']
   io_runtime_sources = \
     (eval(open("runtime/bin/io_sources.gypi").read()))['sources']
   corelib_sources = \
     (eval(open("corelib/src/corelib_sources.gypi").read()))['sources']
   corelib_frog_sources = \
     (eval(open("frog/lib/frog_corelib_sources.gypi").read()))['sources']
@@ skipping 24 matching lines @@
   # Copy the Dart VM binary into sdk/bin.
   # TODO(dgrove) - deal with architectures that are not ia32.
   build_dir = os.path.dirname(argv[1])
   frogc_file_extension = ''
   dart_file_extension = ''
   if utils.GuessOS() == 'win32':
     dart_file_extension = '.exe'
     frogc_file_extension = '.bat'
   dart_src_binary = join(HOME, build_dir, 'dart' + dart_file_extension)
   dart_dest_binary = join(BIN, 'dart' + dart_file_extension)
-  frogc_src_binary = join(HOME, 'frog', 'scripts', 'bootstrap', 
+  frogc_src_binary = join(HOME, 'frog', 'scripts', 'bootstrap',
       'frogc' + frogc_file_extension)
   frogc_dest_binary = join(BIN, 'frogc' + frogc_file_extension)
   copyfile(dart_src_binary, dart_dest_binary)
   copymode(dart_src_binary, dart_dest_binary)
   copyfile(frogc_src_binary, frogc_dest_binary)
   copymode(frogc_src_binary, frogc_dest_binary)
 
   # Create sdk/bin/frogc.dart, and hack as needed.
   frog_src_dir = join(HOME, 'frog')
 
@@ skipping 64 matching lines @@
   # Create and populate lib/frog.
   #
   frog_dest_dir = join(LIB, 'frog')
   os.makedirs(frog_dest_dir)
 
   for filename in os.listdir(frog_src_dir):
     if filename == 'frog_options.dart':
       # change config from 'dev' to 'sdk' in frog_options.dart
       frog_options_contents = open(join(frog_src_dir, filename)).read()
       frog_options_dest = open(join(frog_dest_dir, filename), 'w')
-      frog_options_dest.write(re.sub("final config = \'dev\';", 
-                                     "final config = \'sdk\';", 
+      frog_options_dest.write(re.sub("final config = \'dev\';",
+                                     "final config = \'sdk\';",
                                      frog_options_contents))
       frog_options_dest.close()
     elif filename.endswith('.dart'):
       copyfile(join(frog_src_dir, filename), join(frog_dest_dir, filename))
 
   leg_dest_dir = join(frog_dest_dir, 'leg')
   copytree(join(frog_src_dir, 'leg'), leg_dest_dir,
            ignore=ignore_patterns('.svn'))
 
   # Remap imports in frog/leg/* .
   for filename in os.listdir(leg_dest_dir):
     if filename.endswith('.dart'):
       file_contents = open(join(leg_dest_dir, filename)).read()
       file = open(join(leg_dest_dir, filename), 'w')
       file.write(re.sub("../../lib", "../..", file_contents))
       file.close()
 
-  copytree(join(frog_src_dir, 'server'), join(frog_dest_dir, 'server'), 
+  copytree(join(frog_src_dir, 'server'), join(frog_dest_dir, 'server'),
            ignore=ignore_patterns('.svn'))
 
   # Remap imports in frog/... .
   for (dirpath, subdirs, _) in os.walk(frog_dest_dir):
     for subdir in subdirs:
       for filename in os.listdir(join(dirpath, subdir)):
         if filename.endswith('.dart'):
           file_contents = open(join(dirpath, subdir, filename)).read()
           file = open(join(dirpath, subdir, filename), 'w')
           file.write(re.sub("../lib/", "../", file_contents))
           file.close()
 
   #
   # Create and populate lib/html and lib/htmlimpl.
   #
   html_src_dir = join(HOME, 'client', 'html')
   html_dest_dir = join(LIB, 'html')
   os.makedirs(html_dest_dir)
   htmlimpl_dest_dir = join(LIB, 'htmlimpl')
   os.makedirs(htmlimpl_dest_dir)
 
-  copyfile(join(html_src_dir, 'release', 'html.dart'), 
+  copyfile(join(html_src_dir, 'release', 'html.dart'),
            join(html_dest_dir, 'html.dart'))
-  copyfile(join(html_src_dir, 'release', 'htmlimpl.dart'), 
+  copyfile(join(html_src_dir, 'release', 'htmlimpl.dart'),
            join(htmlimpl_dest_dir, 'htmlimpl.dart'))
 
   # TODO(dgrove): prune the correct files in html and htmlimpl.
   for target_dir in [html_dest_dir, htmlimpl_dest_dir]:
     copytree(join(html_src_dir, 'src'), join(target_dir, 'src'),
              ignore=ignore_patterns('.svn'))
     copytree(join(html_src_dir, 'generated'), join(target_dir, 'generated'),
              ignore=ignore_patterns('.svn'))
 
 
   #
   # Create and populate lib/dom.
   #
   dom_src_dir = join(HOME, 'client', 'dom')
   dom_dest_dir = join(LIB, 'dom')
   os.makedirs(dom_dest_dir)
 
   for filename in os.listdir(dom_src_dir):
     src_file = join(dom_src_dir, filename)
     dest_file = join(dom_dest_dir, filename)
     if filename.endswith('.dart') or filename.endswith('.js'):
       copyfile(src_file, dest_file)
     elif isdir(src_file):
       if filename not in ['benchmarks', 'idl', 'scripts', 'snippets', '.svn']:
-        copytree(src_file, dest_file, 
-                 ignore=ignore_patterns('.svn', 'interface', 'wrapping', 
+        copytree(src_file, dest_file,
+                 ignore=ignore_patterns('.svn', 'interface', 'wrapping',
                                         '*monkey*'))
 
-  # 
+  #
   # Create and populate lib/{json, uri, utf8} .
   #
 
   for library in ['json', 'uri', 'utf8']:
     src_dir = join(HOME, 'lib', library)
     dest_dir = join(LIB, library)
     os.makedirs(dest_dir)
 
     for filename in os.listdir(src_dir):
       if filename.endswith('.dart'):
         copyfile(join(src_dir, filename), join(dest_dir, filename))
-  
+
+  # Create and populate lib/dartdoc
+  dartdoc_src_dir = join(HOME, 'utils', 'dartdoc')

[dgrove, 2012/03/01 08:38:00]

I think we should move dartdoc from utils/dartdoc to lib/dartdoc as part of this
change.

[Bob Nystrom, 2012/03/01 23:03:27]

Should we move apidoc there too?

More important question, what about the tests? Where do those go?

+  dartdoc_dest_dir = join(LIB, 'dartdoc')
+  copytree(dartdoc_src_dir, dartdoc_dest_dir,
+           ignore=ignore_patterns('.svn', 'docs'))
+  ReplaceInFile(join(LIB, 'dartdoc', 'dartdoc'), [
+      ("../../frog/minfrog", "../../bin/frogc"),
+      ("--libdir=../../frog/lib", "--libdir=../")
+    ])
+  ReplaceInFile(join(LIB, 'dartdoc', 'dartdoc.dart'), [
+      ("#import\('../../frog", "#import('../frog"),
+      ("'../../frog'", "'../frog'"),
+      ("'--libdir=../../frog/lib'", "'--libdir=../'")
+    ])
+  ReplaceInFile(join(LIB, 'dartdoc', 'classify.dart'), [
+      ("#import\('../../frog", "#import('../frog")
+    ])
+  ReplaceInFile(join(LIB, 'dartdoc', 'client-live-nav.dart'), [
+      ("#import\('../../frog", "#import('../frog")
+    ])
+  ReplaceInFile(join(LIB, 'dartdoc', 'client-static.dart'), [
+      ("#import\('../../frog", "#import('../frog")

[dgrove, 2012/03/01 08:38:00]

it would be nice if ReplaceInFile were ReplaceInFiles.

+    ])
+
   # Create and populate lib/isolate
   copytree(join(HOME, 'lib', 'isolate'), join(LIB, 'isolate'),
            ignore=ignore_patterns('.svn'))
 
   #
   # Create and populate lib/core.
   #
 
   # First, copy corelib/* to lib/{frog, runtime}
   for filename in corelib_sources:
     for target_dir in ['frog', 'runtime']:
-      copyfile(join('corelib', 'src', filename), 
+      copyfile(join('corelib', 'src', filename),
                join(corelib_dest_dir, target_dir, filename))
 
   # Next, copy the frog library source on top of core/frog
   # TOOD(dgrove): move json to top-level
   for filename in corelib_frog_sources:
-    copyfile(join('frog', 'lib', filename), 
+    copyfile(join('frog', 'lib', filename),
              join(corelib_dest_dir, 'frog', filename))
 
   # Next, copy the runtime library source on top of core/runtime
   for filename in corelib_runtime_sources:
     if filename.endswith('.dart'):
-      copyfile(join('runtime', 'lib', filename), 
+      copyfile(join('runtime', 'lib', filename),
                join(corelib_dest_dir, 'runtime', filename))
-  
+
   #
   # At this point, it's time to create lib/core/core*dart .
   #
   # munge frog/lib/corelib.dart into lib/core_frog.dart .
   src_file = join('frog', 'lib', 'corelib.dart')
   dest_file = open(join(corelib_dest_dir, 'core_frog.dart'), 'w')
   contents = open(src_file).read()
   contents = re.sub('source\(\"../../corelib/src/', 'source(\"', contents)
   contents = re.sub("source\(\"", "source(\"frog/", contents)
   dest_file.write(contents)
@@ skipping 10 matching lines @@
       dest_file.write('#source("runtime/' + filename + '");\n')
   dest_file.close()
 
   #
   # Create and populate lib/coreimpl.
   #
 
   # First, copy corelib/src/implementation to corelib/{frog, runtime}.
   for filename in coreimpl_sources:
     for target_dir in ['frog', 'runtime']:
-      copyfile(join('corelib', 'src', 'implementation', filename), 
+      copyfile(join('corelib', 'src', 'implementation', filename),
                join(coreimpl_dest_dir, target_dir, filename))
 
   for filename in coreimpl_frog_sources:
-    copyfile(join('frog', 'lib', filename), 
+    copyfile(join('frog', 'lib', filename),
              join(coreimpl_dest_dir, 'frog', filename))
 
   for filename in coreimpl_runtime_sources:
     if filename.endswith('.dart'):
-      copyfile(join('runtime', 'lib', filename), 
+      copyfile(join('runtime', 'lib', filename),
                join(coreimpl_dest_dir, 'runtime', filename))
 
-  
+
   # Create and fix up lib/coreimpl/coreimpl_frog.dart .
   src_file = join('frog', 'lib', 'corelib_impl.dart')
   dest_file = open(join(coreimpl_dest_dir, 'coreimpl_frog.dart'), 'w')
   contents = open(src_file).read()
-  contents = re.sub('source\(\"../../corelib/src/implementation/', 
+  contents = re.sub('source\(\"../../corelib/src/implementation/',
                     'source(\"', contents)
   contents = re.sub('source\(\"', 'source(\"frog/', contents)
   dest_file.write(contents)
   dest_file.close()
 
   # Construct lib/coreimpl/coreimpl_runtime.dart from whole cloth.
   dest_file = open(join(coreimpl_dest_dir, 'coreimpl_runtime.dart'), 'w')
   dest_file.write('#library("dart:coreimpl");\n')
   for filename in coreimpl_sources:
     dest_file.write('#source("runtime/' + filename + '");\n')
   for filename in coreimpl_runtime_sources:
     if filename.endswith('.dart'):
       dest_file.write('#source("runtime/' + filename + '");\n')
   dest_file.close()
 
   # Create and copy tools.
 
   UTIL = join(SDK_tmp, 'util')
   os.makedirs(UTIL)
 
   move(SDK_tmp, SDK)
 
 if __name__ == '__main__':
   sys.exit(Main(sys.argv))