Memory management of PluginBookmarkList

[Thomas]

Does anybody know the right usage of PluginBookmarkList/getBookmarkList?
If I call it, I'll get correct results. What I don't understand, is how to cleanup the memory after that.

If I simply call freeMemory on the pointer, the client crashes. If I don't call it, the client will crash on unloading the plugin.
I already tested, calling freeMemory on each "child" item first, but had no luck with it.

Here is some snippet:

PluginBookmarkList* bookmarks;

  if (funcs.getBookmarkList(&bookmarks) == ERROR_ok) {
    for (int i = 0; i < bookmarks->itemcount; ++i)
      printf("got bm %s\n", bookmarks->items[i].name);


    printf("I'll print this\n");
    funcs.freeMemory(bookmarks);
    printf("but not this\n");
  }

Or is this a bug?

Running on linux amd64 here.

[Chris]

That's currently a bug due to changes for the new client.
On Windows you won't even get that far and crash directly in the function call (at least with your code).
Once fixed, to release allocated memory you will have to call freeMemory for the main pointer and the folder member of each item where isFolder is true.

Thanks for report.

[Thomas]

Thx for the quick reply!

[Chris]

Will be fixed with next client.
Developers reminded me you also have to free the char* members of the struct, which I forgot when I was testing it and wrote the reply.

[Thomas]

So something like this:

void freeBookmarkList(struct PluginBookmarkList* list) {
  for (int i = 0; i < list->itemcount; ++i) {
    ts3_funcs.freeMemory(list->items[i].name);
    if (list->items[i].isFolder)
      freeBookmarkList(list->items[i].folder);
    else ts3_funcs.freeMemory(list->items[i].uuid); //or does directories also have a uuid?
  }

  ts3_funcs.freeMemory(list);
}

[Chris]

So something like this:

void freeBookmarkList(struct PluginBookmarkList* list) {
  for (int i = 0; i < list->itemcount; ++i) {
    ts3_funcs.freeMemory(list->items[i].name);
    if (list->items[i].isFolder)
      freeBookmarkList(list->items[i].folder);
    else ts3_funcs.freeMemory(list->items[i].uuid); //or does directories also have a uuid?
  }

  ts3_funcs.freeMemory(list);
}

Yes, like that.
There will be an example in the plugin.c with the next update.

[Thomas]

I'll post it here, because it could be related.

If you try to create a bookmark (createBookmark), what is the purpose of the first parameter (bookmarkuuid)? I could imagine it should be either the predecessor in list or the parent folder of the new bookmark.
If I pass a valid uuid of an existing bookmark, there is no new bookmark (but the function returns 0).
If I pass an empty string, the bookmark is created. Don't know if the position in list is random.

Follow up: Folders does not seem to have a uuid, so how do you create a bookmark as child of a folder?

[Chris]

The uuid parameter should be nullptr, it is marked for removal.
You cannot specify the position of the bookmark that is being created. The user has the choice of where to put it after it was created. It will be created according to the users options and is (should) always be created at the end of the list.
Before you ask: No you cannot create Folders either.

[Thomas]

Thx, all questions asked (for now ).