JSDOC/TokenStream.js
[gnome.introspection-doc-generator] / JSDOC / TokenStream.js
1 //<script type="text/javscript">
2
3 imports['Object.js'].load(Object);
4
5 JSDOC   = imports['JSDOC.js'].JSDOC;
6 console = imports['console.js'].console;
7 Token   = imports['JSDOC/Token.js'].Token;
8 Lang    = imports['JSDOC/Lang.js'].Lang;
9
10 /**
11         @constructor
12 */
13  
14 TokenStream = Object.define(
15     function(tokens) {
16      
17         
18         this.tokens = (tokens || []);
19        // Seed.print(this.tokens.length);
20         this.rewind();
21     },
22     Object,
23     {
24         cursor : -1, // where are we in the stream.
25         
26         rewind : function() {
27             this.cursor = -1;
28         },
29
30         /**
31             @type JSDOC.Token
32         */
33         look : function(/**Number*/n, /**Boolean*/considerWhitespace) {
34             if (typeof n == "undefined") n = 0;
35
36             if (considerWhitespace == true) {
37                 if (this.cursor+n < 0 || this.cursor+n > this.tokens.length) return {};
38                 return this.tokens[this.cursor+n];
39             }
40             else {
41                 var count = 0;
42                 var i = this.cursor;
43
44                 while (true) {
45                     if (i < 0) return new Token("", "VOID", "START_OF_STREAM");
46                     else if (i > this.tokens.length) return new Token("", "VOID", "END_OF_STREAM");
47
48                     if (i != this.cursor && (this.tokens[i] === undefined || this.tokens[i].is("WHIT"))) {
49                         if (n < 0) i--; else i++;
50                         continue;
51                     }
52                     
53                     if (count == Math.abs(n)) {
54                         return this.tokens[i];
55                     }
56                     count++;
57                     (n < 0)? i-- : i++;
58                 }
59
60                 return new Token("", "VOID", "STREAM_ERROR"); // because null isn't an object and caller always expects an object
61             }
62         },
63
64         lookFor : function (data)
65         {
66             // non tree version..
67             var i = this.cursor < 0 ? 0 : this.cursor ;
68             
69             while (true) {
70                 if (i >= this.tokens.length) return -1;
71                 if (this.tokens[i].data == data) {
72                     return i;
73                 }
74                 i++;
75                 
76             }
77             // should not get here!
78             return -1;
79
80         },
81
82
83         /**
84          * look ahead (or back) x number of tokens (which are not comment or whitespace)
85          * ?? used any more?
86          */
87         lookTok : function(/**Number*/n) {
88             if (typeof n == "undefined") n = 1;
89
90             
91             var count = 0;
92             var i = this.cursor;
93
94             while (true) {
95                 if (i < 0) {
96                     if (n > -1) {
97                         i = 0; continue;
98                     }
99                 }
100                 else if (i > this.tokens.length) return false;
101
102                 if (i != this.cursor && (this.tokens[i] === undefined || this.tokens[i].is("WHIT") || this.tokens[i].is("COMM"))) {
103                     if (n < 0) i--; else i++;
104                     continue;
105                 }
106                 
107                 if (count == Math.abs(n)) {
108                     return this.tokens[i];
109                 }
110                 count++;
111                 (n < 0)? i-- : i++;
112             }
113
114             return false; // because null isn't an object and caller always expects an object;
115             
116         },
117
118         /**
119             @type JSDOC.Token|JSDOC.Token[]| null!
120         */
121         next : function(/**Number*/howMany) {
122             if (typeof howMany == "undefined") howMany = 1;
123             if (howMany < 1) return null;
124             var got = [];
125
126             for (var i = 1; i <= howMany; i++) {
127                 if (this.cursor+i >= this.tokens.length) {
128                     return null;
129                 }
130                 got.push(this.tokens[this.cursor+i]);
131             }
132             this.cursor += howMany;
133
134             if (howMany == 1) {
135                 return got[0];
136             }
137             else return got;
138         },
139         // what about comments after 'function'...
140         // is this used ???
141         nextTok  : function() {
142             return this.nextNonSpace();
143         },
144         nextNonSpace : function ()
145         {
146             
147             while (true) {
148                 tok = this.next(1);
149                 if (!tok) {
150                     return false;
151                 }
152                 if (tok.is('WHIT') ||  tok.is('COMM')) {
153                     continue;
154                 }
155                 return tok;
156             }
157         },
158         /**
159          *    @type JSDOC.Token[]
160          * @param start {String}  token name or data (eg. '{'
161          * @param stop {String} (Optional) token name or data (eg. '}'
162          */
163         balance : function(/**String*/start, /**String*/stop) {
164             
165             start = typeof(Lang.matching(start)) == 'undefined' ? Lang.punc(start) : start;
166             
167             if (!stop) stop = Lang.matching(start);
168             
169             var depth = 0;
170             var got = [];
171             var started = false;
172             //Seed.print("STOP:" + stop);
173             while ((token = this.look())) {
174                 if (token.is(start)) {
175                     depth++;
176                     started = true;
177                 }
178                 
179                 if (started) {
180                     got.push(token);
181                 }
182                 
183                 if (token.is(stop)) {
184                     depth--;
185                     if (depth == 0) return got;
186                 }
187                 if (!this.next()) break;
188             }
189         },
190
191         getMatchingToken : function(/**String*/start, /**String*/stop) {
192             var depth = 0;
193             var cursor = this.cursor;
194             
195             if (!start) {
196                 start = Lang.matching(stop);
197                 depth = 1;
198             }
199             if (!stop) stop = Lang.matching(start);
200             
201             while ((token = this.tokens[cursor])) {
202                 if (token.is(start)) {
203                     depth++;
204                 }
205                 
206                 if (token.is(stop) && cursor) {
207                     depth--;
208                     if (depth == 0) return this.tokens[cursor];
209                 }
210                 cursor++;
211             }
212         },
213
214         insertAhead : function(/**JSDOC.Token*/token) {
215             this.tokens.splice(this.cursor+1, 0, token);
216         },
217          
218         remaining : function() {
219             var ret = [];
220             while (true) {
221                 var tok = this.look(1,true);
222                 if (!tok || !tok.is || tok.is('VOID')) {
223                     return ret;
224                 }
225                 ret.push(this.next(1));
226             }
227         },
228          
229
230         arrayToString : function(ar) {
231             console.log(typeof(ar));
232             var ret = [];
233             ar.forEach(function(e) {
234                 ret.push(e.data);
235             })
236             return ret.join('');
237         },
238         dump: function()
239         {
240             this.tokens.forEach(function(t) {
241                 print(t.toString());
242             });
243         }
244 });
245