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