From 86235dfc91e5a7c873e67d23053a8c7d041b9860 Mon Sep 17 00:00:00 2001
From: twanvl <twanvl@0fc631ac-6414-0410-93d0-97cfa31319b6>
Date: Sat, 7 Jul 2007 00:55:27 +0000
Subject: [PATCH] Fixed undo issue for combined editor; Added keyword usage
 statistics

git-svn-id: svn://svn.code.sf.net/p/magicseteditor/code/trunk@516 0fc631ac-6414-0410-93d0-97cfa31319b6
---
 src/data/card.hpp                |  4 ++++
 src/data/field.cpp               |  2 ++
 src/data/field.hpp               |  3 +++
 src/data/field/text.cpp          |  3 ++-
 src/data/field/text.hpp          |  2 +-
 src/data/keyword.cpp             | 20 ++++++++++++++++++++
 src/data/keyword.hpp             |  6 ++++++
 src/gui/control/keyword_list.cpp | 22 ++++++++++++++++++++--
 src/gui/control/keyword_list.hpp |  5 +++++
 src/script/functions/basic.cpp   |  2 ++
 src/util/age.hpp                 |  2 +-
 11 files changed, 66 insertions(+), 5 deletions(-)

diff --git a/src/data/card.hpp b/src/data/card.hpp
index 047b44f5..bce1b091 100644
--- a/src/data/card.hpp
+++ b/src/data/card.hpp
@@ -16,6 +16,7 @@
 
 class Game;
 class Dependency;
+class Keyword;
 DECLARE_POINTER_TYPE(Card);
 DECLARE_POINTER_TYPE(Field);
 DECLARE_POINTER_TYPE(Value);
@@ -50,6 +51,9 @@ class Card : public IntrusivePtrVirtualBase {
 	/// Styling information for a particular stylesheet
 	IndexMap<FieldP, ValueP>& extraDataFor(const StyleSheet& stylesheet) ;
 	
+	/// Keyword usage statistics
+	vector<pair<Value*,const Keyword*> > keyword_usage;
+	
 	/// Get the identification of this card, an identification is something like a name, title, etc.
 	/** May return "" */
 	String identification() const;
diff --git a/src/data/field.cpp b/src/data/field.cpp
index dd781981..c3ce31dd 100644
--- a/src/data/field.cpp
+++ b/src/data/field.cpp
@@ -199,6 +199,8 @@ StyleListener::~StyleListener() {
 
 // ----------------------------------------------------------------------------- : Value
 
+IMPLEMENT_DYNAMIC_ARG(Value*, value_being_updated, nullptr);
+
 Value::~Value() {}
 
 IMPLEMENT_REFLECTION_NAMELESS(Value) {
diff --git a/src/data/field.hpp b/src/data/field.hpp
index 5f26f68b..def5abcd 100644
--- a/src/data/field.hpp
+++ b/src/data/field.hpp
@@ -29,6 +29,9 @@ class DataViewer; class DataEditor;
 DECLARE_POINTER_TYPE(ValueViewer);
 DECLARE_POINTER_TYPE(ValueEditor);
 
+// Value for which script updates are being run
+DECLARE_DYNAMIC_ARG(Value*, value_being_updated);
+
 // ----------------------------------------------------------------------------- : Field
 
 /// Information on how to store a value
diff --git a/src/data/field/text.cpp b/src/data/field/text.cpp
index 42fc7cbd..5d97f444 100644
--- a/src/data/field/text.cpp
+++ b/src/data/field/text.cpp
@@ -119,7 +119,8 @@ String TextValue::toString() const {
 }
 bool TextValue::update(Context& ctx) {
 	Value::update(ctx);
-	WITH_DYNAMIC_ARG(last_update_age, value.isDefault() ? 0 : last_update.get());
+	WITH_DYNAMIC_ARG(last_update_age,     last_update.get());
+	WITH_DYNAMIC_ARG(value_being_updated, this);
 	bool change = field().default_script.invokeOnDefault(ctx, value)
 	            | field().        script.invokeOn(ctx, value);
 	if (change) last_update.update();
diff --git a/src/data/field/text.hpp b/src/data/field/text.hpp
index c6e6e601..6d46b747 100644
--- a/src/data/field/text.hpp
+++ b/src/data/field/text.hpp
@@ -92,7 +92,7 @@ class TextStyle : public Style {
 /// The Value in a TextField
 class TextValue : public Value {
   public:
-	inline TextValue(const TextFieldP& field) : Value(field) {}
+	inline TextValue(const TextFieldP& field) : Value(field), last_update(1) {}
 	DECLARE_HAS_FIELD(Text)
 	
 	typedef Defaultable<String> ValueType;
diff --git a/src/data/keyword.cpp b/src/data/keyword.cpp
index c077dab7..ca25a9e2 100644
--- a/src/data/keyword.cpp
+++ b/src/data/keyword.cpp
@@ -17,6 +17,8 @@ DECLARE_TYPEOF_COLLECTION(KeywordModeP);
 DECLARE_TYPEOF_COLLECTION(KeywordParamP);
 DECLARE_TYPEOF_COLLECTION(const Keyword*);
 DECLARE_POINTER_TYPE(KeywordParamValue);
+class Value;
+DECLARE_DYNAMIC_ARG(Value*, value_being_updated);
 
 // ----------------------------------------------------------------------------- : Reflection
 
@@ -329,6 +331,8 @@ KeywordTrie* KeywordTrie::insertAnyStar() {
 
 // ----------------------------------------------------------------------------- : KeywordDatabase
 
+IMPLEMENT_DYNAMIC_ARG(KeywordUsageStatistics*, keyword_usage_statistics, nullptr);
+
 KeywordDatabase::KeywordDatabase()
 	: root(nullptr)
 {}
@@ -440,6 +444,17 @@ String KeywordDatabase::expand(const String& text,
                                Context& ctx) const {
 	assert(combine_script);
 	
+	// Clean up usage statistics
+	KeywordUsageStatistics* stat = keyword_usage_statistics();
+	Value* stat_key = value_being_updated();
+	if (stat && stat_key) {
+		for (size_t i = stat->size() - 1 ; i + 1 > 0 ; --i) { // loop backwards
+			if ((*stat)[i].first == stat_key) {
+				stat->erase(stat->begin() + i);
+			}
+		}
+	}
+	
 	// Remove all old reminder texts
 	String s = remove_tag_contents(text, _("<atom-reminder"));
 	s = remove_tag_contents(s, _("<atom-keyword")); // OLD, TODO: REMOVEME
@@ -614,6 +629,11 @@ String KeywordDatabase::expand(const String& text,
 								result += _("</kw-"); result += expand_type; result += _(">");
 							}
 							
+							// Add to usage statistics
+							if (stat && stat_key) {
+								stat->push_back(make_pair(stat_key, kw));
+							}
+							
 							// After keyword
 							s        = s.substr(end);
 							untagged = untagged.substr(start_u + len_u);
diff --git a/src/data/keyword.hpp b/src/data/keyword.hpp
index 9a5ee689..1efd3d0b 100644
--- a/src/data/keyword.hpp
+++ b/src/data/keyword.hpp
@@ -11,6 +11,7 @@
 
 #include <util/prec.hpp>
 #include <script/scriptable.hpp>
+#include <util/dynamic_arg.hpp>
 #include <wx/regex.h>
 
 DECLARE_POINTER_TYPE(KeywordParam);
@@ -18,6 +19,7 @@ DECLARE_POINTER_TYPE(KeywordMode);
 DECLARE_POINTER_TYPE(Keyword);
 DECLARE_POINTER_TYPE(ParamReferenceType);
 class KeywordTrie;
+class Value;
 
 // ----------------------------------------------------------------------------- : Keyword parameters
 
@@ -115,6 +117,10 @@ class Keyword : public IntrusivePtrVirtualBase {
 
 // ----------------------------------------------------------------------------- : Using keywords
 
+/// Store keyword usage statistics here, using value_being_updated as the key
+typedef vector<pair<Value*, const Keyword*> > KeywordUsageStatistics;
+DECLARE_DYNAMIC_ARG(KeywordUsageStatistics*, keyword_usage_statistics);
+
 /// A database of keywords to allow for fast matching
 /** NOTE: keywords may not be altered after they are added to the database,
  *  The database should be rebuild.
diff --git a/src/gui/control/keyword_list.cpp b/src/gui/control/keyword_list.cpp
index b59fbc5e..9d94bfbd 100644
--- a/src/gui/control/keyword_list.cpp
+++ b/src/gui/control/keyword_list.cpp
@@ -10,6 +10,7 @@
 #include <gui/icon_menu.hpp>
 #include <data/set.hpp>
 #include <data/game.hpp>
+#include <data/card.hpp>
 #include <data/keyword.hpp>
 #include <data/action/value.hpp>
 #include <data/action/keyword.hpp>
@@ -20,6 +21,7 @@
 #include <wx/clipbrd.h>
 
 DECLARE_TYPEOF_COLLECTION(KeywordP);
+DECLARE_TYPEOF_COLLECTION(CardP);
 
 // ----------------------------------------------------------------------------- : Events
 
@@ -49,6 +51,7 @@ void KeywordList::onBeforeChangeSet() {
 	storeColumns();
 }
 void KeywordList::onChangeSet() {
+	updateUsageStatistics();
 	refreshList();
 }
 
@@ -83,6 +86,15 @@ void KeywordList::onAction(const Action& action, bool undone) {
 	}
 }
 
+void KeywordList::updateUsageStatistics() {
+	usage_statistics.clear();
+	FOR_EACH_CONST(card, set->cards) {
+		for (KeywordUsageStatistics::const_iterator it = card->keyword_usage.begin() ; it != card->keyword_usage.end() ; ++it) {
+			usage_statistics[it->second]++;
+		}
+	}
+}
+
 // ----------------------------------------------------------------------------- : Clipboard
 
 bool KeywordList::canCopy()  const { return !!selected_item; }
@@ -154,13 +166,19 @@ bool KeywordList::compareItems(void* a, void* b) const {
 		case 0:	return ka.keyword < kb.keyword;
 		case 1: return ka.match   < kb.match;
 		case 2: return ka.mode    < kb.mode;
-		//case 3:
+		case 3: return usage(ka)  < usage(kb);
 		case 4: return ka.reminder.getUnparsed() < kb.reminder.getUnparsed();
 		default: // TODO: 3
 				return ka.keyword < kb.keyword;
 	}
 }
 
+int KeywordList::usage(const Keyword& kw) const {
+	map<const Keyword*,int>::const_iterator it = usage_statistics.find(&kw);
+	if (it == usage_statistics.end()) return 0;
+	else return it->second;
+}
+
 // ----------------------------------------------------------------------------- : KeywordList : Item text
 
 String KeywordList::OnGetItemText (long pos, long col) const {
@@ -169,7 +187,7 @@ String KeywordList::OnGetItemText (long pos, long col) const {
 		case 0:		return kw.keyword;
 		case 1:		return match_string(kw);
 		case 2:		return kw.mode;
-		case 3:		return _("?");
+		case 3:		return String::Format(_("%d"), usage(kw));
 		case 4: {
 			// convert all whitespace to ' '
 			String formatted;
diff --git a/src/gui/control/keyword_list.hpp b/src/gui/control/keyword_list.hpp
index fea6a0ad..6a73ae8c 100644
--- a/src/gui/control/keyword_list.hpp
+++ b/src/gui/control/keyword_list.hpp
@@ -44,6 +44,7 @@ class KeywordList : public ItemList, public SetView {
 	virtual void onBeforeChangeSet();
 	virtual void onChangeSet();
 	virtual void onAction(const Action&, bool);
+	void updateUsageStatistics();
 	
 	// --------------------------------------------------- : Selection
 	
@@ -86,6 +87,10 @@ class KeywordList : public ItemList, public SetView {
 	
 	mutable wxListItemAttr item_attr; // for OnGetItemAttr
 	
+	/// How often is a keyword used in the set?
+	int usage(const Keyword&) const;
+	map<const Keyword*,int> usage_statistics;
+	
 	// --------------------------------------------------- : Window events
 	DECLARE_EVENT_TABLE();
 	
diff --git a/src/script/functions/basic.cpp b/src/script/functions/basic.cpp
index 762a6e4e..7e21ae41 100644
--- a/src/script/functions/basic.cpp
+++ b/src/script/functions/basic.cpp
@@ -285,6 +285,8 @@ SCRIPT_RULE_2_N_DEP(expand_keywords, ScriptValueP, _("default expand"), default_
 		db.add(set->game->keywords);
 		db.add(set->keywords);
 	}
+	SCRIPT_OPTIONAL_PARAM_(CardP, card);
+	WITH_DYNAMIC_ARG(keyword_usage_statistics, card ? &card->keyword_usage : nullptr);
 	SCRIPT_RETURN(db.expand(input, default_expand, combine, ctx));
 }
 SCRIPT_RULE_2_DEPENDENCIES(expand_keywords) {
diff --git a/src/util/age.hpp b/src/util/age.hpp
index ead82226..0f064e04 100644
--- a/src/util/age.hpp
+++ b/src/util/age.hpp
@@ -19,7 +19,7 @@
 /** Age is counted using a global variable */
 class Age {
   public:
-	/// Construct a new age value, 
+	/// Construct a new age value
 	Age() {
 		update();
 	}