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