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.com. Otherwise please send a patch to both
  14 wine-patches@winehq.com and ros-dev@reactos.com
  15
  16 When porting a dll from WINE to ReactOS please take a look at how
  17 comctl32 has been imported. We start by creating a makefile that has
  18 a target defined like so:
  19
  20 TARGET_TYPE = winedll
  21
  22 This will cause the reactos build system to look for a file called
  23 makefile.ros-template. This file contains all of the information needed
  24 for the ReactOS build system to make use of the WINE Makefile.in.
  25 This will allow you to use the WINE tools and librarys with very little
  26 work to import a new dll.
  27
  28 The following build tools are shared with Wine.
  29
  30 reactos/tools/unicode             # Synced to Wine-0_9_5
  31 reactos/tools/wpp                 # Synced to Wine-0_9_5
  32 reactos/tools/bin2res             # Resource to binary converter
  33 reactos/tools/winebuild           # Synced to Wine-0_9_5
  34 reactos/tools/wmc                 # Synced to Wine-0_9_5
  35 reactos/tools/wrc                 # Synced to Wine-0_9_5
  36 reactos/tools/widl                # Synced to Wine-20060729
  37
  38 The following libraries are shared with Wine.
  39
  40 reactos/dll/win32/advpack         # Autosync
  41 reactos/dll/win32/avifil32        # Autosync
  42 reactos/dll/win32/cabinet         # Autosync
  43 reactos/dll/win32/comctl32        # Autosync
  44 reactos/dll/win32/comdlg32        # Synced to Wine-0_9_16
  45 reactos/dll/win32/crypt32         # Autosync
  46 reactos/dll/win32/cryptdll        # Autosync
  47 reactos/dll/win32/dbghelp         #
  48 reactos/dll/win32/icmp            # Synced to Wine-0_9_10
  49 reactos/dll/win32/imm32           # Autosync
  50 reactos/dll/win32/iphlpapi        # Out of sync
  51 reactos/dll/win32/imagehlp        # Patches for BindImage need review and submission to winehq.
  52 reactos/dll/win32/lz32            # Autosync
  53 reactos/dll/win32/mapi32          # Autosync
  54 reactos/dll/win32/msvcrt20        # Out of sync
  55 reactos/dll/win32/mpr             # Autosync
  56 reactos/dll/win32/msacm           # Out of sync
  57 reactos/dll/win32/msimg32         # Autosync
  58 reactos/dll/win32/msi             # Autosync
  59 reactos/dll/win32/msvideo         # Out of sync
  60 reactos/dll/win32/netapi32        # Synced to Wine-0_9_5
  61 reactos/dll/win32/objsel          # Autosync
  62 reactos/dll/win32/odbc32          # Out of sync. Depends on port of Linux ODBC.
  63 reactos/dll/win32/odbccp32        # Autosync
  64 reactos/dll/win32/ole32           # Synced to Wine-0_9_5
  65 reactos/dll/win32/oleacc          # Autosync
  66 reactos/dll/win32/oleaut32        # Synced to Wine-0_9_10
  67 reactos/dll/win32/oledlg          # Autosync
  68 reactos/dll/win32/olepro32        # Autosync
  69 reactos/dll/win32/powrprof        # Synced to Wine-0_9_14
  70 reactos/dll/win32/riched20        # Synced to Wine-0_9_5
  71 reactos/dll/win32/riched32        # Autosync
  72 reactos/dll/win32/rpcrt4          # Synced to Wine-0_9_10
  73 reactos/dll/win32/sensapi         # Autosync
  74 reactos/dll/win32/setupapi        # Forked at Wine-20050524
  75 reactos/dll/win32/shell32         # Synced to Wine-0_9_5
  76 reactos/dll/win32/shdocvw         # Synced to Wine-0_9_5
  77 reactos/dll/win32/shfolder        # Autosync
  78 reactos/dll/win32/shlwapi         # Synced to Wine-0_9_5
  79 reactos/dll/win32/twain           # Out of sync
  80 reactos/dll/win32/urlmon          # Synced to Wine-0_9_10
  81 reactos/dll/win32/uxtheme         # Autosync
  82 reactos/dll/win32/version         # Synced at 20060509
  83 reactos/dll/win32/wininet         # Synced to Wine-0_9_10
  84 reactos/dll/win32/wintrust        # Autosync
  85 reactos/dll/win32/winmm           # Forked at Wine-20050628
  86 reactos/dll/win32/winmm/midimap   # Forked at Wine-20050628
  87 reactos/dll/win32/winmm/wavemap   # Forked at Wine-20050628
  88 reactos/dll/directx/dinput        # Synced to Wine-0_9_5
  89 reactos/dll/directx/dinput8       # Synced to Wine-0_9_5
  90 reactos/dll/directx/dplay         # Synced to Wine-0_9_5
  91 reactos/dll/directx/dplayx        # Synced to Wine-0_9_5
  92 reactos/dll/directx/dxdiagn       # Synced to Wine-0_9_5
  93
  94 ReactOS shares the following programs with Winehq.
  95
  96 reactos/base/applications/games/winemine  # Out of sync
  97 reactos/base/applications/regedit         # Out of sync
  98 reactos/base/system/expand                # Out of sync
  99 reactos/base/system/msiexec               # Synced to Wine-0_9_3
 100
 101 In addition the following libs, dlls and source files are mostly based on code ported
 102 from Winehq CVS. If you are looking to update something in these files
 103 check Wine current souces first as it may already be fixed.
 104
 105 reactos/lib/uuid                  #
 106
 107 advapi32 -
 108   reactos/dll/win32/advapi32/crypt/*.c          # ekohl says we're not sharing this
 109
 110 gdi32 -
 111   reactos/dll/win32/gdi32/objects/linedda.c     # Out of sync
 112
 113 kernel32 -
 114   reactos/dll/win32/kernel32/misc/errormsg.c    # Out of sync
 115   reactos/dll/win32/kernel32/misc/profile.c     # Out of sync
 116   reactos/dll/win32/kernel32/misc/lcformat.c    # Out of sync
 117
 118 msvcrt -
 119   reactos/dll/win32/msvcrt/wine/*.c             # Out of sync
 120
 121 User32 -
 122   reactos/dll/win32/user32/controls/button.c    # Synced at 20060621
 123   reactos/dll/win32/user32/controls/combo.c     # Synced at 20060904
 124   reactos/dll/win32/user32/controls/edit.c      # Synced at 20060710
 125   reactos/dll/win32/user32/controls/icontitle.c # Synced at 20060617
 126   reactos/dll/win32/user32/controls/listbox.c   # Synced at 20060616
 127   reactos/dll/win32/user32/controls/scrollbar.c # Forked
 128   reactos/dll/win32/user32/controls/static.c    # Synced at 20060908
 129
 130   reactos/dll/win32/user32/misc/dde.c           # Synced at 20060623 (dde_misc.c)
 131   reactos/dll/win32/user32/misc/ddeclient.c     # Synced at 20060623
 132   reactos/dll/win32/user32/misc/ddeserver.c     # Synced at 20060623
 133   reactos/dll/win32/user32/misc/exticon.c       # Last sync date unknown
 134   reactos/dll/win32/user32/misc/resources.c     # Forked?
 135   reactos/dll/win32/user32/misc/winhelp.c       # Last sync date unknown
 136   reactos/dll/win32/user32/misc/wsprintf.c      # Synced at 20060623
 137
 138   reactos/dll/win32/user32/windows/defwnd.c     # Forked
 139   reactos/dll/win32/user32/windows/draw.c       # Forked at Wine-20020904 (uitools.c)
 140   reactos/dll/win32/user32/windows/mdi.c        # Synced at 20060703
 141   reactos/dll/win32/user32/windows/menu.c       # Forked
 142   reactos/dll/win32/user32/windows/messagebox.c # Forked
 143   reactos/dll/win32/user32/windows/rect.c       # Forked (uitools.c)
 144   reactos/dll/win32/user32/windows/text.c       # Forked (lstr.c)
 145   reactos/dll/win32/user32/windows/winpos.c     # Forked
 146
 147 Update process for shared DLLs
 148
 149 - Cd to the parent directory of your top-level "reactos" directory
 150 - Check out the Wine release: "cvs -d :pserver:cvs@cvs.winehq.com:2401/home/wine co wine -r Wine-20050211"
 151 - Create "vendor" directory (as a sibling of your top-level "reactos" directory)
 152 - Cd to the vendor dir and check out the current vendor drop:
 153   "svn co svn://svn.reactos.org/reactos/vendor/wine".
 154 - For each component shared with Wine (e.g. cabinet):
 155   "del vendor\wine\dlls\cabinet\current\*"
 156   "copy wine\dlls\cabinet vendor\wine\dlls\cabinet\current"
 157   "del vendor\wine\dlls\cabinet\current\.cvsignore"
 158   Check svn status, svn add/delete files as needed
 159   Tag new Wine release "svn copy vendor\wine\dlls\cabinet\current vendor\wine\dlls\cabinet\Wine-20050211"
 160 - Commit the vendor drop: svn commit vendor\wine -m "Wine-20050211 vendor drop"
 161 - Determine the revision number of the last Wine tag by looking at http://svn.reactos.ru/svn/reactos/tags/
 162   and finding the last Wine-yyyymmdd-sync tag, e.g. Wine-20050111-sync had rev 13007
 163 - For each component shared with Wine (e.g. cabinet):
 164 - "cd reactos\lib\cabinet"
 165 - Check for changes in the ReactOS tree: "svn diff -r 13007" (13007 is the revno of the previous sync).
 166   If any changes are found, see if they're present in the Wine code. If not, submit to WineHQ
 167   if apropriate.
 168 - Merge in Wine changes:
 169   "svn merge svn://svn.reactos.org/vendor/wine/dlls/cabinet/Wine-20050111
 170    svn://svn.reactos.org/vendor/wine/dlls/cabinet/current"
 171 - Fix any merge conflicts
 172 - Build and test (building will sometimes require adjusting header files)
 173 - Check which files were changed: "svn status"
 174 - For each of the changed files, get the WineHQ CVS log. Copy author and CVS commit message into a
 175   commit log
 176 - Commit changed files "svn commit" using generated commit log as commit message