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/widl                # Synced to Wine-1_1_4, omitting patches that break MIDL-Compatibility
  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/wpp                 # Synced to Wine-20081105 (~Wine-1.1.7)
  29 reactos/tools/wrc                 # Synced to Wine-20081105 (~Wine-1.1.7)
  30
  31 The following libraries are shared with Wine.
  32
  33 reactos/dll/directx/amstream      # Autosync
  34 reactos/dll/directx/dinput        # Synced to Wine-1_1_4
  35 reactos/dll/directx/dinput8       # Synced to Wine-1_1_4
  36 reactos/dll/directx/dplay         # Synced to Wine-0_9_5
  37 reactos/dll/directx/dplayx        # Synced to Wine-0_9_5
  38 reactos/dll/directx/dxdiagn       # Synced to Wine-0_9_5
  39 reactos/dll/directx/msdmo         # Autosync
  40 reactos/dll/directx/qedit         # Autosync
  41 reactos/dll/directx/quartz        # Autosync
  42 reactos/dll/win32/advpack         # Autosync
  43 reactos/dll/win32/atl             # Autosync
  44 reactos/dll/win32/avifil32        # Autosync
  45 reactos/dll/win32/browseui        # Out of sync
  46 reactos/dll/win32/cabinet         # Autosync
  47 reactos/dll/win32/clusapi         # Autosync
  48 reactos/dll/win32/comcat          # Autosync
  49 reactos/dll/win32/comctl32        # Autosync
  50 reactos/dll/win32/comdlg32        # Autosync
  51 reactos/dll/win32/compstui        # Autosync
  52 reactos/dll/win32/credui          # Autosync
  53 reactos/dll/win32/crypt32         # Synced to Wine-1_1_21
  54 reactos/dll/win32/cryptdll        # Autosync
  55 reactos/dll/win32/cryptnet        # Autosync
  56 reactos/dll/win32/cryptui         # Autosync
  57 reactos/dll/win32/dbghelp         # Synced to Wine-20080802
  58 reactos/dll/win32/dciman32        # Synced to Wine-1_0-rc2
  59 reactos/dll/win32/gdiplus         # Autosync
  60 reactos/dll/win32/hhctrl.ocx      # Autosync
  61 reactos/dll/win32/hlink           # Autosync
  62 reactos/dll/win32/httpapi         # Autosync
  63 reactos/dll/win32/iccvid          # Autosync
  64 reactos/dll/win32/icmp            # Synced to Wine-0_9_10
  65 reactos/dll/win32/imaadp32.acm    # Autosync
  66 reactos/dll/win32/imm32           # Autosync
  67 reactos/dll/win32/imagehlp        # Patches for BindImage need review and submission to winehq.
  68 reactos/dll/win32/inetcomm        # Autosync
  69 reactos/dll/win32/inetmib1        # Autosync
  70 reactos/dll/win32/initpki         # Autosync
  71 reactos/dll/win32/inseng          # Autosync
  72 reactos/dll/win32/iphlpapi        # Out of sync
  73 reactos/dll/win32/itircl          # Autosync
  74 reactos/dll/win32/itss            # Autosync
  75 reactos/dll/win32/jscript         # Autosync
  76 reactos/dll/win32/localspl        # Autosync
  77 reactos/dll/win32/localui         # Autosync
  78 reactos/dll/win32/lz32            # Autosync
  79 reactos/dll/win32/mapi32          # Autosync
  80 reactos/dll/win32/mciavi32        # Autosync
  81 reactos/dll/win32/mcicda          # Autosync
  82 reactos/dll/win32/mciqtz32        # Autosync
  83 reactos/dll/win32/mciseq          # Autosync
  84 reactos/dll/win32/mciwave         # Autosync
  85 reactos/dll/win32/mlang           # Autosync
  86 reactos/dll/win32/mpr             # Autosync
  87 reactos/dll/win32/msacm32         # Out of sync
  88 reactos/dll/win32/msadp32.acm     # Autosync
  89 reactos/dll/win32/mscat32         # Autosync
  90 reactos/dll/win32/mscms           # Autosync
  91 reactos/dll/win32/mscoree         # Autosync
  92 reactos/dll/win32/msctf           # Autosync
  93 reactos/dll/win32/msftedit        # Autosync
  94 reactos/dll/win32/msg711.acm      # Autosync
  95 reactos/dll/win32/mshtml          # Autosync
  96 reactos/dll/win32/msimg32         # Autosync
  97 reactos/dll/win32/msi             # Autosync
  98 reactos/dll/win32/msimtf          # Autosync
  99 reactos/dll/win32/msisip          # Autosync
 100 reactos/dll/win32/msisys.ocx      # Autosync
 101 reactos/dll/win32/msnet32         # Autosync
 102 reactos/dll/win32/msrle32         # Autosync
 103 reactos/dll/win32/mssign32        # Autosync
 104 reactos/dll/win32/mssip32         # Autosync
 105 reactos/dll/win32/mstask          # Autosync
 106 reactos/dll/win32/msvcrt20        # Autosync
 107 reactos/dll/win32/msvfw32         # Autosync
 108 reactos/dll/win32/msvidc32        # Autosync
 109 reactos/dll/win32/msxml3          # Synced to Wine-1_1_20
 110 reactos/dll/win32/nddeapi         # Autosync
 111 reactos/dll/win32/netapi32        # Autosync
 112 reactos/dll/win32/ntdsapi         # Autosync
 113 reactos/dll/win32/ntprint         # Autosync
 114 reactos/dll/win32/objsel          # Autosync
 115 reactos/dll/win32/odbc32          # Out of sync. Depends on port of Linux ODBC.
 116 reactos/dll/win32/odbccp32        # Autosync
 117 reactos/dll/win32/ole32           # Autosync
 118 reactos/dll/win32/oleacc          # Autosync
 119 reactos/dll/win32/oleaut32        # Autosync
 120 reactos/dll/win32/olecli32        # Autosync
 121 reactos/dll/win32/oledlg          # Autosync
 122 reactos/dll/win32/olepro32        # Autosync
 123 reactos/dll/win32/olesvr32        # Autosync
 124 reactos/dll/win32/olethk32        # Autosync
 125 reactos/dll/win32/pdh             # Autosync
 126 reactos/dll/win32/pidgen          # Autosync
 127 reactos/dll/win32/powrprof        # Forked at Wine-1.0rc5
 128 reactos/dll/win32/printui         # Autosync
 129 reactos/dll/win32/pstorec         # Autosync
 130 reactos/dll/win32/query           # Autosync
 131 reactos/dll/win32/rasapi32        # Autosync
 132 reactos/dll/win32/resutils        # Autosync
 133 reactos/dll/win32/riched20        # Autosync
 134 reactos/dll/win32/riched32        # Autosync
 135 reactos/dll/win32/rpcrt4          # Synced to Wine-0_9_55
 136 reactos/dll/win32/rsabase         # Autosync
 137 reactos/dll/win32/rsaenh          # Autosync
 138 reactos/dll/win32/sccbase         # Autosync
 139 reactos/dll/win32/schannel        # Autosync
 140 reactos/dll/win32/sensapi         # Autosync
 141 reactos/dll/win32/setupapi        # Forked at Wine-20050524
 142 reactos/dll/win32/shell32         # Forked at Wine-20071011
 143 reactos/dll/win32/shdocvw         # Synced to Wine-1_1_20
 144 reactos/dll/win32/shfolder        # Autosync
 145 reactos/dll/win32/shlwapi         # Autosync
 146 reactos/dll/win32/slbcsp          # Autosync
 147 reactos/dll/win32/softpub         # Autosync
 148 reactos/dll/win32/spoolss         # Autosync
 149 reactos/dll/win32/stdole2.tlb     # Autosync
 150 reactos/dll/win32/sti             # Autosync
 151 reactos/dll/win32/sxs             # Autosync
 152 reactos/dll/win32/tapi32          # Autosync
 153 reactos/dll/win32/traffic         # Autosync
 154 reactos/dll/win32/twain_32        # Out of sync
 155 reactos/dll/win32/updspapi        # Autosync
 156 reactos/dll/win32/url             # Autosync
 157 reactos/dll/win32/urlmon          # Autosync
 158 reactos/dll/win32/usp10           # Autosync
 159 reactos/dll/win32/uxtheme         # Autosync
 160 reactos/dll/win32/version         # Autosync
 161 reactos/dll/win32/winemp3.acm     # Autosync
 162 reactos/dll/win32/wininet         # Autosync
 163 reactos/dll/win32/winhttp         # Autosync
 164 reactos/dll/win32/winmm           # Forked at Wine-20050628
 165 reactos/dll/win32/winmm/midimap   # Forked at Wine-20050628
 166 reactos/dll/win32/winmm/wavemap   # Forked at Wine-20050628
 167 reactos/dll/win32/wintab32        # Autosync
 168 reactos/dll/win32/wintrust        # Out of sync
 169 reactos/dll/win32/wldap32         # Autosync
 170 reactos/dll/win32/wmi             # Autosync
 171 reactos/dll/win32/wtsapi32        # Autosync
 172 reactos/dll/win32/wuapi           # Autosync
 173 reactos/dll/win32/xinput1_1       # Autosync
 174 reactos/dll/win32/xinput1_2       # Autosync
 175 reactos/dll/win32/xinput1_3       # Autosync
 176 reactos/dll/win32/xinput9_1_0     # Autosync
 177
 178 ReactOS shares the following programs with Winehq.
 179
 180 reactos/base/applications/cmdutils/xcopy  # Autosync
 181 reactos/base/applications/games/winemine  # Out of sync
 182 reactos/base/applications/iexplore        # Autosync
 183 reactos/base/applications/notepad         # Forked at Wine-20041201
 184 reactos/base/applications/regedit         # Out of sync
 185 reactos/base/applications/winhlp32        # Autosync
 186 reactos/base/applications/wordpad         # Autosync
 187 reactos/base/services/rpcss               # Synced to Wine-20081105
 188 reactos/base/system/expand                # Out of sync
 189 reactos/base/system/msiexec               # Synced to Wine-1_1_23
 190 reactos/modules/rosapps/winfile           # Autosync
 191
 192 In addition the following libs, dlls and source files are mostly based on code ported
 193 from Winehq CVS. If you are looking to update something in these files
 194 check Wine current souces first as it may already be fixed.
 195
 196 reactos/lib/uuid                  # Synced to Wine-20080114
 197
 198 advapi32 -
 199   reactos/dll/win32/advapi32/crypt/*.c          # ekohl says we're not sharing this
 200   reactos/dll/win32/advapi32/sec/cred.c         # Out of Sync
 201   reactos/dll/win32/advapi32/sec/sid.c          # Out of Sync
 202
 203 gdi32 -
 204   reactos/dll/win32/gdi32/objects/linedda.c     # Synched at 20090410
 205
 206 kernel32 -
 207   reactos/dll/win32/kernel32/misc/errormsg.c    # Out of sync
 208   reactos/dll/win32/kernel32/misc/profile.c     # Out of sync
 209   reactos/dll/win32/kernel32/misc/lcformat.c    # Out of sync
 210   reactos/dll/win32/kernel32/misc/lzexpand.c    # Synced to Wine-1_1_23
 211
 212 msvcrt -
 213   reactos/lib/sdk/crt/except/cpp.c              # Synced at 20071111
 214   reactos/lib/sdk/crt/except/cppexcept.c        # Synced at 20071111
 215   reactos/lib/sdk/crt/strings/scanf.c/h         # Synced at 20080604
 216   reactos/lib/sdk/crt/strings/wcs.c             # Synced at 20080611
 217   reactos/lib/sdk/crt/wine/heap.c               # Synced at 20080529
 218   reactos/lib/sdk/crt/wine/undname.c            # Synced at 20081130
 219   reactos/lib/sdk/crt/thread/thread.c           # Synced at 20080604
 220
 221 snmpapi -
 222   reactos/dll/win32/snmpapi/main.c              # Synced at 20090222
 223
 224 User32 -
 225   reactos/dll/win32/user32/controls/button.c    # Synced to Wine-1_1_22
 226   reactos/dll/win32/user32/controls/combo.c     # Synced to Wine-1_1_22
 227   reactos/dll/win32/user32/controls/edit.c      # Synced to Wine-1_1_22
 228   reactos/dll/win32/user32/controls/icontitle.c # Synced to Wine-1_1_13
 229   reactos/dll/win32/user32/controls/listbox.c   # Synced to Wine-1_1_22
 230   reactos/dll/win32/user32/controls/scrollbar.c # Forked
 231   reactos/dll/win32/user32/controls/static.c    # Synced to Wine-1_1_22
 232
 233   reactos/dll/win32/user32/misc/dde.c           # Synced to wine 1.1.17 (dde_misc.c)
 234   reactos/dll/win32/user32/misc/ddeclient.c     # Synced to Wine-1_1_23
 235   reactos/dll/win32/user32/misc/ddeserver.c     # Synced to Wine-1_1_23
 236   reactos/dll/win32/user32/misc/exticon.c       # Synced to Wine-1_1_22
 237   reactos/dll/win32/user32/misc/resources.c     # Forked?
 238   reactos/dll/win32/user32/misc/winhelp.c       # Last sync date unknown
 239   reactos/dll/win32/user32/misc/wsprintf.c      # Synced to Wine-1_1_23
 240
 241   reactos/dll/win32/user32/windows/defwnd.c     # Forked
 242   reactos/dll/win32/user32/windows/draw.c       # Forked at Wine-20020904 (uitools.c)
 243   reactos/dll/win32/user32/windows/mdi.c        # Synced at 20060703
 244   reactos/dll/win32/user32/windows/menu.c       # Forked
 245   reactos/dll/win32/user32/windows/messagebox.c # Forked
 246   reactos/dll/win32/user32/windows/rect.c       # Forked (uitools.c)
 247   reactos/dll/win32/user32/windows/text.c       # Forked (lstr.c)
 248   reactos/dll/win32/user32/windows/winpos.c     # Forked
 249
 250 Update process for autosync DLLs
 251
 252 *** This process can only be done on Microsoft Windows ***
 253 - Download wineimport.cmd at svn://svn.reactos.org/reactos/trunk/tools/
 254 - Download cvs command line program and be sure to put it in your path
 255   (available at http://ftp.gnu.org/non-gnu/cvs/binary/stable/x86-woe/ )
 256 - Download svn command line program and be sure to put it in your path
 257   (available at http://subversion.tigris.org/servlets/ProjectDocumentList?folderID=91 )
 258 - Download patch command line program and be sure to put it in your path
 259   (available at http://gnuwin32.sourceforge.net/packages/patch.htm )
 260 - Optionally, download junction.exe and put it in your path
 261   (available at http://www.sysinternals.com/Utilities/Junction.html )
 262 - Cd to the directory containing wineimport.cmd
 263 - Run
 264   "wineimport.cmd fullprocessing {path_to_your_reactos_directory} {name_of_the_wine_dll}"
 265 - In case of error, you can
 266   1) add missing definitions to ReactOS headers
 267   2) fix {name_of_the_wine_dll}_ros.diff patch file, by removing outdated changes
 268   3) or modify Wine code, by adding a {name_of_the_wine_dll}_ros.diff patch,
 269      which will be applied after Wine source checkout
 270      DO NOT DIRECTLY MODIFY WINE SOURCE CODE
 271 - Once Wine DLL compiles, install and run ReactOS and search for regressions
 272 - In case of regression, you can
 273   1) Fix ReactOS code (not in the shared DLL)
 274   2) or update the {name_of_the_wine_dll}_ros.diff patch file
 275 - Commit your changes with the "Autosyncing with Wine HEAD" commit message