2 @setfilename ../../info/ede
3 @settitle Emacs Development Environment
6 This file describes EDE, the Emacs Development Environment.
8 Copyright @copyright{} 1998, 1999, 2000, 2001, 2004, 2005, 2008, 2009, 2010
9 Free Software Foundation, Inc.
12 Permission is granted to copy, distribute and/or modify this document
13 under the terms of the GNU Free Documentation License, Version 1.3 or
14 any later version published by the Free Software Foundation; with no
15 Invariant Sections, with the Front-Cover texts being ``A GNU Manual,''
16 and with the Back-Cover Texts as in (a) below. A copy of the license
17 is included in the section entitled ``GNU Free Documentation License.''
19 (a) The FSF's Back-Cover Text is: ``You have the freedom to copy and
20 modify this GNU manual. Buying copies from the FSF supports it in
21 developing GNU and promoting software freedom.''
27 * ede: (ede). Project management for Emacs
31 @center @titlefont{EDE (The Emacs Development Environment)}
33 @center by Eric Ludlam
67 @node top, EDE Project Concepts, (dir), (dir)
69 @comment node-name, next, previous, up
71 @ede{} is the Emacs Development Environment: an Emacs extension that
72 simplifies building and debugging programs in Emacs. It attempts to
73 emulate a typical IDE (Integrated Development Environment). @ede{}
74 can manage or create your makefiles and other building environment
75 duties, allowing you to concentrate on writing code rather than
76 support files. It aims to make it much easier for new programmers to
77 learn and adopt GNU ways of doing things.
84 * EDE Project Concepts:: @ede{} Project Concepts
85 * EDE Mode:: Turning on @ede{} mode.
86 * Creating a project:: Creating a project.
87 * Modifying your project:: Adding and removing files and targets.
88 * Building and Debugging:: Initiating a build or debug session.
89 * Miscellaneous commands:: Other project related commands.
90 * Simple projects:: Projects not managed by @ede{}.
91 * Extending EDE:: Programming and extending @ede{}.
94 @node EDE Project Concepts, EDE Mode, top, top
95 @chapter @ede{} Project Concepts
97 @ede{} is a generic interface for managing projects. It specifies a
98 single set of menus and keybindings, while supporting multiple ways to
99 express a project via a build system.
101 In the subsequent chapters, we will describe the different project
102 types (@pxref{Creating a project}), as well as the commands to build
103 and debug projects (@pxref{Building and Debugging}).
105 In @ede{}, a project hierarchy matches a directory hierarchy. The
106 project's topmost directory is called the @dfn{project root}, and its
107 subdirectories are @dfn{subprojects}.
109 Each project can contain multiple @dfn{targets}. A target, at the
110 simplest level, is a named collection of files within a project. A
111 target can specify two different types of information:
115 A collection of files to be added to a distribution (e.g., a tarball
116 that you intend to distribute to others).
119 A collection of files that can be built into something else (e.g., a
120 program or compiled documentation).
123 Lastly, @ede{} provides a way for other tools to easily learn file
124 associations. For example, a program might need to restrict some sort
125 of search to files in a single target, or to discover the location of
126 documentation or interface files. @ede{} can provide this
129 @node EDE Mode, Creating a project, EDE Project Concepts, top
132 @ede{} is implemented as a minor-mode, which augments other modes such
133 as C mode, and Texinfo mode. You can enable @ede{} for all buffers by
134 running the command @code{global-ede-mode}, or by putting this in your
135 @file{~/.emacs} file:
141 When @ede{} is active for a given buffer, the menu item
142 ``Development'' appears. This menu provides several menu items for
143 high-level @ede{} commands. These menu items, and their corresponding
144 keybindings, are independent of the type of project you are actually
147 @node Creating a project, Modifying your project, EDE Mode, top
148 @chapter Creating a project
150 To create a new project, first visit a file that you want to include
151 in that project. If you have a hierarchy of directories, choose a
152 file in the topmost directory first. From this buffer, type @kbd{M-x
153 ede-new}, or click on the @samp{Create Project} item in the
154 @samp{Development} menu.
156 The @command{ede-new} command prompts for the type of project you
157 would like to create. Each project type has its own benefits or
158 language specific enhancements. @ede{} supports four different
159 project types: @samp{Make}, @samp{Automake}, @samp{direct Automake},
164 For the @samp{Make} project type, @ede{} creates a @dfn{project file},
165 called @file{Project.ede}, in each project directory. Information
166 about the project is stored in this file. This project autogenerates
170 For the @samp{Automake} project type, @ede{} creates a
171 @file{Project.ede} project file similar to a @samp{Make} project.
172 Unlike a @samp{Make} project, this project autogenerates a
173 @file{Makefile.am} file. @ede{} handles the Automake bootstrapping
174 routines, which import and maintain a @file{configure.am} script and
175 other required files.
178 For the @samp{direct Automake} project type, @ede{} reads directly
179 from the Automake files.
181 You cannot create direct Automake projects with the @command{ede-new}
182 command. Instead, when you visit a project with existing Automake
183 files, @ede{} automatically detects them.
186 The @samp{Simple} project type provides light-weight constructs for
187 identifying a project root and looking up files. If you already have
188 a non-@ede{} project infrastructure, you can use a @samp{Simple}
189 project to provide other Emacs packages, such as Semantic, with some
190 information about the project. @xref{Simple projects}.
193 A subproject is merely a project in a subdirectory of another project.
194 You can create a subproject by using the @command{ede-new} command (or
195 the @samp{Create Project} menu item), while visiting a buffer in a
196 subdirectory of the project root. This new project is automatically
197 added to the parent project, and will be automatically loaded when
198 @ede{} reads the parent project.
200 When using a project command that involves a makefile, @ede{} uses
201 the top-most project's makefile as a starting place for the build. How
202 the toplevel project handles subprojects in the build process is
203 dependent on that project's type.
205 @node Modifying your project, Building and Debugging, Creating a project, top
206 @chapter Modifying your project
208 In this chapter, we describe the generic features for manipulating
209 projects, including the targets and files within them. Subsequent
210 chapters, which describe specific project types, will provide more
211 detailed information about exactly what these features do.
214 * Add/Remove target::
216 * Customize Features::
217 * EDE Project Features::
220 @node Add/Remove target, Add/Remove files, Modifying your project, Modifying your project
221 @section Add/Remove target
223 To create a new target, type @kbd{C-c . t} (@code{M-x ede-new-target})
224 or use the @samp{Add Target} menu item in the @samp{Project Options}
225 submenu. This prompts for a target name, and adds the current buffer
228 The @command{ede-new-target} command also prompts for a @dfn{target
229 type}. Each target type has its own build process and class of files
232 To remove a target from the project, type @kbd{M-x ede-delete-target},
233 or use the @samp{Remove Target} menu item in the @samp{Project
236 @node Add/Remove files, Customize Features, Add/Remove target, Modifying your project
237 @section Add/Remove files
239 To add the current file to an existing target, type @kbd{C-c . a}
240 (@code{ede-add-file}), or or use the @samp{Add File} menu item in the
241 @samp{Target Options} submenu.
243 You can add a file to more than one target; this is OK.
245 To remove the current file from a target, type @kbd{C-c . d}
246 (@code{ede-remove-file}), or or use the @samp{Remove File} menu item
247 in the @samp{Target Options} submenu. If the file belongs to multiple
248 targets, this command prompts for each target it could be removed
251 While working in a project, if you visit a file that is not part of an
252 existing target, @ede{} automatically prompts for a target. If you do
253 not wish to add the file to any target, you can choose @samp{none}.
254 You can customize this behavior with the variable
255 @command{ede-auto-add-method}.
257 @node Customize Features, EDE Project Features, Add/Remove files, Modifying your project
258 @section Customize Features
260 A project, and its targets, are objects using the @samp{EIEIO} object
261 system. @xref{Top,,,eieio,EIEIO manual}. These objects have data
262 fields containing important information related to your work.
264 If the high-level functions aren't enough, you can tweak all
265 user-customizable fields at any time by running the command
266 @command{customize-project} or @command{customize-target}. This loads
267 the current project or target into a customization buffer, where you
268 can tweak individual slots. This is usually necessary for complex
271 Some project modes do not have a project file, but directly read a
272 Makefile or other existing file. Instead of directly editing the
273 object, you can edit the file by typine @kbd{C-c . e}
274 (@code{ede-edit-file-target}). You should ``rescan'' the project
275 afterwards (@pxref{Miscellaneous commands}).
277 @node EDE Project Features, , Customize Features, Modifying your project
278 @section EDE Project Features
280 This section details user facing features of an @ede{} @samp{Make}
281 style project. An @samp{Automake} project has similar options (but a
282 direct Automake project does not).
284 To modify any of the specific features mentioned here, you need to
285 customize the project or target with @command{customize-project} or
286 @command{customize-target}.
288 When you are customizing, you are directly manipulating slot values in
289 @eieio{} objects. @xref{Extending EDE}, if you are interested in
293 * Changing Compilers and Flags::
297 @node Changing Compilers and Flags, Configurations, EDE Project Features, EDE Project Features
298 @subsection Changing Compilers and Flags
300 Targets that build stuff need compilers. To change compilers, you
301 need to customize the desired target.
303 In the @samp{[Make]} section, you can choose a new compiler or linker
304 from the list. If a linker you need is not available, you will need
305 to create a new one. @xref{Compiler and Linker objects}.
307 If an existing compiler or linker is close, but you need to modify
308 some flag set such as adding an include path you will need to add a
309 configuration variable.
311 To start, you should create the basic setup, and construct a makefile
312 with @command{ede-proj-regenerate}. Look in the @file{Makefile} to
313 see what commands are inserted. Once you have determined the variable
314 you need to modify, you can add a configuration for it.
315 @xref{Configurations}.
317 @node Configurations, , Changing Compilers and Flags, EDE Project Features
318 @subsection Configurations
320 Configurations specify different ways to build a project. For
321 example, you may configure a project to be in ``debug'' mode, or
322 perhaps in ``release'' mode.
324 The project, and each target type all have a slot named
325 @code{configuration-variables}. To add new variables to a
326 configuration find this slot in the custom buffer, and insert a new
327 configuration. Name it either ``debug'' or ``release'', then insert
328 some number of name/value pairs to it.
330 You can have any number of valid configurations too. To add a new
331 configuration, customize your project. Work in the @samp{[Settings]}
332 block for ``configurations''. Add a new named configuration here.
334 To switch between different active configurations, modify the
335 ``configuration default'' slot.
337 @node Building and Debugging, Miscellaneous commands, Modifying your project, top
338 @chapter Building and Debugging
340 @ede{} provides the following ``project-aware'' compilation and
345 Compile the current target (@code{ede-compile-target}).
347 Compile the entire project (@code{ede-compile-project}).
349 Debug the current target (@code{ede-debug-target}).
350 @item M-x ede-make-dist
351 Build a distribution file for your project.
354 These commands are also available from the @samp{Development} menu.
356 @node Miscellaneous commands, Simple projects, Building and Debugging, top
357 @chapter Miscellaneous commands
359 If you opt to go in and edit @ede{} project files directly---for
360 instance, by using @kbd{C-c . e} (@pxref{Customize Features})---you
361 must then ``rescan'' the project files to update the internal data
362 structures. To rescan the current project, type @kbd{C-c . g}
363 (@code{ede-rescan-toplevel}).
365 @ede{} can help you find files in your project, via the command
366 @kbd{C-c . f} (@code{ede-find-file}). This prompts for a file name;
367 you need not specify the directory. EDE then tries to visit a file
368 with that name somewhere in your project.
370 @ede{} can use external tools to help with file finding. To do this,
371 customize @code{ede-locate-setup-options}.
373 @defvar ede-locate-setup-options
374 @anchor{ede-locate-setup-options}
375 List of locate objects to try out by default.
376 Listed in order of preference. If the first item cannot be used in
377 a particular project, then the next one is tried.
378 It is always assumed that @dfn{ede-locate-base} is at end of the list.
381 @ede{} also provides a project display mode for the speedbar
382 (@pxref{Speedbar,,,emacs,GNU Emacs Manual}). This allows you to view
383 your source files as they are structured in your project: as a
384 hierarchical tree, grouped according to target.
386 To activate the speedbar in this mode, type @kbd{C-c . s}
387 (@code{ede-speedbar}).
389 @node Simple projects, Extending EDE, Miscellaneous commands, top
390 @section Simple Projects
392 There is a wide array of Simple projects. The root for simple
393 projects is the class @code{ede-simple-project}. This handles the
394 infrastructure of storing a .ede file if needed.
396 The class @code{ede-simple-project} is designed to be subclassed.
397 Then key @ede{} methods can be overridden to provide a quick wrapper
400 A second project type is @code{ede-cpp-root}. This project type is
401 designed to be created for a directory hierarchy full of C/C++ code.
402 It can be configured with minimal lisp knowledge to do header file
403 lookup for @semantic{}, improving code completion performance.
406 * ede-cpp-root:: This project marks the root of a C/C++ code project.
407 * ede-simple subclassing:: Create your own simple project.
408 * ede-emacs:: A project for working with Emacs.
409 * ede-linux:: A project for working with Linux kernels.
410 * Custom Locate:: Customizing how to locate files in a simple project
414 @subsection ede-cpp-root
416 The @code{ede-cpp-root} project type allows you to create a single
417 object with no save-file in your @file{.emacs} file. It allows @ede{}
418 to provide the @semantic{} package with the ability to find header
421 The @code{ede-cpp-root} class knows a few things about C++ projects,
422 such as the prevalence of "include" directories, and typical
423 file-layout stuff. If this isn't sufficient, you can subclass
424 @code{ede-cpp-root-project} and add your own tweaks in just a few
425 lines. See the end of this file for an example.
427 In the most basic case, add this to your @file{.emacs} file, modifying
428 appropriate bits as needed.
431 (ede-cpp-root-project "SOMENAME" :file "/dir/to/some/file")
434 Replace @var{SOMENAME} with whatever name you want, and the filename
435 to an actual file at the root of your project. It might be a
436 Makefile, a README file. Whatever. It doesn't matter. It's just a
437 key to hang the rest of @ede{} off of.
439 The most likely reason to create this project, is to speed up
440 searching for includes files, or to simplify bootstrapping @semantic{}'s
441 ability to find files without much user interaction. In conjunction
442 with @semantic{} completion, having a short include path is key. You can
443 override the default include path and system include path like this:
446 (ede-cpp-root-project "NAME" :file "FILENAME"
447 :include-path '( "/include" "../include" "/c/include" )
448 :system-include-path '( "/usr/include/c++/3.2.2/" )
449 :spp-table '( ("MOOSE" . "")
450 ("CONST" . "const") ) )
453 In this case each item in the include path list is searched. If the
454 directory starts with "/", then that expands to the project root
455 directory. If a directory does not start with "/", then it is
456 relative to the default-directory of the current buffer when the file
459 The include path only affects C/C++ header files. Use the slot
460 @code{:header-match-regexp} to change it.
462 The @code{:system-include-path} allows you to specify full directory
463 names to include directories where system header files can be found.
464 These will be applied to files in this project only.
466 The @code{:spp-table} provides a list of project specific #define
467 style macros that are unique to this project, passed in to the
468 compiler on the command line, or are in special headers.
469 See the @code{semantic-lex-c-preprocessor-symbol-map} for more
470 on how to format this entry.
472 If there is a single file in your project, you can instead set the
473 @code{:spp-files} to a list of file names relative to the root of your
474 project. Specifying this is like setting the variable
475 @code{semantic-lex-c-preprocessor-symbol-file} in semantic.
477 If you want to override the file-finding tool with your own
478 function you can do this:
481 (ede-cpp-root-project "NAME" :file "FILENAME" :locate-fcn 'MYFCN)
484 Where @var{MYFCN} is a symbol for a function. The locate function can
485 be used in place of @code{ede-expand-filename} so you can quickly
486 customize your custom target to use specialized local routines instead
487 of the default @ede{} routines. The function symbol must take two
492 The name of the file to find.
494 The directory root for this cpp-root project.
498 If the cpp-root project style is right for you, but you want a dynamic
499 loader, instead of hard-coding path name values in your @file{.emacs}, you
500 can do that too, but you will need to write some lisp code.
502 To do that, you need to add an entry to the
503 @code{ede-project-class-files} list, and also provide two functions to
504 teach @ede{} how to load your project pattern
506 It would look like this:
509 (defun MY-FILE-FOR-DIR (&optional dir)
510 "Return a full file name to the project file stored in DIR."
511 <write your code here, or return nil>
514 (defun MY-ROOT-FCN ()
515 "Return the root fcn for `default-directory'"
516 ;; You might be able to use `ede-cpp-root-project-root'
517 ;; and not write this at all.
521 "Load a project of type `cpp-root' for the directory DIR.
522 Return nil if there isn't one."
523 ;; Use your preferred constructin method here.
524 (ede-cpp-root-project "NAME" :file (expand-file-name "FILE" dir)
528 (add-to-list 'ede-project-class-files
529 (ede-project-autoload "cpp-root"
532 :proj-file 'MY-FILE-FOR-DIR
533 :proj-root 'MY-ROOT-FCN
535 :class-sym 'ede-cpp-root)
539 This example only creates an auto-loader, and does not create a new kind
542 @xref{ede-cpp-root-project}, for details about the class that defines
543 the @code{ede-cpp-root} project type.
545 @node ede-simple subclassing
546 @subsection ede-simple Subclassing
548 todo - Write some doc.
550 In the meantime look in the commentary of ede-simple.el
553 @subsection ede-emacs
555 The @code{ede-emacs} project automatically identifies an Emacs source
556 tree, and enables EDE project mode for it.
558 It pre-populates the C Preprocessor symbol map for correct parsing,
559 and has an optimized include file identification function.
562 @subsection ede-linux
564 The @code{ede-linux} project will automatically identify a Linux
565 Kernel source tree, and enable EDE project mode for it.
567 It pre-populates the C Preprocessor symbol map for reasonable parsing,
568 and has an optimized include file identification function.
571 @subsection Custom Locate
573 The various simple project styles all have one major drawback, which
574 is that the files in the project are not completely known to EDE.
575 When the EDE API is used to try and file files by some reference name
576 in the project, then that could fail.
578 @@TODO - Add ID Utils and CScope examples
580 @ede{} can therefore use some external locate commands, such as the unix
581 ``locate'' command, or ``GNU Global''.
583 Configuration of the tool you want to use such as @code{locate}, or
584 @code{global} will need to be done without the aid of @ede{}. Once
585 configured, however, @ede{} can use it.
587 To enable one of these tools, set the variable
588 @code{ede-locate-setup-options} with the names of different locate
589 objects. @ref{Miscellaneous commands}.
591 Configure this in your @file{.emacs} before loading in CEDET or EDE.
592 If you want to add support for GNU Global, your configuration would
596 (setq ede-locate-setup-options '(ede-locate-global ede-locate-base))
599 That way, when a search needs to be done, it will first try using
600 GLOBAL. If global is not available for that directory, then it will
601 revert to the base locate object. The base object always fails to
604 You can add your own locate tool but subclassing from
605 @code{ede-locate-base}. The subclass should also implement two
606 methods. See the code in @file{ede-locate.el} for GNU Global as a
609 @node Extending EDE, , Simple projects, top
610 @chapter Extending @ede{}
612 This chapter is intended for users who want to write new parts or fix
613 bugs in @ede{}. A knowledge of Emacs Lisp, and some @eieio{}(CLOS) is
616 @ede{} uses @eieio{}, the CLOS package for Emacs, to define two object
617 superclasses, specifically the PROJECT and TARGET. All commands in
618 @ede{} are usually meant to address the current project, or current
621 All specific projects in @ede{} derive subclasses of the @ede{}
622 superclasses. In this way, specific behaviors such as how a project
623 is saved, or how a target is compiled can be customized by a project
624 author in detail. @ede{} communicates to these project objects via an
625 API using methods. The commands you use in @ede{} mode are high-level
626 functional wrappers over these methods. @xref{(eieio)Top}. For
627 details on using @eieio{} to extending classes, and writing methods.
629 If you intend to extend @ede{}, it is most likely that a new target type is
630 needed in one of the existing project types. The rest of this chapter
631 will discuss extending the @code{ede-project} class, and it's targets.
632 See @file{project-am.el} for basic details on adding targets to it.
634 For the @code{ede-project} type, the core target class is called
635 @code{ede-proj-target}. Inheriting from this will give you everything
636 you need to start, including adding your sources into the makefile. If
637 you also need additional rules in the makefile, you will want to inherit
638 from @code{ede-proj-target-makefile} instead. You may want to also add
639 new fields to track important information.
641 If you are building currently unsupported code into a program or shared
642 library, it is unlikely you need a new target at all. Instead you
643 would need to create a new compiler or linker object that compiles
644 source code of the desired type. @ref{Compiler and Linker objects}.
646 Once your new class exists, you will want to fill in some basic methods.
647 See the @file{ede-skel.el} file for examples of these. The files
648 @file{ede-proj-info.el} and @file{ede-proj-elisp.el} are two interesting
652 * User interface methods:: Methods associated with keybindings
653 * Base project methods:: The most basic methods on @ede{} objects.
654 * Sourcecode objects:: Defining new sourcecode classes.
655 * Compiler and Linker objects:: Defining new compilers and linkers.
656 * Project:: Details of project classes.
657 * Targets:: Details of target classes.
658 * Sourcecode:: Details of source code classes.
659 * Compilers:: Details of compiler classes.
662 @node User interface methods
663 @section User interface methods
665 These methods are core behaviors associated with user commands.
666 If you do not implement a method, there is a reasonable default that
667 may do what you need.
670 @item project-add-file
671 Add a file to your project. Override this if you want to put new
672 sources into different fields depending on extension, or other details.
673 @item project-remove-file
674 Reverse of project-add-file.
675 @item project-compile-target
676 Override this if you want to do something special when the user
677 "compiles" this target.
678 @item project-debug-target
679 What to do when a user wants to debug your target.
680 @item project-update-version
681 Easily update the version number of your project.
682 @item project-edit-file-target
683 Edit the file the project's information is stored in.
684 @item project-new-target
685 Create a new target in a project.
686 @item project-delete-target
687 Delete a target from a project.
688 @item project-make-dist
689 Make a distribution (tar archive) of the project.
691 Rescan a project file, changing the data in the existing objects.
694 @node Base project methods
695 @section Base project methods
697 These methods are important for querying base information from project
702 Return a string that is the name of this target.
703 @item ede-target-name
704 Return a string that is the name of the target used by a Make system.
705 @item ede-description
706 A brief description of the project or target. This is currently used
707 by the @samp{ede-speedbar} interface.
708 @item ede-want-file-p
709 Return non-nil if a target will accept a given file.
710 It is generally unecessary to override this. See the section on source
712 @item ede-buffer-mine
713 Return non-nil if a buffer belongs to this target. Used during
714 association when a file is loaded. It is generally unecessary to
715 override this unless you keep auxiliary files.
718 These methods are used by the semantic package extensions @xref{(semantic)Top}.
721 @item ede-buffer-header-file
722 Return a header file belonging to a given buffer. Prototypes are place
723 there when appropriate
724 @item ede-buffer-documentation-files
725 Return the documentation file information about this file would be
727 @item ede-documentation
728 List all documentation a project or target is responsible for.
731 @node Sourcecode objects
732 @section Sourcecode objects
734 @ede{} projects track source file / target associates via source code
735 objects. The definitions for this is in @file{ede-source.el}. A source
736 code object contains methods that know how to identify a file as being
737 of that class, (ie, a C file ends with @file{.c}). Some targets can
738 handle many different types of sources which must all be compiled
739 together. For example, a mixed C and C++ program would have
740 instantiations of both sourcecode types.
742 When a target needs to know if it will accept a source file, it
743 references its list of source code objects. These objects then make
746 Source code objects are stored in the target objects as a list of
747 symbols, where the symbol's value is the object. This enables the
748 project save file mechanism to work.
750 Here is an example for an instantiation of an Emacs Lisp source code object:
753 (defvar ede-source-emacs
754 (ede-sourcecode "ede-emacs-source"
756 :sourcepattern "\\.el$"
757 :garbagepattern '("*.elc"))
758 "Emacs Lisp source code definition.")
761 If you want to recycle parts of an existing sourcecode object, you can
762 clone the original, and then just tweak the parts that are different.
766 (defvar ede-source-emacs-autoload
767 (clone ede-source-emacs "ede-source-emacs-autoload"
768 :name "Emacs Lisp Autoload"
769 :sourcepattern "-loaddefs\\.el")
770 "Emacs Lisp autoload source code.")
773 In this case, the garbage pattern is the same.
777 @node Compiler and Linker objects
778 @section Compiler and Linker objects
780 In order for a target to create a @file{Makefile}, it must know how to
781 compile the sources into the program or desired data file, and
782 possibly link them together.
784 A compiler object instantiation is used to associate a given target
785 with a given source code type. Some targets can handle many types of
786 sources, and thus has many compilers available to it. Some targets
787 may have multiple compilers for a given type of source code.
789 @ede{} will examine the actual source files in a target, cross reference
790 that against the compiler list to come up with the final set of
791 compilers that will be inserted into the Makefile.
793 Compiler instantiations must also insert variables specifying the
794 compiler it plans to use, in addition to creating Automake settings for
795 @file{configure.in} when appropriate.
797 Compiler objects are stored in the target objects as a list of
798 symbols, where the symbols value is the object. This enables the
799 project output mechanism to work more efficiently.
801 Targets will also have a special "compiler" slot which lets a user
802 explicitly choose the compiler they want to use.
804 Here is an example for texinfo:
807 (defvar ede-makeinfo-compiler
809 "ede-makeinfo-compiler"
811 :variables '(("MAKEINFO" . "makeinfo"))
812 :commands '("makeinfo -o $@ $<")
813 :autoconf '(("AC_CHECK_PROG" . "MAKEINFO, makeinfo"))
814 :sourcetype '(ede-makeinfo-source)
816 "Compile texinfo files into info files.")
821 When creating compiler instantiations, it may be useful to @code{clone}
822 an existing compiler variable. Cloning allows you to only modify
823 parts of the original, while keeping the rest of the same.
824 Modification of the original will result in the clone also being
825 changed for shared value slots.
827 The second important object is the linker class. The linker is similar
828 to the compiler, except several compilers might be used to create some
829 object files, and only one linker is used to link those objects together.
831 See @file{ede-proj-obj.el} for examples of the combination.
842 * ede-project-placeholder ::
844 * ede-cpp-root-project ::
845 * ede-simple-project ::
846 * ede-simple-base-project ::
847 * ede-proj-project ::
848 * project-am-makefile ::
849 * ede-step-project ::
852 @node ede-project-placeholder
853 @subsection ede-project-placeholder
854 @pjindex ede-project-placeholder
857 @item Inheritance Tree:
861 @item eieio-speedbar-directory-button
863 @item ede-project-placeholder
866 @w{@xref{ede-project}.}
878 Type: @code{string} @*
879 Default Value: @code{"Untitled"}
881 The name used when generating distribution files.
885 Type: @code{string} @*
886 Default Value: @code{"1.0"}
888 The version number used when distributing files.
894 Directory this project is associated with.
900 File name where this project is stored.
907 @subsubsection Specialized Methods
909 @deffn Method ede--project-inode :AFTER proj
910 Get the inode of the directory project @var{PROJ} is in.
913 @deffn Method ede-project-root :AFTER this
914 If a project knows it's root, return it here.
915 Allows for one-project-object-for-a-tree type systems.
918 @deffn Method ede-find-subproject-for-directory :AFTER proj dir
919 Find a subproject of @var{PROJ} that corresponds to @var{DIR}.
922 @deffn Method ede-project-root-directory :AFTER this &optional file
923 If a project knows it's root, return it here.
924 Allows for one-project-object-for-a-tree type systems.
925 Optional @var{FILE} is the file to test. It is ignored in preference
926 of the anchor file for the project.
929 @deffn Method ede-project-force-load :AFTER this
930 Make sure the placeholder @var{THIS} is replaced with the real thing.
931 Return the new object created in its place.
934 @deffn Method project-interactive-select-target :AFTER this prompt
935 Make sure placeholder @var{THIS} is replaced with the real thing, and pass through.
938 @deffn Method project-add-file :AFTER this file
939 Make sure placeholder @var{THIS} is replaced with the real thing, and pass through.
943 @subsection ede-project
947 @item Inheritance Tree:
951 @item eieio-speedbar-directory-button
953 @item @w{@xref{ede-project-placeholder}.}
958 @w{@xref{ede-cpp-root-project},} @w{ede-emacs-project,} @w{ede-linux-project,} @w{ede-maven-project,} @w{@xref{ede-simple-project},} @w{@xref{ede-simple-base-project},} @w{@xref{ede-proj-project},} @w{@xref{project-am-makefile},} @w{@xref{ede-step-project}.}
973 List of top level targets in this project.
979 List of tool cache configurations in this project.
980 This allows any tool to create, manage, and persist project-specific settings.
984 Type: @code{string} @*
986 URL to this projects web site.
987 This is a URL to be sent to a web site for documentation.
990 @item :web-site-directory @*
992 A directory where web pages can be found by Emacs.
993 For remote locations use a path compatible with ange-ftp or EFS.
994 You can also use TRAMP for use with rcp & scp.
997 @item :web-site-file @*
999 A file which contains the home page for this project.
1000 This file can be relative to slot @code{web-site-directory}.
1001 This can be a local file, use ange-ftp, EFS, or TRAMP.
1005 Type: @code{string} @*
1007 FTP site where this project's distribution can be found.
1008 This FTP site should be in Emacs form, as needed by @code{ange-ftp}, but can
1009 also be of a form used by TRAMP for use with scp, or rcp.
1012 @item :ftp-upload-site
1013 Type: @code{string} @*
1015 FTP Site to upload new distributions to.
1016 This FTP site should be in Emacs form as needed by @code{ange-ftp}.
1017 If this slot is @code{nil}, then use @code{ftp-site} instead.
1020 @item :configurations
1021 Type: @code{list} @*
1022 Default Value: @code{("debug" "release")}
1024 List of available configuration types.
1025 Individual target/project types can form associations between a configuration,
1026 and target specific elements such as build variables.
1029 @item :configuration-default @*
1030 Default Value: @code{"debug"}
1032 The default configuration.
1035 @item :local-variables @*
1036 Default Value: @code{nil}
1038 Project local variables
1044 @subsubsection Specialized Methods
1046 @deffn Method ede-preprocessor-map :AFTER this
1047 Get the pre-processor map for project @var{THIS}.
1050 @deffn Method ede-subproject-relative-path :AFTER proj &optional parent-in
1051 Get a path name for @var{PROJ} which is relative to the parent project.
1052 If PARENT is specified, then be relative to the PARENT project.
1053 Specifying PARENT is useful for sub-sub projects relative to the root project.
1056 @deffn Method eieio-speedbar-description :AFTER obj
1057 Provide a speedbar description for @var{OBJ}.
1060 @deffn Method ede-map-any-target-p :AFTER this proc
1061 For project @var{THIS}, map @var{PROC} to all targets and return if any non-nil.
1062 Return the first non-@code{nil} value returned by @var{PROC}.
1065 @deffn Method ede-map-subprojects :AFTER this proc
1066 For object @var{THIS}, execute @var{PROC} on all direct subprojects.
1067 This function does not apply @var{PROC} to sub-sub projects.
1068 See also @dfn{ede-map-all-subprojects}.
1071 @deffn Method ede-convert-path :AFTER this path
1072 Convert path in a standard way for a given project.
1073 Default to making it project relative.
1074 Argument @var{THIS} is the project to convert @var{PATH} to.
1077 @deffn Method ede-name :AFTER this
1078 Return a short-name for @var{THIS} project file.
1079 Do this by extracting the lowest directory name.
1082 @deffn Method ede-set-project-variables :AFTER project &optional buffer
1083 Set variables local to @var{PROJECT} in @var{BUFFER}.
1086 @deffn Method eieio-speedbar-derive-line-path :AFTER obj &optional depth
1087 Return the path to @var{OBJ}.
1088 Optional @var{DEPTH} is the depth we start at.
1091 @deffn Method ede-map-all-subprojects :AFTER this allproc
1092 For object @var{THIS}, execute PROC on @var{THIS} and all subprojects.
1093 This function also applies PROC to sub-sub projects.
1094 See also @dfn{ede-map-subprojects}.
1097 @deffn Method project-update-version :AFTER ot
1098 The @code{:version} of the project @var{OT} has been updated.
1099 Handle saving, or other detail.
1102 @deffn Method ede-buffer-header-file :AFTER this buffer
1103 Return @code{nil}, projects don't have header files.
1106 @deffn Method ede-buffer-documentation-files :AFTER this buffer
1107 Return all documentation in project @var{THIS} based on @var{BUFFER}.
1110 @deffn Method ede-map-targets :AFTER this proc
1111 For object @var{THIS}, execute @var{PROC} on all targets.
1114 @deffn Method ede-buffer-mine :AFTER this buffer
1115 Return non-@code{nil} if object @var{THIS} lays claim to the file in @var{BUFFER}.
1118 @deffn Method ede-object-keybindings :BEFORE this
1119 Retrieves the slot @code{keybindings} from an object of class @code{ede-project}
1122 @deffn Method ede-description :AFTER this
1123 Return a description suitable for the minibuffer about @var{THIS}.
1126 @deffn Method eieio-speedbar-object-children :AFTER this
1127 Return the list of speedbar display children for @var{THIS}.
1130 @deffn Method project-make-dist :AFTER this
1131 Build a distribution for the project based on @var{THIS} project.
1134 @deffn Method ede-system-include-path :AFTER this
1135 Get the system include path used by project @var{THIS}.
1138 @deffn Method project-new-target-custom :AFTER proj
1139 Create a new target. It is up to the project @var{PROJ} to get the name.
1142 @deffn Method ede-subproject-p :AFTER proj
1143 Return non-@code{nil} if @var{PROJ} is a sub project.
1146 @deffn Method ede-expand-filename :AFTER this filename &optional force
1147 Return a fully qualified file name based on project @var{THIS}.
1148 @var{FILENAME} should be just a filename which occurs in a directory controlled
1150 Optional argument @var{FORCE} forces the default filename to be provided even if it
1154 @deffn Method ede-menu-items-build :AFTER obj &optional current
1155 Return a list of menu items for building project @var{OBJ}.
1156 If optional argument @var{CURRENT} is non-@code{nil}, return sub-menu code.
1159 @deffn Method ede-update-version-in-source :AFTER this version
1160 Change occurrences of a version string in sources.
1161 In project @var{THIS}, cycle over all targets to give them a chance to set
1162 their sources to @var{VERSION}.
1165 @deffn Method project-new-target :AFTER proj &rest args
1166 Create a new target. It is up to the project @var{PROJ} to get the name.
1169 @deffn Method project-compile-project :AFTER obj &optional command
1170 Compile the entire current project @var{OBJ}.
1171 Argument @var{COMMAND} is the command to use when compiling.
1174 @deffn Method eieio-speedbar-object-buttonname :AFTER object
1175 Return a string to use as a speedbar button for @var{OBJECT}.
1178 @deffn Method ede-map-project-buffers :AFTER this proc
1179 For @var{THIS}, execute @var{PROC} on all buffers belonging to @var{THIS}.
1182 @deffn Method ede-expand-filename-impl :AFTER this filename &optional force
1183 Return a fully qualified file name based on project @var{THIS}.
1184 @var{FILENAME} should be just a filename which occurs in a directory controlled
1186 Optional argument @var{FORCE} forces the default filename to be provided even if it
1190 @deffn Method eieio-done-customizing :AFTER proj
1191 Call this when a user finishes customizing @var{PROJ}.
1194 @deffn Method ede-html-documentation :AFTER this
1195 Return a list of HTML files provided by project @var{THIS}.
1198 @deffn Method ede-documentation :AFTER this
1199 Return a list of files that provides documentation.
1200 Documentation is not for object @var{THIS}, but is provided by @var{THIS} for other
1201 files in the project.
1204 @deffn Method project-interactive-select-target :AFTER this prompt
1205 Interactively query for a target that exists in project @var{THIS}.
1206 Argument @var{PROMPT} is the prompt to use when querying the user for a target.
1209 @deffn Method ede-target-in-project-p :AFTER proj target
1210 Is @var{PROJ} the parent of @var{TARGET}?
1211 If @var{TARGET} belongs to a subproject, return that project file.
1214 @deffn Method ede-find-target :AFTER proj buffer
1215 Fetch the target in @var{PROJ} belonging to @var{BUFFER} or nil.
1218 @deffn Method ede-add-subproject :AFTER proj-a proj-b
1219 Add into @var{PROJ-A}, the subproject @var{PROJ-B}.
1222 @deffn Method ede-commit-project :AFTER proj
1223 Commit any change to @var{PROJ} to its file.
1226 @deffn Method project-dist-files :AFTER this
1227 Return a list of files that constitutes a distribution of @var{THIS} project.
1230 @deffn Method ede-object-menu :BEFORE this
1231 Retrieves the slot @code{menu} from an object of class @code{ede-project}
1234 @deffn Method ede-commit-local-variables :AFTER proj
1235 Commit change to local variables in @var{PROJ}.
1238 @node ede-cpp-root-project
1239 @subsection ede-cpp-root-project
1240 @pjindex ede-cpp-root-project
1243 @item Inheritance Tree:
1245 @item eieio-speedbar
1247 @item eieio-speedbar-directory-button
1249 @item @w{@xref{ede-project-placeholder}.}
1251 @item @w{@xref{ede-project}.}
1253 @item ede-cpp-root-project
1262 This class implements the @code{ede-cpp-root} project type.
1263 @xref{ede-cpp-root}, for information about using this project type.
1270 Type: @code{list} @*
1271 Default Value: @code{(quote ("/include" "../include/"))}
1273 The default locate function expands filenames within a project.
1274 If a header file (.h, .hh, etc) name is expanded, and
1275 the @code{:locate-fcn} slot is @code{nil}, then the include path is checked
1276 first, and other directories are ignored. For very large
1277 projects, this optimization can save a lot of time.
1279 Directory names in the path can be relative to the current
1280 buffer's @code{default-directory} (not starting with a /). Directories
1281 that are relative to the project's root should start with a /, such
1282 as "/include", meaning the directory @code{include} off the project root
1286 @item :system-include-path
1287 Type: @code{list} @*
1288 Default Value: @code{nil}
1290 The system include path for files in this project.
1291 C files initialized in an ede-cpp-root-project have their semantic
1292 system include path set to this value. If this is @code{nil}, then the
1293 semantic path is not modified.
1297 Type: @code{list} @*
1298 Default Value: @code{nil}
1300 C Preprocessor macros for your files.
1301 Preprocessor symbols will be used while parsing your files.
1302 These macros might be passed in through the command line compiler, or
1303 are critical symbols derived from header files. Providing header files
1304 macro values through this slot improves accuracy and performance.
1305 Use `:spp-files' to use these files directly.
1309 Type: @code{list} @*
1310 Default Value: @code{nil}
1312 C header file with Preprocessor macros for your files.
1313 The PreProcessor symbols appearing in these files will be used while
1314 parsing files in this project.
1315 See @code{semantic-lex-c-preprocessor-symbol-map} for more on how this works.
1318 @item :header-match-regexp
1319 Type: @code{string} @*
1320 Default Value: @code{"\\.\\(h\\(h\\|xx\\|pp\\|\\+\\+\\)?\\|H\\)$\\|\\<\\w+$"}
1322 Regexp used to identify C/C++ header files.
1326 Type: @code{(or null function)} @*
1327 Default Value: @code{nil}
1329 The locate function can be used in place of
1330 @dfn{ede-expand-filename} so you can quickly customize your custom target
1331 to use specialized local routines instead of the EDE routines.
1332 The function symbol must take two arguments:
1333 NAME - The name of the file to find.
1334 DIR - The directory root for this cpp-root project.
1336 It should return the fully qualified file name passed in from NAME. If that file does not
1337 exist, it should return nil.
1343 @subsubsection Specialized Methods
1345 @deffn Method initialize-instance :AFTER this &rest fields
1346 Make sure the @code{:file} is fully expanded.
1349 @deffn Method ede-preprocessor-map :AFTER this
1350 Get the pre-processor map for project @var{THIS}.
1353 @deffn Method ede-cpp-root-header-file-p :AFTER proj name
1354 Non @code{nil} if in @var{PROJ} the filename @var{NAME} is a header.
1357 @deffn Method ede-system-include-path :AFTER this
1358 Get the system include path used by project @var{THIS}.
1361 @deffn Method ede-expand-filename-impl :AFTER proj name
1362 Within this project @var{PROJ}, find the file @var{NAME}.
1363 This knows details about or source tree.
1366 @node ede-simple-project
1367 @subsection ede-simple-project
1368 @pjindex ede-simple-project
1371 @item Inheritance Tree:
1373 @item eieio-speedbar
1375 @item eieio-speedbar-directory-button
1377 @item @w{@xref{ede-project-placeholder}.}
1379 @item @w{@xref{ede-project}.}
1381 @item ede-simple-project
1390 @subsubsection Specialized Methods
1392 @deffn Method ede-commit-project :AFTER proj
1393 Commit any change to @var{PROJ} to its file.
1396 @node ede-simple-base-project
1397 @subsection ede-simple-base-project
1398 @pjindex ede-simple-base-project
1401 @item Inheritance Tree:
1403 @item eieio-speedbar
1405 @item eieio-speedbar-directory-button
1407 @item @w{@xref{ede-project-placeholder}.}
1409 @item @w{@xref{ede-project}.}
1411 @item ede-simple-base-project
1420 EDE Simple project base class.
1421 This one project could control a tree of subdirectories.
1426 @node ede-proj-project
1427 @subsection ede-proj-project
1428 @pjindex ede-proj-project
1431 @item Inheritance Tree:
1433 @item eieio-speedbar
1435 @item eieio-speedbar-directory-button
1437 @item @w{@xref{ede-project-placeholder}.}
1439 @item @w{@xref{ede-project}.}
1441 @item ede-proj-project
1454 @item :makefile-type
1455 Type: @code{symbol} @*
1456 Default Value: @code{Makefile}
1458 The type of Makefile to generate.
1459 Can be one of @code{'Makefile}, 'Makefile.in, or 'Makefile.am.
1460 If this value is NOT @code{'Makefile}, then that overrides the @code{:makefile} slot
1465 Type: @code{list} @*
1466 Default Value: @code{nil}
1468 Variables to set in this Makefile.
1471 @item :configuration-variables
1472 Type: @code{list} @*
1473 Default Value: @code{("debug" (("DEBUG" . "1")))}
1475 Makefile variables to use in different configurations.
1476 These variables are used in the makefile when a configuration becomes active.
1479 @item :inference-rules @*
1480 Default Value: @code{nil}
1482 Inference rules to add to the makefile.
1485 @item :include-file @*
1486 Default Value: @code{nil}
1488 Additional files to include.
1489 These files can contain additional rules, variables, and customizations.
1492 @item :automatic-dependencies
1493 Type: @code{boolean} @*
1494 Default Value: @code{t}
1496 Non-@code{nil} to do implement automatic dependencies in the Makefile.
1499 @item :metasubproject
1500 Type: @code{boolean} @*
1501 Default Value: @code{nil}
1503 Non-@code{nil} if this is a metasubproject.
1504 Usually, a subproject is determined by a parent project. If multiple top level
1505 projects are grouped into a large project not maintained by EDE, then you need
1506 to set this to non-nil. The only effect is that the @code{dist} rule will then avoid
1513 @subsubsection Specialized Methods
1515 @deffn Method ede-proj-makefile-create :AFTER this mfilename
1516 Create a Makefile for all Makefile targets in @var{THIS}.
1517 @var{MFILENAME} is the makefile to generate.
1520 @deffn Method ede-proj-makefile-insert-rules :AFTER this
1521 Insert rules needed by @var{THIS} target.
1524 @deffn Method ede-proj-makefile-tags :AFTER this targets
1525 Insert into the current location rules to make recursive TAGS files.
1526 Argument @var{THIS} is the project to create tags for.
1527 Argument @var{TARGETS} are the targets we should depend on for TAGS.
1530 @deffn Method ede-proj-makefile-insert-variables :AFTER this
1531 Insert variables needed by target @var{THIS}.
1534 @deffn Method project-make-dist :AFTER this
1535 Build a distribution for the project based on @var{THIS} target.
1538 @deffn Method ede-proj-makefile-insert-dist-rules :AFTER this
1539 Insert distribution rules for @var{THIS} in a Makefile, such as CLEAN and DIST.
1542 @deffn Method ede-proj-makefile-insert-dist-dependencies :AFTER this
1543 Insert any symbols that the DIST rule should depend on.
1544 Argument @var{THIS} is the project that should insert stuff.
1547 @deffn Method ede-proj-makefile-insert-subproj-rules :AFTER this
1548 Insert a rule for the project @var{THIS} which should be a subproject.
1551 @deffn Method ede-proj-makefile-create-maybe :AFTER this mfilename
1552 Create a Makefile for all Makefile targets in @var{THIS} if needed.
1553 @var{MFILENAME} is the makefile to generate.
1556 @deffn Method ede-proj-configure-test-required-file :AFTER this file
1557 For project @var{THIS}, test that the file @var{FILE} exists, or create it.
1560 @deffn Method ede-proj-setup-buildenvironment :AFTER this &optional force
1561 Setup the build environment for project @var{THIS}.
1562 Handles the Makefile, or a Makefile.am configure.in combination.
1563 Optional argument @var{FORCE} will force items to be regenerated.
1566 @deffn Method ede-proj-makefile-garbage-patterns :AFTER this
1567 Return a list of patterns that are considered garbage to @var{THIS}.
1568 These are removed with make clean.
1571 @deffn Method ede-proj-configure-synchronize :AFTER this
1572 Synchronize what we know about project @var{THIS} into configure.in.
1575 @deffn Method ede-proj-makefile-insert-variables-new :AFTER this
1576 Insert variables needed by target @var{THIS}.
1578 NOTE: Not yet in use! This is part of an SRecode conversion of
1579 EDE that is in progress.
1582 @deffn Method ede-proj-makefile-configuration-variables :AFTER this configuration
1583 Return a list of configuration variables from @var{THIS}.
1584 Use @var{CONFIGURATION} as the current configuration to query.
1587 @deffn Method eieio-done-customizing :AFTER proj
1588 Call this when a user finishes customizing this object.
1589 Argument @var{PROJ} is the project to save.
1592 @deffn Method ede-proj-configure-recreate :AFTER this
1593 Delete project @var{THIS}es configure script and start over.
1596 @deffn Method ede-proj-makefile-insert-user-rules :AFTER this
1597 Insert user specified rules needed by @var{THIS} target.
1598 This is different from @dfn{ede-proj-makefile-insert-rules} in that this
1599 function won't create the building rules which are auto created with
1603 @deffn Method ede-proj-dist-makefile :AFTER this
1604 Return the name of the Makefile with the DIST target in it for @var{THIS}.
1607 @deffn Method ede-proj-configure-file :AFTER this
1608 The configure.in script used by project @var{THIS}.
1611 @deffn Method ede-commit-project :AFTER proj
1612 Commit any change to @var{PROJ} to its file.
1615 @deffn Method project-dist-files :AFTER this
1616 Return a list of files that constitutes a distribution of @var{THIS} project.
1619 @deffn Method ede-commit-local-variables :AFTER proj
1620 Commit change to local variables in @var{PROJ}.
1623 @node project-am-makefile
1624 @subsection project-am-makefile
1625 @pjindex project-am-makefile
1628 @item Inheritance Tree:
1630 @item eieio-speedbar
1632 @item eieio-speedbar-directory-button
1634 @item @w{@xref{ede-project-placeholder}.}
1636 @item @w{@xref{ede-project}.}
1638 @item project-am-makefile
1647 @subsubsection Specialized Methods
1649 @deffn Method project-am-subtree :AFTER ampf subdir
1650 Return the sub project in @var{AMPF} specified by @var{SUBDIR}.
1653 @deffn Method project-targets-for-file :AFTER proj
1654 Return a list of targets the project @var{PROJ}.
1657 @deffn Method project-new-target :AFTER proj &optional name type
1658 Create a new target named @var{NAME}.
1659 Argument @var{TYPE} is the type of target to insert. This is a string
1660 matching something in @code{project-am-type-alist} or type class symbol.
1661 Despite the fact that this is a method, it depends on the current
1662 buffer being in order to provide a smart default target type.
1665 @node ede-step-project
1666 @subsection ede-step-project
1667 @pjindex ede-step-project
1670 @item Inheritance Tree:
1672 @item eieio-speedbar
1674 @item eieio-speedbar-directory-button
1676 @item @w{@xref{ede-project-placeholder}.}
1678 @item @w{@xref{ede-project}.}
1680 @item ede-step-project
1693 @item :init-variables
1694 Type: @code{list} @*
1695 Default Value: @code{nil}
1697 Variables to set in this Makefile, at top of file.
1700 @item :additional-variables
1701 Type: @code{(or null list)} @*
1702 Default Value: @code{nil}
1704 Arbitrary variables needed from this project.
1705 It is safe to leave this blank.
1708 @item :additional-rules
1709 Type: @code{(or null list)} @*
1710 Default Value: @code{nil}
1712 Arbitrary rules and dependencies needed to make this target.
1713 It is safe to leave this blank.
1716 @item :installation-domain
1717 Type: @code{symbol} @*
1718 Default Value: @code{user}
1720 Installation domain specification.
1721 The variable GNUSTEP_INSTALLATION_DOMAIN is set at this value.
1725 Type: @code{(or null list)} @*
1726 Default Value: @code{(quote ("GNUmakefile.preamble"))}
1728 The auxiliary makefile for additional variables.
1729 Included just before the specific target files.
1733 Type: @code{(or null list)} @*
1734 Default Value: @code{(quote ("GNUmakefile.postamble"))}
1736 The auxiliary makefile for additional rules.
1737 Included just after the specific target files.
1740 @item :metasubproject
1741 Type: @code{boolean} @*
1742 Default Value: @code{nil}
1744 Non-@code{nil} if this is a metasubproject.
1745 Usually, a subproject is determined by a parent project. If multiple top level
1746 projects are grouped into a large project not maintained by EDE, then you need
1747 to set this to non-nil. The only effect is that the @code{dist} rule will then avoid
1754 @subsubsection Specialized Methods
1756 @deffn Method ede-proj-makefile-create :AFTER this mfilename
1757 Create a GNUmakefile for all Makefile targets in @var{THIS}.
1758 @var{MFILENAME} is the makefile to generate.
1761 @deffn Method project-make-dist :AFTER this
1762 Build a distribution for the project based on @var{THIS} target.
1765 @deffn Method ede-proj-makefile-create-maybe :AFTER this mfilename
1766 Create a Makefile for all Makefile targets in @var{THIS} if needed.
1767 @var{MFILENAME} is the makefile to generate.
1770 @deffn Method ede-proj-setup-buildenvironment :AFTER this &optional force
1771 Setup the build environment for project @var{THIS}.
1772 Handles the Makefile, or a Makefile.am configure.in combination.
1773 Optional argument @var{FORCE} will force items to be regenerated.
1776 @deffn Method eieio-done-customizing :AFTER proj
1777 Call this when a user finishes customizing this object.
1778 Argument @var{PROJ} is the project to save.
1781 @deffn Method ede-proj-dist-makefile :AFTER this
1782 Return the name of the Makefile with the DIST target in it for @var{THIS}.
1785 @deffn Method ede-commit-project :AFTER proj
1786 Commit any change to @var{PROJ} to its file.
1789 @deffn Method project-dist-files :AFTER this
1790 Return a list of files that constitutes a distribution of @var{THIS} project.
1793 @deffn Method ede-commit-local-variables :AFTER proj
1794 Commit change to local variables in @var{PROJ}.
1802 * ede-proj-target ::
1803 * ede-proj-target-makefile ::
1804 * semantic-ede-proj-target-grammar ::
1805 * ede-proj-target-makefile-objectcode ::
1806 * ede-proj-target-makefile-archive ::
1807 * ede-proj-target-makefile-program ::
1808 * ede-proj-target-makefile-shared-object ::
1809 * ede-proj-target-elisp ::
1810 * ede-proj-target-elisp-autoloads ::
1811 * ede-proj-target-makefile-miscelaneous ::
1812 * ede-proj-target-makefile-info ::
1813 * ede-proj-target-scheme ::
1814 * project-am-target ::
1815 * project-am-objectcode ::
1816 * project-am-program ::
1817 * project-am-header-noinst ::
1818 * project-am-header-inst ::
1819 * project-am-lisp ::
1820 * project-am-texinfo ::
1826 @subsection ede-target
1830 @item Inheritance Tree:
1832 @item eieio-speedbar
1834 @item eieio-speedbar-directory-button
1839 @w{ede-cpp-root-target,} @w{ede-emacs-target-c,} @w{ede-emacs-target-el,} @w{ede-emacs-target-misc,} @w{ede-linux-target-c,} @w{ede-linux-target-misc,} @w{ede-maven-target-java,} @w{ede-maven-target-c,} @w{ede-maven-target-misc,} @w{ede-simple-target,} @w{@xref{ede-proj-target},} @w{@xref{project-am-target}.}
1853 Name of this target.
1859 The path to the sources of this target.
1860 Relative to the path of the project it belongs to.
1864 Type: @code{list} @*
1865 Default Value: @code{nil}
1867 Source files in this target.
1870 @item :versionsource
1871 Type: @code{list} @*
1872 Default Value: @code{nil}
1874 Source files with a version string in them.
1875 These files are checked for a version string whenever the EDE version
1876 of the master project is changed. When strings are found, the version
1877 previously there is updated.
1883 @subsubsection Specialized Methods
1885 @deffn Method ede-preprocessor-map :AFTER this
1886 Get the pre-processor map for project @var{THIS}.
1889 @deffn Method eieio-speedbar-description :AFTER obj
1890 Provide a speedbar description for @var{OBJ}.
1893 @deffn Method project-compile-target :AFTER obj &optional command
1894 Compile the current target @var{OBJ}.
1895 Argument @var{COMMAND} is the command to use for compiling the target.
1898 @deffn Method project-debug-target :AFTER obj
1899 Run the current project target @var{OBJ} in a debugger.
1902 @deffn Method ede-convert-path :AFTER this path
1903 Convert path in a standard way for a given project.
1904 Default to making it project relative.
1905 Argument @var{THIS} is the project to convert @var{PATH} to.
1908 @deffn Method ede-name :AFTER this
1909 Return the name of @var{THIS} targt.
1912 @deffn Method ede-target-buffer-in-sourcelist :AFTER this buffer source
1913 Return non-@code{nil} if object @var{THIS} is in @var{BUFFER} to a @var{SOURCE} list.
1914 Handles complex path issues.
1917 @deffn Method eieio-speedbar-derive-line-path :AFTER obj &optional depth
1918 Return the path to @var{OBJ}.
1919 Optional @var{DEPTH} is the depth we start at.
1922 @deffn Method ede-buffer-header-file :AFTER this buffer
1923 There are no default header files in EDE.
1924 Do a quick check to see if there is a Header tag in this buffer.
1927 @deffn Method project-remove-file :AFTER ot fnnd
1928 Remove the current buffer from project target @var{OT}.
1929 Argument @var{FNND} is an argument.
1932 @deffn Method ede-buffer-documentation-files :AFTER this buffer
1933 Check for some documentation files for @var{THIS}.
1934 Also do a quick check to see if there is a Documentation tag in this @var{BUFFER}.
1937 @deffn Method ede-map-target-buffers :AFTER this proc
1938 For @var{THIS}, execute @var{PROC} on all buffers belonging to @var{THIS}.
1941 @deffn Method eieio-speedbar-child-description :AFTER obj
1942 Provide a speedbar description for a plain-child of @var{OBJ}.
1943 A plain child is a child element which is not an EIEIO object.
1946 @deffn Method ede-object-keybindings :BEFORE this
1947 Retrieves the slot @code{keybindings} from an object of class @code{ede-target}
1950 @deffn Method ede-description :AFTER this
1951 Return a description suitable for the minibuffer about @var{THIS}.
1954 @deffn Method eieio-speedbar-object-children :AFTER this
1955 Return the list of speedbar display children for @var{THIS}.
1958 @deffn Method ede-system-include-path :AFTER this
1959 Get the system include path used by project @var{THIS}.
1962 @deffn Method ede-object-sourcecode :BEFORE this
1963 Retrieves the slot @code{sourcetype} from an object of class @code{ede-target}
1966 @deffn Method ede-expand-filename :AFTER this filename &optional force
1967 Return a fully qualified file name based on target @var{THIS}.
1968 @var{FILENAME} should be a filename which occurs in a directory in which @var{THIS} works.
1969 Optional argument @var{FORCE} forces the default filename to be provided even if it
1973 @deffn Method ede-menu-items-build :AFTER obj &optional current
1974 Return a list of menu items for building target @var{OBJ}.
1975 If optional argument @var{CURRENT} is non-@code{nil}, return sub-menu code.
1978 @deffn Method ede-want-file-p :AFTER this file
1979 Return non-@code{nil} if @var{THIS} target wants @var{FILE}.
1982 @deffn Method ede-update-version-in-source :AFTER this version
1983 In sources for @var{THIS}, change version numbers to @var{VERSION}.
1986 @deffn Method project-delete-target :AFTER ot
1987 Delete the current target @var{OT} from it's parent project.
1990 @deffn Method ede-target-sourcecode :AFTER this
1991 Return the sourcecode objects which @var{THIS} permits.
1994 @deffn Method eieio-speedbar-child-make-tag-lines :AFTER this depth
1995 Create a speedbar tag line for a child of @var{THIS}.
1996 It has depth @var{DEPTH}.
1999 @deffn Method eieio-speedbar-object-buttonname :AFTER object
2000 Return a string to use as a speedbar button for @var{OBJECT}.
2003 @deffn Method eieio-done-customizing :AFTER target
2004 Call this when a user finishes customizing @var{TARGET}.
2007 @deffn Method project-edit-file-target :AFTER ot
2008 Edit the target @var{OT} associated w/ this file.
2011 @deffn Method ede-documentation :AFTER this
2012 Return a list of files that provides documentation.
2013 Documentation is not for object @var{THIS}, but is provided by @var{THIS} for other
2014 files in the project.
2017 @deffn Method ede-want-file-source-p :AFTER this file
2018 Return non-@code{nil} if @var{THIS} target wants @var{FILE}.
2021 @deffn Method ede-want-file-auxiliary-p :AFTER this file
2022 Return non-@code{nil} if @var{THIS} target wants @var{FILE}.
2025 @deffn Method project-add-file :AFTER ot file
2026 Add the current buffer into project project target @var{OT}.
2027 Argument @var{FILE} is the file to add.
2030 @deffn Method ede-target-name :AFTER this
2031 Return the name of @var{THIS} target, suitable for make or debug style commands.
2034 @deffn Method ede-object-menu :BEFORE this
2035 Retrieves the slot @code{menu} from an object of class @code{ede-target}
2038 @node ede-proj-target
2039 @subsection ede-proj-target
2040 @tgindex ede-proj-target
2043 @item Inheritance Tree:
2045 @item eieio-speedbar
2047 @item eieio-speedbar-directory-button
2049 @item @w{@xref{ede-target}.}
2051 @item ede-proj-target
2054 @w{@xref{ede-proj-target-makefile},} @w{ede-proj-target-aux,} @w{@xref{ede-proj-target-scheme}.}
2069 Name of this target.
2075 The path to the sources of this target.
2076 Relative to the path of the project it belongs to.
2080 Type: @code{list} @*
2081 Default Value: @code{nil}
2083 Auxiliary source files included in this target.
2084 Each of these is considered equivalent to a source file, but it is not
2085 distributed, and each should have a corresponding rule to build it.
2089 Type: @code{(or null symbol)} @*
2090 Default Value: @code{nil}
2092 The compiler to be used to compile this object.
2093 This should be a symbol, which contains the object defining the compiler.
2094 This enables save/restore to do so by name, permitting the sharing
2095 of these compiler resources, and global customization thereof.
2099 Type: @code{(or null symbol)} @*
2100 Default Value: @code{nil}
2102 The linker to be used to link compiled sources for this object.
2103 This should be a symbol, which contains the object defining the linker.
2104 This enables save/restore to do so by name, permitting the sharing
2105 of these linker resources, and global customization thereof.
2111 @subsubsection Specialized Methods
2113 @deffn Method project-compile-target :AFTER obj &optional command
2114 Compile the current target @var{OBJ}.
2115 Argument @var{COMMAND} is the command to use for compiling the target.
2118 @deffn Method project-debug-target :AFTER obj
2119 Run the current project target @var{OBJ} in a debugger.
2122 @deffn Method ede-proj-configure-add-missing :AFTER this
2123 Query if any files needed by @var{THIS} provided by automake are missing.
2124 Results in --add-missing being passed to automake.
2127 @deffn Method ede-proj-flush-autoconf :AFTER this
2128 Flush the configure file (current buffer) to accomodate @var{THIS}.
2129 By flushing, remove any cruft that may be in the file. Subsequent
2130 calls to @dfn{ede-proj-tweak-autoconf} can restore items removed by flush.
2133 @deffn Method ede-proj-makefile-insert-rules :AFTER this
2134 Insert rules needed by @var{THIS} target.
2137 @deffn Method project-remove-file :AFTER target file
2138 For @var{TARGET}, remove @var{FILE}.
2139 @var{FILE} must be massaged by @dfn{ede-convert-path}.
2142 @deffn Method ede-proj-configure-create-missing :AFTER this
2143 Add any missing files for @var{THIS} by creating them.
2146 @deffn Method ede-proj-makefile-sourcevar :AFTER this
2147 Return the variable name for @var{THIS}'s sources.
2150 @deffn Method ede-proj-makefile-insert-variables :AFTER this &optional moresource
2151 Insert variables needed by target @var{THIS}.
2152 Optional argument @var{MORESOURCE} is a list of additional sources to add to the
2156 @deffn Method ede-proj-makefile-insert-automake-post-variables :AFTER this
2157 Insert variables needed by target @var{THIS} in Makefile.am after SOURCES.
2160 @deffn Method ede-proj-makefile-insert-dist-dependencies :AFTER this
2161 Insert any symbols that the DIST rule should depend on.
2162 Argument @var{THIS} is the target that should insert stuff.
2165 @deffn Method ede-proj-linkers :AFTER obj
2166 List of linkers being used by @var{OBJ}.
2167 If the @code{linker} slot is empty, concoct one on a first match found
2168 basis for any given type from the @code{availablelinkers} slot.
2169 Otherwise, return the @code{linker} slot.
2170 Converts all symbols into the objects to be used.
2173 @deffn Method ede-proj-makefile-garbage-patterns :AFTER this
2174 Return a list of patterns that are considered garbage to @var{THIS}.
2175 These are removed with make clean.
2178 @deffn Method ede-proj-tweak-autoconf :AFTER this
2179 Tweak the configure file (current buffer) to accomodate @var{THIS}.
2182 @deffn Method ede-proj-compilers :AFTER obj
2183 List of compilers being used by @var{OBJ}.
2184 If the @code{compiler} slot is empty, concoct one on a first match found
2185 basis for any given type from the @code{availablecompilers} slot.
2186 Otherwise, return the @code{compiler} slot.
2187 Converts all symbols into the objects to be used.
2190 @deffn Method project-delete-target :AFTER this
2191 Delete the current target @var{THIS} from it's parent project.
2194 @deffn Method ede-proj-makefile-target-name :AFTER this
2195 Return the name of the main target for @var{THIS} target.
2198 @deffn Method eieio-done-customizing :AFTER target
2199 Call this when a user finishes customizing this object.
2200 Argument @var{TARGET} is the project we are completing customization on.
2203 @deffn Method ede-proj-makefile-insert-user-rules :AFTER this
2204 Insert user specified rules needed by @var{THIS} target.
2207 @deffn Method project-add-file :AFTER this file
2208 Add to target @var{THIS} the current buffer represented as @var{FILE}.
2211 @deffn Method ede-proj-makefile-insert-automake-pre-variables :AFTER this
2212 Insert variables needed by target @var{THIS} in Makefile.am before SOURCES.
2215 @deffn Method ede-proj-makefile-insert-dist-filepatterns :AFTER this
2216 Insert any symbols that the DIST rule should depend on.
2217 Argument @var{THIS} is the target that should insert stuff.
2220 @deffn Method ede-proj-makefile-dependency-files :AFTER this
2221 Return a list of source files to convert to dependencies.
2222 Argument @var{THIS} is the target to get sources from.
2225 @deffn Method ede-proj-makefile-insert-source-variables :AFTER this &optional moresource
2226 Insert the source variables needed by @var{THIS}.
2227 Optional argument @var{MORESOURCE} is a list of additional sources to add to the
2232 @node ede-proj-target-makefile
2233 @subsection ede-proj-target-makefile
2234 @tgindex ede-proj-target-makefile
2237 @item Inheritance Tree:
2239 @item eieio-speedbar
2241 @item eieio-speedbar-directory-button
2243 @item @w{@xref{ede-target}.}
2245 @item @w{@xref{ede-proj-target}.}
2247 @item ede-proj-target-makefile
2250 @w{@xref{semantic-ede-proj-target-grammar},} @w{@xref{ede-proj-target-makefile-objectcode},} @w{@xref{ede-proj-target-elisp},} @w{@xref{ede-proj-target-makefile-miscelaneous},} @w{@xref{ede-proj-target-makefile-info}.}
2264 Type: @code{string} @*
2265 Default Value: @code{"Makefile"}
2267 File name of generated Makefile.
2271 Type: @code{boolean} @*
2272 Default Value: @code{t}
2274 Non @code{nil} means the rule created is part of the all target.
2275 Setting this to @code{nil} creates the rule to build this item, but does not
2276 include it in the ALL`all:' rule.
2279 @item :configuration-variables
2280 Type: @code{list} @*
2281 Default Value: @code{nil}
2283 Makefile variables appended to use in different configurations.
2284 These variables are used in the makefile when a configuration becomes active.
2285 Target variables are always renamed such as foo_CFLAGS, then included into
2286 commands where the variable would usually appear.
2290 Type: @code{list} @*
2291 Default Value: @code{nil}
2293 Arbitrary rules and dependencies needed to make this target.
2294 It is safe to leave this blank.
2300 @subsubsection Specialized Methods
2302 @deffn Method ede-proj-makefile-dependencies :AFTER this
2303 Return a string representing the dependencies for @var{THIS}.
2304 Some compilers only use the first element in the dependencies, others
2305 have a list of intermediates (object files), and others don't care.
2306 This allows customization of how these elements appear.
2309 @deffn Method project-compile-target :AFTER obj &optional command
2310 Compile the current target program @var{OBJ}.
2311 Optional argument @var{COMMAND} is the s the alternate command to use.
2314 @deffn Method ede-proj-makefile-insert-rules :AFTER this
2315 Insert rules needed by @var{THIS} target.
2318 @deffn Method ede-proj-makefile-insert-variables :AFTER this &optional moresource
2319 Insert variables needed by target @var{THIS}.
2320 Optional argument @var{MORESOURCE} is a list of additional sources to add to the
2324 @deffn Method ede-proj-makefile-insert-commands :AFTER this
2325 Insert the commands needed by target @var{THIS}.
2326 For targets, insert the commands needed by the chosen compiler.
2329 @deffn Method ede-proj-makefile-configuration-variables :AFTER this configuration
2330 Return a list of configuration variables from @var{THIS}.
2331 Use @var{CONFIGURATION} as the current configuration to query.
2334 @node semantic-ede-proj-target-grammar
2335 @subsection semantic-ede-proj-target-grammar
2336 @tgindex semantic-ede-proj-target-grammar
2339 @item Inheritance Tree:
2341 @item eieio-speedbar
2343 @item eieio-speedbar-directory-button
2345 @item @w{@xref{ede-target}.}
2347 @item @w{@xref{ede-proj-target}.}
2349 @item @w{@xref{ede-proj-target-makefile}.}
2351 @item semantic-ede-proj-target-grammar
2361 @subsubsection Specialized Methods
2363 @deffn Method project-compile-target :AFTER obj
2364 Compile all sources in a Lisp target @var{OBJ}.
2367 @deffn Method ede-proj-makefile-insert-rules :AFTER this
2368 Insert rules needed by @var{THIS} target.
2371 @deffn Method ede-buffer-mine :AFTER this buffer
2372 Return @code{t} if object @var{THIS} lays claim to the file in @var{BUFFER}.
2373 Lays claim to all -by.el, and -wy.el files.
2376 @deffn Method ede-proj-makefile-sourcevar :AFTER this
2377 Return the variable name for @var{THIS}'s sources.
2380 @deffn Method ede-proj-makefile-insert-dist-dependencies :AFTER this
2381 Insert dist dependencies, or intermediate targets.
2382 This makes sure that all grammar lisp files are created before the dist
2383 runs, so they are always up to date.
2384 Argument @var{THIS} is the target that should insert stuff.
2388 @node ede-proj-target-makefile-objectcode
2389 @subsection ede-proj-target-makefile-objectcode
2390 @tgindex ede-proj-target-makefile-objectcode
2393 @item Inheritance Tree:
2395 @item eieio-speedbar
2397 @item eieio-speedbar-directory-button
2399 @item @w{@xref{ede-target}.}
2401 @item @w{@xref{ede-proj-target}.}
2403 @item @w{@xref{ede-proj-target-makefile}.}
2405 @item ede-proj-target-makefile-objectcode
2408 @w{@xref{ede-proj-target-makefile-archive},} @w{@xref{ede-proj-target-makefile-program}.}
2422 @item :configuration-variables
2423 Type: @code{list} @*
2424 Default Value: @code{("debug" ("CFLAGS" . "-g") ("LDFLAGS" . "-g"))}
2426 @xref{ede-proj-target-makefile}.
2429 @subsubsection Specialized Methods
2431 @deffn Method ede-buffer-header-file :AFTER this buffer
2432 There are no default header files.
2435 @deffn Method ede-proj-makefile-sourcevar :AFTER this
2436 Return the variable name for @var{THIS}'s sources.
2439 @deffn Method ede-proj-makefile-insert-variables :AFTER this &optional moresource
2440 Insert variables needed by target @var{THIS}.
2441 Optional argument @var{MORESOURCE} is not used.
2444 @deffn Method ede-proj-makefile-dependency-files :AFTER this
2445 Return a list of source files to convert to dependencies.
2446 Argument @var{THIS} is the target to get sources from.
2450 @node ede-proj-target-makefile-archive
2451 @subsection ede-proj-target-makefile-archive
2452 @tgindex ede-proj-target-makefile-archive
2455 @item Inheritance Tree:
2457 @item eieio-speedbar
2459 @item eieio-speedbar-directory-button
2461 @item @w{@xref{ede-target}.}
2463 @item @w{@xref{ede-proj-target}.}
2465 @item @w{@xref{ede-proj-target-makefile}.}
2467 @item @w{@xref{ede-proj-target-makefile-objectcode}.}
2469 @item ede-proj-target-makefile-archive
2480 @subsubsection Specialized Methods
2482 @deffn Method ede-proj-makefile-insert-rules :AFTER this
2483 Create the make rule needed to create an archive for @var{THIS}.
2486 @deffn Method ede-proj-makefile-insert-source-variables :PRIMARY this
2487 Insert bin_PROGRAMS variables needed by target @var{THIS}.
2488 We aren't acutally inserting SOURCE details, but this is used by the
2489 Makefile.am generator, so use it to add this important bin program.
2493 @node ede-proj-target-makefile-program
2494 @subsection ede-proj-target-makefile-program
2495 @tgindex ede-proj-target-makefile-program
2498 @item Inheritance Tree:
2500 @item eieio-speedbar
2502 @item eieio-speedbar-directory-button
2504 @item @w{@xref{ede-target}.}
2506 @item @w{@xref{ede-proj-target}.}
2508 @item @w{@xref{ede-proj-target-makefile}.}
2510 @item @w{@xref{ede-proj-target-makefile-objectcode}.}
2512 @item ede-proj-target-makefile-program
2515 @w{@xref{ede-proj-target-makefile-shared-object}.}
2531 Type: @code{list} @*
2532 Default Value: @code{nil}
2534 Libraries, such as "m" or "Xt" which this program depends on.
2535 The linker flag "-l" is automatically prepended. Do not include a "lib"
2536 prefix, or a ".so" suffix.
2538 Note: Currently only used for Automake projects.
2542 Type: @code{list} @*
2543 Default Value: @code{nil}
2545 Additional flags to add when linking this target.
2546 Use ldlibs to add addition libraries. Use this to specify specific
2547 options to the linker.
2549 Note: Not currently used. This bug needs to be fixed.
2555 @subsubsection Specialized Methods
2557 @deffn Method project-debug-target :AFTER obj
2558 Debug a program target @var{OBJ}.
2561 @deffn Method ede-proj-makefile-insert-rules :AFTER this
2562 Insert rules needed by @var{THIS} target.
2565 @deffn Method ede-proj-makefile-insert-automake-post-variables :AFTER this
2566 Insert bin_PROGRAMS variables needed by target @var{THIS}.
2569 @deffn Method ede-proj-makefile-insert-automake-pre-variables :AFTER this
2570 Insert bin_PROGRAMS variables needed by target @var{THIS}.
2574 @node ede-proj-target-makefile-shared-object
2575 @subsection ede-proj-target-makefile-shared-object
2576 @tgindex ede-proj-target-makefile-shared-object
2579 @item Inheritance Tree:
2581 @item eieio-speedbar
2583 @item eieio-speedbar-directory-button
2585 @item @w{@xref{ede-target}.}
2587 @item @w{@xref{ede-proj-target}.}
2589 @item @w{@xref{ede-proj-target-makefile}.}
2591 @item @w{@xref{ede-proj-target-makefile-objectcode}.}
2593 @item @w{@xref{ede-proj-target-makefile-program}.}
2595 @item ede-proj-target-makefile-shared-object
2607 @subsubsection Specialized Methods
2609 @deffn Method ede-proj-configure-add-missing :AFTER this
2610 Query if any files needed by @var{THIS} provided by automake are missing.
2611 Results in --add-missing being passed to automake.
2614 @deffn Method ede-proj-makefile-sourcevar :AFTER this
2615 Return the variable name for @var{THIS}'s sources.
2618 @deffn Method ede-proj-makefile-insert-automake-post-variables :AFTER this
2619 Insert bin_PROGRAMS variables needed by target @var{THIS}.
2620 We need to override -program which has an LDADD element.
2623 @deffn Method ede-proj-makefile-target-name :AFTER this
2624 Return the name of the main target for @var{THIS} target.
2627 @deffn Method ede-proj-makefile-insert-automake-pre-variables :AFTER this
2628 Insert bin_PROGRAMS variables needed by target @var{THIS}.
2629 We aren't acutally inserting SOURCE details, but this is used by the
2630 Makefile.am generator, so use it to add this important bin program.
2634 @node ede-proj-target-elisp
2635 @subsection ede-proj-target-elisp
2636 @tgindex ede-proj-target-elisp
2639 @item Inheritance Tree:
2641 @item eieio-speedbar
2643 @item eieio-speedbar-directory-button
2645 @item @w{@xref{ede-target}.}
2647 @item @w{@xref{ede-proj-target}.}
2649 @item @w{@xref{ede-proj-target-makefile}.}
2651 @item ede-proj-target-elisp
2654 @w{@xref{ede-proj-target-elisp-autoloads}.}
2669 Type: @code{list} @*
2670 Default Value: @code{nil}
2672 Additional packages needed.
2673 There should only be one toplevel package per auxiliary tool needed.
2674 These packages location is found, and added to the compile time
2681 @subsubsection Specialized Methods
2683 @deffn Method project-compile-target :AFTER obj
2684 Compile all sources in a Lisp target @var{OBJ}.
2685 Bonus: Return a cons cell: (COMPILED . UPTODATE).
2688 @deffn Method ede-proj-flush-autoconf :AFTER this
2689 Flush the configure file (current buffer) to accomodate @var{THIS}.
2692 @deffn Method ede-buffer-mine :AFTER this buffer
2693 Return @code{t} if object @var{THIS} lays claim to the file in @var{BUFFER}.
2694 Lays claim to all .elc files that match .el files in this target.
2697 @deffn Method ede-proj-makefile-sourcevar :AFTER this
2698 Return the variable name for @var{THIS}'s sources.
2701 @deffn Method ede-proj-tweak-autoconf :AFTER this
2702 Tweak the configure file (current buffer) to accomodate @var{THIS}.
2705 @deffn Method ede-update-version-in-source :AFTER this version
2706 In a Lisp file, updated a version string for @var{THIS} to @var{VERSION}.
2707 There are standards in Elisp files specifying how the version string
2708 is found, such as a @code{-version} variable, or the standard header.
2711 @node ede-proj-target-elisp-autoloads
2712 @subsection ede-proj-target-elisp-autoloads
2713 @tgindex ede-proj-target-elisp-autoloads
2716 @item Inheritance Tree:
2718 @item eieio-speedbar
2720 @item eieio-speedbar-directory-button
2722 @item @w{@xref{ede-target}.}
2724 @item @w{@xref{ede-proj-target}.}
2726 @item @w{@xref{ede-proj-target-makefile}.}
2728 @item @w{@xref{ede-proj-target-elisp}.}
2730 @item ede-proj-target-elisp-autoloads
2746 Type: @code{list} @*
2747 Default Value: @code{("cedet-autogen")}
2749 @xref{ede-proj-target-elisp}.
2750 @item :autoload-file
2751 Type: @code{string} @*
2752 Default Value: @code{"loaddefs.el"}
2754 The file that autoload definitions are placed in.
2755 There should be one load defs file for a given package. The load defs are created
2756 for all Emacs Lisp sources that exist in the directory of the created target.
2759 @item :autoload-dirs
2760 Type: @code{list} @*
2761 Default Value: @code{nil}
2763 The directories to scan for autoload definitions.
2764 If @code{nil} defaults to the current directory.
2770 @subsubsection Specialized Methods
2772 @deffn Method ede-proj-makefile-dependencies :AFTER this
2773 Return a string representing the dependencies for @var{THIS}.
2774 Always return an empty string for an autoloads generator.
2777 @deffn Method project-compile-target :AFTER obj
2778 Create or update the autoload target.
2781 @deffn Method ede-proj-flush-autoconf :AFTER this
2782 Flush the configure file (current buffer) to accomodate @var{THIS}.
2785 @deffn Method ede-buffer-mine :AFTER this buffer
2786 Return @code{t} if object @var{THIS} lays claim to the file in @var{BUFFER}.
2787 Lays claim to all .elc files that match .el files in this target.
2790 @deffn Method ede-proj-makefile-sourcevar :AFTER this
2791 Return the variable name for @var{THIS}'s sources.
2794 @deffn Method ede-proj-makefile-insert-dist-dependencies :AFTER this
2795 Insert any symbols that the DIST rule should depend on.
2796 Emacs Lisp autoload files ship the generated .el files.
2797 Argument @var{THIS} is the target which needs to insert an info file.
2800 @deffn Method ede-proj-tweak-autoconf :AFTER this
2801 Tweak the configure file (current buffer) to accomodate @var{THIS}.
2804 @deffn Method ede-update-version-in-source :AFTER this version
2805 In a Lisp file, updated a version string for @var{THIS} to @var{VERSION}.
2806 There are standards in Elisp files specifying how the version string
2807 is found, such as a @code{-version} variable, or the standard header.
2810 @deffn Method ede-proj-compilers :AFTER obj
2811 List of compilers being used by @var{OBJ}.
2812 If the @code{compiler} slot is empty, get the car of the compilers list.
2815 @deffn Method ede-proj-makefile-insert-dist-filepatterns :AFTER this
2816 Insert any symbols that the DIST rule should distribute.
2817 Emacs Lisp autoload files ship the generated .el files.
2818 Argument @var{THIS} is the target which needs to insert an info file.
2821 @deffn Method ede-proj-makefile-insert-source-variables :AFTER this &optional moresource
2822 Insert the source variables needed by @var{THIS}.
2823 Optional argument @var{MORESOURCE} is a list of additional sources to add to the
2828 @node ede-proj-target-makefile-miscelaneous
2829 @subsection ede-proj-target-makefile-miscelaneous
2830 @tgindex ede-proj-target-makefile-miscelaneous
2833 @item Inheritance Tree:
2835 @item eieio-speedbar
2837 @item eieio-speedbar-directory-button
2839 @item @w{@xref{ede-target}.}
2841 @item @w{@xref{ede-proj-target}.}
2843 @item @w{@xref{ede-proj-target-makefile}.}
2845 @item ede-proj-target-makefile-miscelaneous
2860 Type: @code{string} @*
2861 Default Value: @code{""}
2863 Miscellaneous sources which have a specialized makefile.
2864 The sub-makefile is used to build this target.
2870 @subsubsection Specialized Methods
2872 @deffn Method ede-proj-makefile-insert-rules :AFTER this
2873 Create the make rule needed to create an archive for @var{THIS}.
2876 @deffn Method ede-proj-makefile-sourcevar :AFTER this
2877 Return the variable name for @var{THIS}'s sources.
2880 @deffn Method ede-proj-makefile-dependency-files :AFTER this
2881 Return a list of files which @var{THIS} target depends on.
2885 @node ede-proj-target-makefile-info
2886 @subsection ede-proj-target-makefile-info
2887 @tgindex ede-proj-target-makefile-info
2890 @item Inheritance Tree:
2892 @item eieio-speedbar
2894 @item eieio-speedbar-directory-button
2896 @item @w{@xref{ede-target}.}
2898 @item @w{@xref{ede-proj-target}.}
2900 @item @w{@xref{ede-proj-target-makefile}.}
2902 @item ede-proj-target-makefile-info
2917 Type: @code{string} @*
2918 Default Value: @code{""}
2920 The main menu resides in this file.
2921 All other sources should be included independently.
2927 @subsubsection Specialized Methods
2929 @deffn Method ede-proj-configure-add-missing :AFTER this
2930 Query if any files needed by @var{THIS} provided by automake are missing.
2931 Results in --add-missing being passed to automake.
2934 @deffn Method object-write :AFTER this
2935 Before committing any change to @var{THIS}, make sure the mainmenu is first.
2938 @deffn Method ede-proj-makefile-sourcevar :AFTER this
2939 Return the variable name for @var{THIS}'s sources.
2942 @deffn Method ede-proj-makefile-insert-dist-dependencies :AFTER this
2943 Insert any symbols that the DIST rule should depend on.
2944 Texinfo files want to insert generated `.info' files.
2945 Argument @var{THIS} is the target which needs to insert an info file.
2948 @deffn Method ede-proj-makefile-target-name :AFTER this
2949 Return the name of the main target for @var{THIS} target.
2952 @deffn Method ede-documentation :AFTER this
2953 Return a list of files that provides documentation.
2954 Documentation is not for object @var{THIS}, but is provided by @var{THIS} for other
2955 files in the project.
2958 @deffn Method ede-proj-makefile-insert-dist-filepatterns :AFTER this
2959 Insert any symbols that the DIST rule should depend on.
2960 Texinfo files want to insert generated `.info' files.
2961 Argument @var{THIS} is the target which needs to insert an info file.
2964 @deffn Method ede-proj-makefile-insert-source-variables :AFTER this &optional moresource
2965 Insert the source variables needed by @var{THIS} info target.
2966 Optional argument @var{MORESOURCE} is a list of additional sources to add to the
2968 Does the usual for Makefile mode, but splits source into two variables
2969 when working in Automake mode.
2972 @node ede-proj-target-scheme
2973 @subsection ede-proj-target-scheme
2974 @tgindex ede-proj-target-scheme
2977 @item Inheritance Tree:
2979 @item eieio-speedbar
2981 @item eieio-speedbar-directory-button
2983 @item @w{@xref{ede-target}.}
2985 @item @w{@xref{ede-proj-target}.}
2987 @item ede-proj-target-scheme
3001 Type: @code{string} @*
3002 Default Value: @code{"guile"}
3004 The preferred interpreter for this code.
3010 @subsubsection Specialized Methods
3012 @deffn Method ede-proj-tweak-autoconf :AFTER this
3013 Tweak the configure file (current buffer) to accomodate @var{THIS}.
3017 @node project-am-target
3018 @subsection project-am-target
3019 @tgindex project-am-target
3022 @item Inheritance Tree:
3024 @item eieio-speedbar
3026 @item eieio-speedbar-directory-button
3028 @item @w{@xref{ede-target}.}
3030 @item project-am-target
3033 @w{@xref{project-am-objectcode},} @w{project-am-header,} @w{@xref{project-am-lisp},} @w{@xref{project-am-texinfo},} @w{@xref{project-am-man}.}
3041 @subsubsection Specialized Methods
3043 @deffn Method project-compile-target-command :AFTER this
3044 Default target to use when compiling a given target.
3047 @deffn Method project-make-dist :AFTER this
3048 Run the current project in the debugger.
3051 @deffn Method project-edit-file-target :AFTER obj
3052 Edit the target associated w/ this file.
3055 @node project-am-objectcode
3056 @subsection project-am-objectcode
3057 @tgindex project-am-objectcode
3060 @item Inheritance Tree:
3062 @item eieio-speedbar
3064 @item eieio-speedbar-directory-button
3066 @item @w{@xref{ede-target}.}
3068 @item @w{@xref{project-am-target}.}
3070 @item project-am-objectcode
3073 @w{@xref{project-am-program},} @w{project-am-lib.}
3082 @subsubsection Specialized Methods
3084 @deffn Method project-am-macro :AFTER this
3085 Return the default macro to 'edit' for this object type.
3088 @deffn Method project-debug-target :AFTER obj
3089 Run the current project target in a debugger.
3092 @deffn Method project-compile-target-command :AFTER this
3093 Default target to use when compiling an object code target.
3096 @deffn Method ede-buffer-header-file :AFTER this buffer
3097 There are no default header files.
3100 @node project-am-program
3101 @subsection project-am-program
3102 @tgindex project-am-program
3105 @item Inheritance Tree:
3107 @item eieio-speedbar
3109 @item eieio-speedbar-directory-button
3111 @item @w{@xref{ede-target}.}
3113 @item @w{@xref{project-am-target}.}
3115 @item @w{@xref{project-am-objectcode}.}
3117 @item project-am-program
3132 Default Value: @code{nil}
3139 @node project-am-header-noinst
3140 @subsection project-am-header-noinst
3141 @tgindex project-am-header-noinst
3144 @item Inheritance Tree:
3146 @item eieio-speedbar
3148 @item eieio-speedbar-directory-button
3150 @item @w{@xref{ede-target}.}
3152 @item @w{@xref{project-am-target}.}
3154 @item @w{project-am-header.}
3156 @item project-am-header-noinst
3166 @subsubsection Specialized Methods
3168 @deffn Method project-am-macro :AFTER this
3169 Return the default macro to 'edit' for this object.
3172 @node project-am-header-inst
3173 @subsection project-am-header-inst
3174 @tgindex project-am-header-inst
3177 @item Inheritance Tree:
3179 @item eieio-speedbar
3181 @item eieio-speedbar-directory-button
3183 @item @w{@xref{ede-target}.}
3185 @item @w{@xref{project-am-target}.}
3187 @item @w{project-am-header.}
3189 @item project-am-header-inst
3199 @subsubsection Specialized Methods
3201 @deffn Method project-am-macro :AFTER this
3202 Return the default macro to 'edit' for this object.
3205 @node project-am-lisp
3206 @subsection project-am-lisp
3207 @tgindex project-am-lisp
3210 @item Inheritance Tree:
3212 @item eieio-speedbar
3214 @item eieio-speedbar-directory-button
3216 @item @w{@xref{ede-target}.}
3218 @item @w{@xref{project-am-target}.}
3220 @item project-am-lisp
3229 @subsubsection Specialized Methods
3231 @deffn Method project-am-macro :AFTER this
3232 Return the default macro to 'edit' for this object.
3235 @node project-am-texinfo
3236 @subsection project-am-texinfo
3237 @tgindex project-am-texinfo
3240 @item Inheritance Tree:
3242 @item eieio-speedbar
3244 @item eieio-speedbar-directory-button
3246 @item @w{@xref{ede-target}.}
3248 @item @w{@xref{project-am-target}.}
3250 @item project-am-texinfo
3264 Default Value: @code{nil}
3266 Additional texinfo included in this one.
3271 @subsubsection Specialized Methods
3273 @deffn Method project-am-macro :AFTER this
3274 Return the default macro to 'edit' for this object type.
3277 @deffn Method project-compile-target-command :AFTER this
3278 Default target t- use when compling a texinfo file.
3281 @deffn Method ede-documentation :AFTER this
3282 Return a list of files that provides documentation.
3283 Documentation is not for object @var{THIS}, but is provided by @var{THIS} for other
3284 files in the project.
3287 @node project-am-man
3288 @comment node-name, next, previous, up
3289 @subsection project-am-man
3290 @tgindex project-am-man
3293 @item Inheritance Tree:
3295 @item eieio-speedbar
3297 @item eieio-speedbar-directory-button
3299 @item @w{@xref{ede-target}.}
3301 @item @w{@xref{project-am-target}.}
3303 @item project-am-man
3312 @subsubsection Specialized Methods
3314 @deffn Method project-am-macro :AFTER this
3315 Return the default macro to 'edit' for this object type.
3321 The source code type is an object designed to associated files with
3329 @node ede-sourcecode
3330 @subsection ede-sourcecode
3331 @scindex ede-sourcecode
3334 @item Inheritance Tree:
3336 @item eieio-instance-inheritor
3338 @item ede-sourcecode
3348 @item :parent-instance
3349 Type: @code{eieio-instance-inheritor-child}
3351 The parent of this instance.
3352 If a slot of this class is reference, and is unbound, then the parent
3353 is checked for a value.
3359 The name of this type of source code.
3360 Such as "C" or "Emacs Lisp"
3363 @item :sourcepattern
3364 Type: @code{string} @*
3365 Default Value: @code{".*"}
3367 Emacs regex matching sourcecode this target accepts.
3370 @item :auxsourcepattern
3371 Type: @code{(or null string)} @*
3372 Default Value: @code{nil}
3374 Emacs regex matching auxiliary source code this target accepts.
3375 Aux source are source code files needed for compilation, which are not comiled
3379 @item :enable-subdirectories
3380 Type: @code{boolean} @*
3381 Default Value: @code{nil}
3383 Non @code{nil} if this sourcecode type uses subdirectores.
3384 If sourcecode always lives near the target creating it, this should be nil.
3385 If sourcecode can, or typically lives in a subdirectory of the owning
3386 target, set this to t.
3389 @item :garbagepattern
3390 Type: @code{list} @*
3391 Default Value: @code{nil}
3393 Shell file regex matching files considered as garbage.
3394 This is a list of items added to an @code{rm} command when executing a @code{clean}
3401 @subsubsection Specialized Methods
3403 @deffn Method ede-want-any-files-p :AFTER this filenames
3404 Return non-@code{nil} if @var{THIS} will accept any files in @var{FILENAMES}.
3407 @deffn Method ede-want-any-source-files-p :AFTER this filenames
3408 Return non-@code{nil} if @var{THIS} will accept any source files in @var{FILENAMES}.
3411 @deffn Method ede-want-any-auxiliary-files-p :AFTER this filenames
3412 Return non-@code{nil} if @var{THIS} will accept any aux files in @var{FILENAMES}.
3415 @deffn Method ede-buffer-header-file :AFTER this filename
3416 Return a list of file names of header files for @var{THIS} with @var{FILENAME}.
3417 Used to guess header files, but uses the auxsource regular expression.
3420 @deffn Method ede-want-file-p :AFTER this filename
3421 Return non-@code{nil} if sourcecode definition @var{THIS} will take @var{FILENAME}.
3424 @deffn Method ede-want-file-source-p :AFTER this filename
3425 Return non-@code{nil} if @var{THIS} will take @var{FILENAME} as an auxiliary .
3428 @deffn Method ede-want-file-auxiliary-p :AFTER this filename
3429 Return non-@code{nil} if @var{THIS} will take @var{FILENAME} as an auxiliary .
3435 The compiler object is designed to associate source code with
3436 compilers. The target then references the compilers it can use.
3437 When the makefile is created, this object type knows how to create
3441 * ede-compilation-program ::
3443 * ede-object-compiler ::
3448 @node ede-compilation-program
3449 @subsection ede-compilation-program
3450 @cmindex ede-compilation-program
3453 @item Inheritance Tree:
3455 @item eieio-instance-inheritor
3457 @item ede-compilation-program
3460 @w{@xref{ede-compiler},} @w{@xref{ede-linker}.}
3470 @item :parent-instance
3471 Type: @code{eieio-instance-inheritor-child}
3473 The parent of this instance.
3474 If a slot of this class is reference, and is unbound, then the parent
3475 is checked for a value.
3481 Name of this type of compiler.
3487 Variables needed in the Makefile for this compiler.
3488 An assoc list where each element is (VARNAME . VALUE) where VARNAME
3489 is a string, and VALUE is either a string, or a list of strings.
3490 For example, GCC would define CC=gcc, and emacs would define EMACS=emacs.
3496 A list of @code{ede-sourcecode} @xref{ede-sourcecode}. objects this class will handle.
3497 This is used to match target objects with the compilers and linkers
3498 they can use, and which files this object is interested in.
3502 Type: @code{list} @*
3503 Default Value: @code{nil}
3505 Auxiliary rules needed for this compiler to run.
3506 For example, yacc/lex files need additional chain rules, or inferences.
3512 The commands used to execute this compiler.
3513 The object which uses this compiler will place these commands after
3514 it's rule definition.
3518 Type: @code{list} @*
3519 Default Value: @code{nil}
3521 Autoconf function to call if this type of compiler is used.
3522 When a project is in Automake mode, this defines the autoconf function to
3523 call to initialize automake to use this compiler.
3524 For example, there may be multiple C compilers, but they all probably
3525 use the same autoconf form.
3528 @item :objectextention
3531 A string which is the extention used for object files.
3532 For example, C code uses .o on unix, and Emacs Lisp uses .elc.
3538 @subsubsection Specialized Methods
3540 @deffn Method ede-proj-flush-autoconf :AFTER this
3541 Flush the configure file (current buffer) to accomodate @var{THIS}.
3544 @deffn Method ede-proj-makefile-insert-rules :AFTER this
3545 Insert rules needed for @var{THIS} compiler object.
3548 @deffn Method ede-proj-makefile-insert-variables :AFTER this
3549 Insert variables needed by the compiler @var{THIS}.
3552 @deffn Method ede-proj-makefile-insert-commands :AFTER this
3553 Insert the commands needed to use compiler @var{THIS}.
3554 The object creating makefile rules must call this method for the
3555 compiler it decides to use after inserting in the rule.
3558 @deffn Method ede-object-sourcecode :AFTER this
3559 Retrieves the slot @code{sourcetype} from an object of class @code{ede-compilation-program}
3562 @deffn Method ede-proj-tweak-autoconf :AFTER this
3563 Tweak the configure file (current buffer) to accomodate @var{THIS}.
3568 @subsection ede-compiler
3569 @cmindex ede-compiler
3572 @item Inheritance Tree:
3574 @item eieio-instance-inheritor
3576 @item @w{@xref{ede-compilation-program}.}
3581 @w{@xref{ede-object-compiler},} @w{semantic-ede-grammar-compiler-class.}
3591 Create a new object with name NAME of class type ede-compiler
3597 @item :parent-instance
3598 Type: @code{eieio-instance-inheritor-child}
3600 The parent of this instance.
3601 If a slot of this class is reference, and is unbound, then the parent
3602 is checked for a value.
3608 Name of this type of compiler.
3614 Variables needed in the Makefile for this compiler.
3615 An assoc list where each element is (VARNAME . VALUE) where VARNAME
3616 is a string, and VALUE is either a string, or a list of strings.
3617 For example, GCC would define CC=gcc, and emacs would define EMACS=emacs.
3623 A list of @code{ede-sourcecode} @xref{ede-sourcecode}. objects this class will handle.
3624 This is used to match target objects with the compilers and linkers
3625 they can use, and which files this object is interested in.
3631 The commands used to execute this compiler.
3632 The object which uses this compiler will place these commands after
3633 it's rule definition.
3636 @item :objectextention
3639 A string which is the extention used for object files.
3640 For example, C code uses .o on unix, and Emacs Lisp uses .elc.
3644 Type: @code{boolean} @*
3645 Default Value: @code{nil}
3647 Non-@code{nil} if this compiler can make dependencies.
3651 Type: @code{boolean} @*
3652 Default Value: @code{nil}
3654 Non-@code{nil} if this compiler creates code that can be linked.
3655 This requires that the containing target also define a list of available
3656 linkers that can be used.
3662 @subsubsection Specialized Methods
3664 @deffn Method ede-proj-makefile-insert-object-variables :AFTER this targetname sourcefiles
3665 Insert an OBJ variable to specify object code to be generated for @var{THIS}.
3666 The name of the target is @var{TARGETNAME} as a string. @var{SOURCEFILES} is the list of
3667 files to be objectified.
3668 Not all compilers do this.
3671 @deffn Method ede-compiler-intermediate-objects-p :AFTER this
3672 Return non-@code{nil} if @var{THIS} has intermediate object files.
3673 If this compiler creates code that can be linked together,
3674 then the object files created by the compiler are considered intermediate.
3677 @deffn Method ede-compiler-intermediate-object-variable :AFTER this targetname
3678 Return a string based on @var{THIS} representing a make object variable.
3679 @var{TARGETNAME} is the name of the target that these objects belong to.
3683 @node ede-object-compiler
3684 @subsection ede-object-compiler
3685 @cmindex ede-object-compiler
3688 @item Inheritance Tree:
3690 @item eieio-instance-inheritor
3692 @item @w{@xref{ede-compilation-program}.}
3694 @item @w{@xref{ede-compiler}.}
3696 @item ede-object-compiler
3709 Type: @code{boolean} @*
3710 Default Value: @code{t}
3712 @xref{ede-compiler}.
3713 @item :dependencyvar
3716 A variable dedicated to dependency generation.
3721 @subsubsection Specialized Methods
3723 @deffn Method ede-proj-makefile-insert-variables :AFTER this
3724 Insert variables needed by the compiler @var{THIS}.
3728 @subsection ede-linker
3732 @item Inheritance Tree:
3734 @item eieio-instance-inheritor
3736 @item @w{@xref{ede-compilation-program}.}
3747 Create a new object with name NAME of class type ede-linker
3756 Name of this type of compiler.
3762 Variables needed in the Makefile for this compiler.
3763 An assoc list where each element is (VARNAME . VALUE) where VARNAME
3764 is a string, and VALUE is either a string, or a list of strings.
3765 For example, GCC would define CC=gcc, and emacs would define EMACS=emacs.
3771 A list of @code{ede-sourcecode} @xref{ede-sourcecode}. objects this class will handle.
3772 This is used to match target objects with the compilers and linkers
3773 they can use, and which files this object is interested in.
3779 The commands used to execute this compiler.
3780 The object which uses this compiler will place these commands after
3781 it's rule definition.
3784 @item :objectextention
3787 A string which is the extention used for object files.
3788 For example, C code uses .o on unix, and Emacs Lisp uses .elc.
3797 arch-tag: c9bfdc6e-e6e9-4e87-97f7-d8348342fbf4