From 6435055d5311c8a74f542bb8480ed65a357fba11 Mon Sep 17 00:00:00 2001
From: Brendan Hagan <bhaganksu@gmail.com>
Date: Sat, 13 Aug 2022 22:43:42 -0400
Subject: [PATCH] feat: add card regions to declare image slice regions for
 DFCs

---
 data/ch-s.mse-locale/locale  |  2 ++
 data/ch-t.mse-locale/locale  |  2 ++
 data/da.mse-locale/locale    |  2 ++
 data/de.mse-locale/locale    |  2 ++
 data/en.mse-locale/locale    |  2 ++
 data/es.mse-locale/locale    |  2 ++
 data/fr.mse-locale/locale    |  2 ++
 data/it.mse-locale/locale    |  2 ++
 data/jp.mse-locale/locale    |  2 ++
 data/pl.mse-locale/locale    |  2 ++
 data/pt-br.mse-locale/locale |  2 ++
 src/data/card_region.cpp     | 25 +++++++++++++++++++++++++
 src/data/card_region.hpp     | 34 ++++++++++++++++++++++++++++++++++
 src/data/stylesheet.cpp      |  3 ++-
 src/data/stylesheet.hpp      | 12 +++++++++---
 15 files changed, 92 insertions(+), 4 deletions(-)
 create mode 100644 src/data/card_region.cpp
 create mode 100644 src/data/card_region.hpp

diff --git a/data/ch-s.mse-locale/locale b/data/ch-s.mse-locale/locale
index 33ce1d75..d63880e6 100644
--- a/data/ch-s.mse-locale/locale
+++ b/data/ch-s.mse-locale/locale
@@ -891,6 +891,8 @@ type:
 	keyword:		关键词
 	keywords:		关键词
 #_ADD	pack:			pack type
+#_ADD	card region:	card region
+#_ADD	card regions:	card regions
 	
 	# Symbol editor shapes
 	shape:			图形
diff --git a/data/ch-t.mse-locale/locale b/data/ch-t.mse-locale/locale
index 560caabf..70661099 100644
--- a/data/ch-t.mse-locale/locale
+++ b/data/ch-t.mse-locale/locale
@@ -891,6 +891,8 @@ type:
 	keyword:		關鍵詞
 	keywords:		關鍵詞
 #_ADD	pack:			pack type
+#_ADD	card region:	card region
+#_ADD	card regions:	card regions
 	
 	# Symbol editor shapes
 	shape:			圖形
diff --git a/data/da.mse-locale/locale b/data/da.mse-locale/locale
index 35749108..346ef803 100644
--- a/data/da.mse-locale/locale
+++ b/data/da.mse-locale/locale
@@ -891,6 +891,8 @@ type:
 	keyword:		keyword
 	keywords:		keywords
 	pack:			pack type
+	card region:	card region
+	card regions:	card regions
 	
 	# Symbol editor shapes
 	shape:			shape
diff --git a/data/de.mse-locale/locale b/data/de.mse-locale/locale
index e8b56090..22d94c37 100644
--- a/data/de.mse-locale/locale
+++ b/data/de.mse-locale/locale
@@ -891,6 +891,8 @@ type:
 	keyword:		keyword
 	keywords:		keywords
 	pack:			pack type
+	card region:	card region
+	card regions:	card regions
 	
 	# Symbol editor shapes
 	shape:			shape
diff --git a/data/en.mse-locale/locale b/data/en.mse-locale/locale
index ee0f4d0c..0632de4b 100644
--- a/data/en.mse-locale/locale
+++ b/data/en.mse-locale/locale
@@ -891,6 +891,8 @@ type:
 	keyword:		keyword
 	keywords:		keywords
 	pack:			pack type
+	card region:	card region
+	card regions:	card regions
 	
 	# Symbol editor shapes
 	shape:			shape
diff --git a/data/es.mse-locale/locale b/data/es.mse-locale/locale
index 48842f46..f72235b5 100644
--- a/data/es.mse-locale/locale
+++ b/data/es.mse-locale/locale
@@ -891,6 +891,8 @@ type:
 	keyword:		palabra clave
 	keywords:		palabras clave
 	pack:			mazo
+#_ADD	card region:	card region
+#_ADD	card regions:	card regions
 	
 	# Symbol editor shapes
 	shape:			forma
diff --git a/data/fr.mse-locale/locale b/data/fr.mse-locale/locale
index 79b7ee5e..de6a9294 100644
--- a/data/fr.mse-locale/locale
+++ b/data/fr.mse-locale/locale
@@ -898,6 +898,8 @@ type:
 	circle:			cercle
 	ellipse:		ellipse
 	pack:			type de pack
+#_ADD	card region:	card region
+#_ADD	card regions:	card regions
 	square:			carré
 	rectangle:		rectangle
 	triangle:		triangle
diff --git a/data/it.mse-locale/locale b/data/it.mse-locale/locale
index 58bb8bc2..c1091adb 100644
--- a/data/it.mse-locale/locale
+++ b/data/it.mse-locale/locale
@@ -891,6 +891,8 @@ type:
 	keyword:		parola-chiave
 	keywords:		parole chiave
 	pack:			tipo busta
+#_ADD	card region:	card region
+#_ADD	card regions:	card regions
 
 	# Symbol editor shapes
 	shape:			forma
diff --git a/data/jp.mse-locale/locale b/data/jp.mse-locale/locale
index 6b324ff7..da040238 100644
--- a/data/jp.mse-locale/locale
+++ b/data/jp.mse-locale/locale
@@ -889,6 +889,8 @@ type:
 	keyword:		キーワード
 	keywords:		キーワード
 #_ADD	pack:			pack type
+#_ADD	card region:	card region
+#_ADD	card regions:	card regions
 	
 	# Symbol editor shapes
 	shape:			形
diff --git a/data/pl.mse-locale/locale b/data/pl.mse-locale/locale
index f630e3d5..a24553ef 100644
--- a/data/pl.mse-locale/locale
+++ b/data/pl.mse-locale/locale
@@ -924,6 +924,8 @@ type:
 	keyword:		słowo kluczowe (keyword)
 	keywords:		słowa kluczowe (keywords)
 	pack:			rodzaj paczki (pack type)
+#_ADD	card region:	card region
+#_ADD	card regions:	card regions
 	
 	# Symbol editor shapes
 	shape:			kształt
diff --git a/data/pt-br.mse-locale/locale b/data/pt-br.mse-locale/locale
index 5ed044c8..5d863245 100644
--- a/data/pt-br.mse-locale/locale
+++ b/data/pt-br.mse-locale/locale
@@ -891,6 +891,8 @@ type:
 	keyword:		palavra-chave
 	keywords:		palavras-chaves
 	pack:			tipo de pacote
+#_ADD	card region:	card region
+#_ADD	card regions:	card regions
 	
 	# Symbol editor shapes
 	shape:			forma
diff --git a/src/data/card_region.cpp b/src/data/card_region.cpp
new file mode 100644
index 00000000..4a197550
--- /dev/null
+++ b/src/data/card_region.cpp
@@ -0,0 +1,25 @@
+//+----------------------------------------------------------------------------+
+//| Description:  Magic Set Editor - Program to make Magic (tm) cards          |
+//| Copyright:    (C) Twan van Laarhoven and the other MSE developers          |
+//| License:      GNU General Public License 2 or later (see file COPYING)     |
+//+----------------------------------------------------------------------------+
+
+#include <util/prec.hpp>
+#include <data/card_region.hpp>
+
+CardRegion::CardRegion()
+  : name("")
+  , x(0.0)
+  , y(0.0)
+  , width(0)
+  , height(0)
+{}
+CardRegion::~CardRegion() {}
+
+IMPLEMENT_REFLECTION(CardRegion) {
+  REFLECT(name);
+  REFLECT(x);
+  REFLECT(y);
+  REFLECT(width);
+  REFLECT(height);
+}
diff --git a/src/data/card_region.hpp b/src/data/card_region.hpp
new file mode 100644
index 00000000..4e5fac33
--- /dev/null
+++ b/src/data/card_region.hpp
@@ -0,0 +1,34 @@
+//+----------------------------------------------------------------------------+
+//| Description:  Magic Set Editor - Program to make Magic (tm) cards          |
+//| Copyright:    (C) Twan van Laarhoven and the other MSE developers          |
+//| License:      GNU General Public License 2 or later (see file COPYING)     |
+//+----------------------------------------------------------------------------+
+
+#pragma once
+
+#include <util/prec.hpp>
+#include <util/reflect.hpp>
+#include <script/scriptable.hpp>
+
+DECLARE_POINTER_TYPE(CardRegion);
+
+class CardRegion : public IntrusivePtrBase<CardRegion> {
+public:
+	CardRegion();
+	virtual ~CardRegion();
+
+	String name;
+	double x, y;
+	int width, height;
+
+private:
+	DECLARE_REFLECTION();
+};
+
+inline String type_name(const CardRegion&) {
+	return _TYPE_("card region");
+}
+
+inline String type_name(const vector<CardRegionP>&) {
+	return _TYPE_("card regions");
+}
diff --git a/src/data/stylesheet.cpp b/src/data/stylesheet.cpp
index 5da65996..2514e172 100644
--- a/src/data/stylesheet.cpp
+++ b/src/data/stylesheet.cpp
@@ -97,7 +97,8 @@ IMPLEMENT_REFLECTION(StyleSheet) {
   REFLECT(card_width);
   REFLECT(card_height);
   REFLECT(card_dpi);
-  REFLECT(card_background);
+  REFLECT(card_background);
+  REFLECT(card_regions);
   REFLECT(init_script);
   // styling
   REFLECT(styling_fields);
diff --git a/src/data/stylesheet.hpp b/src/data/stylesheet.hpp
index c68e5a3f..baca176c 100644
--- a/src/data/stylesheet.hpp
+++ b/src/data/stylesheet.hpp
@@ -11,12 +11,17 @@
 #include <util/prec.hpp>
 #include <util/io/package.hpp>
 #include <util/real_point.hpp>
-#include <script/scriptable.hpp>
+#include <script/scriptable.hpp>
+// This isn't strictly needed for this file, 
+// but CardRegion needs to be referenced from _somewhere_ in the codebase for compilation reasons.
+// Eventually if somewhere else is using the type then this can be removed.
+#include <data/card_region.hpp>
 
 DECLARE_POINTER_TYPE(Game);
 DECLARE_POINTER_TYPE(StyleSheet);
 DECLARE_POINTER_TYPE(Field);
-DECLARE_POINTER_TYPE(Style);
+DECLARE_POINTER_TYPE(Style);
+DECLARE_POINTER_TYPE(CardRegion);
 
 // ----------------------------------------------------------------------------- : StyleSheet
 
@@ -33,7 +38,8 @@ public:
   double card_width;        ///< The width of a card in pixels
   double card_height;        ///< The height of a card in pixels
   double card_dpi;        ///< The resolution of a card in dots per inch
-  Color  card_background;      ///< The background color of cards
+  Color  card_background;      ///< The background color of cards
+  vector<CardRegionP> card_regions;
   /// The styling for card fields
   /** The indices should correspond to the card_fields in the Game */
   IndexMap<FieldP, StyleP> card_style;