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