| blob | 3eb1f9c21839e976a8cd475cacc6d4c8d492b126 |
1 ;;; project-am.el --- A project management scheme based on automake files.
3 ;; Copyright (C) 1998, 1999, 2000, 2003, 2005, 2007, 2008, 2009, 2010
4 ;; Free Software Foundation, Inc.
6 ;; Author: Eric M. Ludlam <zappo@gnu.org>
7 ;; Version: 0.0.3
8 ;; Keywords: project, make
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software: you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation, either version 3 of the License, or
15 ;; (at your option) any later version.
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
25 ;;; Commentary:
26 ;;
27 ;; The GNU Automake tool is the first step towards having a really
28 ;; good project management system. It provides a simple and concise
29 ;; look at what is actually in a project, and records it in a simple
30 ;; fashion.
31 ;;
32 ;; project-am uses the structure defined in all good GNU projects with
33 ;; the Automake file as it's base template, and then maintains that
34 ;; information during edits, automatically updating the automake file
35 ;; where appropriate.
38 ;; (eval-and-compile
39 ;; ;; Compatibility for makefile mode.
40 ;; (condition-case nil
41 ;; (require 'makefile "make-mode")
42 ;; (error (require 'make-mode "make-mode")))
44 ;; ;; Requiring the .el files prevents incomplete builds.
45 ;; (require 'eieio "eieio.el")
46 ;; (require 'ede "ede.el"))
56 ;;; Code:
58 "File and tag browser frame."
61 )
64 "*Default command used to compile a project."
69 "*Default command used to compile a project."
74 "*Default Emacs command used to debug a target."
99 ;; for other global files track EXTRA_
103 ;; Custom libraries targets?
104 ;; ("ltlibcustom" project-am-lib ".*?_LTLIBRARIES" t)
105 )
106 "Alist of type names and the type of object to create for them.
107 Each entry is of th form:
108 (EMACSNAME CLASS AUTOMAKEVAR INDIRECT)
109 where EMACSNAME is a name for Emacs to use.
110 CLASS is the EDE target class to represent the target.
111 AUTOMAKEVAR is the Automake variable to identify. This cannot be a
112 regular expression.
113 INDIRECT is optional. If it is non-nil, then the variable in
117 nil
130 ()
134 ()
138 ()
142 ()
146 ()
150 nil
154 ()
159 :initform nil
164 nil
167 ;; For generic files tracker like EXTRA_DIST
169 ()
173 ()
178 :initform nil
181 :initform nil
182 :documentation
184 )
187 ;;; Code:
189 "Add the current buffer into a project.
190 OT is the object target. DIR is the directory to start in."
197 nil t))))
198 ;; The input target might be new. See if we can find it.
217 "Remove the current buffer from any project targets."
232 "Edit the target associated w/ this file."
241 "Create a new target named NAME.
242 Argument TYPE is the type of target to insert. This is a string
243 matching something in `project-am-type-alist' or type class symbol.
244 Despite the fact that this is a method, it depends on the current
245 buffer being in order to provide a smart default target type."
249 project-am-type-alist
250 nil t
272 ;; Add the new target sources macro (if needed)
275 ;; Add to the list of objects.
284 ;; If the above search fails, thats ok. We'd just want to be at
285 ;; point-min anyway.
286 )
291 ;; Rescan the object in this makefile.
294 ;(defun project-am-rescan-toplevel ()
295 ; "Rescan all projects in which the current buffer resides."
296 ; (interactive)
297 ; (let* ((tlof (project-am-find-topmost-level default-directory))
298 ; (tlo (project-am-load tlof))
299 ; (ede-deep-rescan t)) ; scan deep in this case.
300 ; ;; tlo is the top level object for whatever file we are in
301 ; ;; or nil. If we have an object, call the rescan method.
302 ; (if tlo (project-am-rescan tlo))))
304 ;;
305 ;; NOTE TO SELF
306 ;;
307 ;; This should be handled at the EDE level, calling a method of the
308 ;; top most project.
309 ;;
311 "Compile the entire current project.
312 Argument COMMAND is the command to use when compiling."
316 command
317 ;; This interactive statement was taken from compile, and I'll
318 ;; use the same command history too.
324 ;; hardcode make -k
325 ;; This is compile project after all.
326 project-am-compile-project-command
328 project-am-compile-project-command))))
329 ;; When compile a project, we might be in a subdirectory,
330 ;; so we have to make sure we move all the way to the top.
336 "Compile the entire current project.
337 Argument COMMAND is the command to use when compiling."
341 command
342 ;; This interactive statement was taken from compile, and I'll
343 ;; use the same command history too.
349 ;; hardcode make -k
350 ;; This is compile project after all.
351 project-am-compile-project-command
353 project-am-compile-project-command))))
354 ;; When compile a project, we might be in a subdirectory,
355 ;; so we have to make sure we move all the way to the top.
360 "Compile the current target.
361 Argument COMMAND is the command to use for compiling the target."
367 command
370 ;; hardcode make -k
371 ;; This is compile project after all.
374 project-am-compile-target-command
376 ede-object))
377 project-am-compile-target-command)
378 nil nil
381 project-am-compile-project-command
383 project-am-compile-target-command
385 ;; We better be in the right place when compiling a specific target.
389 "Run the current project target in a debugger."
399 "Run (like this): "
408 "Run the current project target in comint buffer."
417 "Run (like this): "
423 "Run the current project in the debugger."
430 ;;; Project loading and saving
431 ;;
433 "Read an automakefile PROJECT into our data structure.
434 Make sure that the tree down to our makefile is complete so that there
435 is cohesion in the project. Return the project file (or sub-project).
436 If a given set of projects has already been loaded, then do nothing
437 but return the project for the directory given.
438 Optional ROOTPROJ is the root EDE project."
439 ;; @TODO - rationalize this to the newer EDE way of doing things.
445 project)
456 nil
457 ;; Now scan down from amo, and find the current directory
458 ;; from the PROJECT file.
465 amo
469 amo)
470 ))
473 "Find the topmost automakefile starting with DIR."
478 )
484 "Set the Makefile.am in DIR to be the current buffer.
485 Run FORMS while the makefile is current.
486 Kill the makefile if it was not loaded before the load."
491 nil
494 ;; We need to find-file this thing, but don't use
495 ;; any semantic features.
498 )
511 "Convert PATH into a project Makefile, and return its project object.
512 It does not check for existing project objects. Use `project-am-load'."
515 ede-object
522 pn :name pn
523 :version ver
530 ;; Move the rescan after we set ede-object to prevent recursion
532 ampf))))
534 ;;; Methods:
536 "Fetch the target belonging to BUFFER."
548 obj)))
551 "Return a list of targets the project PROJ."
555 "Scan the current Makefile.am for targets.
556 CURRPROJ is the current project being scanned.
557 DIR is the directory to apply to new targets."
561 )
563 ;; Map all the different types
568 ;(name (car typecar))
569 )
571 ;; Map all the found objects
580 ;; Non-indirect will have a target whos sources
581 ;; are actual files, not names of other targets.
590 ))
591 )
592 ))
593 project-am-type-alist)
594 ntargets))
597 "Rescan the makefile for all targets and sub targets."
599 ;;(message "Scanning %s..." (oref this file))
607 ;; If DIST_SUBDIRS doesn't exist, then go for the
608 ;; static list of SUBDIRS. The DIST version should
609 ;; contain SUBDIRS plus extra stuff.
614 ;; Targets are excluded here because they require
615 ;; special attention.
619 )
631 ; ;; LISP is different. Here there is only one kind of lisp (that I know of
632 ; ;; anyway) so it doesn't get mapped when it is found.
633 ; (if (makefile-move-to-macro "lisp_LISP")
634 ; (let ((tmp (project-am-lisp "lisp"
635 ; :name "lisp"
636 ; :path dir)))
637 ; (project-rescan tmp)
638 ; (setq ntargets (cons tmp ntargets))))
639 ;
640 ;; Now that we have this new list, chuck the old targets
641 ;; and replace it with the new list of targets I just created.
643 ;; We still have a list of targets. For all buffers, make sure
644 ;; their object still exists!
646 ;; FIGURE THIS OUT
650 )
653 ;; If it is a variable, expand that variable, and keep going.
657 ))
658 csubproj)
660 ;; Ok, now lets look at all our sub-projects.
666 "Makefile.am"
667 subdir)))
669 nil ;; don't recurse.. please!
671 ;; For each project id found, see if we need to recycle,
672 ;; and if we do not, then make a new one. Check the deep
673 ;; rescan value for behavior patterns.
675 submake
680 ;; In case of problem, ignore it.
683 ;; If we have tmp, then rescan it only if deep mode.
686 ;; Tac tmp onto our list of things to keep, but only
687 ;; if tmp was found.
689 ;;(message "Adding %S" (object-print tmp))
691 )
694 ;; All elements should be updated now.
695 )))
699 "Rescan object THIS."
705 "Rescan object THIS."
709 "Rescan object THIS."
713 "Rescan object THIS."
717 "Rescan the lisp sources."
721 "Rescan the Header sources for object THIS."
725 "Rescan built sources for object THIS."
729 "Rescan object THIS."
731 ;; NOTE: The below calls 'file' then checks that it is some sort of
732 ;; text file. The file command may not be available on all platforms
733 ;; and some files may not exist yet. (ie - auto-generated)
735 ;;(mapc
736 ;; (lambda (f)
737 ;; ;; prevent garbage to be parsed, could we use :aux ?
738 ;; (if (and (not (member f (oref this :source)))
739 ;; (string-match-p "ASCII\\|text"
740 ;; (shell-command-to-string
741 ;; (concat "file " f))))
742 ;; (oset this :source (cons f (oref this :source)))))
743 ;; (makefile-macro-file-list "EXTRA_DIST")))
746 "Return the default macro to 'edit' for this object type."
750 "Return the default macro to 'edit' for this object."
754 "Return the default macro to 'edit' for this object."
758 "Return the default macro to 'edit' for this object."
762 "Return the default macro to 'edit' for this object."
766 "Return the default macro to 'edit' for this object type."
770 "Return the default macro to 'edit' for this object type."
774 "Return the default macro to 'edit' for this object."
778 "Return an object starting with AMF associated with BUFFER.
779 nil means that this buffer belongs to no-one."
781 nil
783 amf
794 obj))))
797 "Return t if object THIS lays claim to the file in BUFFER."
803 ;; Search output files.
808 ans)
809 )))
812 "Return t if object THIS lays claim to the file in BUFFER."
817 "Return t if object THIS lays claim to the file in BUFFER."
823 "Return t if object THIS lays claim to the file in BUFFER."
827 "Return t if object THIS lays claim to the file in BUFFER."
832 "Return the sub project in AMPF specified by SUBDIR."
836 "Default target to use when compiling a given target."
837 ;; This is a pretty good default for most.
841 "Default target to use when compiling an object code target."
845 "Default target t- use when compling a texinfo file."
849 n))
851 \f
852 ;;; Generic useful functions
855 "Return the last part of a directory name.
856 Argument FILE is the file to extract the end directory name from."
859 )
861 )
864 "For FILE, return the preferred type for that file."
866 project-am-texinfo)
868 project-am-man)
870 project-am-lisp)
872 project-am-program)))
875 "There are no default header files."
880 ;; Add more logic here if applicable.
884 found)))
887 "Return a list of files that provides documentation.
888 Documentation is not for object THIS, but is provided by THIS for other
889 files in the project."
895 ;; Loop over all entries and expand
899 out))
901 ;; return it
902 out))
905 ;;; Configure.in queries.
906 ;;
912 "Return the name of the autoconf file to use in DIR."
917 ans))
920 "Set the Configure FILE in the top most directory above DIR as current.
921 Run FORMS in the configure file.
922 Kill the Configure buffer if it was not already in a buffer."
939 "Extract the value of the shell variable VAR from a shell script."
943 nil t)
947 "Extract the package information for directory DIR."
955 )
957 ;; Try configure.in or configure.ac
965 )
967 ;; AC init has more than 1 parameter
972 ;; The init automake has more than 1 parameter
977 )
978 ;; AC_CONFIG_FILES, or AC_OUTPUT lists everything that
979 ;; should be detected as part of this PROJECT, but not in a
980 ;; particular TARGET.
986 )
987 ))
988 )
989 ;; Else, try the script
994 )
995 ))
996 ;; Don't know what else....
998 nil))
999 ;; Return stuff
1001 ))
1004 "Get the package information for directory topmost project dir over DIR.
1005 Calculates the info with `project-am-extract-package-info'."
1012 ;; arch-tag: 528db935-f186-4240-b647-e305c5b784a2
1013 ;;; ede/project-am.el ends here