This is an archive of the discontinued LLVM Phabricator instance.

[Syntax] Remove delayed folding from tree building.
ClosedPublic

Authored by hlopko on Mar 27 2020, 6:57 AM.

Details

Summary

This patch removes delayed folding and replaces it with forward peeking.

Delayed folding was previously used as a solution to the problem that
declaration doesn't have a representation in the AST. For example following
code:

int a,b;

is expressed in the AST as:

TranslationUnitDecl
|-...
|-VarDecl `int a`
`-VarDecl `int b`

And in the syntax tree we need:

*: TranslationUnit
`-SimpleDeclaration
  |-int
  |-SimpleDeclarator
  | `-a
  |-,
  |-SimpleDeclarator
  | `-b
  |-;

So in words, we need to create SimpleDeclaration to be a parent of
SimpleDeclarator nodes. Previously we used delayed folding to make sure SimpleDeclarations will be
eventually created. And in case multiple declarators requested declaration
creation, declaration range was extended to cover all declarators.

This design started to be hard to reason about, so we decided to replace it with
forward peeking. The last declarator node in the chain is responsible for creating
SimpleDeclaration for the whole chain. Range of the declaration corresponds to
the source range of the declarator node. Declarator decides whether its the last
one by peeking to the next AST node (see isResponsibleForCreatingDeclaration).

This patch does following:

  • Removed delayed folding logic
  • Tweaks Token.dumpForTests
  • Moves getQualifiedNameStart inside BuildTreeVisitor
  • Extracts BuildTreeVisitor.ProcessDeclaratorAndDeclaration
  • Renames Builder.getDeclRange to Builder.getDeclarationRange and uses the method in all places.
  • Adds a bunch of tests

Diff Detail

Event Timeline

hlopko created this revision.Mar 27 2020, 6:57 AM
Herald added a project: Restricted Project. · View Herald TranscriptMar 27 2020, 6:57 AM
Herald added a subscriber: cfe-commits. · View Herald Transcript
hlopko updated this revision to Diff 253108.Mar 27 2020, 6:59 AM

Reformat

hlopko edited the summary of this revision. (Show Details)Mar 27 2020, 6:59 AM
gribozavr2 accepted this revision.Mar 30 2020, 7:25 AM

Could you add the following tests?

struct Point { int x, y; } point, *pointPtr;
typedef struct Point { int x, y; } PointTy, *PointPtr;
typedef struct { int x, y; } PointTy, *PointPtr;
clang/lib/Tooling/Syntax/BuildTree.cpp
279

I think this cast should not be necessary -- D is already a const T*.

This revision is now accepted and ready to land.Mar 30 2020, 7:25 AM
hlopko updated this revision to Diff 253787.Mar 30 2020, 11:59 PM
hlopko marked an inline comment as done.

Remove unnecessary cast

I propose adding those tests in a separate patch to keep this one focused. Those tests are currently failing, because:

  • we assume initializer, if present, is extending the declarator range, but struct P {} p; has initializer ending where declarator ended already.
  • UnknownExpressions finds its way inside SimpleDeclarator for p in struct P {} p, *pp;
  • typedefs also fail, unable to find the end of declarator properly. I didn't investigate further.

Fixing those seems worthy of a separate patch.

This revision was automatically updated to reflect the committed changes.