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