| blob | 3949fd64e7ccc01cf559b39da63970cb4947fb2b |
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 d3dx8/ - Direct3D (3D graphics)
30 dciman32/ - DCI Manager (graphics)
31 ddraw/ - DirectDraw (graphics)
32 devenum/ - Device enumeration
33 dinput/ - DirectInput (device input)
34 dinput8/ - DirectInput (device input)
35 dplay/ - DirectPlay (networking)
36 dplayx/ - DirectPlay (networking)
37 dsound/ - DirectSound (audio)
38 gdi/ - GDI (graphics)
39 enhmetafiledrv/ - Enhanced metafile driver
40 metafiledrv/ - Metafile driver
41 win16drv/ - Support for Win16 printer drivers
42 glu32/ - OpenGL Utility library (graphics)
43 icmp/ - ICMP protocol (networking)
44 imagehlp/ - PE (Portable Executable) Image Helper lib
45 imm32/ - Input Method Manager
46 iphlpapi/ - IP Helper API
47 kernel/ - The Windows kernel
48 lzexpand/ - Lempel-Ziv compression/decompression
49 mapi32/ - Mail interface
50 mpr/ - Multi-Protocol Router (networking)
51 msacm/ - Audio Compression Manager (multimedia)
52 msdmo/ - DirectX Media Objects
53 msimg32/ - Gradient and transparency (graphics)
54 msisys/ - System information
55 msnet32/ - Network interface
56 msrle32/ - Run length encoder
57 msvcrt/ - 16 bit C runtime library
58 msvcrt20/ - 32 bit C runtime library
59 msvideo/ - 16 bit video manager
60 netapi32/ - Network interface
61 ntdll/ - NT implementation of kernel calls
62 odbc32/ - Open DataBase Connectivity driver manager
63 ole32/ - 32 bit OLE 2.0 libraries
64 oleaut32/ - 32 bit OLE 2.0 automation
65 olecli/ - 16 bit OLE client
66 oledlg/ - OLE 2.0 user interface support
67 olepro32/ - 32 bit OLE 2.0 automation
68 olesvr/ - 16 bit OLE server
69 opengl32/ - OpenGL implementation (graphics)
70 psapi/ - Process Status interface
71 qcap/ - DirectShow runtime
72 quartz/ - DirectShow runtime
73 rasapi32/ - Remote Access Server interface
74 richedit/ - Rich text formatting
75 rpcrt4/ - Remote Procedure Call runtime
76 serialui/ - Serial port property pages
77 setupapi/ - Setup interface
78 shdocvw/ - Shell document object and control
79 shfolder/ - Shell folder service
80 shell32/ - COM object implementing shell views
81 shlwapi/ - Shell Light-Weight interface
82 snmpapi/ - SNMP protocol interface (networking)
83 sti/ - Still Image service
84 tapi32/ - Telephone interface
85 ttydrv/ - TTY display driver (Wine specific)
86 twain/ - TWAIN Imaging device communications
87 url/ - Internet shortcut shell extension
88 urlmon/ - URL Moniker allows binding to a URL
89 user/ - Window management, standard controls, etc.
90 version/ - File installation library
91 win32s/ - 32-bit function access for 16-bit systems
92 winaspi/ - 16 bit Advanced SCSI Peripheral Interface
93 winedos/ - DOS features and BIOS calls (interrupts)
94 wineps/ - Postscript driver (Wine specific)
95 wininet/ - Internet extensions
96 winmm/ - Multimedia (16 & 32 bit)
97 mciXXX/ - Various MCI drivers
98 midimap/ - MIDI mapper
99 wavemap/ - Audio mapper
100 winealsa/ - ALSA audio driver
101 winearts/ - aRts audio driver
102 winejack/ - JACK audio server driver
103 wineoss/ - OSS audio driver
104 winnls/ - National Language Support
105 winsock/ - Sockets 2.0 (networking)
106 wsock32/ - Sockets 1.1 (networking)
107 wintab32/ - Tablet device interface
108 winspool/ - Printing & Print Spooler
109 wintrust/ - Trust verification interface
110 wow32/ - WOW subsystem
111 x11drv/ - X11 display driver (Wine specific)
113 Winelib programs:
114 -----------------
116 programs/ - All the Winelib programs
118 avitools/ - AVI information viewer and player
119 clock/ - Graphical clock
120 cmdlgtst/ - Common dialog tests
121 control/ - Control panel
122 expand/ - Decompress Lempel-Ziv compressed archive
123 notepad/ - Notepad with RichEdit functionality
124 osversioncheck/ - Check version of Windows being indicated
125 progman/ - Program manager
126 regapi/ - Command line Registry implementation
127 regedit/ - Registry editor
128 regsvr32/ - Register COM server
129 regtest/ - Registry testing program
130 rpcss/ - RPC services
131 rundll32/ - Execute DLL functions directly
132 uninstaller/ - Remove installed programs
133 view/ - Metafile viewer
134 wcmd/ - Command line interface
135 wineconsole/ - Console
136 winedbg/ - Debugger
137 winefile/ - File manager
138 winemine/ - Mine game
139 winepath/ - Translate between Wine and Unix paths
140 winhelp/ - Help viewer
141 winver/ - Windows Version Program
144 Support programs, libraries, etc:
145 ---------------------------------
147 documentation/ - some documentation
148 include/ - Windows standard includes
149 library/ - the Wine portability library
150 miscemu/ - the main Wine program
151 server/ - the Wine server
152 tools/ - relay code builder, resource compiler, 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 * Success: Non-zero.
227 * Failure: FALSE. Use GetLastError() to find the error cause.
228 *
229 * BUGS
230 * Unimplemented
231 */
232 BOOL WINAPI PolyBezierTo(HDC hdc, /* [In] Device context to draw to */
233 LPCVOID p, /* [In] Array of POINT structs */
234 DWORD count /* [In] Number of points in p */
235 )
236 {
237 /* tell the user they've got a substandard implementation */
238 FIXME(gdi, ":(%x,%p,%d): stub\n", hdc, p, count);
240 /* some programs may be able to compensate,
241 * if they know what happened
242 */
243 SetLastError(ERROR_CALL_NOT_IMPLEMENTED);
244 return FALSE; /* error value */
245 }
247 4. Implement and test the rest of the function.
250 IMPLEMENTING A NEW DLL
251 ======================
253 Generic directions
254 ------------------
256 Apart from writing the set of needed .c files, you also need to do the
257 following:
259 1. Create a directory <MyDll> where to store the implementation of
260 the DLL. This directory has to be put under the dlls/ directory.
261 If the DLL exists under Windows as both 16 and 32 bit DLL, you
262 should have a single directory with both implementations.
264 2. Create the Makefile.in in the ./dlls/<MyDll>/ directory. You can
265 copy an existing Makefile.in from another ./dlls/ subdirectory.
266 You need at least to change the MODULE and C_SRCS macros.
268 3. Add the directory in ./configure.ac (in AC_OUTPUT macro at the end
269 of the file to trigger the Makefile generation)
271 4. Run ./make_dlls in the dlls directory to update Makefile.in in
272 that directory.
274 5. You can now regenerate ./configure file (with 'make configure')
275 and the various Makefiles (with 'configure; make depend') (run
276 from the top of Wine's tree).
277 You should now have a Makefile file in ./dlls/<MyDll>/
279 6. Create the .spec file for the DLL exported functions in your
280 directory. Refer to 'Implementation of new API calls' earlier in
281 this document for more information on this part.
283 7. You can now start adding .c files. For the .h files, if they are
284 standard Windows one, put them in include/. If they are linked to
285 *your* implementation of the dll, put them in your newly created
286 directory.
288 Debug channels
289 --------------
291 If you need to create a new debug channel, just add the
292 WINE_DEFAULT_DEBUG_CHANNEL to your .c file(s), and use them.
293 All the housekeeping will happen automatically.
295 Resources
296 ---------
298 If you also need to add resources to your DLL, then create the .rc
299 file. Add to your ./dlls/<MyDll>/Makefile.in, in the RC_SRCS macro,
300 the list of .rc files to add to the DLL. See dlls/comctl32/ for an
301 example of this.
303 Thunking
304 --------
306 If you're building a 16 & 32 bit DLLs pair, then from the 32 bit code
307 you might need to call 16 bit routine. The way to do it to add in the
308 code, fragments like:
309 /* ### Start build ### */
310 extern WORD CALLBACK <PREFIX>_CallTo16_word_wwlll(FARPROC16,WORD,WORD,LONG,LONG,LONG);
311 /* ### stop build ### */
312 Where <PREFIX>_ is an internal prefix for your module. The first
313 parameter is always of type FARPROC16. Then, you can get the regular
314 list of parameters. The _word_wwlll indicates the type of return (long
315 or word) and the size of the parameters (here l=>long, w=>word; which
316 maps to WORD,WORD,LONG,LONG,LONG.
317 You can put several functions between the Start/Stop build pair.
319 You can also read the winebuild manpage for more details on this.
321 Then, add to ./dlls/<MyDll>/Makefile.in a line like:
323 EXTRA_OBJS = $(MODULE).glue.o
325 See dlls/winmm/ for an example of this.
327 MEMORY AND SEGMENTS
328 ===================
330 NE (Win16) executables consist of multiple segments. The Wine loader
331 loads each segment into a unique location in the Wine processes memory
332 and assigns a selector to that segment. Because of this, it's not
333 possible to exchange addresses freely between 16-bit and 32-bit code.
334 Addresses used by 16-bit code are segmented addresses (16:16), formed
335 by a 16-bit selector and a 16-bit offset. Those used by the Wine code
336 are regular 32-bit linear addresses.
338 There are four ways to obtain a segmented pointer:
339 - Using the MapLS function (recommended).
340 - Allocate a block of memory from the global heap and use
341 WIN16_GlobalLock to get its segmented address.
342 - Declare the argument as 'segptr' instead of 'ptr' in the spec file
343 for a given API function.
345 Once you have a segmented pointer, it must be converted to a linear
346 pointer before you can use it from 32-bit code. This can be done with
347 the MapSL function. The linear pointer can then be used freely with
348 standard Unix functions like memcpy() etc. without worrying about 64k
349 boundaries. Note: there's no easy way to convert back from a linear
350 to a segmented address.
352 In most cases, you don't need to worry about segmented address, as the
353 conversion is made automatically by the callback code and the API
354 functions only see linear addresses. However, in some cases it is
355 necessary to manipulate segmented addresses; the most frequent cases
356 are:
357 - API functions that return a pointer
358 - lParam of Windows messages that point to a structure
359 - Pointers contained inside structures accessed by 16-bit code.
361 It is usually a good practice to used the type 'SEGPTR' for segmented
362 pointers, instead of something like 'LPSTR' or 'char *'. As SEGPTR is
363 defined as a DWORD, you'll get a compilation warning if you mistakenly
364 use it as a regular 32-bit pointer.
367 STRUCTURE PACKING
368 =================
370 Under Windows, data structures are tightly packed, i.e. there is no
371 padding between structure members. On the other hand, by default gcc
372 aligns structure members (e.g. WORDs are on a WORD boundary, etc.).
373 This means that a structure like
375 struct { BYTE x; WORD y; };
377 will take 3 bytes under Windows, but 4 with gcc, because gcc will add a
378 dummy byte between x and y. To have the correct layout for structures
379 used by Windows code, you need to embed the struct within two special
380 #include's which will take care of the packing for you:
382 #include "pshpack1.h"
383 struct { BYTE x; WORD y; };
384 #include "poppack1.h"
386 For alignment on a 2-byte boundary, there is a "pshpack2.h", etc.
388 The use of the WINE_PACKED attribute is obsolete. Please remove these
389 in favour of the above solution.
390 Using WINE_PACKED, you would declare the above structure like this:
392 struct { BYTE x; WORD y WINE_PACKED; };
394 You had to do this every time a structure member is not aligned
395 correctly under Windows (i.e. a WORD not on an even address, or a
396 DWORD on a address that was not a multiple of 4).
399 NAMING CONVENTIONS FOR API FUNCTIONS AND TYPES
400 ==============================================
402 In order to support both Win16 and Win32 APIs within the same source
403 code, the following convention must be used in naming all API
404 functions and types. If the Windows API uses the name 'xxx', the Wine
405 code must use:
407 - 'xxx16' for the Win16 version,
408 - 'xxx' for the Win32 version when no ASCII/Unicode strings are
409 involved,
410 - 'xxxA' for the Win32 version with ASCII strings,
411 - 'xxxW' for the Win32 version with Unicode strings.
413 If the function has both ASCII and Unicode version, you should then
414 use the macros WINELIB_NAME_AW(xxx) or DECL_WINELIB_TYPE_AW(xxx)
415 (defined in include/windef.h) to define the correct 'xxx' function
416 or type for Winelib. When compiling Wine itself, 'xxx' is _not_
417 defined, meaning that code inside of Wine must always specify
418 explicitly the ASCII or Unicode version.
420 If 'xxx' is the same in Win16 and Win32, you can simply use the same
421 name as Windows, i.e. just 'xxx'. If 'xxx' is Win16 only, you could
422 use the name as is, but it's preferable to use 'xxx16' to make it
423 clear it is a Win16 function.
425 Examples:
427 typedef struct { /* Win32 ASCII data structure */ } WNDCLASSA;
428 typedef struct { /* Win32 Unicode data structure */ } WNDCLASSW;
429 typedef struct { /* Win16 data structure */ } WNDCLASS16;
430 DECL_WINELIB_TYPE_AW(WNDCLASS);
432 ATOM RegisterClass16( WNDCLASS16 * );
433 ATOM RegisterClassA( WNDCLASSA * );
434 ATOM RegisterClassW( WNDCLASSW * );
435 #define RegisterClass WINELIB_NAME_AW(RegisterClass)
437 The Winelib user can then say:
439 WNDCLASS wc = { ... };
440 RegisterClass( &wc );
442 and this will use the correct declaration depending on the definition
443 of the UNICODE symbol.
446 NAMING CONVENTIONS FOR NON-API FUNCTIONS AND TYPES
447 ==================================================
449 Functions and data which are internal to your code (or at least shouldn't be
450 visible to any Winelib or Windows program) should be preceded by
451 an identifier to the module:
453 Examples:
455 ENUMPRINTERS_GetDWORDFromRegistryA() (in dlls/winspool/info.c)
456 IAVIFile_fnRelease() (in dlls/avifil32/avifile.c)
457 X11DRV_CreateDC() (in graphics/x11drv/init.c)
459 if you need prototypes for these, there are a few possibilities:
460 - within same source file only:
461 put the prototypes at the top of your file and mark them as prototypes.
462 - within the same module:
463 create a header file within the subdirectory where that module resides,
464 e.g. graphics/ddraw_private.h
465 - from a totally different module, or for use in winelib:
466 you should never do that. Only exported APIs can be called across
467 module boundaries.
470 DEBUG MESSAGES
471 ==============
473 To display a message only during debugging, you normally write something
474 like this:
476 TRACE("abc..."); or
477 FIXME("abc..."); or
478 WARN("abc..."); or
479 ERR("abc...");
481 depending on the seriousness of the problem. (documentation/degug-msgs
482 explains when it is appropriate to use each of them). You need to declare
483 the debug channel name at the top of the file (after the includes) using
484 the WINE_DEFAULT_DEBUG_CHANNEL macro, like so:
486 WINE_DEFAULT_DEBUG_CHANNEL(win);
488 If your debugging code is more complex than just printf, you can use
489 the macros:
491 TRACE_ON(xxx), WARN_ON(xxx), ERR_ON(xxx) and FIXME_ON(xxx)
493 to test if the given channel is enabled. Thus, you can write:
495 if (TRACE_ON(win)) DumpSomeStructure(&str);
497 Don't worry about the inefficiency of the test. If it is permanently
498 disabled (that is TRACE_ON(win) is 0 at compile time), the compiler will
499 eliminate the dead code.
501 For more info about debugging messages, read:
503 documentation/debug-msgs
506 MORE INFO
507 =========
509 1. There is a FREE online version of the MSDN library (including
510 documentation for the Win32 API) on http://msdn.microsoft.com/
512 2. Windows apilist: http://www.mentalis.org/apilist/apilist.php
514 3. http://www.sonic.net/~undoc/bookstore.html
516 4. In 1993 Dr. Dobbs Journal published a column called "Undocumented Corner".