Public API Reference

csutil/win32/csosdefs.h

/*
    Copyright (C) 1998 by Jorrit Tyberghein
    Written by Andrew Zabolotny <[email protected]>

    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Library General Public
    License as published by the Free Software Foundation; either
    version 2 of the License, or (at your option) any later version.

    This library 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
    Library General Public License for more details.

    You should have received a copy of the GNU Library General Public
    License along with this library; if not, write to the Free
    Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*/

#ifndef __CS_CSOSDEFS_H__
#define __CS_CSOSDEFS_H__

#define CS_EXPORT_SYM_DLL       __declspec(dllexport)
#define CS_IMPORT_SYM_DLL       __declspec(dllimport)

#ifdef CS_BUILD_SHARED_LIBS
  #define CS_EXPORT_SYM CS_EXPORT_SYM_DLL
  #define CS_IMPORT_SYM CS_IMPORT_SYM_DLL
#else
  #define CS_EXPORT_SYM
  #define CS_IMPORT_SYM
#endif // CS_BUILD_SHARED_LIBS

#if defined(CS_COMPILER_MSVC)
  //#pragma warning(disable:4097)   // use of xxx as synonym for a classname
  //#pragma warning(disable:4099)   // type seen as both 'struct' and `class'
  //#pragma warning(disable:4100)   // Use of void* as a formal function parameter
  //#pragma warning(disable:4102)   // 'label' : unreferenced label
  //#pragma warning(disable:4146)   /* unary minus operator applied to unsigned 
  //                                 * type, result still unsigned */
  //#pragma warning(disable:4201)   // VC6: structure/ union without name.
  #pragma warning(disable:4244)   // conversion from 'double' to 'float'
  #pragma warning(disable:4250)   // '...' inherits '..' via dominance
  //#pragma warning(disable:4251)   /* class needs to have dll-interface to be 
  //                               * used by clients */
  //#pragma warning(disable:4275)   /* non-DLL-interface used as base for
  //                                 * DLL-interface */
  #pragma warning(disable:4290)   // C++ exception specification ignored
  //#pragma warning(disable:4291)   // no matching operator delete found
  #pragma warning(disable:4312)   /* 'variable' : conversion from 'type' to 
                                   * 'type' of greater size */
  #pragma warning(disable:4345)   /* VC7.1: an object of POD type constructed 
                                   * with an initializer of the form () will 
                                   * be default-initialized */
  #pragma warning(disable:4355)   // 'this' used in base member initializer list
  //#pragma warning(disable:4390)   // Empty control statement
  //#pragma warning(disable:4505)   /* 'function' : unreferenced local function 
  //                                 * has been removed */
  //#pragma warning(disable:4611)   /* interaction between _setjmp and C++ 
  //                                 * destructors not portable */
  //#pragma warning(disable:4702)   // Unreachable Code
  //#pragma warning(disable:4706)   // Assignment in conditional expression
  //#pragma warning(disable:4710)   // function not inlined
//  #pragma warning(disable:4711)   /* function 'function' selected for inline 
//                                 * expansion */
//  #pragma warning(disable:4786)   /* VC6: identifier was truncated to '255'
//                                 * characters in the browser information */
//  #pragma warning(disable:4800)   // Forcing value to bool
  //#pragma warning(disable:4805)   // unsafe mix of bool and int.

//  #pragma warning(default:4265)   /* class has virtual functions, but 
//                                 * destructor is not virtual */

  #pragma inline_depth (255)
  #pragma inline_recursion (on)
  #pragma auto_inline (on)
  
  #define CS_FORCEINLINE __forceinline

  #pragma intrinsic (memset, memcpy, memcmp)
  #pragma intrinsic (strcpy, strcmp, strlen, strcat)
  #pragma intrinsic (abs, fabs)
  #pragma intrinsic (_byteswap_ushort, _byteswap_ulong, _byteswap_uint64)
  
  #if _MSC_VER >= 1400
    /* Work around an apparent incompatibility between VC8's intrin.h and
     * the Windows SDK 6.0's winnt.h - _interlockedbittestandset and
     * _interlockedbittestandreset have slightly different prototypes.
     * Go Microsoft!
     */
    #define _interlockedbittestandset   workaround_header_bug_1
    #define _interlockedbittestandreset workaround_header_bug_2
    #include <intrin.h>
    #undef _interlockedbittestandset
    #undef _interlockedbittestandreset
  #else
    extern "C" long _InterlockedCompareExchange (long volatile *, long, long);
    extern "C" long _InterlockedDecrement (long volatile *);
    extern "C" long _InterlockedExchange (long volatile *, long);
    extern "C" long _InterlockedIncrement (long volatile *);
  #endif
  #pragma intrinsic (_InterlockedCompareExchange)
  #pragma intrinsic (_InterlockedDecrement)
  #pragma intrinsic (_InterlockedExchange)
  #pragma intrinsic (_InterlockedIncrement)

  #if defined(__CRYSTAL_SPACE__) && !defined(CS_DEBUG)
    #pragma code_seg("CSpace")    // Just for fun :)
    // However, doing this in debug builds prevents Edit & Continue from
    // functioning properly :/
  #endif

  // VC8 quirks
  #if (_MSC_VER >= 1400)
    // Also note quirk in csconfig.h

    // Nothing else atm.
  #endif
#endif

#ifndef WINVER
#define WINVER 0x0400
#endif

// So many things require this. IF you have an issue with something defined
// in it then undef that def here.

#if defined(CS_COMPILER_GCC)

// From the w32api header files:

#if defined(__i686__) && !defined(_M_IX86)
#define _M_IX86 600
#elif defined(__i586__) && !defined(_M_IX86)
#define _M_IX86 500
#elif defined(__i486__) && !defined(_M_IX86)
#define _M_IX86 400
#elif defined(__i386__) && !defined(_M_IX86)
#define _M_IX86 300
#endif
#if defined(_M_IX86) && !defined(_X86_)
#define _X86_
#endif

#ifdef __GNUC__
#ifndef NONAMELESSUNION
#if __GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 95) 
#define _ANONYMOUS_UNION __extension__
#define _ANONYMOUS_STRUCT __extension__
#else
#if defined(__cplusplus)
#define _ANONYMOUS_UNION __extension__
#endif /* __cplusplus */
#endif /* __GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 95) */
#endif /* NONAMELESSUNION */
#endif /* __GNUC__ */

#ifndef _ANONYMOUS_UNION
#define _ANONYMOUS_UNION
#define _UNION_NAME(x) x
#define DUMMYUNIONNAME  u
#define DUMMYUNIONNAME2 u2
#define DUMMYUNIONNAME3 u3
#define DUMMYUNIONNAME4 u4
#define DUMMYUNIONNAME5 u5
#define DUMMYUNIONNAME6 u6
#define DUMMYUNIONNAME7 u7
#define DUMMYUNIONNAME8 u8
#else
#define _UNION_NAME(x)
#define DUMMYUNIONNAME
#define DUMMYUNIONNAME2
#define DUMMYUNIONNAME3
#define DUMMYUNIONNAME4
#define DUMMYUNIONNAME5
#define DUMMYUNIONNAME6
#define DUMMYUNIONNAME7
#define DUMMYUNIONNAME8
#endif
#ifndef _ANONYMOUS_STRUCT
#define _ANONYMOUS_STRUCT
#define _STRUCT_NAME(x) x
#define DUMMYSTRUCTNAME s
#define DUMMYSTRUCTNAME2 s2
#define DUMMYSTRUCTNAME3 s3
#else
#define _STRUCT_NAME(x)
#define DUMMYSTRUCTNAME
#define DUMMYSTRUCTNAME2
#define DUMMYSTRUCTNAME3
#endif

#else

#if !defined(_X86_) && !defined(_IA64_) && !defined(_AMD64_) && \
     defined(_M_IX86)
#define _X86_
#endif

#if !defined(_X86_) && !defined(_IA64_) && !defined(_AMD64_) && \
     defined(_M_AMD64)
#define _AMD64_
#endif

#if !defined(_X86_) && !defined(_M_IX86) && !defined(_AMD64_) && \
     defined(_M_IA64) && !defined(_IA64_)
#define _IA64_
#endif

#endif

#ifndef __CYGWIN32__
#include <excpt.h>
#endif
#include <stdarg.h>
#include <windef.h>
#include <winbase.h>
#include <malloc.h>
#include <sys/types.h>
#include <sys/stat.h>
#ifdef CS_HAVE_SYS_PARAM_H
#include <sys/param.h>
#endif
#ifndef __CYGWIN32__
#include <direct.h>
#endif


#ifndef WINGDIAPI
#define WINGDIAPI DECLSPEC_IMPORT
#endif

/*
  LONG_PTR is used in the Win32 canvases, but it's only defined in newer 
  Platform or DirectX SDKs (in BaseTsd.h).
  Ergo, on older SDKs, we have to define it ourselves. One indicator for the
  presence of LONG_PTR seems to be if the __int3264 macro is #defined.
  So, if it's not, we define LONG_PTR.
 */
#ifndef __int3264
  typedef LONG LONG_PTR;
  typedef ULONG ULONG_PTR;
  typedef DWORD DWORD_PTR;
#endif

#if defined(_DEBUG) || defined(CS_DEBUG)
  #include <assert.h>
  #ifndef CS_DEBUG
    #define CS_DEBUG
  #endif

  #if defined(CS_COMPILER_MSVC) 
    #include <crtdbg.h>

    #if defined(CS_EXTENSIVE_MEMDEBUG)
      #define malloc(size) \
        _malloc_dbg ((size), _NORMAL_BLOCK, __FILE__, __LINE__)
      #define free(ptr) _free_dbg ((ptr), _NORMAL_BLOCK)
      #define realloc(ptr, size) \
        _realloc_dbg ((ptr), (size), _NORMAL_BLOCK, __FILE__, __LINE__)
      #define calloc(num, size) \
        _calloc_dbg ((num), (size), _NORMAL_BLOCK, __FILE__, __LINE__)

      // heap consistency check is on by default, leave it
      #define CS_WIN32_MSVC_DEBUG_GOOP \
        _CrtSetDbgFlag ( \
          _CrtSetDbgFlag (_CRTDBG_REPORT_FLAG) | _CRTDBG_LEAK_CHECK_DF)
    #else
      // turn heap consistency check off
      #define CS_WIN32_MSVC_DEBUG_GOOP \
        _CrtSetDbgFlag ( \
          (_CrtSetDbgFlag (_CRTDBG_REPORT_FLAG) & ~_CRTDBG_ALLOC_MEM_DF) | \
          _CRTDBG_LEAK_CHECK_DF)
    #endif
  #endif

#endif

#ifdef CS_WIN32_MSVC_DEBUG_GOOP
  #define CS_INITIALIZE_PLATFORM_APPLICATION CS_WIN32_MSVC_DEBUG_GOOP
#endif

// The 2D graphics driver used by software renderer on this platform
#define CS_SOFTWARE_2D_DRIVER "crystalspace.graphics2d.directdraw"
#define CS_OPENGL_2D_DRIVER "crystalspace.graphics2d.glwin32"

// The sound driver
#define CS_SOUND_DRIVER "crystalspace.sound.driver.waveout"
#define CS_SNDSYS_DRIVER "crystalspace.sndsys.software.driver.directsound"

// SCF symbol export facility.
#ifndef CS_STATIC_LINKED
// No need to export the symbols when statically linking into one big binary.
# undef CS_EXPORTED_FUNCTION
# define CS_EXPORTED_FUNCTION extern "C" __declspec(dllexport)
#endif

#if defined (CS_COMPILER_BCC)
#  define strcasecmp stricmp
#  define strncasecmp strnicmp
#endif

#if defined (CS_COMPILER_MSVC)
#  define strcasecmp _stricmp
#  define strncasecmp _strnicmp
#endif

#if defined (CS_COMPILER_MSVC)
#  if defined(_MSC_VER) && (_MSC_VER < 1300)
#    include <assert.h>
static inline longlong strtoll(char const* s, char** sN, int base)
{
  assert(sN == 0);
  assert(base == 10);
  return _atoi64(s);
}
#  else
#   define strtoll _strtoi64
#  endif
#endif

// Maximal path length
#ifndef CS_MAXPATHLEN
#  ifdef _MAX_FNAME
#    define CS_MAXPATHLEN _MAX_FNAME
#  else
#    define CS_MAXPATHLEN 260 /* not 256 */
#  endif
#endif
#define CS_PATH_DELIMITER ';'
#define CS_PATH_SEPARATOR '\\'

#if defined (__CYGWIN32__)
#  define CS_MKDIR(path) mkdir(path, 0755)
#else
#  define CS_MKDIR(path) _mkdir(path)
#endif

// Directory read functions, file access, etc.
#include <io.h>
#ifndef F_OK
#  define F_OK 0
#endif
#ifndef R_OK
#  define R_OK 2
#endif
#ifndef W_OK
#  define W_OK 4
#endif

#define CS_PROVIDES_EXPAND_PATH 1
inline void csPlatformExpandPath(const char* /*path*/, char* /*buffer*/,
  int /*nbuf*/) {}

// Although CS_COMPILER_GCC has opendir(), readdir(), etc., we prefer the CS
// versions of these functions.
#define CS_WIN32_USE_CUSTOM_OPENDIR

#ifndef CS_WIN32_USE_CUSTOM_OPENDIR
# include <dirent.h>
#else
struct dirent
{
  char d_name [CS_MAXPATHLEN + 1]; // File name, 0 terminated
  size_t d_size; // File size (bytes)
  long dwFileAttributes; // File attributes (Windows-specific)
};

struct DIR;
# ifdef CS_CRYSTALSPACE_LIB
  extern "C" CS_EXPORT_SYM DIR *opendir (const char *name);
  extern "C" CS_EXPORT_SYM dirent *readdir (DIR *dirp);
  extern "C" CS_EXPORT_SYM int closedir (DIR *dirp);
  extern "C" CS_EXPORT_SYM bool isdir (const char *path, dirent *de);
# else
  extern "C" CS_IMPORT_SYM DIR *opendir (const char *name);
  extern "C" CS_IMPORT_SYM dirent *readdir (DIR *dirp);
  extern "C" CS_IMPORT_SYM int closedir (DIR *dirp);
  extern "C" CS_IMPORT_SYM bool isdir (const char *path, dirent *de);
# endif // CS_BUILD_SHARED_LIBS
#endif

#if defined (CS_COMPILER_BCC) || defined (__CYGWIN32__)
#  define GETPID() getpid()
#else
#  define GETPID() _getpid()
#endif

#ifdef __CYGWIN32__
#  include <unistd.h>
#  define CS_TEMP_FILE "cs%lu.tmp", (unsigned long)getpid()
#  define CS_TEMP_DIR  "/tmp"
#else
#  include <process.h>
#  define CS_TEMP_FILE "%x.cs", (int)GETPID()
#  define CS_TEMP_DIR win32_tempdir()
   // This is the function called by CS_TEMP_DIR macro
   static inline char *win32_tempdir()
   {
     char *tmp;
     if ((tmp = getenv ("TMP")) != 0)
       return tmp;
     if ((tmp = getenv ("TEMP")) != 0)
       return tmp;
     return "";
   }
#endif

// Microsoft Visual C++ compiler includes a very in-efficient 'memcpy'.
// This also replaces the older 'better_memcpy', which was also not as
// efficient as it could be ergo... heres a better solution.
#if defined(CS_COMPILER_MSVC) && (_MSC_VER < 1300)
#include <memory.h>
#define memcpy fast_mem_copy
static inline void* fast_mem_copy (void *dest, const void *src, int count)
{
    __asm
    {
      mov               eax, count
      mov               esi, src
      mov               edi, dest
      xor               ecx, ecx

      // Check for 'short' moves
      cmp               eax, 16
      jl                do_short
                
      // Move enough bytes to align 'dest'
      sub               ecx, edi
      and               ecx, 3
      je                skip
      sub               eax, ecx
      rep               movsb

      skip:
        mov             ecx, eax
        and             eax, 3
        shr             ecx, 2
        rep             movsd
        test    eax, eax
        je              end

      do_short:
        mov             ecx, eax
        rep             movsb

      end:
    }

    return dest;
}
#endif

#ifdef CS_COMPILER_BCC
// Major hack due to pow failures in CS for Borland, removing this
// causes millions of strings to print out -- Brandon Ehle
#define pow(arga, argb) ( (!arga && !argb)?0:pow(arga, argb) )
// Dunno why this is in CS -- Brandon Ehle
#define DEBUG_BREAK
#endif

#if defined (CS_PROCESSOR_X86)
#  define CS_LITTLE_ENDIAN
#else
#  error "Please define a suitable CS_XXX_ENDIAN macro in win32/csosdefs.h!"
#endif

#if defined(CS_COMPILER_BCC)
  // The Borland C++ compiler does not accept a 'main' routine
  // in a program which already contains WinMain. This is a work-around.
  #undef main
  #define main csMain
#endif

// cygwin has no _beginthread and _endthread functions
#ifdef __CYGWIN32__
#ifndef _beginthread
#define _beginthread(func, stack, ptr)  CreateThread (0, 0, \
          LPTHREAD_START_ROUTINE(func), ptr, CREATE_SUSPENDED, 0)
#endif
#ifndef _endthread
#define _endthread()  {}
#endif
#endif

// Fake up setenv(), if necessary
#ifndef CS_HAVE_SETENV
  #ifdef CS_CRYSTALSPACE_LIB
    CS_EXPORT_SYM int setenv (const char* name, const char* value, 
      bool overwrite);
  #else
    CS_IMPORT_SYM int setenv (const char* name, const char* value, 
      bool overwrite);
  #endif
#endif

// just to avoid windows.h inclusion
#define csSW_SHOWNORMAL 1

#if defined(CS_COMPILER_GCC) && defined(__STRICT_ANSI__)
// Need those...
  extern int            _argc;
  extern char** _argv;
  #define CS_WIN32_ARGC _argc
  #define CS_WIN32_ARGV _argv
#elif defined(CS_COMPILER_BCC) 
  #define CS_WIN32_ARGC _argc
  #define CS_WIN32_ARGV _argv
#else
  #define CS_WIN32_ARGC __argc
  #define CS_WIN32_ARGV __argv
#endif


#ifdef __CYGWIN32__
#if !defined(CS_IMPLEMENT_PLATFORM_APPLICATION)
#define CS_IMPLEMENT_PLATFORM_APPLICATION
#endif

#else // __CYGWIN32__

/*
 if the EXE is compiled as a GUI app,
 a WinMain is needed. But if compiled
 as a console app it's not used but main() is
 instead. 
 */

#if !defined(CS_IMPLEMENT_PLATFORM_APPLICATION)
#ifndef __STRICT_ANSI__
  #define csMain main
#else
  /* Work around "error: ISO C++ forbids taking address of function `::main'"
   * when compiling -ansi -pedantic */
  #define csMain mainWithAnotherNameBecauseISOCPPForbidsIt
#endif
#define CS_IMPLEMENT_PLATFORM_APPLICATION                              \
int csMain (int argc, char* argv[]);                            \
int WINAPI WinMain (HINSTANCE hApp, HINSTANCE prev, LPSTR cmd, int show)\
{                                                                      \
  (void)hApp;                                                          \
  (void)show;                                                          \
  (void)prev;                                                          \
  (void)cmd;                                                           \
  int ret = csMain (CS_WIN32_ARGC, CS_WIN32_ARGV);                     \
  return ret;                                                          \
}
#ifdef __STRICT_ANSI__
  #define main mainWithAnotherNameBecauseISOCPPForbidsIt
#endif
#endif // CS_IMPLEMENT_PLATFORM_APPLICATION

#endif // __CYGWIN32__

#if !defined(CS_STATIC_LINKED)

#if !defined(CS_IMPLEMENT_PLATFORM_PLUGIN)
#define CS_IMPLEMENT_PLATFORM_PLUGIN                                   \
int _cs_main(int /*argc*/, char* /*argv*/[])                           \
{                                                                      \
         return 0;                                                     \
}                                                                      \
extern "C" BOOL WINAPI                                                 \
DllMain (HINSTANCE /*hinstDLL*/, DWORD /*fdwReason*/, LPVOID /*lpvReserved*/) \
{                                                                      \
          return TRUE;                                                 \
}                                                                      \
CS_EXPORTED_FUNCTION const char* plugin_compiler()                     \
{                                                                      \
         return CS_COMPILER_NAME;                                      \
}
#endif // CS_IMPLEMENT_PLATFORM_PLUGIN

#endif // CS_STATIC_LINKED

#include "sanity.inc"

#endif // __CS_CSOSDEFS_H__

---