EDE is the Emacs Development Environment: an Emacs extension that simplifies building and debugging programs in Emacs. It attempts to emulate a typical IDE (Integrated Development Environment). EDE can manage or create your makefiles and other building environment duties, allowing you to concentrate on writing code rather than support files. It aims to make it much easier for new programmers to learn and adopt GNU ways of doing things.
This file describes EDE, the Emacs Development Environment.
Copyright © 1998, 1999, 2000, 2001, 2004, 2005, 2008, 2009, 2010 Free Software Foundation, Inc.
Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, with the Front-Cover texts being “A GNU Manual,” and with the Back-Cover Texts as in (a) below. A copy of the license is included in the section entitled “GNU Free Documentation License.”(a) The FSF's Back-Cover Text is: “You have the freedom to copy and modify this GNU manual. Buying copies from the FSF supports it in developing GNU and promoting software freedom.”
EDE is a generic interface for managing projects. It specifies a single set of menus and keybindings, while supporting multiple ways to express a project via a build system.
In the subsequent chapters, we will describe the different project types (see Creating a project), as well as the commands to build and debug projects (see Building and Debugging).
In EDE, a project hierarchy matches a directory hierarchy. The project's topmost directory is called the project root, and its subdirectories are subprojects.
Each project can contain multiple targets. A target, at the simplest level, is a named collection of files within a project. A target can specify two different types of information:
Lastly, EDE provides a way for other tools to easily learn file associations. For example, a program might need to restrict some sort of search to files in a single target, or to discover the location of documentation or interface files. EDE can provide this information.
EDE is implemented as a minor mode, which augments other modes such
as C mode, and Texinfo mode. You can enable EDE for all buffers by
running the command global-ede-mode, or by putting this in your
init file:
(global-ede-mode t)
Activating EDE adds a menu named ‘Development’ to the menu bar. This menu provides several menu items for high-level EDE commands. These menu items, and their corresponding keybindings, are independent of the type of project you are actually working on.
To create a new project, first visit a file that you want to include in that project. If you have a hierarchy of directories, first visit a file in the topmost directory. From this buffer, type M-x ede-new, or click on the ‘Create Project’ item in the ‘Development’ menu.
The ede-new command prompts for the type of project you would like to create. Each project type has its own benefits or language specific enhancements. EDE supports four different project types: ‘Make’, ‘Automake’, ‘direct Automake’, and ‘Simple’.
You cannot create direct Automake projects with the ede-new command. Instead, when you visit a project with existing Automake files, EDE automatically detects them.
A subproject is merely a project in a subdirectory of another project. You can create a subproject by using the ede-new command (or the ‘Create Project’ menu item), while visiting a buffer in a subdirectory of the project root. This new project is automatically added to the parent project, and will be automatically loaded when EDE reads the parent project.
When using a project command that involves a makefile, EDE uses the top-most project's makefile as a starting place for the build. How the toplevel project handles subprojects in the build process is dependent on that project's type.
In this chapter, we describe the generic features for manipulating projects, including the targets and files within them. Subsequent chapters, which describe specific project types, will provide more detailed information about exactly what these features do.
To create a new target, type C-c . t (ede-new-target) or
use the ‘Add Target’ menu item in the ‘Project Options’
submenu. This prompts for a target name, and adds the current buffer
to that target.
The ede-new-target command also prompts for a target type. Each target type has its own build process and class of files that it will accept.
To remove a target from the project, type M-x ede-delete-target, or use the ‘Remove Target’ menu item in the ‘Project Options’ submenu.
To add the current file to an existing target, type C-c . a
(ede-add-file), or use the ‘Add File’ menu item in the
‘Target Options’ submenu.
You can add a file to more than one target; this is OK.
To remove the current file from a target, type C-c . d
(ede-remove-file), or or use the ‘Remove File’ menu item
in the ‘Target Options’ submenu. If the file belongs to multiple
targets, this command prompts for each target it could be removed
from.
While working in a project, if you visit a file that is not part of an existing target, EDE automatically prompts for a target. If you do not wish to add the file to any target, you can choose ‘none’. You can customize this behavior with the variable ede-auto-add-method.
A project, and its targets, are objects using the ‘EIEIO’ object system. See Top. These objects have data fields containing important information related to your work.
If the high-level functions aren't enough, you can tweak all user-customizable fields at any time by running the command customize-project or customize-target. This loads the current project or target into a customization buffer, where you can tweak individual slots. This is usually necessary for complex projects.
Some project modes do not have a project file, but directly read a
Makefile or other existing file. Instead of directly editing the
object, you can edit the file by typine C-c . e
(ede-edit-file-target). You should “rescan” the project
afterwards (see Miscellaneous commands).
This section details user facing features of an EDE ‘Make’ style project. An ‘Automake’ project has similar options (but a direct Automake project does not).
To modify any of the specific features mentioned here, you need to customize the project or target with customize-project or customize-target.
When you are customizing, you are directly manipulating slot values in EIEIO objects. See Extending EDE, if you are interested in additional details.
Targets that build stuff need compilers. To change compilers, you need to customize the desired target.
In the ‘[Make]’ section, you can choose a new compiler or linker from the list. If a linker you need is not available, you will need to create a new one. See Compiler and Linker objects.
If an existing compiler or linker is close, but you need to modify some flag set such as adding an include path you will need to add a configuration variable.
To start, you should create the basic setup, and construct a makefile with ede-proj-regenerate. Look in the Makefile to see what commands are inserted. Once you have determined the variable you need to modify, you can add a configuration for it. See Configurations.
Configurations specify different ways to build a project. For example, you may configure a project to be in “debug” mode, or perhaps in “release” mode.
The project, and each target type all have a slot named
configuration-variables. To add new variables to a
configuration find this slot in the custom buffer, and insert a new
configuration. Name it either “debug” or “release”, then insert
some number of name/value pairs to it.
You can have any number of valid configurations too. To add a new configuration, customize your project. Work in the ‘[Settings]’ block for “configurations”. Add a new named configuration here.
To switch between different active configurations, modify the “configuration default” slot.
EDE provides the following “project-aware” compilation and debugging commands:
ede-compile-target).
ede-compile-project).
ede-debug-target).
These commands are also available from the ‘Development’ menu.
If you opt to go in and edit EDE project files directly—for
instance, by using C-c . e (see Customize Features)—you
must then “rescan” the project files to update the internal data
structures. To rescan the current project, type C-c . g
(ede-rescan-toplevel).
EDE can help you find files in your project, via the command
C-c . f (ede-find-file). This prompts for a file name;
you need not specify the directory. EDE then tries to visit a file
with that name somewhere in your project.
EDE can use external tools to help with file finding. To do this,
customize ede-locate-setup-options.
List of locate objects to try out by default. Listed in order of preference. If the first item cannot be used in a particular project, then the next one is tried. It is always assumed that ede-locate-base is at end of the list.
EDE also provides a project display mode for the speedbar (see Speedbar). This allows you to view your source files as they are structured in your project: as a hierarchical tree, grouped according to target.
To activate the speedbar in this mode, type C-c . s
(ede-speedbar).
There is a wide array of Simple projects. The root for simple
projects is the class ede-simple-project. This handles the
infrastructure of storing a .ede file if needed.
The class ede-simple-project is designed to be subclassed.
Then key EDE methods can be overridden to provide a quick wrapper
over any project.
A second project type is ede-cpp-root. This project type is
designed to be created for a directory hierarchy full of C/C++ code.
It can be configured with minimal lisp knowledge to do header file
lookup for Semantic, improving code completion performance.
The ede-cpp-root project type allows you to create a single
object with no save-file in your .emacs file. It allows EDE
to provide the Semantic package with the ability to find header
files quickly.
The ede-cpp-root class knows a few things about C++ projects,
such as the prevalence of "include" directories, and typical
file-layout stuff. If this isn't sufficient, you can subclass
ede-cpp-root-project and add your own tweaks in just a few
lines. See the end of this file for an example.
In the most basic case, add this to your .emacs file, modifying appropriate bits as needed.
(ede-cpp-root-project "SOMENAME" :file "/dir/to/some/file")
Replace SOMENAME with whatever name you want, and the filename to an actual file at the root of your project. It might be a Makefile, a README file. Whatever. It doesn't matter. It's just a key to hang the rest of EDE off of.
The most likely reason to create this project, is to speed up searching for includes files, or to simplify bootstrapping Semantic's ability to find files without much user interaction. In conjunction with Semantic completion, having a short include path is key. You can override the default include path and system include path like this:
(ede-cpp-root-project "NAME" :file "FILENAME"
:include-path '( "/include" "../include" "/c/include" )
:system-include-path '( "/usr/include/c++/3.2.2/" )
:spp-table '( ("MOOSE" . "")
("CONST" . "const") ) )
In this case each item in the include path list is searched. If the directory starts with "/", then that expands to the project root directory. If a directory does not start with "/", then it is relative to the default-directory of the current buffer when the file name is expanded.
The include path only affects C/C++ header files. Use the slot
:header-match-regexp to change it.
The :system-include-path allows you to specify full directory
names to include directories where system header files can be found.
These will be applied to files in this project only.
The :spp-table provides a list of project specific #define
style macros that are unique to this project, passed in to the
compiler on the command line, or are in special headers.
See the semantic-lex-c-preprocessor-symbol-map for more
on how to format this entry.
If there is a single file in your project, you can instead set the
:spp-files to a list of file names relative to the root of your
project. Specifying this is like setting the variable
semantic-lex-c-preprocessor-symbol-file in semantic.
If you want to override the file-finding tool with your own function you can do this:
(ede-cpp-root-project "NAME" :file "FILENAME" :locate-fcn 'MYFCN)
Where MYFCN is a symbol for a function. The locate function can
be used in place of ede-expand-filename so you can quickly
customize your custom target to use specialized local routines instead
of the default EDE routines. The function symbol must take two
arguments:
If the cpp-root project style is right for you, but you want a dynamic loader, instead of hard-coding path name values in your .emacs, you can do that too, but you will need to write some lisp code.
To do that, you need to add an entry to the
ede-project-class-files list, and also provide two functions to
teach EDE how to load your project pattern
It would look like this:
(defun MY-FILE-FOR-DIR (&optional dir)
"Return a full file name to the project file stored in DIR."
<write your code here, or return nil>
)
(defun MY-ROOT-FCN ()
"Return the root fcn for `default-directory'"
;; You might be able to use `ede-cpp-root-project-root'
;; and not write this at all.
)
(defun MY-LOAD (dir)
"Load a project of type `cpp-root' for the directory DIR.
Return nil if there isn't one."
;; Use your preferred constructin method here.
(ede-cpp-root-project "NAME" :file (expand-file-name "FILE" dir)
:locate-fcn 'MYFCN)
)
(add-to-list 'ede-project-class-files
(ede-project-autoload "cpp-root"
:name "CPP ROOT"
:file 'ede-cpp-root
:proj-file 'MY-FILE-FOR-DIR
:proj-root 'MY-ROOT-FCN
:load-type 'MY-LOAD
:class-sym 'ede-cpp-root)
t)
This example only creates an auto-loader, and does not create a new kind of project.
See ede-cpp-root-project, for details about the class that defines
the ede-cpp-root project type.
todo - Write some doc.
In the meantime look in the commentary of ede-simple.el
The ede-emacs project automatically identifies an Emacs source
tree, and enables EDE project mode for it.
It pre-populates the C Preprocessor symbol map for correct parsing, and has an optimized include file identification function.
The ede-linux project will automatically identify a Linux
Kernel source tree, and enable EDE project mode for it.
It pre-populates the C Preprocessor symbol map for reasonable parsing, and has an optimized include file identification function.
The various simple project styles all have one major drawback, which is that the files in the project are not completely known to EDE. When the EDE API is used to try and file files by some reference name in the project, then that could fail.
@TODO - Add ID Utils and CScope examples
EDE can therefore use some external locate commands, such as the unix “locate” command, or “GNU Global”.
Configuration of the tool you want to use such as locate, or
global will need to be done without the aid of EDE. Once
configured, however, EDE can use it.
To enable one of these tools, set the variable
ede-locate-setup-options with the names of different locate
objects. Miscellaneous commands.
Configure this in your .emacs before loading in CEDET or EDE. If you want to add support for GNU Global, your configuration would look like this:
(setq ede-locate-setup-options '(ede-locate-global ede-locate-base))
That way, when a search needs to be done, it will first try using GLOBAL. If global is not available for that directory, then it will revert to the base locate object. The base object always fails to find a file.
You can add your own locate tool but subclassing from
ede-locate-base. The subclass should also implement two
methods. See the code in ede-locate.el for GNU Global as a
simple example.
This chapter is intended for users who want to write new parts or fix bugs in EDE. A knowledge of Emacs Lisp, and some EIEIO(CLOS) is required.
EDE uses EIEIO, the CLOS package for Emacs, to define two object superclasses, specifically the PROJECT and TARGET. All commands in EDE are usually meant to address the current project, or current target.
All specific projects in EDE derive subclasses of the EDE superclasses. In this way, specific behaviors such as how a project is saved, or how a target is compiled can be customized by a project author in detail. EDE communicates to these project objects via an API using methods. The commands you use in EDE mode are high-level functional wrappers over these methods. See (eieio)Top. For details on using EIEIO to extending classes, and writing methods.
If you intend to extend EDE, it is most likely that a new target type is
needed in one of the existing project types. The rest of this chapter
will discuss extending the ede-project class, and it's targets.
See project-am.el for basic details on adding targets to it.
For the ede-project type, the core target class is called
ede-proj-target. Inheriting from this will give you everything
you need to start, including adding your sources into the makefile. If
you also need additional rules in the makefile, you will want to inherit
from ede-proj-target-makefile instead. You may want to also add
new fields to track important information.
If you are building currently unsupported code into a program or shared library, it is unlikely you need a new target at all. Instead you would need to create a new compiler or linker object that compiles source code of the desired type. Compiler and Linker objects.
Once your new class exists, you will want to fill in some basic methods. See the ede-skel.el file for examples of these. The files ede-proj-info.el and ede-proj-elisp.el are two interesting examples.
These methods are core behaviors associated with user commands. If you do not implement a method, there is a reasonable default that may do what you need.
project-add-fileproject-remove-fileproject-compile-targetproject-debug-targetproject-update-versionproject-edit-file-targetproject-new-targetproject-delete-targetproject-make-distproject-rescanThese methods are important for querying base information from project and target types:
ede-nameede-target-nameede-descriptionede-want-file-pede-buffer-mineThese methods are used by the semantic package extensions See (semantic)Top.
ede-buffer-header-fileede-buffer-documentation-filesede-documentationEDE projects track source file / target associates via source code objects. The definitions for this is in ede-source.el. A source code object contains methods that know how to identify a file as being of that class, (ie, a C file ends with .c). Some targets can handle many different types of sources which must all be compiled together. For example, a mixed C and C++ program would have instantiations of both sourcecode types.
When a target needs to know if it will accept a source file, it references its list of source code objects. These objects then make that decision.
Source code objects are stored in the target objects as a list of symbols, where the symbol's value is the object. This enables the project save file mechanism to work.
Here is an example for an instantiation of an Emacs Lisp source code object:
(defvar ede-source-emacs
(ede-sourcecode "ede-emacs-source"
:name "Emacs Lisp"
:sourcepattern "\\.el$"
:garbagepattern '("*.elc"))
"Emacs Lisp source code definition.")
If you want to recycle parts of an existing sourcecode object, you can clone the original, and then just tweak the parts that are different. For example:
(defvar ede-source-emacs-autoload
(clone ede-source-emacs "ede-source-emacs-autoload"
:name "Emacs Lisp Autoload"
:sourcepattern "-loaddefs\\.el")
"Emacs Lisp autoload source code.")
In this case, the garbage pattern is the same.
See Sourcecode.
In order for a target to create a Makefile, it must know how to compile the sources into the program or desired data file, and possibly link them together.
A compiler object instantiation is used to associate a given target with a given source code type. Some targets can handle many types of sources, and thus has many compilers available to it. Some targets may have multiple compilers for a given type of source code.
EDE will examine the actual source files in a target, cross reference that against the compiler list to come up with the final set of compilers that will be inserted into the Makefile.
Compiler instantiations must also insert variables specifying the compiler it plans to use, in addition to creating Automake settings for configure.in when appropriate.
Compiler objects are stored in the target objects as a list of symbols, where the symbols value is the object. This enables the project output mechanism to work more efficiently.
Targets will also have a special "compiler" slot which lets a user explicitly choose the compiler they want to use.
Here is an example for texinfo:
(defvar ede-makeinfo-compiler
(ede-compiler
"ede-makeinfo-compiler"
:name "makeinfo"
:variables '(("MAKEINFO" . "makeinfo"))
:commands '("makeinfo -o $ $<")
:autoconf '(("AC_CHECK_PROG" . "MAKEINFO, makeinfo"))
:sourcetype '(ede-makeinfo-source)
)
"Compile texinfo files into info files.")
See Compilers.
When creating compiler instantiations, it may be useful to clone
an existing compiler variable. Cloning allows you to only modify
parts of the original, while keeping the rest of the same.
Modification of the original will result in the clone also being
changed for shared value slots.
The second important object is the linker class. The linker is similar to the compiler, except several compilers might be used to create some object files, and only one linker is used to link those objects together.
See ede-proj-obj.el for examples of the combination.
eieio-speedbareieio-speedbar-directory-buttonede-project-placeholder:namestring "Untitled"
The name used when generating distribution files.
:versionstring "1.0"
The version number used when distributing files.
:directorystring
Directory this project is associated with.
:filestring
File name where this project is stored.
If a project knows it's root, return it here. Allows for one-project-object-for-a-tree type systems.
Find a subproject of PROJ that corresponds to DIR.
If a project knows it's root, return it here. Allows for one-project-object-for-a-tree type systems. Optional FILE is the file to test. It is ignored in preference of the anchor file for the project.
Make sure the placeholder THIS is replaced with the real thing. Return the new object created in its place.
Make sure placeholder THIS is replaced with the real thing, and pass through.
Make sure placeholder THIS is replaced with the real thing, and pass through.
eieio-speedbareieio-speedbar-directory-buttonSee ede-project-placeholder.ede-project:targetslist
List of top level targets in this project.
:tool-cachelist
List of tool cache configurations in this project.
This allows any tool to create, manage, and persist project-specific settings.
:web-site-urlstring URL to this projects web site.
This is a URL to be sent to a web site for documentation.
:web-site-directory
:web-site-file
web-site-directory.
This can be a local file, use ange-ftp, EFS, or TRAMP.
:ftp-sitestring FTP site where this project's distribution can be found.
This FTP site should be in Emacs form, as needed by ange-ftp, but can
also be of a form used by TRAMP for use with scp, or rcp.
:ftp-upload-sitestring FTP Site to upload new distributions to.
This FTP site should be in Emacs form as needed by ange-ftp.
If this slot is nil, then use ftp-site instead.
:configurationslist ("debug" "release")
List of available configuration types.
Individual target/project types can form associations between a configuration,
and target specific elements such as build variables.
:configuration-default
"debug"
The default configuration.
:local-variables
nil
Project local variables
Get a path name for PROJ which is relative to the parent project. If PARENT is specified, then be relative to the PARENT project. Specifying PARENT is useful for sub-sub projects relative to the root project.
For project THIS, map PROC to all targets and return if any non-nil. Return the first non-
nilvalue returned by PROC.
For object THIS, execute PROC on all direct subprojects. This function does not apply PROC to sub-sub projects. See also ede-map-all-subprojects.
Convert path in a standard way for a given project. Default to making it project relative. Argument THIS is the project to convert PATH to.
Return a short-name for THIS project file. Do this by extracting the lowest directory name.
Set variables local to PROJECT in BUFFER.
Return the path to OBJ. Optional DEPTH is the depth we start at.
For object THIS, execute PROC on THIS and all subprojects. This function also applies PROC to sub-sub projects. See also ede-map-subprojects.
The
:versionof the project OT has been updated. Handle saving, or other detail.
Return all documentation in project THIS based on BUFFER.
Return non-
nilif object THIS lays claim to the file in BUFFER.
Retrieves the slot
keybindingsfrom an object of classede-project
Return the list of speedbar display children for THIS.
Create a new target. It is up to the project PROJ to get the name.
Return a fully qualified file name based on project THIS. FILENAME should be just a filename which occurs in a directory controlled by this project. Optional argument FORCE forces the default filename to be provided even if it doesn't exist.
Return a list of menu items for building project OBJ. If optional argument CURRENT is non-
nil, return sub-menu code.
Change occurrences of a version string in sources. In project THIS, cycle over all targets to give them a chance to set their sources to VERSION.
Create a new target. It is up to the project PROJ to get the name.
Compile the entire current project OBJ. Argument COMMAND is the command to use when compiling.
Return a string to use as a speedbar button for OBJECT.
For THIS, execute PROC on all buffers belonging to THIS.
Return a fully qualified file name based on project THIS. FILENAME should be just a filename which occurs in a directory controlled by this project. Optional argument FORCE forces the default filename to be provided even if it doesn't exist.
Return a list of files that provides documentation. Documentation is not for object THIS, but is provided by THIS for other files in the project.
Interactively query for a target that exists in project THIS. Argument PROMPT is the prompt to use when querying the user for a target.
Is PROJ the parent of TARGET? If TARGET belongs to a subproject, return that project file.
Return a list of files that constitutes a distribution of THIS project.
eieio-speedbareieio-speedbar-directory-buttonSee ede-project-placeholder.See ede-project.ede-cpp-root-projectThis class implements the ede-cpp-root project type.
See ede-cpp-root, for information about using this project type.
:include-pathlist (quote ("/include" "../include/"))
The default locate function expands filenames within a project.
If a header file (.h, .hh, etc) name is expanded, and
the :locate-fcn slot is nil, then the include path is checked
first, and other directories are ignored. For very large
projects, this optimization can save a lot of time.
Directory names in the path can be relative to the current
buffer's default-directory (not starting with a /). Directories
that are relative to the project's root should start with a /, such
as "/include", meaning the directory include off the project root
directory.
:system-include-pathlist nil
The system include path for files in this project.
C files initialized in an ede-cpp-root-project have their semantic
system include path set to this value. If this is nil, then the
semantic path is not modified.
:spp-tablelist nil
C Preprocessor macros for your files.
Preprocessor symbols will be used while parsing your files.
These macros might be passed in through the command line compiler, or
are critical symbols derived from header files. Providing header files
macro values through this slot improves accuracy and performance.
Use `:spp-files' to use these files directly.
:spp-fileslist nil
C header file with Preprocessor macros for your files.
The PreProcessor symbols appearing in these files will be used while
parsing files in this project.
See semantic-lex-c-preprocessor-symbol-map for more on how this works.
:header-match-regexpstring "\\.\\(h\\(h\\|xx\\|pp\\|\\+\\+\\)?\\|H\\)$\\|\\<\\w+$"
Regexp used to identify C/C++ header files.
:locate-fcn(or null function) nil
The locate function can be used in place of ede-expand-filename so you can quickly customize your custom target to use specialized local routines instead of the EDE routines. The function symbol must take two arguments: NAME - The name of the file to find. DIR - The directory root for this cpp-root project.
It should return the fully qualified file name passed in from NAME. If that file does not exist, it should return nil.
Non
nilif in PROJ the filename NAME is a header.
Within this project PROJ, find the file NAME. This knows details about or source tree.
eieio-speedbareieio-speedbar-directory-buttonSee ede-project-placeholder.See ede-project.ede-simple-projecteieio-speedbareieio-speedbar-directory-buttonSee ede-project-placeholder.See ede-project.ede-simple-base-projectEDE Simple project base class. This one project could control a tree of subdirectories.
eieio-speedbareieio-speedbar-directory-buttonSee ede-project-placeholder.See ede-project.ede-proj-project:makefile-typesymbol Makefile
The type of Makefile to generate.
Can be one of 'Makefile, 'Makefile.in, or 'Makefile.am.
If this value is NOT 'Makefile, then that overrides the :makefile slot
in targets.
:variableslist nil
Variables to set in this Makefile.
:configuration-variableslist ("debug" (("DEBUG" . "1")))
Makefile variables to use in different configurations.
These variables are used in the makefile when a configuration becomes active.
:inference-rules
nil
Inference rules to add to the makefile.
:include-file
nil
Additional files to include.
These files can contain additional rules, variables, and customizations.
:automatic-dependenciesboolean t
Non-nil to do implement automatic dependencies in the Makefile.
:metasubprojectboolean nil
Non-nil if this is a metasubproject.
Usually, a subproject is determined by a parent project. If multiple top level
projects are grouped into a large project not maintained by EDE, then you need
to set this to non-nil. The only effect is that the dist rule will then avoid
making a tar file.
Create a Makefile for all Makefile targets in THIS. MFILENAME is the makefile to generate.
Insert into the current location rules to make recursive TAGS files. Argument THIS is the project to create tags for. Argument TARGETS are the targets we should depend on for TAGS.
Insert distribution rules for THIS in a Makefile, such as CLEAN and DIST.
Insert any symbols that the DIST rule should depend on. Argument THIS is the project that should insert stuff.
Insert a rule for the project THIS which should be a subproject.
Create a Makefile for all Makefile targets in THIS if needed. MFILENAME is the makefile to generate.
For project THIS, test that the file FILE exists, or create it.
Setup the build environment for project THIS. Handles the Makefile, or a Makefile.am configure.in combination. Optional argument FORCE will force items to be regenerated.
Return a list of patterns that are considered garbage to THIS. These are removed with make clean.
Synchronize what we know about project THIS into configure.in.
Insert variables needed by target THIS.
NOTE: Not yet in use! This is part of an SRecode conversion of EDE that is in progress.
Return a list of configuration variables from THIS. Use CONFIGURATION as the current configuration to query.
Call this when a user finishes customizing this object. Argument PROJ is the project to save.
Delete project THISes configure script and start over.
Insert user specified rules needed by THIS target. This is different from ede-proj-makefile-insert-rules in that this function won't create the building rules which are auto created with automake.
Return the name of the Makefile with the DIST target in it for THIS.
Return a list of files that constitutes a distribution of THIS project.
eieio-speedbareieio-speedbar-directory-buttonSee ede-project-placeholder.See ede-project.project-am-makefileCreate a new target named NAME. Argument TYPE is the type of target to insert. This is a string matching something in
project-am-type-alistor type class symbol. Despite the fact that this is a method, it depends on the current buffer being in order to provide a smart default target type.
eieio-speedbareieio-speedbar-directory-buttonSee ede-project-placeholder.See ede-project.ede-step-project:init-variableslist nil
Variables to set in this Makefile, at top of file.
:additional-variables(or null list) nil
Arbitrary variables needed from this project.
It is safe to leave this blank.
:additional-rules(or null list) nil
Arbitrary rules and dependencies needed to make this target.
It is safe to leave this blank.
:installation-domainsymbol user
Installation domain specification.
The variable GNUSTEP_INSTALLATION_DOMAIN is set at this value.
:preamble(or null list) (quote ("GNUmakefile.preamble"))
The auxiliary makefile for additional variables.
Included just before the specific target files.
:postamble(or null list) (quote ("GNUmakefile.postamble"))
The auxiliary makefile for additional rules.
Included just after the specific target files.
:metasubprojectboolean nil
Non-nil if this is a metasubproject.
Usually, a subproject is determined by a parent project. If multiple top level
projects are grouped into a large project not maintained by EDE, then you need
to set this to non-nil. The only effect is that the dist rule will then avoid
making a tar file.
Create a GNUmakefile for all Makefile targets in THIS. MFILENAME is the makefile to generate.
Create a Makefile for all Makefile targets in THIS if needed. MFILENAME is the makefile to generate.
Setup the build environment for project THIS. Handles the Makefile, or a Makefile.am configure.in combination. Optional argument FORCE will force items to be regenerated.
Call this when a user finishes customizing this object. Argument PROJ is the project to save.
Return the name of the Makefile with the DIST target in it for THIS.
Return a list of files that constitutes a distribution of THIS project.
eieio-speedbareieio-speedbar-directory-buttonede-target:namestring
Name of this target.
:pathstring
The path to the sources of this target.
Relative to the path of the project it belongs to.
:sourcelist nil
Source files in this target.
:versionsourcelist nil
Source files with a version string in them. These files are checked for a version string whenever the EDE version of the master project is changed. When strings are found, the version previously there is updated.
Compile the current target OBJ. Argument COMMAND is the command to use for compiling the target.
Convert path in a standard way for a given project. Default to making it project relative. Argument THIS is the project to convert PATH to.
Return non-
nilif object THIS is in BUFFER to a SOURCE list. Handles complex path issues.
Return the path to OBJ. Optional DEPTH is the depth we start at.
There are no default header files in EDE. Do a quick check to see if there is a Header tag in this buffer.
Remove the current buffer from project target OT. Argument FNND is an argument.
Check for some documentation files for THIS. Also do a quick check to see if there is a Documentation tag in this BUFFER.
For THIS, execute PROC on all buffers belonging to THIS.
Provide a speedbar description for a plain-child of OBJ. A plain child is a child element which is not an EIEIO object.
Retrieves the slot
keybindingsfrom an object of classede-target
Return the list of speedbar display children for THIS.
Retrieves the slot
sourcetypefrom an object of classede-target
Return a fully qualified file name based on target THIS. FILENAME should be a filename which occurs in a directory in which THIS works. Optional argument FORCE forces the default filename to be provided even if it doesn't exist.
Return a list of menu items for building target OBJ. If optional argument CURRENT is non-
nil, return sub-menu code.
In sources for THIS, change version numbers to VERSION.
Create a speedbar tag line for a child of THIS. It has depth DEPTH.
Return a string to use as a speedbar button for OBJECT.
Return a list of files that provides documentation. Documentation is not for object THIS, but is provided by THIS for other files in the project.
Add the current buffer into project project target OT. Argument FILE is the file to add.
Return the name of THIS target, suitable for make or debug style commands.
eieio-speedbareieio-speedbar-directory-buttonSee ede-target.ede-proj-target:namestring
Name of this target.
:pathstring
The path to the sources of this target.
Relative to the path of the project it belongs to.
:auxsourcelist nil
Auxiliary source files included in this target.
Each of these is considered equivalent to a source file, but it is not
distributed, and each should have a corresponding rule to build it.
:compiler(or null symbol) nil
The compiler to be used to compile this object.
This should be a symbol, which contains the object defining the compiler.
This enables save/restore to do so by name, permitting the sharing
of these compiler resources, and global customization thereof.
:linker(or null symbol) nil
The linker to be used to link compiled sources for this object. This should be a symbol, which contains the object defining the linker. This enables save/restore to do so by name, permitting the sharing of these linker resources, and global customization thereof.
Compile the current target OBJ. Argument COMMAND is the command to use for compiling the target.
Query if any files needed by THIS provided by automake are missing. Results in –add-missing being passed to automake.
Flush the configure file (current buffer) to accomodate THIS. By flushing, remove any cruft that may be in the file. Subsequent calls to ede-proj-tweak-autoconf can restore items removed by flush.
For TARGET, remove FILE. FILE must be massaged by ede-convert-path.
Add any missing files for THIS by creating them.
Insert variables needed by target THIS. Optional argument MORESOURCE is a list of additional sources to add to the sources variable.
Insert variables needed by target THIS in Makefile.am after SOURCES.
Insert any symbols that the DIST rule should depend on. Argument THIS is the target that should insert stuff.
List of linkers being used by OBJ. If the
linkerslot is empty, concoct one on a first match found basis for any given type from theavailablelinkersslot. Otherwise, return thelinkerslot. Converts all symbols into the objects to be used.
Return a list of patterns that are considered garbage to THIS. These are removed with make clean.
Tweak the configure file (current buffer) to accomodate THIS.
List of compilers being used by OBJ. If the
compilerslot is empty, concoct one on a first match found basis for any given type from theavailablecompilersslot. Otherwise, return thecompilerslot. Converts all symbols into the objects to be used.
Delete the current target THIS from it's parent project.
Return the name of the main target for THIS target.
Call this when a user finishes customizing this object. Argument TARGET is the project we are completing customization on.
Insert user specified rules needed by THIS target.
Add to target THIS the current buffer represented as FILE.
Insert variables needed by target THIS in Makefile.am before SOURCES.
Insert any symbols that the DIST rule should depend on. Argument THIS is the target that should insert stuff.
Return a list of source files to convert to dependencies. Argument THIS is the target to get sources from.
Insert the source variables needed by THIS. Optional argument MORESOURCE is a list of additional sources to add to the sources variable.
eieio-speedbareieio-speedbar-directory-buttonSee ede-target.See ede-proj-target.ede-proj-target-makefile:makefilestring "Makefile"
File name of generated Makefile.
:partofallboolean t
Non nil means the rule created is part of the all target.
Setting this to nil creates the rule to build this item, but does not
include it in the ALL`all:' rule.
:configuration-variableslist nil
Makefile variables appended to use in different configurations.
These variables are used in the makefile when a configuration becomes active.
Target variables are always renamed such as foo_CFLAGS, then included into
commands where the variable would usually appear.
:ruleslist nil
Arbitrary rules and dependencies needed to make this target. It is safe to leave this blank.
Return a string representing the dependencies for THIS. Some compilers only use the first element in the dependencies, others have a list of intermediates (object files), and others don't care. This allows customization of how these elements appear.
Compile the current target program OBJ. Optional argument COMMAND is the s the alternate command to use.
Insert variables needed by target THIS. Optional argument MORESOURCE is a list of additional sources to add to the sources variable.
Insert the commands needed by target THIS. For targets, insert the commands needed by the chosen compiler.
Return a list of configuration variables from THIS. Use CONFIGURATION as the current configuration to query.
eieio-speedbareieio-speedbar-directory-buttonSee ede-target.See ede-proj-target.See ede-proj-target-makefile.semantic-ede-proj-target-grammarReturn
tif object THIS lays claim to the file in BUFFER. Lays claim to all -by.el, and -wy.el files.
Insert dist dependencies, or intermediate targets. This makes sure that all grammar lisp files are created before the dist runs, so they are always up to date. Argument THIS is the target that should insert stuff.
eieio-speedbareieio-speedbar-directory-buttonSee ede-target.See ede-proj-target.See ede-proj-target-makefile.ede-proj-target-makefile-objectcode:configuration-variableslist ("debug" ("CFLAGS" . "-g") ("LDFLAGS" . "-g"))
Insert variables needed by target THIS. Optional argument MORESOURCE is not used.
Return a list of source files to convert to dependencies. Argument THIS is the target to get sources from.
eieio-speedbareieio-speedbar-directory-buttonSee ede-target.See ede-proj-target.See ede-proj-target-makefile.See ede-proj-target-makefile-objectcode.ede-proj-target-makefile-archiveCreate the make rule needed to create an archive for THIS.
Insert bin_PROGRAMS variables needed by target THIS. We aren't acutally inserting SOURCE details, but this is used by the Makefile.am generator, so use it to add this important bin program.
eieio-speedbareieio-speedbar-directory-buttonSee ede-target.See ede-proj-target.See ede-proj-target-makefile.See ede-proj-target-makefile-objectcode.ede-proj-target-makefile-program:ldlibslist nil
Libraries, such as "m" or "Xt" which this program depends on. The linker flag "-l" is automatically prepended. Do not include a "lib" prefix, or a ".so" suffix.
Note: Currently only used for Automake projects.
:ldflagslist nil
Additional flags to add when linking this target. Use ldlibs to add addition libraries. Use this to specify specific options to the linker.
Note: Not currently used. This bug needs to be fixed.
Insert bin_PROGRAMS variables needed by target THIS.
Insert bin_PROGRAMS variables needed by target THIS.
eieio-speedbareieio-speedbar-directory-buttonSee ede-target.See ede-proj-target.See ede-proj-target-makefile.See ede-proj-target-makefile-objectcode.See ede-proj-target-makefile-program.ede-proj-target-makefile-shared-objectQuery if any files needed by THIS provided by automake are missing. Results in –add-missing being passed to automake.
Insert bin_PROGRAMS variables needed by target THIS. We need to override -program which has an LDADD element.
Return the name of the main target for THIS target.
Insert bin_PROGRAMS variables needed by target THIS. We aren't acutally inserting SOURCE details, but this is used by the Makefile.am generator, so use it to add this important bin program.
eieio-speedbareieio-speedbar-directory-buttonSee ede-target.See ede-proj-target.See ede-proj-target-makefile.ede-proj-target-elisp:aux-packageslist nil
Additional packages needed. There should only be one toplevel package per auxiliary tool needed. These packages location is found, and added to the compile time load path.
Compile all sources in a Lisp target OBJ. Bonus: Return a cons cell: (COMPILED . UPTODATE).
Flush the configure file (current buffer) to accomodate THIS.
Return
tif object THIS lays claim to the file in BUFFER. Lays claim to all .elc files that match .el files in this target.
Tweak the configure file (current buffer) to accomodate THIS.
In a Lisp file, updated a version string for THIS to VERSION. There are standards in Elisp files specifying how the version string is found, such as a
-versionvariable, or the standard header.
eieio-speedbareieio-speedbar-directory-buttonSee ede-target.See ede-proj-target.See ede-proj-target-makefile.See ede-proj-target-elisp.ede-proj-target-elisp-autoloads:aux-packageslist ("cedet-autogen")
:autoload-filestring "loaddefs.el"
The file that autoload definitions are placed in.
There should be one load defs file for a given package. The load defs are created
for all Emacs Lisp sources that exist in the directory of the created target.
:autoload-dirslist nil
The directories to scan for autoload definitions.
If nil defaults to the current directory.
Return a string representing the dependencies for THIS. Always return an empty string for an autoloads generator.
Flush the configure file (current buffer) to accomodate THIS.
Return
tif object THIS lays claim to the file in BUFFER. Lays claim to all .elc files that match .el files in this target.
Insert any symbols that the DIST rule should depend on. Emacs Lisp autoload files ship the generated .el files. Argument THIS is the target which needs to insert an info file.
Tweak the configure file (current buffer) to accomodate THIS.
In a Lisp file, updated a version string for THIS to VERSION. There are standards in Elisp files specifying how the version string is found, such as a
-versionvariable, or the standard header.
List of compilers being used by OBJ. If the
compilerslot is empty, get the car of the compilers list.
Insert any symbols that the DIST rule should distribute. Emacs Lisp autoload files ship the generated .el files. Argument THIS is the target which needs to insert an info file.
Insert the source variables needed by THIS. Optional argument MORESOURCE is a list of additional sources to add to the sources variable.
eieio-speedbareieio-speedbar-directory-buttonSee ede-target.See ede-proj-target.See ede-proj-target-makefile.ede-proj-target-makefile-miscelaneous:submakefilestring ""
Miscellaneous sources which have a specialized makefile. The sub-makefile is used to build this target.
Create the make rule needed to create an archive for THIS.
Return a list of files which THIS target depends on.
eieio-speedbareieio-speedbar-directory-buttonSee ede-target.See ede-proj-target.See ede-proj-target-makefile.ede-proj-target-makefile-info:mainmenustring ""
The main menu resides in this file. All other sources should be included independently.
Query if any files needed by THIS provided by automake are missing. Results in –add-missing being passed to automake.
Before committing any change to THIS, make sure the mainmenu is first.
Insert any symbols that the DIST rule should depend on. Texinfo files want to insert generated `.info' files. Argument THIS is the target which needs to insert an info file.
Return the name of the main target for THIS target.
Return a list of files that provides documentation. Documentation is not for object THIS, but is provided by THIS for other files in the project.
Insert any symbols that the DIST rule should depend on. Texinfo files want to insert generated `.info' files. Argument THIS is the target which needs to insert an info file.
Insert the source variables needed by THIS info target. Optional argument MORESOURCE is a list of additional sources to add to the sources variable. Does the usual for Makefile mode, but splits source into two variables when working in Automake mode.
eieio-speedbareieio-speedbar-directory-buttonSee ede-target.See ede-proj-target.ede-proj-target-scheme:interpreterstring "guile"
The preferred interpreter for this code.
Tweak the configure file (current buffer) to accomodate THIS.
eieio-speedbareieio-speedbar-directory-buttonSee ede-target.project-am-targetDefault target to use when compiling a given target.
eieio-speedbareieio-speedbar-directory-buttonSee ede-target.See project-am-target.project-am-objectcodeDefault target to use when compiling an object code target.
eieio-speedbareieio-speedbar-directory-buttonSee ede-target.See project-am-target.See project-am-objectcode.project-am-program:ldadd
nil
Additional LD args.
eieio-speedbareieio-speedbar-directory-buttonSee ede-target.See project-am-target.project-am-header.project-am-header-noinsteieio-speedbareieio-speedbar-directory-buttonSee ede-target.See project-am-target.project-am-header.project-am-header-insteieio-speedbareieio-speedbar-directory-buttonSee ede-target.See project-am-target.project-am-lispeieio-speedbareieio-speedbar-directory-buttonSee ede-target.See project-am-target.project-am-texinfo:include
nil
Additional texinfo included in this one.
Default target t- use when compling a texinfo file.
Return a list of files that provides documentation. Documentation is not for object THIS, but is provided by THIS for other files in the project.
eieio-speedbareieio-speedbar-directory-buttonSee ede-target.See project-am-target.project-am-manThe source code type is an object designed to associated files with targets.
eieio-instance-inheritorede-sourcecode:parent-instanceeieio-instance-inheritor-child
The parent of this instance.
If a slot of this class is reference, and is unbound, then the parent
is checked for a value.
:namestring
The name of this type of source code.
Such as "C" or "Emacs Lisp"
:sourcepatternstring ".*"
Emacs regex matching sourcecode this target accepts.
:auxsourcepattern(or null string) nil
Emacs regex matching auxiliary source code this target accepts.
Aux source are source code files needed for compilation, which are not comiled
themselves.
:enable-subdirectoriesboolean nil
Non nil if this sourcecode type uses subdirectores.
If sourcecode always lives near the target creating it, this should be nil.
If sourcecode can, or typically lives in a subdirectory of the owning
target, set this to t.
:garbagepatternlist nil
Shell file regex matching files considered as garbage.
This is a list of items added to an rm command when executing a clean
type directive.
Return non-
nilif THIS will accept any files in FILENAMES.
Return non-
nilif THIS will accept any source files in FILENAMES.
Return non-
nilif THIS will accept any aux files in FILENAMES.
Return a list of file names of header files for THIS with FILENAME. Used to guess header files, but uses the auxsource regular expression.
Return non-
nilif sourcecode definition THIS will take FILENAME.
Return non-
nilif THIS will take FILENAME as an auxiliary .
Return non-
nilif THIS will take FILENAME as an auxiliary .
The compiler object is designed to associate source code with compilers. The target then references the compilers it can use. When the makefile is created, this object type knows how to create compile commands.
eieio-instance-inheritorede-compilation-program:parent-instanceeieio-instance-inheritor-child
The parent of this instance.
If a slot of this class is reference, and is unbound, then the parent
is checked for a value.
:namestring
Name of this type of compiler.
:variableslist
Variables needed in the Makefile for this compiler.
An assoc list where each element is (VARNAME . VALUE) where VARNAME
is a string, and VALUE is either a string, or a list of strings.
For example, GCC would define CC=gcc, and emacs would define EMACS=emacs.
:sourcetypelist
A list of ede-sourcecode See ede-sourcecode. objects this class will handle.
This is used to match target objects with the compilers and linkers
they can use, and which files this object is interested in.
:ruleslist nil
Auxiliary rules needed for this compiler to run.
For example, yacc/lex files need additional chain rules, or inferences.
:commandslist
The commands used to execute this compiler.
The object which uses this compiler will place these commands after
it's rule definition.
:autoconflist nil
Autoconf function to call if this type of compiler is used.
When a project is in Automake mode, this defines the autoconf function to
call to initialize automake to use this compiler.
For example, there may be multiple C compilers, but they all probably
use the same autoconf form.
:objectextentionstring
A string which is the extention used for object files. For example, C code uses .o on unix, and Emacs Lisp uses .elc.
Flush the configure file (current buffer) to accomodate THIS.
Insert variables needed by the compiler THIS.
Insert the commands needed to use compiler THIS. The object creating makefile rules must call this method for the compiler it decides to use after inserting in the rule.
Retrieves the slot
sourcetypefrom an object of classede-compilation-program
Tweak the configure file (current buffer) to accomodate THIS.
eieio-instance-inheritorSee ede-compilation-program.ede-compilerCreate a new object with name NAME of class type ede-compiler
:parent-instanceeieio-instance-inheritor-child
The parent of this instance.
If a slot of this class is reference, and is unbound, then the parent
is checked for a value.
:namestring
Name of this type of compiler.
:variableslist
Variables needed in the Makefile for this compiler.
An assoc list where each element is (VARNAME . VALUE) where VARNAME
is a string, and VALUE is either a string, or a list of strings.
For example, GCC would define CC=gcc, and emacs would define EMACS=emacs.
:sourcetypelist
A list of ede-sourcecode See ede-sourcecode. objects this class will handle.
This is used to match target objects with the compilers and linkers
they can use, and which files this object is interested in.
:commandslist
The commands used to execute this compiler.
The object which uses this compiler will place these commands after
it's rule definition.
:objectextentionstring
A string which is the extention used for object files.
For example, C code uses .o on unix, and Emacs Lisp uses .elc.
:makedependsboolean nil
Non-nil if this compiler can make dependencies.
:uselinkerboolean nil
Non-nil if this compiler creates code that can be linked.
This requires that the containing target also define a list of available
linkers that can be used.
Insert an OBJ variable to specify object code to be generated for THIS. The name of the target is TARGETNAME as a string. SOURCEFILES is the list of files to be objectified. Not all compilers do this.
Return non-
nilif THIS has intermediate object files. If this compiler creates code that can be linked together, then the object files created by the compiler are considered intermediate.
Return a string based on THIS representing a make object variable. TARGETNAME is the name of the target that these objects belong to.
eieio-instance-inheritorSee ede-compilation-program.See ede-compiler.ede-object-compiler:uselinkerboolean t
See ede-compiler.
:dependencyvarlist
A variable dedicated to dependency generation.
Insert variables needed by the compiler THIS.
eieio-instance-inheritorSee ede-compilation-program.ede-linkerCreate a new object with name NAME of class type ede-linker
:namestring
Name of this type of compiler.
:variableslist
Variables needed in the Makefile for this compiler.
An assoc list where each element is (VARNAME . VALUE) where VARNAME
is a string, and VALUE is either a string, or a list of strings.
For example, GCC would define CC=gcc, and emacs would define EMACS=emacs.
:sourcetypelist
A list of ede-sourcecode See ede-sourcecode. objects this class will handle.
This is used to match target objects with the compilers and linkers
they can use, and which files this object is interested in.
:commandslist
The commands used to execute this compiler.
The object which uses this compiler will place these commands after
it's rule definition.
:objectextentionstring
A string which is the extention used for object files. For example, C code uses .o on unix, and Emacs Lisp uses .elc.