Skip to content

Commit

Permalink
Add point-inside-block tree-sitter implementation
Browse files Browse the repository at this point in the history
  • Loading branch information
@gmlarumbe
gmlarumbe committed Apr 7, 2024
1 parent 2488a25 commit 1454457
Show file tree
Hide file tree
Showing 5 changed files with 99 additions and 79 deletions.
2 changes: 1 addition & 1 deletion test-hdl
Submodule test-hdl updated 16 files
+51 −0 verilog/files/utils/verilog-ext/ref/axi_test.ts.point.inside.block.el
+30 −0 verilog/files/utils/verilog-ext/ref/instances.ts.point.inside.block.el
+45 −0 verilog/files/utils/verilog-ext/ref/tb_program.ts.point.inside.block.el
+15 −0 verilog/files/utils/verilog-ext/ref/ucontroller.ts.point.inside.block.el
+66 −0 verilog/files/utils/verilog-ext/ref/uvm_component.ts.point.inside.block.el
+26 −0 verilog/verilog-ext/test-hdl-verilog-ext-utils.el
+22 −0 vhdl/files/utils/vhdl-ext/ref/axi_if_converter.ts.point.inside.block.el
+21 −0 vhdl/files/utils/vhdl-ext/ref/global_pkg.ts.point.inside.block.el
+39 −0 vhdl/files/utils/vhdl-ext/ref/global_sim.ts.point.inside.block.el
+70 −0 vhdl/files/utils/vhdl-ext/ref/hierarchy.ts.point.inside.block.el
+51 −0 vhdl/files/utils/vhdl-ext/ref/instances.ts.point.inside.block.el
+62 −0 vhdl/files/utils/vhdl-ext/ref/sexp.ts.point.inside.block.el
+1 −0 vhdl/vhdl-ext/test-hdl-vhdl-ext-setup-package-test.el
+1 −0 vhdl/vhdl-ext/test-hdl-vhdl-ext-setup-package.el
+1 −0 vhdl/vhdl-ext/test-hdl-vhdl-ext-setup-straight.el
+26 −0 vhdl/vhdl-ext/test-hdl-vhdl-ext-utils.el
1 change: 0 additions & 1 deletion verilog-ext-hierarchy.el
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,6 @@
(require 'tree-widget)
(require 'async)
(require 'verilog-ext-nav)
(require 'verilog-ts-mode)

(defgroup verilog-ext-hierarchy nil
"Verilog-ext hierarchy."
Expand Down
3 changes: 2 additions & 1 deletion verilog-ext-nav.el
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,6 @@
(require 'ripgrep)
(require 'xref)
(require 'verilog-ext-utils)
(require 'verilog-ts-mode)


;;;; Custom
Expand Down Expand Up @@ -646,9 +645,11 @@ moves the cursor to current instance if pointing at one."
(defun verilog-ext-instance-at-point ()
"Return list with module and instance names if point is at an instance."
(if (eq major-mode 'verilog-ts-mode)
;; `verilog-ts-mode' based search
(let ((node (verilog-ts-instance-at-point)))
(when node
`(,(verilog-ts--node-identifier-name node) ,(verilog-ts--node-instance-name node))))
;; `verilog-mode' based search
(let ((point-cur (point))
point-instance-begin point-instance-end instance-type instance-name)
(save-excursion
Expand Down
1 change: 0 additions & 1 deletion verilog-ext-tags.el
View file
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,6 @@
(require 'async)
(require 'map)
(require 'verilog-ext-nav)
(require 'verilog-ts-mode)


(defgroup verilog-ext-tags nil
Expand Down
171 changes: 96 additions & 75 deletions verilog-ext-utils.el
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@
;;; Code:

(require 'verilog-mode)
(require 'verilog-ts-mode)

;;;; Custom
(defcustom verilog-ext-file-extension-re "\\.s?vh?\\'"
Expand Down Expand Up @@ -540,81 +541,101 @@ Assumes that point is looking at a BLOCK type."
(defun verilog-ext-point-inside-block (block)
"Return non-nil if cursor is inside specified BLOCK type.
Return alist with block type, name and boundaries."
(let ((pos (point))
(re (cond ((eq block 'function) "\\<\\(function\\)\\>")
((eq block 'task) "\\<\\(task\\)\\>")
((eq block 'class) "\\<\\(class\\)\\>")
((eq block 'module) "\\<\\(module\\)\\>")
((eq block 'interface) "\\<\\(interface\\)\\>")
((eq block 'package) "\\<\\(package\\)\\>")
((eq block 'program) "\\<\\(program\\)\\>")
((eq block 'always) "\\<\\(always\\(_ff\\|_comb\\|_latch\\)?\\)\\>")
((eq block 'initial) "\\<\\(initial\\)\\>")
((eq block 'final) "\\<\\(final\\)\\>")
((eq block 'generate) "\\<\\(generate\\)\\>")
((eq block 'begin-end) "\\<\\(begin\\|end\\)\\>")
(t (error "Incorrect block argument"))))
block-boundaries block-beg-point block-end-point block-type block-name)
(save-match-data
(save-excursion
(when (and (verilog-re-search-backward re nil t)
(cond (;; Classes
(equal block 'class)
(if (verilog-ext-class-declaration-is-typedef-p)
;; Try again if looking at a typedef class declaration
(verilog-ext-point-inside-block 'class)
;; Else do the same as for function/tasks and top blocks
(setq block-type (match-string-no-properties 1))
(looking-at verilog-ext-class-re)
(setq block-name (match-string-no-properties 3))))
;; Function/tasks and top blocks
((member block '(function task module interface package program))
(and (save-excursion ; Exclude external func/tasks declarations
(save-match-data
(verilog-beg-of-statement)
(not (looking-at "\\<extern\\>"))))
(setq block-type (match-string-no-properties 1))
(or (looking-at verilog-ext-function-re)
(looking-at verilog-ext-task-re)
(looking-at verilog-ext-top-re))
(setq block-name (match-string-no-properties 3))))
;; Procedural: always, initial and final
((member block '(always initial final))
(if (equal block 'always)
(setq block-type "always")
(setq block-type (match-string-no-properties 1)))
(save-excursion ; Get block name
(verilog-ext-skip-identifier-forward)
(verilog-ext-forward-syntactic-ws)
(setq block-name (buffer-substring-no-properties (point) (line-end-position)))))
;; Generate
((equal block 'generate)
(and (setq block-type (match-string-no-properties 1))
(save-excursion ; Get block name
(verilog-ext-skip-identifier-forward)
(verilog-ext-forward-syntactic-ws)
(setq block-name (buffer-substring-no-properties (point) (line-end-position))))))
;; Procedural block (begin-end)
((equal block 'begin-end)
(verilog-ext-while-t (string= (match-string-no-properties 0) "end")
(verilog-ext-backward-sexp)
(verilog-re-search-backward re nil t))
(setq block-type "begin-end")
(setq block-name "")) ; Return non-nil for and condition
;; Default invalid condition
(t
(error "Invalid condition"))))
;; Set boundaries and return value
(setq block-boundaries (verilog-ext-get-block-boundaries block))
(setq block-beg-point (car block-boundaries))
(setq block-end-point (cdr block-boundaries)))
(when (and block-beg-point block-end-point
(>= pos block-beg-point)
(< pos block-end-point))
`((type . ,block-type)
(name . ,block-name)
(beg-point . ,block-beg-point)
(end-point . ,block-end-point)))))))
(if (eq major-mode 'verilog-ts-mode)
;; `verilog-ts-mode' based search
(let* ((re (cond ((eq block 'function) "\\<\\(function_declaration\\)\\>")
((eq block 'task) "\\<\\(task_declaration\\)\\>")
((eq block 'class) "\\<\\(class_declaration\\)\\>")
((eq block 'module) "\\<\\(module_declaration\\)\\>")
((eq block 'interface) "\\<\\(interface_declaration\\)\\>")
((eq block 'package) "\\<\\(package_declaration\\)\\>")
((eq block 'program) "\\<\\(program_declaration\\)\\>")
((eq block 'always) "\\<\\(always_construct\\)\\>")
((eq block 'initial) "\\<\\(initial_construct\\)\\>")
((eq block 'final) "\\<\\(final_construct\\)\\>")
((eq block 'generate) "\\<\\(generate_region\\)\\>")))
(node (verilog-ts--node-has-parent-recursive (verilog-ts--node-at-point) re)))
(when node
`((type . ,(verilog-ts--node-identifier-type node))
(name . ,(verilog-ts--node-identifier-name node))
(beg-point . ,(treesit-node-start node))
(end-point . ,(treesit-node-end node)))))
;; `verilog-mode' based search
(let ((pos (point))
(re (cond ((eq block 'function) "\\<\\(function\\)\\>")
((eq block 'task) "\\<\\(task\\)\\>")
((eq block 'class) "\\<\\(class\\)\\>")
((eq block 'module) "\\<\\(module\\)\\>")
((eq block 'interface) "\\<\\(interface\\)\\>")
((eq block 'package) "\\<\\(package\\)\\>")
((eq block 'program) "\\<\\(program\\)\\>")
((eq block 'always) "\\<\\(always\\(_ff\\|_comb\\|_latch\\)?\\)\\>")
((eq block 'initial) "\\<\\(initial\\)\\>")
((eq block 'final) "\\<\\(final\\)\\>")
((eq block 'generate) "\\<\\(generate\\)\\>")
((eq block 'begin-end) "\\<\\(begin\\|end\\)\\>")
(t (error "Incorrect block argument"))))
block-boundaries block-beg-point block-end-point block-type block-name)
(save-match-data
(save-excursion
(when (and (verilog-re-search-backward re nil t)
(cond (;; Classes
(equal block 'class)
(if (verilog-ext-class-declaration-is-typedef-p)
;; Try again if looking at a typedef class declaration
(verilog-ext-point-inside-block 'class)
;; Else do the same as for function/tasks and top blocks
(setq block-type (match-string-no-properties 1))
(looking-at verilog-ext-class-re)
(setq block-name (match-string-no-properties 3))))
;; Function/tasks and top blocks
((member block '(function task module interface package program))
(and (save-excursion ; Exclude external func/tasks declarations
(save-match-data
(verilog-beg-of-statement)
(not (looking-at "\\<extern\\>"))))
(setq block-type (match-string-no-properties 1))
(or (looking-at verilog-ext-function-re)
(looking-at verilog-ext-task-re)
(looking-at verilog-ext-top-re))
(setq block-name (match-string-no-properties 3))))
;; Procedural: always, initial and final
((member block '(always initial final))
(if (equal block 'always)
(setq block-type "always")
(setq block-type (match-string-no-properties 1)))
(save-excursion ; Get block name
(verilog-ext-skip-identifier-forward)
(verilog-ext-forward-syntactic-ws)
(setq block-name (buffer-substring-no-properties (point) (line-end-position)))))
;; Generate
((equal block 'generate)
(and (setq block-type (match-string-no-properties 1))
(save-excursion ; Get block name
(verilog-ext-skip-identifier-forward)
(verilog-ext-forward-syntactic-ws)
(setq block-name (buffer-substring-no-properties (point) (line-end-position))))))
;; Procedural block (begin-end)
((equal block 'begin-end)
(verilog-ext-while-t (string= (match-string-no-properties 0) "end")
(verilog-ext-backward-sexp)
(verilog-re-search-backward re nil t))
(setq block-type "begin-end")
(setq block-name "")) ; Return non-nil for and condition
;; Default invalid condition
(t
(error "Invalid condition"))))
;; Set boundaries and return value
(setq block-boundaries (verilog-ext-get-block-boundaries block))
(setq block-beg-point (car block-boundaries))
(setq block-end-point (cdr block-boundaries)))
(when (and block-beg-point block-end-point
(>= pos block-beg-point)
(< pos block-end-point))
`((type . ,block-type)
(name . ,block-name)
(beg-point . ,block-beg-point)
(end-point . ,block-end-point))))))))

(defconst verilog-ext-block-at-point-all-re
(eval-when-compile
Expand Down

0 comments on commit 1454457

Please sign in to comment.