pkg/analysis_server/lib/src/lsp/handlers/handler_document_color_presentation.dart

// Copyright (c) 2021, 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:analysis_server/lsp_protocol/protocol_generated.dart';
import 'package:analysis_server/lsp_protocol/protocol_special.dart';
import 'package:analysis_server/src/lsp/handlers/handlers.dart';
import 'package:analysis_server/src/lsp/lsp_analysis_server.dart';
import 'package:analysis_server/src/lsp/mapping.dart';
import 'package:analysis_server/src/utilities/flutter.dart';
import 'package:analyzer/dart/analysis/results.dart';
import 'package:analyzer/dart/element/element.dart';
import 'package:analyzer/source/source_range.dart';
import 'package:analyzer/src/dart/analysis/session_helper.dart';
import 'package:analyzer_plugin/utilities/change_builder/change_builder_core.dart';

/// Handles textDocument/colorPresentation.
///
/// This request is sent by the client if it allowed the user to pick a color
/// using a color picker (in a location returned by textDocument/documentColor)
/// and needs a representation of this color, including the edits to insert it
/// into the source file.
class DocumentColorPresentationHandler
    extends MessageHandler<ColorPresentationParams, List<ColorPresentation>> {
  DocumentColorPresentationHandler(LspAnalysisServer server) : super(server);
  @override
  Method get handlesMessage => Method.textDocument_colorPresentation;

  @override
  LspJsonHandler<ColorPresentationParams> get jsonHandler =>
      ColorPresentationParams.jsonHandler;

  @override
  Future<ErrorOr<List<ColorPresentation>>> handle(
    ColorPresentationParams params,
    CancellationToken token,
  ) async {
    if (!isDartDocument(params.textDocument)) {
      return success([]);
    }

    final path = pathOfDoc(params.textDocument);
    final unit = await path.mapResult(requireResolvedUnit);
    return unit.mapResult((unit) => _getPresentations(params, unit));
  }

  /// Converts individual 0-255 ARGB values into a single int value as
  /// 0xAARRGGBB as used by the dart:ui Color class.
  int _colorValueForComponents(int alpha, int red, int green, int blue) {
    return (alpha << 24) | (red << 16) | (green << 8) | (blue << 0);
  }

  /// Creates a [ColorPresentation] for inserting code to produce a dart:ui
  /// or Flutter Color at [editRange].
  ///
  /// [colorType] is the Type of the Color class whose constructor will be
  /// called. This will be replaced into [editRange] and any required import
  /// statement will produce additional edits.
  ///
  /// [label] is the visible label shown to the user and should roughly reflect
  /// the code that will be inserted.
  ///
  /// [invocationString] is written immediately after [colorType] in [editRange].
  Future<ColorPresentation> _createColorPresentation(
    ResolvedUnitResult unit,
    SourceRange editRange,
    ClassElement colorType,
    String label,
    String invocationString,
  ) async {
    final builder = ChangeBuilder(session: unit.session);
    await builder.addDartFileEdit(unit.path, (builder) {
      builder.addReplacement(editRange, (builder) {
        builder.writeType(colorType.thisType);
        builder.write(invocationString);
      });
    });

    // We can only apply changes to the same file, so filter any change from the
    // builder to only include this file, otherwise we may corrupt the users
    // source (although hopefully we don't produce edits for other files).
    final editsForThisFile = builder.sourceChange.edits
        .where((edit) => edit.file == unit.path)
        .expand((edit) => edit.edits)
        .toList();

    // LSP requires that we separate the main edit (changing the color code)
    // from anything else (imports).
    final mainEdit =
        editsForThisFile.singleWhere((edit) => edit.offset == editRange.offset);
    final otherEdits =
        editsForThisFile.where((edit) => edit.offset != editRange.offset);

    return ColorPresentation(
      label: label,
      textEdit: toTextEdit(unit.lineInfo, mainEdit),
      additionalTextEdits: otherEdits.isNotEmpty
          ? otherEdits.map((edit) => toTextEdit(unit.lineInfo, edit)).toList()
          : null,
    );
  }

  /// Builds a list of valid color presentations for the requested color.
  Future<ErrorOr<List<ColorPresentation>>> _getPresentations(
    ColorPresentationParams params,
    ResolvedUnitResult unit,
  ) async {
    // The values in LSP are decimals 0-1 so should be scaled up to 255 that
    // we use internally (except for opacity is which 0-1).
    final alpha = (params.color.alpha * 255).toInt();
    final red = (params.color.red * 255).toInt();
    final green = (params.color.green * 255).toInt();
    final blue = (params.color.blue * 255).toInt();
    final opacity = params.color.alpha;

    final editStart = toOffset(unit.lineInfo, params.range.start);
    final editEnd = toOffset(unit.lineInfo, params.range.end);

    if (editStart.isError) return failure(editStart);
    if (editEnd.isError) return failure(editEnd);

    final editRange =
        SourceRange(editStart.result, editEnd.result - editStart.result);

    final sessionHelper = AnalysisSessionHelper(unit.session);
    final analysisContext = unit.session.analysisContext;
    final flutter = Flutter.instance;
    final colorType = await sessionHelper.getClass(flutter.widgetsUri, 'Color');
    if (colorType == null) {
      // If we can't find the class (perhaps because this isn't a Flutter
      // project) we will not include any results. In theory the client should
      // not be calling this request in that case.
      return success([]);
    }

    // If this file is outside of analysis roots, we cannot build edits for it
    // so return null to signal to the client that it should not try to modify
    // the source.
    if (!analysisContext.contextRoot.isAnalyzed(unit.path)) {
      return success([]);
    }

    final colorValue = _colorValueForComponents(alpha, red, green, blue);
    final colorValueHex =
        '0x${colorValue.toRadixString(16).toUpperCase().padLeft(8, '0')}';

    final colorFromARGB = await _createColorPresentation(
      unit,
      editRange,
      colorType,
      'Color.fromARGB($alpha, $red, $green, $blue)',
      '.fromARGB($alpha, $red, $green, $blue)',
    );

    final colorFromRGBO = await _createColorPresentation(
      unit,
      editRange,
      colorType,
      'Color.fromRGBO($red, $green, $blue, $opacity)',
      '.fromRGBO($red, $green, $blue, $opacity)',
    );

    final colorDefault = await _createColorPresentation(
      unit,
      editRange,
      colorType,
      'Color($colorValueHex)',
      '($colorValueHex)',
    );

    return success([
      colorFromARGB,
      colorFromRGBO,
      colorDefault,
    ]);
  }
}