ScummVM API documentation
inter.h
1 /* ScummVM - Graphic Adventure Engine
2  *
3  * ScummVM is the legal property of its developers, whose names
4  * are too numerous to list here. Please refer to the COPYRIGHT
5  * file distributed with this source distribution.
6  *
7  * This program is free software: you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation, either version 3 of the License, or
10  * (at your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program. If not, see <http://www.gnu.org/licenses/>.
19  *
20  *
21  * This file is dual-licensed.
22  * In addition to the GPLv3 license mentioned above, this code is also
23  * licensed under LGPL 2.1. See LICENSES/COPYING.LGPL file for the
24  * full text of the license.
25  *
26  */
27 
28 #ifndef GOB_INTER_H
29 #define GOB_INTER_H
30 
31 #include "common/func.h"
32 #include "common/hashmap.h"
33 
34 #include "gob/goblin.h"
35 #include "gob/variables.h"
36 #include "gob/iniconfig.h"
37 #include "gob/databases.h"
38 
39 namespace Common {
40  class WinResources;
41 }
42 
43 namespace Gob {
44 
45 class Cheater_Geisha;
46 
47 namespace Geisha {
48  class Diving;
49  class Penetration;
50 }
51 
52 // This is to help devices with small memory (PDA, smartphones, ...)
53 // to save a bit of memory used by opcode names in the Gob engine.
54 #ifndef REDUCE_MEMORY_USAGE
55  #define _OPCODEDRAW(ver, x) setProc(new Common::Functor0Mem<void, ver>(this, &ver::x), #x)
56  #define _OPCODEFUNC(ver, x) setProc(new Common::Functor1Mem<OpFuncParams &, void, ver>(this, &ver::x), #x)
57  #define _OPCODEGOB(ver, x) setProc(new Common::Functor1Mem<OpGobParams &, void, ver>(this, &ver::x), #x)
58 #else
59  #define _OPCODEDRAW(ver, x) setProc(new Common::Functor0Mem<void, ver>(this, &ver::x), "")
60  #define _OPCODEFUNC(ver, x) setProc(new Common::Functor1Mem<OpFuncParams &, void, ver>(this, &ver::x), "")
61  #define _OPCODEGOB(ver, x) setProc(new Common::Functor1Mem<OpGobParams &, void, ver>(this, &ver::x), "")
62 #endif
63 
64 #define CLEAROPCODEDRAW(i) _opcodesDraw[i].setProc(0, 0)
65 #define CLEAROPCODEFUNC(i) _opcodesFunc[i].setProc(0, 0)
66 #define CLEAROPCODEGOB(i) _opcodesGob.erase(i)
67 
68 typedef Common::Functor0<void> OpcodeDraw;
69 typedef Common::Functor1<struct OpFuncParams &, void> OpcodeFunc;
70 typedef Common::Functor1<struct OpGobParams &, void> OpcodeGob;
71 
72 struct OpFuncParams {
73  byte cmdCount;
74  byte counter;
75  int16 retFlag;
76  bool doReturn;
77 };
78 struct OpGobParams {
79  int16 extraData;
80  int16 paramCount;
81  VariableReference retVarPtr;
82  Goblin::Gob_Object *objDesc;
83 };
84 
85 template<typename T>
86 struct OpcodeEntry : Common::NonCopyable {
87  T *proc;
88  const char *desc;
89 
90  OpcodeEntry() : proc(0), desc(0) {}
91  ~OpcodeEntry() {
92  setProc(0, 0);
93  }
94 
95  void setProc(T *p, const char *d) {
96  if (proc != p) {
97  delete proc;
98  proc = p;
99  }
100  desc = d;
101  }
102 };
103 
104 class Inter {
105 public:
106  uint8 _terminate;
107 
108  int16 *_breakFromLevel;
109  int16 *_nestLevel;
110 
111  uint32 _soundEndTimeKey;
112  int16 _soundStopVal;
113 
114  Variables *_variables;
115 
116  void setupOpcodes();
117 
118  void initControlVars(char full);
119  void renewTimeInVars();
120  void storeMouse();
121  void storeKey(int16 key);
122 
123  void writeVar(uint32 offset, uint16 type, uint32 value);
124 
125  void funcBlock(int16 retFlag);
126  void callSub(int16 retFlag);
127 
128  void allocateVars(uint32 count);
129  void delocateVars();
130 
131  virtual int16 loadSound(int16 slot) = 0;
132  virtual void animPalette() = 0;
133 
134  Inter(GobEngine *vm);
135  virtual ~Inter();
136 
137 protected:
138  OpcodeEntry<OpcodeDraw> _opcodesDraw[256];
139  OpcodeEntry<OpcodeFunc> _opcodesFunc[256];
140  Common::HashMap<int, OpcodeEntry<OpcodeGob> > _opcodesGob;
141 
142  bool _break;
143 
144  int16 _animPalLowIndex[8];
145  int16 _animPalHighIndex[8];
146  int16 _animPalDir[8];
147 
148  VariableStack _varStack;
149 
150  // Busy-wait detection
151  bool _noBusyWait;
152  uint32 _lastBusyWait;
153 
154  GobEngine *_vm;
155 
156  void executeOpcodeDraw(byte i);
157  void executeOpcodeFunc(byte i, byte j, OpFuncParams &params);
158  void executeOpcodeGob(int i, OpGobParams &params);
159 
160  const char *getDescOpcodeDraw(byte i);
161  const char *getDescOpcodeFunc(byte i, byte j);
162  const char *getDescOpcodeGob(int i);
163 
164  virtual void setupOpcodesDraw() = 0;
165  virtual void setupOpcodesFunc() = 0;
166  virtual void setupOpcodesGob() = 0;
167 
168  virtual void checkSwitchTable(uint32 &offset) = 0;
169 
170  void o_drawNOP() {}
171  void o_funcNOP(OpFuncParams &params) {}
172  void o_gobNOP(OpGobParams &params) {}
173 
174  void storeValue(uint16 index, uint16 type, uint32 value);
175  void storeValue(uint32 value);
176 
177  void storeString(uint16 index, uint16 type, const char *value);
178  void storeString(const char *value);
179 
180  uint32 readValue(uint16 index, uint16 type);
181 
182  void handleBusyWait();
183 };
184 
185 class Inter_v1 : public Inter {
186 public:
187  Inter_v1(GobEngine *vm);
188  ~Inter_v1() override {}
189 
190  int16 loadSound(int16 slot) override;
191  void animPalette() override;
192 
193 protected:
194  void setupOpcodesDraw() override;
195  void setupOpcodesFunc() override;
196  void setupOpcodesGob() override;
197 
198  void checkSwitchTable(uint32 &offset) override;
199 
200  void o1_loadMult();
201  void o1_playMult();
202  void o1_freeMultKeys();
203  void o1_initCursor();
204  void o1_initCursorAnim();
205  void o1_clearCursorAnim();
206  void o1_setRenderFlags();
207  void o1_loadAnim();
208  void o1_freeAnim();
209  void o1_updateAnim();
210  void o1_initMult();
211  void o1_freeMult();
212  void o1_animate();
213  void o1_loadMultObject();
214  void o1_getAnimLayerInfo();
215  void o1_getObjAnimSize();
216  void o1_loadStatic();
217  void o1_freeStatic();
218  void o1_renderStatic();
219  void o1_loadCurLayer();
220  void o1_playCDTrack();
221  void o1_getCDTrackPos();
222  void o1_stopCD();
223  void o1_loadFontToSprite();
224  void o1_freeFontToSprite();
225  void o1_callSub(OpFuncParams &params);
226  void o1_printTotText(OpFuncParams &params);
227  void o1_loadCursor(OpFuncParams &params);
228  void o1_switch (OpFuncParams &params);
229  void o1_repeatUntil(OpFuncParams &params);
230  void o1_whileDo(OpFuncParams &params);
231  void o1_if(OpFuncParams &params);
232  void o1_assign(OpFuncParams &params);
233  void o1_loadSpriteToPos(OpFuncParams &params);
234  void o1_printText(OpFuncParams &params);
235  void o1_loadTot(OpFuncParams &params);
236  void o1_palLoad(OpFuncParams &params);
237  void o1_keyFunc(OpFuncParams &params);
238  void o1_capturePush(OpFuncParams &params);
239  void o1_capturePop(OpFuncParams &params);
240  void o1_animPalInit(OpFuncParams &params);
241  void o1_drawOperations(OpFuncParams &params);
242  void o1_setcmdCount(OpFuncParams &params);
243  void o1_return(OpFuncParams &params);
244  void o1_renewTimeInVars(OpFuncParams &params);
245  void o1_speakerOn(OpFuncParams &params);
246  void o1_speakerOff(OpFuncParams &params);
247  void o1_putPixel(OpFuncParams &params);
248  void o1_goblinFunc(OpFuncParams &params);
249  void o1_createSprite(OpFuncParams &params);
250  void o1_freeSprite(OpFuncParams &params);
251  void o1_returnTo(OpFuncParams &params);
252  void o1_loadSpriteContent(OpFuncParams &params);
253  void o1_copySprite(OpFuncParams &params);
254  void o1_fillRect(OpFuncParams &params);
255  void o1_drawLine(OpFuncParams &params);
256  void o1_strToLong(OpFuncParams &params);
257  void o1_invalidate(OpFuncParams &params);
258  void o1_setBackDelta(OpFuncParams &params);
259  void o1_playSound(OpFuncParams &params);
260  void o1_stopSound(OpFuncParams &params);
261  void o1_loadSound(OpFuncParams &params);
262  void o1_freeSoundSlot(OpFuncParams &params);
263  void o1_waitEndPlay(OpFuncParams &params);
264  void o1_playComposition(OpFuncParams &params);
265  void o1_getFreeMem(OpFuncParams &params);
266  void o1_checkData(OpFuncParams &params);
267  void o1_cleanupStr(OpFuncParams &params);
268  void o1_insertStr(OpFuncParams &params);
269  void o1_cutStr(OpFuncParams &params);
270  void o1_strstr(OpFuncParams &params);
271  void o1_istrlen(OpFuncParams &params);
272  void o1_setMousePos(OpFuncParams &params);
273  void o1_setFrameRate(OpFuncParams &params);
274  void o1_animatePalette(OpFuncParams &params);
275  void o1_animateCursor(OpFuncParams &params);
276  void o1_blitCursor(OpFuncParams &params);
277  void o1_loadFont(OpFuncParams &params);
278  void o1_freeFont(OpFuncParams &params);
279  void o1_readData(OpFuncParams &params);
280  void o1_writeData(OpFuncParams &params);
281  void o1_manageDataFile(OpFuncParams &params);
282  void o1_setState(OpGobParams &params);
283  void o1_setCurFrame(OpGobParams &params);
284  void o1_setNextState(OpGobParams &params);
285  void o1_setMultState(OpGobParams &params);
286  void o1_setOrder(OpGobParams &params);
287  void o1_setActionStartState(OpGobParams &params);
288  void o1_setCurLookDir(OpGobParams &params);
289  void o1_setType(OpGobParams &params);
290  void o1_setNoTick(OpGobParams &params);
291  void o1_setPickable(OpGobParams &params);
292  void o1_setXPos(OpGobParams &params);
293  void o1_setYPos(OpGobParams &params);
294  void o1_setDoAnim(OpGobParams &params);
295  void o1_setRelaxTime(OpGobParams &params);
296  void o1_setMaxTick(OpGobParams &params);
297  void o1_getState(OpGobParams &params);
298  void o1_getCurFrame(OpGobParams &params);
299  void o1_getNextState(OpGobParams &params);
300  void o1_getMultState(OpGobParams &params);
301  void o1_getOrder(OpGobParams &params);
302  void o1_getActionStartState(OpGobParams &params);
303  void o1_getCurLookDir(OpGobParams &params);
304  void o1_getType(OpGobParams &params);
305  void o1_getNoTick(OpGobParams &params);
306  void o1_getPickable(OpGobParams &params);
307  void o1_getObjMaxFrame(OpGobParams &params);
308  void o1_getXPos(OpGobParams &params);
309  void o1_getYPos(OpGobParams &params);
310  void o1_getDoAnim(OpGobParams &params);
311  void o1_getRelaxTime(OpGobParams &params);
312  void o1_getMaxTick(OpGobParams &params);
313  void o1_manipulateMap(OpGobParams &params);
314  void o1_getItem(OpGobParams &params);
315  void o1_manipulateMapIndirect(OpGobParams &params);
316  void o1_getItemIndirect(OpGobParams &params);
317  void o1_setPassMap(OpGobParams &params);
318  void o1_setGoblinPosH(OpGobParams &params);
319  void o1_getGoblinPosXH(OpGobParams &params);
320  void o1_getGoblinPosYH(OpGobParams &params);
321  void o1_setGoblinMultState(OpGobParams &params);
322  void o1_setGoblinUnk14(OpGobParams &params);
323  void o1_setItemIdInPocket(OpGobParams &params);
324  void o1_setItemIndInPocket(OpGobParams &params);
325  void o1_getItemIdInPocket(OpGobParams &params);
326  void o1_getItemIndInPocket(OpGobParams &params);
327  void o1_setGoblinPos(OpGobParams &params);
328  void o1_setGoblinState(OpGobParams &params);
329  void o1_setGoblinStateRedraw(OpGobParams &params);
330  void o1_decRelaxTime(OpGobParams &params);
331  void o1_getGoblinPosX(OpGobParams &params);
332  void o1_getGoblinPosY(OpGobParams &params);
333  void o1_clearPathExistence(OpGobParams &params);
334  void o1_setGoblinVisible(OpGobParams &params);
335  void o1_setGoblinInvisible(OpGobParams &params);
336  void o1_getObjectIntersect(OpGobParams &params);
337  void o1_getGoblinIntersect(OpGobParams &params);
338  void o1_setItemPos(OpGobParams &params);
339  void o1_loadObjects(OpGobParams &params);
340  void o1_freeObjects(OpGobParams &params);
341  void o1_animateObjects(OpGobParams &params);
342  void o1_drawObjects(OpGobParams &params);
343  void o1_loadMap(OpGobParams &params);
344  void o1_moveGoblin(OpGobParams &params);
345  void o1_switchGoblin(OpGobParams &params);
346  void o1_loadGoblin(OpGobParams &params);
347  void o1_writeTreatItem(OpGobParams &params);
348  void o1_moveGoblin0(OpGobParams &params);
349  void o1_setGoblinTarget(OpGobParams &params);
350  void o1_setGoblinObjectsPos(OpGobParams &params);
351  void o1_initGoblin(OpGobParams &params);
352 
353  void manipulateMap(int16 xPos, int16 yPos, int16 item);
354 };
355 
356 class Inter_Geisha : public Inter_v1 {
357 public:
358  Inter_Geisha(GobEngine *vm);
359  ~Inter_Geisha() override;
360 
361 protected:
362  void setupOpcodesDraw() override;
363  void setupOpcodesFunc() override;
364  void setupOpcodesGob() override;
365 
366  void oGeisha_loadCursor(OpFuncParams &params);
367  void oGeisha_loadTot(OpFuncParams &params);
368  void oGeisha_goblinFunc(OpFuncParams &params);
369  void oGeisha_loadSound(OpFuncParams &params);
370  void oGeisha_checkData(OpFuncParams &params);
371  void oGeisha_readData(OpFuncParams &params);
372  void oGeisha_writeData(OpFuncParams &params);
373 
374  void oGeisha_gamePenetration(OpGobParams &params);
375  void oGeisha_gameDiving(OpGobParams &params);
376  void oGeisha_loadTitleMusic(OpGobParams &params);
377  void oGeisha_playMusic(OpGobParams &params);
378  void oGeisha_stopMusic(OpGobParams &params);
379 
380  void oGeisha_caress1(OpGobParams &params);
381  void oGeisha_caress2(OpGobParams &params);
382 
383  int16 loadSound(int16 slot) override;
384 
385 private:
386  Geisha::Diving *_diving;
387  Geisha::Penetration *_penetration;
388 
389  Cheater_Geisha *_cheater;
390 };
391 
392 class Inter_v2 : public Inter_v1 {
393 public:
394  Inter_v2(GobEngine *vm);
395  ~Inter_v2() override {}
396 
397  int16 loadSound(int16 search) override;
398  void animPalette() override;
399 
400 protected:
401  void setupOpcodesDraw() override;
402  void setupOpcodesFunc() override;
403  void setupOpcodesGob() override;
404 
405  void checkSwitchTable(uint32 &offset) override;
406 
407  void o2_playMult();
408  void o2_freeMultKeys();
409  void o2_setRenderFlags();
410  void o2_multSub();
411  void o2_initMult();
412  void o2_loadMultObject();
413  void o2_renderStatic();
414  void o2_loadCurLayer();
415  void o2_playCDTrack();
416  void o2_waitCDTrackEnd();
417  void o2_stopCD();
418  void o2_readLIC();
419  void o2_freeLIC();
420  void o2_getCDTrackPos();
421  void o2_loadFontToSprite();
422  void o2_totSub();
423  void o2_switchTotSub();
424  void o2_pushVars();
425  void o2_popVars();
426  void o2_loadMapObjects();
427  void o2_freeGoblins();
428  void o2_moveGoblin();
429  void o2_writeGoblinPos();
430  void o2_stopGoblin();
431  void o2_setGoblinState();
432  void o2_placeGoblin();
433  void o2_initScreen();
434  void o2_scroll();
435  void o2_setScrollOffset();
436  void o2_playImd();
437  void o2_getImdInfo();
438  void o2_openItk();
439  void o2_closeItk();
440  void o2_setImdFrontSurf();
441  void o2_resetImdFrontSurf();
442  void o2_assign(OpFuncParams &params);
443  void o2_printText(OpFuncParams &params);
444  void o2_animPalInit(OpFuncParams &params);
445  void o2_addHotspot(OpFuncParams &params);
446  void o2_removeHotspot(OpFuncParams &params);
447  void o2_getTotTextItemPart(OpFuncParams &params);
448  void o2_goblinFunc(OpFuncParams &params);
449  void o2_stopSound(OpFuncParams &params);
450  void o2_loadSound(OpFuncParams &params);
451  void o2_getFreeMem(OpFuncParams &params);
452  void o2_checkData(OpFuncParams &params);
453  void o2_readData(OpFuncParams &params);
454  void o2_writeData(OpFuncParams &params);
455  void o2_loadInfogramesIns(OpGobParams &params);
456  void o2_playInfogrames(OpGobParams &params);
457  void o2_startInfogrames(OpGobParams &params);
458  void o2_stopInfogrames(OpGobParams &params);
459  void o2_handleGoblins(OpGobParams &params);
460  void o2_playProtracker(OpGobParams &params);
461  void o2_stopProtracker(OpGobParams &params);
462 };
463 
464 class Inter_Bargon : public Inter_v2 {
465 public:
466  Inter_Bargon(GobEngine *vm);
467  ~Inter_Bargon() override {}
468 
469 protected:
470  void setupOpcodesDraw() override;
471  void setupOpcodesFunc() override;
472  void setupOpcodesGob() override;
473 
474  void oBargon_intro0(OpGobParams &params);
475  void oBargon_intro1(OpGobParams &params);
476  void oBargon_intro2(OpGobParams &params);
477  void oBargon_intro3(OpGobParams &params);
478  void oBargon_intro4(OpGobParams &params);
479  void oBargon_intro5(OpGobParams &params);
480  void oBargon_intro6(OpGobParams &params);
481  void oBargon_intro7(OpGobParams &params);
482  void oBargon_intro8(OpGobParams &params);
483  void oBargon_intro9(OpGobParams &params);
484 };
485 
486 class Inter_Fascination : public Inter_v2 {
487 public:
488  Inter_Fascination(GobEngine *vm);
489  ~Inter_Fascination() override {}
490 
491 protected:
492  void setupOpcodesDraw() override;
493  void setupOpcodesFunc() override;
494  void setupOpcodesGob() override;
495 
496  void oFascin_playProtracker(OpGobParams &params);
497 
498  void oFascin_repeatUntil(OpFuncParams &params);
499  void oFascin_assign(OpFuncParams &params);
500  void oFascin_copySprite(OpFuncParams &params);
501  void oFascin_keyFunc(OpFuncParams &params);
502 
503  void oFascin_playTirb(OpGobParams &params);
504  void oFascin_playTira(OpGobParams &params);
505  void oFascin_loadExtasy(OpGobParams &params);
506  void oFascin_adlibPlay(OpGobParams &params);
507  void oFascin_adlibStop(OpGobParams &params);
508  void oFascin_adlibUnload(OpGobParams &params);
509  void oFascin_loadMus1(OpGobParams &params);
510  void oFascin_loadMus2(OpGobParams &params);
511  void oFascin_loadMus3(OpGobParams &params);
512  void oFascin_loadBatt1(OpGobParams &params);
513  void oFascin_loadBatt2(OpGobParams &params);
514  void oFascin_loadBatt3(OpGobParams &params);
515  void oFascin_loadMod(OpGobParams &params);
516  void oFascin_setWinSize();
517  void oFascin_closeWin();
518  void oFascin_activeWin();
519  void oFascin_openWin();
520  void oFascin_initCursorAnim();
521  void oFascin_setRenderFlags();
522  void oFascin_setWinFlags();
523 };
524 
525 class Inter_LittleRed : public Inter_v2 {
526 public:
527  Inter_LittleRed(GobEngine *vm);
528  ~Inter_LittleRed() override {}
529 
530 protected:
531  void setupOpcodesDraw() override;
532  void setupOpcodesFunc() override;
533  void setupOpcodesGob() override;
534 
535  void oLittleRed_keyFunc(OpFuncParams &params);
536  void oLittleRed_playComposition(OpFuncParams &params);
537 };
538 
539 class Inter_Adibou1 : public Inter_v2 {
540 public:
541  Inter_Adibou1(GobEngine *vm);
542  ~Inter_Adibou1() override {}
543 
544 protected:
545  void setupOpcodesDraw() override;
546  void setupOpcodesFunc() override;
547  void setupOpcodesGob() override;
548 
549  void oAdibou1_writeSprite(OpGobParams &params);
550  void oAdibou1_readSprite(OpGobParams &params);
551  void oAdibou1_fillAreaAtPoint(OpGobParams &params);
552  void oAdibou1_getAppliNameFromId(OpGobParams &params);
553  void oAdibou1_listApplications(OpGobParams &params);
554 };
555 
556 class Inter_v3 : public Inter_v2 {
557 public:
558  Inter_v3(GobEngine *vm);
559  ~Inter_v3() override {}
560 
561 protected:
562  void setupOpcodesDraw() override;
563  void setupOpcodesFunc() override;
564  void setupOpcodesGob() override;
565 
566  void o3_speakerOn(OpFuncParams &params);
567  void o3_speakerOff(OpFuncParams &params);
568  void o3_copySprite(OpFuncParams &params);
569 
570  void o3_wobble(OpGobParams &params);
571 
572 private:
573  bool _ignoreSpeakerOff;
574 };
575 
576 class Inter_Inca2 : public Inter_v3 {
577 public:
578  Inter_Inca2(GobEngine *vm);
579  ~Inter_Inca2() override {}
580 
581 protected:
582  void setupOpcodesDraw() override;
583  void setupOpcodesFunc() override;
584  void setupOpcodesGob() override;
585 
586  void oInca2_spaceShooter(OpFuncParams &params);
587 };
588 
589 class Inter_v4 : public Inter_v3 {
590 public:
591  Inter_v4(GobEngine *vm);
592  ~Inter_v4() override {}
593 
594 protected:
595  void setupOpcodesDraw() override;
596  void setupOpcodesFunc() override;
597  void setupOpcodesGob() override;
598 
599  void o4_initScreen();
600  void o4_playVmdOrMusic();
601 };
602 
603 class Inter_v5 : public Inter_v4 {
604 public:
605  Inter_v5(GobEngine *vm);
606  ~Inter_v5() override {}
607 
608 protected:
609  byte _gob_97_98_val;
610 
611  void setupOpcodesDraw() override;
612  void setupOpcodesFunc() override;
613  void setupOpcodesGob() override;
614 
615  void o5_deleteFile();
616  void o5_initScreen();
617 
618  void o5_istrlen(OpFuncParams &params);
619 
620  void o5_spaceShooter(OpGobParams &params);
621  void o5_getSystemCDSpeed(OpGobParams &params);
622  void o5_getSystemRAM(OpGobParams &params);
623  void o5_getSystemCPUSpeed(OpGobParams &params);
624  void o5_getSystemDrawSpeed(OpGobParams &params);
625  void o5_totalSystemSpecs(OpGobParams &params);
626  void o5_saveSystemSpecs(OpGobParams &params);
627  void o5_loadSystemSpecs(OpGobParams &params);
628 
629  void o5_gob92(OpGobParams &params);
630  void o5_gob95(OpGobParams &params);
631  void o5_gob96(OpGobParams &params);
632  void o5_gob97(OpGobParams &params);
633  void o5_gob98(OpGobParams &params);
634  void o5_gob100(OpGobParams &params);
635  void o5_gob200(OpGobParams &params);
636 };
637 
638 class Inter_v6 : public Inter_v5 {
639 public:
640  Inter_v6(GobEngine *vm);
641  ~Inter_v6() override {}
642 
643 protected:
644  bool _gotFirstPalette;
645 
646  void setupOpcodesDraw() override;
647  void setupOpcodesFunc() override;
648  void setupOpcodesGob() override;
649 
650  void o6_totSub();
651  void o6_playVmdOrMusic();
652 
653  void o6_loadCursor(OpFuncParams &params);
654  void o6_assign(OpFuncParams &params);
655  void o6_removeHotspot(OpFuncParams &params);
656  void o6_fillRect(OpFuncParams &params);
657 
658  void probe16bitMusic(Common::String &fileName);
659 };
660 
661 class Inter_Playtoons : public Inter_v6 {
662 public:
663  Inter_Playtoons(GobEngine *vm);
664  ~Inter_Playtoons() override {}
665 
666 protected:
667  void setupOpcodesDraw() override;
668  void setupOpcodesFunc() override;
669  void setupOpcodesGob() override;
670 
671  void oPlaytoons_printText(OpFuncParams &params);
672  void oPlaytoons_F_1B(OpFuncParams &params);
673  void oPlaytoons_putPixel(OpFuncParams &params);
674  void oPlaytoons_freeSprite(OpFuncParams &params);
675  void oPlaytoons_checkData(OpFuncParams &params);
676  void oPlaytoons_readData(OpFuncParams &params);
677 
678  void oPlaytoons_loadMultObject();
679  void oPlaytoons_getObjAnimSize();
680  void oPlaytoons_CD_20_23();
681  void oPlaytoons_CD_25();
682  void oPlaytoons_copyFile();
683  void oPlaytoons_openItk();
684 
685  Common::String getFile(const char *path, bool stripPath = true);
686 
687  bool readSprite(Common::String file, int32 dataVar, int32 size, int32 offset);
688 };
689 
690 class Inter_v7 : public Inter_Playtoons {
691 public:
692  Inter_v7(GobEngine *vm);
693  ~Inter_v7() override {};
694 
695 protected:
696  void setupOpcodesDraw() override;
697  void setupOpcodesFunc() override;
698  void setupOpcodesGob() override;
699 
700  void o7_draw0x0C();
701  void o7_setCursorToLoadFromExec();
702  void o7_freeMult();
703  void o7_loadMultObject();
704  void o7_getFreeMem(OpFuncParams &params);
705  void o7_displayWarning();
706  void o7_logString();
707  void o7_moveGoblin();
708  void o7_setGoblinState();
709  void o7_intToString();
710  void o7_callFunction();
711  void o7_loadFunctions();
712  void o7_moveFile();
713  void o7_copyFile();
714  void o7_deleteFile();
715  void o7_playVmdOrMusic();
716  void o7_initScreen();
717  void o7_setActiveCD();
718  void o7_findFile();
719  void o7_findNextFile();
720  void o7_getSystemProperty();
721  void o7_loadImage();
722  void o7_setVolume();
723  void o7_zeroVar();
724  void o7_getINIValue();
725  void o7_setINIValue();
726  void o7_loadIFFPalette();
727  void o7_opendBase();
728  void o7_closedBase();
729  void o7_getDBString();
730 
731  void o7_loadCursor(OpFuncParams &params);
732  void o7_printText(OpFuncParams &params);
733  void o7_fillRect(OpFuncParams &params);
734  void o7_drawLine(OpFuncParams &params);
735  void o7_invalidate(OpFuncParams &params);
736  void o7_checkData(OpFuncParams &params);
737  void o7_readData(OpFuncParams &params);
738  void o7_writeData(OpFuncParams &params);
739 
740  void o7_oemToANSI(OpGobParams &params);
741  void o7_gob0x201(OpGobParams &params);
742 
743 private:
744  INIConfig _inis;
745  Databases _databases;
746 
747  Common::ArchiveMemberList _remainingFilesFromPreviousSearch;
748  Common::String _currentCDPath;
749 
750  Common::String findFile(const Common::String &mask, const Common::String &previousFile);
751  void copyFile(const Common::String &sourceFile, const Common::String &destFile);
752 
753  bool setCurrentCDPath(const Common::String &dir);
754  Common::Array<uint32> getAdibou2InstalledApplications();
755 };
756 
757 } // End of namespace Gob
758 
759 #endif // GOB_INTER_H
Gob::Inter_v3
Definition: inter.h:556
Gob::Inter_Geisha
Definition: inter.h:356
Gob::GobEngine
Definition: gob.h:156
Common::String
Definition: str.h:59
Gob::Inter_Playtoons
Definition: inter.h:661
Gob::Inter_Fascination
Definition: inter.h:486
Gob::Inter_Adibou1
Definition: inter.h:539
Gob::OpcodeEntry
Definition: inter.h:86
Gob::Inter_v7
Definition: inter.h:690
Gob::Variables
Definition: variables.h:33
Gob::Inter_v6
Definition: inter.h:638
Gob::Geisha::Diving
Definition: diving.h:52
Gob::Cheater_Geisha
Definition: cheater.h:55
Common::List
Definition: list.h:44
Gob::Goblin::Gob_Object
Definition: goblin.h:63
Gob::Inter_LittleRed
Definition: inter.h:525
Gob::VariableStack
Definition: variables.h:153
Common::NonCopyable
Definition: noncopyable.h:39
Gob::Inter_Bargon
Definition: inter.h:464
Gob::Inter_v5
Definition: inter.h:603
Gob
Definition: anifile.h:40
Gob::OpFuncParams
Definition: inter.h:72
Common::HashMap
Definition: hashmap.h:85
Gob::Inter
Definition: inter.h:104
Common
Definition: algorithm.h:29
Gob::Inter_v2
Definition: inter.h:392
Common::Functor1
Definition: func.h:437
Gob::OpGobParams
Definition: inter.h:78
Gob::VariableReference
Definition: variables.h:133
Gob::Inter_v4
Definition: inter.h:589
Gob::Databases
Definition: databases.h:40
Gob::Geisha::Penetration
Definition: penetration.h:51
Gob::Inter_v1
Definition: inter.h:185
Gob::INIConfig
Definition: iniconfig.h:37
Gob::Inter_Inca2
Definition: inter.h:576