1 ;;; ada-fix-error.el --- utilities for automatically fixing -*- lexical-binding:t -*-
2 ;; errors reported by the compiler.
4 ;; Copyright (C) 1999-2009, 2012-2015 Free Software Foundation, Inc.
6 ;; Author : Stephen Leake <Stephen_Leake@stephe-leake.org>
7 ;; Maintainer : Stephen Leake <Stephen_Leake@stephe-leake.org>
8 ;; Web site : http://www.stephe-leake.org/
9 ;; Keywords : languages ada error
11 ;; This file is part of GNU Emacs
13 ;; This program is free software; you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation; either version 3, or (at your option)
18 ;; This program is distributed in the hope that it will be useful,
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 ;; GNU General Public License for more details.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with GNU Emacs; see the file COPYING. If not, write to
25 ;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
33 (defcustom ada-fix-sort-context-clause t
34 "*If non-nil, sort context clause when inserting 'with'"
38 (defvar ada-fix-context-clause nil
39 "Function to return the region containing the context clause for the current buffer,
40 excluding leading pragmas. Called with no arguments;
41 return (BEGIN . END). BEGIN and END must be at beginning of line.
42 If there is no context clause, BEGIN = END, at start of
45 (defun ada-fix-context-clause ()
46 (when ada-fix-context-clause
47 (funcall ada-fix-context-clause)))
49 (defun ada-fix-insert-unit-name (unit-name)
50 "Insert UNIT-NAME at point and capitalize it."
51 ;; unit-name is normally gotten from a file-name, and is thus all lower-case.
52 (let ((start-point (point))
55 (setq search-bound (point))
56 (insert " ") ; separate from following words, if any, for ada-case-adjust-identifier
57 (goto-char start-point)
58 (while (search-forward "." search-bound t)
60 (ada-case-adjust-identifier)
62 (goto-char search-bound)
63 (ada-case-adjust-identifier)
66 (defun ada-fix-add-with-clause (package-name)
67 "Add a with_clause for PACKAGE_NAME.
68 If ada-fix-sort-context-clause, sort the context clauses using
70 (let ((context-clause (ada-fix-context-clause)))
71 (when (not context-clause)
72 (error "no compilation unit found"))
74 (goto-char (cdr context-clause))
76 (ada-fix-insert-unit-name package-name)
79 (when (and (< (car context-clause) (cdr context-clause))
80 ada-fix-sort-context-clause)
81 ;; FIXME (later): this puts "limited with", "private with" at top of list; prefer at bottom
82 (sort-lines nil (car context-clause) (point)))
85 (defun ada-fix-extend-with-clause (child-name)
86 "Assuming point is in a selected name, just before CHILD-NAME, add or
87 extend a with_clause to include CHILD-NAME . "
88 (let ((parent-name-end (point)))
89 ;; Find the full parent name; skip back to whitespace, then match
91 (skip-syntax-backward "w_.")
92 (search-forward-regexp ada-name-regexp parent-name-end)
93 (let ((parent-name (match-string 0))
94 (context-clause (ada-fix-context-clause)))
95 (goto-char (car context-clause))
96 (if (search-forward-regexp (concat "^with " parent-name ";") (cdr context-clause) t)
97 ;; found exisiting 'with' for parent; extend it
99 (forward-char -1) ; skip back over semicolon
100 (insert "." child-name))
102 ;; not found; we are in a package body, with_clause for parent is in spec.
104 (ada-fix-add-with-clause (concat parent-name "." child-name)))
107 (defun ada-fix-add-use-type (type)
108 "Insert 'use type' clause for TYPE at start of declarative part for current construct."
109 (ada-goto-declarative-region-start); leaves point after 'is'
111 (insert "use type " type ";")
114 (indent-according-to-mode))
116 (defun ada-fix-add-use (package)
117 "Insert 'use' clause for PACKAGE at start of declarative part for current construct."
118 (ada-goto-declarative-region-start); leaves point after 'is'
120 (insert "use " package ";")
123 (indent-according-to-mode))
125 (defvar ada-fix-error-hook nil
126 ;; determined by ada_compiler, set by *-select-prj-compiler
127 "Hook to recognize and fix errors.
128 Hook functions are called with three args:
130 MSG, the `compilation--message' struct for the current error
132 SOURCE-BUFFER, the buffer containing the source to be fixed
134 SOURCE-WINDOW, the window displaying SOURCE-BUFFER.
136 Point in SOURCE-BUFFER is at error location; point in
137 `compilation-last-buffer' is at MSG location. Focus is in
140 Hook functions should return t if the error is recognized and
141 fixed, leaving point at fix. Otherwise, they should preserve
142 point and return nil.")
144 (defun ada-get-compilation-message ()
145 "Get compilation message at line beginning."
146 (get-text-property (line-beginning-position) 'compilation-message))
148 (defun ada-fix-compiler-error ()
149 "Attempt to fix the current compiler error. Leave point at fixed code."
152 (let ((source-buffer (current-buffer))
153 (source-window (selected-window))
154 (line-move-visual nil)); screws up next-line otherwise
156 (with-current-buffer compilation-last-buffer
157 (when (not (ada-get-compilation-message))
159 (message "FIXME: ada-fix-compiler-error")
160 ;; not clear why this can happens, but it does
161 (compilation-next-error 1))
162 (let ((comp-buf-pt (point))
164 (run-hook-with-args-until-success
166 (compilation-next-error 0)
169 ;; restore compilation buffer point
170 (set-buffer compilation-last-buffer)
171 (goto-char comp-buf-pt)
174 ;; none of the hooks handled the error
175 (error "error not recognized"))
178 (provide 'ada-fix-error)