This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Symbian sync
[perl5.git] / README.symbian
index 19ce115..6bd36f5 100644 (file)
@@ -12,14 +12,14 @@ This document describes various features of the Symbian operating
 system that will affect how Perl version 5 (hereafter just Perl)
 is compiled and/or runs.
 
-B<NOTE: this port (as of 0.2.0) does not compile into a Symbian
+B<NOTE: this port (as of 0.4.1) does not compile into a Symbian
 OS GUI application, but instead it results in a Symbian DLL.>
 The DLL includes a C++ class called CPerlBase, which one can then
 (derive from and) use to embed Perl into applications, see F<symbian/README>.
 
 The base port of Perl to Symbian only implements the basic POSIX-like
-functionality; it does not implement any further Symbian or Series 60
-bindings for Perl.
+functionality; it does not implement any further Symbian or Series 60,
+Series 80, or UIQ bindings for Perl.
 
 It is also possible to generate Symbian executables for "miniperl"
 and "perl", but since there is no standard command line interface
@@ -28,12 +28,13 @@ mainly as demonstrations.
 
 =head2 Compiling Perl on Symbian
 
-(0) You need to have the Symbian SDK installed.
+(0) You need to have the appropriate Symbian SDK installed.
 
     These instructions have been tested under various Nokia Series 60
     Symbian SDKs (1.2 to 2.6, 2.8 should also work, 1.2 compiles but
-    does not work).  You can get the SDKs from
-    Forum Nokia (http://www.forum.nokia.com/).
+    does not work), Series 80 2.0, and Nokia 7710 (Series 90) SDK.
+    You can get the SDKs from Forum Nokia (http://www.forum.nokia.com/).
+    A very rough port ("it compiles") to UIQ 2.1 has also been made.
 
     A prerequisite for any of the SDKs is to install ActivePerl
     from ActiveState, http://www.activestate.com/Products/ActivePerl/
@@ -42,7 +43,7 @@ mainly as demonstrations.
     the Metrowerks CodeWarrior installed (2.8 and 3.0 were used in testing)
     or the Microsoft Visual C++ 6.0 installed (SP3 minimum, SP5 recommended).
 
-    Note that for example the Serie s60 2.0 VC SDK installation talks
+    Note that for example the Serie60 2.0 VC SDK installation talks
     about ActivePerl build 518, which does no more (as of mid-2005) exist
     at the ActiveState website.  The ActivePerl 5.8.4 build 810 was
     used successfully for compiling Perl on Symbian.  The 5.6.x ActivePerls
@@ -68,44 +69,51 @@ mainly as demonstrations.
 
        perl symbian\config.pl
 
-    You must use the cmd.exe, the Cygwin shell will not work
-    (the PATH must include the SDK tools, including a Perl,
-    which should be the case under cmd.exe)
+    You must use the cmd.exe, the Cygwin shell will not work.
+    The PATH must include the SDK tools, including a Perl,
+    which should be the case under cmd.exe.  If you do not
+    have that, see the end of symbian\sdk.pl for notes of
+    how your environment should be set up for Symbian compiles.
 
 (4) Build the project, either by
 
        make all
 
     in cmd.exe or by using either the Metrowerks CodeWarrior
-    or the Visual C++ 6.0.
+    or the Visual C++ 6.0, or the Visual Studio 8 (the Visual C++
+    2005 Express Edition works fine).
 
     If you use the VC IDE, you will have to run F<symbian\config.pl>
     first using the cmd.exe, and then run 'make win.mf vc6.mf' to generate
-    the VC6 makefiles and workspaces.
+    the VC6 makefiles and workspaces.  "make vc6" will compile for the VC6,
+    and "make cw" for the CodeWarrior.
 
-    The following Series 60 SDK and compiler configurations and Nokia
-    phones that were tested (+ = compiled and PerlApp run, - = not),
+    The following SDK and compiler configurations and Nokia phones were
+    tested at some point in time (+ = compiled and PerlApp run, - = not),
     both for Perl 5.8.x and 5.9.x:
 
-        SDK | VC | CW |
-        ----+----+----+---
-        1.2 | +  | +  | 3650 (*)
-        2.0 | +  | +  | 6600
-        2.1 | -  | +  | 6670
-        2.6 | +  | +  | 6630    
+        SDK     | VC | CW |
+        --------+----+----+---
+        S60 1.2 | +  | +  | 3650 (*)
+        S60 2.0 | +  | +  | 6600
+        S60 2.1 | -  | +  | 6670
+        S60 2.6 | +  | +  | 6630    
+        S60 2.8 | +  | +  | (not tested in a device)
+        S80 2.6 | -  | +  | 9300
+        S90 1.1 | +  | -  | 7710
+        UIQ 2.1 | -  | +  | (not tested in a device)
 
-    Also 2.8 should work fine.
+    (*) Compiles but does not work, unfortunately, a problem with Symbian.
 
     If you are using the 'make' directly, it is the GNU make from the SDKs,
     and it will invoke the right make commands for the Windows emulator
     build and the Arm target builds ('thumb' by default) as necessary.
-    (*) Compiles but does not work, unfortunately.
 
     The build scripts assume the 'absolute style' SDK installs under C:,
     the 'subst style' will not work.
 
     If using the VC IDE, to build use for example the File->Open Workspace->
-    C:\Symbian\8.as\S60_2nd_FP2\epoc32\build\symbian\perl\perl\wins\perl.dsw
+    C:\Symbian\8.0a\S60_2nd_FP2\epoc32\build\symbian\perl\perl\wins\perl.dsw
     The emulator binaries will appear in the same directory.
 
     If using the VC IDE, you will a lot of warnings in the beginning of
@@ -129,7 +137,7 @@ mainly as demonstrations.
     the messages.
 
     Since the total size of all Perl SIS files once installed is
-    over 1.9 MB, it is recommended to do the installation into a
+    over 2 MB, it is recommended to do the installation into a
     memory card (drive E:) instead of the C: drive.
 
     The size of the perlXYZ.SIS is about 370 kB but once it is in the
@@ -150,7 +158,7 @@ mainly as demonstrations.
 
         make perlext.sis
 
-    which will create perlXYZext.sis (210 kB -> 470 kB).
+    which will create perlXYZext.sis (290 kB -> 770 kB).
 
     To compile the demonstration application PerlApp you need first to
     install the Perl headers under the SDK.
@@ -246,7 +254,7 @@ In the symbian subdirectory there is sisify.pl utility which can be
 used to package Perl scripts and/or Perl library directories into SIS
 files, which can be installed to the device.  To run the sisify.pl
 utility, you will need to have the 'makesis' and 'uidcrc' utilities
-already installed.  If you don't have the S60 Win32 SDKs, you may try
+already installed.  If you don't have the Win32 SDKs, you may try
 for example http://gnupoc.sourceforge.net/ or http://symbianos.org/~andreh/.
 
 =head2 Using Perl in Symbian
@@ -266,18 +274,19 @@ See the file symbian/config.sh and look for 'undef' to find the
 unsupported APIs (or from Perl use Config).
   
 The filesystem of Symbian devices uses DOSish syntax, "drives"
-separated from paths by a colon, and backslashes for the path.
-The exact assignment of the drives probably varies between platforms,
-but you might for example see C: as the flash main memory, D: as the
-RAM drive, E: as the memory card (MMC), Z: as the ROM.  As far the
-devices go the NUL: is the bit bucket, the COMx: are the serial lines,
-IRCOMx: are the IR ports, TMP: might be C:\System\Temp.  Remember to
-double those backslashes in doublequoted strings.
+separated from paths by a colon, and backslashes for the path.  The
+exact assignment of the drives probably varies between platforms, but
+for example in Series 60 you might see C: as the (flash) main memory,
+D: as the RAM drive, E: as the memory card (MMC), Z: as the ROM.  In
+Series 80 D: is the memory card.  As far the devices go the NUL: is
+the bit bucket, the COMx: are the serial lines, IRCOMx: are the IR
+ports, TMP: might be C:\System\Temp.  Remember to double those
+backslashes in doublequoted strings.
 
 The Perl DLL is installed in \System\Libs\.  The Perl libraries and
 extension DLLs are installed in \System\Libs\Perl\X.Y.Z\.  The PerlApp
 is installed in \System\Apps\, and the SIS also installs a couple of
-demo scripts in \Perl\.
+demo scripts in \Perl\ (C:\Mydocs\Perl\ on Nokia 7710).
 
 Note that the Symbian filesystem is very picky: it strongly prefers
 the \ instead of the /.
@@ -296,7 +305,7 @@ Lots.  See F<symbian\TODO>.
 
 =head1 WARNING
 
-As of Perl Symbian port version 0.2.0 any part of Perl's standard
+As of Perl Symbian port version 0.4.1 any part of Perl's standard
 regression test suite has not been run on a real Symbian device using
 the ported Perl, so innumerable bugs may lie in wait.  Therefore there
 is absolutely no warranty.
@@ -304,11 +313,12 @@ is absolutely no warranty.
 =head1 NOTE
 
 When creating and extending application programming interfaces (APIs)
-for Symbian or Series 60 it is suggested that trademarks, registered
-trademarks, or trade names are not used in the API names.  Instead,
-developers should consider basing the API naming in the existing (C++)
-public component and API naming, modified as appropriate by the rules
-of the programming language the new APIs are for.
+for Symbian or Series 60 or Series 80 or Series 90 it is suggested
+that trademarks, registered trademarks, or trade names are not used in
+the API names.  Instead, developers should consider basing the API
+naming in the existing (C++, or maybe Java) public component and API
+naming, modified as appropriate by the rules of the programming
+language the new APIs are for.
   
 Nokia is a registered trademark of Nokia Corporation. Nokia's product
 names are trademarks or registered trademarks of Nokia.  Other product
@@ -323,6 +333,8 @@ Jarkko Hietaniemi
 
 Copyright (c) 2004-2005 Nokia.  All rights reserved.
 
+Copyright (c) 2006-2007 Jarkko Hietaniemi.
+
 =head1 LICENSE
 
 The Symbian port is licensed under the same terms as Perl itself.
@@ -362,8 +374,8 @@ The Symbian port is licensed under the same terms as Perl itself.
 
 Since this is 0.something release, any future releases are almost
 guaranteed to be binary incompatible.  As a sign of this the Symbian
-symbol exports are kept unfrozen and the .def files rebuilt every
-time.
+symbol exports are kept unfrozen and the .def files fully rebuilt
+every time.
 
 =item *
 
@@ -375,6 +387,46 @@ time.
 
 We maintain the binary incompatibility.
 
+=item *
+
+0.3.0: October 2005
+
+  - Perl 5.9.3 (patch level 25911)
+  - Series 80 2.0 and UIQ 2.1 support
+
+We maintain the binary incompatibility.
+
+=item *
+
+0.4.0: November 2005
+
+  - Perl 5.9.3 (patch level 26052)
+  - adding a sample Symbian extension
+
+We maintain the binary incompatibility.
+
+=item *
+
+0.4.1: December 2006
+
+  - Perl 5.9.5-to-be (patch level 30002)
+  - added extensions: Compress/Raw/Zlib, Digest/SHA,
+    Hash/Util, Math/BigInt/FastCalc, Text/Soundex, Time/Piece
+  - port to S90 1.1 by alexander smishlajev
+
+We maintain the binary incompatibility.
+
+=item *
+
+0.4.2: March 2007
+
+  - catchup with Perl 5.9.5-to-be (patch level 30812)
+  - tested to build with Microsoft Visual C++ 2005 Express Edition
+    (which uses Microsoft Visual C 8, instead of the old VC6),
+    SDK used for testing S60_2nd_FP3 aka 8.1a
+
+We maintain the binary incompatibility.
+
 =back
 
 =cut