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