mcs/tools/mdoc/Mono.Documentation/webdoc.cs

   1 //
   2 // webdoc.cs
   3 //
   4 // Author:
   5 //   Jonathan Pryor  <jpryor@novell.com>
   6 //
   7 // Copyright (c) 2009 Novell, Inc. (http://www.novell.com)
   8 //
   9 // Permission is hereby granted, free of charge, to any person obtaining
  10 // a copy of this software and associated documentation files (the
  11 // "Software"), to deal in the Software without restriction, including
  12 // without limitation the rights to use, copy, modify, merge, publish,
  13 // distribute, sublicense, and/or sell copies of the Software, and to
  14 // permit persons to whom the Software is furnished to do so, subject to
  15 // the following conditions:
  16 //
  17 // The above copyright notice and this permission notice shall be
  18 // included in all copies or substantial portions of the Software.
  19 //
  20 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  21 // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  22 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  23 // NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  24 // LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  25 // OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  26 // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  27 //
  28
  29 using System;
  30 using System.Collections.Generic;
  31 using System.Diagnostics;
  32 using System.IO;
  33 using System.Linq;
  34 using System.Text;
  35 using System.Web;
  36
  37 using Monodoc;
  38
  39 using Mono.Options;
  40 using Mono.Rocks;
  41
  42 namespace Mono.Documentation
  43 {
  44         public class MDocExportWebdocHtml : MDocCommand
  45         {
  46                 public override void Run (IEnumerable<string> args)
  47                 {
  48                         string dir = null;
  49                         var options = new OptionSet () {
  50                         { "o|out=",
  51                                 "The {DIRECTORY} to place the generated files and directories.",
  52                                 v => dir = v },
  53                         };
  54                         List<string> files = Parse (options, args, "export-html-webdoc",
  55                                         "[OPTIONS]+ FILES",
  56                                         "Export mdoc documentation within FILES to HTML for use by ASP.NET webdoc.\n\n" +
  57                                         "FILES are .tree or .zip files as produced by 'mdoc update'.");
  58                         if (files == null)
  59                                 return;
  60                         if (files.Count == 0)
  61                                 Error ("No files specified.");
  62                         HelpSource.use_css = true;
  63                         HelpSource.FullHtml = false;
  64                         SettingsHandler.Settings.EnableEditing = false;
  65                         foreach (var basePath in
  66                                         files.Select (f => Path.GetFileNameWithoutExtension (f)).Distinct ()) {
  67                                 Console.WriteLine ("# Processing BasePath={0}", basePath);
  68                                 string treeFile = basePath + ".tree";
  69                                 string zipFile  = basePath + ".zip";
  70                                 if (!Exists (treeFile) || !Exists (zipFile))
  71                                         continue;
  72                                 Console.WriteLine ("# Tree file={0}", treeFile);
  73                                 Tree tree = new Tree (null, treeFile);
  74                                 RootTree docRoot = RootTree.LoadTree ();
  75                                 // monodoc url == docRoot.RenderUrl
  76                                 // tree link == HelpSource.GetText()
  77                                 Console.WriteLine ("# tree contents:");
  78                                 Tree.PrintTree (tree);
  79                                 foreach (Node node in tree.TraverseDepthFirst<Node, Node> (t => t, t => t.Nodes.Cast<Node> ())) {
  80                                         var url = node.URL;
  81                                         Console.WriteLine ("# NodeUrl={0}", url);
  82                                         if (string.IsNullOrEmpty (url))
  83                                                 continue;
  84                                         var file = Path.Combine (dir,
  85                                                         HttpUtility.UrlEncode (url).Replace ('/', '+').Replace ("*", "%2a"));
  86                                         Console.WriteLine ("# file={0}", file);
  87                                         using (var o = File.AppendText (file)) {
  88                                                 Node _;
  89                                                 o.Write (docRoot.RenderUrl (url, out _));
  90                                                 //  tree.HelpSource.GetText (url, out _));
  91                                         }
  92                                 }
  93                         }
  94                 }
  95
  96                 bool Exists (string file)
  97                 {
  98                         if (!File.Exists (file)) {
  99                                         Message (TraceLevel.Error,
 100                                                         "mdoc: Could not find file: {0}", file);
 101                                         return false;
 102                         }
 103                         return true;
 104                 }
 105         }
 106 }