Eliminate pointless runtime datastructures for CalltipProvider

And add some tests and make it actually work correctly.

build/tests/tests.vcxproj

@@ -40,6 +40,7 @@
   <ItemGroup>
     <ClCompile Include="$(SrcDir)tests\access.cpp" />
     <ClCompile Include="$(SrcDir)tests\cajun.cpp" />
+    <ClCompile Include="$(SrcDir)tests\calltip_provider.cpp" />
     <ClCompile Include="$(SrcDir)tests\color.cpp" />
     <ClCompile Include="$(SrcDir)tests\dialogue_lexer.cpp" />
     <ClCompile Include="$(SrcDir)tests\format.cpp" />

libaegisub/common/calltip_provider.cpp

@@ -18,113 +18,107 @@
 
 #include "libaegisub/ass/dialogue_parser.h"
 
-namespace {
+#include <algorithm>
-	struct proto_lit {
-		const char *name;
-		bool has_parens;
-		const char *args;
-	};
 
-	proto_lit calltip_protos[] = {
+namespace {
-		{ "move", true, "X1\0Y1\0X2\0Y2\0" },
+struct proto_lit {
-		{ "move", true, "X1\0Y1\0X2\0Y2\0Start Time\0End Time\0" },
+	const char *name;
-		{ "fn", false, "Font Name\0" },
+	const char *args;
-		{ "bord", false, "Width\0" },
+};
-		{ "xbord", false, "Width\0" },
+
-		{ "ybord", false, "Width\0" },
+// NOTE: duplicate tag names sorted by number of arguments
-		{ "shad", false, "Depth\0" },
+const proto_lit proto_1[] = {
-		{ "xshad", false, "Depth\0" },
+	{"K", "\\KDuration"},
-		{ "yshad", false, "Depth\0" },
+	{"a", "\\aAlignment"},
-		{ "be", false, "Strength\0" },
+	{"b", "\\bWeight"},
-		{ "blur", false, "Strength\0" },
+	{"c", "\\cColour"},
-		{ "fscx", false, "Scale\0" },
+	{"i", "\\i1/0"},
-		{ "fscy", false, "Scale\0" },
+	{"k", "\\kDuration"},
-		{ "fsp", false, "Spacing\0" },
+	{"p", "\\pExponent"},
-		{ "fs", false, "Font Size\0" },
+	{"q", "\\qWrap Style"},
-		{ "fe", false, "Encoding\0" },
+	{"r", "\\rStyle"},
-		{ "frx", false, "Angle\0" },
+	{"s", "\\s1/0"},
-		{ "fry", false, "Angle\0" },
+	{"t", "\\t(Acceleration,Tags)"},
-		{ "frz", false, "Angle\0" },
+	{"t", "\\t(Start Time,End Time,Tags)"},
-		{ "fr", false, "Angle\0" },
+	{"t", "\\t(Start Time,End Time,Acceleration,Tags)"},
-		{ "pbo", false, "Offset\0" },
+	{"u", "\\u1/0"},
-		{ "clip", true, "Command\0" },
+	{nullptr, nullptr}
-		{ "clip", true, "Scale\0Command\0" },
+};
-		{ "clip", true, "X1\0Y1\0X2\0Y2\0" },
+
-		{ "iclip", true, "Command\0" },
+const proto_lit proto_2[] = {
-		{ "iclip", true, "Scale\0Command\0" },
+	{"1a", "\\1aAlpha"},
-		{ "iclip", true, "X1\0Y1\0X2\0Y2\0" },
+	{"1c", "\\1cColour"},
-		{ "t", true, "Acceleration\0Tags\0" },
+	{"2a", "\\2aAlpha"},
-		{ "t", true, "Start Time\0End Time\0Tags\0" },
+	{"2c", "\\2cColour"},
-		{ "t", true, "Start Time\0End Time\0Acceleration\0Tags\0" },
+	{"3a", "\\3aAlpha"},
-		{ "pos", true, "X\0Y\0" },
+	{"3c", "\\3cColour"},
-		{ "p", false, "Exponent\0" },
+	{"4a", "\\4aAlpha"},
-		{ "org", true, "X\0Y\0" },
+	{"4c", "\\4cColour"},
-		{ "fade", true, "Start Alpha\0Middle Alpha\0End Alpha\0Start In\0End In\0Start Out\0End Out\0" },
+	{"an", "\\anAlignment"},
-		{ "fad", true, "Start Time\0End Time\0" },
+	{"be", "\\beStrength"},
-		{ "c", false, "Colour\0" },
+	{"fe", "\\feEncoding"},
-		{ "1c", false, "Colour\0" },
+	{"fn", "\\fnFont Name"},
-		{ "2c", false, "Colour\0" },
+	{"fr", "\\frAngle"},
-		{ "3c", false, "Colour\0" },
+	{"fs", "\\fsFont Size"},
-		{ "4c", false, "Colour\0" },
+	{"kf", "\\kfDuration"},
-		{ "alpha", false, "Alpha\0" },
+	{"ko", "\\koDuration"},
-		{ "1a", false, "Alpha\0" },
+	{nullptr, nullptr}
-		{ "2a", false, "Alpha\0" },
+};
-		{ "3a", false, "Alpha\0" },
+
-		{ "4a", false, "Alpha\0" },
+const proto_lit proto_3[] = {
-		{ "an", false, "Alignment\0" },
+	{"fax", "\\faxFactor"},
-		{ "a", false, "Alignment\0" },
+	{"fay", "\\fayFactor"},
-		{ "b", false, "Weight\0" },
+	{"frx", "\\frxAngle"},
-		{ "i", false, "1/0\0" },
+	{"fry", "\\fryAngle"},
-		{ "u", false, "1/0\0" },
+	{"frz", "\\frzAngle"},
-		{ "s", false, "1/0\0" },
+	{"fsp", "\\fspSpacing"},
-		{ "kf", false, "Duration\0" },
+	{"org", "\\org(X,Y)"},
-		{ "ko", false, "Duration\0" },
+	{"pbo", "\\pboOffset"},
-		{ "k", false, "Duration\0" },
+	{"pos", "\\pos(X,Y)"},
-		{ "K", false, "Duration\0" },
+	{nullptr, nullptr}
-		{ "q", false, "Wrap Style\0" },
+};
-		{ "r", false, "Style\0" },
+
-		{ "fax", false, "Factor\0" },
+const proto_lit proto_4[] = {
-		{ "fay", false, "Factor\0" }
+	{"blur", "\\blurStrength"},
-	};
+	{"bord", "\\bordWidth"},
+	{"clip", "\\clip(Command)"},
+	{"clip", "\\clip(Scale,Command)"},
+	{"clip", "\\clip(X1,Y1,X2,Y2)"},
+	{"fad", "\\fad(Start Time,End Time)"},
+	{"fade", "\\fade(Start Alpha,Middle Alpha,End Alpha,Start In,End In,Start Out,End Out)"},
+	{"fscx", "\\fscxScale"},
+	{"fscy", "\\fscyScale"},
+	{"move", "\\move(X1,Y1,X2,Y2)"},
+	{"move", "\\move(X1,Y1,X2,Y2,Start Time,End Time)"},
+	{"shad", "\\shadDepth"},
+	{nullptr, nullptr}
+};
+
+const proto_lit proto_5[] = {
+	{"alpha", "\\alphaAlpha"},
+	{"iclip", "\\iclip(Command)"},
+	{"iclip", "\\iclip(Scale,Command)"},
+	{"iclip", "\\iclip(X1,Y1,X2,Y2)"},
+	{"xbord", "\\xbordWidth"},
+	{"xshad", "\\xshadDepth"},
+	{"ybord", "\\ybordWidth"},
+	{"yshad", "\\yshadDepth"},
+	{nullptr, nullptr}
+};
+
+const proto_lit *all_protos[] = {proto_1, proto_2, proto_3, proto_4, proto_5};
 }
 
 namespace agi {
-CalltipProvider::CalltipProvider() {
+Calltip GetCalltip(std::vector<ass::DialogueToken> const& tokens, std::string const& text, size_t pos) {
-	for (auto proto : calltip_protos) {
-		CalltipProto p;
-		std::string tag_name = proto.name;
-		p.text = '\\' + tag_name;
-		if (proto.has_parens)
-			p.text += '(';
-
-		for (const char *arg = proto.args; *arg; ) {
-			size_t start = p.text.size();
-			p.text += arg;
-			size_t end = p.text.size();
-			if (proto.has_parens)
-				p.text += ',';
-
-			arg += end - start + 1;
-			p.args.emplace_back(start, end);
-		}
-
-		// replace trailing comma
-		if (proto.has_parens)
-			p.text.back() = ')';
-
-		protos.insert(make_pair(tag_name, p));
-	}
-}
-
-Calltip CalltipProvider::GetCalltip(std::vector<ass::DialogueToken> const& tokens, std::string const& text, size_t pos) {
 	namespace dt = ass::DialogueTokenType;
 
-	Calltip ret = { "", 0, 0, 0 };
+	Calltip ret = { nullptr, 0, 0, 0 };
 
 	size_t idx = 0;
 	size_t tag_name_idx = 0;
 	size_t commas = 0;
-	for (; idx < tokens.size() && pos >= tokens[idx].length; ++idx) {
+	for (; idx < tokens.size() && pos > 0; ++idx) {
 		switch (tokens[idx].type) {
 			case dt::COMMENT:
 			case dt::OVR_END:
@@ -139,7 +133,7 @@ Calltip CalltipProvider::GetCalltip(std::vector<ass::DialogueToken> const& token
 				break;
 			default: break;
 		}
-		pos -= tokens[idx].length;
+		pos -= std::min(pos, tokens[idx].length);
 	}
 
 	// Either didn't hit a tag or the override block ended before reaching the
@@ -147,17 +141,32 @@ Calltip CalltipProvider::GetCalltip(std::vector<ass::DialogueToken> const& token
 	if (tag_name_idx == 0)
 		return ret;
 
-	// Find the prototype for this tag
 	size_t tag_name_start = 0;
 	for (size_t i = 0; i < tag_name_idx; ++i)
 		tag_name_start += tokens[i].length;
-	auto it = protos.equal_range(text.substr(tag_name_start, tokens[tag_name_idx].length));
+	size_t tag_name_length = tokens[tag_name_idx].length;
+
+	// No tags exist with length over five
+	if (tag_name_length > 5)
+		return ret;
+
+	auto valid = [&](const proto_lit *it) {
+		return it->name && strncmp(it->name, &text[tag_name_start], tag_name_length) == 0;
+	};
+
+	// Find the prototype for this tag
+	auto proto = all_protos[tag_name_length - 1];
+	while (proto->name && strncmp(proto->name, &text[tag_name_start], tag_name_length) < 0)
+		++proto;
+
+	if (!valid(proto))
+		return ret;
 
 	// If there's multiple overloads, check how many total arguments we have
 	// and pick the one with the least args >= current arg count
-	if (distance(it.first, it.second) > 1) {
+	if (valid(proto + 1)) {
 		size_t args = commas + 1;
-		for (size_t i = idx; i < tokens.size(); ++i) {
+		for (size_t i = idx + 1; i < tokens.size(); ++i) {
 			int type = tokens[i].type;
 			if (type == dt::ARG_SEP)
 				++args;
@@ -165,18 +174,40 @@ Calltip CalltipProvider::GetCalltip(std::vector<ass::DialogueToken> const& token
 				break;
 		}
 
-		while (it.first != it.second && args > it.first->second.args.size())
+		auto arg_count = [](const proto_lit *it) -> size_t {
-			++it.first;
+			size_t count = 1;
+			for (const char *s = it->args; *s; ++s) {
+				if (*s == ',') ++count;
+			}
+			return count;
+		};
+
+		while (valid(proto + 1) && args > arg_count(proto))
+			++proto;
 	}
 
-	// Unknown tag or too many arguments
+	ret.highlight_start = tag_name_length + 1;
-	if (it.first == it.second || it.first->second.args.size() <= commas)
+	if (proto->args[ret.highlight_start] != '(')
-		return ret;
+		ret.highlight_end = strlen(proto->args);
+	else {
+		auto start = proto->args + tag_name_length + 2; // One for slash, one for open paren
+		for (; commas > 0; --commas) {
+			start = strchr(start, ',');
+			if (!start) return ret; // No calltip if there's too many args
+			++start;
+		}
 
-	ret.text = it.first->second.text;
+		ret.highlight_start = std::distance(proto->args, start);
-	ret.highlight_start = it.first->second.args[commas].first;
+		const char *end = strchr(start, ',');
-	ret.highlight_end = it.first->second.args[commas].second;
+		if (end)
+			ret.highlight_end = std::distance(start, end) + ret.highlight_start;
+		else
+			ret.highlight_end = strlen(proto->args) - 1; // -1 for close paren
+	}
+
+	ret.text = proto->args;
 	ret.tag_position = tag_name_start;
+
 	return ret;
 }
 }

libaegisub/include/libaegisub/calltip_provider.h

@@ -14,31 +14,19 @@
 //
 // Aegisub Project http://www.aegisub.org/
 
-#include <map>
 #include <string>
 #include <vector>
 
 namespace agi {
-	namespace ass { struct DialogueToken; }
+namespace ass { struct DialogueToken; }
 
-	struct Calltip {
+struct Calltip {
-		std::string text;       ///< Text of the calltip
+	const char *text;       ///< Text of the calltip
-		size_t highlight_start; ///< Start index of the current parameter in text
+	size_t highlight_start; ///< Start index of the current parameter in text
-		size_t highlight_end;   ///< End index of the current parameter in text
+	size_t highlight_end;   ///< End index of the current parameter in text
-		size_t tag_position;    ///< Start index of the tag in the input line
+	size_t tag_position;    ///< Start index of the tag in the input line
-	};
+};
 
-	class CalltipProvider {
+/// Get the calltip to show for the given cursor position in the text
-		struct CalltipProto {
+Calltip GetCalltip(std::vector<ass::DialogueToken> const& tokens, std::string const& text, size_t pos);
-			std::string text;
-			std::vector<std::pair<size_t, size_t>> args;
-		};
-		std::multimap<std::string, CalltipProto> protos;
-
-	public:
-		CalltipProvider();
-
-		/// Get the calltip to show for the given cursor position in the text
-		Calltip GetCalltip(std::vector<ass::DialogueToken> const& tokens, std::string const& text, size_t pos);
-	};
 }

src/subs_edit_ctrl.cpp

@@ -281,18 +281,15 @@ void SubsTextEditCtrl::UpdateCallTip() {
 	if (pos == cursor_pos) return;
 	cursor_pos = pos;
 
-	if (!calltip_provider)
+	agi::Calltip new_calltip = agi::GetCalltip(tokenized_line, line_text, pos);
-		calltip_provider = agi::make_unique<agi::CalltipProvider>();
 
-	agi::Calltip new_calltip = calltip_provider->GetCalltip(tokenized_line, line_text, pos);
+	if (!new_calltip.text) {
-
-	if (new_calltip.text.empty()) {
 		CallTipCancel();
 		return;
 	}
 
 	if (!CallTipActive() || calltip_position != new_calltip.tag_position || calltip_text != new_calltip.text)
-		CallTipShow(new_calltip.tag_position, to_wx(new_calltip.text));
+		CallTipShow(new_calltip.tag_position, wxString::FromUTF8Unchecked(new_calltip.text));
 
 	calltip_position = new_calltip.tag_position;
 	calltip_text = new_calltip.text;

src/subs_edit_ctrl.h

@@ -34,7 +34,6 @@
 
 class Thesaurus;
 namespace agi {
-	class CalltipProvider;
 	class SpellChecker;
 	struct Context;
 	namespace ass { struct DialogueToken; }
@@ -49,8 +48,6 @@ class SubsTextEditCtrl final : public wxStyledTextCtrl {
 	/// Backend thesaurus to use
 	std::unique_ptr<Thesaurus> thesaurus;
 
-	std::unique_ptr<agi::CalltipProvider> calltip_provider;
-
 	/// Project context, for splitting lines
 	agi::Context *context;
 

tests/tests/calltip_provider.cpp

@@ -0,0 +1,77 @@
+// Copyright (c) 2014, Thomas Goyne <plorkyeran@aegisub.org>
+//
+// Permission to use, copy, modify, and distribute this software for any
+// purpose with or without fee is hereby granted, provided that the above
+// copyright notice and this permission notice appear in all copies.
+//
+// THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+// WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+// MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+// ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+// WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+// ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+// OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+
+#include <libaegisub/calltip_provider.h>
+
+#include <libaegisub/ass/dialogue_parser.h>
+
+#include <main.h>
+
+using agi::Calltip;
+
+static void expect_tip(const char *line, size_t pos, agi::Calltip tip) {
+	auto tokenized_line = agi::ass::TokenizeDialogueBody(line, false);
+	auto actual = agi::GetCalltip(tokenized_line, line, pos);
+	if (!tip.text) {
+		EXPECT_EQ(nullptr, actual.text);
+	}
+	else {
+		ASSERT_TRUE(actual.text);
+		EXPECT_STREQ(tip.text, actual.text);
+		EXPECT_EQ(tip.tag_position, actual.tag_position);
+		EXPECT_EQ(tip.highlight_start, actual.highlight_start);
+		EXPECT_EQ(tip.highlight_end, actual.highlight_end);
+	}
+}
+
+const auto bad_tip = Calltip{nullptr, 0, 0, 0};
+
+TEST(lagi_calltip, empty_line) {
+	expect_tip("", 0, bad_tip);
+}
+
+TEST(lagi_calltip, no_override_blocks) {
+	expect_tip("hello", 0, bad_tip);
+}
+
+TEST(lagi_calltip, cursor_outside_of_block) {
+	expect_tip("{\\b1}hello", 6, bad_tip);
+}
+
+TEST(lagi_calltip, basic_cursor_on_tag) {
+	expect_tip("{\\b1}hello", 3, Calltip{"\\bWeight", 2, 8, 2});
+}
+
+TEST(lagi_calltip, basic_two_arg) {
+	expect_tip("{\\pos(100,100)}hello", 3, Calltip{"\\pos(X,Y)", 5, 6, 2});
+	expect_tip("{\\pos(100,100)}hello", 9, Calltip{"\\pos(X,Y)", 5, 6, 2});
+	expect_tip("{\\pos(100,100)}hello", 10, Calltip{"\\pos(X,Y)", 7, 8, 2});
+	expect_tip("{\\pos(100,100)}hello", 14, Calltip{"\\pos(X,Y)", 7, 8, 2});
+	expect_tip("{\\pos(100,100)}hello", 15, bad_tip);
+}
+
+TEST(lagi_calltip, overloads) {
+	expect_tip("{\\clip(m)}", 3, Calltip{"\\clip(Command)", 6, 13, 2});
+	expect_tip("{\\clip(1, m)}", 3, Calltip{"\\clip(Scale,Command)", 6, 11, 2});
+	expect_tip("{\\clip(1, m)}", 10, Calltip{"\\clip(Scale,Command)", 12, 19, 2});
+}
+
+TEST(lagi_calltip, too_many_args) {
+	expect_tip("{\\pos(100,100,100)}hello", 2, bad_tip);
+}
+
+TEST(lagi_calltip, unknown_tag) {
+	expect_tip("{\\foo(100,100,100)}hello", 2, bad_tip);
+	expect_tip("{\\toolong(100,100,100)}hello", 2, bad_tip);
+}