reactos/media/doc/README.WINE

   1 # ReactOS WINE porting guide for 0.3
   2 # Update this file when you port a dll/program from WINE.
   3
   4 The ReactOS Project shares quite a bit of code with the WINE project.
   5 This document should provide a compleate reference for all of the
   6 locations in the ReactOS source tree where code is shared between the
   7 two projects. If you find something is missing from this documentation
   8 please add it.
   9
  10 If you find that a function in ReactOS that is not implemented properly
  11 and is based on WINE sources, check the latest Winehq CVS and see if
  12 it has been fixed there. If so, please submit a patch to
  13 ros-dev@reactos.org. Otherwise please send a patch to both
  14 wine-patches@winehq.com and ros-dev@reactos.org
  15
  16 When porting a new DLL from Wine to ReactOS, please do the following steps
  17 - Create a new directory in dll/win32/ of the same name as the new Wine DLL
  18 - Add a new entry in dll/win32/win32.rbuild
  19 - Follow the guide "Update process for autosync DLLs" at the bottom of this file
  20
  21
  22 The following build tools are shared with Wine.
  23
  24 reactos/tools/unicode             # Synced to Wine-20081105 (~Wine-1.1.7)
  25 reactos/tools/wpp                 # Synced to Wine-20081105 (~Wine-1.1.7)
  26 reactos/tools/winebuild           # Synced to Wine-20081105 (~Wine-1.1.7)
  27 reactos/tools/wmc                 # Synced to Wine-20081105 (~Wine-1.1.7)
  28 reactos/tools/wrc                 # Synced to Wine-20081105 (~Wine-1.1.7)
  29 reactos/tools/widl                # Synced to Wine-1_1_4, omitting patches that break MIDL-Compatibility
  30
  31 The following libraries are shared with Wine.
  32
  33 reactos/dll/win32/advpack         # Autosync
  34 reactos/dll/win32/atl             # Autosync
  35 reactos/dll/win32/avifil32        # Autosync
  36 reactos/dll/win32/browseui        # Out of sync
  37 reactos/dll/win32/cabinet         # Autosync
  38 reactos/dll/win32/clusapi         # Autosync
  39 reactos/dll/win32/comcat          # Autosync
  40 reactos/dll/win32/comctl32        # Autosync
  41 reactos/dll/win32/comdlg32        # Autosync
  42 reactos/dll/win32/compstui        # Autosync
  43 reactos/dll/win32/credui          # Autosync
  44 reactos/dll/win32/crypt32         # Synced to Wine-1_0-rc1
  45 reactos/dll/win32/cryptdll        # Autosync
  46 reactos/dll/win32/cryptnet        # Autosync
  47 reactos/dll/win32/cryptui         # Autosync
  48 reactos/dll/win32/dbghelp         # Synced to Wine-20080802
  49 reactos/dll/win32/dciman32        # Synced to Wine-1_0-rc2
  50 reactos/dll/win32/gdiplus         # Autosync
  51 reactos/dll/win32/hhctrl.ocx      # Autosync
  52 reactos/dll/win32/hlink           # Autosync
  53 reactos/dll/win32/icmp            # Synced to Wine-0_9_10
  54 reactos/dll/win32/imm32           # Autosync
  55 reactos/dll/win32/imagehlp        # Patches for BindImage need review and submission to winehq.
  56 reactos/dll/win32/inetcomm        # Autosync
  57 reactos/dll/win32/inetmib1        # Autosync
  58 reactos/dll/win32/iphlpapi        # Out of sync
  59 reactos/dll/win32/localui         # Autosync
  60 reactos/dll/win32/lz32            # Autosync
  61 reactos/dll/win32/mapi32          # Autosync
  62 reactos/dll/win32/mlang           # Autosync
  63 reactos/dll/win32/mpr             # Autosync
  64 reactos/dll/win32/msacm32         # Out of sync
  65 reactos/dll/win32/mscoree         # Autosync
  66 reactos/dll/win32/mshtml          # Autosync
  67 reactos/dll/win32/msimg32         # Autosync
  68 reactos/dll/win32/msi             # Autosync
  69 reactos/dll/win32/mstask          # Autosync
  70 reactos/dll/win32/msvcrt20        # Autosync
  71 reactos/dll/win32/msvfw32         # Autosync
  72 reactos/dll/win32/msxml3          # Synced to Wine-20071230
  73 reactos/dll/win32/nddeapi         # Autosync
  74 reactos/dll/win32/netapi32        # Autosync
  75 reactos/dll/win32/ntdsapi         # Autosync
  76 reactos/dll/win32/objsel          # Autosync
  77 reactos/dll/win32/odbc32          # Out of sync. Depends on port of Linux ODBC.
  78 reactos/dll/win32/odbccp32        # Autosync
  79 reactos/dll/win32/ole32           # Autosync
  80 reactos/dll/win32/oleacc          # Autosync
  81 reactos/dll/win32/oleaut32        # Autosync
  82 reactos/dll/win32/oledlg          # Autosync
  83 reactos/dll/win32/olepro32        # Autosync
  84 reactos/dll/win32/pdh             # Autosync
  85 reactos/dll/win32/powrprof        # Forked at Wine-1.0rc5
  86 reactos/dll/win32/printui         # Autosync
  87 reactos/dll/win32/pstorec         # Autosync
  88 reactos/dll/win32/rasapi32        # Autosync
  89 reactos/dll/win32/riched20        # Autosync
  90 reactos/dll/win32/riched32        # Autosync
  91 reactos/dll/win32/rpcrt4          # Synced to Wine-0_9_55
  92 reactos/dll/win32/rsabase         # Autosync
  93 reactos/dll/win32/rsaenh          # Autosync
  94 reactos/dll/win32/schannel        # Autosync
  95 reactos/dll/win32/sensapi         # Autosync
  96 reactos/dll/win32/setupapi        # Forked at Wine-20050524
  97 reactos/dll/win32/shell32         # Forked at Wine-20071011
  98 reactos/dll/win32/shdocvw         # Synced to Wine-0_9_5
  99 reactos/dll/win32/shfolder        # Autosync
 100 reactos/dll/win32/shlwapi         # Autosync
 101 reactos/dll/win32/spoolss         # Autosync
 102 reactos/dll/win32/stdole2.tlb     # Autosync
 103 reactos/dll/win32/sxs             # Autosync
 104 reactos/dll/win32/tapi32          # Autosync
 105 reactos/dll/win32/twain_32        # Out of sync
 106 reactos/dll/win32/urlmon          # Autosync
 107 reactos/dll/win32/usp10           # Autosync
 108 reactos/dll/win32/uxtheme         # Autosync
 109 reactos/dll/win32/version         # Autosync
 110 reactos/dll/win32/wininet         # Autosync
 111 reactos/dll/win32/winhttp         # Autosync
 112 reactos/dll/win32/wintrust        # Out of sync
 113 reactos/dll/win32/winmm           # Forked at Wine-20050628
 114 reactos/dll/win32/winmm/midimap   # Forked at Wine-20050628
 115 reactos/dll/win32/winmm/wavemap   # Forked at Wine-20050628
 116 reactos/dll/win32/wldap32         # Autosync
 117 reactos/dll/win32/wtsapi32        # Autosync
 118 reactos/dll/directx/dinput        # Synced to Wine-0_9_5
 119 reactos/dll/directx/dinput8       # Synced to Wine-0_9_5
 120 reactos/dll/directx/dplay         # Synced to Wine-0_9_5
 121 reactos/dll/directx/dplayx        # Synced to Wine-0_9_5
 122 reactos/dll/directx/dxdiagn       # Synced to Wine-0_9_5
 123
 124 ReactOS shares the following programs with Winehq.
 125
 126 reactos/base/applications/games/winemine  # Out of sync
 127 reactos/base/applications/regedit         # Out of sync
 128 reactos/base/applications/cmdutils/xcopy  # Synced to Wine-0_9_54
 129 reactos/base/services/rpcss               # Synced to Wine-20081105
 130 reactos/base/system/expand                # Out of sync
 131 reactos/base/system/msiexec               # Wine 1.0-rc1
 132 reactos/base/applications/winhelp         # Synced to Wine-0_9_53
 133 reactos/base/applications/wordpad         # Synced to Wine-0_9_53
 134 reactos/modules/rosapps/winefile          # Synced to Wine-0_9_53
 135 reactos/base/applications/notepad         # Forked at Wine-20041201
 136 reactos/base/applications/iexplore        # Wine 1.0-rc1
 137
 138 In addition the following libs, dlls and source files are mostly based on code ported
 139 from Winehq CVS. If you are looking to update something in these files
 140 check Wine current souces first as it may already be fixed.
 141
 142 reactos/lib/uuid                  # Synced to Wine-20080114
 143
 144 advapi32 -
 145   reactos/dll/win32/advapi32/crypt/*.c          # ekohl says we're not sharing this
 146
 147 gdi32 -
 148   reactos/dll/win32/gdi32/objects/linedda.c     # Out of sync
 149
 150 kernel32 -
 151   reactos/dll/win32/kernel32/misc/errormsg.c    # Out of sync
 152   reactos/dll/win32/kernel32/misc/profile.c     # Out of sync
 153   reactos/dll/win32/kernel32/misc/lcformat.c    # Out of sync
 154
 155 msvcrt -
 156   reactos/lib/sdk/crt/cpp.c                     # Synced at 20071111
 157   reactos/lib/sdk/crt/cppexcept.c               # Synced at 20071111
 158   reactos/lib/sdk/crt/strings/scanf.c/h         # Synced at 20080604
 159   reactos/lib/sdk/crt/strings/wcs.c             # Synced at 20080611
 160   reactos/lib/sdk/crt/wine/heap.c               # Synced at 20080529
 161   reactos/lib/sdk/crt/wine/undname.c            # Synced at XXXXXXXX
 162   reactos/lib/sdk/crt/thread/thread.c           # Synced at 20080604
 163
 164 User32 -
 165   reactos/dll/win32/user32/controls/button.c    # Synced at Wine-1_1_12
 166   reactos/dll/win32/user32/controls/combo.c     # Synced at Wine-1_1_12
 167   reactos/dll/win32/user32/controls/edit.c      # Synced at 20071022
 168   reactos/dll/win32/user32/controls/icontitle.c # Synced at 20060617
 169   reactos/dll/win32/user32/controls/listbox.c   # Synced at 20071023
 170   reactos/dll/win32/user32/controls/scrollbar.c # Forked
 171   reactos/dll/win32/user32/controls/static.c    # Synced at 20071024
 172
 173   reactos/dll/win32/user32/misc/dde.c           # Synced at 20080414 (dde_misc.c)
 174   reactos/dll/win32/user32/misc/ddeclient.c     # Synced at 20060623
 175   reactos/dll/win32/user32/misc/ddeserver.c     # Synced at 20060623
 176   reactos/dll/win32/user32/misc/exticon.c       # Last sync date unknown
 177   reactos/dll/win32/user32/misc/resources.c     # Forked?
 178   reactos/dll/win32/user32/misc/winhelp.c       # Last sync date unknown
 179   reactos/dll/win32/user32/misc/wsprintf.c      # Synced at Wine-1_1_12
 180
 181   reactos/dll/win32/user32/windows/defwnd.c     # Forked
 182   reactos/dll/win32/user32/windows/draw.c       # Forked at Wine-20020904 (uitools.c)
 183   reactos/dll/win32/user32/windows/mdi.c        # Synced at 20060703
 184   reactos/dll/win32/user32/windows/menu.c       # Forked
 185   reactos/dll/win32/user32/windows/messagebox.c # Forked
 186   reactos/dll/win32/user32/windows/rect.c       # Forked (uitools.c)
 187   reactos/dll/win32/user32/windows/text.c       # Forked (lstr.c)
 188   reactos/dll/win32/user32/windows/winpos.c     # Forked
 189
 190 Update process for autosync DLLs
 191
 192 *** This process can only be done on Microsoft Windows ***
 193 - Download wineimport.cmd at svn://svn.reactos.org/reactos/trunk/tools/
 194 - Download cvs command line program and be sure to put it in your path
 195   (available at http://ftp.gnu.org/non-gnu/cvs/binary/stable/x86-woe/ )
 196 - Download svn command line program and be sure to put it in your path
 197   (available at http://subversion.tigris.org/servlets/ProjectDocumentList?folderID=91 )
 198 - Download patch command line program and be sure to put it in your path
 199   (available at http://gnuwin32.sourceforge.net/packages/patch.htm )
 200 - Optionally, download junction.exe and put it in your path
 201   (available at http://www.sysinternals.com/Utilities/Junction.html )
 202 - Cd to the directory containing wineimport.cmd
 203 - Run
 204   "wineimport.cmd fullprocessing {path_to_your_reactos_directory} {name_of_the_wine_dll}"
 205 - In case of error, you can
 206   1) add missing definitions to ReactOS headers
 207   2) fix {name_of_the_wine_dll}_ros.diff patch file, by removing outdated changes
 208   3) or modify Wine code, by adding a {name_of_the_wine_dll}_ros.diff patch,
 209      which will be applied after Wine source checkout
 210      DO NOT DIRECTLY MODIFY WINE SOURCE CODE
 211 - Once Wine DLL compiles, install and run ReactOS and search for regressions
 212 - In case of regression, you can
 213   1) Fix ReactOS code (not in the shared DLL)
 214   2) or update the {name_of_the_wine_dll}_ros.diff patch file
 215 - Commit your changes with the "Autosyncing with Wine HEAD" commit message