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