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