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