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