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