| blob | 09c8ec0daf75536a5a13e05a42a1a6202c388eae |
1 ;;; project-am.el --- A project management scheme based on automake files.
3 ;; Copyright (C) 1998-2000, 2003, 2005, 2007-2014 Free Software
4 ;; 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 its base template, and then maintains that
34 ;; information during edits, automatically updating the automake file
35 ;; where appropriate.
48 ;;; Code:
50 "File and tag browser frame."
53 )
56 "*Default command used to compile a project."
61 "*Default command used to compile a project."
66 "*Default Emacs command used to debug a target."
91 ;; for other global files track EXTRA_
95 ;; Custom libraries targets?
96 ;; ("ltlibcustom" project-am-lib ".*?_LTLIBRARIES" t)
97 )
98 "Alist of type names and the type of object to create for them.
99 Each entry is of the form:
100 (EMACSNAME CLASS AUTOMAKEVAR INDIRECT)
101 where EMACSNAME is a name for Emacs to use.
102 CLASS is the EDE target class to represent the target.
103 AUTOMAKEVAR is the Automake variable to identify. This cannot be a
104 regular expression.
105 INDIRECT is optional. If it is non-nil, then the variable in
113 ;; direct primary target use a dummy object (man target)
114 ;; update to: * 3.3 Uniform in automake-1.11 info node.
116 )
117 "Alist of meta-target type, each entry has form:
118 (CLASS REGEXPVAR INDIRECT)
119 where CLASS is the EDE target class for target.
120 REGEXPVAR is the regexp used in `semantic-find-tags-by-name-regexp'.
121 INDIRECT is optional. If it is non-nil, then the variable in it have
126 nil
139 ()
143 ()
147 ()
151 ()
155 ()
159 nil
163 ()
168 :initform nil
173 nil
176 ;; For generic files tracker like EXTRA_DIST
178 ()
182 ()
187 :initform nil
190 :initform nil
191 :documentation
193 )
196 ;;; Code:
198 "Add the current buffer into a project.
199 OT is the object target. DIR is the directory to start in."
206 nil t))))
207 ;; The input target might be new. See if we can find it.
225 "Remove the current buffer from any project targets."
236 "Edit the target associated w/ this file."
245 "Create a new target named NAME.
246 Argument TYPE is the type of target to insert. This is a string
247 matching something in `project-am-type-alist' or type class symbol.
248 Despite the fact that this is a method, it depends on the current
249 buffer being in order to provide a smart default target type."
253 project-am-type-alist
254 nil t
275 ;; Add the new target sources macro (if needed)
278 ;; Add to the list of objects.
287 ;; If the above search fails, that's ok. We'd just want to be at
288 ;; point-min anyway.
289 )
294 ;; Rescan the object in this makefile.
297 ;;
298 ;; NOTE TO SELF
299 ;;
300 ;; This should be handled at the EDE level, calling a method of the
301 ;; top most project.
302 ;;
304 "Compile the entire current project.
305 Argument COMMAND is the command to use when compiling."
309 command
310 ;; This interactive statement was taken from compile, and I'll
311 ;; use the same command history too.
317 ;; hardcode make -k
318 ;; This is compile project after all.
319 project-am-compile-project-command
321 project-am-compile-project-command))))
322 ;; When compile a project, we might be in a subdirectory,
323 ;; so we have to make sure we move all the way to the top.
329 "Compile the entire current project.
330 Argument COMMAND is the command to use when compiling."
334 command
335 ;; This interactive statement was taken from compile, and I'll
336 ;; use the same command history too.
342 ;; hardcode make -k
343 ;; This is compile project after all.
344 project-am-compile-project-command
346 project-am-compile-project-command))))
347 ;; When compile a project, we might be in a subdirectory,
348 ;; so we have to make sure we move all the way to the top.
353 "Compile the current target.
354 Argument COMMAND is the command to use for compiling the target."
360 command
363 ;; hardcode make -k
364 ;; This is compile project after all.
367 project-am-compile-target-command
369 ede-object))
370 project-am-compile-target-command)
371 nil nil
374 project-am-compile-project-command
376 project-am-compile-target-command
378 ;; We better be in the right place when compiling a specific target.
382 "Run the current project target in a debugger."
392 "Run (like this): "
401 "Run the current project target in comint buffer."
411 "Run (like this): "
417 "Run the current project in the debugger."
424 ;;; Project loading and saving
425 ;;
427 "Read an automakefile DIRECTORY into our data structure.
428 If a given set of projects has already been loaded, then do nothing
429 but return the project for the directory given.
430 Optional ROOTPROJ is the root EDE project."
436 amo))
439 "Find the topmost automakefile starting with DIR."
444 )
450 "Set the Makefile.am in DIR to be the current buffer.
451 Run FORMS while the makefile is current.
452 Kill the makefile if it was not loaded before the load."
457 nil
460 ;; We need to find-file this thing, but don't use
461 ;; any semantic features.
464 )
466 )
479 "Convert PATH into a project Makefile, and return its project object.
480 It does not check for existing project objects. Use `project-am-load'.
481 Optional argument SUGGESTEDNAME will be the project name.
482 This is used when subprojects are made in named subdirectories."
485 ede-object
494 pn :name pn
495 :version ver
502 ;; Move the rescan after we set ede-object to prevent recursion
504 ampf))))
506 ;;; Methods:
508 "Return a list of targets the project PROJ."
512 "Scan the current Makefile.am for targets.
513 CURRPROJ is the current project being scanned.
514 DIR is the directory to apply to new targets."
516 ;; `ntargets' results in complete targets list
517 ;; not only the new targets by diffing.
520 )
523 ;; Map all the different types
528 )
530 ;; Map all the found objects
539 ;; Non-indirect will have a target whos sources
540 ;; are actual files, not names of other targets.
549 ))
550 )
551 ))
552 project-am-type-alist)
554 ;; At now check variables for meta-target regexp
555 ;; We have to check ntargets to avoid useless rescan.
556 ;; Also we have check otargets to prevent duplication.
563 ;; Map all the found objects
573 ;; build a target list to map over
579 ;; default-value have to be a list
584 atargets))))
587 ;; else not indirect, TODO: FIX various direct meta type in a sane way.
593 ;; we are really new
598 )))
599 project-am-meta-type-alist)
600 ntargets))
603 "Store in PLACE the SUBDIRS expanded from variables.
604 Strip out duplicates, and recurse on variables."
608 ;; If it is a variable, expand that variable, and keep going.
611 ;; Else, add SP in if it isn't a dup.
613 nil ; don't do it twice.
615 ))))
616 subdirs)
617 )
620 "Rescan the makefile for all targets and sub targets."
622 ;;(message "Scanning %s..." (oref this file))
629 ;; 1/30/10 - We need to append these two lists together,
630 ;; then strip out duplicates. Expanding this list (via
631 ;; references to other variables should also strip out dups
637 ;; Targets are excluded here because they require
638 ;; special attention.
642 )
645 ;; Else, setup toplevel project info.
655 ;; Now that we have this new list, chuck the old targets
656 ;; and replace it with the new list of targets I just created.
658 ;; We still have a list of targets. For all buffers, make sure
659 ;; their object still exists!
660 ;; FIGURE THIS OUT
662 ;; Ok, now let's look at all our sub-projects.
668 "Makefile.am"
669 subdir)))
671 nil ;; don't recurse.. please!
672 ;; For each project id found, see if we need to recycle,
673 ;; and if we do not, then make a new one. Check the deep
674 ;; rescan value for behavior patterns.
676 submake
681 ;; In case of problem, ignore it.
684 ;; If we have tmp, then rescan it only if deep mode.
687 ;; Tac tmp onto our list of things to keep, but only
688 ;; if tmp was found.
690 ;;(message "Adding %S" (object-print tmp))
692 )
695 ;; All elements should be updated now.
696 )))
700 "Rescan object THIS."
708 "Rescan object THIS."
714 "Rescan object THIS."
718 "Rescan object THIS."
722 "Rescan the lisp sources."
726 "Rescan the Header sources for object THIS."
730 "Rescan built sources for object THIS."
734 "Rescan object THIS."
738 "Return the default macro to 'edit' for this object type."
742 "Return the default macro to 'edit' for this object."
746 "Return the default macro to 'edit' for this object."
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 type."
762 "Return the default macro to 'edit' for this object type."
766 "Return the default macro to 'edit' for this object."
770 "Return an object starting with AMF associated with BUFFER.
771 nil means that this buffer belongs to no-one."
773 nil
775 amf
786 obj))))
789 "Return t if object THIS lays claim to the file in BUFFER."
795 ;; Search output files.
800 ans)
801 )))
804 "Return t if object THIS lays claim to the file in BUFFER."
809 "Return t if object THIS lays claim to the file in BUFFER."
816 "Return t if object THIS lays claim to the file in BUFFER."
821 "Return t if object THIS lays claim to the file in BUFFER."
826 "Return the sub project in AMPF specified by SUBDIR."
830 "Default target to use when compiling a given target."
831 ;; This is a pretty good default for most.
835 "Default target to use when compiling an object code target."
839 "Default target t- use when compiling a texinfo file."
843 n))
845 \f
846 ;;; Generic useful functions
849 "Return the last part of a directory name.
850 Argument FILE is the file to extract the end directory name from."
853 )
855 )
858 "For FILE, return the preferred type for that file."
860 project-am-texinfo)
862 project-am-man)
864 project-am-lisp)
866 project-am-program)))
869 "There are no default header files."
874 ;; Add more logic here if applicable.
878 found)))
881 "Return a list of files that provides documentation.
882 Documentation is not for object THIS, but is provided by THIS for other
883 files in the project."
889 ;; Loop over all entries and expand
893 out))
895 ;; return it
896 out))
899 ;;; Configure.ac queries.
900 ;;
906 "Return the name of the autoconf file to use in DIR."
911 ans))
914 "Set the Configure FILE in the top most directory above DIR as current.
915 Run FORMS in the configure file.
916 Kill the Configure buffer if it was not already in a buffer."
933 "Extract the value of the shell variable VAR from a shell script."
937 nil t)
941 "Extract the package information for directory DIR."
949 )
951 ;; Try configure.ac or configure.in
958 )
960 ;; AC init has more than 1 parameter
965 ;; The init automake has more than 1 parameter
970 )
971 ;; AC_CONFIG_FILES, or AC_OUTPUT lists everything that
972 ;; should be detected as part of this PROJECT, but not in a
973 ;; particular TARGET.
979 )
980 ))
981 )
982 ;; Else, try the script
987 )
988 ))
989 ;; Don't know what else....
991 nil))
992 ;; Return stuff
994 ))
997 "Get the package information for directory topmost project dir over DIR.
998 Calculates the info with `project-am-extract-package-info'."
1003 ;; for simple per project include path extension
1005 "Return `project-am-localvars-include-path', usually local variable
1006 per file or in .dir-locals.el or similar."
1010 "Return `project-am-localvars-include-path', usually local variable
1011 per file or in .dir-locals.el or similar."
1017 ;; Local variables:
1018 ;; generated-autoload-load-name: "ede/project-am"
1019 ;; End:
1021 ;;; ede/project-am.el ends here