AGS.Native: fix deletion of fonts not clearing loaded font data

Author: ivan-mogilko

Common/font/fonts.cpp

@@ -54,7 +54,9 @@ struct Font
     Bitmap OutlineStencil, OutlineStencilSub;
 
     Font() = default;
+    Font(const Font &font) = default;
     Font(Font &&font) = default;
+    Font &operator =(const Font &font) = default;
     Font &operator =(Font &&font) = default;
 };
 
@@ -547,6 +549,7 @@ bool load_font_size(size_t font_number, const FontInfo &font_info)
         fonts.resize(font_number + 1);
     else
         freefont(font_number);
+
     FontRenderParams params;
     params.SizeMultiplier = font_info.SizeMultiplier;
     params.LoadMode = (font_info.Flags & FFLG_LOADMODEMASK);
@@ -651,21 +654,25 @@ void freefont(size_t font_number)
     if (font_number >= fonts.size())
         return;
 
-    fonts[font_number].TextStencilSub.Destroy();
-    fonts[font_number].OutlineStencilSub.Destroy();
-    fonts[font_number].TextStencil.Destroy();
-    fonts[font_number].OutlineStencil.Destroy();
-    if (fonts[font_number].Renderer != nullptr)
+    if (fonts[font_number].Renderer)
         fonts[font_number].Renderer->FreeMemory(font_number);
+    fonts[font_number] = Font();
+}
+
+void movefont(size_t old_number, size_t new_number)
+{
+    if (old_number == new_number)
+        return; // same number
 
-    fonts[font_number].Renderer = nullptr;
+    fonts[new_number] = std::move(fonts[old_number]);
+    fonts[old_number] = Font();
 }
 
 void free_all_fonts()
 {
     for (size_t i = 0; i < fonts.size(); ++i)
     {
-        if (fonts[i].Renderer != nullptr)
+        if (fonts[i].Renderer)
             fonts[i].Renderer->FreeMemory(i);
     }
     fonts.clear();

Common/font/fonts.h

@@ -110,6 +110,8 @@ void alloc_font_outline_buffers(size_t font_number,
 void adjust_fonts_for_render_mode(bool aa_mode);
 // Free particular font's data
 void freefont(size_t font_number);
+// Moves font data from one index to another; previous index becomes empty
+void movefont(size_t old_number, size_t new_number);
 // Free all fonts data
 void free_all_fonts();
 

Common/gfx/allegrobitmap.cpp

@@ -47,6 +47,11 @@ Bitmap::Bitmap(BITMAP *al_bmp, bool shared_data)
     WrapAllegroBitmap(al_bmp, shared_data);
 }
 
+Bitmap::Bitmap(const Bitmap &bmp)
+{
+    CreateCopy(&bmp);
+}
+
 Bitmap::Bitmap(Bitmap &&bmp)
 {
     _pixelData = std::move(bmp._pixelData);
@@ -61,6 +66,12 @@ Bitmap::~Bitmap()
     Destroy();
 }
 
+Bitmap &Bitmap::operator =(const Bitmap &bmp)
+{
+    CreateCopy(&bmp);
+    return *this;
+}
+
 //=============================================================================
 // Creation and destruction
 //=============================================================================
@@ -152,6 +163,13 @@ bool Bitmap::CreateCopy(const Bitmap *src, int color_depth)
     if (src == this || src->_alBitmap == _alBitmap)
         return false; // cannot create a copy of yourself
 
+    // Handle uninitialized bitmap case
+    if (!src->_alBitmap)
+    {
+        Destroy();
+        return true;
+    }
+
     if (Create(src->_alBitmap->w, src->_alBitmap->h, color_depth ? color_depth : bitmap_color_depth(src->_alBitmap)))
     {
         blit(src->_alBitmap, _alBitmap, 0, 0, 0, 0, _alBitmap->w, _alBitmap->h);

Common/gfx/allegrobitmap.h

@@ -39,11 +39,19 @@ class Bitmap
     Bitmap() = default;
     Bitmap(int width, int height, int color_depth = 0);
     Bitmap(PixelBuffer &&pxbuf);
+    // Constructs a sub-bitmap, referencing parent
     Bitmap(Bitmap *src, const Rect &rc);
+    // Wraps Allegro BITMAP object, optionally owning it
     Bitmap(BITMAP *al_bmp, bool shared_data);
+    // Copy-constructor: constructs a full Bitmap copy
+    Bitmap(const Bitmap &bmp);
+    // Move-constructor: moves pixel data from another bitmap
     Bitmap(Bitmap &&bmp);
     ~Bitmap();
 
+    Bitmap &operator =(const Bitmap &bmp);
+    Bitmap &operator =(Bitmap &&bmp) = default;
+
     // Allocate new bitmap.
     // NOTE: color_depth is in BITS per pixel (i.e. 8, 16, 24, 32...).
     // NOTE: in all of these color_depth may be passed as 0 in which case a default

Editor/AGS.Editor/Components/FontsComponent.cs

@@ -49,7 +49,7 @@ public override void CommandClick(string controlID)
                 newItem.TTFMetricsFixup = _agsEditor.CurrentGame.Settings.TTFMetricsFixup; // use defaults
                 items.Add(newItem);
                 Utilities.CopyFont(0, newItem.ID);
-                Factory.NativeProxy.GameSettingsChanged(_agsEditor.CurrentGame);
+                Factory.NativeProxy.OnFontAdded(_agsEditor.CurrentGame, newItem.ID);
                 _guiController.ProjectTree.StartFromNode(this, TOP_LEVEL_COMMAND_ID);
                 _guiController.ProjectTree.AddTreeLeaf(this, GetNodeID(newItem), newItem.ID.ToString() + ": " + newItem.Name, "FontIcon");
                 _guiController.ProjectTree.SelectNode(this, GetNodeID(newItem));
@@ -86,6 +86,7 @@ public override void CommandClick(string controlID)
                     }
                     _agsEditor.CurrentGame.Fonts.Remove(_itemRightClicked);
                     _agsEditor.CurrentGame.FilesAddedOrRemoved = true;
+                    Factory.NativeProxy.OnFontDeleted(_agsEditor.CurrentGame, removingID);
                     Factory.NativeProxy.GameSettingsChanged(_agsEditor.CurrentGame);
                     RePopulateTreeView();
                     FontTypeConverter.SetFontList(_agsEditor.CurrentGame.Fonts);

Editor/AGS.Editor/NativeProxy.cs

@@ -230,6 +230,16 @@ public int FindTTFSizeForHeight(string fileName, int size)
             return _native.FindTTFSizeForHeight(fileName, size);
         }
 
+        public void OnFontAdded(Game game, int fontSlot)
+        {
+            _native.OnGameFontAdded(game, fontSlot);
+        }
+
+        public void OnFontDeleted(Game game, int fontSlot)
+        {
+            _native.OnGameFontDeleted(game, fontSlot);
+        }
+
         public void OnFontUpdated(Game game, int fontSlot, bool forceUpdate)
         {
             _native.OnGameFontUpdated(game, fontSlot, forceUpdate);

Editor/AGS.Native/NativeMethods.cpp

@@ -91,6 +91,8 @@ extern HAGSError reset_sprite_file();
 extern void PaletteUpdated(cli::array<PaletteEntry^>^ newPalette);
 extern void GameDirChanged(String ^workingDir);
 extern void GameUpdated(Game ^game, bool forceUpdate);
+extern void GameFontAdded(Game ^game, int fontNumber);
+extern void GameFontDeleted(Game ^game, int fontNumber);
 extern void GameFontUpdated(Game ^game, int fontNumber, bool forceUpdate);
 extern void UpdateNativeSpritesToGame(Game ^game, CompileMessages ^errors);
 extern void draw_room_background(void *roomptr, HDC hdc, int x, int y, int bgnum, float scaleFactor, int maskType, int selectedArea, int maskTransparency);
@@ -372,9 +374,19 @@ namespace AGS
         return height;
     }
 
+    void NativeMethods::OnGameFontAdded(Game^ game, int fontSlot)
+    {
+        ::GameFontAdded(game, fontSlot);
+    }
+
+    void NativeMethods::OnGameFontDeleted(Game^ game, int fontSlot)
+    {
+        ::GameFontDeleted(game, fontSlot);
+    }
+
     void NativeMethods::OnGameFontUpdated(Game^ game, int fontSlot, bool forceUpdate)
     {
-        GameFontUpdated(game, fontSlot, forceUpdate);
+        ::GameFontUpdated(game, fontSlot, forceUpdate);
     }
 
         AGS::Types::SpriteInfo^ NativeMethods::GetSpriteInfo(int spriteSlot)

Editor/AGS.Native/NativeMethods.h

@@ -76,6 +76,8 @@ namespace AGS
             // Measures the TTF font from the given file, and tries to find a point size corresponding
             // to the closest pixel height match, returns the found point size, or 0 in case of error.
             int FindTTFSizeForHeight(String ^fileName, int size);
+            void OnGameFontAdded(Game^ game, int fontSlot);
+            void OnGameFontDeleted(Game^ game, int fontSlot);
             void OnGameFontUpdated(Game^ game, int fontSlot, bool forceUpdate);
 			Dictionary<int,Sprite^>^ LoadAllSpriteDimensions();
 			void LoadNewSpriteFile();

Editor/AGS.Native/agsnative.cpp

@@ -2057,8 +2057,33 @@ void GameUpdated(Game ^game, bool forceUpdate) {
   }
 }
 
+void GameFontAdded(Game ^game, int fontNumber)
+{
+    thisgame.numfonts = game->Fonts->Count;
+    thisgame.fonts.resize(thisgame.numfonts);
+    for (int i = fontNumber; i < thisgame.numfonts; i++) 
+    {
+        GameFontUpdated(game, i, true);
+    }
+}
+
+void GameFontDeleted(Game ^game, int fontNumber)
+{
+    thisgame.numfonts = game->Fonts->Count;
+    thisgame.fonts.resize(thisgame.numfonts);
+    freefont(fontNumber);
+    for (int i = fontNumber; i < thisgame.numfonts; i++) 
+    {
+        GameFontUpdated(game, i, true);
+    }
+}
+
 void GameFontUpdated(Game ^game, int fontNumber, bool forceUpdate)
 {
+    assert(fontNumber >= 0 && fontNumber < thisgame.numfonts);
+    if (fontNumber < 0 || fontNumber >= thisgame.numfonts)
+        return;
+
     FontInfo &font_info = thisgame.fonts[fontNumber];
     AGS::Types::Font ^font = game->Fonts[fontNumber];