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 imagehlp/ - PE (Portable Executable) Image Helper lib
58 imm32/ - Input Method Manager
59 iphlpapi/ - IP Helper API
60 kernel/ - The Windows kernel
61 lzexpand/ - Lempel-Ziv compression/decompression
62 mapi32/ - Mail interface
63 mpr/ - Multi-Protocol Router (networking)
64 msacm/ - Audio Compression Manager (multimedia)
65 msacm/imaadp32/ - IMA ADPCM Audio Codec
66 msacm/msadp32/ - MS ADPCM Audio Codec
67 msacm/msg711/ - MS G711 Audio Codec (includes A-Law & MU-Law)
68 msacm/winemp3/ - Mpeg Layer 3 Audio Codec
69 msdmo/ - DirectX Media Objects
70 mshtml/ - MS HTML component
71 msimg32/ - Gradient and transparency (graphics)
72 msisys/ - System information
73 msi/ - Microsoft Installer
74 msnet32/ - Network interface
75 msvcrt/ - C runtime library
76 msvcrt20/ - C runtime library version 2.0
77 msvcrt40/ - C runtime library version 4.0
78 msvcrtd/ - C runtime library debugging
79 msvidc32/ - Microsoft Video-1 Decoder
80 msvideo/ - 16 bit video manager
81 msvideo/msrle32/ - Video codecs
82 mswsock/ - Misc networking
83 netapi32/ - Network interface
84 newdev/ - New Hardware Device Library
85 ntdll/ - NT implementation of kernel calls
86 odbc32/ - Open DataBase Connectivity driver manager
87 ole32/ - 32 bit OLE 2.0 libraries
88 oleacc/ - OLE accessibility support
89 oleaut32/ - 32 bit OLE 2.0 automation
90 olecli/ - 16 bit OLE client
91 oledlg/ - OLE 2.0 user interface support
92 olepro32/ - 32 bit OLE 2.0 automation
93 olesvr/ - 16 bit OLE server
94 opengl32/ - OpenGL implementation (graphics)
95 psapi/ - Process Status interface
96 qcap/ - DirectShow runtime
97 quartz/ - DirectShow runtime
98 rasapi32/ - Remote Access Server interface
99 richedit/ - Rich text editing control
100 rpcrt4/ - Remote Procedure Call runtime
101 rsabase/ - RSA encryption
102 serialui/ - Serial port property pages
103 setupapi/ - Setup interface
104 shdocvw/ - Shell document object and control
105 shfolder/ - Shell folder service
106 shell32/ - COM object implementing shell views
107 shlwapi/ - Shell Light-Weight interface
108 snmpapi/ - SNMP protocol interface (networking)
109 sti/ - Still Image service
110 tapi32/ - Telephone interface
111 ttydrv/ - TTY display driver (Wine specific)
112 twain/ - TWAIN Imaging device communications
113 unicows/ - Unicows replacement (Unicode layer for Win9x)
114 url/ - Internet shortcut shell extension
115 urlmon/ - URL Moniker allows binding to a URL (like KIO/gnome-vfs)
116 user/ - Window management, standard controls, etc.
117 uxtheme/ - Theme library
118 version/ - File installation library
119 win32s/ - 32-bit function access for 16-bit systems
120 winaspi/ - 16 bit Advanced SCSI Peripheral Interface
121 wined3d/ - Wine internal Direct3D helper
122 winedos/ - DOS features and BIOS calls (interrupts) (wine specific)
123 wineps/ - Postscript driver (Wine specific)
124 wininet/ - Internet extensions
125 winmm/ - Multimedia (16 & 32 bit)
126 winmm/joystick/ - Joystick driver
127 winmm/mcianim/ - MCI animation driver
128 winmm/mciavi/ - MCI video driver
129 winmm/mcicda/ - MCI audio CD driver
130 winmm/mciseq/ - MCI MIDI driver
131 winmm/mciwave/ - MCI wave driver
132 winmm/midimap/ - MIDI mapper
133 winmm/wavemap/ - Audio mapper
134 winmm/winealsa/ - ALSA audio driver
135 winmm/winearts/ - aRts audio driver
136 winmm/wineaudioio/ - audioio audio driver
137 winmm/winejack/ - JACK audio server driver
138 winmm/winenas/ - NAS audio driver
139 winmm/wineoss/ - OSS audio driver
140 winnls/ - National Language Support
141 winsock/ - Sockets 2.0 (networking)
142 wsock32/ - Sockets 1.1 (networking)
143 wintab32/ - Tablet device interface
144 winspool/ - Printing & Print Spooler
145 wintrust/ - Trust verification interface
146 wow32/ - WOW subsystem
147 x11drv/ - X11 display driver (Wine specific)
149 Winelib programs (under programs/):
150 -----------------------------------
152 avitools/ - AVI information viewer and player
153 clock/ - Graphical clock
154 cmdlgtst/ - Common dialog tests
155 control/ - Control panel
156 expand/ - Decompress Lempel-Ziv compressed archive
157 notepad/ - Notepad with RichEdit functionality
158 progman/ - Program manager
159 regedit/ - Registry editor
160 regsvr32/ - Register COM server
161 rpcss/ - RPC services
162 rundll32/ - Execute DLL functions directly
163 start/ - Replacement for start.exe
164 uninstaller/ - Remove installed programs
165 view/ - Metafile viewer
166 wcmd/ - Command line interface
167 wineboot/ - Wine bootstrap process
168 winecfg/ - Wine configuration utility
169 wineconsole/ - Console
171 winefile/ - File manager
172 winemenubuilder/ - Helper program for building Unix menu entries
173 winemine/ - Mine game
174 winepath/ - Translate between Wine and Unix paths
175 winetest/ - Wine testing shell
176 winevdm/ - Wine virtual DOS machine
177 winhelp/ - Help viewer
178 winver/ - Windows Version Program
181 Support programs, libraries, etc:
182 ---------------------------------
184 dlls/dxguid/ - DirectX UUID import lib
185 dlls/uuid/ - Windows-compatible UUID import lib
186 documentation/ - some documentation
187 documentation/samples/ - sample configuration files
188 include/ - Windows standard includes
189 include/msvcrt/ - MSVC compatible libc headers
190 include/wine/ - Wine specific headers
191 libs/ - the Wine libraries
192 libs/port/ - portability library
193 libs/unicode/ - Unicode support shared
194 libs/wine/ - Wine bootstrap library
195 libs/wpp/ - C preprocessor
196 loader/ - the main Wine loader
197 server/ - the Wine server
198 tools/ - various tools used to build/check Wine
199 tools/widl/ - the IDL compiler
200 tools/winapi{,_check}/ - A Win32 API checker
201 tools/winebuild/ - Wine build tool
202 tools/winedump/ - a .DLL dump utility
203 tools/winegcc/ - a MinGW command line compatible gcc wrapper
204 tools/wmc/ - the message compiler
205 tools/wpp/ - the C pre-processor library
206 tools/wrc/ - the resource compiler
212 Note: these directories will ultimately get moved into their
215 files/ - KERNEL file I/O
216 misc/ - KERNEL registry
218 objects/ - GDI logical objects
220 controls/ - USER built-in widgets
221 windows/ - USER window management
225 IMPLEMENTING NEW API CALLS
226 ==========================
228 This is the simple version, and covers only Win32. Win16 is slightly
229 uglier, because of the Pascal heritage and the segmented memory model.
231 All of the Win32 APIs known to Wine are listed in the .spec file of
232 their corresponding dll. An unimplemented call will look like (from
234 269 stub PolyBezierTo
235 To implement this call, you need to do the following four things.
237 1. Find the appropriate parameters for the call, and add a prototype to
238 the correct header file. In this case, that means [include/wingdi.h],
239 and it might look like
240 BOOL WINAPI PolyBezierTo(HDC, LPCVOID, DWORD);
241 If the function has both an ASCII and a Unicode version, you need to
242 define both and add a #define WINELIB_NAME_AW declaration. See below
243 for discussion of function naming conventions.
245 2. Modify the .spec file to tell Wine that the function has an
246 implementation, what the parameters look like and what Wine function
247 to use for the implementation. In Win32, things are simple--everything
248 is 32-bits. However, the relay code handles pointers and pointers to
249 strings slightly differently, so you should use 'str' and 'wstr' for
250 strings, 'ptr' for other pointer types, and 'long' for everything else.
251 269 stdcall PolyBezierTo(long ptr long) PolyBezierTo
252 The 'PolyBezierTo' at the end of the line is which Wine function to use
253 for the implementation.
255 3. Implement the function as a stub. Once you add the function to the .spec
256 file, you must add the function to the Wine source before it will link.
257 Add a function called 'PolyBezierTo' somewhere. Good things to put
259 o a correct prototype, including the WINAPI
260 o header comments, including full documentation for the function and
261 arguments (see documentation/README.documentation)
262 o A FIXME message and an appropriate return value are good things to
265 /************************************************************
266 * PolyBezierTo (GDI32.269)
268 * Draw many Bezier curves.
271 * hdc [I] Device context to draw to
272 * p [I] Array of POINT structs
273 * count [I] Number of points in p
277 * Failure: FALSE. Use GetLastError() to find the error cause.
282 BOOL WINAPI PolyBezierTo(HDC hdc, LPCVOID p, DWORD count)
284 /* tell the user they've got a substandard implementation */
285 FIXME(gdi, ":(%x,%p,%d): stub\n", hdc, p, count);
287 /* some programs may be able to compensate,
288 * if they know what happened
290 SetLastError(ERROR_CALL_NOT_IMPLEMENTED);
291 return FALSE; /* error value */
294 4. Implement and test the rest of the function.
297 IMPLEMENTING A NEW DLL
298 ======================
303 Apart from writing the set of needed .c files, you also need to do the
306 1. Create a directory <MyDll> where to store the implementation of
307 the DLL. This directory has to be put under the dlls/ directory.
308 If the DLL exists under Windows as both 16 and 32 bit DLL, you
309 should have a single directory with both implementations.
311 2. Create the Makefile.in in the ./dlls/<MyDll>/ directory. You can
312 copy an existing Makefile.in from another ./dlls/ subdirectory.
313 You need at least to change the MODULE and C_SRCS macros.
315 3. Add the directory in ./configure.ac (in AC_OUTPUT macro at the end
316 of the file to trigger the Makefile generation)
318 4. Run ./make_dlls in the dlls directory to update Makefile.in in
321 5. You can now regenerate ./configure file (with 'make configure')
322 and the various Makefiles (with 'configure; make depend') (run
323 from the top of Wine's tree).
324 You should now have a Makefile file in ./dlls/<MyDll>/
326 6. Create the .spec file for the DLL exported functions in your
327 directory. Refer to 'Implementation of new API calls' earlier in
328 this document for more information on this part.
330 7. You can now start adding .c files. For the .h files, if they are
331 standard Windows one, put them in include/. If they are linked to
332 *your* implementation of the dll, put them in your newly created
338 If you need to create a new debug channel, just add the
339 WINE_DEFAULT_DEBUG_CHANNEL to your .c file(s), and use them.
340 All the housekeeping will happen automatically.
345 If you also need to add resources to your DLL, then create the .rc
346 file. Add to your ./dlls/<MyDll>/Makefile.in, in the RC_SRCS macro,
347 the list of .rc files to add to the DLL. See dlls/comctl32/ for an
353 If you're building a 16 & 32 bit DLLs pair, then from the 32 bit code
354 you might need to call 16 bit routine. The way to do it to add in the
355 code, fragments like:
356 /* ### Start build ### */
357 extern WORD CALLBACK <PREFIX>_CallTo16_word_wwlll(FARPROC16,WORD,WORD,LONG,LONG,LONG);
358 /* ### stop build ### */
359 Where <PREFIX>_ is an internal prefix for your module. The first
360 parameter is always of type FARPROC16. Then, you can get the regular
361 list of parameters. The _word_wwlll indicates the type of return (long
362 or word) and the size of the parameters (here l=>long, w=>word; which
363 maps to WORD,WORD,LONG,LONG,LONG.
364 You can put several functions between the Start/Stop build pair.
366 You can also read the winebuild manpage for more details on this.
368 Then, add to ./dlls/<MyDll>/Makefile.in a line like:
370 EXTRA_OBJS = $(MODULE).glue.o
372 See dlls/winmm/ for an example of this.
377 NE (Win16) executables consist of multiple segments. The Wine loader
378 loads each segment into a unique location in the Wine processes memory
379 and assigns a selector to that segment. Because of this, it's not
380 possible to exchange addresses freely between 16-bit and 32-bit code.
381 Addresses used by 16-bit code are segmented addresses (16:16), formed
382 by a 16-bit selector and a 16-bit offset. Those used by the Wine code
383 are regular 32-bit linear addresses.
385 There are four ways to obtain a segmented pointer:
386 - Using the MapLS function (recommended).
387 - Allocate a block of memory from the global heap and use
388 WIN16_GlobalLock to get its segmented address.
389 - Declare the argument as 'segptr' instead of 'ptr' in the spec file
390 for a given API function.
392 Once you have a segmented pointer, it must be converted to a linear
393 pointer before you can use it from 32-bit code. This can be done with
394 the MapSL function. The linear pointer can then be used freely with
395 standard Unix functions like memcpy() etc. without worrying about 64k
396 boundaries. Note: there's no easy way to convert back from a linear
397 to a segmented address.
399 In most cases, you don't need to worry about segmented address, as the
400 conversion is made automatically by the callback code and the API
401 functions only see linear addresses. However, in some cases it is
402 necessary to manipulate segmented addresses; the most frequent cases
404 - API functions that return a pointer
405 - lParam of Windows messages that point to a structure
406 - Pointers contained inside structures accessed by 16-bit code.
408 It is usually a good practice to used the type 'SEGPTR' for segmented
409 pointers, instead of something like 'LPSTR' or 'char *'. As SEGPTR is
410 defined as a DWORD, you'll get a compilation warning if you mistakenly
411 use it as a regular 32-bit pointer.
417 Under Windows, data structures are tightly packed, i.e. there is no
418 padding between structure members. On the other hand, by default gcc
419 aligns structure members (e.g. WORDs are on a WORD boundary, etc.).
420 This means that a structure like
422 struct { BYTE x; WORD y; };
424 will take 3 bytes under Windows, but 4 with gcc, because gcc will add a
425 dummy byte between x and y. To have the correct layout for structures
426 used by Windows code, you need to embed the struct within two special
427 #include's which will take care of the packing for you:
429 #include "pshpack1.h"
430 struct { BYTE x; WORD y; };
431 #include "poppack1.h"
433 For alignment on a 2-byte boundary, there is a "pshpack2.h", etc.
436 NAMING CONVENTIONS FOR API FUNCTIONS AND TYPES
437 ==============================================
439 In order to support both Win16 and Win32 APIs within the same source
440 code, the following convention must be used in naming all API
441 functions and types. If the Windows API uses the name 'xxx', the Wine
444 - 'xxx16' for the Win16 version,
445 - 'xxx' for the Win32 version when no strings are involved,
446 - 'xxxA' for the Win32 version with ASCII strings,
447 - 'xxxW' for the Win32 version with Unicode strings.
449 If the function has both ASCII and Unicode version, you should then
450 use the macros WINELIB_NAME_AW(xxx) or DECL_WINELIB_TYPE_AW(xxx)
451 (defined in include/windef.h) to define the correct 'xxx' function
452 or type for Winelib. When compiling Wine itself, 'xxx' is _not_
453 defined, meaning that code inside of Wine must always specify
454 explicitly the ASCII or Unicode version.
456 If 'xxx' is the same in Win16 and Win32, you can simply use the same
457 name as Windows, i.e. just 'xxx'. If 'xxx' is Win16 only, you could
458 use the name as is, but it's preferable to use 'xxx16' to make it
459 clear it is a Win16 function.
463 typedef struct { /* Win32 ASCII data structure */ } WNDCLASSA;
464 typedef struct { /* Win32 Unicode data structure */ } WNDCLASSW;
465 typedef struct { /* Win16 data structure */ } WNDCLASS16;
466 DECL_WINELIB_TYPE_AW(WNDCLASS);
468 ATOM RegisterClass16( WNDCLASS16 * );
469 ATOM RegisterClassA( WNDCLASSA * );
470 ATOM RegisterClassW( WNDCLASSW * );
471 #define RegisterClass WINELIB_NAME_AW(RegisterClass)
473 The Winelib user can then say:
475 WNDCLASS wc = { ... };
476 RegisterClass( &wc );
478 and this will use the correct declaration depending on the definition
479 of the UNICODE symbol.
485 To display a message only during debugging, you normally write something
493 depending on the seriousness of the problem. (documentation/debugging.sgml
494 explains when it is appropriate to use each of them). You need to declare
495 the debug channel name at the top of the file (after the includes) using
496 the WINE_DEFAULT_DEBUG_CHANNEL macro, like so:
498 WINE_DEFAULT_DEBUG_CHANNEL(win);
500 If your debugging code is more complex than just printf, you can use
503 TRACE_ON(xxx), WARN_ON(xxx), ERR_ON(xxx) and FIXME_ON(xxx)
505 to test if the given channel is enabled. Thus, you can write:
507 if (TRACE_ON(win)) DumpSomeStructure(&str);
509 Don't worry about the inefficiency of the test. If it is permanently
510 disabled (that is TRACE_ON(win) is 0 at compile time), the compiler will
511 eliminate the dead code.
513 For more info about debugging messages, read:
515 http://www.winehq.org/site/docs/wine-devel/debugging
521 1. There is a FREE online version of the MSDN library (including
522 documentation for the Win32 API) on http://msdn.microsoft.com/
523 or http://www.msdn.com/
525 2. Windows apilist: http://www.mentalis.org/apilist/apilist.php
527 3. http://www.sonic.net/~undoc/bookstore.html
529 4. In 1993 Dr. Dobbs Journal published a column called "Undocumented Corner".
531 5. www.geocities.com/SiliconValley/4942/