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