1 ;;; An indentation engine for gpr mode, using the wisent LALR parser
3 ;; [1] GNAT user guide (info "gnat_ugn")
5 ;; Copyright (C) 2013, 2014 Free Software Foundation, Inc.
7 ;; Author: Stephen Leake <stephen_leake@member.fsf.org>
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software: you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation, either version 3 of the License, or
14 ;; (at your option) any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
24 ;;; History: first version Jan 2013
28 ;; I don't use 'pcase', because it gives _really_ confusing errors
29 ;; when I forget a ')' somewhere. Even worse, the error message is
30 ;; given when you use edebug on a defun, not when you eval it. This
31 ;; code is hard enough to debug!
35 ;; we reuse some stuff from ada-mode
36 (require 'ada-indent-user-options)
37 (require 'gpr-grammar-wy)
41 (defconst gpr-wisi-class-list
54 (defun gpr-wisi-indent-cache (offset cache)
55 "Return indentation of OFFSET relative to indentation of line containing CACHE
56 or containing ancestor of CACHE that is at a line beginning."
57 (let ((indent (current-indentation)))
59 (not (= (current-column) indent)))
60 (when (eq 'WHEN (wisi-cache-token cache))
61 (setq offset (+ offset ada-indent-when)))
62 (setq cache (wisi-goto-containing cache))
63 (setq indent (current-indentation)))
64 (+ (current-indentation) offset)
67 (defun gpr-wisi-indent-containing (offset cache)
68 "Return indentation of OFFSET relative to containing ancestor of CACHE that is at a line beginning."
69 (gpr-wisi-indent-cache offset (wisi-goto-containing cache)))
71 (defun gpr-wisi-before-cache ()
72 (let ((cache (wisi-get-cache (point))))
74 (cl-ecase (wisi-cache-class cache)
75 (block-start (wisi-indent-start ada-indent (wisi-backward-cache)))
76 (block-end (wisi-indent-start 0 cache))
79 (if (eq (wisi-cache-token cache) 'WHEN) ada-indent-when 0)
80 ;; FIXME (later): need test of ada-indent-when in gpr
82 (close-paren (wisi-indent-paren 0))
83 (open-paren nil); let after-keyword handle it
85 (if (not (wisi-get-containing-cache cache))
89 (gpr-wisi-indent-containing ada-indent cache)))
93 (defun gpr-wisi-after-cache ()
94 (let ((cache (wisi-backward-cache)))
98 (cl-ecase (wisi-cache-class cache)
100 (wisi-indent-current 0))
103 (cl-case (wisi-cache-token cache)
105 (gpr-wisi-indent-cache ada-indent-broken cache))
107 (gpr-wisi-indent-cache ada-indent cache))
111 (cl-case (wisi-cache-token cache)
113 (gpr-wisi-indent-containing ada-indent cache))
115 (gpr-wisi-indent-cache ada-indent cache))
119 ;; test/gpr/simple.gpr
120 ;; type GNAT_Version_Type
123 ;; "GPL-2012", "GPL-2011");
125 ;; for Source_Dirs use
127 ;; External ("GNAT_VERSION") & "/foo",
129 (wisi-goto-containing cache)
130 (1+ (current-column)))
133 (1+ (current-column)))
136 (wisi-indent-start 0 cache))
138 ((statement-other close-paren)
139 ;; test/gpr/simple.gpr
141 ;; & Standard_Common.Compiler'Default_Switches;
143 ;; for Source_Dirs use
145 (wisi-indent-start ada-indent-broken cache))
148 ;; test/gpr/simple.gpr
149 ;; type GNAT_Version_Type
152 (gpr-wisi-indent-cache ada-indent-broken cache))
156 (defun gpr-wisi-post-parse-fail ()
157 "For `wisi-post-parse-fail-hook'."
161 (defun gpr-wisi-which-function ()
162 "For `gpr-which-function'."
163 (wisi-validate-cache (point))
164 (let ((cache (wisi-backward-cache)))
167 (memq (wisi-cache-nonterm cache) '(package_spec simple_project_declaration))
168 (eq (wisi-cache-class cache) 'statement-start))))
169 (setq cache (wisi-goto-containing cache)))
171 (wisi-forward-token); package | project
172 (wisi-token-text (wisi-forward-token)); name
176 (defun gpr-wisi-debug-keys ()
177 "Add debug key definitions to `gpr-mode-map'."
179 (define-key gpr-mode-map "\M-h" 'wisi-show-containing-or-previous-cache)
180 (define-key gpr-mode-map "\M-j" 'wisi-show-cache)
181 (define-key gpr-mode-map "\M-k" 'wisi-show-token)
185 (defun gpr-wisi-setup ()
186 "Set up a buffer for parsing Ada files with wisi."
187 (wisi-setup '(gpr-wisi-before-cache
188 gpr-wisi-after-cache)
189 'gpr-wisi-post-parse-fail
191 gpr-grammar-wy--keyword-table
192 gpr-grammar-wy--token-table
193 gpr-grammar-wy--parse-table)
195 (setq gpr-indent-statement 'wisi-indent-statement)
196 (set (make-local-variable 'comment-indent-function) 'wisi-comment-indent)
199 (add-hook 'gpr-mode-hook 'gpr-wisi-setup)
201 (setq gpr-which-function 'gpr-wisi-which-function)
203 (setq gpr-show-parse-error 'wisi-show-parse-error)
206 (provide 'gpr-indent-engine)