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