org.sonarsource.sonarlint.ls.notebooks.NotebookUtils Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of sonarlint-language-server Show documentation
SonarLint Language Server
There is a newer version: 3.12.0.75621
Show newest version
/*
 * SonarLint Language Server
 * Copyright (C) 2009-2024 SonarSource SA
 * mailto:info AT sonarsource DOT com
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 3 of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 */
package org.sonarsource.sonarlint.ls.notebooks;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.Comparator;
import java.util.List;
import java.util.Map;
import org.eclipse.lsp4j.Position;
import org.eclipse.lsp4j.Range;
import org.eclipse.lsp4j.TextDocumentContentChangeEvent;
import org.eclipse.lsp4j.TextDocumentItem;
import org.sonarsource.sonarlint.core.rpc.protocol.common.TextRangeDto;

public class NotebookUtils {

  private NotebookUtils() {
    // Static utility method only
  }

  public static String applyChangeToCellContent(TextDocumentItem originalCell, List textChanges) {
    var cellLines = Arrays.asList(originalCell.getText().split("\n", -1));
    var updatedCellLines = new ArrayList();

    var sortedChanges = new ArrayList<>(textChanges);
    sortedChanges.sort(
      Comparator.comparingInt(change -> change.getRange().getStart().getLine())
        .thenComparingInt(change -> change.getRange().getStart().getCharacter())
    );

    var currentLine = 0;
    var appliedChangesRangeLengthTotal = 0;
    var appliedChangesTextLengthTotal = 0;

    for (var i = 0; i < sortedChanges.size(); i++) {
      var textChange = sortedChanges.get(i);
      var rangeStartLine = textChange.getRange().getStart().getLine();
      var rangeEndLine = textChange.getRange().getEnd().getLine();

      currentLine = addUnchangedLinesBeforeFirstChange(currentLine, updatedCellLines, cellLines, rangeStartLine);
      var modifiedRangeText = getModifiedRangeText(cellLines, currentLine, textChange);

      if (thereWasChangeOnSameLine(sortedChanges, i, rangeStartLine)) {
        updatedCellLines.set(currentLine, modifiedRangeText);
      } else {
        updatedCellLines.add(modifiedRangeText);
      }

      if (thereIsAnotherChangeOnSameLine(sortedChanges, i, rangeStartLine)) {
        appliedChangesRangeLengthTotal += textChange.getRange().getEnd().getCharacter() - textChange.getRange().getStart().getCharacter();
        appliedChangesTextLengthTotal += textChange.getText().length();
        cellLines.set(currentLine, updatedCellLines.get(currentLine));
        // The line was modified, the original range that we got from the IDE needs to be adjusted
        sortedChanges.get(i + 1).setRange(adjustRange(sortedChanges.get(i + 1).getRange(), appliedChangesRangeLengthTotal, appliedChangesTextLengthTotal));
      } else {
        currentLine = rangeEndLine + 1;
      }
    }

    addUnchangedLinesAfterLastChange(currentLine, updatedCellLines, cellLines);

    return String.join("\n", updatedCellLines);
  }

  private static boolean thereWasChangeOnSameLine(ArrayList sortedChanges, int i, int rangeStartLine) {
    return i - 1 >= 0 && sortedChanges.get(i - 1).getRange().getStart().getLine() == rangeStartLine;
  }

  private static boolean thereIsAnotherChangeOnSameLine(ArrayList sortedChanges, int i, int rangeStartLine) {
    return i + 1 < sortedChanges.size() && sortedChanges.get(i + 1).getRange().getStart().getLine() == rangeStartLine;
  }

  static void addUnchangedLinesAfterLastChange(int currentLine, ArrayList modifiedLines, List cellLines) {
    while (currentLine < cellLines.size()) {
      modifiedLines.add(cellLines.get(currentLine));
      currentLine++;
    }
  }

  static int addUnchangedLinesBeforeFirstChange(int currentLine, ArrayList modifiedLines, List cellLines, int rangeStartLine) {
    while (currentLine < rangeStartLine) {
      modifiedLines.add(cellLines.get(currentLine));
      currentLine++;
    }
    return currentLine;
  }

  static String getModifiedRangeText(List cellLines, int currentLine, TextDocumentContentChangeEvent textChange) {
    var rangeStartLineOffset = textChange.getRange().getStart().getCharacter();
    var rangeEndLine = textChange.getRange().getEnd().getLine();
    var rangeEndLineOffset = textChange.getRange().getEnd().getCharacter();
    String modifiedRangeText;
    if (currentLine < cellLines.size()) {
      var textBeforeChange = cellLines.get(currentLine).substring(0, rangeStartLineOffset);
      var textAfterChange = cellLines.get(rangeEndLine).substring(rangeEndLineOffset);
      modifiedRangeText = textBeforeChange + textChange.getText() + textAfterChange;
    } else {
      // Newline added
      modifiedRangeText = textChange.getText();
    }
    return modifiedRangeText;
  }

  private static Range adjustRange(Range originalRange, int totalAppliedChangesRangeLength, int totalAppliedChangesTextLength) {
    var totalRangeShift = totalAppliedChangesRangeLength - totalAppliedChangesTextLength;
    var start = new Position(originalRange.getStart().getLine(), originalRange.getStart().getCharacter() - totalRangeShift);
    var end = new Position(originalRange.getEnd().getLine(), originalRange.getEnd().getCharacter() - totalRangeShift);
    return new Range(start, end);
  }

  public static TextRangeDto fileTextRangeToCellTextRange(int fileStartLine, int fileStartLineOffset,
    int fileEndLine, int fileEndLineOffset, Map virtualFileLineToCellLine) {
    var cellStartLine = virtualFileLineToCellLine.get(fileStartLine);
    var cellEndLine = virtualFileLineToCellLine.get(fileEndLine);

    return new TextRangeDto(cellStartLine, fileStartLineOffset, cellEndLine, fileEndLineOffset);
  }
}