brush_test.cc

Go to the documentation of this file.

/* SPDX-FileCopyrightText: 2025 Blender Authors
 *
 * SPDX-License-Identifier: GPL-2.0-or-later */
#include "testing/testing.h"
 
#include "BKE_brush.hh"
#include "BKE_idtype.hh"
#include "BKE_lib_id.hh"
#include "BKE_main.hh"
 
#include "BLI_listbase.h"
 
#include "DNA_brush_types.h"
#include "DNA_material_types.h"
#include "DNA_node_types.h"
 
class BrushTest : public testing::Test {
 public:
  Main *bmain = nullptr;
 
  static void SetUpTestSuite()
  {
    BKE_idtype_init();
  }
 
  void SetUp() override
  {
    bmain = BKE_main_new();
  }
 
  void TearDown() override
  {
    BKE_main_free(bmain);
  }
};
 
static void check_id_and_name(const ID *a, const ID *b)
{
  EXPECT_NE(a, b) << "ID " << a->name << " and " << b->name << "should be different pointers";
  EXPECT_EQ(a->us, 1) << "ID " << a->name << " should have 1 user";
  EXPECT_EQ(b->us, 1) << "ID " << b->name << " should have 1 user";
  EXPECT_STRNE(a->name, b->name);
}
 
static void check_embedded_copy(const ID *a, const ID *b)
{
  EXPECT_NE(a, b) << "ID " << a->name << " and " << b->name << "should be different pointers";
  EXPECT_EQ(a->us, 0) << "ID " << a->name << " should have 0 users";
  EXPECT_EQ(b->us, 0) << "ID " << b->name << " should have 0 users";
  EXPECT_TRUE(a->flag & ID_FLAG_EMBEDDED_DATA);
  EXPECT_TRUE(b->flag & ID_FLAG_EMBEDDED_DATA);
}
 
TEST_F(BrushTest, deep_copy)
{
  Brush *brush = BKE_brush_add(bmain, "UnitTestBrush", OB_MODE_SCULPT);
  /* TODO: Ideally this shouldn't be needed, but BKE_brush_add generates an extra user. Remove this
   * once that has been fixed. */
  id_us_min(&brush->id);
 
  /* Normal Linked Data */
  brush->paint_curve = static_cast<PaintCurve *>(BKE_id_new(bmain, ID_PC, "UnitTestPaintCurve"));
  brush->mtex.tex = static_cast<Tex *>(BKE_id_new(bmain, ID_TE, "UnitTestTexture"));
  brush->mtex.tex->ima = static_cast<Image *>(BKE_id_new(bmain, ID_IM, "UnitTestImage"));
 
  /* Embedded Data */
  brush->mtex.tex->nodetree = BKE_id_new_nomain<bNodeTree>("UnitTestNodeTree");
  brush->mtex.tex->nodetree->id.flag |= ID_FLAG_EMBEDDED_DATA;
 
  Brush *duplicated_brush = BKE_brush_duplicate(
      bmain, brush, USER_DUP_OBDATA | USER_DUP_LINKED_ID, LIB_ID_DUPLICATE_IS_ROOT_ID);
 
  check_id_and_name(&brush->id, &duplicated_brush->id);
  check_id_and_name(&brush->paint_curve->id, &duplicated_brush->paint_curve->id);
  check_id_and_name(&brush->mtex.tex->id, &duplicated_brush->mtex.tex->id);
  check_id_and_name(&brush->mtex.tex->ima->id, &duplicated_brush->mtex.tex->ima->id);
 
  check_embedded_copy(&brush->mtex.tex->nodetree->id, &duplicated_brush->mtex.tex->nodetree->id);
 
  EXPECT_TRUE(BLI_listbase_is_empty(&bmain->nodetrees));
}
 
TEST_F(BrushTest, deep_copy_grease_pencil_brush)
{
  /* Grease pencil brushes potentially have more ID linked to them, hence a separate test */
 
  Brush *brush = BKE_brush_add(bmain, "UnitTestBrush", OB_MODE_PAINT_GREASE_PENCIL);
  /* TODO: Ideally this shouldn't be needed, but #BKE_brush_add generates an extra user.
   * Remove this once that has been fixed. */
  id_us_min(&brush->id);
 
  /* Normal Linked Data */
  brush->paint_curve = static_cast<PaintCurve *>(BKE_id_new(bmain, ID_PC, "UnitTestPaintCurve"));
  brush->gpencil_settings->material = static_cast<Material *>(
      BKE_id_new(bmain, ID_MA, "UnitTestMaterial"));
  brush->gpencil_settings->material_alt = static_cast<Material *>(
      BKE_id_new(bmain, ID_MA, "UnitTestMaterialAlt"));
 
  /* Embedded Data */
  brush->gpencil_settings->material->nodetree = BKE_id_new_nomain<bNodeTree>("UnitTestNodeTree");
  brush->gpencil_settings->material->nodetree->id.flag |= ID_FLAG_EMBEDDED_DATA;
  brush->gpencil_settings->material_alt->nodetree = BKE_id_new_nomain<bNodeTree>(
      "UnitTestNodeTree2");
  brush->gpencil_settings->material_alt->nodetree->id.flag |= ID_FLAG_EMBEDDED_DATA;
 
  Brush *duplicated_brush = BKE_brush_duplicate(
      bmain, brush, USER_DUP_OBDATA | USER_DUP_LINKED_ID, LIB_ID_DUPLICATE_IS_ROOT_ID);
 
  check_id_and_name(&brush->id, &duplicated_brush->id);
  check_id_and_name(&brush->paint_curve->id, &duplicated_brush->paint_curve->id);
  check_id_and_name(&brush->gpencil_settings->material->id,
                    &duplicated_brush->gpencil_settings->material->id);
  check_id_and_name(&brush->gpencil_settings->material_alt->id,
                    &duplicated_brush->gpencil_settings->material_alt->id);
 
  check_embedded_copy(&brush->gpencil_settings->material->nodetree->id,
                      &duplicated_brush->gpencil_settings->material->nodetree->id);
  check_embedded_copy(&brush->gpencil_settings->material_alt->nodetree->id,
                      &duplicated_brush->gpencil_settings->material_alt->nodetree->id);
 
  EXPECT_TRUE(BLI_listbase_is_empty(&bmain->nodetrees));
}