Indexer vs DotName.equals() for a nested class with simple name that ends with $

Question

Indexer vs DotName.equals() for a nested class with simple name that ends with $

mkouba opened this issue 4 years ago · comments

If there is a nested class with simple name Test$, e.g. org.jboss.jandex.test.IndexerTestCase$Test$ (note that although it's not recommended it's legal to use $ in a class name) then Indexer decodes the DotName as:

componentized	true	
innerClass	true	
local	"" (id=108)	
prefix	DotName  (id=111)	
   componentized	true	
   innerClass	true	
   local	"Test" (id=117)
   prefix	DotName  (id=86)	
      componentized	true	
      innerClass	false	
      local	"test" (id=130)	
      prefix	DotName  (id=131)	
         ...

The toString() of the DotName is org.jboss.jandex.test.IndexerTestCase$Test$ however the equals() method does not match the following:

DotName org = DotName.createComponentized(null, "org");
DotName jboss = DotName.createComponentized(org, "jboss");
DotName jandex = DotName.createComponentized(jboss, "jandex");
DotName test = DotName.createComponentized(jandex, "test");
DotName indexerTestCase = DotName.createComponentized(test, "IndexerTestCase");
DotName testName = DotName.createComponentized(indexerTestCase, Test$.class.getSimpleName(), true);

whose toString() is also org.jboss.jandex.test.IndexerTestCase$Test$.

Maybe I'm missing something obvious.

Martin Kouba · Answer 1 · Wed Dec 02 2020 19:54:26 GMT+0800 (China Standard Time)

CC @Sanne @n1hility

Martin Kouba · Answer 2 · Wed Dec 02 2020 19:56:21 GMT+0800 (China Standard Time)

A test case is available in my branch: https://github.com/mkouba/jandex/tree/issue-97

Jason T. Greene · Answer 3 · Fri Dec 04 2020 13:36:05 GMT+0800 (China Standard Time)

thanks will check it out

Tobias Unger · Answer 4 · Wed Dec 23 2020 04:39:24 GMT+0800 (China Standard Time)

At least the test execution is now successful.

Tobias Unger · Answer 5 · Fri Dec 25 2020 04:25:49 GMT+0800 (China Standard Time)

I think a general solution should take into account the InnerClasses Attribute of the class file and iterate through the outer classes which are already parsed.

msogrin · Answer 6 · Tue Jun 08 2021 23:19:41 GMT+0800 (China Standard Time)

Any chance of a fix?
This bug breaks Quarkus compatibility with Scala (at least with Scala 2.13) which has several classes ending with $ in its standard library.

Ladislav Thon · Answer 7 · Thu Aug 12 2021 21:51:44 GMT+0800 (China Standard Time)

I'm looking at the idea of using the InnerClasses attribute and while I agree it would be the best way to do it, I also believe doing that would require a major overhaul of the indexing algorithm. The ClassFile attributes are stored at the very end of the class file, and we [currently] [have to] parse names way before reaching that point. So it's currently not practical, unfortunately.

Martin Kouba · Answer 8 · Thu Aug 26 2021 15:39:23 GMT+0800 (China Standard Time)

Do we really want to close this issue? IIUIC that PR does not solve the problem, or?

Ladislav Thon · Answer 9 · Thu Aug 26 2021 15:41:32 GMT+0800 (China Standard Time)

It does solve the problem -- for a class name that ends with a single $ :-)

Martin Kouba · Answer 10 · Thu Aug 26 2021 15:45:04 GMT+0800 (China Standard Time)

It does solve the problem -- for a class name that ends with a single $ :-)

Ok, how about multiple $? :D

No, I'm fine if you say it does solve the problem. Let's keep the issue closed.

Ladislav Thon · Answer 11 · Thu Aug 26 2021 16:00:26 GMT+0800 (China Standard Time)

It's been a few days, so I don't have it fresh in memory, but if I recall correctly, I couldn't find a proper solution that wouldn't use the InnerClasses attribute, and that would require a huge refactoring (or parsing the class file twice).