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