This is ede.info, produced by makeinfo version 4.0 from ede.texi. START-INFO-DIR-ENTRY * ede: (ede). Objects for Emacs END-INFO-DIR-ENTRY  File: ede.info, Node: Top, Up: (dir)Top EDE is a collection of definitions called the _Emacs Development Extensions_. EDE provides the gloss that simplifies the learning curve for all the very useful functionality of building and debugging under emacs. In doing so it attempts to emulate a typical IDE (Integrated Development Environment). What this means is that EDE will manage or create your makefiles and other building environment duties so the developer can concentrate on code, and not support files. In doing so, it will be much easier for new programmers to learn and adopt the GNU ways of doing things. * Menu: * EDE Mode:: Turning on EDE mode. * Creating a project:: Creating a project. * Modifying your project:: Adding and removing files and targets. * Building and Debugging:: Initiating a build or debug session. * Miscellaneous commands:: Other project related commands. * Project types:: There are different types of projects. * Extending EDE:: Programming tips when extending.  File: ede.info, Node: EDE Mode, Next: Creating a project, Prev: Top, Up: Top EDE Mode ******** EDE is implemented as a minor-mode, which augments other modes such as C mode, and Texinfo mode. You can turn EDE on for all buffers by running the command `global-ede-mode', or by putting this in your `~/.emacs' file. (require 'ede) (global-ede-mode t) When EDE is active for a given buffer, the menu item "Project" appears. This menu contains several high-level functions to make working on a code set easier. These items and keybindings never change regardless of the type of project you are actually working on. The `ede.el' file is a minimal set of loading routines. When different types of projects are encountered, source code for those projects are loaded at that time.  File: ede.info, Node: Creating a project, Next: Modifying your project, Prev: EDE Mode, Up: Top Creating a project ****************** EDE can support many different types of projects. When creating a new project with the command `ede-new' (or "Create Project" in the menu) you must choose the type of project you would like to create. *Note Project types::. Each type has it's own benefits or language specific enhancements. You will be prompted for the type of project you would like to create. The simplest and most language agnostic project type is `Make'. A derivation of this is the `Automake' type. Not all project types can be created in this way. For example, there are two ways to handle Automake based projects. One is through the `ede-project' class, and the other through `project-am' class. `project-am' will autoload in any GNU Automake based distribution that does not contain a `Project.ede' file. Creating a subproject ===================== A subproject is merely a project in a subdirectory in some other projects control. You can create a subproject by using the `ede-new' command (or `"Create Project"' from the menu) while a in a subdirectory below an existing project. This new project will be automatically added to the parent project, and will be automatically loaded when the parent is read. When using a project command that invovles 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 dependendent on that project's type.  File: ede.info, Node: Modifying your project, Next: Building and Debugging, Prev: Creating a project, Up: Top Modifying your project ********************** A project, and it's targets, are objects using the `EIEIO' object system. *Note (eieio)EIEIO::. These objects have data fields containing important information related to your work. Of note is that a project has a list of subprojects (sub directories), and targets (things to build from sources). Targets in turn have lists of source code, and information on how to convert that source code into compiled programs or documentation. A project conceptually mirrors a Makefile build tree. You can create a new target with the `ede-new-target' command `C-c . t'. Once created, you can now put source files into this target. You can remove a target with the command `ede-delete-target'. You can add and remove files into targets with the command `ede-add-file' and `ede-remove-file' bound to `C-c . a' and `C-c . d' respectively. These commands will add the current buffer's file into the target. When working in an existing project's directory, and a new file is read into Emacs, EDE will attempt to auto-add that file to a target of your choice. You can customize the behavior with the variable `ede-auto-add-method'. If these 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 will load the given object into an immediate-mode customization buffer where you tweak individual slots. This is usually necessary for project modes that are very complex. Some project modes do not have a project file, but directly read a Makefile, or existing file. Instead of letting you directly edit the object, you can edit the file. Use the command `ede-edit-file-target' bound to `C-c . e'.  File: ede.info, Node: Building and Debugging, Next: Miscellaneous commands, Prev: Modifying your project, Up: Top Building and Debugging ********************** EDE assumes you are writing some sort of program, so attempts to facilitate this activity. EDE will associate the current buffer with a target. The target then knows how to compile or debug the given source file. The following commands enable compilation and debugging. `C-c . c' Compile the current target. `C-c . C' Compile the entire project. `c-c . D' Debug the current target. `ede-make-dist' Build a distribution file for your project.  File: ede.info, Node: Miscellaneous commands, Next: Project types, Prev: Building and Debugging, Up: Top Miscellaneous commands ********************** EDE also supports the speedbar package. While speedbar works great against directories already, EDE provides a project display mode. This lets you look at your source files as they are structured in your project. Thus, where many files may be clumped together in one directory, the Project view will provide a hierarchical view of your files as grouped by target. You can activate speedbar in this mode with the command `ede-speedbar'.  File: ede.info, Node: Project types, Next: Extending EDE, Prev: Miscellaneous commands, Up: Top Project types ************* There are two types of project modes currently. One is `ede-project', and shows up as `Make' and `Automake' when creating new projects. `ede-project' lives in the file `ede-proj'. The other is project type lives in `project-am.el', and handles automake projects directly from the Makefiles. EDE cannot make new projects of this type, assuming the user will do it themselves. Use `ede-project' in `Automake' mode to have EDE create `Makefile.am' file, and a `configure.in' file. `ede-project' creates a file called `Project.ede' in a given project directory. This is used to track your configureation information. When compiling, this project will autogenerate a `Makefile', or a `Makefile.am' file. The project type that reads `Makefile.am' directly is derived from the sources of the original `project-am.el' mode I wrote. This mode eventually became EDE. The automake project will read existing automake files, but will not generate them automatically, or create new ones. As such, it is useful as a browsing tool, or as maintenance in managing file lists.  File: ede.info, Node: Extending EDE, Prev: Project types, Up: Top Extending EDE ************* EDE makes use of EIEIO, the CLOS package for Emacs. This lets EDE 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. For details on different types of projects, *Note Project types::. *Note (eieio)Top::. For details on using EIEIO to extending classes, and writing methods. 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'. You may want to also add new fields to track important information. 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' are two interesting examples. User interface methods ====================== These methods are core behaviors associated with user commands. `project-add-file' Add a file to your project. Override this if you want to put new sources into different fields depending on extension, or other details. `project-remove-file' Reverse of project-add-file. `project-compile-target' Override this if you want to do something special when the user "compiles" this target. The default is probably fine. `project-debug-target' What to do when a user wants to debug your target. `project-update-version' Easily updated the version number of your project. `project-edit-file-target' Edit the file the project's information is stored in. `project-new-target' Create a new target in a project. `project-delete-target' Delete a target from a project. `project-make-dist' Make a distribution (tar archive) of the project. `project-rescan' Rescan a project file, changing the data in the existing objects. Base project methods ==================== These methods are important for querying base information from project and target types: `ede-name' Return a string that is the name of this target. `ede-target-name' Return a string that is the name of the target used by a Make system. `ede-description' A brief description of the project or target. This is currently used by the `ede-speedbar' interface. `ede-want-file-p' Return non-nil if a target will accept a given file. It is generally unecessary to override this. See the section on source code. `ede-buffer-mine' Return non-nil if a buffer belongs to this target. Used during association when a file is loaded. It is generally unecessary to override this unless you keep auxilliary files. These methods are used by the semantic package extentions *Note (semantic)Top::. `ede-buffer-header-file' Return a header file belonging to a given buffer. Prototypes are place there when appropriate `ede-buffer-documentation-files' Return the documentation file information about this file would be stored in. `ede-documentation' List all documentation a project or target is responsible for. Sourcecode objects ================== EDE 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 symbols value is the object. This enables the project output mechanism to work more efficiently. 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.") *Note Sourcecode::. Compiler and Linker objects =========================== The EDE project class creates makefiles. 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 link 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 even 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.") *Note Compilers::. When creating compiler instatiations, it may be useful to `clone' an existing compiler variable. 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. Class hierarchies ================= * Menu: * Project :: The different project types. * Targets :: The different target types. * Sourcecode :: Source Code management types. * Compilers :: Compiler management types.  File: ede.info, Node: Project, Next: Targets, Prev: Extending EDE, Up: Extending EDE * Menu: * ede-project-placeholder :: * ede-project :: * ede-proj-project :: * project-am-makefile ::  File: ede.info, Node: ede-project-placeholder, Next: ede-project, Up: Project ede-project-placeholder ======================= Inheritance Tree: `eieio-speedbar' `eieio-speedbar-directory-button' `ede-project-placeholder' Children: *Note ede-project::. Create a new object with name NAME of class type ede-project-placeholder Slots: `:name' Type: `string' Default Value: `"Untitled"' The name used when generating distribution files. `:version' Type: `string' Default Value: `"1.0"' The version number used when distributing files. `:file' Type: `string' Default Value: `unbound' File name where this project is stored. Specialized Methods ------------------- - Method: ede-project-force-load :PRIMARY this Make sure the placeholder THIS is replaced with the real thing. Return the new object created in its place. - Method: project-interactive-select-target :PRIMARY this prompt Make sure placeholder THIS is replaced with the real thing, and pass through. - Method: project-add-file :PRIMARY this file Make sure placeholder THIS is replaced with the real thing, and pass through.  File: ede.info, Node: ede-project, Next: ede-proj-project, Prev: ede-project-placeholder, Up: Project ede-project =========== Inheritance Tree: `eieio-speedbar' `eieio-speedbar-directory-button' `*Note ede-project-placeholder::.' `ede-project' Children: *Note ede-proj-project::, *Note project-am-makefile::. Create a new object with name NAME of class type ede-project Slots: `:targets' Type: `list' Default Value: `unbound' List of top level targets in this project. `:configurations' Type: `list' Default Value: `("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 ' Default Value: `"debug"' The default configuration. `:local-variables ' Default Value: `nil' Project local variables Specialized Methods ------------------- - Method: eieio-speedbar-description :PRIMARY obj Provide a speedbar description for OBJ. - Method: ede-map-any-target-p :PRIMARY this proc For project THIS, map PROC to all targets and return if any non-nil. Return the first non-`nil' value returned by PROC. - Method: project-rescan :PRIMARY this Rescan the EDE proj project THIS. - Method: ede-map-subprojects :PRIMARY this proc For object THIS, execute PROC on all subprojects. - Method: ede-convert-path :PRIMARY this path 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. - Method: ede-name :PRIMARY this Return a short-name for THIS project file. Do this by extracting the lowest directory name. - Method: eieio-speedbar-derive-line-path :PRIMARY obj &optional depth Return the path to OBJ. Optional DEPTH is the depth we start at. - Method: ede-buffer-header-file :PRIMARY this buffer Return `nil', projects don't have header files. - Method: ede-buffer-documentation-files :PRIMARY this buffer Return all documentation in project THIS based on BUFFER. - Method: ede-map-targets :PRIMARY this proc For object THIS, execute PROC on all targets. - Method: ede-buffer-mine :PRIMARY this buffer Return non-`nil' if object THIS lays claim to the file in BUFFER. - Method: ede-object-keybindings :PRIMARY this Retrieves the slot `keybindings' from an object of class `ede-project' - Method: ede-description :PRIMARY this Return a description suitible for the minibuffer about THIS. - Method: eieio-speedbar-object-children :PRIMARY this Return the list of speedbar display children for THIS. - Method: project-make-dist :PRIMARY this Build a distribution for the project based on THIS target. - Method: project-new-target-custom :PRIMARY proj Create a new target. It is up to the project PROJ to get the name. - Method: ede-expand-filename :PRIMARY this filename &optional force 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. - Method: ede-menu-items-build :PRIMARY obj &optional current Return a list of menu items for building project OBJ. If optional argument CURRENT is non-`nil', return sub-menu code. - Method: project-new-target :PRIMARY proj Create a new target. It is up to the project PROJ to get the name. - Method: project-compile-project :PRIMARY obj &optional command Compile the entire current project OBJ. Argument COMMAND is the command to use when compiling. - Method: eieio-speedbar-object-buttonname :PRIMARY object Return a string to use as a speedbar button for OBJECT. - Method: ede-map-project-buffers :PRIMARY this proc For THIS, execute PROC on all buffers belonging to THIS. - Method: eieio-done-customizing :PRIMARY proj Call this when a user finishes customizing PROJ. - Method: ede-documentation :PRIMARY this 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. - Method: project-interactive-select-target :PRIMARY this prompt Interactivly query for a target that exists in project THIS. Argument PROMPT is the prompt to use when querying the user for a target. - Method: ede-target-in-project-p :PRIMARY proj target Is PROJ the parent of TARGET? If TARGET belongs to a subproject, return that project file. - Method: ede-find-target :PRIMARY proj buffer Fetch the target in PROJ belonging to BUFFER or nil. - Method: ede-add-subproject :PRIMARY proj-a proj-b Add into PROJ-A, the subproject PROJ-B. - Method: ede-commit-project :PRIMARY proj Commit any change to PROJ to its file. - Method: ede-object-menu :PRIMARY this Retrieves the slot `menu' from an object of class `ede-project' - Method: ede-commit-local-variables :PRIMARY proj Commit change to local variables in PROJ.  File: ede.info, Node: ede-proj-project, Next: project-am-makefile, Prev: ede-project, Up: Project ede-proj-project ================ Inheritance Tree: `eieio-speedbar' `eieio-speedbar-directory-button' `*Note ede-project-placeholder::.' `*Note ede-project::.' `ede-proj-project' No children Create a new object with name NAME of class type ede-proj-project Slots: `:makefile-type' Type: `symbol' Default Value: `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. `:variables' Type: `list' Default Value: `nil' Variables to set in this Makefile. `:configuration-variables' Type: `list' Default Value: `("debug" (("DEBUG" . "1")))' Makefile variables to use in different configurations. These variables are used in the makefile when a configuration becomes active. `:inference-rules ' Default Value: `nil' Inference rules to add to the makefile. `:automatic-dependencies' Type: `boolean' Default Value: `t' Non-`nil' to do implement automatic dependencies in the Makefile. Specialized Methods ------------------- - Method: project-rescan :PRIMARY this Rescan the EDE proj project THIS. - Method: ede-proj-makefile-create :PRIMARY this mfilename Create a Makefile for all Makefile targets in THIS. MFILENAME is the makefile to generate. - Method: ede-proj-makefile-insert-rules :PRIMARY this Insert rules needed by THIS target. - Method: ede-proj-makefile-tags :PRIMARY this targets 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. - Method: project-update-version :PRIMARY this The `:version' of project THIS has changed. - Method: ede-buffer-mine :PRIMARY this buffer Return `t' if object THIS lays claim to the file in BUFFER. - Method: ede-proj-makefile-insert-variables :PRIMARY this Insert variables needed by target THIS. - Method: project-make-dist :PRIMARY this Build a distribution for the project based on THIS target. - Method: ede-proj-makefile-insert-dist-rules :PRIMARY this Insert distribution rules for THIS in a Makefile, such as CLEAN and DIST. - Method: project-new-target-custom :PRIMARY this Create a new target in THIS for custom. - Method: ede-proj-makefile-create-maybe :PRIMARY this mfilename Create a Makefile for all Makefile targets in THIS if needed. MFILENAME is the makefile to generate. - Method: ede-proj-configure-test-required-file :PRIMARY this file For project THIS, test that the file FILE exists, or create it. - Method: ede-proj-setup-buildenvironment :PRIMARY this &optional force 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. - Method: ede-proj-makefile-garbage-patterns :PRIMARY this Return a list of patterns that are considred garbage to THIS. These are removed with make clean. - Method: ede-proj-configure-synchronize :PRIMARY this Synchronize what we know about project THIS into configure.in. - Method: project-new-target :PRIMARY this Create a new target in THIS based on the current buffer. - Method: project-compile-project :PRIMARY proj &optional command Compile the entire current project PROJ. Argument COMMAND is the command to use when compiling. - Method: ede-proj-makefile-configuration-variables :PRIMARY this configuration Return a list of configuration variables from THIS. Use CONFIGURATION as the current configuration to query. - Method: eieio-done-customizing :PRIMARY proj Call this when a user finishes customizing this object. Argument PROJ is the project to save. - Method: ede-proj-configure-recreate :PRIMARY this Delete project THISes configure script and start over. - Method: ede-proj-makefile-insert-user-rules :PRIMARY this 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. - Method: ede-proj-dist-makefile :PRIMARY this Return the name of the Makefile with the DIST target in it for THIS. - Method: ede-proj-configure-file :PRIMARY this The configure.in script used by project THIS. - Method: ede-commit-project :PRIMARY proj Commit any change to PROJ to its file. - Method: ede-commit-local-variables :PRIMARY proj Commit change to local variables in PROJ.  File: ede.info, Node: project-am-makefile, Prev: ede-proj-project, Up: Project project-am-makefile =================== Inheritance Tree: `eieio-speedbar' `eieio-speedbar-directory-button' `*Note ede-project-placeholder::.' `*Note ede-project::.' `project-am-makefile' No children Create a new object with name NAME of class type project-am-makefile Slots: `:targets' Type: `list' Default Value: `nil' *Note ede-project::. Specialized Methods ------------------- - Method: project-rescan :PRIMARY this Rescan the makefile for all targets and sub targets. - Method: project-am-subtree :PRIMARY ampf subpath Return the sub project in AMPF specified by SUBPATH. - Method: project-targets-for-file :PRIMARY proj Return a list of targets the project PROJ. - Method: ede-buffer-mine :PRIMARY this buffer Return `t' if object THIS lays claim to the file in BUFFER. - Method: project-new-target :PRIMARY proj Create a new target named NAME. Argument TYPE is the type of target to insert. This is a string matching something in `project-am-type-alist' or 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. - Method: project-compile-project :PRIMARY obj &optional command Compile the entire current project. Argument COMMAND is the command to use when compiling. - Method: ede-find-target :PRIMARY amf buffer Fetch the target belonging to BUFFER.  File: ede.info, Node: Targets, Next: Sourcecode, Prev: Project, Up: Extending EDE * Menu: * ede-target :: * ede-proj-target :: * ede-proj-target-makefile :: * ede-proj-target-makefile-objectcode :: * ede-proj-target-makefile-archive :: * ede-proj-target-makefile-program :: * ede-proj-target-makefile-shared-object :: * ede-proj-target-elisp :: * ede-proj-target-makefile-info :: * ede-proj-target-makefile-miscelaneous :: * ede-proj-target-aux :: * ede-proj-target-scheme :: * project-am-target :: * project-am-objectcode :: * project-am-program :: * project-am-lib :: * project-am-lisp :: * project-am-texinfo :: * project-am-man ::  File: ede.info, Node: ede-target, Next: ede-proj-target, Up: Targets ede-target ========== Inheritance Tree: `eieio-speedbar' `eieio-speedbar-directory-button' `ede-target' Children: *Note ede-proj-target::, *Note project-am-target::. Create a new object with name NAME of class type ede-target Slots: `:name' Type: `string' Default Value: `unbound' Name of this target. `:path' Type: `string' Default Value: `unbound' The path to the sources of this target. Relative to the path of the project it belongs to. `:source' Type: `list' Default Value: `nil' Source files in this target. `:versionsource' Type: `list' Default Value: `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. Specialized Methods ------------------- - Method: eieio-speedbar-description :PRIMARY obj Provide a speedbar description for OBJ. - Method: project-compile-target :PRIMARY obj &optional command Compile the current target OBJ. Argument COMMAND is the command to use for compiling the target. - Method: project-debug-target :PRIMARY obj Run the current project target OBJ in a debugger. - Method: ede-convert-path :PRIMARY this path 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. - Method: ede-name :PRIMARY this Return the name of THIS targt. - Method: ede-target-buffer-in-sourcelist :PRIMARY this buffer source Return non-`nil' if object THIS is in BUFFER to a SOURCE list. Handles complex path issues. - Method: eieio-speedbar-derive-line-path :PRIMARY obj &optional depth Return the path to OBJ. Optional DEPTH is the depth we start at. - Method: ede-buffer-header-file :PRIMARY this buffer There are no default header files in EDE. Do a quick check to see if there is a Header tag in this buffer. - Method: project-remove-file :PRIMARY ot fnnd Remove the current buffer from project target OT. Argument FNND is an argument. - Method: ede-buffer-documentation-files :PRIMARY this buffer Check for some documenation files for THIS. Also do a quick check to see if there is a Documentation tag in this BUFFER. - Method: ede-buffer-mine :PRIMARY this buffer Return non-`nil' if object THIS lays claim to the file in BUFFER. - Method: ede-map-target-buffers :PRIMARY this proc For THIS, execute PROC on all buffers belonging to THIS. - Method: eieio-speedbar-child-description :PRIMARY obj Provide a speedbar description for a plain-child of OBJ. A plain child is a child element which is not an EIEIO object. - Method: ede-object-keybindings :PRIMARY this Retrieves the slot `keybindings' from an object of class `ede-target' - Method: ede-description :PRIMARY this Return a description suitible for the minibuffer about THIS. - Method: eieio-speedbar-object-children :PRIMARY this Return the list of speedbar display children for THIS. - Method: ede-object-sourcecode :PRIMARY this Retrieves the slot `sourcetype' from an object of class `ede-target' - Method: ede-expand-filename :PRIMARY this filename &optional force Return a fully qualified file name based on target THIS. FILENAME should a 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. - Method: ede-menu-items-build :PRIMARY obj &optional current Return a list of menu items for building target OBJ. If optional argument CURRENT is non-`nil', return sub-menu code. - Method: ede-want-file-p :PRIMARY this file Return non-`nil' if THIS target wants FILE. - Method: project-delete-target :PRIMARY ot Delete the current target OT from it's parent project. - Method: ede-target-sourcecode :PRIMARY this Return the sourcecode objects which THIS permits. - Method: eieio-speedbar-child-make-tag-lines :PRIMARY this depth Create a speedbar tag line for a child of THIS. It has depth DEPTH. - Method: eieio-speedbar-object-buttonname :PRIMARY object Return a string to use as a speedbar button for OBJECT. - Method: eieio-done-customizing :PRIMARY target Call this when a user finishes customizing TARGET. - Method: project-edit-file-target :PRIMARY ot Edit the target OT associated w/ this file. - Method: ede-documentation :PRIMARY this 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. - Method: ede-want-file-source-p :PRIMARY this file Return non-`nil' if THIS target wants FILE. - Method: ede-want-file-auxiliary-p :PRIMARY this file Return non-`nil' if THIS target wants FILE. - Method: project-add-file :PRIMARY ot file Add the current buffer into project project target OT. Argument FILE is the file to add. - Method: ede-target-name :PRIMARY this Return the name of THIS target, suitable for make or debug style commands. - Method: ede-object-menu :PRIMARY this Retrieves the slot `menu' from an object of class `ede-target'  File: ede.info, Node: ede-proj-target, Next: ede-proj-target-makefile, Prev: ede-target, Up: Targets ede-proj-target =============== Inheritance Tree: `eieio-speedbar' `eieio-speedbar-directory-button' `*Note ede-target::.' `ede-proj-target' Children: *Note ede-proj-target-makefile::, *Note ede-proj-target-aux::, *Note ede-proj-target-scheme::. Create a new object with name NAME of class type ede-proj-target Slots: `:auxsource' Type: `list' Default Value: `nil' Auxilliary 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' Type: `(or null symbol)' Default Value: `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' Type: `(or null symbol)' Default Value: `nil' The linker to be used to link compled 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. Specialized Methods ------------------- - Method: project-compile-target :PRIMARY obj &optional command Compile the current target OBJ. Argument COMMAND is the command to use for compiling the target. - Method: project-rescan :PRIMARY this readstream Rescan target THIS from the read list READSTREAM. - Method: project-debug-target :PRIMARY obj Run the current project target OBJ in a debugger. - Method: ede-proj-configure-add-missing :PRIMARY this Query if any files needed by THIS provided by automake are missing. Results in -add-missing being passed to automake. - Method: ede-proj-flush-autoconf :PRIMARY this 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. - Method: ede-proj-makefile-insert-rules :PRIMARY this Insert rules needed by THIS target. - Method: project-remove-file :PRIMARY target file For TARGET, remove FILE. FILE must be massaged by "ede-convert-path". - Method: ede-buffer-mine :PRIMARY this buffer Return `t' if object THIS lays claim to the file in BUFFER. - Method: ede-proj-configure-create-missing :PRIMARY this Add any missing files for THIS by creating them. - Method: ede-proj-makefile-sourcevar :PRIMARY this Return the variable name for THIS's sources. - Method: ede-proj-makefile-insert-variables :PRIMARY this &optional moresource Insert variables needed by target THIS. Optional argument MORESOURCE is a list of additional sources to add to the sources variable. - Method: ede-proj-makefile-insert-automake-post-variables :PRIMARY this Insert variables needed by target THIS in Makefile.am after SOURCES. - Method: ede-proj-linkers :PRIMARY obj List of linkers being used by OBJ. If the `linker' slot is empty, concoct one on a first match found basis for any given type from the `availablelinkers' slot. Otherwise, return the `linker' slot. Converts all symbols into the objects to be used. - Method: ede-proj-makefile-garbage-patterns :PRIMARY this Return a list of patterns that are considred garbage to THIS. These are removed with make clean. - Method: ede-proj-tweak-autoconf :PRIMARY this Tweak the configure file (current buffer) to accomodate THIS. - Method: ede-proj-compilers :PRIMARY obj List of compilers being used by OBJ. If the `compiler' slot is empty, concoct one on a first match found basis for any given type from the `availablecompilers' slot. Otherwise, return the `compiler' slot. Converts all symbols into the objects to be used. - Method: project-delete-target :PRIMARY this Delete the current target THIS from it's parent project. - Method: ede-proj-makefile-target-name :PRIMARY this Return the name of the main target for THIS target. - Method: eieio-done-customizing :PRIMARY target Call this when a user finishes customizing this object. Argument TARGET is the project we are completing customization on. - Method: ede-proj-makefile-insert-user-rules :PRIMARY this Insert user specified rules needed by THIS target. - Method: project-add-file :PRIMARY this file Add to target THIS the current buffer represented as FILE. - Method: ede-proj-makefile-insert-automake-pre-variables :PRIMARY this Insert variables needed by target THIS in Makefile.am before SOURCES. - Method: ede-proj-makefile-dependency-files :PRIMARY this Return a list of source files to convert to dependencies. Argument THIS is the target to get sources from. - Method: ede-proj-makefile-insert-source-variables :PRIMARY this &optional moresource Insert the source variables needed by THIS. Optional argument MORESOURCE is a list of additional sources to add to the sources variable.  File: ede.info, Node: ede-proj-target-makefile, Next: ede-proj-target-makefile-objectcode, Prev: ede-proj-target, Up: Targets ede-proj-target-makefile ======================== Inheritance Tree: `eieio-speedbar' `eieio-speedbar-directory-button' `*Note ede-target::.' `*Note ede-proj-target::.' `ede-proj-target-makefile' Children: *Note ede-proj-target-makefile-objectcode::, *Note ede-proj-target-elisp::, *Note ede-proj-target-makefile-info::, *Note ede-proj-target-makefile-miscelaneous::. Create a new object with name NAME of class type ede-proj-target-makefile Slots: `:makefile' Type: `string' Default Value: `"Makefile"' File name of generated Makefile. `:partofall' Type: `boolean' Default Value: `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-variables' Type: `list' Default Value: `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. `:rules' Type: `list' Default Value: `nil' Arbitrary rules and dependencies needed to make this target. It is safe to leave this blank. Specialized Methods ------------------- - Method: ede-proj-makefile-dependencies :PRIMARY this 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. - Method: project-compile-target :PRIMARY obj &optional command Compile the current target program OBJ. Optional argument COMMAND is the s the alternate command to use. - Method: ede-proj-makefile-insert-rules :PRIMARY this Insert rules needed by THIS target. - Method: ede-proj-makefile-insert-variables :PRIMARY this &optional moresource Insert variables needed by target THIS. Optional argument MORESOURCE is a list of additional sources to add to the sources variable. - Method: ede-proj-makefile-insert-commands :PRIMARY this Insert the commands needed by target THIS. For targets, insert the commands needed by the chosen compiler.  File: ede.info, Node: ede-proj-target-makefile-objectcode, Next: ede-proj-target-makefile-archive, Prev: ede-proj-target-makefile, Up: Targets ede-proj-target-makefile-objectcode =================================== Inheritance Tree: `eieio-speedbar' `eieio-speedbar-directory-button' `*Note ede-target::.' `*Note ede-proj-target::.' `*Note ede-proj-target-makefile::.' `ede-proj-target-makefile-objectcode' Children: *Note ede-proj-target-makefile-archive::, *Note ede-proj-target-makefile-program::. Create a new object with name NAME of class type ede-proj-target-makefile-objectcode Slots: `:configuration-variables' Type: `list' Default Value: `("debug" ("CFLAGS" . "-g") ("LDFLAGS" . "-g"))' *Note ede-proj-target-makefile::. Specialized Methods ------------------- - Method: ede-buffer-header-file :PRIMARY this buffer There are no default header files. - Method: ede-proj-makefile-sourcevar :PRIMARY this Return the variable name for THIS's sources. - Method: ede-proj-makefile-insert-variables :PRIMARY this &optional moresource Insert variables needed by target THIS. Optional argument MORESOURCE is not used. - Method: ede-proj-makefile-dependency-files :PRIMARY this Return a list of source files to convert to dependencies. Argument THIS is the target to get sources from.  File: ede.info, Node: ede-proj-target-makefile-archive, Next: ede-proj-target-makefile-program, Prev: ede-proj-target-makefile-objectcode, Up: Targets ede-proj-target-makefile-archive ================================ Inheritance Tree: `eieio-speedbar' `eieio-speedbar-directory-button' `*Note ede-target::.' `*Note ede-proj-target::.' `*Note ede-proj-target-makefile::.' `*Note ede-proj-target-makefile-objectcode::.' `ede-proj-target-makefile-archive' No children Create a new object with name NAME of class type ede-proj-target-makefile-archive Specialized Methods ------------------- - Method: ede-proj-makefile-insert-rules :PRIMARY this Create the make rule needed to create an archive for THIS. - Method: ede-proj-makefile-insert-source-variables :BEFORE 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.  File: ede.info, Node: ede-proj-target-makefile-program, Next: ede-proj-target-makefile-shared-object, Prev: ede-proj-target-makefile-archive, Up: Targets ede-proj-target-makefile-program ================================ Inheritance Tree: `eieio-speedbar' `eieio-speedbar-directory-button' `*Note ede-target::.' `*Note ede-proj-target::.' `*Note ede-proj-target-makefile::.' `*Note ede-proj-target-makefile-objectcode::.' `ede-proj-target-makefile-program' Children: *Note ede-proj-target-makefile-shared-object::. Create a new object with name NAME of class type ede-proj-target-makefile-program Slots: `:ldlibs' Type: `list' Default Value: `nil' Libraries, such as "m" or "Xt" which this program dependso on. The linker flag "-l" is automatically prepended. Do not include a "lib" prefix, or a ".so" suffix. `:ldflags' Type: `list' Default Value: `nil' Additional flags to add when linking this target. Use ldlibs to add addition libraries. Use this to specify specific options to the linker. Specialized Methods ------------------- - Method: project-debug-target :PRIMARY obj Debug a program target OBJ. - Method: ede-proj-makefile-insert-rules :PRIMARY this Insert rules needed by THIS target. - Method: ede-proj-makefile-insert-automake-post-variables :PRIMARY this Insert bin_PROGRAMS variables needed by target THIS. - Method: ede-proj-makefile-insert-automake-pre-variables :PRIMARY this Insert bin_PROGRAMS variables needed by target THIS.