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