context.annotation_data isn't set to nullptr when the last annotation layer is deleted #112683

New Issue

Milan Davidović · 2023-09-21T18:56:18+02:00

Milan Davidović commented

2023-09-21 18:56:18 +02:00

System Information
Operating system: Windows 10 Pro
Graphics card: NVIDIA GeForce GTX 1060 3GB/PCIe/SSE2

Blender Version
Broken: 3.6.2, branch: blender-v3.6-release, commit date: 2023-08-16 16:43, hash: e53e55951e, type: release

Short description of error
When the last Annotation layer is deleted from the list, there are warnings printed out to the console on each viewport update.
Looks like context.annotation_data isn't set to nullptr when the last annotation layer is deleted.

Exact steps for others to reproduce the error

Start with the default empty scene.
If the console isn't already visible, open it with Window -> Toggle System Console.
In the 3D viewport, select the Annotate tool and draw a line with it.
In the Tool Settings, open the annotation layers popup and delete the single existing layer named 'Note'.
A few same warnings will be printed out in the console, and again on each update of the viewport:

WARN (bpy.rna): D:\Work\Projects\blender-git\blender\source\blender\python\intern\bpy_rna.cc:1349 pyrna_enum_to_py: current value '-1' matches no enum in 'GreasePencilLayers', '(null)', 'active_note'

**System Information** Operating system: Windows 10 Pro Graphics card: NVIDIA GeForce GTX 1060 3GB/PCIe/SSE2 **Blender Version** Broken: 3.6.2, branch: blender-v3.6-release, commit date: 2023-08-16 16:43, hash: e53e55951e7a, type: release **Short description of error** When the last Annotation layer is deleted from the list, there are warnings printed out to the console on each viewport update. Looks like context.annotation_data isn't set to nullptr when the last annotation layer is deleted. **Exact steps for others to reproduce the error** 1. Start with the default empty scene. 2. If the console isn't already visible, open it with Window -> Toggle System Console. 3. In the 3D viewport, select the Annotate tool and draw a line with it. 4. In the Tool Settings, open the annotation layers popup and delete the single existing layer named 'Note'. 5. A few same warnings will be printed out in the console, and again on each update of the viewport: `WARN (bpy.rna): D:\Work\Projects\blender-git\blender\source\blender\python\intern\bpy_rna.cc:1349 pyrna_enum_to_py: current value '-1' matches no enum in 'GreasePencilLayers', '(null)', 'active_note' `

👍 1

Milan Davidović added the

labels 2023-09-21 18:56:19 +02:00

Milan Davidović commented

2023-09-21 19:08:09 +02:00

I'm already looking into this.

YimingWu commented

2023-09-22 04:58:56 +02:00

Can reproduce on 3.6.2 and 4.0. The error will be printed any time the tool options header updates, suggesting somewhere in the UI script it needs to handle a null-layer situation.

YimingWu added

and removed

labels 2023-09-22 04:59:07 +02:00

Milan Davidović commented

2023-09-22 23:28:53 +02:00

The UI script seems to handle null-layer situation well, but it seems that after deleting the last layer the annotation data bGPdata in C code hasn't been freed and that the script can still access it.

If I print messages in _defs_annotate.draw_settings_common like so:

Initially, when I select the annotation tool, only the first message is printed ("in draw_settings_common").

When I draw something, all three messages are printed.

But when I delete the last layer, all three messages still get printed out (together with that warning), meaning that the bGPdata hasn't been freed and the pointer set to null.

When I do this at the end of gpencil_layer_remove_exec():

  if (gpd->layers.first == nullptr) {
    bGPdata **gpd_ptr = ED_annotation_data_get_pointers(C, nullptr);
    *gpd_ptr = nullptr;
  }

... the problem disappears, but I leak memory. I'll just need to figure out how to free everything properly (I'm new to the code base so it's not that obvious what I need to do, but I'll manage).

The UI script seems to handle null-layer situation well, but it seems that after deleting the last layer the annotation data bGPdata in C code hasn't been freed and that the script can still access it. If I print messages in _defs_annotate.draw_settings_common like so: ![image](/attachments/3e8757dc-2ebd-401e-a964-9a423f0678c0) Initially, when I select the annotation tool, only the first message is printed ("in draw_settings_common"). When I draw something, all three messages are printed. But when I delete the last layer, all three messages still get printed out (together with that warning), meaning that the bGPdata hasn't been freed and the pointer set to null. ![image](/attachments/4cfc17c1-de60-49a8-b63d-a8676e17d323) When I do this at the end of gpencil_layer_remove_exec(): ``` if (gpd->layers.first == nullptr) { bGPdata **gpd_ptr = ED_annotation_data_get_pointers(C, nullptr); *gpd_ptr = nullptr; } ``` ... the problem disappears, but I leak memory. I'll just need to figure out how to free everything properly (I'm new to the code base so it's not that obvious what I need to do, but I'll manage).

image.png

37 KiB

image.png

13 KiB

Jesse Yurkovich added the

Module

Grease Pencil

label 2023-10-04 04:39:40 +02:00

Milan Davidović referenced a pull request that will close this issue

2023-10-05 08:52:23 +02:00

Fix #112683: Removing the last Annotations layer produces a warning. #113274

Pratik Borhade referenced this issue from a commit