147 lines
4.4 KiB
C
147 lines
4.4 KiB
C
/* Copyright (C) 2009 Wildfire Games.
|
|
* This file is part of 0 A.D.
|
|
*
|
|
* 0 A.D. 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 2 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* 0 A.D. 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 0 A.D. If not, see <http://www.gnu.org/licenses/>.
|
|
*/
|
|
|
|
/*
|
|
* various system-specific function implementations
|
|
*/
|
|
|
|
#ifndef INCLUDED_SYSDEP
|
|
#define INCLUDED_SYSDEP
|
|
|
|
#include "lib/debug.h" // ErrorReaction
|
|
|
|
#include <cstdarg> // needed for sys_vswprintf
|
|
|
|
|
|
//
|
|
// output
|
|
//
|
|
|
|
/**
|
|
* display a message.
|
|
*
|
|
* @param caption title message
|
|
* @param msg message contents
|
|
*
|
|
* implemented as a MessageBox on Win32 and printf on Unix.
|
|
* called from debug_DisplayMessage.
|
|
**/
|
|
extern void sys_display_msg(const wchar_t* caption, const wchar_t* msg);
|
|
|
|
/**
|
|
* show the error dialog.
|
|
*
|
|
* @param text to display (practically unlimited length)
|
|
* @param flags: see DebugDisplayErrorFlags.
|
|
* @return ErrorReaction (except ER_EXIT, which is acted on immediately)
|
|
*
|
|
* called from debug_DisplayError unless overridden by means of
|
|
* ah_display_error.
|
|
**/
|
|
extern ErrorReaction sys_display_error(const wchar_t* text, size_t flags);
|
|
|
|
|
|
//
|
|
// misc
|
|
//
|
|
|
|
/**
|
|
* sys_vswprintf: doesn't quite follow the standard for vswprintf, but works
|
|
* better across compilers:
|
|
* - handles positional parameters and %lld
|
|
* - always null-terminates the buffer
|
|
* - returns -1 on overflow (if the output string (including null) does not fit in the buffer)
|
|
**/
|
|
extern int sys_vswprintf(wchar_t* buffer, size_t count, const wchar_t* format, va_list argptr);
|
|
|
|
extern int sys_wopen(const wchar_t* pathname, int oflag, ...);
|
|
|
|
/**
|
|
* describe the current OS error state.
|
|
*
|
|
* @param err: if not 0, use that as the error code to translate; otherwise,
|
|
* uses GetLastError or similar.
|
|
* @param buf output buffer
|
|
* @param max_chars
|
|
*
|
|
* rationale: it is expected to be rare that OS return/error codes are
|
|
* actually seen by user code, but we leave the possibility open.
|
|
**/
|
|
extern LibError sys_error_description_r(int err, wchar_t* buf, size_t max_chars);
|
|
|
|
/**
|
|
* determine filename of the module to whom an address belongs.
|
|
*
|
|
* @param path full path to module (unchanged unless INFO::OK is returned).
|
|
* @return LibError
|
|
*
|
|
* note: this is useful for handling exceptions in other modules.
|
|
**/
|
|
LibError sys_get_module_filename(void* addr, fs::wpath& pathname);
|
|
|
|
/**
|
|
* get path to the current executable.
|
|
*
|
|
* @param path full path to executable (unchanged unless INFO::OK is returned).
|
|
* @return LibError
|
|
*
|
|
* this is useful for determining installation directory, e.g. for VFS.
|
|
**/
|
|
extern LibError sys_get_executable_name(fs::wpath& pathname);
|
|
|
|
/**
|
|
* have the user choose a directory via OS dialog.
|
|
*
|
|
* @param path (unchanged unless INFO::OK is returned).
|
|
**/
|
|
extern LibError sys_pick_directory(fs::wpath& path);
|
|
|
|
/**
|
|
* return the largest sector size [bytes] of any storage medium
|
|
* (HD, optical, etc.) in the system.
|
|
*
|
|
* this may be a bit slow to determine (iterates over all drives),
|
|
* but caches the result so subsequent calls are free.
|
|
* (caveat: device changes won't be noticed during this program run)
|
|
*
|
|
* sector size is relevant because Windows aio requires all IO
|
|
* buffers, offsets and lengths to be a multiple of it. this requirement
|
|
* is also carried over into the vfs / file.cpp interfaces for efficiency
|
|
* (avoids the need for copying to/from align buffers).
|
|
*
|
|
* waio uses the sector size to (in some cases) align IOs if
|
|
* they aren't already, but it's also needed by user code when
|
|
* aligning their buffers to meet the requirements.
|
|
*
|
|
* the largest size is used so that we can read from any drive. while this
|
|
* is a bit wasteful (more padding) and requires iterating over all drives,
|
|
* it is the only safe way: this may be called before we know which
|
|
* drives will be needed, and hardlinks may confuse things.
|
|
**/
|
|
extern size_t sys_max_sector_size();
|
|
|
|
/**
|
|
* directory separation character
|
|
**/
|
|
#if OS_WIN
|
|
# define SYS_DIR_SEP '\\'
|
|
#else
|
|
# define SYS_DIR_SEP '/'
|
|
#endif
|
|
|
|
#endif // #ifndef INCLUDED_SYSDEP
|