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                 print(i);
96                 if (i < 0) {
97                     if (n > -1) {
98                         i = 0; continue;
99                     }
100                 }
101                 else if (i > this.tokens.length) return false;
102
103                 if (i != this.cursor && (this.tokens[i] === undefined || this.tokens[i].is("WHIT") || this.tokens[i].is("COMM"))) {
104                     if (n < 0) i--; else i++;
105                     continue;
106                 }
107                 
108                 if (count == Math.abs(n)) {
109                     return this.tokens[i];
110                 }
111                 count++;
112                 (n < 0)? i-- : i++;
113             }
114
115             return false; // because null isn't an object and caller always expects an object;
116             
117         },
118
119         /**
120             @type JSDOC.Token|JSDOC.Token[]| null!
121         */
122         next : function(/**Number*/howMany) {
123             if (typeof howMany == "undefined") howMany = 1;
124             if (howMany < 1) return null;
125             var got = [];
126
127             for (var i = 1; i <= howMany; i++) {
128                 if (this.cursor+i >= this.tokens.length) {
129                     return null;
130                 }
131                 got.push(this.tokens[this.cursor+i]);
132             }
133             this.cursor += howMany;
134
135             if (howMany == 1) {
136                 return got[0];
137             }
138             else return got;
139         },
140         // what about comments after 'function'...
141         // is this used ???
142         nextTok  : function() {
143             return this.nextNonSpace();
144         },
145         nextNonSpace : function ()
146         {
147             
148             while (true) {
149                 tok = this.next(1);
150                 if (!tok) {
151                     return false;
152                 }
153                 if (tok.is('WHIT') ||  tok.is('COMM')) {
154                     continue;
155                 }
156                 return tok;
157             }
158         },
159         /**
160          *    @type JSDOC.Token[]
161          * @param start {String}  token name or data (eg. '{'
162          * @param stop {String} (Optional) token name or data (eg. '}'
163          */
164         balance : function(/**String*/start, /**String*/stop) {
165             
166             start = typeof(Lang.matching(start)) == 'undefined' ? Lang.punc(start) : start;
167             
168             if (!stop) stop = Lang.matching(start);
169             
170             var depth = 0;
171             var got = [];
172             var started = false;
173             //Seed.print("STOP:" + stop);
174             while ((token = this.look())) {
175                 if (token.is(start)) {
176                     depth++;
177                     started = true;
178                 }
179                 
180                 if (started) {
181                     got.push(token);
182                 }
183                 
184                 if (token.is(stop)) {
185                     depth--;
186                     if (depth == 0) return got;
187                 }
188                 if (!this.next()) break;
189             }
190         },
191
192         getMatchingToken : function(/**String*/start, /**String*/stop) {
193             var depth = 0;
194             var cursor = this.cursor;
195             
196             if (!start) {
197                 start = Lang.matching(stop);
198                 depth = 1;
199             }
200             if (!stop) stop = Lang.matching(start);
201             
202             while ((token = this.tokens[cursor])) {
203                 if (token.is(start)) {
204                     depth++;
205                 }
206                 
207                 if (token.is(stop) && cursor) {
208                     depth--;
209                     if (depth == 0) return this.tokens[cursor];
210                 }
211                 cursor++;
212             }
213         },
214
215         insertAhead : function(/**JSDOC.Token*/token) {
216             this.tokens.splice(this.cursor+1, 0, token);
217         },
218          
219         remaining : function() {
220             var ret = [];
221             while (true) {
222                 var tok = this.look(1,true);
223                 if (!tok || !tok.is || tok.is('VOID')) {
224                     return ret;
225                 }
226                 ret.push(this.next(1));
227             }
228         },
229          
230
231         arrayToString : function(ar) {
232             console.log(typeof(ar));
233             var ret = [];
234             ar.forEach(function(e) {
235                 ret.push(e.data);
236             })
237             return ret.join('');
238         },
239         dump: function()
240         {
241             this.tokens.forEach(function(t) {
242                 print(t.toString());
243             });
244         }
245 });
246