| blob | 3e0ca59afa255f2da88a6f6810704b650cd8573b |
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 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 serialui/ - Serial port property pages
102 setupapi/ - Setup interface
103 shdocvw/ - Shell document object and control
104 shfolder/ - Shell folder service
105 shell32/ - COM object implementing shell views
106 shlwapi/ - Shell Light-Weight interface
107 snmpapi/ - SNMP protocol interface (networking)
108 sti/ - Still Image service
109 tapi32/ - Telephone interface
110 ttydrv/ - TTY display driver (Wine specific)
111 twain/ - TWAIN Imaging device communications
112 unicows/ - Unicows replacement (Unicode layer for Win9x)
113 url/ - Internet shortcut shell extension
114 urlmon/ - URL Moniker allows binding to a URL (like KIO/gnome-vfs)
115 user/ - Window management, standard controls, etc.
116 uxtheme/ - Theme library
117 version/ - File installation library
118 win32s/ - 32-bit function access for 16-bit systems
119 winaspi/ - 16 bit Advanced SCSI Peripheral Interface
120 wined3d/ - Wine internal Direct3D helper
121 winedos/ - DOS features and BIOS calls (interrupts) (wine specific)
122 wineps/ - Postscript driver (Wine specific)
123 wininet/ - Internet extensions
124 winmm/ - Multimedia (16 & 32 bit)
125 winmm/joystick/ - Joystick driver
126 winmm/mcianim/ - MCI animation driver
127 winmm/mciavi/ - MCI video driver
128 winmm/mcicda/ - MCI audio CD driver
129 winmm/mciseq/ - MCI MIDI driver
130 winmm/mciwave/ - MCI wave driver
131 winmm/midimap/ - MIDI mapper
132 winmm/wavemap/ - Audio mapper
133 winmm/winealsa/ - ALSA audio driver
134 winmm/winearts/ - aRts audio driver
135 winmm/wineaudioio/ - audioio audio driver
136 winmm/winejack/ - JACK audio server driver
137 winmm/winenas/ - NAS audio driver
138 winmm/wineoss/ - OSS audio driver
139 winnls/ - National Language Support
140 winsock/ - Sockets 2.0 (networking)
141 wsock32/ - Sockets 1.1 (networking)
142 wintab32/ - Tablet device interface
143 winspool/ - Printing & Print Spooler
144 wintrust/ - Trust verification interface
145 wow32/ - WOW subsystem
146 x11drv/ - X11 display driver (Wine specific)
148 Winelib programs (under programs/):
149 -----------------------------------
151 avitools/ - AVI information viewer and player
152 clock/ - Graphical clock
153 cmdlgtst/ - Common dialog tests
154 control/ - Control panel
155 expand/ - Decompress Lempel-Ziv compressed archive
156 notepad/ - Notepad with RichEdit functionality
157 progman/ - Program manager
158 regedit/ - Registry editor
159 regsvr32/ - Register COM server
160 rpcss/ - RPC services
161 rundll32/ - Execute DLL functions directly
162 start/ - Replacement for start.exe
163 uninstaller/ - Remove installed programs
164 view/ - Metafile viewer
165 wcmd/ - Command line interface
166 wineboot/ - Wine bootstrap process
167 winecfg/ - Wine configuration utility
168 wineconsole/ - Console
169 winedbg/ - Debugger
170 winefile/ - File manager
171 winemenubuilder/ - Helper program for building Unix menu entries
172 winemine/ - Mine game
173 winepath/ - Translate between Wine and Unix paths
174 winetest/ - Wine testing shell
175 winevdm/ - Wine virtual DOS machine
176 winhelp/ - Help viewer
177 winver/ - Windows Version Program
180 Support programs, libraries, etc:
181 ---------------------------------
183 dlls/dxguid/ - DirectX UUID import lib
184 dlls/uuid/ - Windows-compatible UUID import lib
185 documentation/ - some documentation
186 documentation/samples/ - sample configuration files
187 include/ - Windows standard includes
188 include/msvcrt/ - MSVC compatible libc headers
189 include/wine/ - Wine specific headers
190 libs/ - the Wine libraries
191 libs/port/ - portability library
192 libs/unicode/ - Unicode support shared
193 libs/wine/ - Wine bootstrap library
194 libs/wpp/ - C preprocessor
195 loader/ - the main Wine loader
196 server/ - the Wine server
197 tools/ - various tools used to build/check Wine
198 tools/widl/ - the IDL compiler
199 tools/winapi{,_check}/ - A Win32 API checker
200 tools/winebuild/ - Wine build tool
201 tools/winedump/ - a .DLL dump utility
202 tools/winegcc/ - a MinGW command line compatible gcc wrapper
203 tools/wmc/ - the message compiler
204 tools/wpp/ - the C pre-processor library
205 tools/wrc/ - the resource compiler
208 Miscellaneous:
209 --------------
211 Note: these directories will ultimately get moved into their
212 respective dlls.
214 files/ - KERNEL file I/O
215 misc/ - KERNEL registry
217 graphics/ - GDI graphics drivers
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
233 gdi32.spec)
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
258 into a stub:
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
263 put in a stub.
265 /************************************************************
266 * PolyBezierTo (GDI32.269)
267 *
268 * Draw many Bezier curves.
269 *
270 * RETURNS
271 * Success: Non-zero.
272 * Failure: FALSE. Use GetLastError() to find the error cause.
273 *
274 * BUGS
275 * Unimplemented
276 */
277 BOOL WINAPI PolyBezierTo(HDC hdc, /* [In] Device context to draw to */
278 LPCVOID p, /* [In] Array of POINT structs */
279 DWORD count /* [In] Number of points in p */
280 )
281 {
282 /* tell the user they've got a substandard implementation */
283 FIXME(gdi, ":(%x,%p,%d): stub\n", hdc, p, count);
285 /* some programs may be able to compensate,
286 * if they know what happened
287 */
288 SetLastError(ERROR_CALL_NOT_IMPLEMENTED);
289 return FALSE; /* error value */
290 }
292 4. Implement and test the rest of the function.
295 IMPLEMENTING A NEW DLL
296 ======================
298 Generic directions
299 ------------------
301 Apart from writing the set of needed .c files, you also need to do the
302 following:
304 1. Create a directory <MyDll> where to store the implementation of
305 the DLL. This directory has to be put under the dlls/ directory.
306 If the DLL exists under Windows as both 16 and 32 bit DLL, you
307 should have a single directory with both implementations.
309 2. Create the Makefile.in in the ./dlls/<MyDll>/ directory. You can
310 copy an existing Makefile.in from another ./dlls/ subdirectory.
311 You need at least to change the MODULE and C_SRCS macros.
313 3. Add the directory in ./configure.ac (in AC_OUTPUT macro at the end
314 of the file to trigger the Makefile generation)
316 4. Run ./make_dlls in the dlls directory to update Makefile.in in
317 that directory.
319 5. You can now regenerate ./configure file (with 'make configure')
320 and the various Makefiles (with 'configure; make depend') (run
321 from the top of Wine's tree).
322 You should now have a Makefile file in ./dlls/<MyDll>/
324 6. Create the .spec file for the DLL exported functions in your
325 directory. Refer to 'Implementation of new API calls' earlier in
326 this document for more information on this part.
328 7. You can now start adding .c files. For the .h files, if they are
329 standard Windows one, put them in include/. If they are linked to
330 *your* implementation of the dll, put them in your newly created
331 directory.
333 Debug channels
334 --------------
336 If you need to create a new debug channel, just add the
337 WINE_DEFAULT_DEBUG_CHANNEL to your .c file(s), and use them.
338 All the housekeeping will happen automatically.
340 Resources
341 ---------
343 If you also need to add resources to your DLL, then create the .rc
344 file. Add to your ./dlls/<MyDll>/Makefile.in, in the RC_SRCS macro,
345 the list of .rc files to add to the DLL. See dlls/comctl32/ for an
346 example of this.
348 Thunking
349 --------
351 If you're building a 16 & 32 bit DLLs pair, then from the 32 bit code
352 you might need to call 16 bit routine. The way to do it to add in the
353 code, fragments like:
354 /* ### Start build ### */
355 extern WORD CALLBACK <PREFIX>_CallTo16_word_wwlll(FARPROC16,WORD,WORD,LONG,LONG,LONG);
356 /* ### stop build ### */
357 Where <PREFIX>_ is an internal prefix for your module. The first
358 parameter is always of type FARPROC16. Then, you can get the regular
359 list of parameters. The _word_wwlll indicates the type of return (long
360 or word) and the size of the parameters (here l=>long, w=>word; which
361 maps to WORD,WORD,LONG,LONG,LONG.
362 You can put several functions between the Start/Stop build pair.
364 You can also read the winebuild manpage for more details on this.
366 Then, add to ./dlls/<MyDll>/Makefile.in a line like:
368 EXTRA_OBJS = $(MODULE).glue.o
370 See dlls/winmm/ for an example of this.
372 MEMORY AND SEGMENTS
373 ===================
375 NE (Win16) executables consist of multiple segments. The Wine loader
376 loads each segment into a unique location in the Wine processes memory
377 and assigns a selector to that segment. Because of this, it's not
378 possible to exchange addresses freely between 16-bit and 32-bit code.
379 Addresses used by 16-bit code are segmented addresses (16:16), formed
380 by a 16-bit selector and a 16-bit offset. Those used by the Wine code
381 are regular 32-bit linear addresses.
383 There are four ways to obtain a segmented pointer:
384 - Using the MapLS function (recommended).
385 - Allocate a block of memory from the global heap and use
386 WIN16_GlobalLock to get its segmented address.
387 - Declare the argument as 'segptr' instead of 'ptr' in the spec file
388 for a given API function.
390 Once you have a segmented pointer, it must be converted to a linear
391 pointer before you can use it from 32-bit code. This can be done with
392 the MapSL function. The linear pointer can then be used freely with
393 standard Unix functions like memcpy() etc. without worrying about 64k
394 boundaries. Note: there's no easy way to convert back from a linear
395 to a segmented address.
397 In most cases, you don't need to worry about segmented address, as the
398 conversion is made automatically by the callback code and the API
399 functions only see linear addresses. However, in some cases it is
400 necessary to manipulate segmented addresses; the most frequent cases
401 are:
402 - API functions that return a pointer
403 - lParam of Windows messages that point to a structure
404 - Pointers contained inside structures accessed by 16-bit code.
406 It is usually a good practice to used the type 'SEGPTR' for segmented
407 pointers, instead of something like 'LPSTR' or 'char *'. As SEGPTR is
408 defined as a DWORD, you'll get a compilation warning if you mistakenly
409 use it as a regular 32-bit pointer.
412 STRUCTURE PACKING
413 =================
415 Under Windows, data structures are tightly packed, i.e. there is no
416 padding between structure members. On the other hand, by default gcc
417 aligns structure members (e.g. WORDs are on a WORD boundary, etc.).
418 This means that a structure like
420 struct { BYTE x; WORD y; };
422 will take 3 bytes under Windows, but 4 with gcc, because gcc will add a
423 dummy byte between x and y. To have the correct layout for structures
424 used by Windows code, you need to embed the struct within two special
425 #include's which will take care of the packing for you:
427 #include "pshpack1.h"
428 struct { BYTE x; WORD y; };
429 #include "poppack1.h"
431 For alignment on a 2-byte boundary, there is a "pshpack2.h", etc.
433 The use of the WINE_PACKED attribute is obsolete. Please remove these
434 in favour of the above solution.
435 Using WINE_PACKED, you would declare the above structure like this:
437 struct { BYTE x; WORD y WINE_PACKED; };
439 You had to do this every time a structure member is not aligned
440 correctly under Windows (i.e. a WORD not on an even address, or a
441 DWORD on a address that was not a multiple of 4).
444 NAMING CONVENTIONS FOR API FUNCTIONS AND TYPES
445 ==============================================
447 In order to support both Win16 and Win32 APIs within the same source
448 code, the following convention must be used in naming all API
449 functions and types. If the Windows API uses the name 'xxx', the Wine
450 code must use:
452 - 'xxx16' for the Win16 version,
453 - 'xxx' for the Win32 version when no ASCII/Unicode strings are
454 involved,
455 - 'xxxA' for the Win32 version with ASCII strings,
456 - 'xxxW' for the Win32 version with Unicode strings.
458 If the function has both ASCII and Unicode version, you should then
459 use the macros WINELIB_NAME_AW(xxx) or DECL_WINELIB_TYPE_AW(xxx)
460 (defined in include/windef.h) to define the correct 'xxx' function
461 or type for Winelib. When compiling Wine itself, 'xxx' is _not_
462 defined, meaning that code inside of Wine must always specify
463 explicitly the ASCII or Unicode version.
465 If 'xxx' is the same in Win16 and Win32, you can simply use the same
466 name as Windows, i.e. just 'xxx'. If 'xxx' is Win16 only, you could
467 use the name as is, but it's preferable to use 'xxx16' to make it
468 clear it is a Win16 function.
470 Examples:
472 typedef struct { /* Win32 ASCII data structure */ } WNDCLASSA;
473 typedef struct { /* Win32 Unicode data structure */ } WNDCLASSW;
474 typedef struct { /* Win16 data structure */ } WNDCLASS16;
475 DECL_WINELIB_TYPE_AW(WNDCLASS);
477 ATOM RegisterClass16( WNDCLASS16 * );
478 ATOM RegisterClassA( WNDCLASSA * );
479 ATOM RegisterClassW( WNDCLASSW * );
480 #define RegisterClass WINELIB_NAME_AW(RegisterClass)
482 The Winelib user can then say:
484 WNDCLASS wc = { ... };
485 RegisterClass( &wc );
487 and this will use the correct declaration depending on the definition
488 of the UNICODE symbol.
491 NAMING CONVENTIONS FOR NON-API FUNCTIONS AND TYPES
492 ==================================================
494 Functions and data which are internal to your code (or at least shouldn't be
495 visible to any Winelib or Windows program) should be preceded by
496 an identifier to the module:
498 Examples:
500 ENUMPRINTERS_GetDWORDFromRegistryA() (in dlls/winspool/info.c)
501 IAVIFile_fnRelease() (in dlls/avifil32/avifile.c)
502 X11DRV_CreateDC() (in graphics/x11drv/init.c)
504 if you need prototypes for these, there are a few possibilities:
505 - within same source file only:
506 put the prototypes at the top of your file and mark them as prototypes.
507 - within the same module:
508 create a header file within the subdirectory where that module resides,
509 e.g. graphics/ddraw_private.h
510 - from a totally different module, or for use in winelib:
511 you should never do that. Only exported APIs can be called across
512 module boundaries.
515 DEBUG MESSAGES
516 ==============
518 To display a message only during debugging, you normally write something
519 like this:
521 TRACE("abc..."); or
522 FIXME("abc..."); or
523 WARN("abc..."); or
524 ERR("abc...");
526 depending on the seriousness of the problem. (documentation/debugging.sgml
527 explains when it is appropriate to use each of them). You need to declare
528 the debug channel name at the top of the file (after the includes) using
529 the WINE_DEFAULT_DEBUG_CHANNEL macro, like so:
531 WINE_DEFAULT_DEBUG_CHANNEL(win);
533 If your debugging code is more complex than just printf, you can use
534 the macros:
536 TRACE_ON(xxx), WARN_ON(xxx), ERR_ON(xxx) and FIXME_ON(xxx)
538 to test if the given channel is enabled. Thus, you can write:
540 if (TRACE_ON(win)) DumpSomeStructure(&str);
542 Don't worry about the inefficiency of the test. If it is permanently
543 disabled (that is TRACE_ON(win) is 0 at compile time), the compiler will
544 eliminate the dead code.
546 For more info about debugging messages, read:
548 http://www.winehq.org/site/docs/wine-devel/debugging
551 MORE INFO
552 =========
554 1. There is a FREE online version of the MSDN library (including
555 documentation for the Win32 API) on http://msdn.microsoft.com/
556 or http://www.msdn.com/
558 2. Windows apilist: http://www.mentalis.org/apilist/apilist.php
560 3. http://www.sonic.net/~undoc/bookstore.html
562 4. In 1993 Dr. Dobbs Journal published a column called "Undocumented Corner".
564 5. www.geocities.com/SiliconValley/4942/