1 ;;; ede/emacs.el --- Special project for Emacs
3 ;; Copyright (C) 2008-2015 Free Software Foundation, Inc.
5 ;; Author: Eric M. Ludlam <eric@siege-engine.com>
7 ;; This file is part of GNU Emacs.
9 ;; GNU Emacs is free software: you can redistribute it and/or modify
10 ;; it under the terms of the GNU General Public License as published by
11 ;; the Free Software Foundation, either version 3 of the License, or
12 ;; (at your option) any later version.
14 ;; GNU Emacs is distributed in the hope that it will be useful,
15 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
16 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 ;; GNU General Public License for more details.
19 ;; You should have received a copy of the GNU General Public License
20 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
24 ;; Provide a special project type just for Emacs, cause Emacs is special.
26 ;; Identifies an Emacs project automatically.
27 ;; Speedy ede-expand-filename based on extension.
28 ;; Pre-populates the preprocessor map from lisp.h
31 ;; * Add "build" options.
32 ;; * Add texinfo lookup options.
36 (declare-function semanticdb-file-table-object
"semantic/db")
37 (declare-function semanticdb-needs-refresh-p
"semantic/db")
38 (declare-function semanticdb-refresh-table
"semantic/db")
42 ;; @TODO - get rid of this. Stuck in loaddefs right now.
44 (defun ede-emacs-project-root (&optional _dir
)
45 "Get the root directory for DIR."
48 (defun ede-emacs-version (dir)
49 "Find the Emacs version for the Emacs src in DIR.
50 Return a tuple of ( EMACSNAME . VERSION )."
51 (let ((buff (get-buffer-create " *emacs-query*"))
52 (configure_ac "configure.ac")
55 (with-current-buffer buff
57 (setq default-directory
(file-name-as-directory dir
))
60 ((file-exists-p "version.sh")
62 (insert-file-contents "version.sh")
63 (goto-char (point-min))
64 (re-search-forward "emacs_major_version=\\([0-9]+\\)
65 emacs_minor_version=\\([0-9]+\\)
66 emacs_beta_version=\\([0-9]+\\)")
67 (setq ver
(concat (match-string 1) "."
71 ((file-exists-p "sxemacs.pc.in")
72 (setq emacs
"SXEmacs")
73 (insert-file-contents "sxemacs_version.m4")
74 (goto-char (point-min))
75 (re-search-forward "m4_define(\\[SXEM4CS_MAJOR_VERSION\\], \\[\\([0-9]+\\)\\])
76 m4_define(\\[SXEM4CS_MINOR_VERSION\\], \\[\\([0-9]+\\)\\])
77 m4_define(\\[SXEM4CS_BETA_VERSION\\], \\[\\([0-9]+\\)\\])")
78 (setq ver
(concat (match-string 1) "."
82 ;; Insert other Emacs here...
84 ;; Vaguely recent version of GNU Emacs?
85 ((or (file-exists-p configure_ac
)
86 (file-exists-p (setq configure_ac
"configure.in")))
87 (insert-file-contents configure_ac
)
88 (goto-char (point-min))
89 (re-search-forward "AC_INIT(\\(?:GNU \\)?[eE]macs,\\s-*\\([0-9.]+\\)\\s-*[,)]")
90 (setq ver
(match-string 1))
96 (defclass ede-emacs-project
(ede-project)
99 "Project Type for the Emacs source code."
100 :method-invocation-order
:depth-first
)
102 (defun ede-emacs-load (dir &optional _rootproj
)
103 "Return an Emacs Project object if there is a match.
104 Return nil if there isn't one.
105 Argument DIR is the directory it is created for.
106 ROOTPROJ is nil, since there is only one project."
107 ;; Doesn't already exist, so let's make one.
108 (let* ((vertuple (ede-emacs-version dir
)))
112 :version
(cdr vertuple
)
113 :directory
(file-name-as-directory dir
)
114 :file
(expand-file-name "src/emacs.c"
118 (ede-add-project-autoload
119 (make-instance 'ede-project-autoload
122 :proj-file
"src/emacs.c"
123 :load-type
'ede-emacs-load
124 :class-sym
'ede-emacs-project
129 (defclass ede-emacs-target-c
(ede-target)
131 "EDE Emacs Project target for C code.
132 All directories need at least one target.")
134 (defclass ede-emacs-target-el
(ede-target)
136 "EDE Emacs Project target for Emacs Lisp code.
137 All directories need at least one target.")
139 (defclass ede-emacs-target-misc
(ede-target)
141 "EDE Emacs Project target for Misc files.
142 All directories need at least one target.")
144 (cl-defmethod initialize-instance ((this ede-emacs-project
)
146 "Make sure the targets slot is bound."
147 (cl-call-next-method)
148 (unless (slot-boundp this
'targets
)
149 (oset this
:targets nil
)))
153 (cl-defmethod ede-project-root-directory ((this ede-emacs-project
)
155 "Return the root for THIS Emacs project with file."
156 (ede-up-directory (file-name-directory (oref this file
))))
158 (cl-defmethod ede-project-root ((this ede-emacs-project
))
162 (cl-defmethod ede-find-subproject-for-directory ((proj ede-emacs-project
)
164 "Return PROJ, for handling all subdirs below DIR."
167 ;;; TARGET MANAGEMENT
169 (defun ede-emacs-find-matching-target (class dir targets
)
170 "Find a target that is a CLASS and is in DIR in the list of TARGETS."
173 (when (and (object-of-class-p T class
)
174 (string= (oref T path
) dir
))
179 (cl-defmethod ede-find-target ((proj ede-emacs-project
) buffer
)
180 "Find an EDE target in PROJ for BUFFER.
181 If one doesn't exist, create a new one for this directory."
182 (let* ((ext (file-name-extension (buffer-file-name buffer
)))
183 (cls (cond ((not ext
)
184 'ede-emacs-target-misc
)
185 ((string-match "c\\|h" ext
)
187 ((string-match "elc?" ext
)
188 'ede-emacs-target-el
)
189 (t 'ede-emacs-target-misc
)))
190 (targets (oref proj targets
))
191 (dir default-directory
)
192 (ans (ede-emacs-find-matching-target cls dir targets
))
195 (setq ans
(make-instance
197 :name
(file-name-nondirectory
198 (directory-file-name dir
))
201 (object-add-to-list proj
:targets ans
)
205 ;;; UTILITIES SUPPORT.
207 (cl-defmethod ede-preprocessor-map ((this ede-emacs-target-c
))
208 "Get the pre-processor map for Emacs C code.
209 All files need the macros from lisp.h!"
210 (require 'semantic
/db
)
211 (let* ((proj (ede-target-parent this
))
212 (root (ede-project-root proj
))
213 (table (semanticdb-file-table-object
214 (ede-expand-filename root
"lisp.h")))
215 (config (semanticdb-file-table-object
216 (ede-expand-filename root
"config.h")))
220 (when (semanticdb-needs-refresh-p table
)
221 (semanticdb-refresh-table table
))
222 (setq filemap
(append filemap
(oref table lexical-table
)))
225 (when (semanticdb-needs-refresh-p config
)
226 (semanticdb-refresh-table config
))
227 (setq filemap
(append filemap
(oref config lexical-table
)))
232 (defun ede-emacs-find-in-directories (name base dirs
)
233 "Find NAME is BASE directory sublist of DIRS."
235 (while (and dirs
(not ans
))
236 (let* ((D (car dirs
))
237 (ed (expand-file-name D base
))
238 (ef (expand-file-name name ed
)))
239 (if (file-exists-p ef
)
241 ;; Not in this dir? How about subdirs?
242 (let ((dirfile (directory-files ed t
))
245 ;; Get all the subdirs.
247 (when (and (file-directory-p DF
)
248 (not (string-match "\\.$" DF
)))
251 (setq ans
(ede-emacs-find-in-directories name ed moredirs
))
253 (setq dirs
(cdr dirs
))))
256 (cl-defmethod ede-expand-filename-impl ((proj ede-emacs-project
) name
)
257 "Within this project PROJ, find the file NAME.
258 Knows about how the Emacs source tree is organized."
259 (let* ((ext (file-name-extension name
))
260 (root (ede-project-root proj
))
261 (dir (ede-project-root-directory root
))
264 ((string-match "h\\|c" ext
)
265 '("src" "lib-src" "lwlib"))
266 ((string-match "elc?" ext
)
268 ((string-match "texi" ext
)
272 (if (not dirs
) (cl-call-next-method)
273 (ede-emacs-find-in-directories name dir dirs
))
278 (cl-defmethod project-rescan ((this ede-emacs-project
))
279 "Rescan this Emacs project from the sources."
280 (let ((ver (ede-emacs-version (ede-project-root-directory this
))))
281 (oset this name
(car ver
))
282 (oset this version
(cdr ver
))
288 ;; generated-autoload-file: "loaddefs.el"
289 ;; generated-autoload-load-name: "ede/emacs"
292 ;;; ede/emacs.el ends here