sfall/sfall/FalloutEngine/Functions.h

/*
* sfall
* Copyright (C) 2008-2017 The sfall team
*
* 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/>.
*/

#pragma once

#include "Structs.h"

//
// WRAPPERS for FO engine functions.
// Use those as you would if there were source code for the engine...
//
namespace fo
{
namespace func
{

// Prints debug message to debug.log file for develop build
#ifndef NDEBUG
void dev_printf(const char* fmt, ...);
#else
void dev_printf(...);
#endif

/*
	Add functions here if they have non-trivial wrapper implementation (like vararg functions or too many arguments, etc.)
	Otherwise use Functions_def.h file (much easier).
*/

bool __stdcall art_exists(long artFid);

// Returns the name of the critter
const char* __stdcall critter_name(GameObject* critter);

// Change the name of playable character
void critter_pc_set_name(const char* newName);

// Checks if given file exists in DB
bool __stdcall db_access(const char* fileName);

long __stdcall db_fclose(DbFile* file);

DbFile* __stdcall db_fopen(const char* path, const char* mode);

long __stdcall db_fgetc(DbFile* file);

char* __stdcall db_fgets(char* buf, long max_count, DbFile* file);

//long db_ungetc(long c, DBFile* file);
long __stdcall db_fread(void* buf, long elsize, long count, DbFile* file);

long __stdcall db_fseek(DbFile* file, long pos, long origin);

long __stdcall db_freadByte(DbFile* file, BYTE* _out);

long __stdcall db_freadByteCount(DbFile* file, BYTE* cptr, long count);

long __stdcall db_freadShort(DbFile* file, WORD* _out);

long __stdcall db_freadInt(DbFile* file, DWORD* _out);

// destroys filelist array created by db_get_file_list
void __stdcall db_free_file_list(char* * *fileList, DWORD arg2);

long __stdcall db_fwriteByteCount(DbFile* file, const BYTE* cptr, long count);

// searches files in DB by given path/filename mask and stores result in fileList
// fileList is a pointer to a variable, that will be assigned with an address of an array of char* strings
// returns number of elements in *fileList
long __stdcall db_get_file_list(const char* searchMask, char* * *fileList);

long __stdcall db_init(const char* path_dat, const char* path_patches);

// Check fallout file and get file size (result 0 - file exists)
long __stdcall db_dir_entry(const char *fileName, DWORD *sizeOut);

// prints message to debug.log file
void __declspec() debug_printf(const char* fmt, ...);

// Displays message in main UI console window
void display_print(const char* msg);

// execute script proc by internal proc number (from script's proc table, basically a sequential number of a procedure as defined in code, starting from 1)
void executeProcedure(Program* sptr, long procNum);

long __stdcall get_input();

long _stdcall isPartyMember(GameObject* obj);

long __stdcall item_get_type(GameObject* item);

// searches for message ID in given message file and places result in @result
const char* _stdcall getmsg(const MessageList* fileAddr, MessageNode* result, long messageId);

// plays SFX sound with given name
void __stdcall gsound_play_sfx_file(const char* name);

long __stdcall interpret(Program* program, long arg2);

// finds procedure ID for given script program pointer and procedure name
long __stdcall interpretFindProcedure(Program* scriptPtr, const char* procName);

// pops value type from Data stack (must be followed by InterpretPopLong)
DWORD __stdcall interpretPopShort(Program* scriptPtr);

// pops value from Data stack (must be preceded by InterpretPopShort)
DWORD __stdcall interpretPopLong(Program* scriptPtr);

// pushes value to Data stack (must be followed by InterpretPushShort)
void __stdcall interpretPushLong(Program* scriptPtr, DWORD val);

// pushes value type to Data stack (must be preceded by InterpretPushLong)
void __stdcall interpretPushShort(Program* scriptPtr, DWORD valType);

const char* __fastcall interpretGetString(Program* scriptPtr, DWORD dataType, DWORD strId);

DWORD __stdcall interpretAddString(Program* scriptPtr, const char* str);

// prints scripting error in debug.log and stops current script execution by performing longjmp
// USE WITH CAUTION
void __declspec() interpretError(const char* fmt, ...);

// Returns 0 on success, -1 if the item has no charges
long __stdcall item_m_dec_charges(GameObject* item);

GameObject* __stdcall inven_pid_is_carried_ptr(GameObject* invenObj, long pid);

// critter worn item (armor)
GameObject* __stdcall inven_worn(GameObject* critter);

// item in critter's left hand slot
GameObject* __stdcall inven_left_hand(GameObject* critter);

// item in critter's right hand slot
GameObject* __stdcall inven_right_hand(GameObject* critter);

// returns the name of current procedure by program pointer
const char* __stdcall findCurrentProc(Program* program);

Program* __stdcall loadProgram(const char* fileName);

void* __stdcall mem_realloc(void* lpmem, DWORD msize);

long __stdcall message_add(MessageList* file, MessageNode* msg);

long __stdcall message_filter(MessageList* file);

long __stdcall message_make_path(char* outpath, char* path);

long __stdcall message_search(const MessageList* file, MessageNode* msg);

// loads MSG file into given MessageList
long __stdcall message_load(MessageList *msgList, const char *msgFilePath);

// destroys message list
long __stdcall message_exit(MessageList *msgList);

long __fastcall tile_num(long x, long y);

GameObject* __fastcall obj_blocking_at_wrapper(GameObject* obj, DWORD tile, DWORD elevation, void* func);

GameObject* __stdcall obj_find_first_at_tile(long elevation, long tileNum);

GameObject* __stdcall obj_find_next_at_tile();

long _stdcall partyMemberGetCurLevel(GameObject* obj);

long _stdcall perk_level(GameObject* critter, long perkId);

// places pointer to a prototype structure into ptrPtr and returns 0 on success or -1 on failure
long proto_ptr(long pid, Proto* *ptrPtr);

DWORD* __stdcall runProgram(Program* progPtr);

ScriptInstance* __stdcall scr_find_first_at(long elevation);

ScriptInstance* __stdcall scr_find_next_at();

GameObject* __stdcall scr_find_obj_from_program(Program* program);

// Saves pointer to script object into scriptPtr using scriptID.
// Returns 0 on success, -1 on failure.
long __stdcall scr_ptr(long scriptId, ScriptInstance** scriptPtr);

void skill_get_tags(long* result, long num);
void skill_set_tags(long* tags, long num);

long __stdcall stat_level(GameObject* critter, long statId);

// Creates a button on a given window
// buttonType: 0x10 = move window pos, 0x20 or 0x0 = regular click, 0x23 = toggle click
// pictureUp/pictureDown - pointers to a surface
long __stdcall win_register_button(DWORD winRef, long xPos, long yPos, long width, long height, long hoverOn, long hoverOff, long buttonDown, long buttonUp, BYTE* pictureUp, BYTE* pictureDown, long arg12, long buttonType);

void __stdcall DialogOut(const char* text);

long __fastcall DialogOutEx(const char* text, const char** textEx, long count, long flags);

// draws an image to the buffer without scaling and with transparency display toggle
void __fastcall windowDisplayBuf(long x, long width, long y, long height, void* data, long noTrans);

// draws an image in the window and scales it to fit the window
void __fastcall displayInWindow(long w_here, long width, long height, void* data);

void __fastcall trans_cscale(long i_width, long i_height, long s_width, long s_height, long xy_shift, long w_width, void* data);

//void __declspec() __stdcall buf_to_buf(void* to_buf, long to_width, void* from_buf, long from_width, long width, long height);

long __fastcall get_game_config_string(const char* outValue, const char* section, const char* param);

// X-Macro for wrapper functions.
#define WRAP_WATCOM_FUNC0(retType, name) \
	retType __stdcall name();

#define WRAP_WATCOM_FUNC1(retType, name, arg1t, arg1) \
	retType __stdcall name(arg1t arg1);

#define WRAP_WATCOM_FUNC2(retType, name, arg1t, arg1, arg2t, arg2) \
	retType __stdcall name(arg1t arg1, arg2t arg2);

#define WRAP_WATCOM_FUNC3(retType, name, arg1t, arg1, arg2t, arg2, arg3t, arg3) \
	retType __stdcall name(arg1t arg1, arg2t arg2, arg3t arg3);

#define WRAP_WATCOM_FUNC4(retType, name, arg1t, arg1, arg2t, arg2, arg3t, arg3, arg4t, arg4) \
	retType __stdcall name(arg1t arg1, arg2t arg2, arg3t arg3, arg4t arg4);

#define WRAP_WATCOM_FUNC5(retType, name, arg1t, arg1, arg2t, arg2, arg3t, arg3, arg4t, arg4, arg5t, arg5) \
	retType __stdcall name(arg1t arg1, arg2t arg2, arg3t arg3, arg4t arg4, arg5t arg5);

#define WRAP_WATCOM_FUNC6(retType, name, arg1t, arg1, arg2t, arg2, arg3t, arg3, arg4t, arg4, arg5t, arg5, arg6t, arg6) \
	retType __stdcall name(arg1t arg1, arg2t arg2, arg3t arg3, arg4t arg4, arg5t arg5, arg6t arg6);


#define WRAP_WATCOM_FFUNC1(retType, name, arg1t, arg1) \
	retType __fastcall name(arg1t arg1);

#define WRAP_WATCOM_FFUNC2(retType, name, arg1t, arg1, arg2t, arg2) \
	retType __fastcall name(arg1t arg1, arg2t arg2);

#define WRAP_WATCOM_FFUNC3(retType, name, arg1t, arg1, arg2t, arg2, arg3t, arg3) \
	retType __fastcall name(arg1t arg1, arg2t arg2, arg3t arg3);

#define WRAP_WATCOM_FFUNC4(retType, name, arg1t, arg1, arg2t, arg2, arg3t, arg3, arg4t, arg4) \
	retType __fastcall name(arg1t arg1, arg2t arg2, arg3t arg3, arg4t arg4);

#define WRAP_WATCOM_FFUNC5(retType, name, arg1t, arg1, arg2t, arg2, arg3t, arg3, arg4t, arg4, arg5t, arg5) \
	retType __fastcall name(arg1t arg1, arg2t arg2, arg3t arg3, arg4t arg4, arg5t arg5);

#define WRAP_WATCOM_FFUNC6(retType, name, arg1t, arg1, arg2t, arg2, arg3t, arg3, arg4t, arg4, arg5t, arg5, arg6t, arg6) \
	retType __fastcall name(arg1t arg1, arg2t arg2, arg3t arg3, arg4t arg4, arg5t arg5, arg6t arg6);

#define WRAP_WATCOM_FFUNC7(retType, name, arg1t, arg1, arg2t, arg2, arg3t, arg3, arg4t, arg4, arg5t, arg5, arg6t, arg6, arg7t, arg7) \
	retType __fastcall name(arg1t arg1, arg2t arg2, arg3t arg3, arg4t arg4, arg5t arg5, arg6t arg6, arg7t arg7);

#include "Functions_def.h"

#undef WRAP_WATCOM_FUNC0
#undef WRAP_WATCOM_FUNC1
#undef WRAP_WATCOM_FUNC2
#undef WRAP_WATCOM_FUNC3
#undef WRAP_WATCOM_FUNC4
#undef WRAP_WATCOM_FUNC5
#undef WRAP_WATCOM_FUNC6
//#undef WRAP_WATCOM_FUNC7

#undef WRAP_WATCOM_FFUNC1
#undef WRAP_WATCOM_FFUNC2
#undef WRAP_WATCOM_FFUNC3
#undef WRAP_WATCOM_FFUNC4
#undef WRAP_WATCOM_FFUNC5
#undef WRAP_WATCOM_FFUNC6
#undef WRAP_WATCOM_FFUNC7

}
}