This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
pp_match(): refactor intuit-only code
[perl5.git] / README.ce
CommitLineData
e1caacb4
JH
1If you read this file _as_is_, just ignore the funny characters you
2see. It is written in the POD format (see pod/perlpod.pod) which is
3specifically designed to be readable as is.
4
c7bcd97d 5=head1 NAME
e1caacb4 6
c7bcd97d 7perlce - Perl for WinCE
e1caacb4 8
75472953
VK
9=head1 Building Perl for WinCE
10
11=head2 DESCRIPTION
e1caacb4 12
2e64bfdb 13This file gives the instructions for building Perl5.8 and above for
e1caacb4
JH
14WinCE. Please read and understand the terms under which this
15software is distributed.
16
75472953 17=head2 General explanations on cross-compiling WinCE
e1caacb4 18
75472953
VK
19=over
20
21=item *
22
9b15f68e 23F<miniperl> is built. This is a single executable (without DLL), intended
75472953
VK
24to run on Win32, and it will facilitate remaining build process; all binaries
25built after it are foreign and should not run locally.
26
9b15f68e 27F<miniperl> is built using F<./win32/Makefile>; this is part of normal
75472953
VK
28build process invoked as dependency from wince/Makefile.ce
29
30=item *
31
9b15f68e 32After F<miniperl> is built, F<configpm> is invoked to create right F<Config.pm>
75472953 33in right place and its corresponding Cross.pm.
2e64bfdb 34
9b15f68e
KW
35Unlike Win32 build, miniperl will not have F<Config.pm> of host within reach;
36it rather will use F<Config.pm> from within cross-compilation directories.
2e64bfdb 37
9b15f68e
KW
38File F<Cross.pm> is dead simple: for given cross-architecture places in @INC
39a path where perl modules are, and right F<Config.pm> in that place.
e1caacb4 40
75472953 41That said, C<miniperl -Ilib -MConfig -we 1> should report an error, because
9b15f68e 42it can not find F<Config.pm>. If it does not give an error -- wrong F<Config.pm>
75472953
VK
43is substituted, and resulting binaries will be a mess.
44
45C<miniperl -MCross -MConfig -we 1> should run okay, and it will provide right
9b15f68e 46F<Config.pm> for further compilations.
75472953
VK
47
48=item *
49
9b15f68e
KW
50During extensions build phase, a script F<./win32/buldext.pl> is invoked,
51which in turn steps in F<./ext> subdirectories and performs a build of
75472953
VK
52each extension in turn.
53
9b15f68e 54All invokes of F<Makefile.PL> are provided with C<-MCross> so to enable cross-
75472953
VK
55compile.
56
75472953 57=back
8f33b42a 58
75472953
VK
59=head2 BUILD
60
61This section describes the steps to be performed to build PerlCE.
62You may find additional information about building perl for WinCE
63at L<http://perlce.sourceforge.net> and some pre-built binaries.
64
65=head3 Tools & SDK
e1caacb4 66
2e64bfdb
JH
67For compiling, you need following:
68
69=over 4
70
71=item * Microsoft Embedded Visual Tools
72
73=item * Microsoft Visual C++
74
75=item * Rainer Keuchel's celib-sources
76
77=item * Rainer Keuchel's console-sources
78
79=back
e1caacb4 80
75472953 81Needed source files can be downloaded at
464a08e7 82L<http://perlce.sourceforge.net>
e1caacb4 83
75472953 84=head3 Make
e1caacb4 85
9b15f68e 86Normally you only need to edit F<./win32/ce-helpers/compile.bat>
2e64bfdb 87to reflect your system and run it.
e1caacb4 88
9b15f68e 89File F<./win32/ce-helpers/compile.bat> is actually a wrapper to call
45496817
VK
90C<nmake -f makefile.ce> with appropriate parameters and it accepts extra
91parameters and forwards them to C<nmake> command as additional
2e64bfdb 92arguments. You should pass target this way.
e1caacb4 93
8f33b42a 94To prepare distribution you need to do following:
2e64bfdb
JH
95
96=over 4
97
9b15f68e 98=item * go to F<./win32> subdirectory
2e64bfdb 99
9b15f68e 100=item * edit file F<./win32/ce-helpers/compile.bat>
e1caacb4 101
2e64bfdb
JH
102=item * run
103 compile.bat
e1caacb4 104
2e64bfdb
JH
105=item * run
106 compile.bat dist
e1caacb4 107
2e64bfdb
JH
108=back
109
9b15f68e 110F<Makefile.ce> has C<CROSS_NAME> macro, and it is used further to refer to
8f33b42a
VK
111your cross-compilation scheme. You could assign a name to it, but this
112is not necessary, because by default it is assigned after your machine
113configuration name, such as "wince-sh3-hpc-wce211", and this is enough
114to distinguish different builds at the same time. This option could be
115handy for several different builds on same platform to perform, say,
116threaded build. In a following example we assume that all required
117environment variables are set properly for C cross-compiler (a special
9b15f68e 118*.bat file could fit perfectly to this purpose) and your F<compile.bat>
45496817 119has proper "MACHINE" parameter set, to, say, C<wince-mips-pocket-wce300>.
8f33b42a
VK
120
121 compile.bat
122 compile.bat dist
1dcc3c19
DG
123 compile.bat CROSS_NAME=mips-wce300-thr "USE_ITHREADS=define" ^
124 "USE_IMP_SYS=define" "USE_MULTI=define"
125 compile.bat CROSS_NAME=mips-wce300-thr "USE_ITHREADS=define" ^
126 "USE_IMP_SYS=define" "USE_MULTI=define" dist
8f33b42a
VK
127
128If all goes okay and no errors during a build, you'll get two independent
45496817 129distributions: C<wince-mips-pocket-wce300> and C<mips-wce300-thr>.
8f33b42a 130
45496817
VK
131Target C<dist> prepares distribution file set. Target C<zipdist> performs
132same as C<dist> but additionally compresses distribution files into zip
8f33b42a
VK
133archive.
134
9b15f68e
KW
135NOTE: during a build there could be created a number (or one) of F<Config.pm>
136for cross-compilation ("foreign" F<Config.pm>) and those are hidden inside
137F<../xlib/$(CROSS_NAME)> with other auxiliary files, but, and this is important to
138note, there should be B<no> F<Config.pm> for host miniperl.
8f33b42a
VK
139If you'll get an error that perl could not find Config.pm somewhere in building
140process this means something went wrong. Most probably you forgot to
141specify a cross-compilation when invoking miniperl.exe to Makefile.PL
142When building an extension for cross-compilation your command line should
143look like
144
145 ..\miniperl.exe -I..\lib -MCross=mips-wce300-thr Makefile.PL
146
147or just
148
149 ..\miniperl.exe -I..\lib -MCross Makefile.PL
150
151to refer a cross-compilation that was created last time.
152
8f33b42a 153All questions related to building for WinCE devices could be asked in
ef39d023 154F<perlce-user@lists.sourceforge.net> mailing list.
e1caacb4 155
75472953
VK
156=head1 Using Perl on WinCE
157
158=head2 DESCRIPTION
159
160PerlCE is currently linked with a simple console window, so it also
161works on non-hpc devices.
162
9b15f68e
KW
163The simple stdio implementation creates the files F<stdin.txt>,
164F<stdout.txt> and F<stderr.txt>, so you might examine them if your
f858446f 165console has only a limited number of cols.
75472953
VK
166
167When exitcode is non-zero, a message box appears, otherwise the
168console closes, so you might have to catch an exit with
169status 0 in your program to see any output.
170
9b15f68e
KW
171stdout/stderr now go into the files F</perl-stdout.txt> and
172F</perl-stderr.txt.>
45496817
VK
173
174PerlIDE is handy to deal with perlce.
75472953
VK
175
176=head2 LIMITATIONS
177
178No fork(), pipe(), popen() etc.
179
180=head2 ENVIRONMENT
181
182All environment vars must be stored in HKLM\Environment as
183strings. They are read at process startup.
184
45496817
VK
185=over
186
187=item PERL5LIB
188
189Usual perl lib path (semi-list).
190
191=item PATH
192
193Semi-list for executables.
194
195=item TMP
196
197- Tempdir.
198
199=item UNIXROOTPATH
200
9b15f68e 201- Root for accessing some special files, i.e. F</dev/null>, F</etc/services>.
45496817
VK
202
203=item ROWS/COLS
204
205- Rows/cols for console.
206
207=item HOME
208
209- Home directory.
210
211=item CONSOLEFONTSIZE
212
213- Size for console font.
214
215=back
75472953
VK
216
217You can set these with cereg.exe, a (remote) registry editor
218or via the PerlIDE.
219
220=head2 REGISTRY
221
222To start perl by clicking on a perl source file, you have
9b15f68e 223to make the according entries in HKCR (see F<ce-helpers/wince-reg.bat>).
75472953
VK
224cereg.exe (which must be executed on a desktop pc with
225ActiveSync) is reported not to work on some devices.
226You have to create the registry entries by hand using a
227registry editor.
228
75472953
VK
229=head2 XS
230
231The following Win32-Methods are built-in:
232
233 newXS("Win32::GetCwd", w32_GetCwd, file);
234 newXS("Win32::SetCwd", w32_SetCwd, file);
235 newXS("Win32::GetTickCount", w32_GetTickCount, file);
236 newXS("Win32::GetOSVersion", w32_GetOSVersion, file);
237 newXS("Win32::IsWinNT", w32_IsWinNT, file);
238 newXS("Win32::IsWin95", w32_IsWin95, file);
239 newXS("Win32::IsWinCE", w32_IsWinCE, file);
240 newXS("Win32::CopyFile", w32_CopyFile, file);
241 newXS("Win32::Sleep", w32_Sleep, file);
242 newXS("Win32::MessageBox", w32_MessageBox, file);
243 newXS("Win32::GetPowerStatus", w32_GetPowerStatus, file);
244 newXS("Win32::GetOemInfo", w32_GetOemInfo, file);
245 newXS("Win32::ShellEx", w32_ShellEx, file);
246
247=head2 BUGS
248
249Opening files for read-write is currently not supported if
250they use stdio (normal perl file handles).
251
252If you find bugs or if it does not work at all on your
253device, send mail to the address below. Please report
254the details of your device (processor, ceversion,
255devicetype (hpc/palm/pocket)) and the date of the downloaded
256files.
257
258=head2 INSTALLATION
259
260Currently installation instructions are at L<http://perlce.sourceforge.net/>.
261
262After installation & testing processes will stabilize, information will
263be more precise.
264
c7bcd97d 265=head1 ACKNOWLEDGEMENTS
e1caacb4
JH
266
267The port for Win32 was used as a reference.
268
45496817
VK
269=head1 History of WinCE port
270
271=over
272
273=item 5.6.0
274
275Initial port of perl to WinCE. It was performed in separate directory
9b15f68e
KW
276named F<wince>. This port was based on contents of F<./win32> directory.
277F<miniperl> was not built, user must have HOST perl and properly edit
278F<makefile.ce> to reflect this.
45496817
VK
279
280=item 5.8.0
281
9b15f68e 282wince port was kept in the same F<./wince> directory, and F<wince/Makefile.ce>
45496817
VK
283was used to invoke native compiler to create HOST miniperl, which then
284facilitates cross-compiling process.
285Extension building support was added.
286
287=item 5.9.4
288
9b15f68e
KW
289Two directories F<./win32> and F<./wince> were merged, so perlce build
290process comes in F<./win32> directory.
45496817 291
ef39d023 292=back
45496817 293
2e64bfdb 294=head1 AUTHORS
e1caacb4 295
75472953
VK
296=over
297
298=item Rainer Keuchel <coyxc@rainer-keuchel.de>
299
300provided initial port of Perl, which appears to be most essential work, as
301it was a breakthrough on having Perl ported at all.
302Many thanks and obligations to Rainer!
303
304=item Vadim Konovalov
305
306made further support of WinCE port.
307
308=back