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