Version 20 (modified by cotto, 5 years ago)

add moderately coherent gotcha about MULTIs


The PMC Union is being deprecated, which means that any instances of PMC_int_val, etc need to disappear. This is a big job with several gotchas.

What Needs to Happen

The following PMCs should be straightforward to convert to ATTRs. If a PMC has a certain macro listed, only convert uses of that macro to ATTRs for the PMC. Other UnionVal macros have depenency issues which are not yet resolvable.

BigIntfixed in r35664
Continuation (PMC_pmc_val only)removed in r35712
Coroutine (PMC_pmc_val only)
Floatfixed in r35666
LexPad (PMC_pmc_val only)fixed in r35669
MatchRange (PMC_int_val2 only)
NameSpace (PMC_pmc_val only)
SArraywill be removed
TQueuefixed in r35653

Allison  explained in depth how to convert code. Good example code can be found in src/pmc/exporter.pmc .


Because the PMC union struct is part of a PMC's internals, its use is affected by PMC inheritance. The following image shows the dependencies between all *core* PMCs. This does not include PMCs from HLLs. Because of these dependencies, all PMCs in a given dependency tree will have to be updated simultaneously. This only means that all instances of e.g. PMC_struct_val will have to be updated, not all instances of all PMC_x_val.


* src/gc/mark_sweep.c also uses PMC_struct_val in two places. This needs to be investigated and the data stored elsewhere. See TT #178.


* You may need to add certain VTABLE functions to the PMCs which you are updating. This applies not just to init and destroy, but also clone, morph and other functions that need to deal with the PMC's internal data. This is especially true if your PMC *doesn't have* an explicit clone VTABLE function. The absence of clone VTABLE function means that it's using the default clone, which works by copying the UnionVal. Such functions will *not* work properly for any PMCs which don't use the UnionVal.

* Make sure that PMC_data is only used for the PMC-specific attributes struct.

* Watch out for MULTI functions in base classes. This is mainly a concern when working on an extending PMC where the base PMC has a MULTI function that the extending PMC doesn't override. For example, the String PMC needs its own is_equal MULTI, since scalar's is_equal MULTI assumes that any extending PMCs use the UnionVal rather than ATTRs.