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 reactos/tools/unicode           # Synced to Wine-20050628
  30 reactos/tools/wpp               # Synced to Wine-20050628
  31 reactos/tools/bin2res           # Resource to binary converter
  32 reactos/tools/winebuild         # Synced to Wine-20050628
  33 reactos/tools/wmc               # Wine Message Compiler
  34 reactos/tools/wrc               # Synced to Wine-20050628
  35 reactos/tools/widl              # Synced to Wine-20050628 (merge back to winehq in progress)
  36
  37 The following libraries are shared with Wine.
  38
  39 reactos/lib/cabinet             # Synced to Wine-20050628
  40 reactos/lib/comctl32            # Synced to Wine-20050628
  41 reactos/lib/comdlg32            # Synced to Wine-20050628
  42 reactos/lib/dinput              # Synced to Wine-20050310
  43 reactos/lib/dinput8             # Synced to Wine-20050628
  44 reactos/lib/icmp                # Synced to Wine-20050628
  45 reactos/lib/iphlpapi            # Out of sync
  46 reactos/lib/imagehlp            # Patches for BindImage need review and submission to winehq.
  47 reactos/lib/msvcrt20            # Out of sync
  48 reactos/lib/mpr                 # Synced to Wine-20050628
  49 reactos/lib/msacm               # Out of sync
  50 reactos/lib/msimg32             # Synced to Wine-20050628
  51 reactos/lib/msi                 # Synced to Wine-20050628
  52 reactos/lib/msvideo             # Out of sync
  53 reactos/lib/netapi32            # Out of sync
  54 reactos/lib/objsel              # Synced to Wine-20050726
  55 reactos/lib/odbc32              # In sync. Depends on port of Linux ODBC.
  56 reactos/lib/ole32               # Synced to Wine-20050628
  57 reactos/lib/oleaut32            # Synced to Wine-20050628
  58 reactos/lib/oledlg              # Synced to Wine-20050628
  59 reactos/lib/olepro32            # Synced to Wine-20050628
  60 reactos/lib/riched20            # Synced to Wine-20050628
  61 reactos/lib/richedit            # Synced to Wine-20050628
  62 reactos/lib/rpcrt4              # Synced to Wine-20050628
  63 reactos/lib/setupapi            # Synced to Wine-20050524
  64 reactos/lib/shell32             # Synced to Wine-20050628
  65 reactos/lib/shdocvw             # Synced to Wine-20050628
  66 reactos/lib/shlwapi             # Synced to Wine-20050628
  67 reactos/lib/twain               # Out of sync
  68 reactos/lib/urlmon              # Synced to Wine-20050628
  69 reactos/lib/uxtheme             # Synced to Wine-20050703
  70 reactos/lib/version             # Out of sync
  71 reactos/lib/wininet             # Out of sync
  72 reactos/lib/winmm               # Synced to Wine-20050628
  73 reactos/lib/winmm/midimap       # Synced to Wine-20050628
  74 reactos/lib/winmm/wavemap       # Synced to Wine-20050628
  75
  76 ReactOS shares the following programs with Winehq.
  77 reactos/subsys/system/regedit   # Out of sync
  78 reactos/subsys/system/expand    # Out of sync
  79 reactos/subsys/system/msiexec   # Synced to Wine-20050628
  80
  81 In addition the following libs, dlls and source files are mostly based on code ported
  82 from Winehq CVS. If you are looking to update something in these files
  83 check Wine current souces first as it may already be fixed.
  84
  85 reactos/lib/imm32               #
  86 reactos/lib/uuid                #
  87
  88 advapi32 -
  89   reactos/lib/advapi32/crypt/*.c        # ekohl says we're not sharing this
  90
  91 gdi32 -
  92   reactos/lib/gdi32/objects/linedda.c   # Out of sync
  93
  94 kernel32 -
  95   reactos/lib/kernel32/misc/errormsg.c  # Out of sync
  96   reactos/lib/kernel32/misc/profile.c   # Out of sync
  97   reactos/lib/kernel32/misc/lcformat.c  # Out of sync
  98
  99 msvcrt -
 100   reactos/lib/msvcrt/wine/*.c           # Out of sync
 101
 102 User32 -
 103   reactos/lib/user32/controls/button.c  # Out of sync
 104   reactos/lib/user32/controls/edit.c    # Out of sync
 105   reactos/lib/user32/controls/static.c  # Out of sync
 106   reactos/lib/user32/misc/wsprintf.c    # Out of sync
 107   reactos/lib/user32/windows/mdi.c      # Out of sync
 108
 109 - Cd to the parent directory of your top-level "reactos" directory
 110 - Check out the Wine release: "cvs -d :pserver:cvs@cvs.winehq.com:2401/home/wine co wine -r Wine-20050211"
 111 - Create "vendor" directory (as a sibling of your top-level "reactos" directory)
 112 - Cd to the vendor dir and check out the current vendor drop:
 113   "svn co svn://svn.reactos.com/vendor/wine".
 114 - For each component shared with Wine (e.g. cabinet):
 115   "del vendor\wine\dlls\cabinet\current\*"
 116   "copy wine\dlls\cabinet vendor\wine\dlls\cabinet\current"
 117   "del vendor\wine\dlls\cabinet\current\.cvsignore"
 118   Check svn status, svn add/delete files as needed
 119   Tag new Wine release "svn copy vendor\wine\dlls\cabinet\current vendor\wine\dlls\cabinet\Wine-20050211"
 120 - Commit the vendor drop: svn commit vendor\wine -m "Wine-20050211 vendor drop"
 121 - Determine the revision number of the last Wine tag by looking at http://svn.reactos.com/viewcvs/tags/
 122   and finding the last Wine-yyyymmdd-sync tag, e.g. Wine-20050111-sync had rev 13007
 123 - For each component shared with Wine (e.g. cabinet):
 124 - "cd reactos\lib\cabinet"
 125 - Check for changes in the ReactOS tree: "svn diff -r 13007" (13007 is the revno of the previous sync).
 126   If any changes are found, see if they're present in the Wine code. If not, submit to WineHQ
 127   if apropriate.
 128 - Merge in Wine changes:
 129   "svn merge svn://svn.reactos.com/vendor/wine/dlls/cabinet/Wine-20050111
 130    svn://svn.reactos.com/vendor/wine/dlls/cabinet/current"
 131 - Fix any merge conflicts
 132 - Build and test (building will sometimes require adjusting header files)
 133 - Check which files were changed: "svn status"
 134 - For each of the changed files, get the WineHQ CVS log. Copy author and CVS commit message into a
 135   commit log
 136 - Commit changed files "svn commit" using generated commit log as commit message