| blob | 2c2b22651df4712182c23e09ba3bbc689da4424f |
1 This document should help new developers get started. Like all of Wine, it
2 is a work in progress.
5 SOURCE TREE STRUCTURE
6 =====================
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.
14 DLLs (under dlls/):
15 -------------------
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
52 gdi/ - GDI (graphics)
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 vmm.vxd/ - VMM VxD implementation
124 vnb.vxd/ - VNB VxD implementation
125 vnetbios.vxd/ - VNETBIOS VxD implementation
126 vtdapi.vxd/ - VTDAPI VxD implementation
127 vwin32.vxd/ - VWIN32 VxD implementation
128 win32s/ - 32-bit function access for 16-bit systems
129 winaspi/ - 16 bit Advanced SCSI Peripheral Interface
130 wined3d/ - Wine internal Direct3D helper
131 winedos/ - DOS features and BIOS calls (interrupts) (wine specific)
132 wineps/ - Postscript driver (Wine specific)
133 wininet/ - Internet extensions
134 winmm/ - Multimedia (16 & 32 bit)
135 winmm/joystick/ - Joystick driver
136 winmm/mcianim/ - MCI animation driver
137 winmm/mciavi/ - MCI video driver
138 winmm/mcicda/ - MCI audio CD driver
139 winmm/mciseq/ - MCI MIDI driver
140 winmm/mciwave/ - MCI wave driver
141 winmm/midimap/ - MIDI mapper
142 winmm/wavemap/ - Audio mapper
143 winmm/winealsa/ - ALSA audio driver
144 winmm/winearts/ - aRts audio driver
145 winmm/wineaudioio/ - audioio audio driver
146 winmm/winejack/ - JACK audio server driver
147 winmm/winenas/ - NAS audio driver
148 winmm/wineoss/ - OSS audio driver
149 winnls/ - National Language Support
150 winsock/ - Sockets 2.0 (networking)
151 wsock32/ - Sockets 1.1 (networking)
152 wintab32/ - Tablet device interface
153 winspool/ - Printing & Print Spooler
154 wintrust/ - Trust verification interface
155 wow32/ - WOW subsystem
156 x11drv/ - X11 display driver (Wine specific)
158 Winelib programs (under programs/):
159 -----------------------------------
161 avitools/ - AVI information viewer and player
162 clock/ - Graphical clock
163 cmdlgtst/ - Common dialog tests
164 control/ - Control panel
165 expand/ - Decompress Lempel-Ziv compressed archive
166 notepad/ - Notepad replacement
167 progman/ - Program manager
168 regedit/ - Registry editor
169 regsvr32/ - Register COM server
170 rpcss/ - RPC services
171 rundll32/ - Execute DLL functions directly
172 start/ - Replacement for start.exe
173 taskmgr/ - Manage running Windows/Winelib applications
174 uninstaller/ - Remove installed programs
175 view/ - Metafile viewer
176 wcmd/ - Command line interface
177 wineboot/ - Wine bootstrap process
178 winecfg/ - Wine configuration utility
179 wineconsole/ - Console
180 winedbg/ - Debugger
181 winefile/ - File manager
182 winemenubuilder/ - Helper program for building Unix menu entries
183 winemine/ - Mine game
184 winepath/ - Translate between Wine and Unix paths
185 winetest/ - Wine testing shell
186 winevdm/ - Wine virtual DOS machine
187 winhelp/ - Help viewer
188 winver/ - Windows Version Program
191 Support programs, libraries, etc:
192 ---------------------------------
194 dlls/dxerr8/ - DirectX 8 error import lib
195 dlls/dxerr9/ - DirectX 9 error import lib
196 dlls/dxguid/ - DirectX UUID import lib
197 dlls/uuid/ - Windows-compatible UUID import lib
198 documentation/ - some documentation
199 documentation/samples/ - sample configuration files
200 include/ - Windows standard includes
201 include/msvcrt/ - MSVC compatible libc headers
202 include/wine/ - Wine specific headers
203 libs/ - the Wine libraries
204 libs/port/ - portability library
205 libs/unicode/ - Unicode support shared
206 libs/wine/ - Wine bootstrap library
207 libs/wpp/ - C preprocessor
208 loader/ - the main Wine loader
209 server/ - the Wine server
210 tools/ - various tools used to build/check Wine
211 tools/widl/ - the IDL compiler
212 tools/winapi{,_check}/ - A Win32 API checker
213 tools/winebuild/ - Wine build tool
214 tools/winedump/ - a .DLL dump utility
215 tools/winegcc/ - a MinGW command line compatible gcc wrapper
216 tools/wmc/ - the message compiler
217 tools/wpp/ - the C pre-processor library
218 tools/wrc/ - the resource compiler
221 Miscellaneous:
222 --------------
224 Note: these directories will ultimately get moved into their
225 respective dlls.
227 files/ - KERNEL file I/O
228 misc/ - KERNEL registry
230 objects/ - GDI logical objects
232 controls/ - USER built-in widgets
233 windows/ - USER window management
237 IMPLEMENTING NEW API CALLS
238 ==========================
240 This is the simple version, and covers only Win32. Win16 is slightly
241 uglier, because of the Pascal heritage and the segmented memory model.
243 All of the Win32 APIs known to Wine are listed in the .spec file of
244 their corresponding dll. An unimplemented call will look like (from
245 gdi32.spec)
246 269 stub PolyBezierTo
247 To implement this call, you need to do the following four things.
249 1. Find the appropriate parameters for the call, and add a prototype to
250 the correct header file. In this case, that means [include/wingdi.h],
251 and it might look like
252 BOOL WINAPI PolyBezierTo(HDC, LPCVOID, DWORD);
253 If the function has both an ASCII and a Unicode version, you need to
254 define both and add a #define WINELIB_NAME_AW declaration. See below
255 for discussion of function naming conventions.
257 2. Modify the .spec file to tell Wine that the function has an
258 implementation, what the parameters look like and what Wine function
259 to use for the implementation. In Win32, things are simple--everything
260 is 32-bits. However, the relay code handles pointers and pointers to
261 strings slightly differently, so you should use 'str' and 'wstr' for
262 strings, 'ptr' for other pointer types, and 'long' for everything else.
263 269 stdcall PolyBezierTo(long ptr long) PolyBezierTo
264 The 'PolyBezierTo' at the end of the line is which Wine function to use
265 for the implementation.
267 3. Implement the function as a stub. Once you add the function to the .spec
268 file, you must add the function to the Wine source before it will link.
269 Add a function called 'PolyBezierTo' somewhere. Good things to put
270 into a stub:
271 o a correct prototype, including the WINAPI
272 o header comments, including full documentation for the function and
273 arguments (see documentation/README.documentation)
274 o A FIXME message and an appropriate return value are good things to
275 put in a stub.
277 /************************************************************
278 * PolyBezierTo (GDI32.269)
279 *
280 * Draw many Bezier curves.
281 *
282 * PARAMS
283 * hdc [I] Device context to draw to
284 * p [I] Array of POINT structs
285 * count [I] Number of points in p
286 *
287 * RETURNS
288 * Success: Non-zero.
289 * Failure: FALSE. Use GetLastError() to find the error cause.
290 *
291 * BUGS
292 * Unimplemented
293 */
294 BOOL WINAPI PolyBezierTo(HDC hdc, LPCVOID p, DWORD count)
295 {
296 /* tell the user they've got a substandard implementation */
297 FIXME(gdi, ":(%x,%p,%d): stub\n", hdc, p, count);
299 /* some programs may be able to compensate,
300 * if they know what happened
301 */
302 SetLastError(ERROR_CALL_NOT_IMPLEMENTED);
303 return FALSE; /* error value */
304 }
306 4. Implement and test the rest of the function.
309 IMPLEMENTING A NEW DLL
310 ======================
312 Generic directions
313 ------------------
315 Apart from writing the set of needed .c files, you also need to do the
316 following:
318 1. Create a directory <MyDll> where to store the implementation of
319 the DLL. This directory has to be put under the dlls/ directory.
320 If the DLL exists under Windows as both 16 and 32 bit DLL, you
321 should have a single directory with both implementations.
323 2. Create the Makefile.in in the ./dlls/<MyDll>/ directory. You can
324 copy an existing Makefile.in from another ./dlls/ subdirectory.
325 You need at least to change the MODULE and C_SRCS macros.
327 3. Add the directory in ./configure.ac (in AC_OUTPUT macro at the end
328 of the file to trigger the Makefile generation)
330 4. Run ./make_dlls in the dlls directory to update Makefile.in in
331 that directory.
333 5. You can now regenerate ./configure file (with 'make configure')
334 and the various Makefiles (with 'configure; make depend') (run
335 from the top of Wine's tree).
336 You should now have a Makefile file in ./dlls/<MyDll>/
338 6. Create the .spec file for the DLL exported functions in your
339 directory. Refer to 'Implementation of new API calls' earlier in
340 this document for more information on this part.
342 7. You can now start adding .c files. For the .h files, if they are
343 standard Windows one, put them in include/. If they are linked to
344 *your* implementation of the dll, put them in your newly created
345 directory.
347 Debug channels
348 --------------
350 If you need to create a new debug channel, just add the
351 WINE_DEFAULT_DEBUG_CHANNEL to your .c file(s), and use them.
352 All the housekeeping will happen automatically.
354 Resources
355 ---------
357 If you also need to add resources to your DLL, then create the .rc
358 file. Add to your ./dlls/<MyDll>/Makefile.in, in the RC_SRCS macro,
359 the list of .rc files to add to the DLL. See dlls/comctl32/ for an
360 example of this.
362 Thunking
363 --------
365 If you're building a 16 & 32 bit DLLs pair, then from the 32 bit code
366 you might need to call 16 bit routine. The way to do it to add in the
367 code, fragments like:
368 /* ### Start build ### */
369 extern WORD CALLBACK <PREFIX>_CallTo16_word_wwlll(FARPROC16,WORD,WORD,LONG,LONG,LONG);
370 /* ### stop build ### */
371 Where <PREFIX>_ is an internal prefix for your module. The first
372 parameter is always of type FARPROC16. Then, you can get the regular
373 list of parameters. The _word_wwlll indicates the type of return (long
374 or word) and the size of the parameters (here l=>long, w=>word; which
375 maps to WORD,WORD,LONG,LONG,LONG.
376 You can put several functions between the Start/Stop build pair.
378 You can also read the winebuild manpage for more details on this.
380 Then, add to ./dlls/<MyDll>/Makefile.in a line like:
382 EXTRA_OBJS = $(MODULE).glue.o
384 See dlls/winmm/ for an example of this.
386 MEMORY AND SEGMENTS
387 ===================
389 NE (Win16) executables consist of multiple segments. The Wine loader
390 loads each segment into a unique location in the Wine processes memory
391 and assigns a selector to that segment. Because of this, it's not
392 possible to exchange addresses freely between 16-bit and 32-bit code.
393 Addresses used by 16-bit code are segmented addresses (16:16), formed
394 by a 16-bit selector and a 16-bit offset. Those used by the Wine code
395 are regular 32-bit linear addresses.
397 There are four ways to obtain a segmented pointer:
398 - Using the MapLS function (recommended).
399 - Allocate a block of memory from the global heap and use
400 WIN16_GlobalLock to get its segmented address.
401 - Declare the argument as 'segptr' instead of 'ptr' in the spec file
402 for a given API function.
404 Once you have a segmented pointer, it must be converted to a linear
405 pointer before you can use it from 32-bit code. This can be done with
406 the MapSL function. The linear pointer can then be used freely with
407 standard Unix functions like memcpy() etc. without worrying about 64k
408 boundaries. Note: there's no easy way to convert back from a linear
409 to a segmented address.
411 In most cases, you don't need to worry about segmented address, as the
412 conversion is made automatically by the callback code and the API
413 functions only see linear addresses. However, in some cases it is
414 necessary to manipulate segmented addresses; the most frequent cases
415 are:
416 - API functions that return a pointer
417 - lParam of Windows messages that point to a structure
418 - Pointers contained inside structures accessed by 16-bit code.
420 It is usually a good practice to used the type 'SEGPTR' for segmented
421 pointers, instead of something like 'LPSTR' or 'char *'. As SEGPTR is
422 defined as a DWORD, you'll get a compilation warning if you mistakenly
423 use it as a regular 32-bit pointer.
426 STRUCTURE PACKING
427 =================
429 Under Windows, data structures are tightly packed, i.e. there is no
430 padding between structure members. On the other hand, by default gcc
431 aligns structure members (e.g. WORDs are on a WORD boundary, etc.).
432 This means that a structure like
434 struct { BYTE x; WORD y; };
436 will take 3 bytes under Windows, but 4 with gcc, because gcc will add a
437 dummy byte between x and y. To have the correct layout for structures
438 used by Windows code, you need to embed the struct within two special
439 #include's which will take care of the packing for you:
441 #include "pshpack1.h"
442 struct { BYTE x; WORD y; };
443 #include "poppack1.h"
445 For alignment on a 2-byte boundary, there is a "pshpack2.h", etc.
448 NAMING CONVENTIONS FOR API FUNCTIONS AND TYPES
449 ==============================================
451 In order to support both Win16 and Win32 APIs within the same source
452 code, the following convention must be used in naming all API
453 functions and types. If the Windows API uses the name 'xxx', the Wine
454 code must use:
456 - 'xxx16' for the Win16 version,
457 - 'xxx' for the Win32 version when no strings are involved,
458 - 'xxxA' for the Win32 version with ASCII strings,
459 - 'xxxW' for the Win32 version with Unicode strings.
461 If the function has both ASCII and Unicode version, you should then
462 use the macros WINELIB_NAME_AW(xxx) or DECL_WINELIB_TYPE_AW(xxx)
463 (defined in include/windef.h) to define the correct 'xxx' function
464 or type for Winelib. When compiling Wine itself, 'xxx' is _not_
465 defined, meaning that code inside of Wine must always specify
466 explicitly the ASCII or Unicode version.
468 If 'xxx' is the same in Win16 and Win32, you can simply use the same
469 name as Windows, i.e. just 'xxx'. If 'xxx' is Win16 only, you could
470 use the name as is, but it's preferable to use 'xxx16' to make it
471 clear it is a Win16 function.
473 Examples:
475 typedef struct { /* Win32 ASCII data structure */ } WNDCLASSA;
476 typedef struct { /* Win32 Unicode data structure */ } WNDCLASSW;
477 typedef struct { /* Win16 data structure */ } WNDCLASS16;
478 DECL_WINELIB_TYPE_AW(WNDCLASS);
480 ATOM RegisterClass16( WNDCLASS16 * );
481 ATOM RegisterClassA( WNDCLASSA * );
482 ATOM RegisterClassW( WNDCLASSW * );
483 #define RegisterClass WINELIB_NAME_AW(RegisterClass)
485 The Winelib user can then say:
487 WNDCLASS wc = { ... };
488 RegisterClass( &wc );
490 and this will use the correct declaration depending on the definition
491 of the UNICODE symbol.
494 DEBUG MESSAGES
495 ==============
497 To display a message only during debugging, you normally write something
498 like this:
500 TRACE("abc..."); or
501 FIXME("abc..."); or
502 WARN("abc..."); or
503 ERR("abc...");
505 depending on the seriousness of the problem. (documentation/debugging.sgml
506 explains when it is appropriate to use each of them). You need to declare
507 the debug channel name at the top of the file (after the includes) using
508 the WINE_DEFAULT_DEBUG_CHANNEL macro, like so:
510 WINE_DEFAULT_DEBUG_CHANNEL(win);
512 If your debugging code is more complex than just printf, you can use
513 the macros:
515 TRACE_ON(xxx), WARN_ON(xxx), ERR_ON(xxx) and FIXME_ON(xxx)
517 to test if the given channel is enabled. Thus, you can write:
519 if (TRACE_ON(win)) DumpSomeStructure(&str);
521 Don't worry about the inefficiency of the test. If it is permanently
522 disabled (that is TRACE_ON(win) is 0 at compile time), the compiler will
523 eliminate the dead code.
525 For more info about debugging messages, read:
527 http://www.winehq.org/site/docs/wine-devel/debugging
530 MORE INFO
531 =========
533 1. There is a FREE online version of the MSDN library (including
534 documentation for the Win32 API) on http://msdn.microsoft.com/
535 or http://www.msdn.com/
537 2. Windows apilist: http://www.mentalis.org/apilist/apilist.php
539 3. http://www.sonic.net/~undoc/bookstore.html
541 4. In 1993 Dr. Dobbs Journal published a column called "Undocumented Corner".
543 5. www.geocities.com/SiliconValley/4942/