1 //<script type="text/javascript">
4 XObject = imports.XObject.XObject;
5 console = imports.console.console;
8 Token = imports.Token.Token;
9 Lang = imports.Lang.Lang;
12 @class Search a {@link JSDOC.TextStream} for language tokens.
14 TokenReader = XObject.define(
18 this.keepWhite = false;
19 this.keepComments = false;
20 this.sepIdents = false; // seperate '.' in identifiers..
21 XObject.extend(this, o || {});
30 * @return {Array} of tokens
32 * ts = new TextStream(File.read(str));
33 * tr = TokenReader({ keepComments : true, keepWhite : true });
40 tokenize : function(/**JSDOC.TextStream*/stream) {
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];
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;
62 // if execution reaches here then an error has happened
63 tokens.push(new Token(stream.next(), "TOKN", "UNKNOWN_TOKEN", this.line));
72 @returns {Boolean} Was the token found?
74 read_word : function(/**JSDOC.TokenStream*/stream, tokens) {
76 while (!stream.look().eof && Lang.isWordChar(stream.look())) {
77 found += stream.next();
85 if ((name = Lang.keyword(found))) {
86 tokens.push(new Token(found, "KEYW", name, this.line));
89 if (!this.sepIdents || found.indexOf('.') < 0 ) {
90 tokens.push(new Token(found, "NAME", "NAME", this.line));
93 var n = found.split('.');
95 n.forEach(function(nm) {
97 tokens.push(new Token('.', "PUNC", "DOT", this.line));
100 tokens.push(new Token(nm, "NAME", "NAME", this.line));
108 @returns {Boolean} Was the token found?
110 read_punc : function(/**JSDOC.TokenStream*/stream, tokens) {
113 while (!stream.look().eof && Lang.punc(found+stream.look())) {
114 found += stream.next();
121 tokens.push(new Token(found, "PUNC", Lang.punc(found), this.line));
127 @returns {Boolean} Was the token found?
129 read_space : function(/**JSDOC.TokenStream*/stream, tokens) {
132 while (!stream.look().eof && Lang.isSpace(stream.look())) {
133 found += stream.next();
140 if (this.collapseWhite) found = " ";
141 if (this.keepWhite) tokens.push(new Token(found, "WHIT", "SPACE", this.line));
147 @returns {Boolean} Was the token found?
149 read_newline : function(/**JSDOC.TokenStream*/stream, tokens) {
152 while (!stream.look().eof && Lang.isNewline(stream.look())) {
154 found += stream.next();
161 if (this.collapseWhite) found = "\n";
162 if (this.keepWhite) tokens.push(new Token(found, "WHIT", "NEWLINE", this.line));
168 @returns {Boolean} Was the token found?
170 read_mlcomment : function(/**JSDOC.TokenStream*/stream, tokens) {
171 if (stream.look() == "/" && stream.look(1) == "*") {
172 var found = stream.next(2);
174 while (!stream.look().eof && !(stream.look(-1) == "/" && stream.look(-2) == "*")) {
176 if (c == "\n") this.line++;
180 // to start doclet we allow /** or /*** but not /**/ or /****
181 if (/^\/\*\*([^\/]|\*[^*])/.test(found) && this.keepDocs) tokens.push(new Token(found, "COMM", "JSDOC", this.line));
182 else if (this.keepComments) tokens.push(new Token(found, "COMM", "MULTI_LINE_COMM", this.line));
189 @returns {Boolean} Was the token found?
191 read_slcomment : function(/**JSDOC.TokenStream*/stream, tokens) {
194 (stream.look() == "/" && stream.look(1) == "/" && (found=stream.next(2)))
196 (stream.look() == "<" && stream.look(1) == "!" && stream.look(2) == "-" && stream.look(3) == "-" && (found=stream.next(4)))
199 while (!stream.look().eof && !Lang.isNewline(stream.look())) {
200 found += stream.next();
203 if (this.keepComments) {
204 tokens.push(new Token(found, "COMM", "SINGLE_LINE_COMM", this.line));
213 @returns {Boolean} Was the token found?
215 read_dbquote : function(/**JSDOC.TokenStream*/stream, tokens) {
216 if (stream.look() == "\"") {
218 var string = stream.next();
220 while (!stream.look().eof) {
221 if (stream.look() == "\\") {
222 if (Lang.isNewline(stream.look(1))) {
225 } while (!stream.look().eof && Lang.isNewline(stream.look()));
229 string += stream.next(2);
232 else if (stream.look() == "\"") {
233 string += stream.next();
234 tokens.push(new Token(string, "STRN", "DOUBLE_QUOTE", this.line));
238 string += stream.next();
242 return false; // error! unterminated string
246 @returns {Boolean} Was the token found?
248 read_snquote : function(/**JSDOC.TokenStream*/stream, tokens) {
249 if (stream.look() == "'") {
251 var string = stream.next();
253 while (!stream.look().eof) {
254 if (stream.look() == "\\") { // escape sequence
255 string += stream.next(2);
257 else if (stream.look() == "'") {
258 string += stream.next();
259 tokens.push(new Token(string, "STRN", "SINGLE_QUOTE", this.line));
263 string += stream.next();
267 return false; // error! unterminated string
271 @returns {Boolean} Was the token found?
273 read_numb : function(/**JSDOC.TokenStream*/stream, tokens) {
274 if (stream.look() === "0" && stream.look(1) == "x") {
275 return this.read_hex(stream, tokens);
280 while (!stream.look().eof && Lang.isNumber(found+stream.look())){
281 found += stream.next();
288 if (/^0[0-7]/.test(found)) tokens.push(new Token(found, "NUMB", "OCTAL", this.line));
289 else tokens.push(new Token(found, "NUMB", "DECIMAL", this.line));
294 requires("../lib/JSDOC/TextStream.js");
295 requires("../lib/JSDOC/Token.js");
296 requires("../lib/JSDOC/Lang.js");
298 plan(3, "testing read_numb");
301 var src = "function foo(num){while (num+8.0 >= 0x20 && num < 0777){}}";
302 var tr = new TokenReader();
303 var tokens = tr.tokenize(new TextStream(src));
305 var hexToken, octToken, decToken;
306 for (var i = 0; i < tokens.length; i++) {
307 if (tokens[i].name == "HEX_DEC") hexToken = tokens[i];
308 if (tokens[i].name == "OCTAL") octToken = tokens[i];
309 if (tokens[i].name == "DECIMAL") decToken = tokens[i];
313 is(decToken.data, "8.0", "decimal number is found in source.");
314 is(hexToken.data, "0x20", "hexdec number is found in source (issue #99).");
315 is(octToken.data, "0777", "octal number is found in source.");
319 @returns {Boolean} Was the token found?
321 read_hex : function(/**JSDOC.TokenStream*/stream, tokens) {
322 var found = stream.next(2);
324 while (!stream.look().eof) {
325 if (Lang.isHexDec(found) && !Lang.isHexDec(found+stream.look())) { // done
326 tokens.push(new Token(found, "NUMB", "HEX_DEC", this.line));
330 found += stream.next();
337 @returns {Boolean} Was the token found?
339 read_regx : function(/**JSDOC.TokenStream*/stream, tokens) {
347 !(last = tokens.lastSym()) // there is no last, the regex is the first symbol
352 && !last.is("RIGHT_PAREN")
353 && !last.is("RIGHT_BRACKET")
358 var regex = stream.next();
360 while (!stream.look().eof) {
361 if (stream.look() == "\\") { // escape sequence
362 regex += stream.next(2);
364 else if (stream.look() == "/") {
365 regex += stream.next();
367 while (/[gmi]/.test(stream.look())) {
368 regex += stream.next();
371 tokens.push(new Token(regex, "REGX", "REGX", this.line));
375 regex += stream.next();
378 // error: unterminated regex