Short string representation of TypePointer in AST JSON

[erak]

Fixes #3567

[axic]

Please adjusts (or add) tests for this.

[erak]

@axic Added missing tests.

[chriseth]

Looks good to me!

[axic]

Please check the resulting typeString (and typeIdentifier). It is a good idea to take all examples from the initial issue.

[erak]

@axic I've realised that the tests used the legacy AST output instead of the new compact one. That's the reason why checks for typeName and typeString were missing. I've changed that...

Not sure about t_array$_t_array$_t_uint256_$dyn_storage_$dyn_storage_ptr for uint[][] memory rows;. It still looks wrong, but I wasn't sure how to fix the richIdentifier for ArrayType.

@chriseth What do you think about this remaing issue?

[chriseth]

The rich identifier is fine, it is only important that it is really unique. They are not really exposed to the user as much as the other stuff is.

[axic]

Please have at least two cases, one which triggers _short = false and one which triggers _short = true.

[axic]

Basically just extend all the other test cases with typeIdentifier expectation if they define a type.

[erak]

@axic The JSON AST tests are using the legacy JSON output. That's why you won't find typeIdentifier but rather typeName and type. Actually those do not cover my changes since they only apply when using solc --ast-compact-json. I think changing the tests such that they use the new output could be done while deprecating the legacy output for 0.5.0.

I think I'd rather add some tests that cover non-shortened type pointer as you suggested.

[axic]

The JSON AST tests are using the legacy JSON output.

In that case I think we should introduce two sub suites to group the legacy and the "compact" tests.

[erak]

Great idea, will do that!

[axic]

I actually meant that there can be multiple sub-levels of BOOST_AUTO_TEST_SUITE(<name>) within a single suite.

Also the case documentation contains both legacy and non-legacy tests, probably needs to be split into two.

[erak]

@axic Ok, my idea was to split them into 2 files right away, in order to not end up with a very large one at some point. But if you prefer a single file with multiple sub-suites, I'll put it back. I don't have a stong opinion on that.

I've pulled out the legacy part of the documentation test. Did I miss something?

[axic]

I don't have any preference, but if it is a split file I'd name it ASTLegacyJSON.

[erak]

@axic I've renamed the legacy file / suite and added two tests that cover long typeDescriptions for binary operations and identifiers.

[chriseth]

Please add a changelog entry.

[ekpyron]

Looks fine to me now!

[ekpyron]

Rebased.

[chriseth]

This should be a bugfix, and perhaps also phrased differently for the changelog: Remove storage qualifier for type name strings.

[chriseth]

Sorry, please rebase.

Should be fine now.