Release 971221
Fri Dec 19 10:50:46 1997 Douglas Ridgway <ridgway@winehq.com>
* [Make.rules.in] [Makefile.in] [documentation/Makefile.in]
[documentation/README.documentation]
First cut at Wine API documentation. No longer install reference
manual by default.
Wed Dec 17 21:32:23 1997 Andreas Mohr <100.30936@germany.net>
* [files/file.c]
Fixed GetTempFileName16() to use current path of requested drive
as needed.
* [if1632/Makefile.in] [if1632/builtin.c] [if1632/dciman32.spec]
[if1632/msvfw32.spec] [if1632/tapi32.spec] [if1632/wow32.spec]
Added misc DLLs needed by various apps.
Wed Dec 17 12:01:50 1997 Morten Eriksen <mortene@sim.no>
* [if1632/gdi32.spec] [include/windows.h] [objects/palette.c]
Inserted empty stub for CreateHalftonePalette.
Tue Dec 16 22:08:06 1997 Huw D M Davies <h.davies1@physics.oxford.ac.uk>
* [windows/mdi.c]
Use VK_TAB instead of VK_SEPARATOR in TranslateMDISysAccel().
* [graphics/metafiledrv/init.c]
DeleteDC() on a MetaDC doesn't do anything - it shouldn't. Therefore
fix cleanup of MetaDCs in CloseMetaFile(); they now actually get
removed from the GDI heap!
* [graphics/x11drv/xfont.c]
Preserve FO_MATCH_XYINDEP flag in XFONT_MatchFIList(). Should reduce
the number of bold-italic matches.
Tue Dec 16 20:11:43 1997 Bertho Stultiens <bertho@panter.soci.aau.dk>
* [graphics/painting.c]
Included an implementation of DrawState
* [if1632/thunk.c]
Changed many fprintfs into dprintf_thunk
* [include/cache.h] [graphics/cache.c]
New files to hold cached handles to regulary used GDI object.
* [include/windows.h]
Added DRAWSTATExx typedefs
Added DSS_DEFAULT define for DrawState
* [objects/text.c]
New implementation of GrayString()
* [controls/uitools.c]
Implemented DrawFrameControl() functions
Changed DrawEdge() behaviour to win95 implementation
Mon Dec 15 23:43:01 1997 Martin Boehme <boehme@informatik.mu-luebeck.de>
* [graphics/path.c] [include/path.h] [graphics/painting.c]
[if1632/gdi32.spec] [include/gdi.h] [include/windows.h]
[objects/dc.c]
Added preliminary support for GDI paths.
* [objects/dc.c]
Added DC_Init_DC_INFO function for initializing WIN_DC_INFO
structure.
* [include/windows.h] [include/gdi.h] [objects/gdiobj.c]
Added DEFAULT_GUI_FONT.
* [include/winerror.h]
Added a few error codes.
* [memory/heap.c]
Changed HeapAlloc to make the correct calls to SetLastError
(now conforms to NT's behaviour).
* [windows/win.c]
Changed WIN_CreateWindowEx to allow child windows with zero
width / height.
Sun Dec 14 12:01:07 1997 Alexandre Julliard <julliard@lrc.epfl.ch>
* [if1632/*] [relay32/*]
Moved all 32-bit relay stuff to relay32/
* [fi1632/thunk.c] [win32/kernel32.c]
Moved all KERNEL32 ordinal functions to kernel32.c
* [memory/selector.c]
Initialize selectors in AllocSelectorArray.
* [tools/build.c]
Generate C instead of assembly for Win32 relays.
Fixed stack corruption in CallTo16 functions, found by Bertho
Stultiens.
Sun Dec 14 10:55:00 1997 Andreas Mohr <100.30936@germany.net>
* [if1632/Makefile.in] [if1632/builtin.c] [if1632/ole2thk.spec]
Added built-in OLE2THK.DLL.
* [if1632/toolhelp.spec] [include/toolhelp.h] [memory/selector.c]
[misc/toolhelp.c]
Added stubs for StackTraceFirst(), StackTraceCSIPFirst(),
StackTraceNext(), UTSelectorOffsetToLinear()
and UTLinearToSelectorOffset().
Sat Dec 13 17:26:41 1997 Alex Korobka <alex@trantor.pharm.sunysb.edu>
* [misc/winsock.c]
32-bit API fixes for reported problems (thanks to Marcus
and David).
* [graphics/x11drv/xfont.c]
Little tweak in point size calculation.
* [windows/defwnd.c] [windows/dce.c] [windows/winhelp.c]
[windows/winproc.c] [windows/win.c]
Bug fixes.
Sat Dec 13 16:35:14 1997 Kai Morich <kai.morich@rhein-neckar.netsurf.de>
* [files/dos_fs.c]
OpenFile with empty filename and OF_PARSE returns current dir.
* [misc/commdlg.c]
Ignore initial dir if bogus.
* [files/file.c]
Locking an identic region in a file must not be an error.
* [misc/lstr.c]
Use wide char ctype functions.
Fri Dec 12 23:46:22 1997 Uwe Bonnes <bon@elektron.ikp.physik.tu-darmstadt.de>
* [file/drive.c]
First attempt for GetDiskFreeSpaceEx.
Fri Dec 12 23:18:41 1997 Marcus Meissner <msmeissn@cip.informatik.uni-erlangen.de>
* [loader/pe_resource.c]
Fixed wrongly appearing menus problem (only use default lookups in
last resource subtree).
* [multimedia/*.c]
Added win32 support for time* and joy* lowlevel drivers,
(not excessively tested), some misc fixes and cleanups.
* [misc/shellord.c][misc/shell.c][ole/folders.c][ole/ifs.c]
[include/interfaces.h][include/shlobj.h]
Added some more undocumented SHELL32 functions, some shell folder
interface stubs added, SHGetMalloc, SHGetDesktopFolder,
SHGetSpecialFolderLocation, SHGetPathFromIDList stubs added,
IMalloc, IUnknown implemented.
* [windows/msgbox.c]
Implemented MessageBoxIndirect*, some internal changes.
* [if1632/thunk.c]
KERNEL_431 implemented.
* [objects/gdiobj.c]
GetCurrentObject implemented.
Wed Dec 3 01:09:17 1997 Gordon Chaffee <chaffee@apu.cs.berkeley.edu>
* [objects/dib.c]
Fix a couple small DIB problems.
* [controls/edit.c]
Fix a typo.
* [files/dos_fs.c]
Try normal readdir in case fs is specified as vfat but isn't.
* [files/profile.c]
Implementation of WritePrivateProfileSection32A from Uwe Bonnes.
* [misc/printdrv.c]
OpenPrinter32A stub, helps Word97 start.
* [objects/text.c]
Fixup implementation of GetTextCharsetInfo.
* [scheduler/process.c]
Fix environment variable expansion.
* [win32/code_page.c]
Make MultiByteToWideChar and WideCharToMultiByte conform in return
values and error conditions to those in Windows NT 4.0.
* [windows/message.c]
Fix broadcasting problems in Win32. The Win32 docs say to use
HWND_TOPMOST to broadcast to all Win32 Windows.
* [memory/virtual.c] [loader/pe_image.c]
Do not map in VirtualAlloc if address is specified and space is
not available. This is required by Win32.
* [include/pen.h] [include/x11drv.h] [objects/dc.c]
[objects/pen.c] [graphics/x11drv/pen.c]
Support for ExtCreatePen.
Tue Dec 2 20:22:06 1997 Morten Welinder <terra@diku.dk>
* [*/*.c] [*/*.h]
Add lots of prototypes.
* [if1632/kernel32.spec][include/windows.h][include/winnt.h]
[misc/cpu.c]
Define IsProcessorFeaturePresent.
* [misc/crtdll.c]
(CRTDLL__getcwd): Allocate enough memory for the terminating zero.
* [misc/ver.c]
Improve check for null component in _find_data[AW]. Plug leaks
in VerQueryValue*.
* [win32/console.c][if1632/kernel32.spec]
Add stubs for GetConsoleCursorInfo32, SetConsoleCursorInfo32.
* [windows/message.c][if1632/user32.spec][include/windows.h]
Define SendMessageTimeout*.
* [graphics/x11drv/xfont.c]
Change algorithm of __genericCheckSum to be alignment safe.
* [misc/main.c] [misc/winsock.c] [misc/winsock_dns.c]
Include winsock.h early to avoid Solaris problem.
* [include/windows.h]
Undef FSHIFT before we define it.
* [rc/winerc.c]
Include <fcntl.h> instead of <sys/fcntl.h>.
* [files/file.c]
Use strerror in FILE_SetDosError if available.
* [include/config.h.in] [configure.in]
Check for strerror.
* [objects/gdiobj.c]
Make static font structures aligned.
Mon Dec 1 10:10:21 1997 Karl Garrison <karlos@eznet.net>
* [win32/console.c] [if1632/kernel32.spec] [include/windows.h]
Added stub for GetNumberOfConsoleMouseButtons.
Added stub for PeekConsoleInput(A,W).
Fixed parameter list for WriteConsole(A,W).
GetNumberOfConsoleInputEvents now returns 0 events instead of 1
(since low-level console functions are not yet supported).
GetConsoleMode no longer returns ENABLE_WINDOW_INPUT and
ENABLE_MOUSE_INPUT since these are not currently implemented.
diff --git a/documentation/Makefile.in b/documentation/Makefile.in
index fe1be2b..6026158 100644
--- a/documentation/Makefile.in
+++ b/documentation/Makefile.in
@@ -22,6 +22,10 @@
all: $(INFOFILES) $(DVIFILES)
+info: $(INFOFILES)
+
+dvi: $(DVIFILES)
+
@MAKE_RULES@
$(INFOFILES): $(SOURCES)
@@ -34,13 +38,17 @@
$(RM) $(INCLUDES)
for i in $(INCLUDES); do $(LN_S) $(TOPSRCDIR)/$$i $$i || exit 1; done
-install:: $(INFOFILES)
- for i in $(INFOFILES); do $(INSTALL_DATA) $$i $(infodir)/$$i; done
+install::
$(INSTALL_DATA) $(SRCDIR)/wine.man $(mandir)/wine$(manext)
+# Not done by default because of makeinfo bugs
+install_info: $(INFOFILES)
+ for i in $(INFOFILES); do $(INSTALL_DATA) $$i $(infodir)/$$i; done
+
clean::
$(RM) $(INFOFILES) $(DVIFILES) $(INCLUDES)
$(RM) wine.aux wine.cp wine.cps wine.fn wine.fns wine.ky wine.log \
wine.pg wine.toc wine.tp wine.tps wine.vr wine.vrs
+ $(RM) -r man3w
### Dependencies:
diff --git a/documentation/README.documentation b/documentation/README.documentation
new file mode 100644
index 0000000..6a91dc6
--- /dev/null
+++ b/documentation/README.documentation
@@ -0,0 +1,122 @@
+
+ Wine Documentation README
+
+
+Wine Man Page
+
+ The man page for the wine emulator is in this directory. It is installed
+by 'make install'.
+
+Wine Reference Manual
+
+ Texinfo source for preliminary comprehensive documentation is in
+this directory. Use 'make info' in this directory to generate the GNU
+info version, 'make dvi' to generate the DVI version (hit 'r' to
+ignore errors), or 'make all' for both. It is no longer installed by
+default.
+
+Wine API documentation
+
+ Do a 'make manpages' in the Wine toplevel directory to generate the
+API manpages from the Wine source, or 'make man' in any source
+subdirectory to generate manpages from only that directory. The
+manpages will be deposited in [documentation/man3w]. You will need
+c2man, available as source from http://www.debian.org/ and other
+places. Apply the patch included at the end of this file for improved
+terse description formatting. The man pages are not installed
+automatically.
+
+Other READMEs
+
+ Other informational files are in this directory as well as scattered
+through the source tree.
+
+Other resources:
+
+ Usenet: news:comp.emulators.ms-windows.wine
+ WWW: http://www.winehq.com/
+
+
+Writing Wine API Documentation
+
+To improve the documentation of the Wine API, just add comments to the
+existing source. For example,
+
+/******************************************************************
+ * PlayMetaFile32 (GDI32.265) Render metafile to device
+ *
+ * The metafile is rendered in the device context specified by hdc.
+ *
+ * RETURNS
+ *
+ * Always returns TRUE.
+ *
+ * FIXME
+ * Wine metafiles are not 100% binary compatible with Microsoft Windows
+ * metafiles.
+ */
+BOOL32 WINAPI PlayMetaFile32(
+ HDC32 hdc, /* handle of device context in which to render metafile */
+ HMETAFILE32 hmf /* metafile handle */
+) {
+
+becomes, after processing with c2man and nroff -man,
+
+
+PlayMetaFile32(3w) PlayMetaFile32(3w)
+
+
+NAME
+ PlayMetaFile32 - PlayMetaFile32 (GDI32.265) Render
+ metafile to device
+
+SYNOPSIS
+ BOOL32 PlayMetaFile32
+ (
+ HDC32 hdc,
+ HMETAFILE32 hmf
+ );
+
+PARAMETERS
+ HDC32 hdc
+ Handle of device context in which to render
+ metafile.
+
+ HMETAFILE32 hmf
+ Metafile handle.
+
+DESCRIPTION
+ The metafile is rendered in the device context specified
+ by hdc.
+
+RETURNS
+ Always returns TRUE.
+
+FIXME
+ Wine metafiles are not 100% binary compatible with
+ Microsoft Windows metafiles.
+
+----------------------------------------------------------------
+Patch for c2man:
+
+diff -u c2man-2.41.orig/manpage.c c2man-2.41/manpage.c
+--- c2man-2.41.orig/manpage.c Tue Apr 23 21:13:44 1996
++++ c2man-2.41/manpage.c Thu Dec 18 13:20:08 1997
+@@ -585,10 +585,15 @@
+ const char *endterse, *afterdash = skipdash(start_line);
+
+ /* find the end of the terse comment */
+- while (*c && *c != '.' && *c != '\n')
++ while (*c && *c != '\n')
++ {
+ c++;
++ /* '.' ends terse description only if it ends sentence */
++ if (*(c-1)=='.' && *c && isspace(*c))
++ break;
++ }
+
+- endterse = *c == '.' ? c+1 : c;
++ endterse = c;
+ *terse = alloc_string(
+ afterdash < endterse ? afterdash : start_line,
+ endterse);
diff --git a/documentation/how-to-port b/documentation/how-to-port
new file mode 100644
index 0000000..5800f92
--- /dev/null
+++ b/documentation/how-to-port
@@ -0,0 +1,135 @@
+What is this?
+------------
+
+This note is a short description of
+
+* How to port Wine to your favourite operating system
+* Why you probably shouldn't use "#ifdef MyOS"
+* What to do instead.
+
+This document does not say a thing about how to port Wine to non-386
+operating systems, though. You would need a CPU emulator. Let's get
+Wine into a better shape on 386 first, OK?
+
+
+
+
+Why "#ifdef MyOS" is probably a mistake.
+---------------------------------------
+
+Operating systems change. Maybe yours doesn't have the "foo.h"
+header, but maybe a future version will have it. If you want
+to "#include <foo.h>", it doesn't matter what operating system
+you are using; it only matters whether "foo.h" is there.
+
+Furthermore, operating systems change names or "fork" into
+several ones. An "#ifdef MyOs" will break over time.
+
+If you use the feature of Autoconf, the Gnu auto-configuration
+utility wisely, you will help future porters automatically
+because your changes will test for _features_, not names of
+operating systems. A feature can be many things:
+
+* existance of a header file
+* existance of a library function
+* existance of libraries
+* bugs in header files, library functions, the compiler, ...
+* (you name it)
+
+You will need Gnu Autoconf, which you can get from your
+friendly Gnu mirror. This program takes Wine's "configure.in"
+file and produces a "configure" shell script that users use to
+configure Wine to their system.
+
+There _are_ exceptions to the "avoid #ifdef MyOS" rule. Wine,
+for example, needs the internals of the signal stack -- that
+cannot easily be described in terms of features.
+
+Let's now turn to specific porting problems and how to solve
+them.
+
+
+
+MyOS doesn't have the `foo.h' header!
+------------------------------------
+
+This first step is to make Autoconf check for this header.
+In configure.in you add a segment like this in the section
+that checks for header files (search for "header files"):
+
+ AC_CHECK_HEADER(foo.h, AC_DEFINE(HAVE_FOO_H))
+
+If your operating system supports a header file with the
+same contents but a different name, say bar.h, add a check
+for that also.
+
+Now you can change
+
+ #include <foo.h>
+
+to
+
+ #ifdef HAVE_FOO_H
+ #include <foo.h>
+ #elif defined (HAVE_BAR_H)
+ #include <bat.h>
+ #endif
+
+If your system doesn't have a corresponding header file even
+though it has the library functions being used, you might
+have to add an "#else" section to the conditional. Avoid
+this if you can.
+
+You will also need to add "#undef HAVE_FOO_H" (etc.) to
+include/config.h.in
+
+Finish up with "make configure" and "./configure".
+
+
+MyOS doesn't have the `bar' function!
+------------------------------------
+
+A typical example of this is the `memmove'. To solve this
+problem you would add `memmove' to the list of functions
+that Autoconf checks for. In configure.in you search for
+AC_CHECK_FUNCS and add `memmove'. (You will notice that
+someone already did this for this particular function.)
+
+Secondly, you will also need to add "#undef HAVE_BAR"
+to include/config.h.in
+
+The next step depends on the nature of the missing function.
+
+Case 1: It's easy to write a complete emulation of the
+ function. (`memmove' belongs to this case.)
+
+ You add your emulation in misc/port.c surrounded by
+ "#ifndef HAVE_MEMMOVE" and "#endif".
+
+ You might have to add a prototype for your function. If so,
+ include/miscemu.h might be the place. Don't forget to protect
+ that definition by "#ifndef HAVE_MEMMOVE" and "#endif" also!
+
+Case 2: A general emulation is hard, but Wine is only using
+ a special case.
+
+ An example is the various "wait" calls used in SIGNAL_child
+ from loader/signal.c. Here we have a multi-branch case on
+ features:
+
+ #ifdef HAVE_THIS
+ ...
+ #elif defined (HAVE_THAT)
+ ...
+ #elif defined (HAVE_SOMETHING_ELSE)
+ ...
+ #endif
+
+ Note that this is very different from testing on operating
+ systems. If a new version of your operating systems comes
+ out and adds a new function, this code will magically start
+ using it.
+
+Finish up with "make configure" and "./configure".
+
+
