6231007dc97fb67f214e03e5d7a30f5008e1246b
[reactos.git] / 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-20080105
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-20080105
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/system/expand # Out of sync
105 reactos/base/system/msiexec # Synced to Wine-20080105
106 reactos/base/applications/winhelp # Synced to Wine-0_9_53
107 reactos/base/applications/wordpad # Synced to Wine-0_9_53
108 reactos/modules/rosapps/winefile # Synced to Wine-0_9_53
109 reactos/base/applications/notepad # Forked at Wine-20041201
110
111 In addition the following libs, dlls and source files are mostly based on code ported
112 from Winehq CVS. If you are looking to update something in these files
113 check Wine current souces first as it may already be fixed.
114
115 reactos/lib/uuid # Synced to Wine-20080114
116
117 advapi32 -
118 reactos/dll/win32/advapi32/crypt/*.c # ekohl says we're not sharing this
119
120 gdi32 -
121 reactos/dll/win32/gdi32/objects/linedda.c # Out of sync
122
123 kernel32 -
124 reactos/dll/win32/kernel32/misc/errormsg.c # Out of sync
125 reactos/dll/win32/kernel32/misc/profile.c # Out of sync
126 reactos/dll/win32/kernel32/misc/lcformat.c # Out of sync
127
128 msvcrt -
129 reactos/dll/win32/msvcrt/wine/*.c # Out of sync
130 reactos/lib/sdk/crt/cpp.c # Synced at 20071111
131 reactos/lib/sdk/crt/cppexcept.c # Synced at 20071111
132 reactos/lib/sdk/crt/wine # Synced at XXXXXXXX
133
134 User32 -
135 reactos/dll/win32/user32/controls/button.c # Synced at 20071022
136 reactos/dll/win32/user32/controls/combo.c # Synced at 20071022
137 reactos/dll/win32/user32/controls/edit.c # Synced at 20071022
138 reactos/dll/win32/user32/controls/icontitle.c # Synced at 20060617
139 reactos/dll/win32/user32/controls/listbox.c # Synced at 20071023
140 reactos/dll/win32/user32/controls/scrollbar.c # Forked
141 reactos/dll/win32/user32/controls/static.c # Synced at 20071024
142
143 reactos/dll/win32/user32/misc/dde.c # Synced at 20060623 (dde_misc.c)
144 reactos/dll/win32/user32/misc/ddeclient.c # Synced at 20060623
145 reactos/dll/win32/user32/misc/ddeserver.c # Synced at 20060623
146 reactos/dll/win32/user32/misc/exticon.c # Last sync date unknown
147 reactos/dll/win32/user32/misc/resources.c # Forked?
148 reactos/dll/win32/user32/misc/winhelp.c # Last sync date unknown
149 reactos/dll/win32/user32/misc/wsprintf.c # Synced at 20060623
150
151 reactos/dll/win32/user32/windows/defwnd.c # Forked
152 reactos/dll/win32/user32/windows/draw.c # Forked at Wine-20020904 (uitools.c)
153 reactos/dll/win32/user32/windows/mdi.c # Synced at 20060703
154 reactos/dll/win32/user32/windows/menu.c # Forked
155 reactos/dll/win32/user32/windows/messagebox.c # Forked
156 reactos/dll/win32/user32/windows/rect.c # Forked (uitools.c)
157 reactos/dll/win32/user32/windows/text.c # Forked (lstr.c)
158 reactos/dll/win32/user32/windows/winpos.c # Forked
159
160 Update process for autosync DLLs
161
162 *** This process can only be done on Microsoft Windows ***
163 - Download wineimport.cmd at svn://svn.reactos.org/reactos/trunk/tools/
164 - Download cvs command line program and be sure to put it in your path
165 (available at http://ftp.gnu.org/non-gnu/cvs/binary/stable/x86-woe/ )
166 - Download svn command line program and be sure to put it in your path
167 (available at http://subversion.tigris.org/servlets/ProjectDocumentList?folderID=91 )
168 - Download patch command line program and be sure to put it in your path
169 (available at http://gnuwin32.sourceforge.net/packages/patch.htm )
170 - Optionally, download junction.exe and put it in your path
171 (available at http://www.sysinternals.com/Utilities/Junction.html )
172 - Cd to the directory containing wineimport.cmd
173 - Run
174 "wineimport.cmd fullprocessing {path_to_your_reactos_directory} {name_of_the_wine_dll}"
175 - In case of error, you can
176 1) add missing definitions to ReactOS headers
177 2) fix {name_of_the_wine_dll}_ros.diff patch file, by removing outdated changes
178 3) or modify Wine code, by adding a {name_of_the_wine_dll}_ros.diff patch,
179 which will be applied after Wine source checkout
180 DO NOT DIRECTLY MODIFY WINE SOURCE CODE
181 - Once Wine DLL compiles, install and run ReactOS and search for regressions
182 - In case of regression, you can
183 1) Fix ReactOS code (not in the shared DLL)
184 2) or update the {name_of_the_wine_dll}_ros.diff patch file
185 - Commit your changes with the "Autosyncing with Wine HEAD" commit message