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-0_9_60
  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/lz32            # Autosync
  60 reactos/dll/win32/mapi32          # Autosync
  61 reactos/dll/win32/mlang           # Autosync
  62 reactos/dll/win32/mpr             # Autosync
  63 reactos/dll/win32/msacm32         # Out of sync
  64 reactos/dll/win32/mscoree         # Autosync
  65 reactos/dll/win32/mshtml          # Autosync
  66 reactos/dll/win32/msimg32         # Autosync
  67 reactos/dll/win32/msi             # Autosync
  68 reactos/dll/win32/mstask          # Autosync
  69 reactos/dll/win32/msvcrt20        # Autosync
  70 reactos/dll/win32/msvfw32         # Autosync
  71 reactos/dll/win32/msxml3          # Synced to Wine-20071230
  72 reactos/dll/win32/nddeapi         # Autosync
  73 reactos/dll/win32/netapi32        # Autosync
  74 reactos/dll/win32/ntdsapi         # Autosync
  75 reactos/dll/win32/objsel          # Autosync
  76 reactos/dll/win32/odbc32          # Out of sync. Depends on port of Linux ODBC.
  77 reactos/dll/win32/odbccp32        # Autosync
  78 reactos/dll/win32/ole32           # Autosync
  79 reactos/dll/win32/oleacc          # Autosync
  80 reactos/dll/win32/oleaut32        # Autosync
  81 reactos/dll/win32/oledlg          # Autosync
  82 reactos/dll/win32/olepro32        # Autosync
  83 reactos/dll/win32/pdh             # Autosync
  84 reactos/dll/win32/powrprof        # Forked at Wine-1.0rc5
  85 reactos/dll/win32/printui         # Autosync
  86 reactos/dll/win32/pstorec         # Autosync
  87 reactos/dll/win32/rasapi32        # Autosync
  88 reactos/dll/win32/riched20        # Autosync
  89 reactos/dll/win32/riched32        # Autosync
  90 reactos/dll/win32/rpcrt4          # Synced to Wine-0_9_55
  91 reactos/dll/win32/rsabase         # Autosync
  92 reactos/dll/win32/rsaenh          # Autosync
  93 reactos/dll/win32/schannel        # Autosync
  94 reactos/dll/win32/sensapi         # Autosync
  95 reactos/dll/win32/setupapi        # Forked at Wine-20050524
  96 reactos/dll/win32/shell32         # Forked at Wine-20071011
  97 reactos/dll/win32/shdocvw         # Synced to Wine-0_9_5
  98 reactos/dll/win32/shfolder        # Autosync
  99 reactos/dll/win32/shlwapi         # Autosync
 100 reactos/dll/win32/stdole2.tlb     # Autosync
 101 reactos/dll/win32/sxs             # Autosync
 102 reactos/dll/win32/tapi32          # Autosync
 103 reactos/dll/win32/twain_32        # Out of sync
 104 reactos/dll/win32/urlmon          # Autosync
 105 reactos/dll/win32/usp10           # Autosync
 106 reactos/dll/win32/uxtheme         # Autosync
 107 reactos/dll/win32/version         # Autosync
 108 reactos/dll/win32/wininet         # Autosync
 109 reactos/dll/win32/winhttp         # Autosync
 110 reactos/dll/win32/wintrust        # Out of sync
 111 reactos/dll/win32/winmm           # Forked at Wine-20050628
 112 reactos/dll/win32/winmm/midimap   # Forked at Wine-20050628
 113 reactos/dll/win32/winmm/wavemap   # Forked at Wine-20050628
 114 reactos/dll/win32/wldap32         # Autosync
 115 reactos/dll/win32/wtsapi32        # Autosync
 116 reactos/dll/directx/dinput        # Synced to Wine-0_9_5
 117 reactos/dll/directx/dinput8       # Synced to Wine-0_9_5
 118 reactos/dll/directx/dplay         # Synced to Wine-0_9_5
 119 reactos/dll/directx/dplayx        # Synced to Wine-0_9_5
 120 reactos/dll/directx/dxdiagn       # Synced to Wine-0_9_5
 121
 122 ReactOS shares the following programs with Winehq.
 123
 124 reactos/base/applications/games/winemine  # Out of sync
 125 reactos/base/applications/regedit         # Out of sync
 126 reactos/base/applications/cmdutils/xcopy  # Synced to Wine-0_9_54
 127 reactos/base/system/expand                # Out of sync
 128 reactos/base/system/msiexec               # Wine 1.0-rc1
 129 reactos/base/applications/winhelp         # Synced to Wine-0_9_53
 130 reactos/base/applications/wordpad         # Synced to Wine-0_9_53
 131 reactos/modules/rosapps/winefile          # Synced to Wine-0_9_53
 132 reactos/base/applications/notepad         # Forked at Wine-20041201
 133 reactos/base/applications/iexplore        # Wine 1.0-rc1
 134
 135 In addition the following libs, dlls and source files are mostly based on code ported
 136 from Winehq CVS. If you are looking to update something in these files
 137 check Wine current souces first as it may already be fixed.
 138
 139 reactos/lib/uuid                  # Synced to Wine-20080114
 140
 141 advapi32 -
 142   reactos/dll/win32/advapi32/crypt/*.c          # ekohl says we're not sharing this
 143
 144 gdi32 -
 145   reactos/dll/win32/gdi32/objects/linedda.c     # Out of sync
 146
 147 kernel32 -
 148   reactos/dll/win32/kernel32/misc/errormsg.c    # Out of sync
 149   reactos/dll/win32/kernel32/misc/profile.c     # Out of sync
 150   reactos/dll/win32/kernel32/misc/lcformat.c    # Out of sync
 151
 152 msvcrt -
 153   reactos/lib/sdk/crt/cpp.c                     # Synced at 20071111
 154   reactos/lib/sdk/crt/cppexcept.c               # Synced at 20071111
 155   reactos/lib/sdk/crt/strings/scanf.c/h         # Synced at 20080604
 156   reactos/lib/sdk/crt/wine/heap.c               # Synced at 20080529
 157   reactos/lib/sdk/crt/wine                      # Synced at XXXXXXXX
 158   reactos/lib/sdk/crt/thread/thread.c           # Synced at 20080604
 159
 160 User32 -
 161   reactos/dll/win32/user32/controls/button.c    # Synced at 20071022
 162   reactos/dll/win32/user32/controls/combo.c     # Synced at 20071022
 163   reactos/dll/win32/user32/controls/edit.c      # Synced at 20071022
 164   reactos/dll/win32/user32/controls/icontitle.c # Synced at 20060617
 165   reactos/dll/win32/user32/controls/listbox.c   # Synced at 20071023
 166   reactos/dll/win32/user32/controls/scrollbar.c # Forked
 167   reactos/dll/win32/user32/controls/static.c    # Synced at 20071024
 168
 169   reactos/dll/win32/user32/misc/dde.c           # Synced at 20080414 (dde_misc.c)
 170   reactos/dll/win32/user32/misc/ddeclient.c     # Synced at 20060623
 171   reactos/dll/win32/user32/misc/ddeserver.c     # Synced at 20060623
 172   reactos/dll/win32/user32/misc/exticon.c       # Last sync date unknown
 173   reactos/dll/win32/user32/misc/resources.c     # Forked?
 174   reactos/dll/win32/user32/misc/winhelp.c       # Last sync date unknown
 175   reactos/dll/win32/user32/misc/wsprintf.c      # Synced at 20060623
 176
 177   reactos/dll/win32/user32/windows/defwnd.c     # Forked
 178   reactos/dll/win32/user32/windows/draw.c       # Forked at Wine-20020904 (uitools.c)
 179   reactos/dll/win32/user32/windows/mdi.c        # Synced at 20060703
 180   reactos/dll/win32/user32/windows/menu.c       # Forked
 181   reactos/dll/win32/user32/windows/messagebox.c # Forked
 182   reactos/dll/win32/user32/windows/rect.c       # Forked (uitools.c)
 183   reactos/dll/win32/user32/windows/text.c       # Forked (lstr.c)
 184   reactos/dll/win32/user32/windows/winpos.c     # Forked
 185
 186 Update process for autosync DLLs
 187
 188 *** This process can only be done on Microsoft Windows ***
 189 - Download wineimport.cmd at svn://svn.reactos.org/reactos/trunk/tools/
 190 - Download cvs command line program and be sure to put it in your path
 191   (available at http://ftp.gnu.org/non-gnu/cvs/binary/stable/x86-woe/ )
 192 - Download svn command line program and be sure to put it in your path
 193   (available at http://subversion.tigris.org/servlets/ProjectDocumentList?folderID=91 )
 194 - Download patch command line program and be sure to put it in your path
 195   (available at http://gnuwin32.sourceforge.net/packages/patch.htm )
 196 - Optionally, download junction.exe and put it in your path
 197   (available at http://www.sysinternals.com/Utilities/Junction.html )
 198 - Cd to the directory containing wineimport.cmd
 199 - Run
 200   "wineimport.cmd fullprocessing {path_to_your_reactos_directory} {name_of_the_wine_dll}"
 201 - In case of error, you can
 202   1) add missing definitions to ReactOS headers
 203   2) fix {name_of_the_wine_dll}_ros.diff patch file, by removing outdated changes
 204   3) or modify Wine code, by adding a {name_of_the_wine_dll}_ros.diff patch,
 205      which will be applied after Wine source checkout
 206      DO NOT DIRECTLY MODIFY WINE SOURCE CODE
 207 - Once Wine DLL compiles, install and run ReactOS and search for regressions
 208 - In case of regression, you can
 209   1) Fix ReactOS code (not in the shared DLL)
 210   2) or update the {name_of_the_wine_dll}_ros.diff patch file
 211 - Commit your changes with the "Autosyncing with Wine HEAD" commit message