Added word lists for choosing things like card type;

Added 'in_place' pattern to spec_sort

git-svn-id: svn://svn.code.sf.net/p/magicseteditor/code/trunk@616 0fc631ac-6414-0410-93d0-97cfa31319b6

src/gui/value/choice.cpp

@@ -231,14 +231,13 @@ void DropDownChoiceList::onShow() {
 	generateThumbnailImages();
 }
 
-bool DropDownChoiceList::select(size_t item) {
+void DropDownChoiceList::select(size_t item) {
 	if (isFieldDefault(item)) {
 		dynamic_cast<ChoiceValueEditor&>(cve).change( Defaultable<String>() );
 	} else {
 		ChoiceField::ChoiceP choice = getChoice(item);
 		dynamic_cast<ChoiceValueEditor&>(cve).change( field().choices->choiceName(choice->first_id) );
 	}
-	return true;
 }
 
 size_t DropDownChoiceList::selection() const {

src/gui/value/choice.hpp

@@ -96,7 +96,7 @@ class DropDownChoiceList : public DropDownChoiceListBase {
 	
   protected:
 	virtual void   onShow();
-	virtual bool   select(size_t item);
+	virtual void   select(size_t item);
 	virtual size_t selection() const;
 	virtual DropDownList* createSubMenu(ChoiceField::ChoiceP group) const;
 };

src/gui/value/color.cpp

@@ -27,7 +27,7 @@ class DropDownColorList : public DropDownList {
 	virtual String itemText(size_t item) const;
 	virtual void   drawIcon(DC& dc, int x, int y, size_t item, bool selected) const;
 	
-	virtual bool   select(size_t item);
+	virtual void   select(size_t item);
 	virtual size_t selection() const;
 	
   private:
@@ -112,7 +112,7 @@ size_t DropDownColorList::selection() const {
 	}
 	return selection;
 }
-bool DropDownColorList::select(size_t item) {
+void DropDownColorList::select(size_t item) {
 	if (isDefault(item)) {
 		cve.change( Defaultable<Color>());
 	} else if (isCustom(item)) {
@@ -120,7 +120,6 @@ bool DropDownColorList::select(size_t item) {
 	} else {
 		cve.change(field().choices[item - hasDefault()]->color);
 	}
-	return true;
 }
 
 // ----------------------------------------------------------------------------- : ColorValueEditor

src/gui/value/editor.hpp

@@ -113,7 +113,7 @@ class ValueEditor {
 	// --------------------------------------------------- : Other
 	
 	/// The cursor type to use when the mouse is over this control
-	virtual wxCursor cursor() const { return wxCursor(); }
+	virtual wxCursor cursor(const RealPoint& pos) const { return wxCursor(); }
 	/// Determines prefered size in the native look, update the style
 	virtual void determineSize(bool force_fit = false) {}
 	/// Should a label and control border be drawn in the native look?

src/gui/value/multiple_choice.cpp

@@ -20,13 +20,15 @@ class DropDownMultipleChoiceList : public DropDownChoiceListBase {
 	
   protected:
 	virtual void   onShow();
-	virtual bool   select(size_t item);
+	virtual void   select(size_t item);
 	virtual size_t selection() const;
+	virtual bool stayOpen() const { return true; }
 	virtual DropDownList* createSubMenu(ChoiceField::ChoiceP group) const;
 	virtual void drawIcon(DC& dc, int x, int y, size_t item, bool selected) const;
 	
-	virtual void onMotion(wxMouseEvent&);
+	virtual void onMouseLeave(wxMouseEvent&);
   private:
+	DECLARE_EVENT_TABLE();
 	bool kept_open; ///< Was the list kept open after selecting a choice, if so, be eager to close it
 };
 
@@ -38,7 +40,7 @@ DropDownMultipleChoiceList::DropDownMultipleChoiceList
 	icon_size.width += 16;
 }
 
-bool DropDownMultipleChoiceList::select(size_t item) {
+void DropDownMultipleChoiceList::select(size_t item) {
 	MultipleChoiceValueEditor& mcve = dynamic_cast<MultipleChoiceValueEditor&>(cve);
 	if (isFieldDefault(item)) {
 		mcve.toggleDefault();
@@ -49,7 +51,6 @@ bool DropDownMultipleChoiceList::select(size_t item) {
 	// keep the box open
 	DropDownChoiceListBase::onShow(); // update 'enabled'
 	kept_open = true;
-	return false;
 }
 
 void DropDownMultipleChoiceList::drawIcon(DC& dc, int x, int y, size_t item, bool selected) const {
@@ -92,16 +93,21 @@ DropDownList* DropDownMultipleChoiceList::createSubMenu(ChoiceField::ChoiceP gro
 	return new DropDownMultipleChoiceList(const_cast<DropDownMultipleChoiceList*>(this), true, cve, group);
 }
 
-void DropDownMultipleChoiceList::onMotion(wxMouseEvent& ev) {
+void DropDownMultipleChoiceList::onMouseLeave(wxMouseEvent& ev) {
 	if (kept_open) {
 		wxSize cs = GetClientSize();
 		if (ev.GetX() < 0 || ev.GetY() < 0 || ev.GetX() >= cs.x || ev.GetY() >= cs.y) {
 			hide(false); // outside box; hide it
+			ev.Skip();
+			return;
 		}
 	}
-	DropDownChoiceListBase::onMotion(ev);
 }
 
+BEGIN_EVENT_TABLE(DropDownMultipleChoiceList, DropDownChoiceListBase)
+	EVT_LEAVE_WINDOW(DropDownMultipleChoiceList::onMouseLeave)
+END_EVENT_TABLE()
+
 // ----------------------------------------------------------------------------- : MultipleChoiceValueEditor
 
 IMPLEMENT_VALUE_EDITOR(MultipleChoice) {}

src/gui/value/text.cpp

@@ -9,6 +9,9 @@
 #include <gui/value/text.hpp>
 #include <gui/icon_menu.hpp>
 #include <gui/util.hpp>
+#include <gui/drop_down_list.hpp>
+#include <data/word_list.hpp>
+#include <data/game.hpp>
 #include <data/action/value.hpp>
 #include <util/tagged_string.hpp>
 #include <util/find_replace.hpp>
@@ -16,6 +19,10 @@
 #include <wx/clipbrd.h>
 #include <wx/caret.h>
 
+DECLARE_SHARED_POINTER_TYPE(DropDownList);
+DECLARE_TYPEOF_COLLECTION(WordListP);
+DECLARE_TYPEOF_COLLECTION(WordListPosP);
+
 // ----------------------------------------------------------------------------- : TextValueEditorScrollBar
 
 /// A scrollbar to scroll a TextValueEditor
@@ -54,12 +61,97 @@ END_EVENT_TABLE  ()
 
 
 
+// ----------------------------------------------------------------------------- : WordListPos
+
+class WordListPos : public IntrusivePtrBase<WordListPos> {
+  public:
+	WordListPos(size_t start, size_t end, WordListP word_list)
+		: start(start), end(end)
+		, rect(-1,-1,-1,-1)
+		, word_list(word_list)
+		, active(false)
+	{}
+	
+	const size_t start, end; ///< Start and ending indices
+	RealRect  rect;          ///< Rectangle around word list text
+	WordListP word_list;     ///< Word list to use
+	bool active;             ///< Is the list dropped down right now?
+};
+
+class DropDownWordList : public DropDownList {
+  public:
+	DropDownWordList(Window* parent, bool is_submenu, TextValueEditor& tve, const WordListPosP& pos, const WordListWordP& list);
+	
+	void setWords(const WordListPosP& pos2);
+	
+  protected:
+	virtual void          onShow();
+	virtual size_t        itemCount() const             { return words->words.size(); }
+	virtual bool          lineBelow(size_t item) const  { return words->words[item]->line_below; }
+	virtual String        itemText(size_t item) const   { return words->words[item]->name; }
+	virtual DropDownList* submenu(size_t item) const;
+	virtual size_t        selection() const;
+	virtual void          select(size_t item);
+  private:
+	TextValueEditor& tve;
+	WordListPosP pos;
+	mutable vector<DropDownListP> submenus;
+	WordListWordP words; ///< The words we are listing
+};
+
+
+DropDownWordList::DropDownWordList(Window* parent, bool is_submenu, TextValueEditor& tve, const WordListPosP& pos, const WordListWordP& words)
+	: DropDownList(parent, is_submenu, is_submenu ? nullptr : &tve)
+	, tve(tve), pos(pos)
+	, words(words)
+{
+	item_size.height = max(16., item_size.height);
+}
+
+void DropDownWordList::setWords(const WordListPosP& pos2) {
+	if (words != pos2->word_list) {
+		// switch to different list
+		submenus.clear();
+	}
+	pos = pos2;
+	words = pos2->word_list;
+}
+
+void DropDownWordList::onShow() {
+	pos->active = true;
+}
+
+DropDownList* DropDownWordList::submenu(size_t item) const {
+	if (item >= submenus.size()) submenus.resize(item + 1);
+	if (submenus[item]) return submenus[item].get();
+	WordListWordP word = words->words[item];
+	if (word->isGroup()) {
+		// create submenu
+		submenus[item].reset(new DropDownWordList(const_cast<DropDownWordList*>(this), true, tve, pos, word));
+	}
+	return submenus[item].get();
+}
+
+
+size_t DropDownWordList::selection() const {
+	// TODO: find selection
+	return NO_SELECTION;
+}
+
+void DropDownWordList::select(size_t item) {
+	pos->active = false;
+	tve.selection_start_i = pos->start;
+	tve.selection_end_i   = pos->end;
+	tve.fixSelection(TYPE_INDEX);
+	tve.replaceSelection(words->words[item]->name, _ACTION_("?????"));
+}
+
 // ----------------------------------------------------------------------------- : TextValueEditor
 
 IMPLEMENT_VALUE_EDITOR(Text)
 	, selection_start  (0), selection_end  (0)
 	, selection_start_i(0), selection_end_i(0)
-	, select_words(false)
+	, selecting(false), select_words(false)
 	, scrollbar(nullptr), scroll_with_cursor(false)
 {
 	if (viewer.nativeLook() && field().multi_line) {
@@ -75,16 +167,33 @@ TextValueEditor::~TextValueEditor() {
 
 bool TextValueEditor::onLeftDown(const RealPoint& pos, wxMouseEvent& ev) {
 	select_words = false;
-	moveSelection(TYPE_INDEX, v.indexAt(style().getRotation().trInv(pos)), !ev.ShiftDown(), MOVE_MID);
+	RealPoint pos2 = style().getRotation().trInv(pos);
+	// on word list dropdown button?
+	WordListPosP wl_pos = findWordList(pos2);
+	if (wl_pos) {
+		// show dropdown
+		if (drop_down) {
+			drop_down->setWords(wl_pos);
+		} else {
+			drop_down.reset(new DropDownWordList(&editor(), false, *this, wl_pos, wl_pos->word_list));
+		}
+		drop_down->show(false, wxPoint(0,0)); // TODO: position?
+	} else {
+		// no, select text
+		selecting = true;
+		moveSelection(TYPE_INDEX, v.indexAt(pos2), !ev.ShiftDown(), MOVE_MID);
+	}
 	return true;
 }
 bool TextValueEditor::onLeftUp(const RealPoint& pos, wxMouseEvent&) {
 	// TODO: lookup position of click?
+	selecting = false;
 	return false;
 }
 
 bool TextValueEditor::onMotion(const RealPoint& pos, wxMouseEvent& ev) {
-	if (ev.LeftIsDown()) {
+	if (dropDownShown()) return false;
+	if (ev.LeftIsDown() && selecting) {
 		size_t index = v.indexAt(style().getRotation().trInv(pos));
 		if (select_words) {
 			// on the left, swap start and end
@@ -126,6 +235,10 @@ bool TextValueEditor::onRightDown(const RealPoint& pos, wxMouseEvent& ev) {
 // ----------------------------------------------------------------------------- : Keyboard
 
 bool TextValueEditor::onChar(wxKeyEvent& ev) {
+	if (dropDownShown()) {
+		// forward to drop down list
+		return drop_down->onCharInParent(ev);
+	}
 	if (ev.AltDown()) return false;
 	fixSelection();
 	switch (ev.GetKeyCode()) {
@@ -293,6 +406,8 @@ void TextValueEditor::draw(RotatedDC& dc) {
 	prepareDrawScrollbar(dc);
 	// draw text
 	TextValueViewer::draw(dc);
+	// draw word list thingamajigies
+	drawWordListIndicators(dc);
 	// draw selection
 	if (isCurrent()) {
 		v.drawSelection(dc, style(), selection_start_i, selection_end_i);
@@ -306,8 +421,11 @@ void TextValueEditor::draw(RotatedDC& dc) {
 
 wxCursor rotated_ibeam;
 
-wxCursor TextValueEditor::cursor() const {
-	if (viewer.getRotation().sideways() ^ style().getRotation().sideways()) { // 90 or 270 degrees
+wxCursor TextValueEditor::cursor(const RealPoint& pos) const {
+	RealPoint pos2 = style().getRotation().trInv(pos);
+	if (findWordList(pos2)) {
+		return wxCursor();
+	} else if (viewer.getRotation().sideways() ^ style().getRotation().sideways()) { // 90 or 270 degrees
 		if (!rotated_ibeam.Ok()) {
 			rotated_ibeam = wxCursor(load_resource_cursor(_("rot_text")));
 		}
@@ -321,10 +439,12 @@ void TextValueEditor::onValueChange() {
 	TextValueViewer::onValueChange();
 	selection_start   = selection_end   = 0;
 	selection_start_i = selection_end_i = 0;
+	findWordLists();
 }
 
 void TextValueEditor::onAction(const Action& action, bool undone) {
 	TextValueViewer::onValueChange();
+	findWordLists();
 	TYPE_CASE(action, TextValueAction) {
 		selection_start = action.selection_start;
 		selection_end   = action.selection_end;
@@ -439,6 +559,11 @@ void TextValueEditor::doFormat(int type) {
 // ----------------------------------------------------------------------------- : Selection
 
 void TextValueEditor::showCaret() {
+	if (dropDownShown()) {
+		wxCaret* caret = editor().GetCaret();
+		if (caret && caret->IsVisible()) caret->Hide();
+		return;
+	}
 	// Rotation
 	Rotation rot(viewer.getRotation());
 	Rotater rot2(rot, style().getRotation());
@@ -855,3 +980,88 @@ void TextValueEditor::prepareDrawScrollbar(RotatedDC& dc) {
 		style().width.mutate() += scrollbar_width;
 	}
 }
+
+// ----------------------------------------------------------------------------- : Word lists
+
+bool TextValueEditor::dropDownShown() {
+	return drop_down && drop_down->IsShown();
+}
+
+void TextValueEditor::findWordLists() {
+	word_lists.clear();
+	// for each word list...
+	const String& str = value().value();
+	size_t pos = str.find(_("<word-list-"));
+	while (pos != String::npos) {
+		size_t type_end = str.find_first_of(_('>'), pos);
+		size_t end = match_close_tag_end(str, pos);
+		if (type_end == String::npos || end == String::npos) return;
+		String name = str.substr(pos + 11, type_end - pos - 11);
+		WordListP word_list;
+		// find word list type
+		FOR_EACH(wl, getSet().game->word_lists) {
+			if (wl->name == name) {
+				word_list = wl;
+				break;
+			}
+		}
+		if (!word_list) {
+			throw Error(_ERROR_1_("word list type not found", name));
+		}
+		// add to word_lists
+		word_lists.push_back(new_intrusive3<WordListPos>(pos, end, word_list));
+		// next
+		pos = str.find(_("<word-list-"), end);
+	}
+}
+
+void TextValueEditor::drawWordListIndicators(RotatedDC& dc) {
+	bool current = isCurrent();
+	FOR_EACH(wl, word_lists) {
+		RealRect& r = wl->rect;
+		if (r.height < 0) {
+			// find the rectangle for this indicator
+			RealRect start = v.charRect(wl->start);
+			RealRect end   = v.charRect(wl->end);
+			r.x = start.x;
+			r.y = start.y;
+			r.width  = end.right() - start.left() + 0.5;
+			r.height = end.bottom() - start.top();
+		}
+		// draw background
+		if (current && wl->active) {
+			dc.SetPen  (Color(0,  128,255));
+			dc.SetBrush(Color(128,192,255));
+		} else if (current) {
+			dc.SetPen  (Color(64, 160,255));
+			dc.SetBrush(Color(160,208,255));
+		} else {
+			dc.SetPen  (Color(128,128,128));
+			dc.SetBrush(Color(192,192,192));
+		}
+		dc.DrawRectangle(RealRect(style().left + r.right(), style().top + r.top(), 9, r.height));
+		// draw foreground
+		/*
+		dc.SetPen  (*wxTRANSPARENT_PEN);
+		dc.SetBrush(*wxBLACK_BRUSH);
+		wxPoint poly[] = {dc.tr(RealPoint(0,0)), dc.tr(RealPoint(5,0)), dc.tr(RealPoint(3,2))};
+		dc.getDC().DrawPolygon(3, poly, style().left + r.right() + 2, style().top + r.bottom() - 5);
+		*/
+		dc.SetPen  (*wxBLACK_PEN);
+		double x = style().left + r.right(), y = style().top + r.bottom();
+		dc.DrawLine(RealPoint(x + 4, y - 3), RealPoint(x + 5, y - 3));
+		dc.DrawLine(RealPoint(x + 3, y - 4), RealPoint(x + 6, y - 4));
+		dc.DrawLine(RealPoint(x + 2, y - 5), RealPoint(x + 7, y - 5));
+	}
+}
+
+WordListPosP TextValueEditor::findWordList(const RealPoint& pos) const {
+	FOR_EACH_CONST(wl, word_lists) {
+		const RealRect& r = wl->rect;
+		if (pos.x >= r.right() && pos.x < r.right() + 9 &&
+		    pos.y >= r.top()   && pos.y < r.bottom()) {
+			return wl;
+		}
+	}
+	return WordListPosP();
+}

src/gui/value/text.hpp

@@ -15,6 +15,8 @@
 #include <render/value/text.hpp>
 
 class TextValueEditorScrollBar;
+DECLARE_POINTER_TYPE(WordListPos);
+DECLARE_SHARED_POINTER_TYPE(DropDownWordList);
 
 // ----------------------------------------------------------------------------- : TextValueEditor
 
@@ -85,7 +87,7 @@ class TextValueEditor : public TextValueViewer, public ValueEditor {
 	
 	// --------------------------------------------------- : Other
 	
-	virtual wxCursor cursor() const;
+	virtual wxCursor cursor(const RealPoint& pos) const;
 	virtual void determineSize(bool force_fit = false);
 	virtual void onShow(bool);
 	virtual void draw(RotatedDC&);
@@ -94,9 +96,11 @@ class TextValueEditor : public TextValueViewer, public ValueEditor {
   private:
 	size_t selection_start,   selection_end;   ///< Cursor position/selection (if any), cursor positions
 	size_t selection_start_i, selection_end_i; ///< Cursor position/selection, character indices
+	bool selecting;                            ///< Selecting text?
 	bool select_words;                         ///< Select whole words when dragging the mouse?
 	TextValueEditorScrollBar* scrollbar;       ///< Scrollbar for multiline fields in native look
 	bool scroll_with_cursor;                   ///< When the cursor moves, should the scrollposition change?
+	vector<WordListPosP> word_lists;           ///< Word lists in the text
 	
 	// --------------------------------------------------- : Selection / movement
 	
@@ -147,6 +151,22 @@ class TextValueEditor : public TextValueViewer, public ValueEditor {
 	bool ensureCaretVisible();
 	/// Prepare for drawing if there is a scrollbar
 	void prepareDrawScrollbar(RotatedDC& dc);
+	
+	// --------------------------------------------------- : Word lists
+	
+	friend class DropDownWordList;
+	DropDownWordListP drop_down;
+	bool dropDownShown();
+	
+	/// Find all word lists in the current value
+	void findWordLists();
+	/// Draw word list indicators
+	void drawWordListIndicators(RotatedDC& dc);
+	/// Find a WordListPos under the mouse cursor (if any), pos is in internal coordinates
+	WordListPosP findWordList(const RealPoint& pos) const;
+	/// Show a word list drop down menu
+	void wordListDropDown(const WordListPosP& pos);
+	
 };
 
 // ----------------------------------------------------------------------------- : EOF