1 This document should help new developers get started. Like all of Wine, it
8 The Wine source tree is loosely based on the original Windows modules.
9 Most of the source is concerned with implementing the Wine API, although
10 there are also various tools, documentation, sample Winelib code, and
11 code specific to the binary loader. Note that several of the libraries
12 listed here are "stubbed out", meaning they still need to be implemented.
17 activeds/ - Active Directory Service Interface
18 advapi32/ - Crypto, systeminfo, security, eventlogging
19 advpack/ - Reads and verifies .INF files
20 amstream/ - MultiMedia Streams
21 atl/ - Active Template Library
22 avicap32/ - AVI capture window class
23 avifil32/ - COM object to play AVI files
24 cabinet/ - Cabinet file interface
25 capi2032/ - Wrapper library for CAPI4Linux access
26 cards/ - Card graphics
27 cfgmgr32/ - Config manager
28 comcat/ - Component category manager
29 comctl32/ - Common controls
30 commdlg/ - Common dialog boxes (both 16 & 32 bit)
31 crtdll/ - Old C runtime library
32 crypt32/ - Cryptography
33 cryptdll/ - Cryptography Manager
34 ctl3d/ - 3D Effects for Common GUI Components
35 d3d8/ - Direct3D (3D graphics)
36 d3d9/ - Direct3D (3D graphics)
37 d3dim/ - Direct3D Immediate Mode
38 d3drm/ - Direct3D Retained Mode
39 d3dx8/ - Direct3D (3D graphics)
40 d3dxof/ - DirectX Files Functions
41 dbghelp/ - Engine for symbol and module enumeration
42 dciman32/ - DCI Manager (graphics)
43 ddraw/ - DirectDraw (graphics)
44 devenum/ - Device enumeration (part of DirectShow)
45 dinput/ - DirectInput (device input)
46 dinput8/ - DirectInput (device input)
47 dmband/ - DirectMusic Band
48 dmcompos/ - DirectMusic Composer
49 dmime/ - DirectMusic Interactive Engine
50 dmloader/ - DirectMusic Loader
51 dmscript/ - DirectMusic Scripting
52 dmstyle/ - DirectMusic Style Engine
53 dmsynth/ - DirectMusic Software Synthesizer
54 dmusic/ - DirectMusic Core Services
55 dmusic32/ - DirectMusic Legacy Port
56 dplay/ - DirectPlay (networking)
57 dplayx/ - DirectPlay (networking)
58 dpnet/ - DirectPlay (networking)
59 dpnhpast/ - DirectPlay NAT Helper PAST
60 dsound/ - DirectSound (audio)
61 dswave/ - DirectMusic Wave
62 dxdiagn/ - DirectX Diagnostic Tool
64 glu32/ - OpenGL Utility library (graphics)
65 glut32/ - OpenGL Utility Toolkit
66 hhctrl.ocx/ - HHCTRL OCX implementation
67 iccvid/ - Radius Cinepak Video Decoder
68 icmp/ - ICMP protocol (networking)
69 ifsmgr.vxd/ - IFSMGR VxD implementation
70 imagehlp/ - PE (Portable Executable) Image Helper lib
71 imm32/ - Input Method Manager
72 iphlpapi/ - IP Helper API
73 itss/ - Infotech Structured Storage (HTML Help)
74 kernel/ - The Windows kernel
75 lzexpand/ - Lempel-Ziv compression/decompression
76 mapi32/ - Mail interface
77 midimap/ - MIDI mapper
78 mlang/ - Multi Language Support
79 mmdevldr.vxd/ - MMDEVLDR VxD implementation
80 monodebg.vxd/ - MONODEBG VxD implementation
81 mpr/ - Multi-Protocol Router (networking)
82 msacm/ - Audio Compression Manager (multimedia)
83 msacm/imaadp32/ - IMA ADPCM Audio Codec
84 msacm/msadp32/ - MS ADPCM Audio Codec
85 msacm/msg711/ - MS G711 Audio Codec (includes A-Law & MU-Law)
86 msacm/winemp3/ - Mpeg Layer 3 Audio Codec
87 mscms/ - Color Management System
88 msdmo/ - DirectX Media Objects
89 mshtml/ - MS HTML component
90 msi/ - Microsoft Installer
91 msimg32/ - Gradient and transparency (graphics)
92 msisys/ - System information
93 msnet32/ - Network interface
94 msrle32/ - Video codecs
95 msvcrt/ - C runtime library
96 msvcrt20/ - C runtime library version 2.0
97 msvcrt40/ - C runtime library version 4.0
98 msvcrtd/ - C runtime library debugging
99 msvidc32/ - Microsoft Video-1 Decoder
100 msvideo/ - 16 bit video manager
101 mswsock/ - Misc networking
102 netapi32/ - Network interface
103 newdev/ - New Hardware Device Library
104 ntdll/ - NT implementation of kernel calls
105 odbc32/ - Open DataBase Connectivity driver manager
106 odbccp32/ - Open DataBase Connectivity driver installer
107 ole32/ - 32 bit OLE 2.0 libraries
108 oleacc/ - OLE accessibility support
109 oleaut32/ - 32 bit OLE 2.0 automation
110 olecli/ - 16 bit OLE client
111 oledlg/ - OLE 2.0 user interface support
112 olepro32/ - 32 bit OLE 2.0 automation
113 olesvr/ - 16 bit OLE server
114 opengl32/ - OpenGL implementation (graphics)
115 powrprof/ - Power Management and Profiling
116 psapi/ - Process Status interface
117 qcap/ - DirectShow runtime
118 quartz/ - DirectShow runtime
119 rasapi32/ - Remote Access Server interface
120 riched20/ - Rich text editing control version 2.0
121 richedit/ - Rich text editing control
122 rpcrt4/ - Remote Procedure Call runtime
123 rsabase/ - RSA encryption
124 rsaenh/ - Crypto API (DES, 3DES, RSA, etc.)
125 secur32/ - Contains Windows Security functions
126 sensapi/ - System Event Notification Service
127 serialui/ - Serial port property pages
128 setupapi/ - Setup interface
129 shdocvw/ - Shell document object and control
130 shell32/ - COM object implementing shell views
131 shfolder/ - Shell folder service
132 shlwapi/ - Shell Light-Weight interface
133 snmpapi/ - SNMP protocol interface (networking)
134 stdole2.tlb/ - OLE Automation typelib
135 stdole32.tlb/ - Standard OLE typelib
136 sti/ - Still Image service
137 tapi32/ - Telephone interface
138 ttydrv/ - TTY display driver (Wine specific)
139 twain/ - TWAIN Imaging device communications
140 unicows/ - Unicows replacement (Unicode layer for Win9x)
141 url/ - Internet shortcut shell extension
142 urlmon/ - URL Moniker allows binding to a URL
143 user/ - Window management, standard controls, etc.
144 uxtheme/ - Theme library
145 vdhcp.vxd/ - VDHCP VxD implementation
146 vdmdbg/ - Virtual DOS machine debug library
147 version/ - File installation library
148 vmm.vxd/ - VMM VxD implementation
149 vnbt.vxd/ - VNBT VxD implementation
150 vnetbios.vxd/ - VNETBIOS VxD implementation
151 vtdapi.vxd/ - VTDAPI VxD implementation
152 vwin32.vxd/ - VWIN32 VxD implementation
153 win32s/ - 32-bit function access for 16-bit systems
154 winaspi/ - 16 bit Advanced SCSI Peripheral Interface
155 wined3d/ - Wine internal Direct3D helper
156 winedos/ - DOS features and BIOS calls (Wine specific)
157 wineps/ - Postscript driver (Wine specific)
158 wininet/ - Internet extensions
159 winmm/ - Multimedia (16 & 32 bit)
160 winmm/joystick/ - Joystick driver
161 winmm/mcianim/ - MCI animation driver
162 winmm/mciavi/ - MCI video driver
163 winmm/mcicda/ - MCI audio CD driver
164 winmm/mciseq/ - MCI MIDI driver
165 winmm/mciwave/ - MCI wave driver
166 winmm/wavemap/ - Audio mapper
167 winmm/winealsa/ - ALSA audio driver
168 winmm/winearts/ - aRts audio driver
169 winmm/wineaudioio/ - audioio audio driver
170 winmm/winejack/ - JACK audio server driver
171 winmm/winenas/ - NAS audio driver
172 winmm/wineoss/ - OSS audio driver
173 winnls/ - National Language Support
174 winsock/ - Sockets 2.0 (networking)
175 winspool/ - Printing & Print Spooler
176 wintab32/ - Tablet device interface
177 wintrust/ - Trust verification interface
178 wldap32/ - LDAP support
179 wow32/ - WOW subsystem
180 wsock32/ - Sockets 1.1 (networking)
181 wtsapi32/ - Terminal Services
182 x11drv/ - X11 display driver (Wine specific)
184 Winelib programs (under programs/):
185 -----------------------------------
187 avitools/ - AVI information viewer and player
188 clock/ - Graphical clock
189 cmdlgtst/ - Common dialog tests
190 control/ - Control panel
191 expand/ - Decompress Lempel-Ziv compressed archive
192 msiexec/ - Microsoft Installer frontend
193 notepad/ - Notepad replacement
194 progman/ - Program manager
195 regedit/ - Registry editor
196 regsvr32/ - Register COM server
197 rpcss/ - RPC services
198 rundll32/ - Execute DLL functions directly
199 start/ - Replacement for start.exe
200 taskmgr/ - Manage running Windows/Winelib applications
201 uninstaller/ - Remove installed programs
202 view/ - Metafile viewer
203 wcmd/ - Command line interface
204 wineboot/ - Wine bootstrap process
205 winecfg/ - Wine configuration utility
206 wineconsole/ - Console
208 winefile/ - File manager
209 winemenubuilder/ - Helper program for building Unix menu entries
210 winemine/ - Mine game
211 winepath/ - Translate between Wine and Unix paths
212 winetest/ - Wine testing shell
213 winevdm/ - Wine virtual DOS machine
214 winhelp/ - Help viewer
215 winver/ - Windows Version Program
218 Support programs, libraries, etc:
219 ---------------------------------
221 dlls/dxerr8/ - DirectX 8 error import lib
222 dlls/dxerr9/ - DirectX 9 error import lib
223 dlls/dxguid/ - DirectX UUID import lib
224 dlls/strmiids/ - Exports class CLSIDs and interface IIDs
225 dlls/uuid/ - Windows-compatible UUID import lib
226 documentation/ - some documentation
227 documentation/samples/ - sample configuration files
228 include/ - Windows standard includes
229 include/msvcrt/ - MSVC compatible libc headers
230 include/wine/ - Wine specific headers
231 libs/ - the Wine libraries
232 libs/port/ - portability library
233 libs/unicode/ - Unicode support shared
234 libs/wine/ - Wine bootstrap library
235 libs/wpp/ - C preprocessor
236 loader/ - the main Wine loader
237 server/ - the Wine server
238 tools/ - various tools used to build/check Wine
239 tools/widl/ - the IDL compiler
240 tools/winapi{,_check}/ - A Win32 API checker
241 tools/winebuild/ - Wine build tool
242 tools/winedump/ - a .DLL dump utility
243 tools/winegcc/ - a MinGW command line compatible gcc wrapper
244 tools/wmc/ - the message compiler
245 tools/wpp/ - the C pre-processor library
246 tools/wrc/ - the resource compiler
250 IMPLEMENTING NEW API CALLS
251 ==========================
253 This is the simple version, and covers only Win32. Win16 is slightly
254 uglier, because of the Pascal heritage and the segmented memory model.
256 All of the Win32 APIs known to Wine are listed in the .spec file of
257 their corresponding dll. An unimplemented call will look like (from
259 269 stub PolyBezierTo
260 To implement this call, you need to do the following four things.
262 1. Find the appropriate parameters for the call, and add a prototype to
263 the correct header file. In this case, that means [include/wingdi.h],
264 and it might look like
265 BOOL WINAPI PolyBezierTo(HDC, LPCVOID, DWORD);
266 If the function has both an ASCII and a Unicode version, you need to
267 define both and add a #define WINELIB_NAME_AW declaration. See below
268 for discussion of function naming conventions.
270 2. Modify the .spec file to tell Wine that the function has an
271 implementation, what the parameters look like and what Wine function
272 to use for the implementation. In Win32, things are simple--everything
273 is 32-bits. However, the relay code handles pointers and pointers to
274 strings slightly differently, so you should use 'str' and 'wstr' for
275 strings, 'ptr' for other pointer types, and 'long' for everything else.
276 269 stdcall PolyBezierTo(long ptr long) PolyBezierTo
277 The 'PolyBezierTo' at the end of the line is which Wine function to use
278 for the implementation.
280 3. Implement the function as a stub. Once you add the function to the .spec
281 file, you must add the function to the Wine source before it will link.
282 Add a function called 'PolyBezierTo' somewhere. Good things to put
284 o a correct prototype, including the WINAPI
285 o header comments, including full documentation for the function and
286 arguments (see documentation/README.documentation)
287 o A FIXME message and an appropriate return value are good things to
290 /************************************************************
291 * PolyBezierTo (GDI32.269)
293 * Draw many Bezier curves.
296 * hdc [I] Device context to draw to
297 * p [I] Array of POINT structs
298 * count [I] Number of points in p
302 * Failure: FALSE. Use GetLastError() to find the error cause.
307 BOOL WINAPI PolyBezierTo(HDC hdc, LPCVOID p, DWORD count)
309 /* tell the user they've got a substandard implementation */
310 FIXME("(%x,%p,%d): stub\n", hdc, p, count);
312 /* some programs may be able to compensate,
313 * if they know what happened
315 SetLastError(ERROR_CALL_NOT_IMPLEMENTED);
316 return FALSE; /* error value */
319 4. Implement and test the rest of the function.
322 IMPLEMENTING A NEW DLL
323 ======================
328 Apart from writing the set of needed .c files, you also need to do the
331 1. Create a directory <MyDll> where to store the implementation of
332 the DLL. This directory has to be put under the dlls/ directory.
333 If the DLL exists under Windows as both 16 and 32 bit DLL, you
334 should have a single directory with both implementations.
336 2. Create the Makefile.in in the ./dlls/<MyDll>/ directory. You can
337 copy an existing Makefile.in from another ./dlls/ subdirectory.
338 You need at least to change the MODULE and C_SRCS macros.
340 3. Add the directory in ./configure.ac (in AC_OUTPUT macro at the end
341 of the file to trigger the Makefile generation)
343 4. Run ./make_dlls in the dlls directory to update Makefile.in in
346 5. You can now regenerate ./configure file (with 'autoconf')
347 and the various Makefiles (with 'configure; make depend') (run
348 from the top of Wine's tree).
349 You should now have a Makefile file in ./dlls/<MyDll>/
351 6. Create the .spec file for the DLL exported functions in your
352 directory. Refer to 'Implementation of new API calls' earlier in
353 this document for more information on this part.
355 7. You can now start adding .c files. For the .h files, if they are
356 standard Windows one, put them in include/. If they are linked to
357 *your* implementation of the dll, put them in your newly created
363 If you need to create a new debug channel, just add the
364 WINE_DEFAULT_DEBUG_CHANNEL to your .c file(s), and use them.
365 All the housekeeping will happen automatically.
370 If you also need to add resources to your DLL, then create the .rc
371 file. Add to your ./dlls/<MyDll>/Makefile.in, in the RC_SRCS macro,
372 the list of .rc files to add to the DLL. See dlls/comctl32/ for an
378 If you're building a 16 & 32 bit DLLs pair, then from the 32 bit code
379 you might need to call 16 bit routine. The way to do it to add in the
380 code, fragments like:
381 /* ### Start build ### */
382 extern WORD CALLBACK <PREFIX>_CallTo16_word_wwlll(FARPROC16,WORD,WORD,LONG,LONG,LONG);
383 /* ### stop build ### */
384 Where <PREFIX>_ is an internal prefix for your module. The first
385 parameter is always of type FARPROC16. Then, you can get the regular
386 list of parameters. The _word_wwlll indicates the type of return (long
387 or word) and the size of the parameters (here l=>long, w=>word; which
388 maps to WORD,WORD,LONG,LONG,LONG.
389 You can put several functions between the Start/Stop build pair.
391 You can also read the winebuild manpage for more details on this.
393 Then, add to ./dlls/<MyDll>/Makefile.in a line like:
395 EXTRA_OBJS = $(MODULE).glue.o
397 See dlls/winmm/ for an example of this.
402 NE (Win16) executables consist of multiple segments. The Wine loader
403 loads each segment into a unique location in the Wine processes memory
404 and assigns a selector to that segment. Because of this, it's not
405 possible to exchange addresses freely between 16-bit and 32-bit code.
406 Addresses used by 16-bit code are segmented addresses (16:16), formed
407 by a 16-bit selector and a 16-bit offset. Those used by the Wine code
408 are regular 32-bit linear addresses.
410 There are four ways to obtain a segmented pointer:
411 - Using the MapLS function (recommended).
412 - Allocate a block of memory from the global heap and use
413 WIN16_GlobalLock to get its segmented address.
414 - Declare the argument as 'segptr' instead of 'ptr' in the spec file
415 for a given API function.
417 Once you have a segmented pointer, it must be converted to a linear
418 pointer before you can use it from 32-bit code. This can be done with
419 the MapSL function. The linear pointer can then be used freely with
420 standard Unix functions like memcpy() etc. without worrying about 64k
421 boundaries. Note: there's no easy way to convert back from a linear
422 to a segmented address.
424 In most cases, you don't need to worry about segmented address, as the
425 conversion is made automatically by the callback code and the API
426 functions only see linear addresses. However, in some cases it is
427 necessary to manipulate segmented addresses; the most frequent cases
429 - API functions that return a pointer
430 - lParam of Windows messages that point to a structure
431 - Pointers contained inside structures accessed by 16-bit code.
433 It is usually a good practice to used the type 'SEGPTR' for segmented
434 pointers, instead of something like 'LPSTR' or 'char *'. As SEGPTR is
435 defined as a DWORD, you'll get a compilation warning if you mistakenly
436 use it as a regular 32-bit pointer.
442 Under Windows, data structures are tightly packed, i.e. there is no
443 padding between structure members. On the other hand, by default gcc
444 aligns structure members (e.g. WORDs are on a WORD boundary, etc.).
445 This means that a structure like
447 struct { BYTE x; WORD y; };
449 will take 3 bytes under Windows, but 4 with gcc, because gcc will add a
450 dummy byte between x and y. To have the correct layout for structures
451 used by Windows code, you need to embed the struct within two special
452 #include's which will take care of the packing for you:
454 #include "pshpack1.h"
455 struct { BYTE x; WORD y; };
456 #include "poppack1.h"
458 For alignment on a 2-byte boundary, there is a "pshpack2.h", etc.
461 NAMING CONVENTIONS FOR API FUNCTIONS AND TYPES
462 ==============================================
464 In order to support both Win16 and Win32 APIs within the same source
465 code, the following convention must be used in naming all API
466 functions and types. If the Windows API uses the name 'xxx', the Wine
469 - 'xxx16' for the Win16 version,
470 - 'xxx' for the Win32 version when no strings are involved,
471 - 'xxxA' for the Win32 version with ASCII strings,
472 - 'xxxW' for the Win32 version with Unicode strings.
474 If the function has both ASCII and Unicode version, you should then
475 use the macros WINELIB_NAME_AW(xxx) or DECL_WINELIB_TYPE_AW(xxx)
476 (defined in include/windef.h) to define the correct 'xxx' function
477 or type for Winelib. When compiling Wine itself, 'xxx' is _not_
478 defined, meaning that code inside of Wine must always specify
479 explicitly the ASCII or Unicode version.
481 If 'xxx' is the same in Win16 and Win32, you can simply use the same
482 name as Windows, i.e. just 'xxx'. If 'xxx' is Win16 only, you could
483 use the name as is, but it's preferable to use 'xxx16' to make it
484 clear it is a Win16 function.
488 typedef struct { /* Win32 ASCII data structure */ } WNDCLASSA;
489 typedef struct { /* Win32 Unicode data structure */ } WNDCLASSW;
490 typedef struct { /* Win16 data structure */ } WNDCLASS16;
491 DECL_WINELIB_TYPE_AW(WNDCLASS);
493 ATOM RegisterClass16( WNDCLASS16 * );
494 ATOM RegisterClassA( WNDCLASSA * );
495 ATOM RegisterClassW( WNDCLASSW * );
496 #define RegisterClass WINELIB_NAME_AW(RegisterClass)
498 The Winelib user can then say:
500 WNDCLASS wc = { ... };
501 RegisterClass( &wc );
503 and this will use the correct declaration depending on the definition
504 of the UNICODE symbol.
510 To display a message only during debugging, you normally write something
518 depending on the seriousness of the problem. (documentation/debugging.sgml
519 explains when it is appropriate to use each of them). You need to declare
520 the debug channel name at the top of the file (after the includes) using
521 the WINE_DEFAULT_DEBUG_CHANNEL macro, like so:
523 WINE_DEFAULT_DEBUG_CHANNEL(win);
525 If your debugging code is more complex than just printf, you can use
528 TRACE_ON(xxx), WARN_ON(xxx), ERR_ON(xxx) and FIXME_ON(xxx)
530 to test if the given channel is enabled. Thus, you can write:
532 if (TRACE_ON(win)) DumpSomeStructure(&str);
534 Don't worry about the inefficiency of the test. If it is permanently
535 disabled (that is TRACE_ON(win) is 0 at compile time), the compiler will
536 eliminate the dead code.
538 For more info about debugging messages, read:
540 http://www.winehq.org/site/docs/wine-devel/debugging
546 1. There is a FREE online version of the MSDN library (including
547 documentation for the Win32 API) on http://msdn.microsoft.com/
548 or http://www.msdn.com/
550 2. Windows apilist: http://www.mentalis.org/apilist/apilist.php
552 3. http://www.sonic.net/~undoc/bookstore.html
554 4. In 1993 Dr. Dobbs Journal published a column called "Undocumented Corner".
556 5. www.geocities.com/SiliconValley/4942/
projects / wine / blob