Added Multisub.nqp to generate multisubs/multimethods.
[kakapo:kakapo.git] / setup.nqp
1 #! /usr/bin/env parrot-nqp
2 # Copyright 2009-2010, Austin Hastings. See accompanying LICENSE file, or
3 # http://www.opensource.org/licenses/artistic-license-2.0.php for license.
4
5 # =head1 NAME
6 #
7 # setup.nqp - Configure and build the Kakapo library.
8 #
9 # =head1 USAGE
10 #
11 #     $ parrot-nqp setup.nqp build
12 #     $ parrot-nqp setup.nqp test
13 #     $ sudo parrot-nqp setup.nqp install
14
15 INIT {
16         pir::load_language('parrot');
17         pir::load_bytecode('distutils.pbc');
18
19         pir::load_bytecode('dumper.pir');
20 }
21
22 MAIN(get_args());
23
24 sub new_hash(*%hash) {
25         %hash;
26 }
27
28 sub MAIN(@argv) {
29
30         my %kakapo := new_hash(
31                 :name(          'Kakapo' ),
32                 :abstract(              'Run-time library for NQP programs on the Parrot VM' ),
33                 :authority(             'http://gitorious.org/austin' ),
34                 :copyright_holder(      'Austin Hastings' ),
35                 :doc_files(             <README CREDITS> ),
36                 :keywords(              < library  nqp  parrot  runtime  stand alone  xunit
37                                         unit testing  matcher  pmc  methods  >),
38                 :license_type(  'Artistic License 2.0' ),
39                 :license_uri(           'http://www.perlfoundation.org/artistic_license_2_0' ),
40                 :checkout_uri(  'git://gitorious.org/kakapo/kakapo.git' ),
41                 :browser_uri(   'http://code.google.com/p/kakapo-parrot/' ),
42                 :project_uri(           'git://gitorious.org/kakapo/kakapo.git' ),
43
44                 :harness_files(         pir::join(' ', <
45                         !t/Pmc
46                         !t/Structure
47                         t
48                 >) ),
49
50                 :release_id(                    'release-9' ),
51                 :release_dir_format(    'released/%s'),
52                 :vdd_file(                      'vdd.txt' ),
53         );
54
55         %kakapo<copy_templates><library/krt0.pir>                       := <src/Internals/krt0.pir_tmpl>;
56         %kakapo<copy_templates><src/Internals/kakapo_bottom.pir> := <src/Internals/kakapo_bottom.pir_tmpl>;
57         %kakapo<copy_templates><src/Internals/kakapo_top.pir>   := <src/Internals/kakapo_top.pir_tmpl>;
58
59         %kakapo<pir_nqp-rx><src/Internals/Base.pir>     := <src/Internals/Base.nqp>;
60         %kakapo<pir_nqp-rx><src/Internals/Full.pir>     := <src/Internals/Full.nqp>;
61
62         my @base_pir_files := <
63                 src/Global.pir
64                 src/Syntax.pir
65
66                 src/Internals/Kakapo.pir
67
68                 src/Parrot/Multisub.pir
69                 src/Parrot/Nqp.pir
70                 src/Parrot/Opcode.pir
71                 src/Parrot/Parrot.pir
72                 src/Parrot/Pir.pir
73
74                 src/Pmc/Array.pir
75                 src/Pmc/Class.pir
76                 src/Pmc/common-methods.pir
77                 src/Pmc/Exception.pir
78                         src/Exceptions.pir
79                 src/Pmc/File.pir
80                 src/Pmc/Key.pir
81                 src/Pmc/Hash.pir
82                 src/Pmc/Namespace.pir
83                 src/Pmc/String.pir
84                 src/Pmc/Sub.pir
85                 src/Pmc/Undef.pir
86         >;
87
88         for @base_pir_files {
89                 %kakapo<pir_nqp-rx>{~ $_} := change_ext(~$_, :from('.pir'), :to('.nqp'));
90         }
91
92         %kakapo<build_libs><library/kakapo_base.pir> := <
93                 src/Internals/kakapo_top.pir
94                 src/Internals/Base.pir
95         >;
96         %kakapo<build_libs><library/kakapo_base.pir>.append( @base_pir_files );
97         %kakapo<build_libs><library/kakapo_base.pir>.push( <src/Internals/kakapo_bottom.pir>);
98
99         my @full_pir_files := <
100                 src/CallSignature.pir
101
102                 src/Classes/P6object.pir
103                 src/Classes/P6metaclass.pir
104
105                 src/ComponentMarshaller.pir
106                 src/DependencyQueue.pir
107                 src/Library.pir
108
109                 src/Matchers/Boolean.pir
110                 src/Matchers/CallSig.pir
111                 src/Matchers/Factory.pir
112                 src/Matchers/InstanceOf.pir
113                 src/Matchers/Matcher.pir
114                 src/Matchers/Not.pir
115                 src/Matchers/Null.pir
116                 src/Matchers/PassFail.pir
117
118                 src/Cuculinae/Antiphon.pir
119                 src/Cuculinae/Cuculus.pir
120                 src/Cuculinae/Cuckoo.pir
121                 src/Cuculinae/Ovum.pir
122                 src/Cuculinae/SigMatcher.pir
123                 src/Cuculinae/Verifier.pir
124
125                 src/Program.pir
126
127                 src/UnitTest/Assertions.pir
128                 src/UnitTest/Listeners.pir
129                 src/UnitTest/Loader.pir
130                 src/UnitTest/Result.pir
131                 src/UnitTest/Standalone.pir
132                 src/UnitTest/Suite.pir
133                 src/UnitTest/Testcase.pir
134         >;
135
136         for @full_pir_files {
137                 %kakapo<pir_nqp-rx>{~ $_} := change_ext(~$_, :from('.pir'), :to('.nqp'));
138         }
139
140         %kakapo<build_libs><library/kakapo_full.pir> := <
141                 src/Internals/kakapo_top.pir
142                 src/Internals/Full.pir
143         >;
144         %kakapo<build_libs><library/kakapo_full.pir>.append( @base_pir_files );
145         %kakapo<build_libs><library/kakapo_full.pir>.append( @full_pir_files );
146         %kakapo<build_libs><library/kakapo_full.pir>.push( <src/Internals/kakapo_bottom.pir>);
147
148         %kakapo<strip_annotations> := %kakapo<build_libs>;
149
150         %kakapo<pbc_pir><library/kakapo_base.pbc>       := <library/kakapo_base.pir>;
151         %kakapo<pbc_pir><library/kakapo_full.pbc>       := <library/kakapo_full.pir>;
152         %kakapo<pbc_pir><library/krt0.pbc>              := <library/krt0.pir>;
153
154         %kakapo<release_files><kakapo_base.pir> := <library/kakapo_base.pir>;
155         %kakapo<release_files><kakapo_base.pbc> := <library/kakapo_base.pbc>;
156         %kakapo<release_files><kakapo_full.pir> := <library/kakapo_full.pir>;
157         %kakapo<release_files><kakapo_full.pbc> := <library/kakapo_full.pbc>;
158         %kakapo<release_files><krt0.pir>                        := <library/krt0.pir>;
159         %kakapo<release_files><krt0.pbc>                := <library/krt0.pbc>;
160
161         # This test file needs compiling so the others can load it.
162         %kakapo<pir_nqp-rx><t/Pmc/common-methods.pir> := <t/Pmc/common-methods.nqp>;
163
164         %kakapo<inst_lib> := <
165                 library/kakapo_base.pbc
166                 library/kakapo_full.pbc
167                 library/krt0.pbc
168         >;
169
170         register_step_before('build', Setup::Step::copy_templates);
171         register_step_before('clean', Setup::Step::clean_templates);
172
173         #install_build_libs();
174         install_substep('build', Setup::Step::build_libs, :before('_build_pbc_pir'));
175         install_substep('build', Setup::Step::strip_annotations, :before('_build_pbc_pir'));
176         register_step_before('clean', Setup::Step::clean_libs);
177
178         register_step('release', Setup::Step::make_release);
179
180         pir::shift(@argv);
181         setup_(@argv, %kakapo);
182 }
183
184 sub change_ext($file, :$from!, :$to!) {
185         my $len := pir::length__IS($file) - pir::length__IS($from);
186
187         unless pir::substr__SSI($file, $len) eq $from {
188                 pir::die("No matching extension '$from' on file: $file");
189         }
190
191         my $base := pir::substr__SSI($file, 0, $len);
192         $base ~ $to;
193 }
194
195 sub get_args() {
196         my $interp := pir::getinterp__P();
197         $interp[2];
198 }
199
200 sub install_substep($step, &func, :$before, :$after) {
201         my $target := $before // $after;
202         my @insert;
203         @insert.push(&func);
204
205         our %step;
206         my $index := ?$after;
207         for %step{$step} {
208                 if ~ $_ eq $target {
209                         pir::splice__vppii(%step{$step}, @insert, $index, 0);
210                         return 0;
211                 }
212
213                 $index++;
214         }
215
216         pir::die("Unable to insert substep &func into $step - could not find $target");
217 }
218
219
220 # distutils functions are not in a namespace, so Step:: methods can't address them
221 # directly.
222
223 sub needs_update($src, $dst, :$verbose) {
224
225         ! file_exists($dst) ||newer(~$src, $dst, :verbose($verbose));
226 }
227
228 sub setup_(@steps, %config) {
229         Q:PIR {
230                 $P0 = find_lex '@steps'
231                 $P1 = find_lex '%config'
232                 'setup'($P0 :flat, $P1 :flat :named)
233         };
234 }
235
236 module Setup::Step;
237
238 sub build_libs(*%config) {
239         my $output_file;
240         my @inputs;
241         my $needs_update;
242         my $command;
243
244         for %config<build_libs> {
245                 $output_file := ~ $_;
246                 @inputs := %config<build_libs>{$output_file};
247                 $needs_update := 0;
248
249                 unless newer(~$output_file, @inputs) {
250                         $command := 'cat '
251                                 ~ pir::join(' ', @inputs)
252                                 ~ ' > '
253                                 ~ $output_file;
254                         system($command, :verbose(1));
255                 }
256         }
257 }
258
259 sub clean_libs(*%config) {
260         clean_key(%config<build_libs>);
261 }
262
263 sub clean_templates(*%config) {
264         clean_key(%config<copy_templates>);
265 }
266
267 sub copy_templates(*%config) {
268         my %cfg := %config<copy_templates>;
269         for %cfg {
270                 my $src := %cfg{$_};
271                 my $dst := ~ $_;
272
273                 unless newer(~$dst, ~$src) {
274                         cp($src, $dst, :verbose(1));
275                 }
276         }
277 }
278
279 sub make_release(*%config) {
280         my $release_id := %config<release_id>;
281         unless $release_id {
282                 pir::die("Cannot release: <release_id> config not set");
283         }
284
285         my @args;
286         @args.push( $release_id );
287
288         my $release_dir := pir::sprintf__SSP(%config<release_dir_format>, @args);
289
290         if file_exists($release_dir) {
291                 pir::die("Cannot release: '$release_dir' already exists.");
292         }
293
294         my $vdd := %config<vdd_file>;
295
296         unless $vdd && file_exists($vdd) {
297                 pir::die("Cannot release: no Version Description Document provided. Set <vdd_file> config.");
298         }
299
300         my $fh := pir::open__PSS($vdd, 'r');
301         my $leader := $fh.readline;
302         $fh.close;
303
304         if pir::index__ISS($leader, $release_id) < 0 {
305                 pir::die("Cannot release: VDD file '$vdd' does not contain '$release_id' in line 1");
306         }
307
308         my %cfg := %config<release_files>;
309         my $installed_vdd := 0;
310
311         for %cfg {
312                 install(%cfg{~$_}, $release_dir ~ '/' ~$_, :verbose(1));
313
314                 if %cfg{~$_} eq $vdd {
315                         $installed_vdd++;
316                 }
317         }
318
319         unless $installed_vdd {
320                 install($vdd, $release_dir ~ '/VERSION', :verbose(1));
321         }
322
323         unlink($vdd, :verbose(1));
324 }
325
326 sub strip_annotations(*%config) {
327         for %config<strip_annotations> {
328                 if file_exists(~$_) {
329                         my $fh := pir::open__PSS(~$_, 'r');
330                         my $body := $fh.readall();
331                         $fh.close;
332
333                         if pir::index__ISS($body, "\n.annotate ") >= 0 {
334                                 say("Removing annotations from $_");
335                                 $body.replace("\n.annotate ", "\n# .annotate ");
336                                 $fh := pir::open__PSS(~$_, 'w');
337                                 $fh.puts($body);
338                                 $fh.close;
339                         }
340                 }
341         }
342 }