Added initial support for EPOC/Symbian OS (thanks Hannu!)

libsdl-org · Sep 11, 2001 · 103c5f3 · 103c5f3
1 parent f1e7697
commit 103c5f3
Show file tree

Hide file tree

Showing 22 changed files with 2,103 additions and 17 deletions.
diff --git a/README.Epoc b/README.Epoc
@@ -0,0 +1,87 @@
+31.8.2001 HJV
+
+SDL for EPOC/Symbian OS
+=======================
+
+This is an Epoc port of SDL (1.2.0). It is not yet complete, but good enough for starting to port all those wonderful SDL based demos, games and other programs to Epoc! I have tested a bunch of demos and test programs in Nokia 9210 Communicator, which is a fancy device with combined PDA/GSM phone features, Symbian OS (Crystal), a full keyboard and a color screen (640x200x12bit).
+
+Btw. Also SDLDoom works over SDL Epoc port now (CDoom)!
+
+
+How to install to device
+========================
+
+Extract binary packets of the demo and test programs and copy the files to N9210.
+
+
+How to use
+==========
+
+Run exe's from the File manager. The Caps lock key enables or disables the virtual cursor. 
+The Esc key quits demo programs.
+Function keys are mapped as follows: 
+- F1=chr+q, F2=chr+w,..., F8=chr+i, 
+- F9=chr+a,..., F12=chr+d.
+
+In Crystal, Exe programs do not appear in task list nor in Extras :-(
+
+
+How to build
+============
+
+Building SDL, SDL_IMAGE and tests & demos:
+- Build files are in "\sdl\epoc\" and "\sdl_image\epoc\" directories
+- Building as usual: "bldmake bldfiles" "abld build wins udeb" "abld build armi urel"
+- Test and demos programs are build: "abld test build wins udeb" "abld test build armi urel" 
+
+
+Building and sources
+====================
+Information about the Epoc implementation: 
+- Made over SDL 1.2.0
+- Ported sources: SDL, SDL_image, xflame, fire, warp, newvox, graywin, testalpha, SDLDoom(CDoom)
+- Test programs do not have any major changes: usually only screen size and depth is 
+  changed for 9210, if needed
+- Like in all the other platform implementations, the Epoc specific code is in "Epoc" subdirectories. All build files for Epoc are in the directory \sdl\epoc\. Adding a new OS support requires always some changes also in generic files (search for "#ifdef __SYMBIAN32__").
+- Currently, two resolutions and bit depths are supported: 320x200 and 640x200 with 8 or 12 bit color.
+- I addition, two faked resolutions are supported: 640x400, 640x480. These are implemented by shrinking the screen vertically i.e. only every second scanline is drawn. This can be used for testing and for non-resource intensive programs. Thought, using faked resolutions is a waste of memory and cpu power! 
+
+Change history
+==============
+
+31.8.2001 Alpha 0.2:
+- Now you should build ARMI binaries instead of THUMB. It runs faster. 
+- sdl_main.cpp: removed check for existing instance of sdlprogram
+- sdl_error.h: Added debug macros under conditional compilation in Epoc
+- sdl_epocevents.cpp: Added focus lost&gained event handling, added modifier handling, added a lot more key event handling (function keys and others). Function keys are mapped as follows: 
+  F1=chr+q, F2=chr+w,..., F8=chr+i, F9=chr+a,..., F12=chr+d.
+- sdl_epocvideo.h: Added EPOC_ScreenOffset variable. Added EPOC_IsWindowFocused variable (but not used for anything yet!). Added RedrawWindowL() function.
+- sdl_epocvideo.cpp: Added debugging functions: Debug_AvailMem2() and Debug_AvailMem(). 
+  Changed window to have white background. Centralize game screen if it is not full size. 
+  Added RedrawWindowL() function. Force other windows to redraw if SDL window lost focus. This cleans up possible game graphics from screen. Redraw after getting focus again.
+
+
+Todo
+====
+
+This Epoc port is (of course;-) not thoroughly tested. For testing, I have compiled and run a couple of test programs and demos in N9210. Still, e.g. thread related functions have not been tested at all.
+
+Known bugs and unimplemented features:
+- No sound
+- No console output screen. Printing to stdout do not have any effect.
+- Epoc do not allow static/global variables in DLL libraries. So I could only use static linking with SDL.
+- Some test programs may take so much cpu in 9210 that e.g. SMS sending and receiving is not possible at a same time. Also screen may look awkward if there appear visible notes, dialogs etc. when an sdl program is active. SDL program runs in the lowest possible priority for minimum interference in the system. Unfortunately, this is always not enough.  Perhaps some Delay() commands are needed.
+
+P.s. I have ported also the SDL version of MirrorMagic puzzle game to Epoc. I will put the sources and binaries available as soon as I bother to clean the ported sources a bit... 
+
+
+Open Source & "bazaar" style software development
+=================================================
+
+You can take part in this porting project. This is Open Source software and you are very welcome to try it, test it, improve the code and implement the missing pieces. If you have any fix suggestions, improvements, code excerpts etc., contact me by email. Please start the mail subject with a string "EPOC SDL:".
+
+Cheers,
+Hannu
+
+Mail:hannu.j.viitala@mbnet.fi
+Homepage of SDL for Epoc: www.mbnet.fi/~haviital
diff --git a/docs.html b/docs.html
@@ -16,6 +16,8 @@ <H2>
 Major changes since SDL 1.0.0:
 </H2>
 <UL>
+	<LI> 1.2.3: Added initial support for EPOC/Symbian OS (thanks Hannu!)
+	<LI> 1.2.3: Improved MacOS X international keyboard handling
 	<LI> 1.2.3: Added support for DirectFB video on Linux (thanks Denis!)
 	<LI> 1.2.3: Fixed IDE and SCSI CD-ROM detection on BeOS (thanks Caz!)
 	<LI> 1.2.3: Fixed the system dependent SDL_WINDOWID hack on Windows

diff --git a/include/SDL_byteorder.h b/include/SDL_byteorder.h
@@ -43,6 +43,7 @@ static char rcsid =
     (defined(__alpha__) || defined(__alpha)) || \
      defined(__arm__) || \
     (defined(__mips__) && defined(__MIPSEL__)) || \
+     defined(__SYMBIAN32__) || \
      defined(__LITTLE_ENDIAN__)
 #define SDL_BYTEORDER	SDL_LIL_ENDIAN
 #else

diff --git a/include/SDL_main.h b/include/SDL_main.h
@@ -31,7 +31,7 @@ static char rcsid =
 /* Redefine main() on Win32 and MacOS so that it is called by winmain.c */
 
 #if defined(WIN32) || (defined(__MWERKS__) && !defined(__BEOS__)) || \
-    defined(macintosh) || defined(__APPLE__)
+    defined(macintosh) || defined(__APPLE__) || defined(__SYMBIAN32__)
 
 #ifdef __cplusplus
 #define C_LINKAGE	"C"

diff --git a/include/SDL_types.h b/include/SDL_types.h
@@ -54,6 +54,11 @@ typedef signed int	Sint32;
 #endif
 #endif /* !__STRICT_ANSI__ */
 
+/* The 64-bit type isn't available on EPOC/Symbian OS */
+#ifdef __SYMBIAN32__
+#undef SDL_HAS_64BIT_TYPE
+#endif
+
 /* The 64-bit datatype isn't supported on all platforms */
 #ifdef SDL_HAS_64BIT_TYPE
 typedef unsigned SDL_HAS_64BIT_TYPE Uint64;

diff --git a/include/begin_code.h b/include/begin_code.h
@@ -48,6 +48,12 @@
 # endif
 #endif
 
+/* Removed DECLSPEC on Symbian OS because SDL cannot be a DLL in EPOC */
+#ifdef __SYMBIAN32__ 
+#undef DECLSPEC
+#define DECLSPEC
+#endif // __SYMBIAN32__
+
 /* Force structure packing at 4 byte alignment.
    This is necessary if the header is included in code which has structure
    packing set to an alternate value, say for loading structures from disk.

diff --git a/src/main/Makefile.am b/src/main/Makefile.am
@@ -6,8 +6,12 @@
 
 SUBDIRS = macosx
 
-ARCH_SUBDIRS = $(srcdir)/beos $(srcdir)/linux \
-               $(srcdir)/macos $(srcdir)/macosx $(srcdir)/win32
+ARCH_SUBDIRS = $(srcdir)/beos \
+               $(srcdir)/epoc \
+               $(srcdir)/linux \
+               $(srcdir)/macos \
+               $(srcdir)/macosx \
+               $(srcdir)/win32
 
 # Build a separate library containing the main() entry point.
 lib_LIBRARIES = libSDLmain.a

diff --git a/src/main/epoc/SDL_main.cpp b/src/main/epoc/SDL_main.cpp
@@ -0,0 +1,129 @@
+/*
+    SDL - Simple DirectMedia Layer
+    Copyright (C) 1997, 1998, 1999, 2000, 2001  Sam Lantinga
+
+    This library is free software; you can redistribute it and/or
+    modify it under the terms of the GNU Library General Public
+    License as published by the Free Software Foundation; either
+    version 2 of the License, or (at your option) any later version.
+
+    This library is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+    Library General Public License for more details.
+
+    You should have received a copy of the GNU Library General Public
+    License along with this library; if not, write to the Free
+    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+
+    Sam Lantinga
+    slouken@devolution.com
+*/
+
+/*
+    SDL_main.cpp
+    The Epoc executable startup functions 
+
+    Epoc version by Hannu Viitala (hannu.j.viitala@mbnet.fi)
+*/
+
+#include <e32std.h>
+#include <e32def.h>
+#include <e32svr.h>
+#include <e32base.h>
+#include <estlib.h>
+#include <stdlib.h>
+#include <stdio.h>
+#include <w32std.h>
+#include <apgtask.h>
+
+#include "SDL_error.h"
+
+#ifndef EXPORT_C
+# ifdef __VC32__
+#  define IMPORT_C __declspec(dllexport)
+#  define EXPORT_C __declspec(dllexport)
+# endif
+# ifdef __GCC32__
+#  define IMPORT_C
+#  define EXPORT_C __declspec(dllexport)
+# endif
+#endif
+
+#if defined(__WINS__)
+#include <estw32.h>
+IMPORT_C void RegisterWsExe(const TDesC &aName);
+#endif
+
+/* The prototype for the application's main() function */
+#define main	SDL_main
+extern "C" int main (int argc, char *argv[], char *envp[]);
+extern "C" void exit (int ret);
+
+
+/* Epoc main function */
+
+GLDEF_C TInt E32Main() 
+    {
+    /*  Get the clean-up stack */
+	CTrapCleanup* cleanup = CTrapCleanup::New();
+
+    #if defined(__WINS__)
+    /* arrange for access to Win32 stdin/stdout/stderr */
+   	RWin32Stream::StartServer();	
+    #endif
+
+    /* Arrange for multi-threaded operation */
+	SpawnPosixServerThread();	
+
+    /* Get args and environment */
+	int argc=0;
+	char** argv=0;
+	char** envp=0;
+	__crt0(argc,argv,envp);	
+
+    #if defined(__WINS__)
+	/* Cause the graphical Window Server to come into existence */
+	RSemaphore sem;
+	sem.CreateGlobal(_L("WsExeSem"),0);
+	RegisterWsExe(sem.FullName());
+    #endif
+
+
+    /* Start the application! */
+
+    /* Create stdlib */
+    _REENT;
+
+    /* Set process and thread priority */
+    RThread currentThread;
+
+    currentThread.Rename(_L("SdlProgram"));
+    currentThread.SetProcessPriority(EPriorityLow);
+    currentThread.SetPriority(EPriorityMuchLess);
+
+    /* Call stdlib main */
+    int ret = main(argc, argv, envp); /* !! process exits here if there is "exit()" in main! */	
+
+    /* Call exit */
+    exit(ret); /* !! process exits here! */			
+
+    /* Free resources and return */
+    CloseSTDLIB();
+   	delete cleanup;									
+    return(KErrNone);
+    }
+
+/* Epoc dll entry point */
+#if defined(__WINS__)
+GLDEF_C TInt E32Dll(TDllReason)
+	{
+	return(KErrNone);
+	}
+
+EXPORT_C TInt WinsMain(TAny *)
+	{
+    E32Main();
+	return KErrNone;
+	}
+#endif
diff --git a/src/thread/Makefile.am b/src/thread/Makefile.am
@@ -3,8 +3,13 @@
 
 noinst_LTLIBRARIES = libthread.la
 
-ARCH_SUBDIRS = $(srcdir)/generic $(srcdir)/amigaos $(srcdir)/beos \
-	$(srcdir)/irix $(srcdir)/linux $(srcdir)/win32
+ARCH_SUBDIRS = $(srcdir)/generic \
+               $(srcdir)/amigaos \
+               $(srcdir)/beos \
+               $(srcdir)/epoc \
+               $(srcdir)/irix \
+               $(srcdir)/linux \
+               $(srcdir)/win32
 
 # Older versions of Linux require an asm clone() implementation
 if USE_CLONE