Method iterateLinesInBlock

src/textEditor.ts:209–243

* Iterate over every line in the block defined by the two positions (Range) passed in. * If no range is given, the primary cursor will be used as the block. * * This is intended for visual block mode.

(
    vimState: VimState,
    cursor?: Cursor,
    options: { reverse?: boolean } = { reverse: false },
  )

   * This is intended for visual block mode.
   */
  public static *iterateLinesInBlock(
    vimState: VimState,
    cursor?: Cursor,
    options: { reverse?: boolean } = { reverse: false },
  ): Iterable<{ line: string; start: Position; end: Position }> {
    const { reverse } = options;

    cursor ??= vimState.cursors[0];

    const topLeft = visualBlockGetTopLeftPosition(cursor.start, cursor.stop);
    const bottomRight = visualBlockGetBottomRightPosition(cursor.start, cursor.stop);

    const [itrStart, itrEnd] = reverse
      ? [bottomRight.line, topLeft.line]
      : [topLeft.line, bottomRight.line];

    const runToLineEnd = vimState.desiredColumn === Number.POSITIVE_INFINITY;

    for (
      let lineIndex = itrStart;
      reverse ? lineIndex >= itrEnd : lineIndex <= itrEnd;
      reverse ? lineIndex-- : lineIndex++
    ) {
      const line = vimState.document.lineAt(lineIndex).text;
      const endCharacter = runToLineEnd
        ? line.length + 1
        : Math.min(line.length, bottomRight.character + 1);

      yield {
        line: line.substring(topLeft.character, endCharacter),
        start: new Position(lineIndex, topLeft.character),
        end: new Position(lineIndex, endCharacter),
      };
    }
  }

  /**
   * Iterates through words on the same line, starting from the current position.