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