Windows to Linux Porting Library

Transcription

1 Library Windows to Linux Porting Library ( W2LPL ) ADONTEC, All Rights Reserved.

2 This document describes how to use the W2LPL library within a custom application. Technical Support You can reach ADONTEC technical support by at support@adontec.com or most secure, via Support. Copyright Notice ADONTEC, All Rights Reserved. This documentation contains proprietary information of ADONTEC and distribution is limited to authorized licensees of ADONTEC. Any unauthorized reproduction or distribution of this document is strictly prohibited. 2-16

3 Introduction The process of porting code from Microsoft Windows* to Linux is not always an easy task. There are many differences between the APIs provided by Windows and Linux. In many cases it is not clear and by far not that easy to replace Windows specific code with equivalent Linux code. The Windows to Linux Porting Library (W2LPL) allows to easily port code from Windows to Linux operating systems. The library offers access to many commonly used functions provided by the Windows API. In order to correctly use this library please consult the documentation that follows in the next sections. How to use? In order to use the W2LPL library the header file w2lpl.h must be included into the C++ project. To compile and link the project use the library libw2lpl.so. Place this library to a directory that can be found by the compiler and linker. A simple example is shown below. For more details please consult the samples provided. Example: Consider the following makefile example. Suppose we have the following file structure: /usr/home/dev/adontec/w2lpl/common/ libw2lpl.so... /usr/home/dev/adontec/w2lpl/tests/simple_test_project/ w2lpl.h test.cpp makefile The makefile is as follows: DEFS := OBJS :=./test.o LIBS_PATH := "./../../common/" LIBS_RPATH := '$$ORIGIN/../../common/' EXE_NAME := test LIBS := -L$(LIBS_PATH) -lw2lpl all: $(EXE_NAME) # Link objects $(EXE_NAME): $(OBJS) g++ -Wl,-rpath=$(LIBS_RPATH) -o"$@" $(OBJS) $(LIBS) # Compile C++ source files %.o:./%.cpp g++ $(DEFS) -Wall -c -o"$@" "$<" * The standard WIN32 API of Windows (x86/x64). 3-16

4 To build this project open a console and go to the project folder, e.g.: $ cd /usr/home/dev/adontec/w2lpl/tests /simple_test_project Execute makefile: $ make all What to ship? Include the shared library libw2lpl.so with your application, if your are using it. Nothing to ship if using the static library. 4-16

5 The functions of W2LPL Most of the functions included in this library are already documented in the Windows API manual. The functionality of the functions is kept the same as in Windows. In some functions there may exist some limitations. For more details please read the description of each function. Time Sleep void WINAPI Sleep(DWORD ms); Suspends the current thread for ms milliseconds. GetSysTime TSYSTIME WINAPI GetSysTime(void); The functions GetSysTime and GetElapsedTime offer time measurement with millisecond precision. The return value of this function is the current timestamp. Example: TSYSTIME starttime = GetSysTime(); // do some work... printf( Elapsed time = %d\n, GetElapsedTime(startTime)); GetElapsedTime TSYSTIME WINAPI GetElapsedTime(TSYSTIME Start); The functions GetSysTime and GetElapsedTime offer time measurement with millisecond precision. The return value of this function is the time in milliseconds that elapsed since Start. 5-16

6 Critical Section InitializeCriticalSection void WINAPI InitializeCriticalSection(LPCRITICAL_SECTION lpcriticalsection); Initializes a critical section object. DeleteCriticalSection void WINAPI DeleteCriticalSection(LPCRITICAL_SECTION lpcriticalsection); Releases all resources used by an unowned critical section object. EnterCriticalSection void WINAPI EnterCriticalSection(LPCRITICAL_SECTION lpcriticalsection); Waits for ownership of the specified critical section object. The function returns when the calling thread is granted ownership. LeaveCriticalSection void WINAPI LeaveCriticalSection(LPCRITICAL_SECTION lpcriticalsection); Releases ownership of the specified critical section object. TryEnterCriticalSection BOOL WINAPI TryEnterCriticalSection(LPCRITICAL_SECTION lpcriticalsection); Attempts to enter a critical section without blocking. If the call is successful, the calling thread takes ownership of the critical section. 6-16

7 Inifile WritePrivateProfileString BOOL WINAPI WritePrivateProfileString( LPCTSTR lpappname, LPCTSTR lpkeyname, LPCTSTR lpstring, LPCTSTR lpfilename); Copies a string into the specified section of an initialization file. GetPrivateProfileString DWORD WINAPI GetPrivateProfileString( LPCTSTR lpappname, LPCTSTR lpkeyname, LPCTSTR lpdefault, LPTSTR lpreturnedstring, DWORD nsize, LPCTSTR lpfilename); Retrieves a string from the specified section in an initialization file. GetPrivateProfileInt DWORD WINAPI GetPrivateProfileInt( LPCTSTR lpappname, LPCTSTR lpkeyname, int ndefault, LPCTSTR lpfilename); Retrieves an integer associated with a key in the specified section of an initialization file. 7-16

8 GetPrivateProfileSection DWORD WINAPI GetPrivateProfileSection( LPCTSTR lpappname, LPTSTR lpreturnedstring, DWORD nsize, LPCTSTR lpfilename); Retrieves all the keys and values for the specified section of an initialization file. 8-16

9 Handle CloseHandle BOOL WINAPI CloseHandle(HANDLE hobject); Closes an open object handle. 9-16

10 Event CreateEvent HANDLE WINAPI CreateEvent( PVOID lpeventattributes, BOOL bmanualreset, BOOL binitialstate, LPCTSTR lpname); Creates or opens an event object. Remarks: The parameters lpeventattributes and lpname are ignored. WaitForSingleObject DWORD WINAPI WaitForSingleObject(HANDLE hobject, DWORD dwmilliseconds); Wait on an event object. WaitForMultipleObjects DWORD WINAPI WaitForMultipleObjects( DWORD dwcount, const HANDLE *lphandles, BOOL bwaitall, TSYSTIME dwmilliseconds); Wait on multiple event objects. SetEvent BOOL WINAPI SetEvent(HANDLE hobject); Sets the specified event object to the signaled state

11 PulseEvent BOOL WINAPI PulseEvent(HANDLE hobject); Sets the specified event object to the signaled state and then resets it to the nonsignaled state after releasing the appropriate number of waiting threads. ResetEvent BOOL WINAPI ResetEvent(HANDLE hobject); This function sets the state of the specified event object to nonsignaled

12 Threads _beginthreadex unsigned long WINAPI _beginthreadex( void *security, unsigned stack_size, PSTART_ADDRESSEX pstartaddress, void *arglist, unsigned initflag, unsigned *thrdaddr); Create a thread. Remarks: The parameters security and initflag are ignored. _beginthread unsigned long WINAPI _beginthread( PSTART_ADDRESS pstartaddress, unsigned stack_size, void *arglist); Create a thread. GetCurrentThread HANDLE WINAPI GetCurrentThread(); Retrieves the handle of the calling thread. GetCurrentThreadId DWORD WINAPI GetCurrentThreadId(void); Retrieves the thread identifier of the calling thread

13 GetExitCodeThread BOOL WINAPI GetExitCodeThread(HANDLE hthread, LPDWORD lpexitcode); Retrieves the termination status of the specified thread

14 File operations FindFirstFile HANDLE WINAPI FindFirstFile( LPCTSTR lpfilename, LPWIN32_FIND_DATA lpfindfiledata); Searches a directory for a file or subdirectory with a name that matches a specific name (or partial name if wildcards are used). FindNextFile BOOL WINAPI FindNextFile(HANDLE hfindfile, LPWIN32_FIND_DATA lpfindfiledata); Continues a file search from a previous call to the FindFirstFile. FindClose void WINAPI FindClose(HANDLE hfindfile); Closes a file search handle opened by the FindFirstFile

15 Libraries LoadLibrary HMODULE WINAPI LoadLibrary(LPCTSTR lpfilename); Loads the specified module into the address space of the calling process. The specified module may cause other modules to be loaded. FreeLibrary BOOL WINAPI FreeLibrary(HMODULE hmodule); Frees the loaded dynamic-link library (DLL) module. GetProcAddress FARPROC WINAPI GetProcAddress(HMODULE hmodule, LPCSTR lpprocname); Retrieves the address of an exported function or variable from the specified dynamic-link library (DLL)

16 Samples Based on the owned W2LPL license one or more samples are included to demonstrate the use of the library: play_with_cs, play_with_event, test_findfile