vhdl-ext-imenu.el

;;; vhdl-ext-imenu.el --- VHDL Imenu -*- lexical-binding: t -*-

;; Copyright (C) 2022-2024 Gonzalo Larumbe

;; Author: Gonzalo Larumbe <gonzalomlarumbe@gmail.com>
;; URL: https://github.com/gmlarumbe/vhdl-ext

;; This program is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.

;; This program is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
;; along with this program.  If not, see <http://www.gnu.org/licenses/>.

;;; Commentary:

;; Imenu

;;; Code:

(require 'vhdl-ext-utils)

(defconst vhdl-ext-imenu-generic-expression
  `(("Instance"      vhdl-ext-find-entity-instance-bwd 6)
    ("Function"      ,vhdl-ext-function-re 4)
    ("Procedure"     ,vhdl-ext-procedure-re 4)
    ("Process"       ,vhdl-ext-process-re 1)
    ("Component"     ,vhdl-ext-component-re 2)
    ("Block"         ,vhdl-ext-block-re 1)
    ("Package"       ,vhdl-ext-package-re 3)
    ("Configuration" ,vhdl-ext-configuration-re 2)
    ("Architecture"  ,vhdl-ext-architecture-re 2)
    ("Entity"        ,vhdl-ext-entity-re 2)
    ("Context"       ,vhdl-ext-context-re 2))
  "Imenu generic expression for VHDL Mode.  See `imenu-generic-expression'.")

(defun vhdl-ext-index-menu-init ()
  "Initialize index menu."
  (setq-local imenu-case-fold-search t)
  (setq-local imenu-generic-expression vhdl-ext-imenu-generic-expression)
  (when (and vhdl-index-menu
             (fboundp 'imenu))
    (imenu-add-to-menubar "Index")))


(provide 'vhdl-ext-imenu)

;;; vhdl-ext-imenu.el ends here