From c63575e2f6f713b004e6863c505aac8ef025d067 Mon Sep 17 00:00:00 2001 From: Sam Lantinga Date: Wed, 8 Mar 2006 08:30:17 +0000 Subject: [PATCH] Added documentation on how to build a completely useless SDL library. :) --- Makefile.minimal | 38 +++++++++++++++++++++++ README.Porting | 56 ++++++++++++++++++++++++++++++++++ include/SDL_config.h | 24 ++++++++++++++- include/SDL_config.h.minimal | 24 ++++++++++++++- src/timer/dummy/SDL_systimer.c | 3 ++ test/.cvsignore | 6 ++-- test/testcdrom.c | 4 +-- test/testfile.c | 2 +- test/testtimer.c | 2 +- 9 files changed, 149 insertions(+), 10 deletions(-) create mode 100644 Makefile.minimal create mode 100644 README.Porting diff --git a/Makefile.minimal b/Makefile.minimal new file mode 100644 index 000000000..52b444a53 --- /dev/null +++ b/Makefile.minimal @@ -0,0 +1,38 @@ +# Makefile to build the SDL library + +INCLUDE = -I./include +CFLAGS = -g -O2 $(INCLUDE) +AR = ar +RANLIB = ranlib + +TARGET = libSDL.a +SOURCES = \ + src/*.c \ + src/audio/*.c \ + src/cdrom/*.c \ + src/cpuinfo/*.c \ + src/events/*.c \ + src/file/*.c \ + src/joystick/*.c \ + src/stdlib/*.c \ + src/thread/*.c \ + src/timer/*.c \ + src/video/*.c \ + src/audio/disk/*.c \ + src/video/dummy/*.c \ + src/joystick/dummy/*.c \ + src/cdrom/dummy/*.c \ + src/thread/generic/*.c \ + src/timer/dummy/*.c \ + src/loadso/dummy/*.c \ + +OBJECTS = $(shell echo $(SOURCES) | sed -e 's,\.c,\.o,g') + +all: $(TARGET) + +$(TARGET): $(OBJECTS) + $(AR) crv $@ $^ + $(RANLIB) $@ + +clean: + rm -f $(TARGET) $(OBJECTS) diff --git a/README.Porting b/README.Porting new file mode 100644 index 000000000..df619934f --- /dev/null +++ b/README.Porting @@ -0,0 +1,56 @@ + +* Porting To A New Platform + + The first thing you have to do when porting to a new platform, is look at +include/SDL_platform.h and create an entry there for your operating system. +The standard format is __PLATFORM__, where PLATFORM is the name of the OS. +Ideally SDL_platform.h will be able to auto-detect the system it's building +on based on C preprocessor symbols. + +There are two basic ways of building SDL at the moment: + +1. The "UNIX" way: ./configure; make; make install + + If you have a GNUish system, then you might try this. Edit configure.in, + take a look at the large section labelled: + "Set up the configuration based on the target platform!" + Add a section for your platform, and then re-run autogen.sh and build! + +2. Using an IDE: + + If you're using an IDE or other non-configure build system, you'll probably + want to create a custom SDL_config.h for your platform. Edit SDL_config.h, + add a section for your platform, and create a custom SDL_config_{platform}.h, + based on SDL_config.h.minimal and SDL_config.h.in + + Add the top level include directory to the header search path, and then add + the following sources to the project: + src/*.c + src/audio/*.c + src/cdrom/*.c + src/cpuinfo/*.c + src/events/*.c + src/file/*.c + src/joystick/*.c + src/stdlib/*.c + src/thread/*.c + src/timer/*.c + src/video/*.c + src/audio/disk/*.c + src/video/dummy/*.c + src/joystick/dummy/*.c + src/cdrom/dummy/*.c + src/thread/generic/*.c + src/timer/dummy/*.c + src/loadso/dummy/*.c + + +Once you have a working library without any drivers, you can go back to each +of the major subsystems and start implementing drivers for your platform. + +If you have any questions, don't hesitate to ask on the SDL mailing list: + http://www.libsdl.org/mailing-list.php + +Enjoy! + Sam Lantinga (slouken@libsdl.org) + diff --git a/include/SDL_config.h b/include/SDL_config.h index d72b9c573..67240c4e6 100644 --- a/include/SDL_config.h +++ b/include/SDL_config.h @@ -51,6 +51,28 @@ typedef signed int int32_t; typedef unsigned int uint32_t; typedef unsigned int size_t; typedef unsigned long uintptr_t; -#endif + +/* Enable the disk audio driver (src/audio/disk/\*.c) */ +#define SDL_AUDIO_DRIVER_DISK 1 + +/* Enable the stub cdrom driver (src/cdrom/dummy/\*.c) */ +#define SDL_CDROM_DISABLED 1 + +/* Enable the stub joystick driver (src/joystick/dummy/\*.c) */ +#define SDL_JOYSTICK_DISABLED 1 + +/* Enable the stub shared object loader (src/loadso/dummy/\*.c) */ +#define SDL_LOADSO_DISABLED 1 + +/* Enable the stub thread support (src/thread/generic/\*.c) */ +#define SDL_THREADS_DISABLED 1 + +/* Enable the stub timer support (src/timer/dummy/\*.c) */ +#define SDL_TIMERS_DISABLED 1 + +/* Enable the dummy video driver (src/video/dummy/\*.c) */ +#define SDL_VIDEO_DRIVER_DUMMY 1 + +#endif /* platform config */ #endif /* _SDL_config_h */ diff --git a/include/SDL_config.h.minimal b/include/SDL_config.h.minimal index d72b9c573..67240c4e6 100644 --- a/include/SDL_config.h.minimal +++ b/include/SDL_config.h.minimal @@ -51,6 +51,28 @@ typedef signed int int32_t; typedef unsigned int uint32_t; typedef unsigned int size_t; typedef unsigned long uintptr_t; -#endif + +/* Enable the disk audio driver (src/audio/disk/\*.c) */ +#define SDL_AUDIO_DRIVER_DISK 1 + +/* Enable the stub cdrom driver (src/cdrom/dummy/\*.c) */ +#define SDL_CDROM_DISABLED 1 + +/* Enable the stub joystick driver (src/joystick/dummy/\*.c) */ +#define SDL_JOYSTICK_DISABLED 1 + +/* Enable the stub shared object loader (src/loadso/dummy/\*.c) */ +#define SDL_LOADSO_DISABLED 1 + +/* Enable the stub thread support (src/thread/generic/\*.c) */ +#define SDL_THREADS_DISABLED 1 + +/* Enable the stub timer support (src/timer/dummy/\*.c) */ +#define SDL_TIMERS_DISABLED 1 + +/* Enable the dummy video driver (src/video/dummy/\*.c) */ +#define SDL_VIDEO_DRIVER_DUMMY 1 + +#endif /* platform config */ #endif /* _SDL_config_h */ diff --git a/src/timer/dummy/SDL_systimer.c b/src/timer/dummy/SDL_systimer.c index 4d6050e6e..51e8f74be 100644 --- a/src/timer/dummy/SDL_systimer.c +++ b/src/timer/dummy/SDL_systimer.c @@ -21,6 +21,9 @@ */ #include "SDL_config.h" +#include "SDL_timer.h" +#include "../SDL_timer_c.h" + void SDL_StartTicks(void) { } diff --git a/test/.cvsignore b/test/.cvsignore index 4d8330155..cc76e1f45 100644 --- a/test/.cvsignore +++ b/test/.cvsignore @@ -15,10 +15,9 @@ testalpha testbitmap testblitspeed testcdrom -testcpuinfo testdyngl -testendian testerror +testfile testgamma testgl testhread @@ -28,13 +27,12 @@ testlock testoverlay testoverlay2 testpalette +testplatform testsem testsprite testtimer -testtypes testver testvidinfo testwin testwm -threadwin torturethread diff --git a/test/testcdrom.c b/test/testcdrom.c index 9a962a82b..782a66cc3 100644 --- a/test/testcdrom.c +++ b/test/testcdrom.c @@ -2,9 +2,9 @@ /* Test the SDL CD-ROM audio functions */ #include -#include -#include +#include #include +#include #include "SDL.h" diff --git a/test/testfile.c b/test/testfile.c index 4694a02d4..7badc6379 100644 --- a/test/testfile.c +++ b/test/testfile.c @@ -1,7 +1,7 @@ /* sanity tests on SDL_rwops.c (usefull for alternative implementations of stdio rwops) */ - +#include #include "SDL.h" #include "SDL_endian.h" diff --git a/test/testtimer.c b/test/testtimer.c index 02b533cbb..d2e53a234 100644 --- a/test/testtimer.c +++ b/test/testtimer.c @@ -37,7 +37,7 @@ int main(int argc, char *argv[]) SDL_TimerID t1, t2, t3; if ( SDL_Init(SDL_INIT_TIMER) < 0 ) { - fprintf(stderr, "Couldn't load SDL: %s\n", SDL_GetError()); + fprintf(stderr, "Couldn't initialize SDL: %s\n", SDL_GetError()); return(1); }