fix cr/lfs and remove trailing whitespaces...
[supertux.git] / src / squirrel / squirrel / sqobject.cpp
1 /*
2         see copyright notice in squirrel.h
3 */
4 #include "sqpcheader.h"
5 #include "sqvm.h"
6 #include "sqstring.h"
7 #include "sqarray.h"
8 #include "sqtable.h"
9 #include "squserdata.h"
10 #include "sqfuncproto.h"
11 #include "sqclass.h"
12 #include "sqclosure.h"
13
14 SQString *SQString::Create(SQSharedState *ss,const SQChar *s,SQInteger len)
15 {
16         SQString *str=ADD_STRING(ss,s,len);
17         str->_sharedstate=ss;
18         return str;
19 }
20
21 void SQString::Release()
22 {
23         REMOVE_STRING(_sharedstate,this);
24 }
25
26 SQInteger SQString::Next(const SQObjectPtr &refpos, SQObjectPtr &outkey, SQObjectPtr &outval)
27 {
28         SQInteger idx = (SQInteger)TranslateIndex(refpos);
29         while(idx < _len){
30                 outkey = (SQInteger)idx;
31                 outval = SQInteger(_val[idx]);
32                 //return idx for the next iteration
33                 return ++idx;
34         }
35         //nothing to iterate anymore
36         return -1;
37 }
38
39 SQUnsignedInteger TranslateIndex(const SQObjectPtr &idx)
40 {
41         switch(type(idx)){
42                 case OT_NULL:
43                         return 0;
44                 case OT_INTEGER:
45                         return (SQUnsignedInteger)_integer(idx);
46                 default: assert(0); break;
47         }
48         return 0;
49 }
50
51 SQWeakRef *SQRefCounted::GetWeakRef(SQObjectType type)
52 {
53         if(!_weakref) {
54                 sq_new(_weakref,SQWeakRef);
55                 _weakref->_obj._type = type;
56                 _weakref->_obj._unVal.pRefCounted = this;
57         }
58         return _weakref;
59 }
60
61 SQRefCounted::~SQRefCounted()
62 {
63         if(_weakref) {
64                 _weakref->_obj._type = OT_NULL;
65                 _weakref->_obj._unVal.pRefCounted = NULL;
66         }
67 }
68
69 void SQWeakRef::Release() {
70         if(ISREFCOUNTED(_obj._type)) {
71                 _obj._unVal.pRefCounted->_weakref = NULL;
72         }
73         sq_delete(this,SQWeakRef);
74 }
75
76 bool SQDelegable::GetMetaMethod(SQVM *v,SQMetaMethod mm,SQObjectPtr &res) {
77         if(_delegate) {
78                 return _delegate->Get((*_ss(v)->_metamethods)[mm],res);
79         }
80         return false;
81 }
82
83 bool SQDelegable::SetDelegate(SQTable *mt)
84 {
85         SQTable *temp = mt;
86         while (temp) {
87                 if (temp->_delegate == this) return false; //cycle detected
88                 temp = temp->_delegate;
89         }
90         if (mt) __ObjAddRef(mt);
91         __ObjRelease(_delegate);
92         _delegate = mt;
93         return true;
94 }
95
96 bool SQGenerator::Yield(SQVM *v)
97 {
98         if(_state==eSuspended) { v->Raise_Error(_SC("internal vm error, yielding dead generator"));  return false;}
99         if(_state==eDead) { v->Raise_Error(_SC("internal vm error, yielding a dead generator")); return false; }
100         SQInteger size = v->_top-v->_stackbase;
101         _ci=*v->ci;
102         _stack.resize(size);
103         for(SQInteger n =0; n<size; n++) {
104                 _stack._vals[n] = v->_stack[v->_stackbase+n];
105                 v->_stack[v->_stackbase+n] = _null_;
106         }
107         SQInteger nvargs = v->ci->_vargs.size;
108         SQInteger vargsbase = v->ci->_vargs.base;
109         for(SQInteger j = nvargs - 1; j >= 0; j--) {
110                 _vargsstack.push_back(v->_vargsstack[vargsbase+j]);
111         }
112         _ci._generator=_null_;
113         for(SQInteger i=0;i<_ci._etraps;i++) {
114                 _etraps.push_back(v->_etraps.top());
115                 v->_etraps.pop_back();
116         }
117         _state=eSuspended;
118         return true;
119 }
120
121 bool SQGenerator::Resume(SQVM *v,SQInteger target)
122 {
123         SQInteger size=_stack.size();
124         if(_state==eDead){ v->Raise_Error(_SC("resuming dead generator")); return false; }
125         if(_state==eRunning){ v->Raise_Error(_SC("resuming active generator")); return false; }
126         SQInteger prevtop=v->_top-v->_stackbase;
127         PUSH_CALLINFO(v,_ci);
128         SQInteger oldstackbase=v->_stackbase;
129         v->_stackbase=v->_top;
130         v->ci->_target=target;
131         v->ci->_generator=SQObjectPtr(this);
132         v->ci->_vargs.size = _vargsstack.size();
133
134         for(SQInteger i=0;i<_ci._etraps;i++) {
135                 v->_etraps.push_back(_etraps.top());
136                 _etraps.pop_back();
137         }
138         for(SQInteger n =0; n<size; n++) {
139                 v->_stack[v->_stackbase+n] = _stack._vals[n];
140                 _stack._vals[0] = _null_;
141         }
142         while(_vargsstack.size()) {
143                 v->_vargsstack.push_back(_vargsstack.back());
144                 _vargsstack.pop_back();
145         }
146         v->ci->_vargs.base = v->_vargsstack.size() - v->ci->_vargs.size;
147         v->_top=v->_stackbase+size;
148         v->ci->_prevtop=prevtop;
149         v->ci->_prevstkbase=v->_stackbase-oldstackbase;
150         _state=eRunning;
151         return true;
152 }
153
154 void SQArray::Extend(const SQArray *a){
155         SQInteger xlen;
156         if((xlen=a->Size()))
157                 for(SQInteger i=0;i<xlen;i++)
158                         Append(a->_values[i]);
159 }
160
161 const SQChar* SQFunctionProto::GetLocal(SQVM *vm,SQUnsignedInteger stackbase,SQUnsignedInteger nseq,SQUnsignedInteger nop)
162 {
163         SQUnsignedInteger nvars=_localvarinfos.size();
164         const SQChar *res=NULL;
165         if(nvars>=nseq){
166                 for(SQUnsignedInteger i=0;i<nvars;i++){
167                         if(_localvarinfos[i]._start_op<=nop && _localvarinfos[i]._end_op>=nop)
168                         {
169                                 if(nseq==0){
170                                         vm->Push(vm->_stack[stackbase+_localvarinfos[i]._pos]);
171                                         res=_stringval(_localvarinfos[i]._name);
172                                         break;
173                                 }
174                                 nseq--;
175                         }
176                 }
177         }
178         return res;
179 }
180
181 SQInteger SQFunctionProto::GetLine(SQInstruction *curr)
182 {
183         SQInteger op = (SQInteger)(curr-_instructions._vals);
184         SQInteger line=_lineinfos[0]._line;
185         for(SQUnsignedInteger i=1;i<_lineinfos.size();i++){
186                 if(_lineinfos[i]._op>=op)
187                         return line;
188                 line=_lineinfos[i]._line;
189         }
190         return line;
191 }
192
193 //#define _ERROR_TRAP() error_trap:
194 #define _CHECK_IO(exp)  { if(!exp)return false; }
195 bool SafeWrite(HSQUIRRELVM v,SQWRITEFUNC write,SQUserPointer up,SQUserPointer dest,SQInteger size)
196 {
197         if(write(up,dest,size) != size) {
198                 v->Raise_Error(_SC("io error (write function failure)"));
199                 return false;
200         }
201         return true;
202 }
203
204 bool SafeRead(HSQUIRRELVM v,SQWRITEFUNC read,SQUserPointer up,SQUserPointer dest,SQInteger size)
205 {
206         if(size && read(up,dest,size) != size) {
207                 v->Raise_Error(_SC("io error, read function failure, the origin stream could be corrupted/trucated"));
208                 return false;
209         }
210         return true;
211 }
212
213 bool WriteTag(HSQUIRRELVM v,SQWRITEFUNC write,SQUserPointer up,SQInteger tag)
214 {
215         return SafeWrite(v,write,up,&tag,sizeof(tag));
216 }
217
218 bool CheckTag(HSQUIRRELVM v,SQWRITEFUNC read,SQUserPointer up,SQInteger tag)
219 {
220         SQInteger t;
221         _CHECK_IO(SafeRead(v,read,up,&t,sizeof(t)));
222         if(t != tag){
223                 v->Raise_Error(_SC("invalid or corrupted closure stream"));
224                 return false;
225         }
226         return true;
227 }
228
229 bool WriteObject(HSQUIRRELVM v,SQUserPointer up,SQWRITEFUNC write,SQObjectPtr &o)
230 {
231         _CHECK_IO(SafeWrite(v,write,up,&type(o),sizeof(SQObjectType)));
232         switch(type(o)){
233         case OT_STRING:
234                 _CHECK_IO(SafeWrite(v,write,up,&_string(o)->_len,sizeof(SQInteger)));
235                 _CHECK_IO(SafeWrite(v,write,up,_stringval(o),rsl(_string(o)->_len)));
236                 break;
237         case OT_INTEGER:
238                 _CHECK_IO(SafeWrite(v,write,up,&_integer(o),sizeof(SQInteger)));break;
239         case OT_FLOAT:
240                 _CHECK_IO(SafeWrite(v,write,up,&_float(o),sizeof(SQFloat)));break;
241         case OT_NULL:
242                 break;
243         default:
244                 v->Raise_Error(_SC("cannot serialize a %s"),GetTypeName(o));
245                 return false;
246         }
247         return true;
248 }
249
250 bool ReadObject(HSQUIRRELVM v,SQUserPointer up,SQREADFUNC read,SQObjectPtr &o)
251 {
252         SQObjectType t;
253         _CHECK_IO(SafeRead(v,read,up,&t,sizeof(SQObjectType)));
254         switch(t){
255         case OT_STRING:{
256                 SQInteger len;
257                 _CHECK_IO(SafeRead(v,read,up,&len,sizeof(SQInteger)));
258                 _CHECK_IO(SafeRead(v,read,up,_ss(v)->GetScratchPad(rsl(len)),rsl(len)));
259                 o=SQString::Create(_ss(v),_ss(v)->GetScratchPad(-1),len);
260                                    }
261                 break;
262         case OT_INTEGER:{
263                 SQInteger i;
264                 _CHECK_IO(SafeRead(v,read,up,&i,sizeof(SQInteger))); o = i; break;
265                                         }
266         case OT_FLOAT:{
267                 SQFloat f;
268                 _CHECK_IO(SafeRead(v,read,up,&f,sizeof(SQFloat))); o = f; break;
269                                   }
270         case OT_NULL:
271                 o=_null_;
272                 break;
273         default:
274                 v->Raise_Error(_SC("cannot serialize a %s"),IdType2Name(t));
275                 return false;
276         }
277         return true;
278 }
279
280 bool SQClosure::Save(SQVM *v,SQUserPointer up,SQWRITEFUNC write)
281 {
282         _CHECK_IO(WriteTag(v,write,up,SQ_CLOSURESTREAM_HEAD));
283         _CHECK_IO(WriteTag(v,write,up,sizeof(SQChar)));
284         _CHECK_IO(_funcproto(_function)->Save(v,up,write));
285         _CHECK_IO(WriteTag(v,write,up,SQ_CLOSURESTREAM_TAIL));
286         return true;
287 }
288
289 bool SQClosure::Load(SQVM *v,SQUserPointer up,SQREADFUNC read)
290 {
291         _CHECK_IO(CheckTag(v,read,up,SQ_CLOSURESTREAM_HEAD));
292         _CHECK_IO(CheckTag(v,read,up,sizeof(SQChar)));
293         _CHECK_IO(_funcproto(_function)->Load(v,up,read));
294         _CHECK_IO(CheckTag(v,read,up,SQ_CLOSURESTREAM_TAIL));
295         return true;
296 }
297
298 bool SQFunctionProto::Save(SQVM *v,SQUserPointer up,SQWRITEFUNC write)
299 {
300         SQInteger i,nsize=_literals.size();
301         _CHECK_IO(WriteTag(v,write,up,SQ_CLOSURESTREAM_PART));
302         _CHECK_IO(WriteObject(v,up,write,_sourcename));
303         _CHECK_IO(WriteObject(v,up,write,_name));
304         _CHECK_IO(WriteTag(v,write,up,SQ_CLOSURESTREAM_PART));
305         _CHECK_IO(SafeWrite(v,write,up,&nsize,sizeof(nsize)));
306         for(i=0;i<nsize;i++){
307                 _CHECK_IO(WriteObject(v,up,write,_literals[i]));
308         }
309         _CHECK_IO(WriteTag(v,write,up,SQ_CLOSURESTREAM_PART));
310         nsize=_parameters.size();
311         _CHECK_IO(SafeWrite(v,write,up,&nsize,sizeof(nsize)));
312         for(i=0;i<nsize;i++){
313                 _CHECK_IO(WriteObject(v,up,write,_parameters[i]));
314         }
315         _CHECK_IO(WriteTag(v,write,up,SQ_CLOSURESTREAM_PART));
316         nsize=_outervalues.size();
317         _CHECK_IO(SafeWrite(v,write,up,&nsize,sizeof(nsize)));
318         for(i=0;i<nsize;i++){
319                 _CHECK_IO(SafeWrite(v,write,up,&_outervalues[i]._type,sizeof(SQUnsignedInteger)));
320                 _CHECK_IO(WriteObject(v,up,write,_outervalues[i]._src));
321                 _CHECK_IO(WriteObject(v,up,write,_outervalues[i]._name));
322         }
323         _CHECK_IO(WriteTag(v,write,up,SQ_CLOSURESTREAM_PART));
324         nsize=_localvarinfos.size();
325         _CHECK_IO(SafeWrite(v,write,up,&nsize,sizeof(nsize)));
326         for(i=0;i<nsize;i++){
327                 SQLocalVarInfo &lvi=_localvarinfos[i];
328                 _CHECK_IO(WriteObject(v,up,write,lvi._name));
329                 _CHECK_IO(SafeWrite(v,write,up,&lvi._pos,sizeof(SQUnsignedInteger)));
330                 _CHECK_IO(SafeWrite(v,write,up,&lvi._start_op,sizeof(SQUnsignedInteger)));
331                 _CHECK_IO(SafeWrite(v,write,up,&lvi._end_op,sizeof(SQUnsignedInteger)));
332         }
333         _CHECK_IO(WriteTag(v,write,up,SQ_CLOSURESTREAM_PART));
334         nsize=_lineinfos.size();
335         _CHECK_IO(SafeWrite(v,write,up,&nsize,sizeof(nsize)));
336         _CHECK_IO(SafeWrite(v,write,up,&_lineinfos[0],sizeof(SQLineInfo)*nsize));
337         _CHECK_IO(WriteTag(v,write,up,SQ_CLOSURESTREAM_PART));
338         nsize=_instructions.size();
339         _CHECK_IO(SafeWrite(v,write,up,&nsize,sizeof(nsize)));
340         _CHECK_IO(SafeWrite(v,write,up,&_instructions[0],sizeof(SQInstruction)*nsize));
341         _CHECK_IO(WriteTag(v,write,up,SQ_CLOSURESTREAM_PART));
342         nsize=_functions.size();
343         _CHECK_IO(SafeWrite(v,write,up,&nsize,sizeof(nsize)));
344         for(i=0;i<nsize;i++){
345                 _CHECK_IO(_funcproto(_functions[i])->Save(v,up,write));
346         }
347         _CHECK_IO(SafeWrite(v,write,up,&_stacksize,sizeof(_stacksize)));
348         _CHECK_IO(SafeWrite(v,write,up,&_bgenerator,sizeof(_bgenerator)));
349         _CHECK_IO(SafeWrite(v,write,up,&_varparams,sizeof(_varparams)));
350         return true;
351 }
352
353 bool SQFunctionProto::Load(SQVM *v,SQUserPointer up,SQREADFUNC read)
354 {
355         SQInteger i, nsize = _literals.size();
356         SQObjectPtr o;
357         _CHECK_IO(CheckTag(v,read,up,SQ_CLOSURESTREAM_PART));
358         _CHECK_IO(ReadObject(v, up, read, _sourcename));
359         _CHECK_IO(ReadObject(v, up, read, _name));
360         _CHECK_IO(CheckTag(v,read,up,SQ_CLOSURESTREAM_PART));
361         _CHECK_IO(SafeRead(v,read,up, &nsize, sizeof(nsize)));
362         for(i = 0;i < nsize; i++){
363                 _CHECK_IO(ReadObject(v, up, read, o));
364                 _literals.push_back(o);
365         }
366         _CHECK_IO(CheckTag(v,read,up,SQ_CLOSURESTREAM_PART));
367         _CHECK_IO(SafeRead(v,read,up, &nsize, sizeof(nsize)));
368         for(i = 0; i < nsize; i++){
369                 _CHECK_IO(ReadObject(v, up, read, o));
370                 _parameters.push_back(o);
371         }
372         _CHECK_IO(CheckTag(v,read,up,SQ_CLOSURESTREAM_PART));
373         _CHECK_IO(SafeRead(v,read,up,&nsize,sizeof(nsize)));
374         for(i = 0; i < nsize; i++){
375                 SQUnsignedInteger type;
376                 SQObjectPtr name;
377                 _CHECK_IO(SafeRead(v,read,up, &type, sizeof(SQUnsignedInteger)));
378                 _CHECK_IO(ReadObject(v, up, read, o));
379                 _CHECK_IO(ReadObject(v, up, read, name));
380                 _outervalues.push_back(SQOuterVar(name,o, (SQOuterType)type));
381         }
382         _CHECK_IO(CheckTag(v,read,up,SQ_CLOSURESTREAM_PART));
383         _CHECK_IO(SafeRead(v,read,up,&nsize, sizeof(nsize)));
384         for(i = 0; i < nsize; i++){
385                 SQLocalVarInfo lvi;
386                 _CHECK_IO(ReadObject(v, up, read, lvi._name));
387                 _CHECK_IO(SafeRead(v,read,up, &lvi._pos, sizeof(SQUnsignedInteger)));
388                 _CHECK_IO(SafeRead(v,read,up, &lvi._start_op, sizeof(SQUnsignedInteger)));
389                 _CHECK_IO(SafeRead(v,read,up, &lvi._end_op, sizeof(SQUnsignedInteger)));
390                 _localvarinfos.push_back(lvi);
391         }
392         _CHECK_IO(CheckTag(v,read,up,SQ_CLOSURESTREAM_PART));
393         _CHECK_IO(SafeRead(v,read,up, &nsize,sizeof(nsize)));
394         _lineinfos.resize(nsize);
395         _CHECK_IO(SafeRead(v,read,up, &_lineinfos[0], sizeof(SQLineInfo)*nsize));
396         _CHECK_IO(CheckTag(v,read,up,SQ_CLOSURESTREAM_PART));
397         _CHECK_IO(SafeRead(v,read,up, &nsize, sizeof(nsize)));
398         _instructions.resize(nsize);
399         _CHECK_IO(SafeRead(v,read,up, &_instructions[0], sizeof(SQInstruction)*nsize));
400         _CHECK_IO(CheckTag(v,read,up,SQ_CLOSURESTREAM_PART));
401         _CHECK_IO(SafeRead(v,read,up, &nsize, sizeof(nsize)));
402         for(i = 0; i < nsize; i++){
403                 o = SQFunctionProto::Create();
404                 _CHECK_IO(_funcproto(o)->Load(v, up, read));
405                 _functions.push_back(o);
406         }
407         _CHECK_IO(SafeRead(v,read,up, &_stacksize, sizeof(_stacksize)));
408         _CHECK_IO(SafeRead(v,read,up, &_bgenerator, sizeof(_bgenerator)));
409         _CHECK_IO(SafeRead(v,read,up, &_varparams, sizeof(_varparams)));
410         return true;
411 }
412
413 #ifndef NO_GARBAGE_COLLECTOR
414
415 #define START_MARK()    if(!(_uiRef&MARK_FLAG)){ \
416                 _uiRef|=MARK_FLAG;
417
418 #define END_MARK() RemoveFromChain(&_sharedstate->_gc_chain, this); \
419                 AddToChain(chain, this); }
420
421 void SQVM::Mark(SQCollectable **chain)
422 {
423         START_MARK()
424                 SQSharedState::MarkObject(_lasterror,chain);
425                 SQSharedState::MarkObject(_errorhandler,chain);
426                 SQSharedState::MarkObject(_debughook,chain);
427                 SQSharedState::MarkObject(_roottable, chain);
428                 SQSharedState::MarkObject(temp_reg, chain);
429                 for(SQUnsignedInteger i = 0; i < _stack.size(); i++) SQSharedState::MarkObject(_stack[i], chain);
430                 for(SQUnsignedInteger j = 0; j < _vargsstack.size(); j++) SQSharedState::MarkObject(_vargsstack[j], chain);
431         END_MARK()
432 }
433
434 void SQArray::Mark(SQCollectable **chain)
435 {
436         START_MARK()
437                 SQInteger len = _values.size();
438                 for(SQInteger i = 0;i < len; i++) SQSharedState::MarkObject(_values[i], chain);
439         END_MARK()
440 }
441 void SQTable::Mark(SQCollectable **chain)
442 {
443         START_MARK()
444                 if(_delegate) _delegate->Mark(chain);
445                 SQInteger len = _numofnodes;
446                 for(SQInteger i = 0; i < len; i++){
447                         SQSharedState::MarkObject(_nodes[i].key, chain);
448                         SQSharedState::MarkObject(_nodes[i].val, chain);
449                 }
450         END_MARK()
451 }
452
453 void SQClass::Mark(SQCollectable **chain)
454 {
455         START_MARK()
456                 _members->Mark(chain);
457                 if(_base) _base->Mark(chain);
458                 SQSharedState::MarkObject(_attributes, chain);
459                 for(SQUnsignedInteger i =0; i< _defaultvalues.size(); i++) {
460                         SQSharedState::MarkObject(_defaultvalues[i].val, chain);
461                         SQSharedState::MarkObject(_defaultvalues[i].attrs, chain);
462                 }
463                 for(SQUnsignedInteger j =0; j< _methods.size(); j++) {
464                         SQSharedState::MarkObject(_methods[j].val, chain);
465                         SQSharedState::MarkObject(_methods[j].attrs, chain);
466                 }
467                 for(SQUnsignedInteger k =0; k< _metamethods.size(); k++) {
468                         SQSharedState::MarkObject(_metamethods[k], chain);
469                 }
470         END_MARK()
471 }
472
473 void SQInstance::Mark(SQCollectable **chain)
474 {
475         START_MARK()
476                 _class->Mark(chain);
477                 for(SQUnsignedInteger i =0; i< _nvalues; i++) {
478                         SQSharedState::MarkObject(_values[i], chain);
479                 }
480         END_MARK()
481 }
482
483 void SQGenerator::Mark(SQCollectable **chain)
484 {
485         START_MARK()
486                 for(SQUnsignedInteger i = 0; i < _stack.size(); i++) SQSharedState::MarkObject(_stack[i], chain);
487                 for(SQUnsignedInteger j = 0; j < _vargsstack.size(); j++) SQSharedState::MarkObject(_vargsstack[j], chain);
488                 SQSharedState::MarkObject(_closure, chain);
489         END_MARK()
490 }
491
492 void SQClosure::Mark(SQCollectable **chain)
493 {
494         START_MARK()
495                 for(SQUnsignedInteger i = 0; i < _outervalues.size(); i++) SQSharedState::MarkObject(_outervalues[i], chain);
496         END_MARK()
497 }
498
499 void SQNativeClosure::Mark(SQCollectable **chain)
500 {
501         START_MARK()
502                 for(SQUnsignedInteger i = 0; i < _outervalues.size(); i++) SQSharedState::MarkObject(_outervalues[i], chain);
503         END_MARK()
504 }
505
506 void SQUserData::Mark(SQCollectable **chain){
507         START_MARK()
508                 if(_delegate) _delegate->Mark(chain);
509         END_MARK()
510 }
511
512 void SQCollectable::UnMark() { _uiRef&=~MARK_FLAG; }
513
514 #endif