selector.h

/* ScummVM - Graphic Adventure Engine
 *
 * ScummVM is the legal property of its developers, whose names
 * are too numerous to list here. Please refer to the COPYRIGHT
 * file distributed with this source distribution.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 */

#ifndef SCI_ENGINE_SELECTOR_H
#define SCI_ENGINE_SELECTOR_H

#include "common/scummsys.h"

#include "sci/engine/vm_types.h"    // for reg_t
#include "sci/engine/vm.h"

namespace Sci {

struct SelectorCache {
    SelectorCache() {
        memset(this, 0, sizeof(*this));
    }

    // Statically defined selectors, (almost the) same in all SCI versions
    Selector _info_;    
    Selector y;
    Selector x;
    Selector view, loop, cel; 
    Selector underBits; 
    Selector nsTop, nsLeft, nsBottom, nsRight; 
    Selector lsTop, lsLeft, lsBottom, lsRight; 
    Selector signal; 
    Selector illegalBits; 
    Selector brTop, brLeft, brBottom, brRight; 
    // name, key, time
    Selector text; 
    Selector elements; 
    // color, back
    Selector mode; 
    // style
    Selector state, font, type;
    // window
    Selector cursor; 
    Selector max; 
    Selector mark; //< Used by list controls (script internal, is needed by us for the QfG import rooms)
    Selector sort; //< Used by list controls (script internal, is needed by us for QfG3 import room)
    // who
    Selector message; 
    // edit
    Selector play; 
    Selector restore;
    Selector number;
    Selector handle;    
    Selector nodePtr;   
    Selector client; 
    Selector dx, dy; 
    Selector b_movCnt, b_i1, b_i2, b_di, b_xAxis, b_incr; 
    Selector xStep, yStep; 
    Selector xLast, yLast; 
    Selector moveSpeed; 
    Selector canBeHere; 
    Selector heading, mover; 
    Selector doit; 
    Selector isBlocked, looper; 
    Selector priority;
    Selector modifiers; 
    Selector replay; 
    // setPri, at, next, done, width
    Selector wordFail, syntaxFail; 
    // semanticFail, pragmaFail
    // said
    Selector claimed; 
    // value, save, restore, title, button, icon, draw
    Selector delete_; 
    Selector z;
    Selector setPri;

    // SCI1+ static selectors
    Selector parseLang;
    Selector printLang; 
    Selector subtitleLang;
    Selector size;
    Selector points; 
    Selector palette;   
    Selector dataInc;   
    // handle (in SCI1)
    Selector min; 
    Selector sec;
    Selector frame;
    Selector vol;
    Selector pri;
    // perform
    Selector moveDone;  

    // SCI1 selectors which have been moved a bit in SCI1.1, but otherwise static
    Selector cantBeHere; 
    Selector topString; 
    Selector flags;

    // SCI1+ audio sync related selectors, not static. They're used for lip syncing in
    // CD talkie games
    Selector syncCue; 
    Selector syncTime;

    // SCI1.1 specific selectors
    Selector scaleSignal; //< Used by kAnimate() for cel scaling (SCI1.1+)
    Selector scaleX, scaleY;    
    Selector maxScale;      
    Selector vanishingX;    
    Selector vanishingY;    

    // Used for auto detection purposes
    Selector overlay;   

    // SCI1.1 Mac icon bar selectors
    Selector iconIndex; 
    Selector select;

    Selector handsOff;
    Selector setStep;
    Selector setMotion;
    Selector cycleSpeed;
    Selector owner;

    Selector curPos; // for LSL6 volume sync
    Selector update; // for LSL6 volume sync

    Selector canInput; // for Phant2 restore from launcher and checking if user has input
    Selector input; // for checking if user has input
    Selector controls; // for checking if user has input

#ifdef ENABLE_SCI32
    Selector data; // Used by Array()/String()
    Selector picture; // Used to hold the picture ID for SCI32 pictures
    Selector bitmap; // Used to hold the text bitmap for SCI32 texts

    Selector plane;
    Selector top, left, bottom, right;
    Selector resX, resY;

    Selector fore;
    Selector back;
    Selector skip;
    Selector dimmed;
    Selector borderColor;
    Selector width;

    Selector fixPriority;
    Selector mirrored;
    Selector visible;

    Selector seenRect;
    Selector useInsetRect;
    Selector inTop, inLeft, inBottom, inRight;
    Selector textTop, textLeft, textBottom, textRight;
    Selector title, titleFont, titleFore, titleBack;

    Selector magnifier;
    Selector frameOut;
    Selector casts; // needed for sync'ing screen items/planes with scripts, when our save/restore code is patched in (see GfxFrameout::syncWithScripts)
    Selector setVol; // for GK2 volume sync on restore
    Selector reSyncVol; // for Torin volume sync on restore
    Selector set; // for LSL6hires subtitle sync
    Selector clear; // for LSL6hires subtitle sync
    Selector show; // for GK1 volume sync
    Selector position; // for GK1 volume sync
    Selector musicVolume; // for GK1 volume sync
    Selector soundVolume; // for GK1 volume sync
    Selector initialOff; // for GK2 volume sync
    Selector setPos; // for Torin volume sync
    Selector setSize; // for PQ4 volume sync
    Selector displayValue; // for PQ:SWAT volume sync
    Selector new_; // for Torin/LSL7 save/load patching
    Selector mainCel; // for MGDX volume sync
    Selector move; // for Phant2 volume sync
    Selector eachElementDo; // for Phant2 volume sync
    Selector physicalBar; // for Phant2 volume sync
    Selector init; // for Phant2 save/load patching
    Selector scratch; // for Phant2 save/load patching
    Selector num; // for Phant2 restore from launcher
    Selector reallyRestore; // for Phant2 restore from launcher
    Selector bookMark; // for Phant2 auto-save
    Selector fileNumber; // for RAMA save/load
    Selector description; // for RAMA save/load
    Selector dispose; // for RAMA save/load save from launcher
    Selector masterVolume; // for RAMA volume sync
    Selector setCel; // for RAMA volume sync
    Selector value; // for QFG4 import dialog
#endif
};

#define SELECTOR(_slc_)     (g_sci->getKernel()->_selectorCache._slc_)

reg_t readSelector(SegManager *segMan, reg_t object, Selector selectorId);
#define readSelectorValue(segMan, _obj_, _slc_) (readSelector(segMan, _obj_, _slc_).getOffset())

void writeSelector(SegManager *segMan, reg_t object, Selector selectorId, reg_t value);
#define writeSelectorValue(segMan, _obj_, _slc_, _val_) writeSelector(segMan, _obj_, _slc_, make_reg(0, _val_))

void invokeSelector(EngineState *s, reg_t object, int selectorId,
    int k_argc, StackPtr k_argp, int argc = 0, const reg_t *argv = 0);

#ifdef ENABLE_SCI32

void updateInfoFlagViewVisible(Object *obj, int index, bool fromPropertyOp = false);
#endif

} // End of namespace Sci

#endif // SCI_ENGINE_SELECTOR_H