tree-sitter/spec/runtime/node_spec.cc

#include "runtime/runtime_spec_helper.h"

extern "C" TSLanguage * ts_language_json();

START_TEST

describe("Node", []() {
  TSDocument *document;
  TSNode array_node;

  before_each([&]() {
    document = ts_document_make();
    ts_document_set_language(document, ts_language_json());
    ts_document_set_input_string(document, "  [123, false, {\"x\": null}]");
    array_node = ts_document_root_node(document);
    AssertThat(ts_node_string(array_node, document), Equals(
      "(array "
        "(number) "
        "(false) "
        "(object (string) (null)))"));
  });

  after_each([&]() {
    ts_document_free(document);
  });

  describe("child_count()", [&]() {
    it("returns the number of visible child nodes", [&]() {
      AssertThat(ts_node_child_count(array_node), Equals<size_t>(3));
    });
  });

  describe("child(i)", [&]() {
    it("returns the child node at the given index", [&]() {
      TSNode child1 = ts_node_child(array_node, 0);
      TSNode child2 = ts_node_child(array_node, 1);
      TSNode child3 = ts_node_child(array_node, 2);

      AssertThat(ts_node_name(array_node, document), Equals("array"));
      AssertThat(ts_node_name(child1, document), Equals("number"));
      AssertThat(ts_node_name(child2, document), Equals("false"));
      AssertThat(ts_node_name(child3, document), Equals("object"));

      AssertThat(ts_node_pos(array_node).bytes, Equals<size_t>(2));
      AssertThat(ts_node_size(array_node).bytes, Equals<size_t>(25));

      AssertThat(ts_node_pos(child1).bytes, Equals<size_t>(3));
      AssertThat(ts_node_size(child1).bytes, Equals<size_t>(3));

      AssertThat(ts_node_pos(child2).bytes, Equals<size_t>(8));
      AssertThat(ts_node_size(child2).bytes, Equals<size_t>(5));

      AssertThat(ts_node_pos(child3).bytes, Equals<size_t>(15));
      AssertThat(ts_node_size(child3).bytes, Equals<size_t>(11));

      AssertThat(ts_node_parent(child1), Equals(array_node));
      AssertThat(ts_node_parent(child2), Equals(array_node));
      AssertThat(ts_node_parent(child3), Equals(array_node));
      AssertThat(ts_node_parent(array_node).data, Equals<void *>(nullptr));
    });
  });

  describe("next_sibling() and prev_sibling()", [&]() {
    it("returns the node's next and previous siblings", [&]() {
      TSNode number_node = ts_node_child(array_node, 0);
      TSNode false_node = ts_node_child(array_node, 1);
      TSNode object_node = ts_node_child(array_node, 2);
      TSNode string_node = ts_node_child(object_node, 0);
      TSNode null_node = ts_node_child(object_node, 1);

      AssertThat(ts_node_next_sibling(number_node), Equals(false_node));
      AssertThat(ts_node_next_sibling(false_node), Equals(object_node));
      AssertThat(ts_node_next_sibling(string_node), Equals(null_node));
      AssertThat(ts_node_prev_sibling(object_node), Equals(false_node));
      AssertThat(ts_node_prev_sibling(false_node), Equals(number_node));
      AssertThat(ts_node_prev_sibling(null_node), Equals(string_node));
    });

    it("returns null when the node has no parent", [&]() {
      AssertThat(ts_node_next_sibling(array_node).data, Equals<void *>(nullptr));
      AssertThat(ts_node_prev_sibling(array_node).data, Equals<void *>(nullptr));
      AssertThat(ts_node_next_sibling(array_node).data, Equals<void *>(nullptr));
      AssertThat(ts_node_prev_sibling(array_node).data, Equals<void *>(nullptr));
    });
  });

  describe("find_for_range(start, end)", [&]() {
    describe("when there is a leaf node that spans the given range exactly", [&]() {
      it("returns that leaf node", [&]() {
        TSNode leaf = ts_node_find_for_range(array_node, 16, 18);
        AssertThat(ts_node_name(leaf, document), Equals("string"));
        AssertThat(ts_node_size(leaf).bytes, Equals<size_t>(3));
        AssertThat(ts_node_pos(leaf).bytes, Equals<size_t>(16));

        leaf = ts_node_find_for_range(array_node, 3, 5);
        AssertThat(ts_node_name(leaf, document), Equals("number"));
        AssertThat(ts_node_size(leaf).bytes, Equals<size_t>(3));
        AssertThat(ts_node_pos(leaf).bytes, Equals<size_t>(3));
      });
    });

    describe("when there is a leaf node that extends beyond the given range", [&]() {
      it("returns that leaf node", [&]() {
        TSNode leaf = ts_node_find_for_range(array_node, 16, 17);
        AssertThat(ts_node_name(leaf, document), Equals("string"));
        AssertThat(ts_node_size(leaf).bytes, Equals<size_t>(3));
        AssertThat(ts_node_pos(leaf).bytes, Equals<size_t>(16));

        leaf = ts_node_find_for_range(array_node, 17, 18);
        AssertThat(ts_node_name(leaf, document), Equals("string"));
        AssertThat(ts_node_size(leaf).bytes, Equals<size_t>(3));
        AssertThat(ts_node_pos(leaf).bytes, Equals<size_t>(16));
      });
    });

    describe("when there is no leaf node that spans the given range", [&]() {
      it("returns the smallest node that does span the range", [&]() {
        TSNode node = ts_node_find_for_range(array_node, 16, 19);
        AssertThat(ts_node_name(node, document), Equals("object"));
        AssertThat(ts_node_size(node).bytes, Equals<size_t>(11));
        AssertThat(ts_node_pos(node).bytes, Equals<size_t>(15));
      });

      it("does not return invisible nodes (repeats)", [&]() {
        TSNode node = ts_node_find_for_range(array_node, 6, 7);
        AssertThat(ts_node_name(node, document), Equals("array"));
        AssertThat(ts_node_size(node).bytes, Equals<size_t>(25));
        AssertThat(ts_node_pos(node).bytes, Equals<size_t>(2));
      });
    });
  });

  describe("find_for_pos(position)", [&]() {
    it("finds the smallest node that spans the given position", [&]() {
      TSNode node = ts_node_find_for_pos(array_node, 10);
      AssertThat(ts_node_name(node, document), Equals("false"));
      AssertThat(ts_node_pos(node).bytes, Equals<size_t>(8));
      AssertThat(ts_node_size(node).bytes, Equals<size_t>(5));
    });
  });
});

END_TEST

bool operator==(const TSNode &left, const TSNode &right) {
  return ts_node_eq(left, right);
}