/*

 * tclWinInt.h --

 *

 *	Declarations of Windows-specific shared variables and procedures.

 *

 * Copyright (c) 1994-1996 Sun Microsystems, Inc.

 *

 * See the file "license.terms" for information on usage and redistribution

 * of this file, and for a DISCLAIMER OF ALL WARRANTIES.

 *

 * RCS: @(#) $Id: tclWinInt.h,v 1.20.2.5 2006/03/10 10:35:25 vincentdarley Exp $

 */

#ifndef _TCLWININT

#define _TCLWININT

#ifndef _TCLINT

#include "tclInt.h"

#endif

#ifndef _TCLPORT

#include "tclPort.h"

#endif

/*

 * The following specifies how much stack space TclpCheckStackSpace()

 * ensures is available.  TclpCheckStackSpace() is called by Tcl_EvalObj()

 * to help avoid overflowing the stack in the case of infinite recursion.

 */

#define TCL_WIN_STACK_THRESHOLD 0x8000

#ifdef BUILD_tcl

# undef TCL_STORAGE_CLASS

# define TCL_STORAGE_CLASS DLLEXPORT

#endif

/*

 * Some versions of Borland C have a define for the OSVERSIONINFO for

 * Win32s and for NT, but not for Windows 95.

 * Define VER_PLATFORM_WIN32_CE for those without newer headers.

 */

#ifndef VER_PLATFORM_WIN32_WINDOWS

#define VER_PLATFORM_WIN32_WINDOWS 1

#endif

#ifndef VER_PLATFORM_WIN32_CE

#define VER_PLATFORM_WIN32_CE 3

#endif

/*

 * The following structure keeps track of whether we are using the 

 * multi-byte or the wide-character interfaces to the operating system.

 * System calls should be made through the following function table.

 */

typedef union {

    WIN32_FIND_DATAA a;

    WIN32_FIND_DATAW w;

} WIN32_FIND_DATAT;

typedef struct TclWinProcs {

    int useWide;

    BOOL (WINAPI *buildCommDCBProc)(CONST TCHAR *, LPDCB);

    TCHAR *(WINAPI *charLowerProc)(TCHAR *);

    BOOL (WINAPI *copyFileProc)(CONST TCHAR *, CONST TCHAR *, BOOL);

    BOOL (WINAPI *createDirectoryProc)(CONST TCHAR *, LPSECURITY_ATTRIBUTES);

    HANDLE (WINAPI *createFileProc)(CONST TCHAR *, DWORD, DWORD, 

	    LPSECURITY_ATTRIBUTES, DWORD, DWORD, HANDLE);

    BOOL (WINAPI *createProcessProc)(CONST TCHAR *, TCHAR *, 

	    LPSECURITY_ATTRIBUTES, LPSECURITY_ATTRIBUTES, BOOL, DWORD, 

	    LPVOID, CONST TCHAR *, LPSTARTUPINFOA, LPPROCESS_INFORMATION);

    BOOL (WINAPI *deleteFileProc)(CONST TCHAR *);

    HANDLE (WINAPI *findFirstFileProc)(CONST TCHAR *, WIN32_FIND_DATAT *);

    BOOL (WINAPI *findNextFileProc)(HANDLE, WIN32_FIND_DATAT *);

    BOOL (WINAPI *getComputerNameProc)(WCHAR *, LPDWORD);

    DWORD (WINAPI *getCurrentDirectoryProc)(DWORD, WCHAR *);

    DWORD (WINAPI *getFileAttributesProc)(CONST TCHAR *);

    DWORD (WINAPI *getFullPathNameProc)(CONST TCHAR *, DWORD nBufferLength, 

	    WCHAR *, TCHAR **);

    DWORD (WINAPI *getModuleFileNameProc)(HMODULE, WCHAR *, int);

    DWORD (WINAPI *getShortPathNameProc)(CONST TCHAR *, WCHAR *, DWORD); 

    UINT (WINAPI *getTempFileNameProc)(CONST TCHAR *, CONST TCHAR *, UINT, 

	    WCHAR *);

    DWORD (WINAPI *getTempPathProc)(DWORD, WCHAR *);

    BOOL (WINAPI *getVolumeInformationProc)(CONST TCHAR *, WCHAR *, DWORD, 

	    LPDWORD, LPDWORD, LPDWORD, WCHAR *, DWORD);

    HINSTANCE (WINAPI *loadLibraryProc)(CONST TCHAR *);

    TCHAR (WINAPI *lstrcpyProc)(WCHAR *, CONST TCHAR *);

    BOOL (WINAPI *moveFileProc)(CONST TCHAR *, CONST TCHAR *);

    BOOL (WINAPI *removeDirectoryProc)(CONST TCHAR *);

    DWORD (WINAPI *searchPathProc)(CONST TCHAR *, CONST TCHAR *, 

	    CONST TCHAR *, DWORD, WCHAR *, TCHAR **);

    BOOL (WINAPI *setCurrentDirectoryProc)(CONST TCHAR *);

    BOOL (WINAPI *setFileAttributesProc)(CONST TCHAR *, DWORD);

    /* 

     * These two function pointers will only be set when

     * Tcl_FindExecutable is called.  If you don't ever call that

     * function, the application will crash whenever WinTcl tries to call

     * functions through these null pointers.  That is not a bug in Tcl

     * -- Tcl_FindExecutable is obligatory in recent Tcl releases.

     */

    BOOL (WINAPI *getFileAttributesExProc)(CONST TCHAR *, 

	    GET_FILEEX_INFO_LEVELS, LPVOID);

    BOOL (WINAPI *createHardLinkProc)(CONST TCHAR*, CONST TCHAR*, 

				      LPSECURITY_ATTRIBUTES);

    INT (__cdecl *utimeProc)(CONST TCHAR*, struct _utimbuf *);

    /* These two are also NULL at start; see comment above */

    HANDLE (WINAPI *findFirstFileExProc)(CONST TCHAR*, UINT,

					 LPVOID, UINT,

					 LPVOID, DWORD);

    BOOL (WINAPI *getVolumeNameForVMPProc)(CONST TCHAR*, TCHAR*, DWORD);

    DWORD (WINAPI *getLongPathNameProc)(CONST TCHAR*, TCHAR*, DWORD);

    /* 

     * These six are for the security sdk to get correct file

     * permissions on NT, 2000, XP, etc.  On 95,98,ME they are

     * always null.

     */

    BOOL (WINAPI *getFileSecurityProc)(LPCTSTR lpFileName,

		     SECURITY_INFORMATION RequestedInformation,

		     PSECURITY_DESCRIPTOR pSecurityDescriptor,

		     DWORD nLength, 

		     LPDWORD lpnLengthNeeded);

    BOOL (WINAPI *impersonateSelfProc) (SECURITY_IMPERSONATION_LEVEL 

		      ImpersonationLevel);

    BOOL (WINAPI *openThreadTokenProc) (HANDLE ThreadHandle,

		      DWORD DesiredAccess, BOOL OpenAsSelf,

		      PHANDLE TokenHandle);

    BOOL (WINAPI *revertToSelfProc) (void);

    VOID (WINAPI *mapGenericMaskProc) (PDWORD AccessMask,

		      PGENERIC_MAPPING GenericMapping);

    BOOL (WINAPI *accessCheckProc)(PSECURITY_DESCRIPTOR pSecurityDescriptor,

		    HANDLE ClientToken, DWORD DesiredAccess,

		    PGENERIC_MAPPING GenericMapping,

		    PPRIVILEGE_SET PrivilegeSet,

		    LPDWORD PrivilegeSetLength,

		    LPDWORD GrantedAccess,

		    LPBOOL AccessStatus);

   /*

    * Unicode console support. WriteConsole and ReadConsole

    */

    BOOL (WINAPI *readConsoleProc)(HANDLE hConsoleInput,

	                           LPVOID lpBuffer,

	                           DWORD nNumberOfCharsToRead,

	                           LPDWORD lpNumberOfCharsRead,

	                           LPVOID lpReserved);

    BOOL (WINAPI *writeConsoleProc)(HANDLE hConsoleOutput,

				    const VOID* lpBuffer,

				    DWORD nNumberOfCharsToWrite,

				    LPDWORD lpNumberOfCharsWritten,

				    LPVOID lpReserved);

} TclWinProcs;

EXTERN TclWinProcs *tclWinProcs;

/*

 * Declarations of functions that are not accessible by way of the

 * stubs table.

 */

EXTERN void		TclWinEncodingsCleanup();

EXTERN void		TclWinResetInterfaceEncodings();

EXTERN void		TclWinInit(HINSTANCE hInst);

EXTERN int              TclWinSymLinkCopyDirectory(CONST TCHAR* LinkOriginal,

						   CONST TCHAR* LinkCopy);

EXTERN int              TclWinSymLinkDelete(CONST TCHAR* LinkOriginal, 

					    int linkOnly);

EXTERN char TclWinDriveLetterForVolMountPoint(CONST WCHAR *mountPoint);

#if defined(TCL_THREADS) && defined(USE_THREAD_ALLOC)

EXTERN void		TclWinFreeAllocCache(void);

EXTERN void		TclFreeAllocCache(void *);

EXTERN Tcl_Mutex	*TclpNewAllocMutex(void);

EXTERN void		*TclpGetAllocCache(void);

EXTERN void		TclpSetAllocCache(void *);

#endif /* TCL_THREADS */

/* Needed by tclWinFile.c and tclWinFCmd.c */

#ifndef FILE_ATTRIBUTE_REPARSE_POINT

#define FILE_ATTRIBUTE_REPARSE_POINT 0x00000400

#endif

#include "tclIntPlatDecls.h"

# undef TCL_STORAGE_CLASS

# define TCL_STORAGE_CLASS DLLIMPORT

#endif	/* _TCLWININT */