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