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

   1 //<script type="text/javascript">
   2
   3
   4 XObject = imports.XObject.XObject;
   5 console = imports.console.console;
   6
   7
   8 Token   = imports.Token.Token;
   9 Lang    = imports.Lang.Lang;
  10
  11 /**
  12         @class Search a {@link JSDOC.TextStream} for language tokens.
  13 */
  14 TokenReader = XObject.define(
  15     function(o) {
  16
  17         this.keepDocs = true;
  18         this.keepWhite = false;
  19         this.keepComments = false;
  20         this.sepIdents = false; // seperate '.' in identifiers..
  21         XObject.extend(this, o || {});
  22
  23     },
  24     Object,
  25     {
  26         collapseWhite : false, // only reduces white space...
  27
  28         /**
  29          * tokenize a stream
  30          * @return {Array} of tokens
  31          *
  32          * ts = new TextStream(File.read(str));
  33          * tr = TokenReader({ keepComments : true, keepWhite : true });
  34          * tr.tokenize(ts)
  35          *
  36          */
  37
  38
  39
  40         tokenize : function(/**JSDOC.TextStream*/stream) {
  41             this.line =1;
  42             var tokens = [];
  43             /**@ignore*/ tokens.last    = function() { return tokens[tokens.length-1]; }
  44             /**@ignore*/ tokens.lastSym = function() {
  45                 for (var i = tokens.length-1; i >= 0; i--) {
  46                     if (!(tokens[i].is("WHIT") || tokens[i].is("COMM"))) return tokens[i];
  47                 }
  48             }
  49
  50             while (!stream.look().eof) {
  51                 if (this.read_mlcomment(stream, tokens)) continue;
  52                 if (this.read_slcomment(stream, tokens)) continue;
  53                 if (this.read_dbquote(stream, tokens))   continue;
  54                 if (this.read_snquote(stream, tokens))   continue;
  55                 if (this.read_regx(stream, tokens))      continue;
  56                 if (this.read_numb(stream, tokens))      continue;
  57                 if (this.read_punc(stream, tokens))      continue;
  58                 if (this.read_newline(stream, tokens))   continue;
  59                 if (this.read_space(stream, tokens))     continue;
  60                 if (this.read_word(stream, tokens))      continue;
  61
  62                 // if execution reaches here then an error has happened
  63                 tokens.push(new Token(stream.next(), "TOKN", "UNKNOWN_TOKEN", this.line));
  64             }
  65
  66
  67
  68             return tokens;
  69         },
  70
  71         /**
  72             @returns {Boolean} Was the token found?
  73          */
  74         read_word : function(/**JSDOC.TokenStream*/stream, tokens) {
  75             var found = "";
  76             while (!stream.look().eof && Lang.isWordChar(stream.look())) {
  77                 found += stream.next();
  78             }
  79
  80             if (found === "") {
  81                 return false;
  82             }
  83             else {
  84                 var name;
  85                 if ((name = Lang.keyword(found))) {
  86                     tokens.push(new Token(found, "KEYW", name, this.line));
  87                     return true;
  88                 }
  89                 if (!this.sepIdents || found.indexOf('.') < 0 ) {
  90                     tokens.push(new Token(found, "NAME", "NAME", this.line));
  91                     return true;
  92                 }
  93                 var n = found.split('.');
  94                 var p = false;
  95                 var _this = this;
  96                 n.forEach(function(nm) {
  97                     if (p) {
  98                         tokens.push(new Token('.', "PUNC", "DOT", _this.line));
  99                     }
 100                     p=true;
 101                     tokens.push(new Token(nm, "NAME", "NAME", _this.line));
 102                 });
 103                 return true;
 104
 105             }
 106         },
 107
 108         /**
 109             @returns {Boolean} Was the token found?
 110          */
 111         read_punc : function(/**JSDOC.TokenStream*/stream, tokens) {
 112             var found = "";
 113             var name;
 114             while (!stream.look().eof && Lang.punc(found+stream.look())) {
 115                 found += stream.next();
 116             }
 117
 118             if (found === "") {
 119                 return false;
 120             }
 121             else {
 122                 tokens.push(new Token(found, "PUNC", Lang.punc(found), this.line));
 123                 return true;
 124             }
 125         },
 126
 127         /**
 128             @returns {Boolean} Was the token found?
 129          */
 130         read_space : function(/**JSDOC.TokenStream*/stream, tokens) {
 131             var found = "";
 132
 133             while (!stream.look().eof && Lang.isSpace(stream.look()) && !Lang.isNewline(stream.look())) {
 134                 found += stream.next();
 135             }
 136
 137             if (found === "") {
 138                 return false;
 139             }
 140             //print("WHITE = " + JSON.stringify(found));
 141             if (this.collapseWhite) found = " ";
 142             if (this.keepWhite) tokens.push(new Token(found, "WHIT", "SPACE", this.line));
 143             return true;
 144
 145         },
 146
 147         /**
 148             @returns {Boolean} Was the token found?
 149          */
 150         read_newline : function(/**JSDOC.TokenStream*/stream, tokens) {
 151             var found = "";
 152             var line = this.line;
 153             while (!stream.look().eof && Lang.isNewline(stream.look())) {
 154                 this.line++;
 155                 found += stream.next();
 156             }
 157
 158             if (found === "") {
 159                 return false;
 160             }
 161             //this.line++;
 162             if (this.collapseWhite) {
 163                 found = "\n";
 164             }
 165             if (this.keepWhite) {
 166                 var last = tokens.pop();
 167                 if (last.name != "WHIT") {
 168                     tokens.push(last);
 169                 }
 170
 171                 tokens.push(new Token(found, "WHIT", "NEWLINE", line));
 172             }
 173             return true;
 174         },
 175
 176         /**
 177             @returns {Boolean} Was the token found?
 178          */
 179         read_mlcomment : function(/**JSDOC.TokenStream*/stream, tokens) {
 180             if (stream.look() == "/" && stream.look(1) == "*") {
 181                 var found = stream.next(2);
 182                 var c = '';
 183                 var line = this.line;
 184                 while (!stream.look().eof && !(stream.look(-1) == "/" && stream.look(-2) == "*")) {
 185                     c = stream.next();
 186                     if (c == "\n") this.line++;
 187                     found += c;
 188                 }
 189
 190                 // to start doclet we allow /** or /*** but not /**/ or /****
 191                 if (/^\/\*\*([^\/]|\*[^*])/.test(found) && this.keepDocs) tokens.push(new Token(found, "COMM", "JSDOC", this.line));
 192                 else if (this.keepComments) tokens.push(new Token(found, "COMM", "MULTI_LINE_COMM", line));
 193                 return true;
 194             }
 195             return false;
 196         },
 197
 198         /**
 199             @returns {Boolean} Was the token found?
 200          */
 201         read_slcomment : function(/**JSDOC.TokenStream*/stream, tokens) {
 202             var found;
 203             if (
 204                 (stream.look() == "/" && stream.look(1) == "/" && (found=stream.next(2)))
 205                 ||
 206                 (stream.look() == "<" && stream.look(1) == "!" && stream.look(2) == "-" && stream.look(3) == "-" && (found=stream.next(4)))
 207             ) {
 208                 var line = this.line;
 209                 while (!stream.look().eof && !Lang.isNewline(stream.look())) {
 210                     found += stream.next();
 211                 }
 212                 if (!stream.look().eof) {
 213                     found += stream.next();
 214                 }
 215                 if (this.keepComments) {
 216                     tokens.push(new Token(found, "COMM", "SINGLE_LINE_COMM", line));
 217                 }
 218                 this.line++;
 219                 return true;
 220             }
 221             return false;
 222         },
 223
 224         /**
 225             @returns {Boolean} Was the token found?
 226          */
 227         read_dbquote : function(/**JSDOC.TokenStream*/stream, tokens) {
 228             if (stream.look() == "\"") {
 229                 // find terminator
 230                 var string = stream.next();
 231
 232                 while (!stream.look().eof) {
 233                     if (stream.look() == "\\") {
 234                         if (Lang.isNewline(stream.look(1))) {
 235                             do {
 236                                 stream.next();
 237                             } while (!stream.look().eof && Lang.isNewline(stream.look()));
 238                             string += "\\\n";
 239                         }
 240                         else {
 241                             string += stream.next(2);
 242                         }
 243                     }
 244                     else if (stream.look() == "\"") {
 245                         string += stream.next();
 246                         tokens.push(new Token(string, "STRN", "DOUBLE_QUOTE", this.line));
 247                         return true;
 248                     }
 249                     else {
 250                         string += stream.next();
 251                     }
 252                 }
 253             }
 254             return false; // error! unterminated string
 255         },
 256
 257         /**
 258             @returns {Boolean} Was the token found?
 259          */
 260         read_snquote : function(/**JSDOC.TokenStream*/stream, tokens) {
 261             if (stream.look() == "'") {
 262                 // find terminator
 263                 var string = stream.next();
 264
 265                 while (!stream.look().eof) {
 266                     if (stream.look() == "\\") { // escape sequence
 267                         string += stream.next(2);
 268                     }
 269                     else if (stream.look() == "'") {
 270                         string += stream.next();
 271                         tokens.push(new Token(string, "STRN", "SINGLE_QUOTE", this.line));
 272                         return true;
 273                     }
 274                     else {
 275                         string += stream.next();
 276                     }
 277                 }
 278             }
 279             return false; // error! unterminated string
 280         },
 281
 282         /**
 283             @returns {Boolean} Was the token found?
 284          */
 285         read_numb : function(/**JSDOC.TokenStream*/stream, tokens) {
 286             if (stream.look() === "0" && stream.look(1) == "x") {
 287                 return this.read_hex(stream, tokens);
 288             }
 289
 290             var found = "";
 291
 292             while (!stream.look().eof && Lang.isNumber(found+stream.look())){
 293                 found += stream.next();
 294             }
 295
 296             if (found === "") {
 297                 return false;
 298             }
 299             else {
 300                 if (/^0[0-7]/.test(found)) tokens.push(new Token(found, "NUMB", "OCTAL", this.line));
 301                 else tokens.push(new Token(found, "NUMB", "DECIMAL", this.line));
 302                 return true;
 303             }
 304         },
 305         /*t:
 306             requires("../lib/JSDOC/TextStream.js");
 307             requires("../lib/JSDOC/Token.js");
 308             requires("../lib/JSDOC/Lang.js");
 309
 310             plan(3, "testing read_numb");
 311
 312             //// setup
 313             var src = "function foo(num){while (num+8.0 >= 0x20 && num < 0777){}}";
 314             var tr = new TokenReader();
 315             var tokens = tr.tokenize(new TextStream(src));
 316
 317             var hexToken, octToken, decToken;
 318             for (var i = 0; i < tokens.length; i++) {
 319                 if (tokens[i].name == "HEX_DEC") hexToken = tokens[i];
 320                 if (tokens[i].name == "OCTAL") octToken = tokens[i];
 321                 if (tokens[i].name == "DECIMAL") decToken = tokens[i];
 322             }
 323             ////
 324
 325             is(decToken.data, "8.0", "decimal number is found in source.");
 326             is(hexToken.data, "0x20", "hexdec number is found in source (issue #99).");
 327             is(octToken.data, "0777", "octal number is found in source.");
 328         */
 329
 330         /**
 331             @returns {Boolean} Was the token found?
 332          */
 333         read_hex : function(/**JSDOC.TokenStream*/stream, tokens) {
 334             var found = stream.next(2);
 335
 336             while (!stream.look().eof) {
 337                 if (Lang.isHexDec(found) && !Lang.isHexDec(found+stream.look())) { // done
 338                     tokens.push(new Token(found, "NUMB", "HEX_DEC", this.line));
 339                     return true;
 340                 }
 341                 else {
 342                     found += stream.next();
 343                 }
 344             }
 345             return false;
 346         },
 347
 348         /**
 349             @returns {Boolean} Was the token found?
 350          */
 351         read_regx : function(/**JSDOC.TokenStream*/stream, tokens) {
 352             var last;
 353             if (
 354                 stream.look() == "/"
 355                 &&
 356                 (
 357
 358                     (
 359                         !(last = tokens.lastSym()) // there is no last, the regex is the first symbol
 360                         ||
 361                         (
 362                                !last.is("NUMB")
 363                             && !last.is("NAME")
 364                             && !last.is("RIGHT_PAREN")
 365                             && !last.is("RIGHT_BRACKET")
 366                         )
 367                     )
 368                 )
 369             ) {
 370                 var regex = stream.next();
 371
 372                 while (!stream.look().eof) {
 373                     if (stream.look() == "\\") { // escape sequence
 374                         regex += stream.next(2);
 375                     }
 376                     else if (stream.look() == "/") {
 377                         regex += stream.next();
 378
 379                         while (/[gmi]/.test(stream.look())) {
 380                             regex += stream.next();
 381                         }
 382
 383                         tokens.push(new Token(regex, "REGX", "REGX", this.line));
 384                         return true;
 385                     }
 386                     else {
 387                         regex += stream.next();
 388                     }
 389                 }
 390                 // error: unterminated regex
 391             }
 392             return false;
 393         }
 394 });