git.roojs.org Git - gnome.introspection-doc-generator/blob - JSDOC/Options.js

   1 //<script type="text/javascript">
   2 /**
   3  * Options management...
   4  */
   5 XObject = import.XObject.XObject;
   6 File = import.File.File;
   7
   8 Options = {
   9
  10     // generic stuff...
  11     "--help"          : 'Show help',   // was h
  12     "help": false,   // was h;se
  13
  14
  15     // configurable optiosn settings..
  16     "usage" : "Usage seed jsdocbuild.js OPTIONS \n",
  17
  18
  19     // options get defined like this..
  20     "--src"           :  "source directory (either absolute - starts with "/" or relative " +
  21                         "- without, in which case it's added to baseDir"
  22     "--baseDir"       :  'Base Directory (root directory of code)',
  23     "--target"        :  'Target Directory (where html files go)',
  24     "--cacheDirectory": 'Cached Files Directory',
  25     "--conf"          : 'Read From a Configuration file',       // was c. - configuration file.. - parsed with JSON.parse
  26     "--template"      : 'Template Directory',   // was t.
  27     // "recurse": false,   // was r. - not supported..
  28     "--ext"           :  'Extension of code files to read (normally js)',   // was x.
  29     "--publishExt"    : 'Extension of html files to write (normally html)',
  30     //"private": '',   // was p
  31     //"allfunctions": '',   // was a
  32     //"encoding": '',   // was e.
  33     //"nocode": '',  // was n
  34     //"out": '',   // was o.
  35     //"suppress": '',  // was s ??? used?
  36     "--outputSource" : 'Output the Source code to symbols/src/* (boolean)',
  37     //"testmode": '',  // was t
  38
  39     "--verbose"       : 'Show verbose messages',   // was v
  40     //"disablecache": '',   // was C -- not needed? - see if cacheDirectory was set..
  41     //"define" : [],   // was D.
  42     //"handler" : [],  // was H -- not supported..
  43
  44
  45     // and now the defaults.. (which type can be infered from..)
  46     "src" : [],
  47     "baseDir" :  '',  // base directory -
  48     "target" : '',   // was d. ?? source directory (needed to put temporary files..)
  49     "cacheDirectory" : '',
  50     "conf" : '',       // was c. - configuration file.. - parsed with JSON.parse
  51     "template": '',   // was t.
  52     // "recurse": false,   // was r. - not supported..
  53     "ext": 'js',   // was x.
  54     "publishExt" : 'html',
  55     "private": '',   // was p
  56     "allfunctions": '',   // was a
  57     "encoding": '',   // was e.
  58     "nocode": '',  // was n
  59     "out": '',   // was o.
  60     "suppress": '',  // was s ??? used?
  61     "outputSource" : true,
  62     "testmode": '',  // was t
  63
  64     "verbose": '',   // was v
  65     "disablecache": '',   // was C
  66     "define" : [],   // was D.
  67     "handler" : [],  // was H -- not supported..
  68     LOG : {
  69         warn : function(str) {
  70             print("Warn: " +str );
  71         },
  72         inform : function(str) {
  73             print("Inform: " +str );
  74         },
  75         close : function() { },
  76         flush : function() { },
  77         out: false,
  78         warnings : [],
  79         verbose : false
  80     },
  81     init : function()
  82     {
  83
  84         if (this.help) {
  85             this.showHelp();
  86
  87         }
  88
  89         // the reset of this is specific to JSDOC - and can not be moved to a generic handler..
  90
  91
  92         this.LOG.verbose = this.verbose;
  93
  94         // this is most likely to come from the command line..
  95         if (this.conf) {
  96             XObject.extend(this, JSON.parse(File.read(this.conf)));;
  97         }
  98         // help ?? -- usage..
  99         if (!this.baseDir) {
 100             throw {
 101                 name: "ArgumentError",
 102                 message: "No baseDir specified"
 103             };
 104         }
 105         if (!this.src.length) {
 106             throw {
 107                 name: "ArgumentError",
 108                 message: "No source directories specified"
 109             };
 110         }
 111         // append full path to source directories.
 112         var _this= this;
 113         this.src.forEach(function(v, i) {
 114             if (v[0] != '/') {
 115                 this.src[i] = _this.baseDir + '/' + v;
 116             }
 117             if (File.isDirectory(this.src[i])) {
 118                 throw {
 119                     name: "ArgumentError",
 120                     message: "invalid Source Directory : " +  v;
 121                 };
 122             }
 123         }
 124
 125
 126         if (!this.template) {
 127             throw {
 128                 name: "ArgumentError",
 129                 message: "No template Directory specified"
 130             };
 131         }
 132
 133         if (!this.target) {
 134             throw {
 135                 name: "ArgumentError",
 136                 message: "No directory specified"
 137             };
 138         }
 139
 140
 141         // should cacheDirectory be a subdirectory of target??
 142         // if not set..
 143         //if (!this.cacheDirectory) {
 144         //    throw {
 145         //        name: "ArgumentError",
 146         //        message: "No cacheDirectory specified"
 147         //    };
 148         // }
 149
 150     },
 151     /**
 152      *  this might be nice as a standard bit of code..
 153      */
 154
 155     parseArgv : function()
 156     {
 157
 158         var args = Array.prototype.slice.call(Seed.argv);
 159         args.shift(); //seed
 160         args.shift(); // pack.js
 161
 162         for(var i =0; i < args.length;i++) {
 163             if (args[i].substring(0,2) != '--') {
 164
 165                 throw {
 166                     name: "ArgumentError",
 167                     message: "Unknown argument: " + args[i]
 168                 };
 169             }
 170             var a = arg[i].substring(2);
 171             if (typeof(argTypes[arg[i]]) == 'undefined') {
 172                 throw {
 173                     name: "ArgumentError",
 174                     message: "Unknown argument: " + args[i]
 175                 };
 176             }
 177             // type!!?!?
 178             if (typeof(this[a]) == 'string') {
 179                 this[a] = args[i+1];
 180                 i++;
 181                 continue;
 182             }
 183             if (typeof(this[a]) == 'boolean') {
 184                 if (['false', 'true'].indexOf(args[i+1]) < 0) {
 185                     throw {
 186                         name: "ArgumentError",
 187                         message: "Unknown value for : " + args[i] + ' : ' +  args[i+1]
 188                     };
 189                 }
 190                 this[a] = args[i+1] == 'true';
 191                 i++;
 192                 continue;
 193             }
 194             if (typeof(this[a]) == 'object') { // tecnically an array.
 195                 i++;
 196                 while(i < args.length)
 197                 {
 198                     if (args[i].substring(0,2) != '--'){
 199
 200                         break;
 201                     }
 202                     this[a].push(args[i]);
 203                 }
 204                 i--;
 205             }
 206             throw {
 207                 name: "ArgumentError",
 208                 message: "Do not know how to handle: " + a
 209             };
 210         }
 211
 212
 213     },
 214
 215
 216     function showHelp()
 217     {
 218         print (""Usage seed jsdocbulid.js /var/www/seed [Gtk] \n": ");
 219         for(var i in this) {
 220             if (i.substring(0,2) != '--') {
 221                 continue;
 222             }
 223             print( i + '  ARG  : ' + this[i]);
 224             throw "DONE";
 225         }
 226     }
 227 }