luke
/
klayout
mirror of https://github.com/KLayout/klayout.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Better error messages on Expressions too.

This commit is contained in:
Matthias Koefferlein 2024-05-25 19:18:15 +02:00
parent d59d318218
commit 4f88ff68da
3 changed files with 121 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

82
src/gsi/gsi/gsiExpression.cc
View File

@ -721,19 +721,49 @@ num_args (const gsi::MethodBase *m)
return int (m->end_arguments () - m->begin_arguments ());
}
std::set<std::string>
invalid_kwnames (const gsi::MethodBase *meth, const std::map<std::string, tl::Variant> *kwargs)
{
std::set<std::string> valid_names;
for (gsi::MethodBase::argument_iterator a = meth->begin_arguments (); a != meth->end_arguments (); ++a) {
valid_names.insert (a->spec ()->name ());
}
std::set<std::string> invalid_names;
for (auto i = kwargs->begin (); i != kwargs->end (); ++i) {
if (valid_names.find (i->first) == valid_names.end ()) {
invalid_names.insert (i->first);
}
}
return invalid_names;
}
static bool
compatible_with_args (const gsi::MethodBase *m, int argc, const std::map<std::string, tl::Variant> *kwargs)
compatible_with_args (const gsi::MethodBase *m, int argc, const std::map<std::string, tl::Variant> *kwargs, std::string *why_not = 0)
{
int nargs = num_args (m);
int nkwargs = kwargs ? int (kwargs->size ()) : 0;
if (argc >= nargs) {
if (argc > nargs) {
if (why_not) {
*why_not = tl::sprintf (tl::to_string (tr ("%d argument(s) expected, but %d given")), nargs, argc);
}
return false;
} else if (argc == nargs) {
// no more arguments to consider
return argc == nargs && (! kwargs || kwargs->empty ());
if (nkwargs > 0) {
if (why_not) {
*why_not = tl::to_string (tr ("all arguments given, but additional keyword arguments specified"));
}
return false;
} else {
return true;
}
}
if (kwargs) {
int nkwargs = int (kwargs->size ());
int kwargs_taken = 0;
while (argc < nargs) {
@ -741,6 +771,9 @@ compatible_with_args (const gsi::MethodBase *m, int argc, const std::map<std::st
auto i = kwargs->find (atype.spec ()->name ());
if (i == kwargs->end ()) {
if (! atype.spec ()->has_default ()) {
if (why_not) {
*why_not = tl::sprintf (tl::to_string (tr ("no argument specified for '%s' (neither positional or keyword)")), atype.spec ()->name ());
}
return false;
}
} else {
@ -750,13 +783,33 @@ compatible_with_args (const gsi::MethodBase *m, int argc, const std::map<std::st
}
// matches if all keyword arguments are taken
return kwargs_taken == nkwargs;
if (kwargs_taken != nkwargs) {
if (why_not) {
std::set<std::string> invalid_names = invalid_kwnames (m, kwargs);
if (invalid_names.size () > 1) {
std::string names_str = tl::join (invalid_names.begin (), invalid_names.end (), ", ");
*why_not = tl::to_string (tr ("unknown keyword parameters: ")) + names_str;
} else if (invalid_names.size () == 1) {
*why_not = tl::to_string (tr ("unknown keyword parameter: ")) + *invalid_names.begin ();
}
}
return false;
} else {
return true;
}
} else {
while (argc < nargs) {
const gsi::ArgType &atype = m->begin_arguments () [argc];
if (! atype.spec ()->has_default ()) {
if (why_not) {
if (argc < nargs - 1 && ! m->begin_arguments () [argc + 1].spec ()->has_default ()) {
*why_not = tl::sprintf (tl::to_string (tr ("no value given for argument #%d and following")), argc + 1);
} else {
*why_not = tl::sprintf (tl::to_string (tr ("no value given for argument #%d")), argc + 1);
}
}
return false;
}
++argc;
@ -771,8 +824,11 @@ static std::string
describe_overload (const gsi::MethodBase *m, int argc, const std::map<std::string, tl::Variant> *kwargs)
{
std::string res = m->to_string ();
if (compatible_with_args (m, argc, kwargs)) {
std::string why_not;
if (compatible_with_args (m, argc, kwargs, &why_not)) {
res += " " + tl::to_string (tr ("[match candidate]"));
} else if (! why_not.empty ()) {
res += " [" + why_not + "]";
}
return res;
}
@ -1006,19 +1062,7 @@ VariantUserClassImpl::execute_gsi (const tl::ExpressionParserContext & /*context
if (kwargs_taken != nkwargs) {
// check if there are any left-over keyword parameters with unknown names
std::set<std::string> valid_names;
for (gsi::MethodBase::argument_iterator a = meth->begin_arguments (); a != meth->end_arguments (); ++a) {
valid_names.insert (a->spec ()->name ());
}
std::set<std::string> invalid_names;
for (auto i = kwargs->begin (); i != kwargs->end (); ++i) {
if (valid_names.find (i->first) == valid_names.end ()) {
invalid_names.insert (i->first);
}
}
std::set<std::string> invalid_names = invalid_kwnames (meth, kwargs);
if (invalid_names.size () > 1) {
std::string names_str = tl::join (invalid_names.begin (), invalid_names.end (), ", ");
throw tl::Exception (tl::to_string (tr ("Unknown keyword parameters: ")) + names_str);

57
src/gsi/unit_tests/gsiExpressionTests.cc
View File

@ -772,3 +772,60 @@ TEST(14)
EXPECT_EQ (ex.msg ().find ("No overload with matching arguments. Variants are:"), 0);
}
}
TEST(15)
{
// Keyword arguments, enums and errors
tl::Eval e;
tl::Variant v;
try {
v = e.parse("var bb = BB.new; bb.d4()").execute();
EXPECT_EQ (true, false);
} catch (tl::Exception &ex) {
EXPECT_EQ (ex.msg (), "Can't match arguments. Variants are:\n string d4(int a, string b, double c, B3::E d = E3A, variant e = nil) [no value given for argument #1 and following]\n at position 19 (...d4())");
}
try {
v = e.parse("var bb = BB.new; bb.d4(1, 'a')").execute();
EXPECT_EQ (true, false);
} catch (tl::Exception &ex) {
EXPECT_EQ (ex.msg (), "Can't match arguments. Variants are:\n string d4(int a, string b, double c, B3::E d = E3A, variant e = nil) [no value given for argument #3]\n at position 19 (...d4(1, 'a'))");
}
try {
v = e.parse("var bb = BB.new; bb.d4(1, 'a', 2.0, xxx=17)").execute();
EXPECT_EQ (true, false);
} catch (tl::Exception &ex) {
EXPECT_EQ (ex.msg (), "Can't match arguments. Variants are:\n string d4(int a, string b, double c, B3::E d = E3A, variant e = nil) [unknown keyword parameter: xxx]\n at position 19 (...d4(1, 'a', 2.0, xxx..)");
}
try {
v = e.parse("var bb = BB.new; bb.d4(a=1, b='a', c=2.0, xxx=17)").execute();
EXPECT_EQ (true, false);
} catch (tl::Exception &ex) {
EXPECT_EQ (ex.msg (), "Can't match arguments. Variants are:\n string d4(int a, string b, double c, B3::E d = E3A, variant e = nil) [unknown keyword parameter: xxx]\n at position 19 (...d4(a=1, b='a', c=2...)");
}
v = e.parse("var bb = BB.new; bb.d4(1, 'a', 2.0)").execute();
EXPECT_EQ (v.to_string (), "1,a,2,100,nil");
v = e.parse("var bb = BB.new; bb.d4(1, 'a', 2.0, e=42)").execute();
EXPECT_EQ (v.to_string (), "1,a,2,100,42");
v = e.parse("var bb = BB.new; bb.d4(1, 'a', c=2.0, e=42)").execute();
EXPECT_EQ (v.to_string (), "1,a,2,100,42");
v = e.parse("var bb = BB.new; bb.d4(c=2.0, a=1, b='a', e=42)").execute();
EXPECT_EQ (v.to_string (), "1,a,2,100,42");
v = e.parse("var bb = BB.new; bb.d4(1, 'a', 2.0, d=BB.E.E3B)").execute();
EXPECT_EQ (v.to_string (), "1,a,2,101,nil");
v = e.parse("var bb = BB.new; bb.d4(1, 'a', d=BB.E.E3B, c=2.0)").execute();
EXPECT_EQ (v.to_string (), "1,a,2,101,nil");
v = e.parse("var bb = BB.new; bb.d4(1, 'a', 2.0, BB.E.E3B, 42)").execute();
EXPECT_EQ (v.to_string (), "1,a,2,101,42");
}

2
testdata/ruby/basic_testcore.rb vendored
View File

@ -3193,7 +3193,7 @@ class Basic_TestClass < TestBase
assert_equal(bb.d4(1, "a", 2.0), "1,a,2,100,nil")
assert_equal(bb.d4(1, "a", 2.0, e: 42), "1,a,2,100,42")
assert_equal(bb.d4(1, "a", c=2.0, e: 42), "1,a,2,100,42")
assert_equal(bb.d4(1, "a", c: 2.0, e: 42), "1,a,2,100,42")
assert_equal(bb.d4(c: 2.0, a: 1, b: "a", e: 42), "1,a,2,100,42")
assert_equal(bb.d4(1, "a", 2.0, d: RBA::BB::E::E3B), "1,a,2,101,nil")
assert_equal(bb.d4(1, "a", d: RBA::BB::E::E3B, c: 2.5), "1,a,2.5,101,nil")