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