Treeview and SpriteOP

We are using Treeview in !CLFiler and want to display the App sprite in the tree. We do it already but discovered that it doesn’t work with all sprites as they are sometimes not declared. We set the "sm!{appname} as reference. So some are missing when that one is not available in the App’s sprite file.

Example of missing sm!sprite

So the idea is that we create the missing sprites in the sprite area but we are running into a problem there.

Current problem:

Problem that I can’t create the sprite in the system sprite area.
When I tried to create a sprite with “OS_SpriteOp 15 – Create sprite” I got an error that there was not enough memory in the sprite area.
I tried to reallocate sprite area memory with OS_ChangeDynamicArea http://www.riscos.com/support/developers/prm/memoryman.html#89840
No errors and “OS_SpriteOp 15 – Create sprite” also returned without errors but sprite is not created.
The “OS_SpriteOp 24 – Select sprite” https://www.riscosopen.org/wiki/documentation/show/OS_SpriteOp%2024 cant find it and the sprite info call returned 0×0 dimensions.

This is the code:

It needs to be in the Wimp Sprite Area, not the System Sprite Area.

sm!… sprites are half-size. If it doesn’t exist, you can use Wimp_PlotIcon with the fullsize icon and set the bit for half-size sprite.

But how to create sprite in the WimpSprite area? (i thought that system area and wimp area it is the same)

In the docs about OS_SpriteOp I get that R1 must be pointer to sprite area or 0 for system area. I tried to set is as 0.
How to get pointer to Wimp Sprite area?

Thank you

@Stuart OK that might be the solution.

@Graeme: WimpPlotIcon is not the right way as Treeview does the Redraw not our App.

Her is the code to set the sprite name:
The code is: node.sprite(1, spr->name(), spr->name());

void TreeViewCurrentNode::sprite(int sprite_area_id, const std::string &sprite_name, const std::string &expanded_sprite_name)
{
_kernel_swi_regs regs;
regs.r0 = 0; // Flags are zero
regs.r1 = _handle;
regs.r2 = 0×402d;
regs.r3 = id;
regs.r4 = sprite_area_id;
regs.r5 = reinterpret_cast(sprite_name.c_str());
regs.r6 = reinterpret_cast(expanded_sprite_name.cstr());


I think it’s best to let the Wimp completely manage its Sprite Area; I think it might get upset if external code starts messing with it using SWI OS_SpriteOp (see “Wimp internally caches pointers to its sprites”). Hang on, there is SWI Wimp_SpriteOp …

But how to create sprite in the WimpSprite area?

The *IconSprites command will merge the sprites in a sprite file into the area. It’s how your application adds its icon to the area for use in Filer windows.

(i thought that system area and wimp area it is the same)

No, they are not. The System area is an Arthur-era (or probably BBC MOS-era) thing that has been deprecated for many, many years. Don’t use it.

In the docs about OS_SpriteOp I get that R1 must be pointer to sprite area or 0 for system area. I tried to set is as 0.

Do not use OS_SpriteOp for managing the Wimp area.

How to get pointer to Wimp Sprite area?

As Stuart says, use the Wimp_SpriteOp SWI that the Wimp helpfully provides for accessing its area. If Wimp_SpriteOp won’t do something that you need, it’s probably safest to assume that you shouldn’t be doing it – and a hint that taking a different approach would be better.

We found out in the meantime that Treeview allows to specify sprite from app memory by specifying the sprite area address.

@Steve: The *IconSprites command might be a good way so we can create the sprites only one time and save them in the app folder.

void CLDirectoryWindow::assign_node_sprite(tbx::ext::TreeViewCurrentNode& node, CLDirectoryItemData item) {
CLBaseImage *spr = item→small_sprite_image();
// Log_debug(“CLDirectoryWindow::assign_node_sprite small spr:%p item:%s”, spr, item→name().c_str());
if (spr) {
if (spr→get_image_type() == CL_IMAGE_TYPE_WIMP_SPRITE) {
node.sprite(1, ((CLWimpSpriteImage)spr)→name_str(), ((CLWimpSpriteImage*)spr)→name_str());
} else {
CLUserSpriteImage user_spr = ((CLUserSpriteImage)spr);
std::string spr_name = user_spr→name();
node.sprite((int)user_spr→get_area_pointer(), spr_name, spr_name);
}
} else {
node.sprite(1, “small_dir”, “small_diro”);
}
}

We found out in the meantime that Treeview allows to specify sprite from app memory by specifying the sprite area address.

That’s the correct way to do it, then, unless the sprites would already be in the Wimp Sprite Pool for another reason. Your users can’t get space from the Wimp Sprite Pool back afterwards, so unless the specific sprites are to be used in Filer windows or somewhere else that you can’t set your own sprite area, use an application sprite area.