update setup.nqp to properly install files. Thanks to fperrad++ for guidance.
[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/UnitTest
48                         t
49                 >) ),
50
51                 :release_id(                    'release-8' ),
52                 :release_dir_format(    'released/%s'),
53                 :vdd_file(                      'vdd.txt' ),
54         );
55
56         %kakapo<copy_templates><library/krt0.pir>                       := <src/Internals/krt0.pir_tmpl>;
57         %kakapo<copy_templates><src/Internals/kakapo_bottom.pir> := <src/Internals/kakapo_bottom.pir_tmpl>;
58         %kakapo<copy_templates><src/Internals/kakapo_top.pir>   := <src/Internals/kakapo_top.pir_tmpl>;
59
60         %kakapo<pir_nqp-rx><src/Internals/Base.pir>     := <src/Internals/Base.nqp>;
61         %kakapo<pir_nqp-rx><src/Internals/Full.pir>     := <src/Internals/Full.nqp>;
62
63         my @base_pir_files := <
64                 src/Global.pir
65                 src/Syntax.pir
66
67                 src/Internals/Kakapo.pir
68
69                 src/Parrot/Opcode.pir
70                 src/Parrot/Parrot.pir
71                 src/Parrot/Pir.pir
72
73                 src/Pmc/Array.pir
74                 src/Pmc/Class.pir
75                 src/Pmc/common-methods.pir
76                 src/Pmc/Exception.pir
77                         src/Exceptions.pir
78                 src/Pmc/Key.pir
79                 src/Pmc/Hash.pir
80                 src/Pmc/Namespace.pir
81                 src/Pmc/String.pir
82                 src/Pmc/Sub.pir
83                 src/Pmc/Undef.pir
84         >;
85
86         for @base_pir_files {
87                 %kakapo<pir_nqp-rx>{~ $_} := change_ext(~$_, :from('.pir'), :to('.nqp'));
88         }
89
90         %kakapo<build_libs><library/kakapo_base.pir> := <
91                 src/Internals/kakapo_top.pir
92                 src/Internals/Base.pir
93         >;
94         %kakapo<build_libs><library/kakapo_base.pir>.append( @base_pir_files );
95         %kakapo<build_libs><library/kakapo_base.pir>.push( <src/Internals/kakapo_bottom.pir>);
96
97         my @full_pir_files := <
98                 src/CallSignature.pir
99
100                 src/Classes/P6object.pir
101                 src/Classes/P6metaclass.pir
102
103                 src/DependencyQueue.pir
104                 src/Library.pir
105
106                 src/Matchers/Boolean.pir
107                 src/Matchers/CallSig.pir
108                 src/Matchers/Factory.pir
109                 src/Matchers/InstanceOf.pir
110                 src/Matchers/Matcher.pir
111                 src/Matchers/Not.pir
112                 src/Matchers/Null.pir
113                 src/Matchers/PassFail.pir
114
115                 src/Cuculinae/Antiphon.pir
116                 src/Cuculinae/Cuculus.pir
117                 src/Cuculinae/Cuckoo.pir
118                 src/Cuculinae/Ovum.pir
119                 src/Cuculinae/SigMatcher.pir
120                 src/Cuculinae/Verifier.pir
121
122                 src/Program.pir
123
124                 src/UnitTest/Assertions.pir
125                 src/UnitTest/Listeners.pir
126                 src/UnitTest/Loader.pir
127                 src/UnitTest/Result.pir
128                 src/UnitTest/Suite.pir
129                 src/UnitTest/Testcase.pir
130         >;
131
132         for @full_pir_files {
133                 %kakapo<pir_nqp-rx>{~ $_} := change_ext(~$_, :from('.pir'), :to('.nqp'));
134         }
135
136         %kakapo<build_libs><library/kakapo_full.pir> := <
137                 src/Internals/kakapo_top.pir
138                 src/Internals/Full.pir
139         >;
140         %kakapo<build_libs><library/kakapo_full.pir>.append( @base_pir_files );
141         %kakapo<build_libs><library/kakapo_full.pir>.append( @full_pir_files );
142         %kakapo<build_libs><library/kakapo_full.pir>.push( <src/Internals/kakapo_bottom.pir>);
143
144         %kakapo<strip_annotations> := %kakapo<build_libs>;
145
146         %kakapo<pbc_pir><library/kakapo_base.pbc>       := <library/kakapo_base.pir>;
147         %kakapo<pbc_pir><library/kakapo_full.pbc>       := <library/kakapo_full.pir>;
148         %kakapo<pbc_pir><library/krt0.pbc>              := <library/krt0.pir>;
149
150         %kakapo<release_files><kakapo_base.pir> := <library/kakapo_base.pir>;
151         %kakapo<release_files><kakapo_base.pbc> := <library/kakapo_base.pbc>;
152         %kakapo<release_files><kakapo_full.pir> := <library/kakapo_full.pir>;
153         %kakapo<release_files><kakapo_full.pbc> := <library/kakapo_full.pbc>;
154         %kakapo<release_files><krt0.pir>                        := <library/krt0.pir>;
155         %kakapo<release_files><krt0.pbc>                := <library/krt0.pbc>;
156
157         # This test file needs compiling so the others can load it.
158         %kakapo<pir_nqp-rx><t/Pmc/common-methods.pir> := <t/Pmc/common-methods.nqp>;
159
160         %kakapo<inst_lib> := <
161             library/kakapo_base.pbc
162             library/kakapo_full.pbc
163             library/krt0.pbc
164         >;
165
166         register_step_before('build', Setup::Step::copy_templates);
167         register_step_before('clean', Setup::Step::clean_templates);
168
169         #install_build_libs();
170         install_substep('build', Setup::Step::build_libs, :before('_build_pbc_pir'));
171         install_substep('build', Setup::Step::strip_annotations, :before('_build_pbc_pir'));
172         register_step_before('clean', Setup::Step::clean_libs);
173
174         register_step('release', Setup::Step::make_release);
175
176         pir::shift(@argv);
177         setup_(@argv, %kakapo);
178 }
179
180 sub change_ext($file, :$from!, :$to!) {
181         my $len := pir::length__IS($file) - pir::length__IS($from);
182
183         unless pir::substr__SSI($file, $len) eq $from {
184                 pir::die("No matching extension '$from' on file: $file");
185         }
186
187         my $base := pir::substr__SSI($file, 0, $len);
188         $base ~ $to;
189 }
190
191 sub get_args() {
192         my $interp := pir::getinterp__P();
193         $interp[2];
194 }
195
196 sub install_substep($step, &func, :$before, :$after) {
197         my $target := $before // $after;
198         my @insert;
199         @insert.push(&func);
200
201         our %step;
202         my $index := ?$after;
203         for %step{$step} {
204                 if ~ $_ eq $target {
205                         pir::splice__vppii(%step{$step}, @insert, $index, 0);
206                         return 0;
207                 }
208
209                 $index++;
210         }
211
212         pir::die("Unable to insert substep &func into $step - could not find $target");
213 }
214
215
216 # distutils functions are not in a namespace, so Step:: methods can't address them
217 # directly.
218
219 sub needs_update($src, $dst, :$verbose) {
220
221         ! file_exists($dst) ||newer(~$src, $dst, :verbose($verbose));
222 }
223
224 sub setup_(@steps, %config) {
225         Q:PIR {
226                 $P0 = find_lex '@steps'
227                 $P1 = find_lex '%config'
228                 'setup'($P0 :flat, $P1 :flat :named)
229         };
230 }
231
232 module Setup::Step;
233
234 sub build_libs(*%config) {
235         my $output_file;
236         my @inputs;
237         my $needs_update;
238         my $command;
239
240         for %config<build_libs> {
241                 $output_file := ~ $_;
242                 @inputs := %config<build_libs>{$output_file};
243                 $needs_update := 0;
244
245                 unless newer(~$output_file, @inputs) {
246                         $command := 'cat '
247                                 ~ pir::join(' ', @inputs)
248                                 ~ ' > '
249                                 ~ $output_file;
250                         system($command, :verbose(1));
251                 }
252         }
253 }
254
255 sub clean_libs(*%config) {
256         clean_key(%config<build_libs>);
257 }
258
259 sub clean_templates(*%config) {
260         clean_key(%config<copy_templates>);
261 }
262
263 sub copy_templates(*%config) {
264         my %cfg := %config<copy_templates>;
265         for %cfg {
266                 my $src := %cfg{$_};
267                 my $dst := ~ $_;
268
269                 unless newer(~$dst, ~$src) {
270                         cp($src, $dst, :verbose(1));
271                 }
272         }
273 }
274
275 sub make_release(*%config) {
276         my $release_id := %config<release_id>;
277         unless $release_id {
278                 pir::die("Cannot release: <release_id> config not set");
279         }
280
281         my @args;
282         @args.push( $release_id );
283
284         my $release_dir := pir::sprintf__SSP(%config<release_dir_format>, @args);
285
286         if file_exists($release_dir) {
287                 pir::die("Cannot release: '$release_dir' already exists.");
288         }
289
290         my $vdd := %config<vdd_file>;
291
292         unless $vdd && file_exists($vdd) {
293                 pir::die("Cannot release: no Version Description Document provided. Set <vdd_file> config.");
294         }
295
296         my $fh := pir::open__PSS($vdd, 'r');
297         my $leader := $fh.readline;
298         $fh.close;
299
300         if pir::index__ISS($leader, $release_id) < 0 {
301                 pir::die("Cannot release: VDD file '$vdd' does not contain '$release_id' in line 1");
302         }
303
304         my %cfg := %config<release_files>;
305         my $installed_vdd := 0;
306
307         for %cfg {
308                 install(%cfg{~$_}, $release_dir ~ '/' ~$_, :verbose(1));
309
310                 if %cfg{~$_} eq $vdd {
311                         $installed_vdd++;
312                 }
313         }
314
315         unless $installed_vdd {
316                 install($vdd, $release_dir ~ '/VERSION', :verbose(1));
317         }
318
319         unlink($vdd, :verbose(1));
320 }
321
322 sub strip_annotations(*%config) {
323         for %config<strip_annotations> {
324                 if file_exists(~$_) {
325                         my $fh := pir::open__PSS(~$_, 'r');
326                         my $body := $fh.readall();
327                         $fh.close;
328
329                         if pir::index__ISS($body, "\n.annotate ") >= 0 {
330                                 say("Removing  annotations from $_");
331                                 $body.replace("\n.annotate ", "\n# .annotate ");
332                                 $fh := pir::open__PSS(~$_, 'w');
333                                 $fh.puts($body);
334                                 $fh.close;
335                         }
336                 }
337         }
338 }