sc_fuel

Prototype

$space = &sc_fuel(supply[,%options]);

$space = $region->sc_fuel([supply,%options])

Parameters

M/O = Mandatory/Optional

Return Type

SC_SPACE

Description

sc_fuel loads field and region definitions from a supply and returns them in a space. If called as a region method and the region has no children, the region is populated with the children of the space.

A supply is either specified as a type or a file. If it specified as a file, the type is set to the basename of the file. If it is specified as a type, the fuel supply list is searched for a matching file. See sc_fuel_supply for details on finding a supply file from a supply type.

If the supply type has not been previously loaded, the supply file is parsed into a space and returned.

If the supply type has been previously loaded, the previously loaded space is returned.

If called as a region method the supply may be omitted, in which case the region must have a type, as the region type is used as the supply type.

The sc_fuel API may be called with the following options in either context:

Example

$space = &sc_get_space();

$space->sc_fuel("chip.rf", -recursive => 1);

Here the top level space is recursively loaded from the “chip.rf” file.

This is equivalent to the following command line:

$ spacecraft -R chip.rf ...

$chip = &sc_get_space();

$macro = &sc_fuel("macro");

$chip->sc_add_region(-offset => '0KB, -size => '8KB', -name => 'MX')->sc_set_children($macro);
$chip->sc_add_region(-offset => '8KB, -size => '8KB', -name => 'MY')->sc_set_children($macro);

Here we do some bottom up construction, where the $macro definition is loaded from the “macro” type (assuming macro.rf can be found) and added to the chip as two different instances.

This is equivalent to the following chip.rf:

0KB 8KB MX macro;
8KB 8KB MY macro;