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