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-0_9_5
  25 reactos/tools/wpp                 # Synced to Wine-0_9_5
  26 reactos/tools/winebuild           # Synced to Wine-20071217
  27 reactos/tools/wmc                 # Synced to Wine-20071201
  28 reactos/tools/wrc                 # Synced to Wine-0_9_53
  29 reactos/tools/widl                # Synced to Wine-0_9_55
  30
  31 The following libraries are shared with Wine.
  32
  33 reactos/dll/win32/advpack         # Autosync
  34 reactos/dll/win32/avifil32        # Autosync
  35 reactos/dll/win32/browseui        # Out of sync
  36 reactos/dll/win32/cabinet         # Autosync
  37 reactos/dll/win32/clusapi         # Autosync
  38 reactos/dll/win32/comcat          # Autosync
  39 reactos/dll/win32/comctl32        # Autosync
  40 reactos/dll/win32/comdlg32        # Autosync
  41 reactos/dll/win32/crypt32         # Out of sync
  42 reactos/dll/win32/cryptdll        # Autosync
  43 reactos/dll/win32/cryptnet        # Autosync
  44 reactos/dll/win32/dbghelp         # Synced to Wine-20080106
  45 reactos/dll/win32/hhctrl.ocx      # Autosync
  46 reactos/dll/win32/hlink           # Autosync
  47 reactos/dll/win32/icmp            # Synced to Wine-0_9_10
  48 reactos/dll/win32/imm32           # Autosync
  49 reactos/dll/win32/iphlpapi        # Out of sync
  50 reactos/dll/win32/imagehlp        # Patches for BindImage need review and submission to winehq.
  51 reactos/dll/win32/lz32            # Autosync
  52 reactos/dll/win32/mapi32          # Autosync
  53 reactos/dll/win32/mlang           # Autosync
  54 reactos/dll/win32/mpr             # Autosync
  55 reactos/dll/win32/msacm32         # Out of sync
  56 reactos/dll/win32/msimg32         # Autosync
  57 reactos/dll/win32/msi             # Autosync
  58 reactos/dll/win32/msvcrt20        # Autosync
  59 reactos/dll/win32/msvfw32         # Autosync
  60 reactos/dll/win32/msxml3          # Synced to Wine-20071230
  61 reactos/dll/win32/netapi32        # Autosync
  62 reactos/dll/win32/objsel          # Autosync
  63 reactos/dll/win32/odbc32          # Out of sync. Depends on port of Linux ODBC.
  64 reactos/dll/win32/odbccp32        # Autosync
  65 reactos/dll/win32/ole32           # Autosync
  66 reactos/dll/win32/oleacc          # Autosync
  67 reactos/dll/win32/oleaut32        # Autosync
  68 reactos/dll/win32/oledlg          # Autosync
  69 reactos/dll/win32/olepro32        # Autosync
  70 reactos/dll/win32/powrprof        # Autosync
  71 reactos/dll/win32/riched20        # Autosync
  72 reactos/dll/win32/riched32        # Autosync
  73 reactos/dll/win32/rpcrt4          # Synced to Wine-0_9_55
  74 reactos/dll/win32/rsabase         # Autosync
  75 reactos/dll/win32/rsaenh          # Autosync
  76 reactos/dll/win32/schannel        # Autosync
  77 reactos/dll/win32/sensapi         # Autosync
  78 reactos/dll/win32/setupapi        # Forked at Wine-20050524
  79 reactos/dll/win32/shell32         # Forked at Wine-20071011
  80 reactos/dll/win32/shdocvw         # Synced to Wine-0_9_5
  81 reactos/dll/win32/shfolder        # Autosync
  82 reactos/dll/win32/shlwapi         # Autosync
  83 reactos/dll/win32/twain_32        # Out of sync
  84 reactos/dll/win32/urlmon          # Autosync
  85 reactos/dll/win32/uxtheme         # Autosync
  86 reactos/dll/win32/version         # Autosync
  87 reactos/dll/win32/wininet         # Autosync
  88 reactos/dll/win32/wintrust        # Out of sync
  89 reactos/dll/win32/winmm           # Forked at Wine-20050628
  90 reactos/dll/win32/winmm/midimap   # Forked at Wine-20050628
  91 reactos/dll/win32/winmm/wavemap   # Forked at Wine-20050628
  92 reactos/dll/win32/wldap32         # Autosync
  93 reactos/dll/win32/wtsapi32        # Autosync
  94 reactos/dll/directx/dinput        # Synced to Wine-0_9_5
  95 reactos/dll/directx/dinput8       # Synced to Wine-0_9_5
  96 reactos/dll/directx/dplay         # Synced to Wine-0_9_5
  97 reactos/dll/directx/dplayx        # Synced to Wine-0_9_5
  98 reactos/dll/directx/dxdiagn       # Synced to Wine-0_9_5
  99
 100 ReactOS shares the following programs with Winehq.
 101
 102 reactos/base/applications/games/winemine  # Out of sync
 103 reactos/base/applications/regedit         # Out of sync
 104 reactos/base/applications/cmdutils/xcopy  # Synced to Wine-0_9_54
 105 reactos/base/system/expand                # Out of sync
 106 reactos/base/system/msiexec               # Synced to Wine-20080105
 107 reactos/base/applications/winhelp         # Synced to Wine-0_9_53
 108 reactos/base/applications/wordpad         # Synced to Wine-0_9_53
 109 reactos/modules/rosapps/winefile          # Synced to Wine-0_9_53
 110 reactos/base/applications/notepad         # Forked at Wine-20041201
 111
 112 In addition the following libs, dlls and source files are mostly based on code ported
 113 from Winehq CVS. If you are looking to update something in these files
 114 check Wine current souces first as it may already be fixed.
 115
 116 reactos/lib/uuid                  # Synced to Wine-20080114
 117
 118 advapi32 -
 119   reactos/dll/win32/advapi32/crypt/*.c          # ekohl says we're not sharing this
 120
 121 gdi32 -
 122   reactos/dll/win32/gdi32/objects/linedda.c     # Out of sync
 123
 124 kernel32 -
 125   reactos/dll/win32/kernel32/misc/errormsg.c    # Out of sync
 126   reactos/dll/win32/kernel32/misc/profile.c     # Out of sync
 127   reactos/dll/win32/kernel32/misc/lcformat.c    # Out of sync
 128
 129 msvcrt -
 130   reactos/dll/win32/msvcrt/wine/*.c             # Out of sync
 131   reactos/lib/sdk/crt/cpp.c                     # Synced at 20071111
 132   reactos/lib/sdk/crt/cppexcept.c               # Synced at 20071111
 133   reactos/lib/sdk/crt/wine                      # Synced at XXXXXXXX
 134
 135 User32 -
 136   reactos/dll/win32/user32/controls/button.c    # Synced at 20071022
 137   reactos/dll/win32/user32/controls/combo.c     # Synced at 20071022
 138   reactos/dll/win32/user32/controls/edit.c      # Synced at 20071022
 139   reactos/dll/win32/user32/controls/icontitle.c # Synced at 20060617
 140   reactos/dll/win32/user32/controls/listbox.c   # Synced at 20071023
 141   reactos/dll/win32/user32/controls/scrollbar.c # Forked
 142   reactos/dll/win32/user32/controls/static.c    # Synced at 20071024
 143
 144   reactos/dll/win32/user32/misc/dde.c           # Synced at 20060623 (dde_misc.c)
 145   reactos/dll/win32/user32/misc/ddeclient.c     # Synced at 20060623
 146   reactos/dll/win32/user32/misc/ddeserver.c     # Synced at 20060623
 147   reactos/dll/win32/user32/misc/exticon.c       # Last sync date unknown
 148   reactos/dll/win32/user32/misc/resources.c     # Forked?
 149   reactos/dll/win32/user32/misc/winhelp.c       # Last sync date unknown
 150   reactos/dll/win32/user32/misc/wsprintf.c      # Synced at 20060623
 151
 152   reactos/dll/win32/user32/windows/defwnd.c     # Forked
 153   reactos/dll/win32/user32/windows/draw.c       # Forked at Wine-20020904 (uitools.c)
 154   reactos/dll/win32/user32/windows/mdi.c        # Synced at 20060703
 155   reactos/dll/win32/user32/windows/menu.c       # Forked
 156   reactos/dll/win32/user32/windows/messagebox.c # Forked
 157   reactos/dll/win32/user32/windows/rect.c       # Forked (uitools.c)
 158   reactos/dll/win32/user32/windows/text.c       # Forked (lstr.c)
 159   reactos/dll/win32/user32/windows/winpos.c     # Forked
 160
 161 Update process for autosync DLLs
 162
 163 *** This process can only be done on Microsoft Windows ***
 164 - Download wineimport.cmd at svn://svn.reactos.org/reactos/trunk/tools/
 165 - Download cvs command line program and be sure to put it in your path
 166   (available at http://ftp.gnu.org/non-gnu/cvs/binary/stable/x86-woe/ )
 167 - Download svn command line program and be sure to put it in your path
 168   (available at http://subversion.tigris.org/servlets/ProjectDocumentList?folderID=91 )
 169 - Download patch command line program and be sure to put it in your path
 170   (available at http://gnuwin32.sourceforge.net/packages/patch.htm )
 171 - Optionally, download junction.exe and put it in your path
 172   (available at http://www.sysinternals.com/Utilities/Junction.html )
 173 - Cd to the directory containing wineimport.cmd
 174 - Run
 175   "wineimport.cmd fullprocessing {path_to_your_reactos_directory} {name_of_the_wine_dll}"
 176 - In case of error, you can
 177   1) add missing definitions to ReactOS headers
 178   2) fix {name_of_the_wine_dll}_ros.diff patch file, by removing outdated changes
 179   3) or modify Wine code, by adding a {name_of_the_wine_dll}_ros.diff patch,
 180      which will be applied after Wine source checkout
 181      DO NOT DIRECTLY MODIFY WINE SOURCE CODE
 182 - Once Wine DLL compiles, install and run ReactOS and search for regressions
 183 - In case of regression, you can
 184   1) Fix ReactOS code (not in the shared DLL)
 185   2) or update the {name_of_the_wine_dll}_ros.diff patch file
 186 - Commit your changes with the "Autosyncing with Wine HEAD" commit message