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 *root;

  before_each([&]() {
    document = ts_document_make();
    ts_document_set_language(document, ts_language_json());

    ts_document_set_input_string(document, "  [123, false, {\"x\": null}]");
    root = ts_document_root_node(document);
    AssertThat(ts_node_string(root), Equals(
        "(DOCUMENT (array "
          "(number) "
          "(false) "
          "(object (string) (null))))"));
  });

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

  describe("child_count", [&]() {
    it("returns the number of visible child nodes", [&]() {
      TSNode *array = ts_node_child(root, 0);

      AssertThat(ts_node_child_count(array), Equals<size_t>(3));

      ts_node_release(array);
    });
  });

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

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

      AssertThat(ts_node_pos(parent), Equals<size_t>(2));
      AssertThat(ts_node_size(parent), Equals<size_t>(25));

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

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

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

      ts_node_release(parent);
      ts_node_release(child1);
      ts_node_release(child2);
      ts_node_release(child3);
    });
  });

  describe("parent", [&]() {
    it("returns the node's parent node", [&]() {
      TSNode *array = ts_node_child(root, 0);
      TSNode *child1 = ts_node_child(array, 1);

      AssertThat(ts_node_parent(child1), Equals(array));
      AssertThat(ts_node_parent(array), Equals(root));

      ts_node_release(array);
      ts_node_release(child1);
    });

    it("returns null if the node has no parent", [&]() {
      AssertThat(ts_node_parent(root), Equals<TSNode *>(nullptr));
    });
  });

  describe("next_sibling and prev_sibling", [&]() {
    it("returns the node's next and previous siblings", [&]() {
      TSNode *array = ts_node_child(root, 0);
      TSNode *number1 = ts_node_child(array, 0);
      TSNode *number2 = ts_node_child(array, 1);
      TSNode *number3 = ts_node_child(array, 2);

      AssertThat(ts_node_eq(ts_node_next_sibling(number2), number3), IsTrue());
      AssertThat(ts_node_eq(ts_node_prev_sibling(number2), number1), IsTrue());

      ts_node_release(array);
      ts_node_release(number1);
      ts_node_release(number2);
      ts_node_release(number3);
    });

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

  describe("find_for_range", [&]() {
    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(root, 16, 18);
        AssertThat(ts_node_name(leaf), Equals("string"));
        AssertThat(ts_node_size(leaf), Equals<size_t>(3));
        AssertThat(ts_node_pos(leaf), Equals<size_t>(16));
        ts_node_release(leaf);
      });
    });

    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(root, 16, 17);
        AssertThat(ts_node_name(leaf), Equals("string"));
        AssertThat(ts_node_size(leaf), Equals<size_t>(3));
        AssertThat(ts_node_pos(leaf), Equals<size_t>(16));
        ts_node_release(leaf);

        leaf = ts_node_find_for_range(root, 17, 18);
        AssertThat(ts_node_name(leaf), Equals("string"));
        AssertThat(ts_node_size(leaf), Equals<size_t>(3));
        AssertThat(ts_node_pos(leaf), Equals<size_t>(16));
        ts_node_release(leaf);
      });
    });

    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(root, 16, 19);
        AssertThat(ts_node_name(node), Equals("object"));
        AssertThat(ts_node_size(node), Equals<size_t>(11));
        AssertThat(ts_node_pos(node), Equals<size_t>(15));
        ts_node_release(node);
      });
    });
  });

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

  describe("error nodes", [&]() {
    before_each([&]() {
      ts_document_set_input_string(document, "  [123, total nonsense, true]");
      AssertThat(ts_node_string(ts_document_root_node(document)), Equals(
          "(DOCUMENT (array (number) (ERROR 'o') (true)))"));

      root = ts_document_root_node(document);
    });

    it("computes their size and position correctly", [&]() {
      TSNode *array = ts_node_child(root, 0);
      TSNode *error = ts_node_child(array, 1);

      AssertThat(ts_node_name(error), Equals("error"));
      AssertThat(ts_node_pos(error), Equals(string("  [123,").length()))
      AssertThat(ts_node_size(error), Equals(string(" total nonsense").length()))

      ts_node_release(array);
      ts_node_release(error);
    });
  });
});

END_TEST