| blob | a6898a1fa522344cfe394ef3fcca410e56811619 |
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:
15 -----
16 dlls/ - All the DLLs implemented by Wine
18 advapi32/ - Crypto, systeminfo, security, eventlogging
19 avicap32/ - AVI capture window class
20 avifil32/ - COM object to play AVI files
21 cabinet/ - Cabinet file interface
22 comcat/ - Component category manager
23 comctl32/ - Common controls
24 commdlg/ - Common dialog boxes (both 16 & 32 bit)
25 crtdll/ - Old C runtime library
26 crypt32/ - Cryptography
27 ctl3d/ - 3D Effects for Common GUI Components
28 d3d8/ - Direct3D (3D graphics)
29 d3d9/ - Direct3D (3D graphics)
30 d3dim/ - Direct3D Immediate Mode
31 d3dx8/ - Direct3D (3D graphics)
32 dciman32/ - DCI Manager (graphics)
33 ddraw/ - DirectDraw (graphics)
34 devenum/ - Device enumeration (part of DirectShow)
35 dinput/ - DirectInput (device input)
36 dinput8/ - DirectInput (device input)
37 dmband/ - DirectMusic
38 dmcompos/ - DirectMusic
39 dmime/ - DirectMusic
40 dmloader/ - DirectMusic
41 dmscript/ - DirectMusic
42 dmstyle/ - DirectMusic
43 dmsynth/ - DirectMusic
44 dmusic/ - DirectMusic
45 dmusic32/ - DirectMusic
46 dplay/ - DirectPlay (networking)
47 dplayx/ - DirectPlay (networking)
48 dpnhpast/ - DirectPlay NAT Helper
49 dsound/ - DirectSound (audio)
50 gdi/ - GDI (graphics)
51 enhmetafiledrv/ - Enhanced metafile driver
52 metafiledrv/ - Metafile driver
53 glu32/ - OpenGL Utility library (graphics)
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 msdmo/ - DirectX Media Objects
64 msimg32/ - Gradient and transparency (graphics)
65 msisys/ - System information
66 msi/ - Microsoft Installer
67 msnet32/ - Network interface
68 msvcrt/ - C runtime library
69 msvcrt20/ - C runtime library version 2.0
70 msvcrtd/ - C runtime library debugging
71 msvideo/ - 16 bit video manager
72 mswsock/ - Misc networking
73 netapi32/ - Network interface
74 ntdll/ - NT implementation of kernel calls
75 odbc32/ - Open DataBase Connectivity driver manager
76 ole32/ - 32 bit OLE 2.0 libraries
77 oleaut32/ - 32 bit OLE 2.0 automation
78 olecli/ - 16 bit OLE client
79 oledlg/ - OLE 2.0 user interface support
80 olepro32/ - 32 bit OLE 2.0 automation
81 olesvr/ - 16 bit OLE server
82 opengl32/ - OpenGL implementation (graphics)
83 psapi/ - Process Status interface
84 qcap/ - DirectShow runtime
85 quartz/ - DirectShow runtime
86 rasapi32/ - Remote Access Server interface
87 richedit/ - Rich text editing control
88 rpcrt4/ - Remote Procedure Call runtime
89 serialui/ - Serial port property pages
90 setupapi/ - Setup interface
91 shdocvw/ - Shell document object and control
92 shfolder/ - Shell folder service
93 shell32/ - COM object implementing shell views
94 shlwapi/ - Shell Light-Weight interface
95 snmpapi/ - SNMP protocol interface (networking)
96 sti/ - Still Image service
97 tapi32/ - Telephone interface
98 ttydrv/ - TTY display driver (Wine specific)
99 twain/ - TWAIN Imaging device communications
100 url/ - Internet shortcut shell extension
101 urlmon/ - URL Moniker allows binding to a URL (like KIO/gnome-vfs)
102 user/ - Window management, standard controls, etc.
103 version/ - File installation library
104 win32s/ - 32-bit function access for 16-bit systems
105 winaspi/ - 16 bit Advanced SCSI Peripheral Interface
106 winedos/ - DOS features and BIOS calls (interrupts) (wine specific)
107 wineps/ - Postscript driver (Wine specific)
108 wininet/ - Internet extensions
109 winmm/ - Multimedia (16 & 32 bit)
110 mciXXX/ - Various MCI drivers
111 midimap/ - MIDI mapper
112 wavemap/ - Audio mapper
113 winealsa/ - ALSA audio driver
114 winearts/ - aRts audio driver
115 winejack/ - JACK audio server driver
116 wineoss/ - OSS audio driver
117 winnls/ - National Language Support
118 winsock/ - Sockets 2.0 (networking)
119 wsock32/ - Sockets 1.1 (networking)
120 wintab32/ - Tablet device interface
121 winspool/ - Printing & Print Spooler
122 wintrust/ - Trust verification interface
123 wow32/ - WOW subsystem
124 x11drv/ - X11 display driver (Wine specific)
126 Winelib programs:
127 -----------------
129 programs/ - All the Winelib programs
131 avitools/ - AVI information viewer and player
132 clock/ - Graphical clock
133 cmdlgtst/ - Common dialog tests
134 control/ - Control panel
135 expand/ - Decompress Lempel-Ziv compressed archive
136 notepad/ - Notepad with RichEdit functionality
137 osversioncheck/ - Check version of Windows being indicated
138 progman/ - Program manager
139 regapi/ - Command line Registry implementation
140 regedit/ - Registry editor
141 regsvr32/ - Register COM server
142 regtest/ - Registry testing program
143 rpcss/ - RPC services
144 rundll32/ - Execute DLL functions directly
145 uninstaller/ - Remove installed programs
146 view/ - Metafile viewer
147 wcmd/ - Command line interface
148 wineconsole/ - Console
149 winedbg/ - Debugger
150 winefile/ - File manager
151 winemine/ - Mine game
152 winepath/ - Translate between Wine and Unix paths
153 winhelp/ - Help viewer
154 winver/ - Windows Version Program
157 Support programs, libraries, etc:
158 ---------------------------------
160 documentation/ - some documentation
161 include/ - Windows standard includes
162 libs/ - the Wine libraries
163 miscemu/ - the main Wine program
164 server/ - the Wine server
165 tools/ - relay code builder, resource compiler, etc.
166 unicode/ - Unicode support shared
169 Miscellaneous:
170 --------------
172 Note: these directories will ultimately get moved into their
173 respective dlls.
175 files/ - KERNEL file I/O
176 loader/ - KERNEL loader code
177 memory/ - KERNEL memory management
178 misc/ - KERNEL shell, registry, winsock, etc.
179 msdos/ - KERNEL DOS support
180 relay32/ - KERNEL 32-bit relay code
181 scheduler/ - KERNEL process and thread management
182 win32/ - KERNEL misc Win32 functions
184 graphics/ - GDI graphics drivers
185 objects/ - GDI logical objects
187 controls/ - USER built-in widgets
188 windows/ - USER window management
192 IMPLEMENTING NEW API CALLS
193 ==========================
195 This is the simple version, and covers only Win32. Win16 is slightly
196 uglier, because of the Pascal heritage and the segmented memory model.
198 All of the Win32 APIs known to Wine are listed in the .spec file of
199 their corresponding dll. An unimplemented call will look like (from
200 gdi32.spec)
201 269 stub PolyBezierTo
202 To implement this call, you need to do the following four things.
204 1. Find the appropriate parameters for the call, and add a prototype to
205 the correct header file. In this case, that means [include/wingdi.h],
206 and it might look like
207 BOOL WINAPI PolyBezierTo(HDC, LPCVOID, DWORD);
208 If the function has both an ASCII and a Unicode version, you need to
209 define both and add a #define WINELIB_NAME_AW declaration. See below
210 for discussion of function naming conventions.
212 2. Modify the .spec file to tell Wine that the function has an
213 implementation, what the parameters look like and what Wine function
214 to use for the implementation. In Win32, things are simple--everything
215 is 32-bits. However, the relay code handles pointers and pointers to
216 strings slightly differently, so you should use 'str' and 'wstr' for
217 strings, 'ptr' for other pointer types, and 'long' for everything else.
218 269 stdcall PolyBezierTo(long ptr long) PolyBezierTo
219 The 'PolyBezierTo' at the end of the line is which Wine function to use
220 for the implementation.
222 3. Implement the function as a stub. Once you add the function to the .spec
223 file, you must add the function to the Wine source before it will link.
224 Add a function called 'PolyBezierTo' somewhere. Good things to put
225 into a stub:
226 o a correct prototype, including the WINAPI
227 o header comments, including full documentation for the function and
228 arguments (see documentation/README.documentation)
229 o A FIXME message and an appropriate return value are good things to
230 put in a stub.
232 /************************************************************
233 * PolyBezierTo (GDI32.269)
234 *
235 * Draw many Bezier curves.
236 *
237 * RETURNS
238 * Success: Non-zero.
239 * Failure: FALSE. Use GetLastError() to find the error cause.
240 *
241 * BUGS
242 * Unimplemented
243 */
244 BOOL WINAPI PolyBezierTo(HDC hdc, /* [In] Device context to draw to */
245 LPCVOID p, /* [In] Array of POINT structs */
246 DWORD count /* [In] Number of points in p */
247 )
248 {
249 /* tell the user they've got a substandard implementation */
250 FIXME(gdi, ":(%x,%p,%d): stub\n", hdc, p, count);
252 /* some programs may be able to compensate,
253 * if they know what happened
254 */
255 SetLastError(ERROR_CALL_NOT_IMPLEMENTED);
256 return FALSE; /* error value */
257 }
259 4. Implement and test the rest of the function.
262 IMPLEMENTING A NEW DLL
263 ======================
265 Generic directions
266 ------------------
268 Apart from writing the set of needed .c files, you also need to do the
269 following:
271 1. Create a directory <MyDll> where to store the implementation of
272 the DLL. This directory has to be put under the dlls/ directory.
273 If the DLL exists under Windows as both 16 and 32 bit DLL, you
274 should have a single directory with both implementations.
276 2. Create the Makefile.in in the ./dlls/<MyDll>/ directory. You can
277 copy an existing Makefile.in from another ./dlls/ subdirectory.
278 You need at least to change the MODULE and C_SRCS macros.
280 3. Add the directory in ./configure.ac (in AC_OUTPUT macro at the end
281 of the file to trigger the Makefile generation)
283 4. Run ./make_dlls in the dlls directory to update Makefile.in in
284 that directory.
286 5. You can now regenerate ./configure file (with 'make configure')
287 and the various Makefiles (with 'configure; make depend') (run
288 from the top of Wine's tree).
289 You should now have a Makefile file in ./dlls/<MyDll>/
291 6. Create the .spec file for the DLL exported functions in your
292 directory. Refer to 'Implementation of new API calls' earlier in
293 this document for more information on this part.
295 7. You can now start adding .c files. For the .h files, if they are
296 standard Windows one, put them in include/. If they are linked to
297 *your* implementation of the dll, put them in your newly created
298 directory.
300 Debug channels
301 --------------
303 If you need to create a new debug channel, just add the
304 WINE_DEFAULT_DEBUG_CHANNEL to your .c file(s), and use them.
305 All the housekeeping will happen automatically.
307 Resources
308 ---------
310 If you also need to add resources to your DLL, then create the .rc
311 file. Add to your ./dlls/<MyDll>/Makefile.in, in the RC_SRCS macro,
312 the list of .rc files to add to the DLL. See dlls/comctl32/ for an
313 example of this.
315 Thunking
316 --------
318 If you're building a 16 & 32 bit DLLs pair, then from the 32 bit code
319 you might need to call 16 bit routine. The way to do it to add in the
320 code, fragments like:
321 /* ### Start build ### */
322 extern WORD CALLBACK <PREFIX>_CallTo16_word_wwlll(FARPROC16,WORD,WORD,LONG,LONG,LONG);
323 /* ### stop build ### */
324 Where <PREFIX>_ is an internal prefix for your module. The first
325 parameter is always of type FARPROC16. Then, you can get the regular
326 list of parameters. The _word_wwlll indicates the type of return (long
327 or word) and the size of the parameters (here l=>long, w=>word; which
328 maps to WORD,WORD,LONG,LONG,LONG.
329 You can put several functions between the Start/Stop build pair.
331 You can also read the winebuild manpage for more details on this.
333 Then, add to ./dlls/<MyDll>/Makefile.in a line like:
335 EXTRA_OBJS = $(MODULE).glue.o
337 See dlls/winmm/ for an example of this.
339 MEMORY AND SEGMENTS
340 ===================
342 NE (Win16) executables consist of multiple segments. The Wine loader
343 loads each segment into a unique location in the Wine processes memory
344 and assigns a selector to that segment. Because of this, it's not
345 possible to exchange addresses freely between 16-bit and 32-bit code.
346 Addresses used by 16-bit code are segmented addresses (16:16), formed
347 by a 16-bit selector and a 16-bit offset. Those used by the Wine code
348 are regular 32-bit linear addresses.
350 There are four ways to obtain a segmented pointer:
351 - Using the MapLS function (recommended).
352 - Allocate a block of memory from the global heap and use
353 WIN16_GlobalLock to get its segmented address.
354 - Declare the argument as 'segptr' instead of 'ptr' in the spec file
355 for a given API function.
357 Once you have a segmented pointer, it must be converted to a linear
358 pointer before you can use it from 32-bit code. This can be done with
359 the MapSL function. The linear pointer can then be used freely with
360 standard Unix functions like memcpy() etc. without worrying about 64k
361 boundaries. Note: there's no easy way to convert back from a linear
362 to a segmented address.
364 In most cases, you don't need to worry about segmented address, as the
365 conversion is made automatically by the callback code and the API
366 functions only see linear addresses. However, in some cases it is
367 necessary to manipulate segmented addresses; the most frequent cases
368 are:
369 - API functions that return a pointer
370 - lParam of Windows messages that point to a structure
371 - Pointers contained inside structures accessed by 16-bit code.
373 It is usually a good practice to used the type 'SEGPTR' for segmented
374 pointers, instead of something like 'LPSTR' or 'char *'. As SEGPTR is
375 defined as a DWORD, you'll get a compilation warning if you mistakenly
376 use it as a regular 32-bit pointer.
379 STRUCTURE PACKING
380 =================
382 Under Windows, data structures are tightly packed, i.e. there is no
383 padding between structure members. On the other hand, by default gcc
384 aligns structure members (e.g. WORDs are on a WORD boundary, etc.).
385 This means that a structure like
387 struct { BYTE x; WORD y; };
389 will take 3 bytes under Windows, but 4 with gcc, because gcc will add a
390 dummy byte between x and y. To have the correct layout for structures
391 used by Windows code, you need to embed the struct within two special
392 #include's which will take care of the packing for you:
394 #include "pshpack1.h"
395 struct { BYTE x; WORD y; };
396 #include "poppack1.h"
398 For alignment on a 2-byte boundary, there is a "pshpack2.h", etc.
400 The use of the WINE_PACKED attribute is obsolete. Please remove these
401 in favour of the above solution.
402 Using WINE_PACKED, you would declare the above structure like this:
404 struct { BYTE x; WORD y WINE_PACKED; };
406 You had to do this every time a structure member is not aligned
407 correctly under Windows (i.e. a WORD not on an even address, or a
408 DWORD on a address that was not a multiple of 4).
411 NAMING CONVENTIONS FOR API FUNCTIONS AND TYPES
412 ==============================================
414 In order to support both Win16 and Win32 APIs within the same source
415 code, the following convention must be used in naming all API
416 functions and types. If the Windows API uses the name 'xxx', the Wine
417 code must use:
419 - 'xxx16' for the Win16 version,
420 - 'xxx' for the Win32 version when no ASCII/Unicode strings are
421 involved,
422 - 'xxxA' for the Win32 version with ASCII strings,
423 - 'xxxW' for the Win32 version with Unicode strings.
425 If the function has both ASCII and Unicode version, you should then
426 use the macros WINELIB_NAME_AW(xxx) or DECL_WINELIB_TYPE_AW(xxx)
427 (defined in include/windef.h) to define the correct 'xxx' function
428 or type for Winelib. When compiling Wine itself, 'xxx' is _not_
429 defined, meaning that code inside of Wine must always specify
430 explicitly the ASCII or Unicode version.
432 If 'xxx' is the same in Win16 and Win32, you can simply use the same
433 name as Windows, i.e. just 'xxx'. If 'xxx' is Win16 only, you could
434 use the name as is, but it's preferable to use 'xxx16' to make it
435 clear it is a Win16 function.
437 Examples:
439 typedef struct { /* Win32 ASCII data structure */ } WNDCLASSA;
440 typedef struct { /* Win32 Unicode data structure */ } WNDCLASSW;
441 typedef struct { /* Win16 data structure */ } WNDCLASS16;
442 DECL_WINELIB_TYPE_AW(WNDCLASS);
444 ATOM RegisterClass16( WNDCLASS16 * );
445 ATOM RegisterClassA( WNDCLASSA * );
446 ATOM RegisterClassW( WNDCLASSW * );
447 #define RegisterClass WINELIB_NAME_AW(RegisterClass)
449 The Winelib user can then say:
451 WNDCLASS wc = { ... };
452 RegisterClass( &wc );
454 and this will use the correct declaration depending on the definition
455 of the UNICODE symbol.
458 NAMING CONVENTIONS FOR NON-API FUNCTIONS AND TYPES
459 ==================================================
461 Functions and data which are internal to your code (or at least shouldn't be
462 visible to any Winelib or Windows program) should be preceded by
463 an identifier to the module:
465 Examples:
467 ENUMPRINTERS_GetDWORDFromRegistryA() (in dlls/winspool/info.c)
468 IAVIFile_fnRelease() (in dlls/avifil32/avifile.c)
469 X11DRV_CreateDC() (in graphics/x11drv/init.c)
471 if you need prototypes for these, there are a few possibilities:
472 - within same source file only:
473 put the prototypes at the top of your file and mark them as prototypes.
474 - within the same module:
475 create a header file within the subdirectory where that module resides,
476 e.g. graphics/ddraw_private.h
477 - from a totally different module, or for use in winelib:
478 you should never do that. Only exported APIs can be called across
479 module boundaries.
482 DEBUG MESSAGES
483 ==============
485 To display a message only during debugging, you normally write something
486 like this:
488 TRACE("abc..."); or
489 FIXME("abc..."); or
490 WARN("abc..."); or
491 ERR("abc...");
493 depending on the seriousness of the problem. (documentation/degug-msgs
494 explains when it is appropriate to use each of them). You need to declare
495 the debug channel name at the top of the file (after the includes) using
496 the WINE_DEFAULT_DEBUG_CHANNEL macro, like so:
498 WINE_DEFAULT_DEBUG_CHANNEL(win);
500 If your debugging code is more complex than just printf, you can use
501 the macros:
503 TRACE_ON(xxx), WARN_ON(xxx), ERR_ON(xxx) and FIXME_ON(xxx)
505 to test if the given channel is enabled. Thus, you can write:
507 if (TRACE_ON(win)) DumpSomeStructure(&str);
509 Don't worry about the inefficiency of the test. If it is permanently
510 disabled (that is TRACE_ON(win) is 0 at compile time), the compiler will
511 eliminate the dead code.
513 For more info about debugging messages, read:
515 documentation/debug-msgs
518 MORE INFO
519 =========
521 1. There is a FREE online version of the MSDN library (including
522 documentation for the Win32 API) on http://msdn.microsoft.com/
523 or http://www.msdn.com/
525 2. Windows apilist: http://www.mentalis.org/apilist/apilist.php
527 3. http://www.sonic.net/~undoc/bookstore.html
529 4. In 1993 Dr. Dobbs Journal published a column called "Undocumented Corner".