- key accelerators for "New Game" and exit
[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/dxguid/            - DirectX UUID import lib
194         dlls/uuid/              - Windows-compatible UUID import lib
195         documentation/          - some documentation
196         documentation/samples/  - sample configuration files
197         include/                - Windows standard includes
198         include/msvcrt/         - MSVC compatible libc headers
199         include/wine/           - Wine specific headers
200         libs/                   - the Wine libraries
201         libs/port/              - portability library
202         libs/unicode/           - Unicode support shared
203         libs/wine/              - Wine bootstrap library
204         libs/wpp/               - C preprocessor
205         loader/                 - the main Wine loader
206         server/                 - the Wine server
207         tools/                  - various tools used to build/check Wine
208         tools/widl/             - the IDL compiler
209         tools/winapi{,_check}/  - A Win32 API checker
210         tools/winebuild/        - Wine build tool
211         tools/winedump/         - a .DLL dump utility
212         tools/winegcc/          - a MinGW command line compatible gcc wrapper
213         tools/wmc/              - the message compiler
214         tools/wpp/              - the C pre-processor library
215         tools/wrc/              - the resource compiler
216
217
218 Miscellaneous:
219 --------------
220
221 Note: these directories will ultimately get moved into their
222 respective dlls.
223
224         files/                  - KERNEL file I/O
225         misc/                   - KERNEL registry 
226
227         objects/                - GDI logical objects
228
229         controls/               - USER built-in widgets
230         windows/                - USER window management
231
232
233
234 IMPLEMENTING NEW API CALLS
235 ==========================
236
237 This is the simple version, and covers only Win32. Win16 is slightly
238 uglier, because of the Pascal heritage and the segmented memory model.
239
240 All of the Win32 APIs known to Wine are listed in the .spec file of
241 their corresponding dll. An unimplemented call will look like (from
242 gdi32.spec)
243   269 stub PolyBezierTo
244 To implement this call, you need to do the following four things.
245
246 1. Find the appropriate parameters for the call, and add a prototype to
247 the correct header file. In this case, that means [include/wingdi.h],
248 and it might look like
249   BOOL WINAPI PolyBezierTo(HDC, LPCVOID, DWORD);
250 If the function has both an ASCII and a Unicode version, you need to
251 define both and add a #define WINELIB_NAME_AW declaration. See below
252 for discussion of function naming conventions.
253   
254 2. Modify the .spec file to tell Wine that the function has an
255 implementation, what the parameters look like and what Wine function
256 to use for the implementation. In Win32, things are simple--everything
257 is 32-bits. However, the relay code handles pointers and pointers to
258 strings slightly differently, so you should use 'str' and 'wstr' for
259 strings, 'ptr' for other pointer types, and 'long' for everything else.
260   269 stdcall PolyBezierTo(long ptr long) PolyBezierTo
261 The 'PolyBezierTo' at the end of the line is which Wine function to use
262 for the implementation.
263
264 3. Implement the function as a stub. Once you add the function to the .spec
265 file, you must add the function to the Wine source before it will link.
266 Add a function called 'PolyBezierTo' somewhere. Good things to put
267 into a stub:
268   o a correct prototype, including the WINAPI
269   o header comments, including full documentation for the function and
270     arguments (see documentation/README.documentation)
271   o A FIXME message and an appropriate return value are good things to
272     put in a stub.
273
274   /************************************************************
275    *                    PolyBezierTo   (GDI32.269)  
276    *  
277    * Draw many Bezier curves.
278    *
279    * PARAMS
280    *   hdc   [I] Device context to draw to
281    *   p     [I] Array of POINT structs
282    *   count [I] Number of points in p
283    *
284    * RETURNS
285    *   Success: Non-zero.
286    *   Failure: FALSE. Use GetLastError() to find the error cause.
287    *
288    * BUGS
289    *   Unimplemented
290    */
291    BOOL WINAPI PolyBezierTo(HDC hdc, LPCVOID p, DWORD count) 
292    {
293        /* tell the user they've got a substandard implementation */
294        FIXME(gdi, ":(%x,%p,%d): stub\n", hdc, p, count);
295
296        /* some programs may be able to compensate, 
297         * if they know what happened 
298         */
299        SetLastError(ERROR_CALL_NOT_IMPLEMENTED);  
300        return FALSE;    /* error value */
301    }
302
303 4. Implement and test the rest of the function.
304
305
306 IMPLEMENTING A NEW DLL
307 ======================
308
309 Generic directions
310 ------------------
311
312 Apart from writing the set of needed .c files, you also need to do the 
313 following:
314
315 1.  Create a directory <MyDll> where to store the implementation of
316     the DLL. This directory has to be put under the dlls/ directory.
317     If the DLL exists under Windows as both 16 and 32 bit DLL, you
318     should have a single directory with both implementations.
319
320 2.  Create the Makefile.in in the ./dlls/<MyDll>/ directory. You can
321     copy an existing Makefile.in from another ./dlls/ subdirectory.
322     You need at least to change the MODULE and C_SRCS macros. 
323
324 3.  Add the directory in ./configure.ac (in AC_OUTPUT macro at the end
325     of the file to trigger the Makefile generation)
326
327 4.  Run ./make_dlls in the dlls directory to update Makefile.in in
328     that directory.
329
330 5.  You can now regenerate ./configure file (with 'make configure')
331     and the various Makefiles (with 'configure; make depend') (run
332     from the top of Wine's tree).
333     You should now have a Makefile file in ./dlls/<MyDll>/
334
335 6.  Create the .spec file for the DLL exported functions in your
336     directory. Refer to 'Implementation of new API calls' earlier in
337     this document for more information on this part.
338
339 7.  You can now start adding .c files. For the .h files, if they are
340     standard Windows one, put them in include/. If they are linked to
341     *your* implementation of the dll, put them in your newly created
342     directory.
343
344 Debug channels
345 --------------
346
347 If you need to create a new debug channel, just add the
348 WINE_DEFAULT_DEBUG_CHANNEL to your .c file(s), and use them. 
349 All the housekeeping will happen automatically.
350
351 Resources
352 ---------
353
354 If you also need to add resources to your DLL, then create the .rc
355 file. Add to your ./dlls/<MyDll>/Makefile.in, in the RC_SRCS macro,
356 the list of .rc files to add to the DLL. See dlls/comctl32/ for an
357 example of this.
358
359 Thunking
360 --------
361
362 If you're building a 16 & 32 bit DLLs pair, then from the 32 bit code
363 you might need to call 16 bit routine. The way to do it to add in the
364 code, fragments like:
365 /* ### Start build ### */
366 extern WORD CALLBACK <PREFIX>_CallTo16_word_wwlll(FARPROC16,WORD,WORD,LONG,LONG,LONG);
367 /* ### stop build ### */
368 Where <PREFIX>_ is an internal prefix for your module. The first
369 parameter is always of type FARPROC16. Then, you can get the regular
370 list of parameters. The _word_wwlll indicates the type of return (long
371 or word) and the size of the parameters (here l=>long, w=>word; which
372 maps to WORD,WORD,LONG,LONG,LONG.
373 You can put several functions between the Start/Stop build pair.
374
375 You can also read the winebuild manpage for more details on this.
376
377 Then, add to ./dlls/<MyDll>/Makefile.in a line like:
378
379 EXTRA_OBJS = $(MODULE).glue.o
380
381 See dlls/winmm/ for an example of this.
382
383 MEMORY AND SEGMENTS
384 ===================
385
386 NE (Win16) executables consist of multiple segments.  The Wine loader
387 loads each segment into a unique location in the Wine processes memory
388 and assigns a selector to that segment.  Because of this, it's not
389 possible to exchange addresses freely between 16-bit and 32-bit code.
390 Addresses used by 16-bit code are segmented addresses (16:16), formed
391 by a 16-bit selector and a 16-bit offset.  Those used by the Wine code
392 are regular 32-bit linear addresses.
393
394 There are four ways to obtain a segmented pointer:
395   - Using the MapLS function (recommended).
396   - Allocate a block of memory from the global heap and use
397     WIN16_GlobalLock to get its segmented address.
398   - Declare the argument as 'segptr' instead of 'ptr' in the spec file
399     for a given API function.
400
401 Once you have a segmented pointer, it must be converted to a linear
402 pointer before you can use it from 32-bit code.  This can be done with
403 the MapSL function.  The linear pointer can then be used freely with
404 standard Unix functions like memcpy() etc. without worrying about 64k
405 boundaries.  Note: there's no easy way to convert back from a linear
406 to a segmented address.
407
408 In most cases, you don't need to worry about segmented address, as the
409 conversion is made automatically by the callback code and the API
410 functions only see linear addresses. However, in some cases it is
411 necessary to manipulate segmented addresses; the most frequent cases
412 are:
413   - API functions that return a pointer
414   - lParam of Windows messages that point to a structure
415   - Pointers contained inside structures accessed by 16-bit code.
416
417 It is usually a good practice to used the type 'SEGPTR' for segmented
418 pointers, instead of something like 'LPSTR' or 'char *'.  As SEGPTR is
419 defined as a DWORD, you'll get a compilation warning if you mistakenly
420 use it as a regular 32-bit pointer.
421
422
423 STRUCTURE PACKING
424 =================
425
426 Under Windows, data structures are tightly packed, i.e. there is no
427 padding between structure members. On the other hand, by default gcc
428 aligns structure members (e.g. WORDs are on a WORD boundary, etc.).
429 This means that a structure like
430
431 struct { BYTE x; WORD y; };
432
433 will take 3 bytes under Windows, but 4 with gcc, because gcc will add a
434 dummy byte between x and y. To have the correct layout for structures
435 used by Windows code, you need to embed the struct within two special
436 #include's which will take care of the packing for you:
437
438 #include "pshpack1.h"
439 struct { BYTE x; WORD y; };
440 #include "poppack1.h"
441
442 For alignment on a 2-byte boundary, there is a "pshpack2.h", etc.
443
444
445 NAMING CONVENTIONS FOR API FUNCTIONS AND TYPES
446 ==============================================
447
448 In order to support both Win16 and Win32 APIs within the same source
449 code, the following convention must be used in naming all API
450 functions and types. If the Windows API uses the name 'xxx', the Wine
451 code must use:
452
453  - 'xxx16' for the Win16 version,
454  - 'xxx'   for the Win32 version when no strings are involved,
455  - 'xxxA'  for the Win32 version with ASCII strings,
456  - 'xxxW'  for the Win32 version with Unicode strings.
457
458 If the function has both ASCII and Unicode version, you should then
459 use the macros WINELIB_NAME_AW(xxx) or DECL_WINELIB_TYPE_AW(xxx)
460 (defined in include/windef.h) to define the correct 'xxx' function
461 or type for Winelib. When compiling Wine itself, 'xxx' is _not_
462 defined, meaning that code inside of Wine must always specify
463 explicitly the ASCII or Unicode version.
464
465 If 'xxx' is the same in Win16 and Win32, you can simply use the same
466 name as Windows, i.e. just 'xxx'.  If 'xxx' is Win16 only, you could
467 use the name as is, but it's preferable to use 'xxx16' to make it
468 clear it is a Win16 function.
469
470 Examples:
471
472 typedef struct { /* Win32 ASCII data structure */ } WNDCLASSA;
473 typedef struct { /* Win32 Unicode data structure */ } WNDCLASSW;
474 typedef struct { /* Win16 data structure */ } WNDCLASS16;
475 DECL_WINELIB_TYPE_AW(WNDCLASS);
476
477 ATOM RegisterClass16( WNDCLASS16 * );
478 ATOM RegisterClassA( WNDCLASSA * );
479 ATOM RegisterClassW( WNDCLASSW * );
480 #define RegisterClass WINELIB_NAME_AW(RegisterClass)
481
482 The Winelib user can then say:
483
484     WNDCLASS wc = { ... };
485     RegisterClass( &wc );
486
487 and this will use the correct declaration depending on the definition
488 of the UNICODE symbol.
489
490
491 DEBUG MESSAGES
492 ==============
493
494 To display a message only during debugging, you normally write something
495 like this:
496
497         TRACE("abc...");  or
498         FIXME("abc...");  or
499         WARN("abc...");   or
500         ERR("abc...");
501
502 depending on the seriousness of the problem. (documentation/debugging.sgml
503 explains when it is appropriate to use each of them). You need to declare
504 the debug channel name at the top of the file (after the includes) using
505 the WINE_DEFAULT_DEBUG_CHANNEL macro, like so:
506
507         WINE_DEFAULT_DEBUG_CHANNEL(win);
508
509 If your debugging code is more complex than just printf, you can use 
510 the macros:
511
512         TRACE_ON(xxx), WARN_ON(xxx), ERR_ON(xxx) and FIXME_ON(xxx) 
513
514 to test if the given channel is enabled. Thus, you can write:
515
516         if (TRACE_ON(win)) DumpSomeStructure(&str);
517
518 Don't worry about the inefficiency of the test. If it is permanently 
519 disabled (that is TRACE_ON(win) is 0 at compile time), the compiler will 
520 eliminate the dead code.
521
522 For more info about debugging messages, read:
523
524 http://www.winehq.org/site/docs/wine-devel/debugging
525
526
527 MORE INFO
528 =========
529
530 1. There is a FREE online version of the MSDN library (including
531    documentation for the Win32 API) on http://msdn.microsoft.com/
532    or http://www.msdn.com/
533
534 2. Windows apilist:  http://www.mentalis.org/apilist/apilist.php
535
536 3. http://www.sonic.net/~undoc/bookstore.html
537
538 4. In 1993 Dr. Dobbs Journal published a column called "Undocumented Corner".
539
540 5. www.geocities.com/SiliconValley/4942/