/
multidispatch.c
1522 lines (1138 loc) · 41.5 KB
/
multidispatch.c
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
Copyright (C) 2003-2009, Parrot Foundation.
$Id$
=head1 NAME
src/multidispatch.c - Multimethod dispatch for binary opcode functions
=head1 SYNOPSIS
This system is set up to handle type-based dispatching for binary (two
argument) functions. This includes, though isn't necessarily limited to, binary
operators such as addition or subtraction.
=head1 DESCRIPTION
The MMD system is straightforward, and currently must be explicitly invoked,
for example by a vtable function. (We reserve the right to use MMD in all
circumstances, but currently do not).
=head2 API
For the purposes of the API, each MMD-able function is assigned a unique
number which is used to find the correct function table. This is the
C<func_num> parameter in the following functions. While Parrot isn't
restricted to a predefined set of functions, it I<does> set things up so
that all the binary vtable functions have a MMD table preinstalled for
them, with default behaviour.
=head2 Remarks
=head2 Functions
=over 4
=cut
*/
#include "parrot/compiler.h"
#include "parrot/parrot.h"
#include "parrot/multidispatch.h"
#include "parrot/oplib/ops.h"
#include "multidispatch.str"
#include "pmc/pmc_nci.h"
#include "pmc/pmc_sub.h"
#include "pmc/pmc_callcontext.h"
/* HEADERIZER HFILE: include/parrot/multidispatch.h */
/* HEADERIZER BEGIN: static */
/* Don't modify between HEADERIZER BEGIN / HEADERIZER END. Your changes will be lost. */
static INTVAL distance_cmp(SHIM_INTERP, INTVAL a, INTVAL b);
static void mmd_add_multi_global(PARROT_INTERP,
ARGIN(STRING *sub_name),
ARGIN(PMC *sub_obj))
__attribute__nonnull__(1)
__attribute__nonnull__(2)
__attribute__nonnull__(3);
static void mmd_add_multi_to_namespace(PARROT_INTERP,
ARGIN(STRING *ns_name),
ARGIN(STRING *sub_name),
ARGIN(PMC *sub_obj))
__attribute__nonnull__(1)
__attribute__nonnull__(2)
__attribute__nonnull__(3)
__attribute__nonnull__(4);
PARROT_CANNOT_RETURN_NULL
PARROT_WARN_UNUSED_RESULT
static PMC* mmd_build_type_tuple_from_long_sig(PARROT_INTERP,
ARGIN(STRING *long_sig))
__attribute__nonnull__(1)
__attribute__nonnull__(2);
PARROT_CANNOT_RETURN_NULL
PARROT_WARN_UNUSED_RESULT
static PMC* mmd_build_type_tuple_from_type_list(PARROT_INTERP,
ARGIN(PMC *type_list))
__attribute__nonnull__(1)
__attribute__nonnull__(2);
PARROT_WARN_UNUSED_RESULT
PARROT_CAN_RETURN_NULL
static STRING * mmd_cache_key_from_types(PARROT_INTERP,
ARGIN(const char *name),
ARGIN(PMC *types))
__attribute__nonnull__(1)
__attribute__nonnull__(2)
__attribute__nonnull__(3);
PARROT_WARN_UNUSED_RESULT
PARROT_CAN_RETURN_NULL
static STRING * mmd_cache_key_from_values(PARROT_INTERP,
ARGIN(const char *name),
ARGIN(PMC *values))
__attribute__nonnull__(1)
__attribute__nonnull__(2)
__attribute__nonnull__(3);
PARROT_WARN_UNUSED_RESULT
PARROT_CAN_RETURN_NULL
static PMC* mmd_cvt_to_types(PARROT_INTERP, ARGIN(PMC *multi_sig))
__attribute__nonnull__(1)
__attribute__nonnull__(2);
static UINTVAL mmd_distance(PARROT_INTERP,
ARGIN(PMC *pmc),
ARGIN(PMC *arg_tuple))
__attribute__nonnull__(1)
__attribute__nonnull__(2)
__attribute__nonnull__(3);
static void mmd_search_by_sig_obj(PARROT_INTERP,
ARGIN(STRING *name),
ARGIN(PMC *sig_obj),
ARGIN(PMC *candidates))
__attribute__nonnull__(1)
__attribute__nonnull__(2)
__attribute__nonnull__(3)
__attribute__nonnull__(4);
static void mmd_search_global(PARROT_INTERP,
ARGIN(STRING *name),
ARGIN(PMC *cl))
__attribute__nonnull__(1)
__attribute__nonnull__(2)
__attribute__nonnull__(3);
static int mmd_search_local(PARROT_INTERP,
ARGIN(STRING *name),
ARGIN(PMC *candidates))
__attribute__nonnull__(1)
__attribute__nonnull__(2)
__attribute__nonnull__(3);
PARROT_WARN_UNUSED_RESULT
PARROT_CAN_RETURN_NULL
static PMC * Parrot_mmd_get_cached_multi_sig(PARROT_INTERP,
ARGIN(PMC *sub_pmc))
__attribute__nonnull__(1)
__attribute__nonnull__(2);
static int Parrot_mmd_maybe_candidate(PARROT_INTERP,
ARGIN(PMC *pmc),
ARGIN(PMC *cl))
__attribute__nonnull__(1)
__attribute__nonnull__(2)
__attribute__nonnull__(3);
PARROT_CANNOT_RETURN_NULL
PARROT_WARN_UNUSED_RESULT
static PMC* Parrot_mmd_search_scopes(PARROT_INTERP, ARGIN(STRING *meth))
__attribute__nonnull__(1)
__attribute__nonnull__(2);
PARROT_CANNOT_RETURN_NULL
static PMC * Parrot_mmd_sort_candidates(PARROT_INTERP,
ARGIN(PMC *arg_tuple),
ARGIN(PMC *cl))
__attribute__nonnull__(1)
__attribute__nonnull__(2)
__attribute__nonnull__(3);
#define ASSERT_ARGS_distance_cmp __attribute__unused__ int _ASSERT_ARGS_CHECK = (0)
#define ASSERT_ARGS_mmd_add_multi_global __attribute__unused__ int _ASSERT_ARGS_CHECK = (\
PARROT_ASSERT_ARG(interp) \
, PARROT_ASSERT_ARG(sub_name) \
, PARROT_ASSERT_ARG(sub_obj))
#define ASSERT_ARGS_mmd_add_multi_to_namespace __attribute__unused__ int _ASSERT_ARGS_CHECK = (\
PARROT_ASSERT_ARG(interp) \
, PARROT_ASSERT_ARG(ns_name) \
, PARROT_ASSERT_ARG(sub_name) \
, PARROT_ASSERT_ARG(sub_obj))
#define ASSERT_ARGS_mmd_build_type_tuple_from_long_sig \
__attribute__unused__ int _ASSERT_ARGS_CHECK = (\
PARROT_ASSERT_ARG(interp) \
, PARROT_ASSERT_ARG(long_sig))
#define ASSERT_ARGS_mmd_build_type_tuple_from_type_list \
__attribute__unused__ int _ASSERT_ARGS_CHECK = (\
PARROT_ASSERT_ARG(interp) \
, PARROT_ASSERT_ARG(type_list))
#define ASSERT_ARGS_mmd_cache_key_from_types __attribute__unused__ int _ASSERT_ARGS_CHECK = (\
PARROT_ASSERT_ARG(interp) \
, PARROT_ASSERT_ARG(name) \
, PARROT_ASSERT_ARG(types))
#define ASSERT_ARGS_mmd_cache_key_from_values __attribute__unused__ int _ASSERT_ARGS_CHECK = (\
PARROT_ASSERT_ARG(interp) \
, PARROT_ASSERT_ARG(name) \
, PARROT_ASSERT_ARG(values))
#define ASSERT_ARGS_mmd_cvt_to_types __attribute__unused__ int _ASSERT_ARGS_CHECK = (\
PARROT_ASSERT_ARG(interp) \
, PARROT_ASSERT_ARG(multi_sig))
#define ASSERT_ARGS_mmd_distance __attribute__unused__ int _ASSERT_ARGS_CHECK = (\
PARROT_ASSERT_ARG(interp) \
, PARROT_ASSERT_ARG(pmc) \
, PARROT_ASSERT_ARG(arg_tuple))
#define ASSERT_ARGS_mmd_search_by_sig_obj __attribute__unused__ int _ASSERT_ARGS_CHECK = (\
PARROT_ASSERT_ARG(interp) \
, PARROT_ASSERT_ARG(name) \
, PARROT_ASSERT_ARG(sig_obj) \
, PARROT_ASSERT_ARG(candidates))
#define ASSERT_ARGS_mmd_search_global __attribute__unused__ int _ASSERT_ARGS_CHECK = (\
PARROT_ASSERT_ARG(interp) \
, PARROT_ASSERT_ARG(name) \
, PARROT_ASSERT_ARG(cl))
#define ASSERT_ARGS_mmd_search_local __attribute__unused__ int _ASSERT_ARGS_CHECK = (\
PARROT_ASSERT_ARG(interp) \
, PARROT_ASSERT_ARG(name) \
, PARROT_ASSERT_ARG(candidates))
#define ASSERT_ARGS_Parrot_mmd_get_cached_multi_sig \
__attribute__unused__ int _ASSERT_ARGS_CHECK = (\
PARROT_ASSERT_ARG(interp) \
, PARROT_ASSERT_ARG(sub_pmc))
#define ASSERT_ARGS_Parrot_mmd_maybe_candidate __attribute__unused__ int _ASSERT_ARGS_CHECK = (\
PARROT_ASSERT_ARG(interp) \
, PARROT_ASSERT_ARG(pmc) \
, PARROT_ASSERT_ARG(cl))
#define ASSERT_ARGS_Parrot_mmd_search_scopes __attribute__unused__ int _ASSERT_ARGS_CHECK = (\
PARROT_ASSERT_ARG(interp) \
, PARROT_ASSERT_ARG(meth))
#define ASSERT_ARGS_Parrot_mmd_sort_candidates __attribute__unused__ int _ASSERT_ARGS_CHECK = (\
PARROT_ASSERT_ARG(interp) \
, PARROT_ASSERT_ARG(arg_tuple) \
, PARROT_ASSERT_ARG(cl))
/* Don't modify between HEADERIZER BEGIN / HEADERIZER END. Your changes will be lost. */
/* HEADERIZER END: static */
#define MMD_DEBUG 0
/*
=item C<PMC* Parrot_mmd_find_multi_from_sig_obj(PARROT_INTERP, STRING *name, PMC
*invoke_sig)>
Collect a list of possible candidates for a given sub name and call signature.
Rank the possible candidates by Manhattan Distance, and return the best
matching candidate. The candidate list is cached in the CallSignature object,
to allow for iterating through it.
Currently this only looks in the global "MULTI" namespace.
=cut
*/
PARROT_EXPORT
PARROT_WARN_UNUSED_RESULT
PARROT_CANNOT_RETURN_NULL
PMC*
Parrot_mmd_find_multi_from_sig_obj(PARROT_INTERP, ARGIN(STRING *name), ARGIN(PMC *invoke_sig))
{
ASSERT_ARGS(Parrot_mmd_find_multi_from_sig_obj)
PMC * const candidate_list = pmc_new(interp, enum_class_ResizablePMCArray);
mmd_search_by_sig_obj(interp, name, invoke_sig, candidate_list);
mmd_search_global(interp, name, candidate_list);
return Parrot_mmd_sort_manhattan_by_sig_pmc(interp, candidate_list, invoke_sig);
}
/*
=item C<void Parrot_mmd_multi_dispatch_from_c_args(PARROT_INTERP, const char
*name, const char *sig, ...)>
Dispatches to a MultiSub from a variable-sized list of C arguments. The
multiple dispatch system will figure out which sub should be called based on
the types of the arguments passed in.
Return arguments must be passed as a reference to the PMC, string, number, or
integer, so the result can be set.
=cut
*/
PARROT_EXPORT
PARROT_CAN_RETURN_NULL
void
Parrot_mmd_multi_dispatch_from_c_args(PARROT_INTERP,
ARGIN(const char *name), ARGIN(const char *sig), ...)
{
ASSERT_ARGS(Parrot_mmd_multi_dispatch_from_c_args)
PMC *sig_object, *sub;
va_list args;
va_start(args, sig);
sig_object = Parrot_pcc_build_sig_object_from_varargs(interp, PMCNULL, sig, args);
va_end(args);
/* Check the cache. */
sub = Parrot_mmd_cache_lookup_by_types(interp, interp->op_mmd_cache, name,
VTABLE_get_pmc(interp, sig_object));
if (PMC_IS_NULL(sub)) {
sub = Parrot_mmd_find_multi_from_sig_obj(interp,
Parrot_str_new_constant(interp, name), sig_object);
if (!PMC_IS_NULL(sub))
Parrot_mmd_cache_store_by_types(interp, interp->op_mmd_cache, name,
VTABLE_get_pmc(interp, sig_object), sub);
}
if (PMC_IS_NULL(sub))
Parrot_ex_throw_from_c_args(interp, NULL, EXCEPTION_METHOD_NOT_FOUND,
"Multiple Dispatch: No suitable candidate found for '%s',"
" with signature '%s'", name, sig);
#if MMD_DEBUG
Parrot_io_eprintf(interp, "candidate found for '%s', with signature '%s'\n",
name, sig);
Parrot_io_eprintf(interp, "type of candidate found: %Ss\n",
VTABLE_name(interp, sub));
#endif
Parrot_pcc_invoke_from_sig_object(interp, sub, sig_object);
}
/*
=item C<PMC * Parrot_mmd_find_multi_from_long_sig(PARROT_INTERP, STRING *name,
STRING *long_sig)>
Find the best candidate multi for a given sub name and signature. The signature
is a string containing a comma-delimited list of type names.
Currently only searches the global MULTI namespace.
=cut
*/
PARROT_EXPORT
PARROT_CAN_RETURN_NULL
PARROT_WARN_UNUSED_RESULT
PMC *
Parrot_mmd_find_multi_from_long_sig(PARROT_INTERP, ARGIN(STRING *name),
ARGIN(STRING *long_sig))
{
ASSERT_ARGS(Parrot_mmd_find_multi_from_long_sig)
STRING * const multi_str = CONST_STRING(interp, "MULTI");
PMC * const ns = Parrot_make_namespace_keyed_str(interp,
interp->root_namespace, multi_str);
PMC * const multi_sub = Parrot_get_global(interp, ns, name);
if (PMC_IS_NULL(multi_sub)) {
return PMCNULL;
}
else {
PMC * const type_tuple = mmd_build_type_tuple_from_long_sig(interp, long_sig);
return Parrot_mmd_sort_candidates(interp, type_tuple, multi_sub);
}
}
/*
=item C<PMC * Parrot_mmd_sort_manhattan_by_sig_pmc(PARROT_INTERP, PMC
*candidates, PMC *invoke_sig)>
Given an array PMC (usually a MultiSub) and a CallSignature PMC, sorts the mmd
candidates by their manhattan distance to the signature args and returns the
best one.
=cut
*/
PARROT_EXPORT
PARROT_CAN_RETURN_NULL
PARROT_WARN_UNUSED_RESULT
PMC *
Parrot_mmd_sort_manhattan_by_sig_pmc(PARROT_INTERP, ARGIN(PMC *candidates),
ARGIN(PMC *invoke_sig))
{
ASSERT_ARGS(Parrot_mmd_sort_manhattan_by_sig_pmc)
const INTVAL n = VTABLE_elements(interp, candidates);
if (!n)
return PMCNULL;
return Parrot_mmd_sort_candidates(interp,
VTABLE_get_pmc(interp, invoke_sig), candidates);
}
/*
=item C<static INTVAL distance_cmp(PARROT_INTERP, INTVAL a, INTVAL b)>
Compare distance values C<a> and C<b>. Return 1 if C<a> is larger, -1 if
C<b> is.
=cut
*/
static INTVAL
distance_cmp(SHIM_INTERP, INTVAL a, INTVAL b)
{
ASSERT_ARGS(distance_cmp)
short da = (short)(a & 0xffff);
short db = (short)(b & 0xffff);
/* sort first by distance */
if (da > db)
return 1;
if (da < db)
return -1;
/* end then by index in candidate list */
da = (short)(a >> 16);
db = (short)(b >> 16);
return da > db ? 1 : da < db ? -1 : 0;
}
/*
=item C<static PMC* mmd_build_type_tuple_from_type_list(PARROT_INTERP, PMC
*type_list)>
Construct a FixedIntegerArray of type numbers from an array of
type names. Used for multiple dispatch.
=cut
*/
PARROT_CANNOT_RETURN_NULL
PARROT_WARN_UNUSED_RESULT
static PMC*
mmd_build_type_tuple_from_type_list(PARROT_INTERP, ARGIN(PMC *type_list))
{
ASSERT_ARGS(mmd_build_type_tuple_from_type_list)
PMC *multi_sig = constant_pmc_new(interp, enum_class_FixedIntegerArray);
INTVAL param_count = VTABLE_elements(interp, type_list);
INTVAL i;
VTABLE_set_integer_native(interp, multi_sig, param_count);
for (i = 0; i < param_count; i++) {
STRING *type_name = VTABLE_get_string_keyed_int(interp, type_list, i);
INTVAL type;
if (Parrot_str_equal(interp, type_name, CONST_STRING(interp, "DEFAULT")))
type = enum_type_PMC;
else if (Parrot_str_equal(interp, type_name, CONST_STRING(interp, "STRING")))
type = enum_type_STRING;
else if (Parrot_str_equal(interp, type_name, CONST_STRING(interp, "INTVAL")))
type = enum_type_INTVAL;
else if (Parrot_str_equal(interp, type_name, CONST_STRING(interp, "FLOATVAL")))
type = enum_type_FLOATVAL;
else
type = pmc_type(interp, type_name);
VTABLE_set_integer_keyed_int(interp, multi_sig, i, type);
}
return multi_sig;
}
/*
=item C<static PMC* mmd_build_type_tuple_from_long_sig(PARROT_INTERP, STRING
*long_sig)>
Construct a FixedIntegerArray of type numbers from a comma-delimited string of
type names. Used for multiple dispatch.
=cut
*/
PARROT_CANNOT_RETURN_NULL
PARROT_WARN_UNUSED_RESULT
static PMC*
mmd_build_type_tuple_from_long_sig(PARROT_INTERP, ARGIN(STRING *long_sig))
{
ASSERT_ARGS(mmd_build_type_tuple_from_long_sig)
PMC *type_list = Parrot_str_split(interp, CONST_STRING(interp, ","), long_sig);
return mmd_build_type_tuple_from_type_list(interp, type_list);
}
/*
=item C<PMC* Parrot_mmd_build_type_tuple_from_sig_obj(PARROT_INTERP, PMC
*sig_obj)>
Construct a FixedIntegerArray of type numbers from the arguments of a Call
Signature object. Used for multiple dispatch.
=cut
*/
PARROT_EXPORT
PARROT_CANNOT_RETURN_NULL
PARROT_WARN_UNUSED_RESULT
PMC*
Parrot_mmd_build_type_tuple_from_sig_obj(PARROT_INTERP, ARGIN(PMC *sig_obj))
{
ASSERT_ARGS(Parrot_mmd_build_type_tuple_from_sig_obj)
PMC * const type_tuple = pmc_new(interp, enum_class_ResizableIntegerArray);
STRING *string_sig = VTABLE_get_string(interp, sig_obj);
INTVAL tuple_size = 0;
INTVAL args_ended = 0;
INTVAL i, seen_invocant = 0;
INTVAL sig_len;
if (STRING_IS_NULL(string_sig)) {
Parrot_ex_throw_from_c_args(interp, NULL, 1,
"Call has no signature, unable to dispatch.\n");
}
sig_len = Parrot_str_byte_length(interp, string_sig);
for (i = 0; i < sig_len; ++i) {
INTVAL type = Parrot_str_indexed(interp, string_sig, i + seen_invocant);
if (args_ended)
break;
/* Regular arguments just set the value */
switch (type) {
case 'I':
VTABLE_set_integer_keyed_int(interp, type_tuple,
i, enum_type_INTVAL);
break;
case 'N':
VTABLE_set_integer_keyed_int(interp, type_tuple,
i, enum_type_FLOATVAL);
break;
case 'S':
{
INTVAL type_lookahead = Parrot_str_indexed(interp, string_sig, (i + 1));
if (type_lookahead == 'n') {
args_ended = 1;
break;
}
VTABLE_set_integer_keyed_int(interp, type_tuple,
i, enum_type_STRING);
break;
}
case 'P':
{
INTVAL type_lookahead = Parrot_str_indexed(interp, string_sig, (i + 1));
if (type_lookahead == 'i') {
if (i != 0)
Parrot_ex_throw_from_c_args(interp, NULL,
EXCEPTION_INVALID_OPERATION,
"Multiple Dispatch: only the first argument can be an invocant");
seen_invocant = 1;
}
else if (type_lookahead == 'f') {
args_ended = 1;
break;
}
else {
PMC *pmc_arg = VTABLE_get_pmc_keyed_int(interp, sig_obj, i);
if (PMC_IS_NULL(pmc_arg))
VTABLE_set_integer_keyed_int(interp, type_tuple,
i, enum_type_PMC);
else
VTABLE_set_integer_keyed_int(interp, type_tuple, i,
VTABLE_type(interp, pmc_arg));
}
break;
}
case '-':
args_ended = 1;
break;
default:
Parrot_ex_throw_from_c_args(interp, NULL,
EXCEPTION_INVALID_OPERATION,
"Multiple Dispatch: invalid argument type %c!", type);
}
}
return type_tuple;
}
/*
=item C<static PMC* mmd_cvt_to_types(PARROT_INTERP, PMC *multi_sig)>
Given a ResizablePMCArray PMC containing some form of type identifier (either
the string name of a class or a PMC representing the type), resolves all type
references to type IDs, if possible. If that's not possible, returns PMCNULL.
In that case you can't dispatch to the multi variant with this type signature,
as Parrot doesn't yet know about the respective types requested -- you have to
register them first.
Otherwise, returns a ResizableIntegerArray PMC full of type IDs representing
the signature of a multi variant to which you may be able to dispatch.
{{**DEPRECATE**}}
=cut
*/
PARROT_WARN_UNUSED_RESULT
PARROT_CAN_RETURN_NULL
static PMC*
mmd_cvt_to_types(PARROT_INTERP, ARGIN(PMC *multi_sig))
{
ASSERT_ARGS(mmd_cvt_to_types)
PMC *ar = PMCNULL;
const INTVAL n = VTABLE_elements(interp, multi_sig);
INTVAL i;
for (i = 0; i < n; ++i) {
PMC * const sig_elem = VTABLE_get_pmc_keyed_int(interp, multi_sig, i);
INTVAL type;
if (sig_elem->vtable->base_type == enum_class_String) {
STRING * const sig = VTABLE_get_string(interp, sig_elem);
if (!sig)
return PMCNULL;
type = pmc_type(interp, sig);
if (type == enum_type_undef)
return PMCNULL;
}
else if (sig_elem->vtable->base_type == enum_class_Integer) {
type = VTABLE_get_integer(interp, sig_elem);
}
else
type = pmc_type_p(interp, sig_elem);
/* create destination PMC only as necessary */
if (PMC_IS_NULL(ar)) {
ar = pmc_new(interp, enum_class_FixedIntegerArray);
VTABLE_set_integer_native(interp, ar, n);
}
VTABLE_set_integer_keyed_int(interp, ar, i, type);
}
return ar;
}
/*
=item C<static PMC * Parrot_mmd_get_cached_multi_sig(PARROT_INTERP, PMC
*sub_pmc)>
Get the cached multisig of the given sub, if one exists. The cached signature
might be in different formats, so put it into a type tuple like the rest of the
MMD system expects.
=cut
*/
PARROT_WARN_UNUSED_RESULT
PARROT_CAN_RETURN_NULL
static PMC *
Parrot_mmd_get_cached_multi_sig(PARROT_INTERP, ARGIN(PMC *sub_pmc))
{
ASSERT_ARGS(Parrot_mmd_get_cached_multi_sig)
if (VTABLE_isa(interp, sub_pmc, CONST_STRING(interp, "Sub"))) {
Parrot_Sub_attributes *sub;
PMC *multi_sig;
PMC_get_sub(interp, sub_pmc, sub);
multi_sig = sub->multi_signature;
if (multi_sig->vtable->base_type == enum_class_FixedPMCArray) {
PMC *converted_sig = mmd_cvt_to_types(interp, multi_sig);
if (PMC_IS_NULL(converted_sig))
return PMCNULL;
multi_sig = sub->multi_signature = converted_sig;
}
return multi_sig;
}
return PMCNULL;
}
#define MMD_BIG_DISTANCE 0x7fff
/*
=item C<static UINTVAL mmd_distance(PARROT_INTERP, PMC *pmc, PMC *arg_tuple)>
Create Manhattan Distance of sub C<pmc> against given argument types.
0xffff is the maximum distance
=cut
*/
static UINTVAL
mmd_distance(PARROT_INTERP, ARGIN(PMC *pmc), ARGIN(PMC *arg_tuple))
{
ASSERT_ARGS(mmd_distance)
PMC *multi_sig, *mro;
Parrot_Sub_attributes *sub;
INTVAL args, dist, i, j, n, m;
/* has to be a builtin multi method */
if (pmc->vtable->base_type == enum_class_NCI) {
GETATTR_NCI_multi_sig(interp, pmc, multi_sig);
if (PMC_IS_NULL(multi_sig)) {
STRING *long_sig;
GETATTR_NCI_long_signature(interp, pmc, long_sig);
multi_sig = mmd_build_type_tuple_from_long_sig(interp, long_sig);
SETATTR_NCI_multi_sig(interp, pmc, multi_sig);
}
}
else {
/* not a multi; no distance */
PMC_get_sub(interp, pmc, sub);
if (!sub->multi_signature)
return 0;
multi_sig = Parrot_mmd_get_cached_multi_sig(interp, pmc);
}
if (PMC_IS_NULL(multi_sig))
return MMD_BIG_DISTANCE;
n = VTABLE_elements(interp, multi_sig);
args = VTABLE_elements(interp, arg_tuple);
/*
* arg_tuple may have more arguments - only the
* n multi_sig invocants are counted
*/
if (args < n)
return MMD_BIG_DISTANCE;
dist = 0;
if (args > n)
dist = PARROT_MMD_MAX_CLASS_DEPTH;
/* now go through args */
for (i = 0; i < n; ++i) {
const INTVAL type_sig = VTABLE_get_integer_keyed_int(interp, multi_sig, i);
const INTVAL type_call = VTABLE_get_integer_keyed_int(interp, arg_tuple, i);
if (type_sig == type_call)
continue;
/* promote primitives to their PMC equivalents, as PCC will autobox
* the distance penalty makes primitive variants look cheaper */
switch (type_call) {
case enum_type_INTVAL:
if (type_sig == enum_class_Integer) { dist++; continue; }
break;
case enum_type_FLOATVAL:
if (type_sig == enum_class_Float) { dist++; continue; }
break;
case enum_type_STRING:
if (type_sig == enum_class_String) { dist++; continue; }
break;
default:
break;
}
/*
* different native types are very different, except a PMC
* which matches any PMC
*/
if (type_call <= 0 && type_sig == enum_type_PMC) {
dist++;
continue;
}
if ((type_sig <= 0 && type_sig != enum_type_PMC) || type_call <= 0) {
dist = MMD_BIG_DISTANCE;
break;
}
/*
* now consider MRO of types the signature type has to be somewhere
* in the MRO of the type_call
*/
mro = interp->vtables[type_call]->mro;
m = VTABLE_elements(interp, mro);
for (j = 0; j < m; ++j) {
PMC * const cl = VTABLE_get_pmc_keyed_int(interp, mro, j);
if (cl->vtable->base_type == type_sig)
break;
if (VTABLE_type(interp, cl) == type_sig)
break;
++dist;
}
/*
* if the type wasn't in MRO check, if any PMC matches
* in that case use the distance + 1 (of an any PMC parent)
*/
if (j == m && type_sig != enum_type_PMC) {
dist = MMD_BIG_DISTANCE;
break;
}
++dist;
#if MMD_DEBUG
{
STRING *s1, *s2;
if (type_sig < 0)
s1 = Parrot_get_datatype_name(interp, type_sig);
else
s1 = interp->vtables[type_sig]->whoami;
if (type_call < 0)
s2 = Parrot_get_datatype_name(interp, type_call);
else
s2 = interp->vtables[type_call]->whoami;
Parrot_io_eprintf(interp, "arg %d: dist %d sig %Ss arg %Ss\n",
i, dist, s1, s2);
}
#endif
}
return dist;
}
/*
=item C<static PMC * Parrot_mmd_sort_candidates(PARROT_INTERP, PMC *arg_tuple,
PMC *cl)>
Sort the candidate list C<cl> by Manhattan Distance, returning the best
candidate.
=cut
*/
PARROT_CANNOT_RETURN_NULL
static PMC *
Parrot_mmd_sort_candidates(PARROT_INTERP, ARGIN(PMC *arg_tuple), ARGIN(PMC *cl))
{
ASSERT_ARGS(Parrot_mmd_sort_candidates)
PMC *best_candidate = PMCNULL;
INTVAL best_distance = MMD_BIG_DISTANCE;
const INTVAL n = VTABLE_elements(interp, cl);
INTVAL i;
for (i = 0; i < n; ++i) {
PMC * const pmc = VTABLE_get_pmc_keyed_int(interp, cl, i);
const INTVAL d = mmd_distance(interp, pmc, arg_tuple);
if (d < best_distance) {
best_candidate = pmc;
best_distance = d;
}
}
return best_candidate;
}
/*
=item C<static PMC* Parrot_mmd_search_scopes(PARROT_INTERP, STRING *meth)>
Search all scopes for MMD candidates matching the arguments given in
C<arg_tuple>.
=cut
*/
PARROT_CANNOT_RETURN_NULL
PARROT_WARN_UNUSED_RESULT
static PMC*
Parrot_mmd_search_scopes(PARROT_INTERP, ARGIN(STRING *meth))
{
ASSERT_ARGS(Parrot_mmd_search_scopes)
PMC * const candidates = pmc_new(interp, enum_class_ResizablePMCArray);
const int stop = mmd_search_local(interp, meth, candidates);
if (!stop)
mmd_search_global(interp, meth, candidates);
return candidates;
}
/*
=item C<static int Parrot_mmd_maybe_candidate(PARROT_INTERP, PMC *pmc, PMC *cl)>
If the candidate C<pmc> is a Sub PMC, push it on the candidate list and
return TRUE to stop further search.
If the candidate is a MultiSub remember all matching Subs and return FALSE
to continue searching outer scopes.
=cut
*/
static int
Parrot_mmd_maybe_candidate(PARROT_INTERP, ARGIN(PMC *pmc), ARGIN(PMC *cl))
{
ASSERT_ARGS(Parrot_mmd_maybe_candidate)
STRING * const _sub = CONST_STRING(interp, "Sub");
STRING * const _multi_sub = CONST_STRING(interp, "MultiSub");
INTVAL i, n;
if (VTABLE_isa(interp, pmc, _sub)) {
/* a plain sub stops outer searches */
VTABLE_push_pmc(interp, cl, pmc);
return 1;
}
/* not a Sub or MultiSub - ignore */
if (!VTABLE_isa(interp, pmc, _multi_sub))
return 0;
/* ok we have a multi sub pmc, which is an array of candidates */
n = VTABLE_elements(interp, pmc);
for (i = 0; i < n; ++i) {
PMC * const multi_sub = VTABLE_get_pmc_keyed_int(interp, pmc, i);
VTABLE_push_pmc(interp, cl, multi_sub);
}
return 0;
}
/*
=item C<static int mmd_search_local(PARROT_INTERP, STRING *name, PMC
*candidates)>
Search the current package namespace for matching candidates. Return
TRUE if the MMD search should stop.
=cut
*/
static int
mmd_search_local(PARROT_INTERP, ARGIN(STRING *name), ARGIN(PMC *candidates))
{
ASSERT_ARGS(mmd_search_local)
PMC * const multi_sub = Parrot_find_global_cur(interp, name);
return multi_sub && Parrot_mmd_maybe_candidate(interp, multi_sub, candidates);
}
/*
=item C<static void mmd_search_by_sig_obj(PARROT_INTERP, STRING *name, PMC
*sig_obj, PMC *candidates)>
Search the namespace of the first argument to the sub call for matching
candidates.
=cut
*/
static void
mmd_search_by_sig_obj(PARROT_INTERP, ARGIN(STRING *name),
ARGIN(PMC *sig_obj), ARGIN(PMC *candidates))
{
ASSERT_ARGS(mmd_search_by_sig_obj)
PMC *first_arg = VTABLE_get_pmc_keyed_int(interp, sig_obj, 0);
PMC *ns, *multi_sub;
if (PMC_IS_NULL(first_arg))
return;