annotate README.Watcom @ 3415:1756b9569141

Adam Strzelecki to SDL Actually after my patch commited in r4928 MinGW configure seems to generate broken Makefile due MSYS bash bug. (Attaching cure/patch below) The problem is that: TEST=`echo 'one\\ two\\ three\\'` echo "$TEST" Should echo: one\ two\ three\ Does it on Linux, Mac.. all UNIX but not on MSYS (MinGW) which outputs: one\two\three\ (new lines removed, probably it doesn't like backslashes) Probably this bug should be submitted to MSYS team, but not waiting till MSYS gets it fixed (they have very slow release cycles) here goes simple cure... My patch simply replaces single quoted SED rules where we needed newlien injection with double quoted ones. Tested on Mac, Linux & MinGW. Please review it ASAP coz this may be showstopper for everybody compiling with MinGW.
author Sam Lantinga <slouken@libsdl.org>
date Wed, 28 Oct 2009 04:27:50 +0000
parents 488eba319a25
children 8c72321542f6
rev   line source
1773
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
1
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
2 Using SDL under Windows with the OpenWatcom compiler
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
3 ====================================================
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
4
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
5 Prerequisites
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
6 -------------
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
7
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
8 I have done the port under Windows XP Home with SP2 installed. Windows
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
9 2000 should also be working. I'm not so sure about ancient Windows NT,
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
10 since only DirectX 3 is available there. Building should be possible,
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
11 but running the compiled applications will probalbly fail with
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
12 SDL_VIDEODRIVER=directx. The windib driver should work, though.
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
13
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
14 To compile and use the SDL with Open Watcom you will need the following:
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
15 - Open Watcom compiler. I used version 1.5. The environment variables
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
16 PATH, WATCOM and INCLUDE need to be set appropriately - please consult
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
17 the OpenWatcom documentation and instructions given during the
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
18 installation of the compiler.
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
19 My setup looks like this in owvars.bat:
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
20 set WATCOM=C:\watcom
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
21 set INCLUDE=%WATCOM%\h;%WATCOM%\h\nt
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
22 set PATH=%PATH%;%WATCOM%\binnt;%WATCOM%\binw
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
23 - A fairly recent DirectX SDK. The original unmodified DX8 SDK works, as
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
24 well as the minimal DirectX 7 SDK from the Allegro download site
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
25 (<http://alleg.sourceforge.net/files/dx70_min.zip>).
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
26 - The SDL sources from Subversion
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
27 - The file Watcom-Win32.zip (now available in Subversion)
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
28
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
29
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
30 Building the Library
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
31 --------------------
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
32
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
33 1) In the SDL base directory extract the archive Watcom-Win32.zip. This
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
34 creates a subdirectory named 'watcom'.
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
35 2) The makefile expects the environment variable DXDIR to be set to the
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
36 base directory of a DirectX SDK. I have tried a stock DX8 SDK from
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
37 Microsoft as well as the minimal DirectX 7 SDK from the Allegro
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
38 download site.
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
39 You can also edit the makefile directly and hard code your path to
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
40 the SDK on your system.
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
41 I have this in my setup:
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
42 set DXDIR=D:\devel\DX8_SDK
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
43 3) Enter the watcom directory and run
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
44 wmake sdl
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
45 4) All tests from the test directory are working and can be built by
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
46 running
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
47 wmake tests
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
48
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
49 Notes:
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
50
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
51 The makefile offers some options to tweak the way the library is built.
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
52 You have at your disposal the option to build a static (default)
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
53 library, or a DLL (with tgt=dll). You can also choose whether to build
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
54 a Release (default) or a Debug version (with build=debug) of the tests
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
55 and library. Please consult the usage comment at the top of the
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
56 makefile for usage instructions.
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
57
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
58 If you specify a test target (i.e. 'wmake tests' for all tests, or
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
59 selected targets like 'wmake testgl testvidinfo testoverlay2'), the
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
60 tests are always freshly compiled and linked. This is done to
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
61 minimise hassle when switching between library versions (static vs.
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
62 DLL), because they require subtly different options.
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
63 Also, the test executables are put directly into the test directory,
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
64 so they can find their data files. The clean target of the makefile
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
65 removes the test executables and the SDL.dll file from the test
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
66 directory.
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
67
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
68 To use the library in your own projects with Open Watcom, you can use
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
69 the way the tests are built as base of your own build environment.
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
70
1888
488eba319a25 ------- Comment #5 From Marc Peter 2006-06-25 18:03 [reply] -------
Sam Lantinga <slouken@libsdl.org>
parents: 1773
diff changeset
71 The library can also be built with the stack calling convention of the
488eba319a25 ------- Comment #5 From Marc Peter 2006-06-25 18:03 [reply] -------
Sam Lantinga <slouken@libsdl.org>
parents: 1773
diff changeset
72 compiler (-6s instead of -6r).
488eba319a25 ------- Comment #5 From Marc Peter 2006-06-25 18:03 [reply] -------
Sam Lantinga <slouken@libsdl.org>
parents: 1773
diff changeset
73
1773
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
74
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
75 Test applications
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
76 -----------------
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
77
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
78 I've tried to make all tests work. The following table gives an overview
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
79 of the current status.
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
80
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
81 Testname Status
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
82 ~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
83 checkkeys +
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
84 graywin +
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
85 loopwave +
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
86 testalpha +
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
87 testbitmap +
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
88 testdyngl +
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
89 testerror +
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
90 testfile +
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
91 testgamma +
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
92 testgl +
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
93 testhread +
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
94 testiconv - (all failed)
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
95 testkeys +
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
96 testlock +
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
97 testoverlay + (needs 'set SDL_VIDEODRIVER=directx')
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
98 testoverlay2 + (needs 'set SDL_VIDEODRIVER=directx')
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
99 testpalette +
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
100 testplatform +
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
101 testsem +
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
102 testsprite +
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
103 testtimer +
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
104 testver +
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
105 testvidinfo +
1888
488eba319a25 ------- Comment #5 From Marc Peter 2006-06-25 18:03 [reply] -------
Sam Lantinga <slouken@libsdl.org>
parents: 1773
diff changeset
106 testwin ? (fading doesn't seem right)
1773
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
107 testwm +
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
108 torturethread +
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
109 testcdrom +
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
110 testjoystick not tested
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
111 threadwin +
1888
488eba319a25 ------- Comment #5 From Marc Peter 2006-06-25 18:03 [reply] -------
Sam Lantinga <slouken@libsdl.org>
parents: 1773
diff changeset
112 testcursor +
1773
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
113
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
114
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
115 TODO
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
116 ----
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
117
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
118 There is room for further improvement:
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
119 - Test joystick functionality.
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
120 - Investigate fading issue in 'testwin' test.
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
121 - Fix the UTF-8 support.
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
122 - Adapt the makefile/object file list to support more target systems
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
123 - Use "#pragma aux" syntax for the CPU info functions.
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
124
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
125
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
126 Questions and Comments
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
127 ----------------------
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
128
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
129 Please direct any questions or comments to me: <mailto:macpete@gmx.de>
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
130
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
131 Happy Coding!
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
132
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
133 Marc Peter