phorge / src / applications / files / diff / PhabricatorDocumentEngineBlocks.php

<?php

final class PhabricatorDocumentEngineBlocks
  extends Phobject {

  private $lists = array();
  private $messages = array();
  private $rangeMin;
  private $rangeMax;
  private $revealedIndexes;
  private $layoutAvailableRowCount;

  public function setRange($min, $max) {
    $this->rangeMin = $min;
    $this->rangeMax = $max;
    return $this;
  }

  public function setRevealedIndexes(array $indexes) {
    $this->revealedIndexes = $indexes;
    return $this;
  }

  public function getLayoutAvailableRowCount() {
    if ($this->layoutAvailableRowCount === null) {
      throw new PhutilInvalidStateException('new...Layout');
    }

    return $this->layoutAvailableRowCount;
  }

  public function addMessage($message) {
    $this->messages[] = $message;
    return $this;
  }

  public function getMessages() {
    return $this->messages;
  }

  /**
   * @param ?PhabricatorDocumentRef $ref
   * @param array<PhabricatorDocumentEngineBlock> $blocks
   */
  public function addBlockList(
    ?PhabricatorDocumentRef $ref = null,
    array $blocks = array()) {

    assert_instances_of($blocks, PhabricatorDocumentEngineBlock::class);

    $this->lists[] = array(
      'ref' => $ref,
      'blocks' => array_values($blocks),
    );

    return $this;
  }

  public function getDocumentRefs() {
    return ipull($this->lists, 'ref');
  }

  public function newTwoUpLayout() {
    $rows = array();
    $lists = $this->lists;

    if (count($lists) != 2) {
      $this->layoutAvailableRowCount = 0;
      return array();
    }

    $specs = array();
    foreach ($this->lists as $list) {
      $specs[] = $this->newDiffSpec($list['blocks']);
    }

    $old_map = $specs[0]['map'];
    $new_map = $specs[1]['map'];

    $old_list = $specs[0]['list'];
    $new_list = $specs[1]['list'];

    $changeset = id(new PhabricatorDifferenceEngine())
      ->generateChangesetFromFileContent($old_list, $new_list);

    $hunk_parser = id(new DifferentialHunkParser())
      ->parseHunksForLineData($changeset->getHunks())
      ->reparseHunksForSpecialAttributes();

    $hunk_parser->generateVisibleBlocksMask(2);
    $mask = $hunk_parser->getVisibleLinesMask();

    $old_lines = $hunk_parser->getOldLines();
    $new_lines = $hunk_parser->getNewLines();

    $rows = array();

    $count = count($old_lines);
    for ($ii = 0; $ii < $count; $ii++) {
      $old_line = idx($old_lines, $ii);
      $new_line = idx($new_lines, $ii);

      $is_visible = !empty($mask[$ii]);

      if ($old_line) {
        $old_hash = rtrim($old_line['text'], "\n");
        if (!strlen($old_hash)) {
          // This can happen when one of the sources has no blocks.
          $old_block = null;
        } else {
          $old_block = array_shift($old_map[$old_hash]);
          $old_block
            ->setDifferenceType($old_line['type'])
            ->setIsVisible($is_visible);
        }
      } else {
        $old_block = null;
      }

      if ($new_line) {
        $new_hash = rtrim($new_line['text'], "\n");
        if (!strlen($new_hash)) {
          $new_block = null;
        } else {
          $new_block = array_shift($new_map[$new_hash]);
          $new_block
            ->setDifferenceType($new_line['type'])
            ->setIsVisible($is_visible);
        }
      } else {
        $new_block = null;
      }

      // If both lists are empty, we may generate a row which has two empty
      // blocks.
      if (!$old_block && !$new_block) {
        continue;
      }

      $rows[] = array(
        $old_block,
        $new_block,
      );
    }

    $this->layoutAvailableRowCount = count($rows);

    $rows = $this->revealIndexes($rows, true);
    $rows = $this->sliceRows($rows);

    return $rows;
  }

  public function newOneUpLayout() {
    $rows = array();
    $lists = $this->lists;

    $idx = 0;
    while (true) {
      $found_any = false;

      $row = array();
      foreach ($lists as $list) {
        $blocks = $list['blocks'];
        $cell = idx($blocks, $idx);

        if ($cell !== null) {
          $found_any = true;
        }

        if ($cell) {
          $rows[] = $cell;
        }
      }

      if (!$found_any) {
        break;
      }

      $idx++;
    }

    $this->layoutAvailableRowCount = count($rows);

    $rows = $this->revealIndexes($rows, false);
    $rows = $this->sliceRows($rows);

    return $rows;
  }


  private function newDiffSpec(array $blocks) {
    $map = array();
    $list = array();

    foreach ($blocks as $block) {
      $hash = $block->getDifferenceHash();

      if (!isset($map[$hash])) {
        $map[$hash] = array();
      }
      $map[$hash][] = $block;

      $list[] = $hash;
    }

    return array(
      'map' => $map,
      'list' => implode("\n", $list)."\n",
    );
  }

  private function sliceRows(array $rows) {
    $min = $this->rangeMin;
    $max = $this->rangeMax;

    if ($min === null && $max === null) {
      return $rows;
    }

    if ($max === null) {
      return array_slice($rows, $min, null, true);
    }

    if ($min === null) {
      $min = 0;
    }

    return array_slice($rows, $min, $max - $min, true);
  }

  private function revealIndexes(array $rows, $is_vector) {
    if ($this->revealedIndexes === null) {
      return $rows;
    }

    foreach ($this->revealedIndexes as $index) {
      if (!isset($rows[$index])) {
        continue;
      }

      if ($is_vector) {
        foreach ($rows[$index] as $block) {
          if ($block !== null) {
            $block->setIsVisible(true);
          }
        }
      } else {
        $rows[$index]->setIsVisible(true);
      }
    }

    return $rows;
  }

}