/*=============================================================================
    UTILITY.H: General utility declarations for the Windows interface system
    of Homeworld.

        Created June 1997 by Luke Moloney.
=============================================================================*/

#ifndef ___UITILITY_H
#define ___UITILITY_H

#include "types.h"
#include "prim2d.h"
#include "region.h"
#include "feflow.h"
#include "objtypes.h"
#include "TitanInterfaceC.h"

/*=============================================================================
    Switches:
=============================================================================*/
#ifndef HW_Release

#define UTY_ERROR_CHECKING      1               //basic error checking
#define UTY_VERBOSE_LEVEL       1               //control verbose printing
#define UTY_PLAYER_LOGGING      1               //PlayerStart.log

#else //HW_Debug

#define UTY_ERROR_CHECKING      0               //no error ckecking in retail
#define UTY_VERBOSE_LEVEL       0               //don't print any verbose strings in retail
#define UTY_PLAYER_LOGGING      0               //PlayerStart.log

#endif //HW_Debug

/*=============================================================================
    Definitions:
=============================================================================*/
#define UTY_ErrorStringLength       256
#define UTY_TimerResloutionMax      240         //maximum timer resolution
//bit-field flags stating which system has started properly
typedef enum
{
    SSA_DebugWindow,
    SSA_FilePrepend,
    SSA_MemoryHeap,
    SSA_MemoryModule,
    SSA_Timer,
    SSA_Task,
    SSA_Mouse,
    SSA_Region,
    SSA_Render,
    SSA_Texture,
    SSA_Universe,
    SSA_Selection,
    SSA_MainRegion,
    SSA_UIControls,
    SSA_FEFlow,
    SSA_MouseClipped,
    SSA_ConstructionManager,
    SSA_Effect,
    SSA_FrontEndData,
    SSA_Undo,
    SSA_FontReg,
    SSA_TacticalOverlay,
    SSA_ShipTrails,
    SSA_Lights,
    SSA_TextureRegistry,
    SSA_RegistryRefreshed,
    SSA_TaskBar,
    SSA_SensorsManager,
    SSA_ColorPicker,
    SSA_Teams,
    SSA_ScenarioPicker,
    SSA_RandomNumbers,
    SS2_BSpline,
    SS2_NIS,
    SS2_NetworkQueues,
    SS2_Guns,
    SS2_MultiplayerGame,
    SS2_AIPlayer,
    SS2_Strings,
    SS2_LaunchMgr,
    SS2_DemoMode,
    SS2_ResearchMgr,
    SS2_PlugScreen,
    SS2_Prim3D,
    SS2_BabyCallBackRegistry,
    SS2_InfoOverlay,
    SS2_GamePicker,
    SS2_GameChat,
    SS2_ShipView,
    SS2_Ping,
    SS2_BattleChatter,
    SS2_SubTitle,
    SS2_Tutorial,
    SS2_ToggleKeys,
    SS2_SoundEngine,

    SS2_SystemStarted,

    SSA_NumberBits
}
startupbit;

/*=============================================================================
    Macros:
=============================================================================*/
//these macrs defined in case we have to create a mapping from windows virtual
//key codes to our own internal key codes.
#define KeyMapFromWindows(n)        (n)
#define utyTest(f)              (utyStartedBits[f])
#define utySet(f)               (utyStartedBits[f] = TRUE)
#define utyClear(f)             (utyStartedBits[f] = FALSE)
#define utyTest2(f)             utyTest(f)
#define utySet2(f)              utySet(f)
#define utyClear2(f)            utyClear(f)


/*=============================================================================
    Data:
=============================================================================*/
//flag stating system has started properly
extern sdword utySystemStarted;
extern regionhandle ghMainRegion;
sdword enableTextures;
sdword enableSmoothing;
sdword enableStipple;
extern ShipRace whichRaceSelected;

extern color utyBaseColor;
extern color utyStripeColor;
extern char utyName[MAX_PERSONAL_NAME_LEN];
extern char utyPassword[MAX_PERSONAL_NAME_LEN];

extern char levelfile[];
extern char dirfile[];

extern udword utyNFrameTicks;
extern taskhandle utyRenderTask;
#if defined(CGW) || defined (Downloadable) || defined (OEM)
extern bool utyPlugScreens;
#endif
extern bool utyCreditsSequence;

extern bool8 utyStartedBits[SSA_NumberBits];

extern char utyMusicFilename[];
extern char utyVoiceFilename[];

/*=============================================================================
    Functions:
=============================================================================*/
//handles the message loop for fatal errors
void utyFatalErrorWaitLoop(int exitCode);
sdword utyNonFatalErrorWaitLoop(void);

//startup/shutdown game systems
char *utyGameSystemsPreInit(void);
char *utyGameSystemsPreShutdown(void);
char *utyGameSystemsInit(void);
char *utyGameSystemsShutdown(void);

udword utyCloseOK(regionhandle region, sdword ID, udword event, udword data);

void gameStart(char *loadfilename);
void gameEnd(void);

//query system timer and call task manager
void utyTasksDispatch(void);
void utyTaskTimerClear(void);                   //cancels all previous task time

//get client rect in screen coords
void utyClientRectGet(rectangle *rect);
void utyMouseButtonsClear(void);
void utyForceTopmost(bool bTopMost);

//clip the mouse
void utyClipMouse(sdword clip);

void utyNewGameStart(char *name, featom *atom);
void utyGameQuitToMain(char *name, featom *atom);

//load/save options from disk
void utyOptionsFileRead(void);
void utyOptionsFileRead(void);

//text entry things
real32 utyCaretBlinkRate(void);
void utyDoubleClick(void);

void utyLoadSinglePlayerGameGivenFilename(char *filename);
void utyLoadMultiPlayerGameGivenFilename(char *filename);

bool utyChangeResolution(sdword width, sdword height, sdword depth);

udword utyDataCRCCompute(void);
udword utyCodeCRCCompute(void);
bool utyBrowserExec(char *URL);
void utyGetFirstCDPath(char *szPath);

void utyOptionsFileWrite(void);

//toggle key things
void utyToggleKeyStatesSave(void);
void utyToggleKeyStatesRestore(void);
bool utyCapsLockToggleState(void);

// Start the player dropped dialog box.
void utyStartDroppedDialog(sdword playernum);

extern sdword utyPlayerDroppedDisplay;

#endif //___UITILITY_H