| blob | 40f6ce1d50ae082131c258f8baa2c407316bc134 |
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 activeds/ - Active Directory Service Interface
18 advapi32/ - Crypto, systeminfo, security, eventlogging
19 advpack/ - Reads and verifies .INF files
20 amstream/ - MultiMedia Streams
21 atl/ - Active Template Library
22 avicap32/ - AVI capture window class
23 avifil32/ - COM object to play AVI files
24 cabinet/ - Cabinet file interface
25 capi2032/ - Wrapper library for CAPI4Linux access
26 cards/ - Card graphics
27 cfgmgr32/ - Config manager
28 comcat/ - Component category manager
29 comctl32/ - Common controls
30 commdlg/ - Common dialog boxes (both 16 & 32 bit)
31 crtdll/ - Old C runtime library
32 crypt32/ - Cryptography
33 cryptdll/ - Cryptography Manager
34 ctl3d32/ - 3D Effects for Common GUI Components
35 d3d8/ - Direct3D (3D graphics)
36 d3d9/ - Direct3D (3D graphics)
37 d3dim/ - Direct3D Immediate Mode
38 d3drm/ - Direct3D Retained Mode
39 d3dx8/ - Direct3D (3D graphics)
40 d3dxof/ - DirectX Files Functions
41 dbghelp/ - Engine for symbol and module enumeration
42 dciman32/ - DCI Manager (graphics)
43 ddraw/ - DirectDraw (graphics)
44 devenum/ - Device enumeration (part of DirectShow)
45 dinput/ - DirectInput (device input)
46 dinput8/ - DirectInput (device input)
47 dmband/ - DirectMusic Band
48 dmcompos/ - DirectMusic Composer
49 dmime/ - DirectMusic Interactive Engine
50 dmloader/ - DirectMusic Loader
51 dmscript/ - DirectMusic Scripting
52 dmstyle/ - DirectMusic Style Engine
53 dmsynth/ - DirectMusic Software Synthesizer
54 dmusic/ - DirectMusic Core Services
55 dmusic32/ - DirectMusic Legacy Port
56 dplay/ - DirectPlay (networking)
57 dplayx/ - DirectPlay (networking)
58 dpnet/ - DirectPlay (networking)
59 dpnhpast/ - DirectPlay NAT Helper PAST
60 dsound/ - DirectSound (audio)
61 dswave/ - DirectMusic Wave
62 dxdiagn/ - DirectX Diagnostic Tool
63 gdi/ - GDI (graphics)
64 glu32/ - OpenGL Utility library (graphics)
65 glut32/ - OpenGL Utility Toolkit
66 hhctrl.ocx/ - HHCTRL OCX implementation
67 iccvid/ - Radius Cinepak Video Decoder
68 icmp/ - ICMP protocol (networking)
69 ifsmgr.vxd/ - IFSMGR VxD implementation
70 imaadp32.acm/ - IMA ADPCM Audio Codec
71 imagehlp/ - PE (Portable Executable) Image Helper lib
72 imm32/ - Input Method Manager
73 iphlpapi/ - IP Helper API
74 itss/ - Infotech Structured Storage (HTML Help)
75 kernel/ - The Windows kernel
76 lz32/ - Lempel-Ziv compression/decompression
77 mapi32/ - Mail interface
78 mciavi32/ - MCI video driver
79 mcicda/ - MCI audio CD driver
80 mciseq/ - MCI MIDI driver
81 midimap/ - MIDI mapper
82 mlang/ - Multi Language Support
83 mmdevldr.vxd/ - MMDEVLDR VxD implementation
84 monodebg.vxd/ - MONODEBG VxD implementation
85 mpr/ - Multi-Protocol Router (networking)
86 msacm/ - Audio Compression Manager (multimedia)
87 msadp32.acm/ - MS ADPCM Audio Codec
88 mscms/ - Color Management System
89 msdmo/ - DirectX Media Objects
90 msftedit/ - Rich text editing control (Version 4.1)
91 msg711.acm/ - MS G711 Audio Codec (includes A-Law & MU-Law)
92 mshtml/ - MS HTML component
93 msi/ - Microsoft Installer
94 msimg32/ - Gradient and transparency (graphics)
95 msisys/ - System information
96 msnet32/ - Network interface
97 msrle32/ - Video codecs
98 msvcrt/ - C runtime library
99 msvcrt20/ - C runtime library version 2.0
100 msvcrt40/ - C runtime library version 4.0
101 msvcrtd/ - C runtime library debugging
102 msvfw32/ - 16 bit video manager
103 msvidc32/ - Microsoft Video-1 Decoder
104 mswsock/ - Misc networking
105 msxml3/ - MSXML Class Factory
106 netapi32/ - Network interface
107 newdev/ - New Hardware Device Library
108 ntdll/ - NT implementation of kernel calls
109 objsel/ - Object Picker Dialog
110 odbc32/ - Open DataBase Connectivity driver manager
111 odbccp32/ - Open DataBase Connectivity driver installer
112 ole32/ - 32 bit OLE 2.0 libraries
113 oleacc/ - OLE accessibility support
114 oleaut32/ - 32 bit OLE 2.0 automation
115 olecli32/ - 16 bit OLE client
116 oledlg/ - OLE 2.0 user interface support
117 olepro32/ - 32 bit OLE 2.0 automation
118 olesvr32/ - 16 bit OLE server
119 opengl32/ - OpenGL implementation (graphics)
120 powrprof/ - Power Management and Profiling
121 psapi/ - Process Status interface
122 qcap/ - DirectShow runtime
123 quartz/ - DirectShow runtime
124 rasapi32/ - Remote Access Server interface
125 riched20/ - Rich text editing control (Version 2.0 and 3.0)
126 richedit/ - Rich text editing control
127 rpcrt4/ - Remote Procedure Call runtime
128 rsabase/ - RSA encryption
129 rsaenh/ - Crypto API (DES, 3DES, RSA, etc.)
130 secur32/ - Contains Windows Security functions
131 security/ - Security Support Provider Interface
132 sensapi/ - System Event Notification Service
133 serialui/ - Serial port property pages
134 setupapi/ - Setup interface
135 sfc/ - System File Checker (Windows File Protection)
136 shdocvw/ - Shell document object and control
137 shell32/ - COM object implementing shell views
138 shfolder/ - Shell folder service
139 shlwapi/ - Shell Light-Weight interface
140 snmpapi/ - SNMP protocol interface (networking)
141 stdole2.tlb/ - OLE Automation typelib
142 stdole32.tlb/ - Standard OLE typelib
143 sti/ - Still Image service
144 tapi32/ - Telephone interface
145 twain/ - TWAIN Imaging device communications
146 unicows/ - Unicows replacement (Unicode layer for Win9x)
147 url/ - Internet shortcut shell extension
148 urlmon/ - URL Moniker allows binding to a URL
149 user/ - Window management, standard controls, etc.
150 usp10/ - Uniscribe Script Processor
151 uxtheme/ - Theme library
152 vdhcp.vxd/ - VDHCP VxD implementation
153 vdmdbg/ - Virtual DOS machine debug library
154 version/ - File installation library
155 vmm.vxd/ - VMM VxD implementation
156 vnbt.vxd/ - VNBT VxD implementation
157 vnetbios.vxd/ - VNETBIOS VxD implementation
158 vtdapi.vxd/ - VTDAPI VxD implementation
159 vwin32.vxd/ - VWIN32 VxD implementation
160 win32skrnl/ - 32-bit function access for 16-bit systems
161 wined3d/ - Wine internal Direct3D helper
162 winedos/ - DOS features and BIOS calls (Wine specific)
163 winemp3.acm/ - Mpeg Layer 3 Audio Codec
164 wineps/ - Postscript driver (Wine specific)
165 wininet/ - Internet extensions
166 winmm/ - Multimedia (16 & 32 bit)
167 winmm/joystick/ - Joystick driver
168 winmm/mciwave/ - MCI wave driver
169 winmm/wavemap/ - Audio mapper
170 winmm/winealsa/ - ALSA audio driver
171 winmm/winearts/ - aRts audio driver
172 winmm/wineaudioio/ - audioio audio driver
173 winmm/winejack/ - JACK audio server driver
174 winmm/winenas/ - NAS audio driver
175 winmm/wineoss/ - OSS audio driver
176 winnls32/ - National Language Support
177 winspool/ - Printing & Print Spooler
178 wintab32/ - Tablet device interface
179 wintrust/ - Trust verification interface
180 wldap32/ - LDAP support
181 wnaspi32/ - 16 bit Advanced SCSI Peripheral Interface
182 wow32/ - WOW subsystem
183 ws2_32/ - Sockets 2.0 (networking)
184 wsock32/ - Sockets 1.1 (networking)
185 wtsapi32/ - Terminal Services
186 x11drv/ - X11 display driver (Wine specific)
188 Winelib programs (under programs/):
189 -----------------------------------
191 avitools/ - AVI information viewer and player
192 clock/ - Graphical clock
193 cmdlgtst/ - Common dialog tests
194 control/ - Control panel
195 expand/ - Decompress Lempel-Ziv compressed archive
196 msiexec/ - Microsoft Installer frontend
197 notepad/ - Notepad replacement
198 progman/ - Program manager
199 regedit/ - Registry editor
200 regsvr32/ - Register COM server
201 rpcss/ - RPC services
202 rundll32/ - Execute DLL functions directly
203 start/ - Replacement for start.exe
204 taskmgr/ - Manage running Windows/Winelib applications
205 uninstaller/ - Remove installed programs
206 view/ - Metafile viewer
207 wcmd/ - Command line interface
208 wineboot/ - Wine bootstrap process
209 winecfg/ - Wine configuration utility
210 wineconsole/ - Console
211 winedbg/ - Debugger
212 winefile/ - File manager
213 winemenubuilder/ - Helper program for building Unix menu entries
214 winemine/ - Mine game
215 winepath/ - Translate between Wine and Unix paths
216 winetest/ - Wine testing shell
217 winevdm/ - Wine virtual DOS machine
218 winhelp/ - Help viewer
219 winver/ - Windows Version Program
222 Support programs, libraries, etc:
223 ---------------------------------
225 dlls/dxerr8/ - DirectX 8 error import lib
226 dlls/dxerr9/ - DirectX 9 error import lib
227 dlls/dxguid/ - DirectX UUID import lib
228 dlls/strmiids/ - Exports class CLSIDs and interface IIDs
229 dlls/uuid/ - Windows-compatible UUID import lib
230 documentation/ - some documentation
231 include/ - Windows standard includes
232 include/msvcrt/ - MSVC compatible libc headers
233 include/wine/ - Wine specific headers
234 libs/ - the Wine libraries
235 libs/port/ - portability library
236 libs/unicode/ - Unicode support shared
237 libs/wine/ - Wine bootstrap library
238 libs/wpp/ - C preprocessor
239 loader/ - the main Wine loader
240 server/ - the Wine server
241 tools/ - various tools used to build/check Wine
242 tools/widl/ - the IDL compiler
243 tools/winapi/ - A Win32 API checker
244 tools/winebuild/ - Wine build tool
245 tools/winedump/ - a .DLL dump utility
246 tools/winegcc/ - a MinGW command line compatible gcc wrapper
247 tools/wmc/ - the message compiler
248 tools/wpp/ - the C pre-processor library
249 tools/wrc/ - the resource compiler
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 'autoconf')
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/