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

   1 //
   2 // index.cs
   3 // Index maker (both normal and Lucene-based)
   4 //
   5 // Authors:
   6 //    Jérémie Laval <jeremie dot laval at xamarin dot com>
   7 //
   8 // Copyright 2011 Xamarin Inc (http://www.xamarin.com).
   9 //
  10 // Permission is hereby granted, free of charge, to any person obtaining a copy
  11 // of this software and associated documentation files (the "Software"), to deal
  12 // in the Software without restriction, including without limitation the rights
  13 // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  14 // copies of the Software, and to permit persons to whom the Software is
  15 // furnished to do so, subject to the following conditions:
  16 //
  17 // The above copyright notice and this permission notice shall be included in
  18 // all copies or substantial portions of the Software.
  19 //
  20 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  21 // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  22 // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  23 // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  24 // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  25 // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  26 // THE SOFTWARE.
  27 //
  28 //
  29 using System;
  30 using System.Collections.Generic;
  31
  32 using Mono.Options;
  33 using Monodoc;
  34
  35 namespace Mono.Documentation {
  36
  37         class MDocIndex : MDocCommand {
  38                 public override void Run (IEnumerable<string> args)
  39                 {
  40                         string rootPath = null;
  41
  42                         var options = new OptionSet () {
  43                                 { "r=|root=", "Specify which documentation root to use. Default is $libdir/monodoc", v => rootPath = v },
  44                         };
  45
  46                         var extra = Parse (options, args, "index",
  47                                            "[OPTIONS]+ ACTION",
  48                                            "Create Monodoc indexes depending on ACTION. Possible values are \"tree\" or \"search\" for, respectively, mdoc tree and lucene search");
  49                         if (extra == null)
  50                                 return;
  51
  52                         var root = string.IsNullOrEmpty (rootPath) ? RootTree.LoadTree () : RootTree.LoadTree (rootPath);
  53
  54                         foreach (var action in extra) {
  55                                 switch (action) {
  56                                 case "tree":
  57                                         root.GenerateIndex ();
  58                                         break;
  59                                 case "search":
  60                                         root.GenerateSearchIndex ();
  61                                         break;
  62                                 }
  63                         }
  64                 }
  65         }
  66 }