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