DEVELOPERS-HINTS 20.5 KB
Newer Older
1 2
This document should help new developers get started. Like all of Wine, it
is a work in progress.
Alexandre Julliard's avatar
Alexandre Julliard committed
3

4

Alexandre Julliard's avatar
Alexandre Julliard committed
5 6 7
SOURCE TREE STRUCTURE
=====================

8 9 10
The Wine source tree is loosely based on the original Windows modules. 
Most of the source is concerned with implementing the Wine API, although
there are also various tools, documentation, sample Winelib code, and
11 12
code specific to the binary loader.  Note that several of the libraries
listed here are "stubbed out", meaning they still need to be implemented.
Alexandre Julliard's avatar
Alexandre Julliard committed
13

14 15
DLLs (under dlls/):
-------------------
Alexandre Julliard's avatar
Alexandre Julliard committed
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 23 24 25
	avicap32/		- AVI capture window class
	avifil32/		- COM object to play AVI files
	cabinet/		- Cabinet file interface
	capi2032/		- Wrapper library for CAPI4Linux access
26
	cards/                  - Card graphics
27 28 29 30 31 32
	cfgmgr32/		- Config manager
	comcat/			- Component category manager
	comctl32/		- Common controls
	commdlg/		- Common dialog boxes (both 16 & 32 bit)
	crtdll/			- Old C runtime library
	crypt32/		- Cryptography
33
	cryptdll/		- Cryptography Manager
34 35 36 37
	ctl3d/          	- 3D Effects for Common GUI Components
	d3d8/			- Direct3D (3D graphics)
	d3d9/			- Direct3D (3D graphics)
	d3dim/			- Direct3D Immediate Mode
38
	d3drm/			- Direct3D Retained Mode
39
	d3dx8/			- Direct3D (3D graphics)
Tom Wickline's avatar
Tom Wickline committed
40
	d3dxof/			- DirectX Files Functions
41
	dbghelp/                - Engine for symbol and module enumeration
42 43 44 45 46
	dciman32/		- DCI Manager (graphics)
	ddraw/			- DirectDraw (graphics)
	devenum/		- Device enumeration (part of DirectShow)
	dinput/			- DirectInput (device input)
	dinput8/		- DirectInput (device input)
47 48 49 50 51 52 53 54 55
	dmband/			- DirectMusic Band
	dmcompos/		- DirectMusic Composer
	dmime/			- DirectMusic Interactive Engine
	dmloader/		- DirectMusic Loader
	dmscript/		- DirectMusic Scripting
	dmstyle/		- DirectMusic Style Engine
	dmsynth/		- DirectMusic Software Synthesizer
	dmusic/			- DirectMusic Core Services
	dmusic32/		- DirectMusic Legacy Port
56 57
	dplay/			- DirectPlay (networking)
	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 64
	gdi/			- GDI (graphics)
	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 71 72
	imagehlp/		- PE (Portable Executable) Image Helper lib
	imm32/			- Input Method Manager
	iphlpapi/       	- IP Helper API
73
	itss/			- Infotech Structured Storage (HTML Help)
74 75 76
	kernel/			- The Windows kernel
	lzexpand/		- Lempel-Ziv compression/decompression
	mapi32/			- Mail interface
77
	midimap/		- MIDI mapper
Tom Wickline's avatar
Tom Wickline committed
78
	mlang/			- Multi Language Support
79 80
	mmdevldr.vxd/		- MMDEVLDR VxD implementation
	monodebg.vxd/		- MONODEBG VxD implementation
81 82
	mpr/			- Multi-Protocol Router (networking)
	msacm/			- Audio Compression Manager (multimedia)
83 84 85 86
	msacm/imaadp32/		- IMA ADPCM Audio Codec
	msacm/msadp32/		- MS ADPCM Audio Codec
	msacm/msg711/		- MS G711 Audio Codec (includes A-Law & MU-Law)
	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 92 93
	msimg32/		- Gradient and transparency (graphics)
	msisys/			- System information
	msnet32/		- Network interface
Tom Wickline's avatar
Tom Wickline committed
94
	msrle32/		- Video codecs
95 96
	msvcrt/			- C runtime library 
	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 101
	msvideo/		- 16 bit video manager
	mswsock/		- Misc networking
102
	msxml3/			- MSXML Class Factory
103
	netapi32/		- Network interface
104
	newdev/			- New Hardware Device Library
105
	ntdll/			- NT implementation of kernel calls
106
	objsel/			- Object Picker Dialog
107
	odbc32/			- Open DataBase Connectivity driver manager
108
	odbccp32/		- Open DataBase Connectivity driver installer
109
	ole32/			- 32 bit OLE 2.0 libraries
110
	oleacc/			- OLE accessibility support
111 112 113 114 115 116
	oleaut32/		- 32 bit OLE 2.0 automation
	olecli/			- 16 bit OLE client
	oledlg/			- OLE 2.0 user interface support
	olepro32/		- 32 bit OLE 2.0 automation
	olesvr/			- 16 bit OLE server
	opengl32/		- OpenGL implementation (graphics)
117
	powrprof/		- Power Management and Profiling
118 119 120 121
	psapi/			- Process Status interface
	qcap/			- DirectShow runtime
	quartz/			- DirectShow runtime
	rasapi32/		- Remote Access Server interface
122
	riched20/		- Rich text editing control version 2.0
123 124
	richedit/		- Rich text editing control
	rpcrt4/			- Remote Procedure Call runtime
125
	rsabase/		- RSA encryption
126
	rsaenh/			- Crypto API (DES, 3DES, RSA, etc.)
127
	secur32/                - Contains Windows Security functions
128
	sensapi/		- System Event Notification Service
129 130
	serialui/		- Serial port property pages
	setupapi/		- Setup interface
131
	sfc/			- System File Checker (Windows File Protection)
132 133
	shdocvw/		- Shell document object and control
	shell32/		- COM object implementing shell views
134
	shfolder/		- Shell folder service
135 136
	shlwapi/		- Shell Light-Weight interface
	snmpapi/		- SNMP protocol interface (networking)
137
	stdole2.tlb/		- OLE Automation typelib
138
	stdole32.tlb/		- Standard OLE typelib
139 140 141
	sti/			- Still Image service
	tapi32/			- Telephone interface
	twain/			- TWAIN Imaging device communications
142
	unicows/		- Unicows replacement (Unicode layer for Win9x)
143
	url/			- Internet shortcut shell extension
144
	urlmon/			- URL Moniker allows binding to a URL
145
	user/			- Window management, standard controls, etc.
146
	usp10/			- Uniscribe Script Processor
147
	uxtheme/		- Theme library
148
	vdhcp.vxd/		- VDHCP VxD implementation
Tom Wickline's avatar
Tom Wickline committed
149
	vdmdbg/			- Virtual DOS machine debug library
150
	version/		- File installation library
Dimitrie O. Paun's avatar
Dimitrie O. Paun committed
151
	vmm.vxd/		- VMM VxD implementation
152
	vnbt.vxd/               - VNBT VxD implementation
153 154 155
	vnetbios.vxd/		- VNETBIOS VxD implementation
	vtdapi.vxd/		- VTDAPI VxD implementation
	vwin32.vxd/		- VWIN32 VxD implementation
156 157
	win32s/			- 32-bit function access for 16-bit systems
	winaspi/		- 16 bit Advanced SCSI Peripheral Interface
158
	wined3d/		- Wine internal Direct3D helper
159
	winedos/		- DOS features and BIOS calls (Wine specific)
160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178
	wineps/			- Postscript driver (Wine specific)
	wininet/		- Internet extensions
	winmm/			- Multimedia (16 & 32 bit)
	winmm/joystick/		- Joystick driver
	winmm/mcianim/		- MCI animation driver
	winmm/mciavi/		- MCI video driver
	winmm/mcicda/		- MCI audio CD driver
	winmm/mciseq/		- MCI MIDI driver
	winmm/mciwave/		- MCI wave driver
	winmm/wavemap/		- Audio mapper
	winmm/winealsa/		- ALSA audio driver
	winmm/winearts/		- aRts audio driver
	winmm/wineaudioio/ 	- audioio audio driver
	winmm/winejack/		- JACK audio server driver
	winmm/winenas/		- NAS audio driver
	winmm/wineoss/		- OSS audio driver
	winnls/			- National Language Support
	winsock/		- Sockets 2.0 (networking)
	winspool/		- Printing & Print Spooler
179
	wintab32/		- Tablet device interface
180
	wintrust/		- Trust verification interface
Hans Leidekker's avatar
Hans Leidekker committed
181
	wldap32/		- LDAP support
182
	wow32/			- WOW subsystem
183
	wsock32/		- Sockets 1.1 (networking)
184
	wtsapi32/		- Terminal Services
185
	x11drv/			- X11 display driver (Wine specific)
186

187 188
Winelib programs (under programs/):
-----------------------------------
189

190 191 192 193 194
	avitools/		- AVI information viewer and player
	clock/			- Graphical clock
	cmdlgtst/		- Common dialog tests
	control/		- Control panel
	expand/			- Decompress Lempel-Ziv compressed archive
Mike McCormack's avatar
Mike McCormack committed
195
	msiexec/		- Microsoft Installer frontend
196
	notepad/		- Notepad replacement 
197 198 199 200 201 202
	progman/		- Program manager
	regedit/		- Registry editor
	regsvr32/		- Register COM server
	rpcss/			- RPC services
	rundll32/		- Execute DLL functions directly
	start/			- Replacement for start.exe
203
	taskmgr/		- Manage running Windows/Winelib applications
204 205 206 207 208 209 210 211 212 213 214 215 216 217 218
	uninstaller/		- Remove installed programs
	view/			- Metafile viewer
	wcmd/			- Command line interface
	wineboot/		- Wine bootstrap process
	winecfg/		- Wine configuration utility
	wineconsole/		- Console
	winedbg/		- Debugger
	winefile/		- File manager
	winemenubuilder/	- Helper program for building Unix menu entries
	winemine/		- Mine game
	winepath/		- Translate between Wine and Unix paths
	winetest/		- Wine testing shell
	winevdm/		- Wine virtual DOS machine
	winhelp/		- Help viewer
	winver/			- Windows Version Program
219 220 221 222


Support programs, libraries, etc:
---------------------------------
223

224 225
	dlls/dxerr8/		- DirectX 8 error import lib
	dlls/dxerr9/		- DirectX 9 error import lib
226
	dlls/dxguid/		- DirectX UUID import lib
227
	dlls/strmiids/		- Exports class CLSIDs and interface IIDs
228
	dlls/uuid/		- Windows-compatible UUID import lib
229 230
	documentation/		- some documentation
	include/		- Windows standard includes
231 232
	include/msvcrt/		- MSVC compatible libc headers
	include/wine/		- Wine specific headers
233
	libs/			- the Wine libraries
234 235 236 237
	libs/port/		- portability library
	libs/unicode/		- Unicode support shared
	libs/wine/		- Wine bootstrap library
	libs/wpp/		- C preprocessor
238
	loader/			- the main Wine loader
239
	server/			- the Wine server
240
	tools/			- various tools used to build/check Wine
241
	tools/widl/		- the IDL compiler
242
	tools/winapi/	- A Win32 API checker
243 244 245 246 247 248
	tools/winebuild/	- Wine build tool
	tools/winedump/		- a .DLL dump utility
	tools/winegcc/		- a MinGW command line compatible gcc wrapper
	tools/wmc/		- the message compiler
	tools/wpp/		- the C pre-processor library
	tools/wrc/		- the resource compiler
Alexandre Julliard's avatar
Alexandre Julliard committed
249 250


251

Alexandre Julliard's avatar
Alexandre Julliard committed
252 253 254
IMPLEMENTING NEW API CALLS
==========================

255 256
This is the simple version, and covers only Win32. Win16 is slightly
uglier, because of the Pascal heritage and the segmented memory model.
Alexandre Julliard's avatar
Alexandre Julliard committed
257

258 259 260
All of the Win32 APIs known to Wine are listed in the .spec file of
their corresponding dll. An unimplemented call will look like (from
gdi32.spec)
Alexandre Julliard's avatar
Alexandre Julliard committed
261 262 263 264
  269 stub PolyBezierTo
To implement this call, you need to do the following four things.

1. Find the appropriate parameters for the call, and add a prototype to
265 266
the correct header file. In this case, that means [include/wingdi.h],
and it might look like
267 268 269 270
  BOOL WINAPI PolyBezierTo(HDC, LPCVOID, DWORD);
If the function has both an ASCII and a Unicode version, you need to
define both and add a #define WINELIB_NAME_AW declaration. See below
for discussion of function naming conventions.
Alexandre Julliard's avatar
Alexandre Julliard committed
271 272 273 274 275 276 277
  
2. Modify the .spec file to tell Wine that the function has an
implementation, what the parameters look like and what Wine function
to use for the implementation. In Win32, things are simple--everything
is 32-bits. However, the relay code handles pointers and pointers to
strings slightly differently, so you should use 'str' and 'wstr' for
strings, 'ptr' for other pointer types, and 'long' for everything else.
278 279
  269 stdcall PolyBezierTo(long ptr long) PolyBezierTo
The 'PolyBezierTo' at the end of the line is which Wine function to use
Alexandre Julliard's avatar
Alexandre Julliard committed
280 281 282 283
for the implementation.

3. Implement the function as a stub. Once you add the function to the .spec
file, you must add the function to the Wine source before it will link.
284
Add a function called 'PolyBezierTo' somewhere. Good things to put
Alexandre Julliard's avatar
Alexandre Julliard committed
285 286 287
into a stub:
  o a correct prototype, including the WINAPI
  o header comments, including full documentation for the function and
288
    arguments (see documentation/README.documentation)
Alexandre Julliard's avatar
Alexandre Julliard committed
289 290 291 292
  o A FIXME message and an appropriate return value are good things to
    put in a stub.

  /************************************************************
293 294
   *                    PolyBezierTo   (GDI32.269)  
   *  
295
   * Draw many Bezier curves.
296
   *
297 298 299 300 301
   * PARAMS
   *   hdc   [I] Device context to draw to
   *   p     [I] Array of POINT structs
   *   count [I] Number of points in p
   *
302
   * RETURNS
303 304
   *   Success: Non-zero.
   *   Failure: FALSE. Use GetLastError() to find the error cause.
Alexandre Julliard's avatar
Alexandre Julliard committed
305 306 307 308
   *
   * BUGS
   *   Unimplemented
   */
309
   BOOL WINAPI PolyBezierTo(HDC hdc, LPCVOID p, DWORD count) 
310
   {
311
       /* tell the user they've got a substandard implementation */
312
       FIXME("(%x,%p,%d): stub\n", hdc, p, count);
313 314 315 316 317 318

       /* some programs may be able to compensate, 
        * if they know what happened 
        */
       SetLastError(ERROR_CALL_NOT_IMPLEMENTED);  
       return FALSE;    /* error value */
Alexandre Julliard's avatar
Alexandre Julliard committed
319 320
   }

321 322
4. Implement and test the rest of the function.

Alexandre Julliard's avatar
Alexandre Julliard committed
323

324 325 326
IMPLEMENTING A NEW DLL
======================

327 328 329
Generic directions
------------------

330 331 332 333
Apart from writing the set of needed .c files, you also need to do the 
following:

1.  Create a directory <MyDll> where to store the implementation of
334 335 336
    the DLL. This directory has to be put under the dlls/ directory.
    If the DLL exists under Windows as both 16 and 32 bit DLL, you
    should have a single directory with both implementations.
337 338 339

2.  Create the Makefile.in in the ./dlls/<MyDll>/ directory. You can
    copy an existing Makefile.in from another ./dlls/ subdirectory.
340
    You need at least to change the MODULE and C_SRCS macros. 
341

342 343
3.  Add the directory in ./configure.ac (in AC_OUTPUT macro at the end
    of the file to trigger the Makefile generation)
344

345 346
4.  Run ./make_dlls in the dlls directory to update Makefile.in in
    that directory.
347

348
5.  You can now regenerate ./configure file (with 'autoconf')
349 350
    and the various Makefiles (with 'configure; make depend') (run
    from the top of Wine's tree).
351
    You should now have a Makefile file in ./dlls/<MyDll>/
352

353
6.  Create the .spec file for the DLL exported functions in your
354 355 356
    directory. Refer to 'Implementation of new API calls' earlier in
    this document for more information on this part.

357 358 359 360
7.  You can now start adding .c files. For the .h files, if they are
    standard Windows one, put them in include/. If they are linked to
    *your* implementation of the dll, put them in your newly created
    directory.
361

362 363 364
Debug channels
--------------

365
If you need to create a new debug channel, just add the
366 367
WINE_DEFAULT_DEBUG_CHANNEL to your .c file(s), and use them. 
All the housekeeping will happen automatically.
368

369 370 371
Resources
---------

372
If you also need to add resources to your DLL, then create the .rc
373 374 375
file. Add to your ./dlls/<MyDll>/Makefile.in, in the RC_SRCS macro,
the list of .rc files to add to the DLL. See dlls/comctl32/ for an
example of this.
376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392

Thunking
--------

If you're building a 16 & 32 bit DLLs pair, then from the 32 bit code
you might need to call 16 bit routine. The way to do it to add in the
code, fragments like:
/* ### Start build ### */
extern WORD CALLBACK <PREFIX>_CallTo16_word_wwlll(FARPROC16,WORD,WORD,LONG,LONG,LONG);
/* ### stop build ### */
Where <PREFIX>_ is an internal prefix for your module. The first
parameter is always of type FARPROC16. Then, you can get the regular
list of parameters. The _word_wwlll indicates the type of return (long
or word) and the size of the parameters (here l=>long, w=>word; which
maps to WORD,WORD,LONG,LONG,LONG.
You can put several functions between the Start/Stop build pair.

393 394 395
You can also read the winebuild manpage for more details on this.

Then, add to ./dlls/<MyDll>/Makefile.in a line like:
396

397
EXTRA_OBJS = $(MODULE).glue.o
398 399 400

See dlls/winmm/ for an example of this.

Alexandre Julliard's avatar
Alexandre Julliard committed
401 402
MEMORY AND SEGMENTS
===================
Alexandre Julliard's avatar
Alexandre Julliard committed
403 404

NE (Win16) executables consist of multiple segments.  The Wine loader
Alexandre Julliard's avatar
Alexandre Julliard committed
405 406 407 408 409 410
loads each segment into a unique location in the Wine processes memory
and assigns a selector to that segment.  Because of this, it's not
possible to exchange addresses freely between 16-bit and 32-bit code.
Addresses used by 16-bit code are segmented addresses (16:16), formed
by a 16-bit selector and a 16-bit offset.  Those used by the Wine code
are regular 32-bit linear addresses.
Alexandre Julliard's avatar
Alexandre Julliard committed
411

Alexandre Julliard's avatar
Alexandre Julliard committed
412
There are four ways to obtain a segmented pointer:
413
  - Using the MapLS function (recommended).
Alexandre Julliard's avatar
Alexandre Julliard committed
414 415 416 417
  - Allocate a block of memory from the global heap and use
    WIN16_GlobalLock to get its segmented address.
  - Declare the argument as 'segptr' instead of 'ptr' in the spec file
    for a given API function.
Alexandre Julliard's avatar
Alexandre Julliard committed
418

Alexandre Julliard's avatar
Alexandre Julliard committed
419 420
Once you have a segmented pointer, it must be converted to a linear
pointer before you can use it from 32-bit code.  This can be done with
421 422 423 424
the MapSL function.  The linear pointer can then be used freely with
standard Unix functions like memcpy() etc. without worrying about 64k
boundaries.  Note: there's no easy way to convert back from a linear
to a segmented address.
Alexandre Julliard's avatar
Alexandre Julliard committed
425

Alexandre Julliard's avatar
Alexandre Julliard committed
426 427 428 429 430 431 432 433
In most cases, you don't need to worry about segmented address, as the
conversion is made automatically by the callback code and the API
functions only see linear addresses. However, in some cases it is
necessary to manipulate segmented addresses; the most frequent cases
are:
  - API functions that return a pointer
  - lParam of Windows messages that point to a structure
  - Pointers contained inside structures accessed by 16-bit code.
Alexandre Julliard's avatar
Alexandre Julliard committed
434

Alexandre Julliard's avatar
Alexandre Julliard committed
435 436 437 438
It is usually a good practice to used the type 'SEGPTR' for segmented
pointers, instead of something like 'LPSTR' or 'char *'.  As SEGPTR is
defined as a DWORD, you'll get a compilation warning if you mistakenly
use it as a regular 32-bit pointer.
Alexandre Julliard's avatar
Alexandre Julliard committed
439

Alexandre Julliard's avatar
Alexandre Julliard committed
440

Alexandre Julliard's avatar
Alexandre Julliard committed
441 442 443 444 445 446 447 448 449 450 451 452
STRUCTURE PACKING
=================

Under Windows, data structures are tightly packed, i.e. there is no
padding between structure members. On the other hand, by default gcc
aligns structure members (e.g. WORDs are on a WORD boundary, etc.).
This means that a structure like

struct { BYTE x; WORD y; };

will take 3 bytes under Windows, but 4 with gcc, because gcc will add a
dummy byte between x and y. To have the correct layout for structures
453 454 455 456
used by Windows code, you need to embed the struct within two special
#include's which will take care of the packing for you:

#include "pshpack1.h"
457
struct { BYTE x; WORD y; };
458 459 460 461
#include "poppack1.h"

For alignment on a 2-byte boundary, there is a "pshpack2.h", etc.

Alexandre Julliard's avatar
Alexandre Julliard committed
462

Alexandre Julliard's avatar
Alexandre Julliard committed
463 464 465 466
NAMING CONVENTIONS FOR API FUNCTIONS AND TYPES
==============================================

In order to support both Win16 and Win32 APIs within the same source
467
code, the following convention must be used in naming all API
Alexandre Julliard's avatar
Alexandre Julliard committed
468 469 470
functions and types. If the Windows API uses the name 'xxx', the Wine
code must use:

471
 - 'xxx16' for the Win16 version,
472
 - 'xxx'   for the Win32 version when no strings are involved,
473 474
 - 'xxxA'  for the Win32 version with ASCII strings,
 - 'xxxW'  for the Win32 version with Unicode strings.
Alexandre Julliard's avatar
Alexandre Julliard committed
475

476 477
If the function has both ASCII and Unicode version, you should then
use the macros WINELIB_NAME_AW(xxx) or DECL_WINELIB_TYPE_AW(xxx)
478
(defined in include/windef.h) to define the correct 'xxx' function
479 480 481
or type for Winelib. When compiling Wine itself, 'xxx' is _not_
defined, meaning that code inside of Wine must always specify
explicitly the ASCII or Unicode version.
Alexandre Julliard's avatar
Alexandre Julliard committed
482

483 484 485 486
If 'xxx' is the same in Win16 and Win32, you can simply use the same
name as Windows, i.e. just 'xxx'.  If 'xxx' is Win16 only, you could
use the name as is, but it's preferable to use 'xxx16' to make it
clear it is a Win16 function.
Alexandre Julliard's avatar
Alexandre Julliard committed
487 488 489

Examples:

490 491
typedef struct { /* Win32 ASCII data structure */ } WNDCLASSA;
typedef struct { /* Win32 Unicode data structure */ } WNDCLASSW;
Alexandre Julliard's avatar
Alexandre Julliard committed
492 493 494 495
typedef struct { /* Win16 data structure */ } WNDCLASS16;
DECL_WINELIB_TYPE_AW(WNDCLASS);

ATOM RegisterClass16( WNDCLASS16 * );
496 497
ATOM RegisterClassA( WNDCLASSA * );
ATOM RegisterClassW( WNDCLASSW * );
Alexandre Julliard's avatar
Alexandre Julliard committed
498 499 500 501 502 503 504 505
#define RegisterClass WINELIB_NAME_AW(RegisterClass)

The Winelib user can then say:

    WNDCLASS wc = { ... };
    RegisterClass( &wc );

and this will use the correct declaration depending on the definition
506
of the UNICODE symbol.
Alexandre Julliard's avatar
Alexandre Julliard committed
507 508 509 510


DEBUG MESSAGES
==============
Alexandre Julliard's avatar
Alexandre Julliard committed
511 512 513 514

To display a message only during debugging, you normally write something
like this:

515 516 517 518
        TRACE("abc...");  or
        FIXME("abc...");  or
        WARN("abc...");   or
        ERR("abc...");
Alexandre Julliard's avatar
Alexandre Julliard committed
519

520
depending on the seriousness of the problem. (documentation/debugging.sgml
521 522 523 524 525 526 527 528 529 530 531 532 533 534
explains when it is appropriate to use each of them). You need to declare
the debug channel name at the top of the file (after the includes) using
the WINE_DEFAULT_DEBUG_CHANNEL macro, like so:

	WINE_DEFAULT_DEBUG_CHANNEL(win);

If your debugging code is more complex than just printf, you can use 
the macros:

	TRACE_ON(xxx), WARN_ON(xxx), ERR_ON(xxx) and FIXME_ON(xxx) 

to test if the given channel is enabled. Thus, you can write:

	if (TRACE_ON(win)) DumpSomeStructure(&str);
Alexandre Julliard's avatar
Alexandre Julliard committed
535

Alexandre Julliard's avatar
Alexandre Julliard committed
536
Don't worry about the inefficiency of the test. If it is permanently 
Alexandre Julliard's avatar
Alexandre Julliard committed
537
disabled (that is TRACE_ON(win) is 0 at compile time), the compiler will 
Alexandre Julliard's avatar
Alexandre Julliard committed
538
eliminate the dead code.
Alexandre Julliard's avatar
Alexandre Julliard committed
539

Alexandre Julliard's avatar
Alexandre Julliard committed
540 541
For more info about debugging messages, read:

542
http://www.winehq.org/site/docs/wine-devel/debugging
Alexandre Julliard's avatar
Alexandre Julliard committed
543

Alexandre Julliard's avatar
Alexandre Julliard committed
544 545 546 547

MORE INFO
=========

Alexandre Julliard's avatar
Alexandre Julliard committed
548
1. There is a FREE online version of the MSDN library (including
549
   documentation for the Win32 API) on http://msdn.microsoft.com/
550
   or http://www.msdn.com/
Alexandre Julliard's avatar
Alexandre Julliard committed
551

Tom Wickline's avatar
Tom Wickline committed
552 553 554 555 556
2. Windows apilist:  http://www.mentalis.org/apilist/apilist.php

3. http://www.sonic.net/~undoc/bookstore.html

4. In 1993 Dr. Dobbs Journal published a column called "Undocumented Corner".
557 558

5. www.geocities.com/SiliconValley/4942/