pkg/analyzer/test/src/dart/resolution/dart_object_printer.dart

// Copyright (c) 2022, the Dart project authors. Please see the AUTHORS file
// for details. All rights reserved. Use of this source code is governed by a
// BSD-style license that can be found in the LICENSE file.

import 'package:analyzer/dart/element/type.dart';
import 'package:analyzer/src/dart/constant/value.dart';
import 'package:analyzer_utilities/testing/tree_string_sink.dart';
import 'package:collection/collection.dart';

import '../../../util/element_printer.dart';

/// Prints [DartObjectImpl] as a tree, with values and fields.
class DartObjectPrinter {
  final DartObjectPrinterConfiguration _configuration;
  final TreeStringSink _sink;
  final ElementPrinter _elementPrinter;

  DartObjectPrinter({
    required DartObjectPrinterConfiguration configuration,
    required TreeStringSink sink,
    required ElementPrinter elementPrinter,
  }) : _configuration = configuration,
       _sink = sink,
       _elementPrinter = elementPrinter;

  void write(DartObjectImpl? object) {
    if (object != null) {
      var type = object.type;
      var state = object.state;
      if (object.isUnknown) {
        _sink.write('<unknown> ');
        _elementPrinter.writeType(type);
      } else if (type.isDartCoreBool) {
        _sink.write('bool ');
        _sink.writeln(object.toBoolValue());
      } else if (type.isDartCoreDouble) {
        _sink.write('double ');
        _sink.writeln(object.toDoubleValue());
      } else if (type.isDartCoreInt) {
        _writeInteger(object);
      } else if (type.isDartCoreNull) {
        _sink.writeln('Null null');
      } else if (type.isDartCoreString) {
        _writeString(object);
      } else if (state is FunctionState) {
        _writeFunctionState(type, state);
      } else if (state is GenericState) {
        _writeGenericState(type, state);
      } else if (state is ListState) {
        _writeListState(type, state);
      } else if (state is MapState) {
        _writeMapState(type, state);
      } else if (state is RecordState) {
        _writeRecordState(type, state);
      } else if (state is SetState) {
        _writeSetState(type, state);
      } else if (state is TypeState) {
        _writeTypeObject(object);
      } else {
        throw UnimplementedError();
      }
      _writeConstructorInvocation(object);
      _writeVariable(object);
      _writeTypeNotExtensionTypeErased(object);
    } else {
      _sink.writeln('<null>');
    }
  }

  void _writeConstructorInvocation(DartObjectImpl object) {
    var constructorInvocation = object.constructorInvocation;
    if (constructorInvocation != null) {
      _sink.withIndent(() {
        _sink.writelnWithIndent('constructorInvocation');
        _sink.withIndent(() {
          _elementPrinter.writeNamedElement2(
            'constructor',
            constructorInvocation.constructor,
          );
          _sink.writeElements(
            'positionalArguments',
            constructorInvocation.positionalArguments.indexed.toList(),
            (indexValue) {
              _sink.writeWithIndent('${indexValue.$1}: ');
              write(indexValue.$2);
            },
          );
          _sink.writeElements(
            'namedArguments',
            constructorInvocation.namedArguments.entries.toList(),
            (entry) {
              _sink.writeIndent();
              _sink.write('${entry.key}: ');
              write(entry.value);
            },
          );
        });
      });
    }
  }

  void _writeFunctionState(DartType type, FunctionState state) {
    _elementPrinter.writeType(type);

    _sink.withIndent(() {
      _elementPrinter.writeNamedElement2('element', state.element);
    });

    _writeTypeArguments(state.typeArguments);
  }

  void _writeGenericState(DartType type, GenericState state) {
    _writelnType(type);
    _sink.withIndent(() {
      var fields = state.fields;
      var sortedFields = fields.entries.sortedBy((e) => e.key);
      for (var entry in sortedFields) {
        _sink.writeIndent();
        _sink.write('${entry.key}: ');
        write(entry.value);
      }
    });
  }

  void _writeInteger(DartObjectImpl object) {
    _sink.write('int ');
    var intValue = object.toIntValue();
    if (_configuration.withHexIntegers && intValue != null) {
      _sink.writeln('0x${intValue.toRadixString(16)}');
    } else {
      _sink.writeln(intValue);
    }
  }

  void _writeListState(DartType type, ListState state) {
    _writelnType(type);
    _sink.withIndent(() {
      var elements = state.elements;
      if (elements.isNotEmpty) {
        _sink.writelnWithIndent('elements');
        _sink.withIndent(() {
          for (var element in elements) {
            _sink.writeIndent();
            write(element);
          }
        });
      }
    });
  }

  void _writelnType(DartType type) {
    _elementPrinter.writeType(type);

    if (_configuration.withTypeArguments) {
      if (type is InterfaceType) {
        _writeTypeArguments(type.typeArguments);
      }
    }
  }

  void _writeMapState(DartType type, MapState state) {
    _writelnType(type);
    _sink.withIndent(() {
      var entries = state.entries;
      if (entries.isNotEmpty) {
        _sink.writelnWithIndent('entries');
        _sink.withIndent(() {
          for (var entry in entries.entries) {
            _sink.writelnWithIndent('entry');
            _sink.withIndent(() {
              _sink.writeIndent();
              _sink.write('key: ');
              write(entry.key);

              _sink.writeIndent();
              _sink.write('value: ');
              write(entry.value);
            });
          }
        });
      }
    });
  }

  void _writeRecordState(DartType type, RecordState state) {
    _sink.write('Record');
    _elementPrinter.writeType(type);

    _sink.withIndent(() {
      var positionalFields = state.positionalFields;
      if (positionalFields.isNotEmpty) {
        _sink.writelnWithIndent('positionalFields');
        _sink.withIndent(() {
          positionalFields.forEachIndexed((index, field) {
            _sink.writeIndent();
            _sink.write('\$${index + 1}: ');
            write(field);
          });
        });
      }

      var namedFields = state.namedFields;
      if (namedFields.isNotEmpty) {
        _sink.writelnWithIndent('namedFields');
        _sink.withIndent(() {
          var entries = namedFields.entries.sortedBy((entry) => entry.key);
          for (var entry in entries) {
            _sink.writeIndent();
            _sink.write('${entry.key}: ');
            write(entry.value);
          }
        });
      }
    });
  }

  void _writeSetState(DartType type, SetState state) {
    _writelnType(type);
    _sink.withIndent(() {
      var elements = state.elements;
      if (elements.isNotEmpty) {
        _sink.writelnWithIndent('elements');
        _sink.withIndent(() {
          for (var element in elements) {
            _sink.writeIndent();
            write(element);
          }
        });
      }
    });
  }

  void _writeString(DartObjectImpl object) {
    _sink.write('String ');

    var stringValue = object.toStringValue();
    if (stringValue == null || stringValue.isEmpty) {
      _sink.writeln('<empty>');
    } else {
      _sink.writeln(stringValue);
    }
  }

  void _writeTypeArguments(List<DartType>? typeArguments) {
    _sink.withIndent(() {
      _elementPrinter.writeTypeList('typeArguments', typeArguments);
    });
  }

  void _writeTypeNotExtensionTypeErased(DartObjectImpl object) {
    var typeNotErased = object.typeNotExtensionTypeErased;
    if (typeNotErased != object.type) {
      _sink.withIndent(() {
        _elementPrinter.writeNamedType(
          'typeNotExtensionTypeErased',
          typeNotErased,
        );
      });
    }
  }

  void _writeTypeObject(DartObjectImpl object) {
    _elementPrinter.writeType(object.type);

    _sink.withIndent(() {
      _elementPrinter.writeNamedType('toTypeValue', object.toTypeValue());
      _elementPrinter.writeNamedType(
        'toTypeValueNotExtensionTypeErased',
        object.toTypeValueNotExtensionTypeErased(),
      );
    });
  }

  void _writeVariable(DartObjectImpl object) {
    var variable = object.variable;
    if (variable != null) {
      _sink.withIndent(() {
        _elementPrinter.writeNamedElement2('variable', variable);
      });
    }
  }
}

class DartObjectPrinterConfiguration {
  bool withHexIntegers = false;
  bool withTypeArguments = false;
}