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
  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                 n.forEach(function(nm) {
  96                     if (p) {
  97                         tokens.push(new Token('.', "PUNC", "DOT", this.line));
  98                     }
  99                     p=true;
 100                     tokens.push(new Token(nm, "NAME", "NAME", this.line));
 101                 });
 102                 return true;
 103
 104             }
 105         },
 106
 107         /**
 108             @returns {Boolean} Was the token found?
 109          */
 110         read_punc : function(/**JSDOC.TokenStream*/stream, tokens) {
 111             var found = "";
 112             var name;
 113             while (!stream.look().eof && Lang.punc(found+stream.look())) {
 114                 found += stream.next();
 115             }
 116
 117             if (found === "") {
 118                 return false;
 119             }
 120             else {
 121                 tokens.push(new Token(found, "PUNC", Lang.punc(found), this.line));
 122                 return true;
 123             }
 124         },
 125
 126         /**
 127             @returns {Boolean} Was the token found?
 128          */
 129         read_space : function(/**JSDOC.TokenStream*/stream, tokens) {
 130             var found = "";
 131
 132             while (!stream.look().eof && Lang.isSpace(stream.look())) {
 133                 found += stream.next();
 134             }
 135
 136             if (found === "") {
 137                 return false;
 138             }
 139             else {
 140                 if (this.collapseWhite) found = " ";
 141                 if (this.keepWhite) tokens.push(new Token(found, "WHIT", "SPACE", this.line));
 142                 return true;
 143             }
 144         },
 145
 146         /**
 147             @returns {Boolean} Was the token found?
 148          */
 149         read_newline : function(/**JSDOC.TokenStream*/stream, tokens) {
 150             var found = "";
 151
 152             while (!stream.look().eof && Lang.isNewline(stream.look())) {
 153                 this.line++;
 154                 found += stream.next();
 155             }
 156
 157             if (found === "") {
 158                 return false;
 159             }
 160             else {
 161                 if (this.collapseWhite) found = "\n";
 162                 if (this.keepWhite) {
 163                     tokens.push(new Token(found, "WHIT", "NEWLINE", this.line));
 164                 }
 165                 return true;
 166             }
 167         },
 168
 169         /**
 170             @returns {Boolean} Was the token found?
 171          */
 172         read_mlcomment : function(/**JSDOC.TokenStream*/stream, tokens) {
 173             if (stream.look() == "/" && stream.look(1) == "*") {
 174                 var found = stream.next(2);
 175                 var c = '';
 176                 while (!stream.look().eof && !(stream.look(-1) == "/" && stream.look(-2) == "*")) {
 177                     c = stream.next();
 178                     if (c == "\n") this.line++;
 179                     found += c;
 180                 }
 181
 182                 // to start doclet we allow /** or /*** but not /**/ or /****
 183                 if (/^\/\*\*([^\/]|\*[^*])/.test(found) && this.keepDocs) tokens.push(new Token(found, "COMM", "JSDOC", this.line));
 184                 else if (this.keepComments) tokens.push(new Token(found, "COMM", "MULTI_LINE_COMM", this.line));
 185                 return true;
 186             }
 187             return false;
 188         },
 189
 190         /**
 191             @returns {Boolean} Was the token found?
 192          */
 193         read_slcomment : function(/**JSDOC.TokenStream*/stream, tokens) {
 194             var found;
 195             if (
 196                 (stream.look() == "/" && stream.look(1) == "/" && (found=stream.next(2)))
 197                 ||
 198                 (stream.look() == "<" && stream.look(1) == "!" && stream.look(2) == "-" && stream.look(3) == "-" && (found=stream.next(4)))
 199             ) {
 200
 201                 while (!stream.look().eof && !Lang.isNewline(stream.look())) {
 202                     found += stream.next();
 203                 }
 204
 205                 if (this.keepComments) {
 206                     tokens.push(new Token(found, "COMM", "SINGLE_LINE_COMM", this.line));
 207                 }
 208                 this.line++;
 209                 return true;
 210             }
 211             return false;
 212         },
 213
 214         /**
 215             @returns {Boolean} Was the token found?
 216          */
 217         read_dbquote : function(/**JSDOC.TokenStream*/stream, tokens) {
 218             if (stream.look() == "\"") {
 219                 // find terminator
 220                 var string = stream.next();
 221
 222                 while (!stream.look().eof) {
 223                     if (stream.look() == "\\") {
 224                         if (Lang.isNewline(stream.look(1))) {
 225                             do {
 226                                 stream.next();
 227                             } while (!stream.look().eof && Lang.isNewline(stream.look()));
 228                             string += "\\\n";
 229                         }
 230                         else {
 231                             string += stream.next(2);
 232                         }
 233                     }
 234                     else if (stream.look() == "\"") {
 235                         string += stream.next();
 236                         tokens.push(new Token(string, "STRN", "DOUBLE_QUOTE", this.line));
 237                         return true;
 238                     }
 239                     else {
 240                         string += stream.next();
 241                     }
 242                 }
 243             }
 244             return false; // error! unterminated string
 245         },
 246
 247         /**
 248             @returns {Boolean} Was the token found?
 249          */
 250         read_snquote : function(/**JSDOC.TokenStream*/stream, tokens) {
 251             if (stream.look() == "'") {
 252                 // find terminator
 253                 var string = stream.next();
 254
 255                 while (!stream.look().eof) {
 256                     if (stream.look() == "\\") { // escape sequence
 257                         string += stream.next(2);
 258                     }
 259                     else if (stream.look() == "'") {
 260                         string += stream.next();
 261                         tokens.push(new Token(string, "STRN", "SINGLE_QUOTE", this.line));
 262                         return true;
 263                     }
 264                     else {
 265                         string += stream.next();
 266                     }
 267                 }
 268             }
 269             return false; // error! unterminated string
 270         },
 271
 272         /**
 273             @returns {Boolean} Was the token found?
 274          */
 275         read_numb : function(/**JSDOC.TokenStream*/stream, tokens) {
 276             if (stream.look() === "0" && stream.look(1) == "x") {
 277                 return this.read_hex(stream, tokens);
 278             }
 279
 280             var found = "";
 281
 282             while (!stream.look().eof && Lang.isNumber(found+stream.look())){
 283                 found += stream.next();
 284             }
 285
 286             if (found === "") {
 287                 return false;
 288             }
 289             else {
 290                 if (/^0[0-7]/.test(found)) tokens.push(new Token(found, "NUMB", "OCTAL", this.line));
 291                 else tokens.push(new Token(found, "NUMB", "DECIMAL", this.line));
 292                 return true;
 293             }
 294         },
 295         /*t:
 296             requires("../lib/JSDOC/TextStream.js");
 297             requires("../lib/JSDOC/Token.js");
 298             requires("../lib/JSDOC/Lang.js");
 299
 300             plan(3, "testing read_numb");
 301
 302             //// setup
 303             var src = "function foo(num){while (num+8.0 >= 0x20 && num < 0777){}}";
 304             var tr = new TokenReader();
 305             var tokens = tr.tokenize(new TextStream(src));
 306
 307             var hexToken, octToken, decToken;
 308             for (var i = 0; i < tokens.length; i++) {
 309                 if (tokens[i].name == "HEX_DEC") hexToken = tokens[i];
 310                 if (tokens[i].name == "OCTAL") octToken = tokens[i];
 311                 if (tokens[i].name == "DECIMAL") decToken = tokens[i];
 312             }
 313             ////
 314
 315             is(decToken.data, "8.0", "decimal number is found in source.");
 316             is(hexToken.data, "0x20", "hexdec number is found in source (issue #99).");
 317             is(octToken.data, "0777", "octal number is found in source.");
 318         */
 319
 320         /**
 321             @returns {Boolean} Was the token found?
 322          */
 323         read_hex : function(/**JSDOC.TokenStream*/stream, tokens) {
 324             var found = stream.next(2);
 325
 326             while (!stream.look().eof) {
 327                 if (Lang.isHexDec(found) && !Lang.isHexDec(found+stream.look())) { // done
 328                     tokens.push(new Token(found, "NUMB", "HEX_DEC", this.line));
 329                     return true;
 330                 }
 331                 else {
 332                     found += stream.next();
 333                 }
 334             }
 335             return false;
 336         },
 337
 338         /**
 339             @returns {Boolean} Was the token found?
 340          */
 341         read_regx : function(/**JSDOC.TokenStream*/stream, tokens) {
 342             var last;
 343             if (
 344                 stream.look() == "/"
 345                 &&
 346                 (
 347
 348                     (
 349                         !(last = tokens.lastSym()) // there is no last, the regex is the first symbol
 350                         ||
 351                         (
 352                                !last.is("NUMB")
 353                             && !last.is("NAME")
 354                             && !last.is("RIGHT_PAREN")
 355                             && !last.is("RIGHT_BRACKET")
 356                         )
 357                     )
 358                 )
 359             ) {
 360                 var regex = stream.next();
 361
 362                 while (!stream.look().eof) {
 363                     if (stream.look() == "\\") { // escape sequence
 364                         regex += stream.next(2);
 365                     }
 366                     else if (stream.look() == "/") {
 367                         regex += stream.next();
 368
 369                         while (/[gmi]/.test(stream.look())) {
 370                             regex += stream.next();
 371                         }
 372
 373                         tokens.push(new Token(regex, "REGX", "REGX", this.line));
 374                         return true;
 375                     }
 376                     else {
 377                         regex += stream.next();
 378                     }
 379                 }
 380                 // error: unterminated regex
 381             }
 382             return false;
 383         }
 384 });