Refactor: move GPencil .blend I/O to IDTypeInfo callbacks

4 files changed, 171 insertions, 166 deletions

diff --git a/source/blender/blenkernel/BKE_gpencil.h b/source/blender/blenkernel/BKE_gpencil.h
index 88eef40ebd2..f1912b14e8c 100644
--- a/source/blender/blenkernel/BKE_gpencil.h
+++ b/source/blender/blenkernel/BKE_gpencil.h
@@ -48,6 +48,7 @@ struct bGPDlayer_Mask;
 struct bGPDspoint;
 struct bGPDstroke;
 struct bGPdata;
+struct BlendDataReader;
 
 #define GPENCIL_SIMPLIFY(scene) ((scene->r.simplify_gpencil & SIMPLIFY_GPENCIL_ENABLE))
 #define GPENCIL_SIMPLIFY_ONPLAY(playing) \
@@ -281,6 +282,8 @@ void BKE_gpencil_parent_matrix_get(const struct Depsgraph *depsgraph,
 
 void BKE_gpencil_update_layer_parent(const struct Depsgraph *depsgraph, struct Object *ob);
 
+void BKE_gpencil_blend_read_data(struct BlendDataReader *reader, struct bGPdata *gpd);
+
 #ifdef __cplusplus
 }
 #endif
diff --git a/source/blender/blenkernel/intern/gpencil.c b/source/blender/blenkernel/intern/gpencil.c
index 1e37ae3892b..03ac7e622e1 100644
--- a/source/blender/blenkernel/intern/gpencil.c
+++ b/source/blender/blenkernel/intern/gpencil.c
@@ -40,12 +40,16 @@
 #include "IMB_imbuf.h"
 #include "IMB_imbuf_types.h"
 
+/* Allow using deprecated functionality for .blend file I/O. */
+#define DNA_DEPRECATED_ALLOW
+
 #include "DNA_gpencil_types.h"
 #include "DNA_material_types.h"
 #include "DNA_meshdata_types.h"
 #include "DNA_space_types.h"
 
 #include "BKE_action.h"
+#include "BKE_anim_data.h"
 #include "BKE_collection.h"
 #include "BKE_colortools.h"
 #include "BKE_deform.h"
@@ -64,6 +68,10 @@
 
 #include "DEG_depsgraph_query.h"
 
+#include "BLO_read_write.h"
+
+#include "BKE_gpencil.h"
+
 static CLG_LogRef LOG = {"bke.gpencil"};
 
 static void greasepencil_copy_data(Main *UNUSED(bmain),
@@ -111,6 +119,154 @@ static void greasepencil_foreach_id(ID *id, LibraryForeachIDData *data)
   }
 }
 
+static void greasepencil_blend_write(BlendWriter *writer, ID *id, const void *id_address)
+{
+  bGPdata *gpd = (bGPdata *)id;
+  if (gpd->id.us > 0 || BLO_write_is_undo(writer)) {
+    /* Clean up, important in undo case to reduce false detection of changed data-blocks. */
+    /* XXX not sure why the whole run-time data is not cleared in reading code,
+     * for now mimicking it here. */
+    gpd->runtime.sbuffer = NULL;
+    gpd->runtime.sbuffer_used = 0;
+    gpd->runtime.sbuffer_size = 0;
+    gpd->runtime.tot_cp_points = 0;
+
+    /* write gpd data block to file */
+    BLO_write_id_struct(writer, bGPdata, id_address, &gpd->id);
+    BKE_id_blend_write(writer, &gpd->id);
+
+    if (gpd->adt) {
+      BKE_animdata_blend_write(writer, gpd->adt);
+    }
+
+    BLO_write_pointer_array(writer, gpd->totcol, gpd->mat);
+
+    /* write grease-pencil layers to file */
+    BLO_write_struct_list(writer, bGPDlayer, &gpd->layers);
+    LISTBASE_FOREACH (bGPDlayer *, gpl, &gpd->layers) {
+      /* Write mask list. */
+      BLO_write_struct_list(writer, bGPDlayer_Mask, &gpl->mask_layers);
+      /* write this layer's frames to file */
+      BLO_write_struct_list(writer, bGPDframe, &gpl->frames);
+      LISTBASE_FOREACH (bGPDframe *, gpf, &gpl->frames) {
+        /* write strokes */
+        BLO_write_struct_list(writer, bGPDstroke, &gpf->strokes);
+        LISTBASE_FOREACH (bGPDstroke *, gps, &gpf->strokes) {
+          BLO_write_struct_array(writer, bGPDspoint, gps->totpoints, gps->points);
+          BLO_write_struct_array(writer, bGPDtriangle, gps->tot_triangles, gps->triangles);
+          BKE_defvert_blend_write(writer, gps->totpoints, gps->dvert);
+        }
+      }
+    }
+  }
+}
+
+void BKE_gpencil_blend_read_data(BlendDataReader *reader, bGPdata *gpd)
+{
+  /* we must firstly have some grease-pencil data to link! */
+  if (gpd == NULL) {
+    return;
+  }
+
+  /* relink animdata */
+  BLO_read_data_address(reader, &gpd->adt);
+  BKE_animdata_blend_read_data(reader, gpd->adt);
+
+  /* Ensure full objectmode for linked grease pencil. */
+  if (gpd->id.lib != NULL) {
+    gpd->flag &= ~GP_DATA_STROKE_PAINTMODE;
+    gpd->flag &= ~GP_DATA_STROKE_EDITMODE;
+    gpd->flag &= ~GP_DATA_STROKE_SCULPTMODE;
+    gpd->flag &= ~GP_DATA_STROKE_WEIGHTMODE;
+    gpd->flag &= ~GP_DATA_STROKE_VERTEXMODE;
+  }
+
+  /* init stroke buffer */
+  gpd->runtime.sbuffer = NULL;
+  gpd->runtime.sbuffer_used = 0;
+  gpd->runtime.sbuffer_size = 0;
+  gpd->runtime.tot_cp_points = 0;
+
+  /* relink palettes (old palettes deprecated, only to convert old files) */
+  BLO_read_list(reader, &gpd->palettes);
+  if (gpd->palettes.first != NULL) {
+    LISTBASE_FOREACH (Palette *, palette, &gpd->palettes) {
+      BLO_read_list(reader, &palette->colors);
+    }
+  }
+
+  /* materials */
+  BLO_read_pointer_array(reader, (void **)&gpd->mat);
+
+  /* relink layers */
+  BLO_read_list(reader, &gpd->layers);
+
+  LISTBASE_FOREACH (bGPDlayer *, gpl, &gpd->layers) {
+    /* relink frames */
+    BLO_read_list(reader, &gpl->frames);
+
+    BLO_read_data_address(reader, &gpl->actframe);
+
+    gpl->runtime.icon_id = 0;
+
+    /* Relink masks. */
+    BLO_read_list(reader, &gpl->mask_layers);
+
+    LISTBASE_FOREACH (bGPDframe *, gpf, &gpl->frames) {
+      /* relink strokes (and their points) */
+      BLO_read_list(reader, &gpf->strokes);
+
+      LISTBASE_FOREACH (bGPDstroke *, gps, &gpf->strokes) {
+        /* relink stroke points array */
+        BLO_read_data_address(reader, &gps->points);
+        /* Relink geometry*/
+        BLO_read_data_address(reader, &gps->triangles);
+
+        /* relink weight data */
+        if (gps->dvert) {
+          BLO_read_data_address(reader, &gps->dvert);
+          BKE_defvert_blend_read(reader, gps->totpoints, gps->dvert);
+        }
+      }
+    }
+  }
+}
+
+static void greasepencil_blend_read_data(BlendDataReader *reader, ID *id)
+{
+  bGPdata *gpd = (bGPdata *)id;
+  BKE_gpencil_blend_read_data(reader, gpd);
+}
+
+static void greasepencil_blend_read_lib(BlendLibReader *reader, ID *id)
+{
+  bGPdata *gpd = (bGPdata *)id;
+
+  /* Relink all data-lock linked by GP data-lock */
+  /* Layers */
+  LISTBASE_FOREACH (bGPDlayer *, gpl, &gpd->layers) {
+    /* Layer -> Parent References */
+    BLO_read_id_address(reader, gpd->id.lib, &gpl->parent);
+  }
+
+  /* materials */
+  for (int a = 0; a < gpd->totcol; a++) {
+    BLO_read_id_address(reader, gpd->id.lib, &gpd->mat[a]);
+  }
+}
+
+static void greasepencil_blend_read_expand(BlendExpander *expander, ID *id)
+{
+  bGPdata *gpd = (bGPdata *)id;
+  LISTBASE_FOREACH (bGPDlayer *, gpl, &gpd->layers) {
+    BLO_expand(expander, gpl->parent);
+  }
+
+  for (int a = 0; a < gpd->totcol; a++) {
+    BLO_expand(expander, gpd->mat[a]);
+  }
+}
+
 IDTypeInfo IDType_ID_GD = {
     .id_code = ID_GD,
     .id_filter = FILTER_ID_GD,
@@ -128,10 +284,10 @@ IDTypeInfo IDType_ID_GD = {
     .foreach_id = greasepencil_foreach_id,
     .foreach_cache = NULL,
 
-    .blend_write = NULL,
-    .blend_read_data = NULL,
-    .blend_read_lib = NULL,
-    .blend_read_expand = NULL,
+    .blend_write = greasepencil_blend_write,
+    .blend_read_data = greasepencil_blend_read_data,
+    .blend_read_lib = greasepencil_blend_read_lib,
+    .blend_read_expand = greasepencil_blend_read_expand,
 };
 
 /* ************************************************** */
diff --git a/source/blender/blenloader/intern/readfile.c b/source/blender/blenloader/intern/readfile.c
index 8413fd94d2c..e6375ee6477 100644
--- a/source/blender/blenloader/intern/readfile.c
+++ b/source/blender/blenloader/intern/readfile.c
@@ -127,6 +127,7 @@
 #include "BKE_fcurve_driver.h"
 #include "BKE_fluid.h"
 #include "BKE_global.h"  // for G
+#include "BKE_gpencil.h"
 #include "BKE_gpencil_modifier.h"
 #include "BKE_hair.h"
 #include "BKE_icons.h"
@@ -4921,100 +4922,6 @@ static void direct_link_scene(BlendDataReader *reader, Scene *sce)
 /** \} */
 
 /* -------------------------------------------------------------------- */
-/** \name Read ID: Grease Pencil
- * \{ */
-
-/* relink's grease pencil data's refs */
-static void lib_link_gpencil(BlendLibReader *reader, bGPdata *gpd)
-{
-  /* Relink all data-lock linked by GP data-lock */
-  /* Layers */
-  LISTBASE_FOREACH (bGPDlayer *, gpl, &gpd->layers) {
-    /* Layer -> Parent References */
-    BLO_read_id_address(reader, gpd->id.lib, &gpl->parent);
-  }
-
-  /* materials */
-  for (int a = 0; a < gpd->totcol; a++) {
-    BLO_read_id_address(reader, gpd->id.lib, &gpd->mat[a]);
-  }
-}
-
-/* relinks grease-pencil data - used for direct_link and old file linkage */
-static void direct_link_gpencil(BlendDataReader *reader, bGPdata *gpd)
-{
-  /* we must firstly have some grease-pencil data to link! */
-  if (gpd == NULL) {
-    return;
-  }
-
-  /* relink animdata */
-  BLO_read_data_address(reader, &gpd->adt);
-  BKE_animdata_blend_read_data(reader, gpd->adt);
-
-  /* Ensure full objectmode for linked grease pencil. */
-  if (gpd->id.lib != NULL) {
-    gpd->flag &= ~GP_DATA_STROKE_PAINTMODE;
-    gpd->flag &= ~GP_DATA_STROKE_EDITMODE;
-    gpd->flag &= ~GP_DATA_STROKE_SCULPTMODE;
-    gpd->flag &= ~GP_DATA_STROKE_WEIGHTMODE;
-    gpd->flag &= ~GP_DATA_STROKE_VERTEXMODE;
-  }
-
-  /* init stroke buffer */
-  gpd->runtime.sbuffer = NULL;
-  gpd->runtime.sbuffer_used = 0;
-  gpd->runtime.sbuffer_size = 0;
-  gpd->runtime.tot_cp_points = 0;
-
-  /* relink palettes (old palettes deprecated, only to convert old files) */
-  BLO_read_list(reader, &gpd->palettes);
-  if (gpd->palettes.first != NULL) {
-    LISTBASE_FOREACH (Palette *, palette, &gpd->palettes) {
-      BLO_read_list(reader, &palette->colors);
-    }
-  }
-
-  /* materials */
-  BLO_read_pointer_array(reader, (void **)&gpd->mat);
-
-  /* relink layers */
-  BLO_read_list(reader, &gpd->layers);
-
-  LISTBASE_FOREACH (bGPDlayer *, gpl, &gpd->layers) {
-    /* relink frames */
-    BLO_read_list(reader, &gpl->frames);
-
-    BLO_read_data_address(reader, &gpl->actframe);
-
-    gpl->runtime.icon_id = 0;
-
-    /* Relink masks. */
-    BLO_read_list(reader, &gpl->mask_layers);
-
-    LISTBASE_FOREACH (bGPDframe *, gpf, &gpl->frames) {
-      /* relink strokes (and their points) */
-      BLO_read_list(reader, &gpf->strokes);
-
-      LISTBASE_FOREACH (bGPDstroke *, gps, &gpf->strokes) {
-        /* relink stroke points array */
-        BLO_read_data_address(reader, &gps->points);
-        /* Relink geometry*/
-        BLO_read_data_address(reader, &gps->triangles);
-
-        /* relink weight data */
-        if (gps->dvert) {
-          BLO_read_data_address(reader, &gps->dvert);
-          BKE_defvert_blend_read(reader, gps->totpoints, gps->dvert);
-        }
-      }
-    }
-  }
-}
-
-/** \} */
-
-/* -------------------------------------------------------------------- */
 /** \name Read Screen Area/Region (Screen Data)
  * \{ */
 
@@ -5156,7 +5063,7 @@ static void direct_link_area(BlendDataReader *reader, ScrArea *area)
 
       if (v3d->gpd) {
         BLO_read_data_address(reader, &v3d->gpd);
-        direct_link_gpencil(reader, v3d->gpd);
+        BKE_gpencil_blend_read_data(reader, v3d->gpd);
       }
       BLO_read_data_address(reader, &v3d->localvd);
 
@@ -5228,7 +5135,7 @@ static void direct_link_area(BlendDataReader *reader, ScrArea *area)
 #if 0
       sima->gpd = newdataadr(fd, sima->gpd);
       if (sima->gpd) {
-        direct_link_gpencil(fd, sima->gpd);
+        BKE_gpencil_blend_read_data(fd, sima->gpd);
       }
 #endif
     }
@@ -5237,7 +5144,7 @@ static void direct_link_area(BlendDataReader *reader, ScrArea *area)
 
       if (snode->gpd) {
         BLO_read_data_address(reader, &snode->gpd);
-        direct_link_gpencil(reader, snode->gpd);
+        BKE_gpencil_blend_read_data(reader, snode->gpd);
       }
 
       BLO_read_list(reader, &snode->treepath);
@@ -5262,7 +5169,7 @@ static void direct_link_area(BlendDataReader *reader, ScrArea *area)
 #if 0
       if (sseq->gpd) {
         sseq->gpd = newdataadr(fd, sseq->gpd);
-        direct_link_gpencil(fd, sseq->gpd);
+        BKE_gpencil_blend_read_data(fd, sseq->gpd);
       }
 #endif
       sseq->scopes.reference_ibuf = NULL;
@@ -6619,9 +6526,6 @@ static bool direct_link_id(FileData *fd, Main *main, const int tag, ID *id, ID *
     case ID_PA:
       direct_link_particlesettings(&reader, (ParticleSettings *)id);
       break;
-    case ID_GD:
-      direct_link_gpencil(&reader, (bGPdata *)id);
-      break;
     case ID_CF:
       direct_link_cachefile(&reader, (CacheFile *)id);
       break;
@@ -6664,6 +6568,7 @@ static bool direct_link_id(FileData *fd, Main *main, const int tag, ID *id, ID *
     case ID_LP:
     case ID_KE:
     case ID_TE:
+    case ID_GD:
       /* Do nothing. Handled by IDTypeInfo callback. */
       break;
   }
@@ -7308,9 +7213,6 @@ static void lib_link_all(FileData *fd, Main *bmain)
       case ID_VO:
         lib_link_volume(&reader, (Volume *)id);
         break;
-      case ID_GD:
-        lib_link_gpencil(&reader, (bGPdata *)id);
-        break;
       case ID_SIM:
         lib_link_simulation(&reader, (Simulation *)id);
         break;
@@ -7345,6 +7247,7 @@ static void lib_link_all(FileData *fd, Main *bmain)
       case ID_LP:
       case ID_KE:
       case ID_TE:
+      case ID_GD:
         /* Do nothing. Handled by IDTypeInfo callback. */
         break;
     }
@@ -8281,17 +8184,6 @@ static void expand_sound(BlendExpander *expander, bSound *snd)
   BLO_expand(expander, snd->ipo);  // XXX deprecated - old animation system
 }
 
-static void expand_gpencil(BlendExpander *expander, bGPdata *gpd)
-{
-  LISTBASE_FOREACH (bGPDlayer *, gpl, &gpd->layers) {
-    BLO_expand(expander, gpl->parent);
-  }
-
-  for (int a = 0; a < gpd->totcol; a++) {
-    BLO_expand(expander, gpd->mat[a]);
-  }
-}
-
 static void expand_workspace(BlendExpander *expander, WorkSpace *workspace)
 {
   LISTBASE_FOREACH (WorkSpaceLayout *, layout, &workspace->layouts) {
@@ -8388,9 +8280,6 @@ void BLO_expand_main(void *fdhandle, Main *mainvar)
             case ID_PA:
               expand_particlesettings(&expander, (ParticleSettings *)id);
               break;
-            case ID_GD:
-              expand_gpencil(&expander, (bGPdata *)id);
-              break;
             case ID_CF:
               expand_cachefile(&expander, (CacheFile *)id);
               break;
diff --git a/source/blender/blenloader/intern/writefile.c b/source/blender/blenloader/intern/writefile.c
index 998bd0691ff..b9320bb40e3 100644
--- a/source/blender/blenloader/intern/writefile.c
+++ b/source/blender/blenloader/intern/writefile.c
@@ -1765,47 +1765,6 @@ static void write_scene(BlendWriter *writer, Scene *sce, const void *id_address)
   BLI_assert(sce->layer_properties == NULL);
 }
 
-static void write_gpencil(BlendWriter *writer, bGPdata *gpd, const void *id_address)
-{
-  if (gpd->id.us > 0 || BLO_write_is_undo(writer)) {
-    /* Clean up, important in undo case to reduce false detection of changed data-blocks. */
-    /* XXX not sure why the whole run-time data is not cleared in reading code,
-     * for now mimicking it here. */
-    gpd->runtime.sbuffer = NULL;
-    gpd->runtime.sbuffer_used = 0;
-    gpd->runtime.sbuffer_size = 0;
-    gpd->runtime.tot_cp_points = 0;
-
-    /* write gpd data block to file */
-    BLO_write_id_struct(writer, bGPdata, id_address, &gpd->id);
-    BKE_id_blend_write(writer, &gpd->id);
-
-    if (gpd->adt) {
-      BKE_animdata_blend_write(writer, gpd->adt);
-    }
-
-    BLO_write_pointer_array(writer, gpd->totcol, gpd->mat);
-
-    /* write grease-pencil layers to file */
-    BLO_write_struct_list(writer, bGPDlayer, &gpd->layers);
-    LISTBASE_FOREACH (bGPDlayer *, gpl, &gpd->layers) {
-      /* Write mask list. */
-      BLO_write_struct_list(writer, bGPDlayer_Mask, &gpl->mask_layers);
-      /* write this layer's frames to file */
-      BLO_write_struct_list(writer, bGPDframe, &gpl->frames);
-      LISTBASE_FOREACH (bGPDframe *, gpf, &gpl->frames) {
-        /* write strokes */
-        BLO_write_struct_list(writer, bGPDstroke, &gpf->strokes);
-        LISTBASE_FOREACH (bGPDstroke *, gps, &gpf->strokes) {
-          BLO_write_struct_array(writer, bGPDspoint, gps->totpoints, gps->points);
-          BLO_write_struct_array(writer, bGPDtriangle, gps->tot_triangles, gps->triangles);
-          BKE_defvert_blend_write(writer, gps->totpoints, gps->dvert);
-        }
-      }
-    }
-  }
-}
-
 static void write_wm_xr_data(BlendWriter *writer, wmXrData *xr_data)
 {
   write_view3dshading(writer, &xr_data->session_settings.shading);
@@ -2557,9 +2516,6 @@ static bool write_file_handle(Main *mainvar,
           case ID_PA:
             write_particlesettings(&writer, (ParticleSettings *)id_buffer, id);
             break;
-          case ID_GD:
-            write_gpencil(&writer, (bGPdata *)id_buffer, id);
-            break;
           case ID_CF:
             write_cachefile(&writer, (CacheFile *)id_buffer, id);
             break;
@@ -2599,6 +2555,7 @@ static bool write_file_handle(Main *mainvar,
           case ID_LP:
           case ID_KE:
           case ID_TE:
+          case ID_GD:
             /* Do nothing, handled in IDTypeInfo callback. */
             break;
           case ID_LI: