[all-commits] [llvm/llvm-project] f63e3e: [clang] Rework how and when APValues are dumped

[Bruno Ricci via All-commits]

  Branch: refs/heads/master
  Home:   https://github.com/llvm/llvm-project
  Commit: f63e3ea558bbe14826b5b775367eac617b35e041
      https://github.com/llvm/llvm-project/commit/f63e3ea558bbe14826b5b775367eac617b35e041
  Author: Bruno Ricci <riccibrun at gmail.com>
  Date:   2020-07-06 (Mon, 06 Jul 2020)

  Changed paths:
    M clang/include/clang/AST/APValue.h
    M clang/include/clang/AST/ASTNodeTraverser.h
    M clang/include/clang/AST/JSONNodeDumper.h
    M clang/include/clang/AST/TextNodeDumper.h
    M clang/lib/AST/APValue.cpp
    M clang/lib/AST/ASTDumper.cpp
    M clang/lib/AST/JSONNodeDumper.cpp
    M clang/lib/AST/TextNodeDumper.cpp
    M clang/test/AST/alignas_maybe_odr_cleanup.cpp
    A clang/test/AST/ast-dump-APValue-anon-union.cpp
    A clang/test/AST/ast-dump-APValue-arithmetic.cpp
    A clang/test/AST/ast-dump-APValue-array.cpp
    A clang/test/AST/ast-dump-APValue-struct.cpp
    A clang/test/AST/ast-dump-APValue-todo.cpp
    A clang/test/AST/ast-dump-APValue-union.cpp
    A clang/test/AST/ast-dump-APValue-vector.cpp
    M clang/test/AST/ast-dump-attr.cpp
    M clang/test/AST/ast-dump-color.cpp
    M clang/test/AST/ast-dump-constant-expr.cpp
    M clang/test/AST/ast-dump-decl.cpp
    M clang/test/AST/ast-dump-records.cpp
    M clang/test/AST/ast-dump-stmt.cpp
    M clang/test/AST/pr43983.cpp
    M clang/test/Import/switch-stmt/test.cpp
    M clang/test/Tooling/clang-check-ast-dump.cpp

  Log Message:
  -----------
  [clang] Rework how and when APValues are dumped

Currently APValues are dumped as a single string. This becomes quickly
completely unreadable since APValue is a tree-like structure. Even a simple
example is not pretty:

  struct S { int arr[4]; float f; };
  constexpr S s = { .arr = {1,2}, .f = 3.1415f };
  // Struct  fields: Array: Int: 1, Int: 2, 2 x Int: 0, Float: 3.141500e+00

With this patch this becomes:

  -Struct
   |-field: Array size=4
   | |-elements: Int 1, Int 2
   | `-filler: 2 x Int 0
   `-field: Float 3.141500e+00

Additionally APValues are currently only dumped as part of visiting a
ConstantExpr. This patch also dump the value of the initializer of constexpr
variable declarations:

  constexpr int foo(int a, int b) { return a + b - 42; }
  constexpr int a = 1, b = 2;
  constexpr int c = foo(a, b) > 0 ? foo(a, b) : foo(b, a);
  // VarDecl 0x62100008aec8 <col:3, col:57> col:17 c 'const int' constexpr cinit
  // |-value: Int -39
  // `-ConditionalOperator 0x62100008b4d0 <col:21, col:57> 'int'
  // <snip>

Do the above by moving the dump functions to TextNodeDumper which already has
the machinery to display trees. The cases APValue::LValue, APValue::MemberPointer
and APValue::AddrLabelDiff are left as they were before (unimplemented).

We try to display multiple elements on the same line if they are considered to
be "simple". This is to avoid wasting large amounts of vertical space in an
example like:

  constexpr int arr[8] = {0,1,2,3,4,5,6,7};
  // VarDecl 0x62100008bb78 <col:3, col:42> col:17 arr 'int const[8]' constexpr cinit
  // |-value: Array size=8
  // | |-elements: Int 0, Int 1, Int 2, Int 3
  // | `-elements: Int 4, Int 5, Int 6, Int 7

Differential Revision: https://reviews.llvm.org/D83183

Reviewed By: aaron.ballman