Ykkrosh
4b06ebd52d
Add buttons to open the web site and IRC. Tentatively allow Atlas to be launched from the menu. Add some shutdown functions to support relaunching into Atlas without having to restart the whole process. This was SVN commit r7714.
172 lines
5.3 KiB
C++
172 lines
5.3 KiB
C++
/* Copyright (c) 2010 Wildfire Games
|
|
*
|
|
* Permission is hereby granted, free of charge, to any person obtaining
|
|
* a copy of this software and associated documentation files (the
|
|
* "Software"), to deal in the Software without restriction, including
|
|
* without limitation the rights to use, copy, modify, merge, publish,
|
|
* distribute, sublicense, and/or sell copies of the Software, and to
|
|
* permit persons to whom the Software is furnished to do so, subject to
|
|
* the following conditions:
|
|
*
|
|
* The above copyright notice and this permission notice shall be included
|
|
* in all copies or substantial portions of the Software.
|
|
*
|
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
|
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
|
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
|
|
* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
|
|
* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
|
|
* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
|
|
* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
|
*/
|
|
|
|
/*
|
|
* 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, if count > 0
|
|
* - 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);
|
|
|
|
/**
|
|
* 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.
|
|
**/
|
|
LIB_API LibError sys_get_executable_name(fs::wpath& pathname);
|
|
|
|
/**
|
|
* get the current user's login name.
|
|
*
|
|
* @return login name, or empty string on error
|
|
*/
|
|
extern std::wstring sys_get_user_name();
|
|
|
|
/**
|
|
* have the user choose a directory via OS dialog.
|
|
*
|
|
* @param path's input value determines the starting directory for
|
|
* faster browsing. if INFO::OK is returned, it receives
|
|
* chosen directory path.
|
|
**/
|
|
extern LibError sys_pick_directory(fs::wpath& path);
|
|
|
|
/**
|
|
* open the user's default web browser to the given URL.
|
|
**/
|
|
extern LibError sys_open_url(const std::string& url);
|
|
|
|
/**
|
|
* 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();
|
|
|
|
/**
|
|
* generate high-quality random bytes.
|
|
*
|
|
* this should only be used with small numbers of bytes, to avoid
|
|
* hogging the system's entropy.
|
|
**/
|
|
extern LibError sys_generate_random_bytes(u8* buf, size_t count);
|
|
|
|
/**
|
|
* directory separation character
|
|
**/
|
|
#if OS_WIN
|
|
# define SYS_DIR_SEP '\\'
|
|
#else
|
|
# define SYS_DIR_SEP '/'
|
|
#endif
|
|
|
|
#endif // #ifndef INCLUDED_SYSDEP
|