Add Ada config
This commit is contained in:
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,682 @@
|
||||
;;; ada-prj.el --- GUI editing of project files for the ada-mode
|
||||
|
||||
;; Copyright (C) 1998-2019 Free Software Foundation, Inc.
|
||||
|
||||
;; Author: Emmanuel Briot <briot@gnat.com>
|
||||
;; Maintainer: Stephen Leake <stephen_leake@stephe-leake.org>
|
||||
;; Keywords: languages, ada, project file
|
||||
;; Package: ada-mode
|
||||
|
||||
;; This file is part of GNU Emacs.
|
||||
|
||||
;; GNU Emacs is free software: you can redistribute it and/or modify
|
||||
;; it under the terms of the GNU General Public License as published by
|
||||
;; the Free Software Foundation, either version 3 of the License, or
|
||||
;; (at your option) any later version.
|
||||
|
||||
;; GNU Emacs is distributed in the hope that it will be useful,
|
||||
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
;; GNU General Public License for more details.
|
||||
|
||||
;; You should have received a copy of the GNU General Public License
|
||||
;; along with GNU Emacs. If not, see <https://www.gnu.org/licenses/>.
|
||||
|
||||
;;; Commentary:
|
||||
|
||||
;; This package provides a set of functions to easily edit the project
|
||||
;; files used by the ada-mode.
|
||||
;; The only function publicly available here is `ada-customize'.
|
||||
;; See the documentation of the Ada mode for more information on the project
|
||||
;; files.
|
||||
;; Internally, a project file is represented as a property list, with each
|
||||
;; field of the project file matching one property of the list.
|
||||
|
||||
;;; Code:
|
||||
|
||||
|
||||
;; ----- Requirements -----------------------------------------------------
|
||||
|
||||
(require 'cus-edit)
|
||||
(require 'ada-xref)
|
||||
|
||||
(eval-when-compile
|
||||
(require 'ada-mode))
|
||||
(eval-when-compile (require 'cl-lib))
|
||||
|
||||
;; ----- Buffer local variables -------------------------------------------
|
||||
|
||||
(defvar ada-prj-current-values nil
|
||||
"Hold the current value of the fields, This is a property list.")
|
||||
(make-variable-buffer-local 'ada-prj-current-values)
|
||||
|
||||
(defvar ada-prj-default-values nil
|
||||
"Hold the default value for the fields, This is a property list.")
|
||||
(make-variable-buffer-local 'ada-prj-default-values)
|
||||
|
||||
(defvar ada-prj-ada-buffer nil
|
||||
"Indicates what Ada source file was being edited.")
|
||||
|
||||
(defvar ada-old-cross-prefix nil
|
||||
"The cross-prefix associated with the currently loaded runtime library.")
|
||||
|
||||
|
||||
;; ----- Functions --------------------------------------------------------
|
||||
|
||||
(defun ada-prj-new ()
|
||||
"Open a new project file."
|
||||
(interactive)
|
||||
(let* ((prj
|
||||
(if (and ada-prj-default-project-file
|
||||
(not (string= ada-prj-default-project-file "")))
|
||||
ada-prj-default-project-file
|
||||
"default.adp"))
|
||||
(filename (read-file-name "Project file: "
|
||||
(if prj "" nil)
|
||||
nil
|
||||
nil
|
||||
prj)))
|
||||
(if (not (string= (file-name-extension filename t) ".adp"))
|
||||
(error "File name extension for project files must be .adp"))
|
||||
|
||||
(ada-customize nil filename)))
|
||||
|
||||
(defun ada-prj-edit ()
|
||||
"Editing the project file associated with the current Ada buffer.
|
||||
If there is none, opens a new project file."
|
||||
(interactive)
|
||||
(if ada-prj-default-project-file
|
||||
(ada-customize)
|
||||
(ada-prj-new)))
|
||||
|
||||
(defun ada-prj-initialize-values (symbol _ada-buffer filename)
|
||||
"Set SYMBOL to the property list of the project file FILENAME.
|
||||
If FILENAME is null, read the file associated with ADA-BUFFER.
|
||||
If no project file is found, return the default values."
|
||||
;; FIXME: rationalize arguments; make ada-buffer optional?
|
||||
(if (and filename
|
||||
(not (string= filename ""))
|
||||
(assoc filename ada-xref-project-files))
|
||||
(set symbol (copy-sequence (cdr (assoc filename ada-xref-project-files))))
|
||||
|
||||
;; Set default values (except for the file name if this was given
|
||||
;; in the buffer
|
||||
(set symbol (ada-default-prj-properties))
|
||||
(if (and filename (not (string= filename "")))
|
||||
(set symbol (plist-put (eval symbol) 'filename filename)))
|
||||
))
|
||||
|
||||
|
||||
(defun ada-prj-save-specific-option (field)
|
||||
"Return the string to print in the project file to save FIELD.
|
||||
If the current value of FIELD is the default value, return an empty string."
|
||||
(if (string= (plist-get ada-prj-current-values field)
|
||||
(plist-get ada-prj-default-values field))
|
||||
""
|
||||
(concat (symbol-name field)
|
||||
"=" (plist-get ada-prj-current-values field) "\n")))
|
||||
|
||||
(defun ada-prj-save ()
|
||||
"Save the edited project file."
|
||||
(interactive)
|
||||
(let ((file-name (or (plist-get ada-prj-current-values 'filename)
|
||||
(read-file-name "Save project as: ")))
|
||||
output)
|
||||
(setq output
|
||||
(concat
|
||||
|
||||
;; Save the fields that do not depend on the current buffer
|
||||
;; only if they are different from the default value
|
||||
|
||||
(ada-prj-save-specific-option 'comp_opt)
|
||||
(ada-prj-save-specific-option 'bind_opt)
|
||||
(ada-prj-save-specific-option 'link_opt)
|
||||
(ada-prj-save-specific-option 'gnatmake_opt)
|
||||
(ada-prj-save-specific-option 'gnatfind_opt)
|
||||
(ada-prj-save-specific-option 'cross_prefix)
|
||||
(ada-prj-save-specific-option 'remote_machine)
|
||||
(ada-prj-save-specific-option 'debug_cmd)
|
||||
|
||||
;; Always save the fields that depend on the current buffer
|
||||
"main=" (plist-get ada-prj-current-values 'main) "\n"
|
||||
"build_dir=" (plist-get ada-prj-current-values 'build_dir) "\n"
|
||||
(ada-prj-set-list "check_cmd"
|
||||
(plist-get ada-prj-current-values 'check_cmd)) "\n"
|
||||
(ada-prj-set-list "make_cmd"
|
||||
(plist-get ada-prj-current-values 'make_cmd)) "\n"
|
||||
(ada-prj-set-list "comp_cmd"
|
||||
(plist-get ada-prj-current-values 'comp_cmd)) "\n"
|
||||
(ada-prj-set-list "run_cmd"
|
||||
(plist-get ada-prj-current-values 'run_cmd)) "\n"
|
||||
(ada-prj-set-list "src_dir"
|
||||
(plist-get ada-prj-current-values 'src_dir)
|
||||
t) "\n"
|
||||
(ada-prj-set-list "obj_dir"
|
||||
(plist-get ada-prj-current-values 'obj_dir)
|
||||
t) "\n"
|
||||
(ada-prj-set-list "debug_pre_cmd"
|
||||
(plist-get ada-prj-current-values 'debug_pre_cmd))
|
||||
"\n"
|
||||
(ada-prj-set-list "debug_post_cmd"
|
||||
(plist-get ada-prj-current-values 'debug_post_cmd))
|
||||
"\n"
|
||||
))
|
||||
|
||||
(find-file file-name)
|
||||
(erase-buffer)
|
||||
(insert output)
|
||||
(save-buffer)
|
||||
;; kill the project buffer
|
||||
(kill-buffer nil)
|
||||
|
||||
;; kill the editor buffer
|
||||
(kill-buffer "*Edit Ada Mode Project*")
|
||||
|
||||
;; automatically set the new project file as the active one
|
||||
(setq ada-prj-default-project-file file-name)
|
||||
|
||||
;; force Emacs to reread the project files
|
||||
(ada-reread-prj-file file-name)
|
||||
)
|
||||
)
|
||||
|
||||
(defun ada-prj-load-from-file (symbol)
|
||||
"Load SYMBOL value from file.
|
||||
One item per line should be found in the file."
|
||||
(save-excursion
|
||||
(let ((file (read-file-name "File name: " nil nil t))
|
||||
(buffer (current-buffer))
|
||||
line
|
||||
list)
|
||||
(find-file file)
|
||||
(widen)
|
||||
(goto-char (point-min))
|
||||
(while (not (eobp))
|
||||
(setq line (buffer-substring-no-properties (point) (point-at-eol)))
|
||||
(cl-pushnew line list :test #'equal)
|
||||
(forward-line 1))
|
||||
(kill-buffer nil)
|
||||
(set-buffer buffer)
|
||||
(setq ada-prj-current-values
|
||||
(plist-put ada-prj-current-values
|
||||
symbol
|
||||
(append (plist-get ada-prj-current-values symbol)
|
||||
(reverse list)))))
|
||||
(ada-prj-display-page 2)))
|
||||
|
||||
(defun ada-prj-subdirs-of (dir)
|
||||
"Return a list of all the subdirectories of DIR, recursively."
|
||||
(let ((subdirs (directory-files dir t "^[^.].*"))
|
||||
(dirlist (list dir)))
|
||||
(while subdirs
|
||||
(if (file-directory-p (car subdirs))
|
||||
(let ((sub (ada-prj-subdirs-of (car subdirs))))
|
||||
(if sub
|
||||
(setq dirlist (append sub dirlist)))))
|
||||
(setq subdirs (cdr subdirs)))
|
||||
dirlist))
|
||||
|
||||
(defun ada-prj-load-directory (field &optional file-name)
|
||||
"Append to FIELD in the current project the subdirectories of FILE-NAME.
|
||||
If FILE-NAME is nil, ask the user for the name."
|
||||
|
||||
;; Do not use an external dialog for this, since it wouldn't allow
|
||||
;; the user to select a directory
|
||||
(let ((use-dialog-box nil))
|
||||
(unless file-name
|
||||
(setq file-name (read-directory-name "Root directory: " nil nil t))))
|
||||
|
||||
(setq ada-prj-current-values
|
||||
(plist-put ada-prj-current-values
|
||||
field
|
||||
(append (plist-get ada-prj-current-values field)
|
||||
(reverse (ada-prj-subdirs-of
|
||||
(expand-file-name file-name))))))
|
||||
(ada-prj-display-page 2))
|
||||
|
||||
(defun ada-prj-display-page (tab-num)
|
||||
"Display page TAB-NUM in the notebook.
|
||||
The current buffer must be the project editing buffer."
|
||||
|
||||
(let ((inhibit-read-only t))
|
||||
(erase-buffer))
|
||||
|
||||
;; Widget support in Emacs 21 requires that we clear the buffer first
|
||||
(if (and (not (featurep 'xemacs)) (>= emacs-major-version 21))
|
||||
(progn
|
||||
(setq widget-field-new nil
|
||||
widget-field-list nil)
|
||||
(mapc (lambda (x) (delete-overlay x)) (car (overlay-lists)))
|
||||
(mapc (lambda (x) (delete-overlay x)) (cdr (overlay-lists)))))
|
||||
|
||||
;; Display the tabs
|
||||
|
||||
(widget-insert "\n Project configuration.\n
|
||||
___________ ____________ ____________ ____________ ____________\n / ")
|
||||
(widget-create 'push-button :notify
|
||||
(lambda (&rest _dummy) (ada-prj-display-page 1)) "General")
|
||||
(widget-insert " \\ / ")
|
||||
(widget-create 'push-button :notify
|
||||
(lambda (&rest _dummy) (ada-prj-display-page 2)) "Paths")
|
||||
(widget-insert " \\ / ")
|
||||
(widget-create 'push-button :notify
|
||||
(lambda (&rest _dummy) (ada-prj-display-page 3)) "Switches")
|
||||
(widget-insert " \\ / ")
|
||||
(widget-create 'push-button :notify
|
||||
(lambda (&rest _dummy) (ada-prj-display-page 4)) "Ada Menu")
|
||||
(widget-insert " \\ / ")
|
||||
(widget-create 'push-button :notify
|
||||
(lambda (&rest _dummy) (ada-prj-display-page 5)) "Debugger")
|
||||
(widget-insert " \\\n")
|
||||
|
||||
;; Display the currently selected page
|
||||
|
||||
(cond
|
||||
|
||||
;;
|
||||
;; First page (General)
|
||||
;;
|
||||
((= tab-num 1)
|
||||
(widget-insert "/ \\/______________\\/______________\\/______________\\/______________\\\n")
|
||||
|
||||
(widget-insert "Project file name:\n")
|
||||
(widget-insert (plist-get ada-prj-current-values 'filename))
|
||||
(widget-insert "\n\n")
|
||||
(ada-prj-field 'casing "Casing Exceptions"
|
||||
"List of files that contain casing exception
|
||||
dictionaries. All these files contain one
|
||||
identifier per line, with a special casing.
|
||||
The first file has the highest priority."
|
||||
t nil
|
||||
(mapconcat (lambda(x)
|
||||
(concat " " x))
|
||||
(ada-xref-get-project-field 'casing)
|
||||
"\n")
|
||||
)
|
||||
(ada-prj-field 'main "Executable file name"
|
||||
"Name of the executable generated when you
|
||||
compile your application. This should include
|
||||
the full directory name, using ${build_dir} if
|
||||
you wish.")
|
||||
(ada-prj-field 'build_dir "Build directory"
|
||||
"Reference directory for relative paths in
|
||||
src_dir and obj_dir below. This is also the directory
|
||||
where the compilation is done.")
|
||||
(ada-prj-field 'remote_machine "Name of the remote machine (if any)"
|
||||
"If you want to remotely compile, debug and
|
||||
run your application, specify the name of a
|
||||
remote machine here. This capability requires
|
||||
the `rsh' protocol on the remote machine.")
|
||||
(ada-prj-field 'cross_prefix "Prefix used in for the cross tool chain"
|
||||
"When working on multiple cross targets, it is
|
||||
most convenient to specify the prefix of the
|
||||
tool chain here. For instance, on PowerPc
|
||||
vxworks, you would enter `powerpc-wrs-vxworks-'.
|
||||
To use JGNAT, enter `j'.")
|
||||
)
|
||||
|
||||
|
||||
;;
|
||||
;; Second page (Paths)
|
||||
;;
|
||||
((= tab-num 2)
|
||||
(if (not (equal (plist-get ada-prj-current-values 'cross_prefix)
|
||||
ada-old-cross-prefix))
|
||||
(progn
|
||||
(setq ada-old-cross-prefix
|
||||
(plist-get ada-prj-current-values 'cross_prefix))
|
||||
(ada-initialize-runtime-library ada-old-cross-prefix)))
|
||||
|
||||
|
||||
(widget-insert "/_____________\\/ \\/______________\\/______________\\/______________\\\n")
|
||||
(ada-prj-field 'src_dir "Source directories"
|
||||
"Enter the list of directories where your Ada
|
||||
sources can be found. These directories will be
|
||||
used for the cross-references and for the default
|
||||
compilation commands.
|
||||
Note that src_dir includes both the build directory
|
||||
and the standard runtime."
|
||||
t t
|
||||
(mapconcat (lambda(x)
|
||||
(concat " " x))
|
||||
ada-xref-runtime-library-specs-path
|
||||
"\n")
|
||||
)
|
||||
(widget-insert "\n\n")
|
||||
|
||||
(ada-prj-field 'obj_dir "Object directories"
|
||||
"Enter the list of directories where the GNAT
|
||||
library files (ALI files) can be found. These
|
||||
files are used for cross-references and by the
|
||||
gnatmake command.
|
||||
Note that obj_dir includes both the build directory
|
||||
and the standard runtime."
|
||||
t t
|
||||
(mapconcat (lambda(x)
|
||||
(concat " " x))
|
||||
ada-xref-runtime-library-ali-path
|
||||
"\n")
|
||||
)
|
||||
(widget-insert "\n\n")
|
||||
)
|
||||
|
||||
;;
|
||||
;; Third page (Switches)
|
||||
;;
|
||||
((= tab-num 3)
|
||||
(widget-insert "/_____________\\/______________\\/ \\/______________\\/______________\\\n")
|
||||
(ada-prj-field 'comp_opt "Switches for the compiler"
|
||||
"These switches are used in the default
|
||||
compilation commands, both for compiling a
|
||||
single file and rebuilding the whole project")
|
||||
(ada-prj-field 'bind_opt "Switches for the binder"
|
||||
"These switches are used in the default build
|
||||
command and are passed to the binder")
|
||||
(ada-prj-field 'link_opt "Switches for the linker"
|
||||
"These switches are used in the default build
|
||||
command and are passed to the linker")
|
||||
(ada-prj-field 'gnatmake_opt "Switches for gnatmake"
|
||||
"These switches are used in the default gnatmake
|
||||
command.")
|
||||
(ada-prj-field 'gnatfind_opt "Switches for gnatfind"
|
||||
"The command gnatfind is run every time the Ada/Goto/List_References menu.
|
||||
You should for instance add -a if you are working in an environment
|
||||
where most ALI files are write-protected, since otherwise they get
|
||||
ignored by gnatfind and you don't see the references within.")
|
||||
)
|
||||
|
||||
;;
|
||||
;; Fourth page
|
||||
;;
|
||||
((= tab-num 4)
|
||||
(widget-insert "/_____________\\/______________\\/______________\\/ \\/______________\\\n")
|
||||
(widget-insert
|
||||
"All the fields below can use variable substitution. The syntax is ${name},
|
||||
where name is the name that appears after the Help buttons in this buffer. As
|
||||
a special case, ${current} is replaced with the name of the file currently
|
||||
edited, with directory name but no extension, whereas ${full_current} is
|
||||
replaced with the name of the current file with directory name and
|
||||
extension.\n")
|
||||
(widget-insert
|
||||
"The environment variables ADA_INCLUDE_PATH and ADA_OBJECTS_PATH are set to
|
||||
${src_dir} and ${obj_dir} before running the compilation commands, so that you
|
||||
don't need to specify the -aI and -aO switches on the command line\n")
|
||||
(widget-insert
|
||||
"You can reference any environment variable using the same ${...} syntax as
|
||||
above, and put the name of the variable between the quotes.\n\n")
|
||||
(ada-prj-field 'check_cmd
|
||||
"Check syntax of a single file (menu Ada->Check File)"
|
||||
"This command is run to check the syntax and semantics of a file.
|
||||
The file name is added at the end of this command." t)
|
||||
(ada-prj-field 'comp_cmd
|
||||
"Compiling a single file (menu Ada->Compile File)"
|
||||
"This command is run when the recompilation
|
||||
of a single file is needed. The file name is
|
||||
added at the end of this command." t)
|
||||
(ada-prj-field 'make_cmd "Rebuilding the whole project (menu Ada->Build)"
|
||||
"This command is run when you want to rebuild
|
||||
your whole application. It is never issues
|
||||
automatically and you will need to ask for it.
|
||||
If remote_machine has been set, this command
|
||||
will be executed on the remote machine." t)
|
||||
(ada-prj-field 'run_cmd "Running the application (menu Ada->Run)"
|
||||
"This command specifies how to run the
|
||||
application, including any switch you need to
|
||||
specify. If remote_machine has been set, this
|
||||
command will be executed on the remote host." t)
|
||||
)
|
||||
|
||||
;;
|
||||
;; Fifth page
|
||||
;;
|
||||
((= tab-num 5)
|
||||
(widget-insert "/_____________\\/______________\\/______________\\/______________\\/ \\\n")
|
||||
(ada-prj-field 'debug_pre_cmd "Commands to execute before launching the
|
||||
debugger"
|
||||
"The following commands are executed one after the other before starting
|
||||
the debugger. These can be used to set up your environment." t)
|
||||
|
||||
(ada-prj-field 'debug_cmd "Debugging the application"
|
||||
"Specifies how to debug the application, possibly
|
||||
remotely if remote_machine has been set. We
|
||||
recommend the following debuggers:
|
||||
> gdb
|
||||
> gvd --tty
|
||||
> ddd --tty -fullname -toolbar")
|
||||
|
||||
(ada-prj-field 'debug_post_cmd "Commands to execute in the debugger"
|
||||
"The following commands are executed one in the debugger once it has been
|
||||
started. These can be used to initialize the debugger, for instance to
|
||||
connect to the target when working with cross-environments" t)
|
||||
)
|
||||
|
||||
)
|
||||
|
||||
|
||||
(widget-insert "______________________________________________________________________\n\n ")
|
||||
(widget-create 'push-button
|
||||
:notify (lambda (&rest _ignore)
|
||||
(setq ada-prj-current-values (ada-default-prj-properties))
|
||||
(ada-prj-display-page 1))
|
||||
"Reset to Default Values")
|
||||
(widget-insert " ")
|
||||
(widget-create 'push-button :notify (lambda (&rest _ignore) (kill-buffer nil))
|
||||
"Cancel")
|
||||
(widget-insert " ")
|
||||
(widget-create 'push-button :notify (lambda (&rest _ignore) (ada-prj-save))
|
||||
"Save")
|
||||
(widget-insert "\n\n")
|
||||
|
||||
(widget-setup)
|
||||
(with-no-warnings
|
||||
(beginning-of-buffer))
|
||||
)
|
||||
|
||||
|
||||
(defun ada-customize (&optional new-file filename)
|
||||
"Edit the project file associated with the current buffer.
|
||||
If there is none or NEW-FILE is non-nil, make a new one.
|
||||
If FILENAME is given, edit that file."
|
||||
(interactive)
|
||||
|
||||
(let ((ada-buffer (current-buffer))
|
||||
(inhibit-read-only t))
|
||||
|
||||
;; We can only edit interactively the standard ada-mode project files. If
|
||||
;; the user is using other formats for the project file (through hooks in
|
||||
;; `ada-load-project-hook', we simply edit the file
|
||||
|
||||
(if (and (not new-file)
|
||||
(or ada-prj-default-project-file filename)
|
||||
(string= (file-name-extension
|
||||
(or filename ada-prj-default-project-file))
|
||||
"gpr"))
|
||||
(progn
|
||||
(find-file ada-prj-default-project-file)
|
||||
(add-hook 'after-save-hook 'ada-reread-prj-file t t)
|
||||
)
|
||||
|
||||
(if filename
|
||||
(ada-reread-prj-file filename)
|
||||
(if (not (string= ada-prj-default-project-file ""))
|
||||
(ada-reread-prj-file ada-prj-default-project-file)
|
||||
(ada-reread-prj-file)))
|
||||
|
||||
(switch-to-buffer "*Edit Ada Mode Project*")
|
||||
|
||||
(ada-prj-initialize-values 'ada-prj-current-values
|
||||
ada-buffer
|
||||
ada-prj-default-project-file)
|
||||
|
||||
(set (make-local-variable 'ada-prj-ada-buffer) ada-buffer)
|
||||
|
||||
(use-local-map
|
||||
(let ((map (make-sparse-keymap)))
|
||||
(set-keymap-parent map custom-mode-map)
|
||||
(define-key map "\C-x\C-s" 'ada-prj-save)
|
||||
map))
|
||||
|
||||
;; FIXME: Not sure if this works!!
|
||||
(set (make-local-variable 'widget-keymap)
|
||||
(let ((map (make-sparse-keymap)))
|
||||
(set-keymap-parent map widget-keymap)
|
||||
(define-key map "\C-x\C-s" 'ada-prj-save)
|
||||
map))
|
||||
|
||||
(set (make-local-variable 'ada-old-cross-prefix)
|
||||
(ada-xref-get-project-field 'cross-prefix))
|
||||
|
||||
(ada-prj-display-page 1)
|
||||
)))
|
||||
|
||||
;; ---------------- Utilities --------------------------------
|
||||
|
||||
(defun ada-prj-set-list (string ada-list &optional is-directory)
|
||||
"Prepend STRING to strings in ADA-LIST, return new-line separated string.
|
||||
If IS-DIRECTORY is non-nil, each element of ADA-LIST is explicitly
|
||||
converted to a directory name."
|
||||
|
||||
(mapconcat (lambda (x) (concat string "="
|
||||
(if is-directory
|
||||
(file-name-as-directory x)
|
||||
x)))
|
||||
ada-list "\n"))
|
||||
|
||||
|
||||
(defun ada-prj-field-modified (widget &rest _dummy)
|
||||
"Callback for modification of WIDGET.
|
||||
Remaining args DUMMY are ignored.
|
||||
Save the change in `ada-prj-current-values' so that selecting
|
||||
another page and coming back keeps the new value."
|
||||
(setq ada-prj-current-values
|
||||
(plist-put ada-prj-current-values
|
||||
(widget-get widget ':prj-field)
|
||||
(widget-value widget))))
|
||||
|
||||
(defun ada-prj-display-help (widget _widget-modified event)
|
||||
"Callback for help button in WIDGET.
|
||||
Parameters WIDGET-MODIFIED, EVENT match :notify for the widget."
|
||||
(let ((text (widget-get widget 'prj-help)))
|
||||
(if event
|
||||
;; If we have a mouse-event, popup a menu
|
||||
(widget-choose "Help"
|
||||
(mapcar (lambda (a) (cons a t))
|
||||
(split-string text "\n"))
|
||||
event)
|
||||
;; Else display the help string just before the next group of
|
||||
;; variables
|
||||
(momentary-string-display
|
||||
(concat "*****Help*****\n" text "\n**************\n")
|
||||
(point-at-bol 2)))))
|
||||
|
||||
(defun ada-prj-show-value (widget _widget-modified event)
|
||||
"Show the current field value in WIDGET.
|
||||
Parameters WIDGET-MODIFIED, EVENT match :notify for the widget."
|
||||
(let* ((field (widget-get widget ':prj-field))
|
||||
(value (plist-get ada-prj-current-values field))
|
||||
(inhibit-read-only t)
|
||||
w)
|
||||
|
||||
;; If the other widget is already visible, delete it
|
||||
(if (widget-get widget 'prj-other-widget)
|
||||
(progn
|
||||
(widget-delete (widget-get widget 'prj-other-widget))
|
||||
(widget-put widget 'prj-other-widget nil)
|
||||
(widget-put widget ':prj-field field)
|
||||
(widget-default-value-set widget "Show Value")
|
||||
)
|
||||
|
||||
;; Else create it
|
||||
(save-excursion
|
||||
(mouse-set-point event)
|
||||
(forward-line 1)
|
||||
(beginning-of-line)
|
||||
(setq w (widget-create 'editable-list
|
||||
:entry-format "%i%d %v"
|
||||
:notify 'ada-prj-field-modified
|
||||
:help-echo (widget-get widget 'prj-help)
|
||||
:value value
|
||||
(list 'editable-field :keymap widget-keymap)))
|
||||
(widget-put widget 'prj-other-widget w)
|
||||
(widget-put w ':prj-field field)
|
||||
(widget-put widget ':prj-field field)
|
||||
(widget-default-value-set widget "Hide Value")
|
||||
)
|
||||
)
|
||||
(widget-setup)
|
||||
))
|
||||
|
||||
(defun ada-prj-field (field text help-text &optional is-list is-paths after-text)
|
||||
"Create a widget to edit FIELD in the current buffer.
|
||||
TEXT is a short explanation of what the field means, whereas HELP-TEXT
|
||||
is the text displayed when the user pressed the help button.
|
||||
If IS-LIST is non-nil, the field contains a list. Otherwise, it contains
|
||||
a single string.
|
||||
If IS-PATHS is true, some special buttons are added to load paths,...
|
||||
AFTER-TEXT is inserted just after the widget."
|
||||
(let ((value (plist-get ada-prj-current-values field))
|
||||
(inhibit-read-only t)
|
||||
widget)
|
||||
(unless value
|
||||
(setq value
|
||||
(if is-list '() "")))
|
||||
(widget-insert text)
|
||||
(widget-insert ":")
|
||||
(move-to-column 54 t)
|
||||
(widget-put (widget-create 'push-button
|
||||
:notify 'ada-prj-display-help
|
||||
"Help")
|
||||
'prj-help
|
||||
help-text)
|
||||
(widget-insert (concat " (" (symbol-name field) ")\n"))
|
||||
(if is-paths
|
||||
(progn
|
||||
(widget-create 'push-button
|
||||
:notify
|
||||
(list 'lambda '(&rest dummy) '(interactive)
|
||||
(list 'ada-prj-load-from-file
|
||||
(list 'quote field)))
|
||||
"Load From File")
|
||||
(widget-insert " ")
|
||||
(widget-create 'push-button
|
||||
:notify
|
||||
(list 'lambda '(&rest dummy) '(interactive)
|
||||
(list 'ada-prj-load-directory
|
||||
(list 'quote field)))
|
||||
"Load Recursive Directory")
|
||||
(widget-insert "\n ${build_dir}\n")))
|
||||
|
||||
(setq widget
|
||||
(if is-list
|
||||
(if (< (length value) 15)
|
||||
(widget-create 'editable-list
|
||||
:entry-format "%i%d %v"
|
||||
:notify 'ada-prj-field-modified
|
||||
:help-echo help-text
|
||||
:value value
|
||||
(list 'editable-field :keymap widget-keymap))
|
||||
|
||||
(let ((w (widget-create 'push-button
|
||||
:notify 'ada-prj-show-value
|
||||
"Show value")))
|
||||
(widget-insert "\n")
|
||||
(widget-put w 'prj-help help-text)
|
||||
(widget-put w 'prj-other-widget nil)
|
||||
w)
|
||||
)
|
||||
(widget-create 'editable-field
|
||||
:format "%v"
|
||||
:notify 'ada-prj-field-modified
|
||||
:help-echo help-text
|
||||
:keymap widget-keymap
|
||||
value)))
|
||||
(widget-put widget ':prj-field field)
|
||||
(if after-text
|
||||
(widget-insert after-text))
|
||||
(widget-insert "\n")
|
||||
))
|
||||
|
||||
|
||||
(provide 'ada-prj)
|
||||
|
||||
;;; ada-prj.el ends here
|
||||
@@ -0,0 +1,486 @@
|
||||
;;; ada-stmt.el --- an extension to Ada mode for inserting statement templates
|
||||
|
||||
;; Copyright (C) 1987, 1993-1994, 1996-2019 Free Software Foundation,
|
||||
;; Inc.
|
||||
|
||||
;; Authors: Daniel Pfeiffer
|
||||
;; Markus Heritsch
|
||||
;; Rolf Ebert <ebert@waporo.muc.de>
|
||||
;; Maintainer: Stephen Leake <stephen_leake@stephe-leake.org>
|
||||
;; Keywords: languages, ada
|
||||
;; Package: ada-mode
|
||||
|
||||
;; This file is part of GNU Emacs.
|
||||
|
||||
;; GNU Emacs is free software: you can redistribute it and/or modify
|
||||
;; it under the terms of the GNU General Public License as published by
|
||||
;; the Free Software Foundation, either version 3 of the License, or
|
||||
;; (at your option) any later version.
|
||||
|
||||
;; GNU Emacs is distributed in the hope that it will be useful,
|
||||
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
;; GNU General Public License for more details.
|
||||
|
||||
;; You should have received a copy of the GNU General Public License
|
||||
;; along with GNU Emacs. If not, see <https://www.gnu.org/licenses/>.
|
||||
|
||||
;;; Commentary:
|
||||
;; This file is now automatically loaded from ada-mode.el, and creates a submenu
|
||||
;; in Ada/ on the menu bar.
|
||||
|
||||
;;; History:
|
||||
|
||||
;; Created May 1987.
|
||||
;; Original version from V. Bowman as in ada.el of Emacs-18
|
||||
;; (borrowed heavily from Mick Jordan's Modula-2 package for GNU,
|
||||
;; as modified by Peter Robinson, Michael Schmidt, and Tom Perrine.)
|
||||
;;
|
||||
;; Sep 1993. Daniel Pfeiffer <pfeiffer@cict.fr> (DP)
|
||||
;; Introduced statement.el for smaller code and user configurability.
|
||||
;;
|
||||
;; Nov 1993. Rolf Ebert <ebert@enpc.fr> (RE) Moved the
|
||||
;; skeleton generation into this separate file. The code still is
|
||||
;; essentially written by DP
|
||||
;;
|
||||
;; Adapted Jun 1994. Markus Heritsch
|
||||
;; <Markus.Heritsch@studbox.uni-stuttgart.de> (MH)
|
||||
;; added menu bar support for templates
|
||||
;;
|
||||
;; 1994/12/02 Christian Egli <cegli@hcsd.hac.com>
|
||||
;; General cleanup and bug fixes.
|
||||
;;
|
||||
;; 1995/12/20 John Hutchison <hutchiso@epi.syr.ge.com>
|
||||
;; made it work with skeleton.el from Emacs-19.30. Several
|
||||
;; enhancements and bug fixes.
|
||||
|
||||
;; BUGS:
|
||||
;;;> I have the following suggestions for the function template: 1) I
|
||||
;;;> don't want it automatically assigning it a name for the return variable. I
|
||||
;;;> never want it to be called "Result" because that is nondescript. If you
|
||||
;;;> must define a variable, give me the ability to specify its name.
|
||||
;;;>
|
||||
;;;> 2) You do not provide a type for variable 'Result'. Its type is the same
|
||||
;;;> as the function's return type, which the template knows, so why force me
|
||||
;;;> to type it in?
|
||||
;;;>
|
||||
|
||||
;;;It would be nice if one could configure such layout details separately
|
||||
;;;without patching the LISP code. Maybe the metalanguage used in ada-stmt.el
|
||||
;;;could be taken even further, providing the user with some nice syntax
|
||||
;;;for describing layout. Then my own hacks would survive the next
|
||||
;;;update of the package :-)
|
||||
|
||||
|
||||
;;; Code:
|
||||
|
||||
(require 'skeleton nil t)
|
||||
(require 'easymenu)
|
||||
(require 'ada-mode)
|
||||
|
||||
(defun ada-func-or-proc-name ()
|
||||
"Return the name of the current function or procedure."
|
||||
(save-excursion
|
||||
(let ((case-fold-search t))
|
||||
(if (re-search-backward ada-procedure-start-regexp nil t)
|
||||
(match-string 5)
|
||||
"NAME?"))))
|
||||
|
||||
;;; ---- statement skeletons ------------------------------------------
|
||||
|
||||
(define-skeleton ada-array
|
||||
"Insert array type definition.
|
||||
Prompt for component type and index subtypes."
|
||||
()
|
||||
"array (" ("index definition: " str ", " ) -2 ") of " _ ?\;)
|
||||
|
||||
|
||||
(define-skeleton ada-case
|
||||
"Build skeleton case statement.
|
||||
Prompt for the selector expression. Also builds the first when clause."
|
||||
"[selector expression]: "
|
||||
"case " str " is" \n
|
||||
> "when " ("discrete choice: " str " | ") -3 " =>" \n
|
||||
> _ \n
|
||||
< < "end case;")
|
||||
|
||||
|
||||
(define-skeleton ada-when
|
||||
"Start a case statement alternative with a when clause."
|
||||
()
|
||||
< "when " ("discrete choice: " str " | ") -3 " =>" \n
|
||||
>)
|
||||
|
||||
|
||||
(define-skeleton ada-declare-block
|
||||
"Insert a block with a declare part.
|
||||
Indent for the first declaration."
|
||||
"[block name]: "
|
||||
< str & ?: & \n
|
||||
> "declare" \n
|
||||
> _ \n
|
||||
< "begin" \n
|
||||
> \n
|
||||
< "end " str | -1 ?\;)
|
||||
|
||||
|
||||
(define-skeleton ada-exception-block
|
||||
"Insert a block with an exception part.
|
||||
Indent for the first line of code."
|
||||
"[block name]: "
|
||||
< str & ?: & \n
|
||||
> "begin" \n
|
||||
> _ \n
|
||||
< "exception" \n
|
||||
> \n
|
||||
< "end " str | -1 ?\;)
|
||||
|
||||
|
||||
(define-skeleton ada-exception
|
||||
"Insert an indented exception part into a block."
|
||||
()
|
||||
< "exception" \n
|
||||
>)
|
||||
|
||||
|
||||
(define-skeleton ada-exit-1
|
||||
"Insert then exit condition of the exit statement, prompting for condition."
|
||||
"[exit condition]: "
|
||||
"when " str | -5)
|
||||
|
||||
|
||||
(define-skeleton ada-exit
|
||||
"Insert an exit statement, prompting for loop name and condition."
|
||||
"[name of loop to exit]: "
|
||||
"exit " str & ?\ (ada-exit-1) | -1 ?\;)
|
||||
|
||||
;;;###autoload
|
||||
(defun ada-header ()
|
||||
"Insert a descriptive header at the top of the file."
|
||||
(interactive "*")
|
||||
(save-excursion
|
||||
(goto-char (point-min))
|
||||
(if (fboundp 'make-header)
|
||||
(funcall (symbol-function 'make-header))
|
||||
(ada-header-tmpl))))
|
||||
|
||||
|
||||
(define-skeleton ada-header-tmpl
|
||||
"Insert a comment block containing the module title, author, etc."
|
||||
"[Description]: "
|
||||
"-- -*- Mode: Ada -*-"
|
||||
"\n" ada-fill-comment-prefix "Filename : " (buffer-name)
|
||||
"\n" ada-fill-comment-prefix "Description : " str
|
||||
"\n" ada-fill-comment-prefix "Author : " (user-full-name)
|
||||
"\n" ada-fill-comment-prefix "Created On : " (current-time-string)
|
||||
"\n" ada-fill-comment-prefix "Last Modified By: ."
|
||||
"\n" ada-fill-comment-prefix "Last Modified On: ."
|
||||
"\n" ada-fill-comment-prefix "Update Count : 0"
|
||||
"\n" ada-fill-comment-prefix "Status : Unknown, Use with caution!"
|
||||
"\n")
|
||||
|
||||
|
||||
(define-skeleton ada-display-comment
|
||||
"Inserts three comment lines, making a display comment."
|
||||
()
|
||||
"--\n" ada-fill-comment-prefix _ "\n--")
|
||||
|
||||
|
||||
(define-skeleton ada-if
|
||||
"Insert skeleton if statement, prompting for a boolean-expression."
|
||||
"[condition]: "
|
||||
"if " str " then" \n
|
||||
> _ \n
|
||||
< "end if;")
|
||||
|
||||
|
||||
(define-skeleton ada-elsif
|
||||
"Add an elsif clause to an if statement,
|
||||
prompting for the boolean-expression."
|
||||
"[condition]: "
|
||||
< "elsif " str " then" \n
|
||||
>)
|
||||
|
||||
|
||||
(define-skeleton ada-else
|
||||
"Add an else clause inside an if-then-end-if clause."
|
||||
()
|
||||
< "else" \n
|
||||
>)
|
||||
|
||||
|
||||
(define-skeleton ada-loop
|
||||
"Insert a skeleton loop statement. The exit statement is added by hand."
|
||||
"[loop name]: "
|
||||
< str & ?: & \n
|
||||
> "loop" \n
|
||||
> _ \n
|
||||
< "end loop " str | -1 ?\;)
|
||||
|
||||
|
||||
(define-skeleton ada-for-loop-prompt-variable
|
||||
"Prompt for the loop variable."
|
||||
"[loop variable]: "
|
||||
str)
|
||||
|
||||
|
||||
(define-skeleton ada-for-loop-prompt-range
|
||||
"Prompt for the loop range."
|
||||
"[loop range]: "
|
||||
str)
|
||||
|
||||
|
||||
(define-skeleton ada-for-loop
|
||||
"Build a skeleton for-loop statement, prompting for the loop parameters."
|
||||
"[loop name]: "
|
||||
< str & ?: & \n
|
||||
> "for "
|
||||
(ada-for-loop-prompt-variable)
|
||||
" in "
|
||||
(ada-for-loop-prompt-range)
|
||||
" loop" \n
|
||||
> _ \n
|
||||
< "end loop " str | -1 ?\;)
|
||||
|
||||
|
||||
(define-skeleton ada-while-loop-prompt-entry-condition
|
||||
"Prompt for the loop entry condition."
|
||||
"[entry condition]: "
|
||||
str)
|
||||
|
||||
|
||||
(define-skeleton ada-while-loop
|
||||
"Insert a skeleton while loop statement."
|
||||
"[loop name]: "
|
||||
< str & ?: & \n
|
||||
> "while "
|
||||
(ada-while-loop-prompt-entry-condition)
|
||||
" loop" \n
|
||||
> _ \n
|
||||
< "end loop " str | -1 ?\;)
|
||||
|
||||
|
||||
(define-skeleton ada-package-spec
|
||||
"Insert a skeleton package specification."
|
||||
"[package name]: "
|
||||
"package " str " is" \n
|
||||
> _ \n
|
||||
< "end " str ?\;)
|
||||
|
||||
|
||||
(define-skeleton ada-package-body
|
||||
"Insert a skeleton package body -- includes a begin statement."
|
||||
"[package name]: "
|
||||
"package body " str " is" \n
|
||||
> _ \n
|
||||
; < "begin" \n
|
||||
< "end " str ?\;)
|
||||
|
||||
|
||||
(define-skeleton ada-private
|
||||
"Undent and start a private section of a package spec. Reindent."
|
||||
()
|
||||
< "private" \n
|
||||
>)
|
||||
|
||||
|
||||
(define-skeleton ada-function-spec-prompt-return
|
||||
"Prompts for function result type."
|
||||
"[result type]: "
|
||||
str)
|
||||
|
||||
|
||||
(define-skeleton ada-function-spec
|
||||
"Insert a function specification. Prompts for name and arguments."
|
||||
"[function name]: "
|
||||
"function " str
|
||||
" (" ("[parameter_specification]: " str "; " ) -2 ")"
|
||||
" return "
|
||||
(ada-function-spec-prompt-return)
|
||||
";" \n )
|
||||
|
||||
|
||||
(define-skeleton ada-procedure-spec
|
||||
"Insert a procedure specification, prompting for its name and arguments."
|
||||
"[procedure name]: "
|
||||
"procedure " str
|
||||
" (" ("[parameter_specification]: " str "; " ) -2 ")"
|
||||
";" \n )
|
||||
|
||||
|
||||
(define-skeleton ada-subprogram-body
|
||||
"Insert frame for subprogram body.
|
||||
Invoke right after `ada-function-spec' or `ada-procedure-spec'."
|
||||
()
|
||||
;; Remove `;' from subprogram decl
|
||||
(save-excursion
|
||||
(let ((pos (1+ (point))))
|
||||
(ada-search-ignore-string-comment ada-subprog-start-re t nil)
|
||||
(when (ada-search-ignore-string-comment "(" nil pos t 'search-forward)
|
||||
(backward-char 1)
|
||||
(forward-sexp 1)))
|
||||
(if (looking-at ";")
|
||||
(delete-char 1)))
|
||||
" is" \n
|
||||
_ \n
|
||||
< "begin" \n
|
||||
\n
|
||||
< "exception" \n
|
||||
"when others => null;" \n
|
||||
< < "end "
|
||||
(ada-func-or-proc-name)
|
||||
";" \n)
|
||||
|
||||
|
||||
(define-skeleton ada-separate
|
||||
"Finish a body stub with `separate'."
|
||||
()
|
||||
> "separate;" \n
|
||||
<)
|
||||
|
||||
|
||||
;(define-skeleton ada-with
|
||||
; "Inserts a with clause, prompting for the list of units depended upon."
|
||||
; "[list of units depended upon]: "
|
||||
; "with " str ?\;)
|
||||
|
||||
;(define-skeleton ada-use
|
||||
; "Inserts a use clause, prompting for the list of packages used."
|
||||
; "[list of packages used]: "
|
||||
; "use " str ?\;)
|
||||
|
||||
|
||||
(define-skeleton ada-record
|
||||
"Insert a skeleton record type declaration."
|
||||
()
|
||||
"record" \n
|
||||
> _ \n
|
||||
< "end record;")
|
||||
|
||||
|
||||
(define-skeleton ada-subtype
|
||||
"Start insertion of a subtype declaration, prompting for the subtype name."
|
||||
"[subtype name]: "
|
||||
"subtype " str " is " _ ?\;
|
||||
(not (message "insert subtype indication.")))
|
||||
|
||||
|
||||
(define-skeleton ada-type
|
||||
"Start insertion of a type declaration, prompting for the type name."
|
||||
"[type name]: "
|
||||
"type " str ?\(
|
||||
("[discriminant specs]: " str " ")
|
||||
| (backward-delete-char 1) | ?\)
|
||||
" is "
|
||||
(not (message "insert type definition.")))
|
||||
|
||||
|
||||
(define-skeleton ada-task-body
|
||||
"Insert a task body, prompting for the task name."
|
||||
"[task name]: "
|
||||
"task body " str " is\n"
|
||||
"begin\n"
|
||||
> _ \n
|
||||
< "end " str ";" )
|
||||
|
||||
|
||||
(define-skeleton ada-task-spec
|
||||
"Insert a task specification, prompting for the task name."
|
||||
"[task name]: "
|
||||
"task " str
|
||||
" (" ("[discriminant]: " str "; ") ") is\n"
|
||||
> "entry " _ \n
|
||||
<"end " str ";" )
|
||||
|
||||
|
||||
(define-skeleton ada-get-param1
|
||||
"Prompt for arguments and if any enclose them in brackets."
|
||||
()
|
||||
("[parameter_specification]: " str "; " ) & -2 & ")")
|
||||
|
||||
|
||||
(define-skeleton ada-get-param
|
||||
"Prompt for arguments and if any enclose them in brackets."
|
||||
()
|
||||
" ("
|
||||
(ada-get-param1) | -2)
|
||||
|
||||
|
||||
(define-skeleton ada-entry
|
||||
"Insert a task entry, prompting for the entry name."
|
||||
"[entry name]: "
|
||||
"entry " str
|
||||
(ada-get-param)
|
||||
";" \n)
|
||||
|
||||
|
||||
(define-skeleton ada-entry-family-prompt-discriminant
|
||||
"Insert an entry specification, prompting for the entry name."
|
||||
"[discriminant name]: "
|
||||
str)
|
||||
|
||||
|
||||
(define-skeleton ada-entry-family
|
||||
"Insert an entry specification, prompting for the entry name."
|
||||
"[entry name]: "
|
||||
"entry " str
|
||||
" (" (ada-entry-family-prompt-discriminant) ")"
|
||||
(ada-get-param)
|
||||
";" \n)
|
||||
|
||||
|
||||
(define-skeleton ada-select
|
||||
"Insert a select block."
|
||||
()
|
||||
"select\n"
|
||||
> _ \n
|
||||
< "end select;")
|
||||
|
||||
|
||||
(define-skeleton ada-accept-1
|
||||
"Insert a condition statement, prompting for the condition name."
|
||||
"[condition]: "
|
||||
"when " str | -5 )
|
||||
|
||||
|
||||
(define-skeleton ada-accept-2
|
||||
"Insert an accept statement, prompting for the name and arguments."
|
||||
"[accept name]: "
|
||||
> "accept " str
|
||||
(ada-get-param)
|
||||
" do" \n
|
||||
> _ \n
|
||||
< "end " str ";" )
|
||||
|
||||
|
||||
(define-skeleton ada-accept
|
||||
"Insert an accept statement (prompt for condition, name and arguments)."
|
||||
()
|
||||
> (ada-accept-1) & " =>\n"
|
||||
(ada-accept-2))
|
||||
|
||||
|
||||
(define-skeleton ada-or-accept
|
||||
"Insert an accept alternative, prompting for the condition name."
|
||||
()
|
||||
< "or\n"
|
||||
(ada-accept))
|
||||
|
||||
|
||||
(define-skeleton ada-or-delay
|
||||
"Insert a delay alternative, prompting for the delay value."
|
||||
"[delay value]: "
|
||||
< "or\n"
|
||||
> "delay " str ";")
|
||||
|
||||
|
||||
(define-skeleton ada-or-terminate
|
||||
"Insert a terminate alternative."
|
||||
()
|
||||
< "or\n"
|
||||
> "terminate;")
|
||||
|
||||
|
||||
(provide 'ada-stmt)
|
||||
|
||||
;;; ada-stmt.el ends here
|
||||
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
Binary file not shown.
File diff suppressed because it is too large
Load Diff
Executable
+3
@@ -0,0 +1,3 @@
|
||||
#! /usr/bin/env bash
|
||||
texi2any -o ada-mode.info --no-split ada-mode.texi
|
||||
texi2any --html -o ada-mode.html --no-split ada-mode.texi
|
||||
Executable
+2
@@ -0,0 +1,2 @@
|
||||
#! /bin/sh
|
||||
rm ada-mode.aux ada-mode.fn ada-mode.log ada-mode.toc
|
||||
@@ -0,0 +1,505 @@
|
||||
@c The GNU Free Documentation License.
|
||||
@center Version 1.3, 3 November 2008
|
||||
|
||||
@c This file is intended to be included within another document,
|
||||
@c hence no sectioning command or @node.
|
||||
|
||||
@display
|
||||
Copyright @copyright{} 2000, 2001, 2002, 2007, 2008 Free Software Foundation, Inc.
|
||||
@uref{https://fsf.org/}
|
||||
|
||||
Everyone is permitted to copy and distribute verbatim copies
|
||||
of this license document, but changing it is not allowed.
|
||||
@end display
|
||||
|
||||
@enumerate 0
|
||||
@item
|
||||
PREAMBLE
|
||||
|
||||
The purpose of this License is to make a manual, textbook, or other
|
||||
functional and useful document @dfn{free} in the sense of freedom: to
|
||||
assure everyone the effective freedom to copy and redistribute it,
|
||||
with or without modifying it, either commercially or noncommercially.
|
||||
Secondarily, this License preserves for the author and publisher a way
|
||||
to get credit for their work, while not being considered responsible
|
||||
for modifications made by others.
|
||||
|
||||
This License is a kind of ``copyleft'', which means that derivative
|
||||
works of the document must themselves be free in the same sense. It
|
||||
complements the GNU General Public License, which is a copyleft
|
||||
license designed for free software.
|
||||
|
||||
We have designed this License in order to use it for manuals for free
|
||||
software, because free software needs free documentation: a free
|
||||
program should come with manuals providing the same freedoms that the
|
||||
software does. But this License is not limited to software manuals;
|
||||
it can be used for any textual work, regardless of subject matter or
|
||||
whether it is published as a printed book. We recommend this License
|
||||
principally for works whose purpose is instruction or reference.
|
||||
|
||||
@item
|
||||
APPLICABILITY AND DEFINITIONS
|
||||
|
||||
This License applies to any manual or other work, in any medium, that
|
||||
contains a notice placed by the copyright holder saying it can be
|
||||
distributed under the terms of this License. Such a notice grants a
|
||||
world-wide, royalty-free license, unlimited in duration, to use that
|
||||
work under the conditions stated herein. The ``Document'', below,
|
||||
refers to any such manual or work. Any member of the public is a
|
||||
licensee, and is addressed as ``you''. You accept the license if you
|
||||
copy, modify or distribute the work in a way requiring permission
|
||||
under copyright law.
|
||||
|
||||
A ``Modified Version'' of the Document means any work containing the
|
||||
Document or a portion of it, either copied verbatim, or with
|
||||
modifications and/or translated into another language.
|
||||
|
||||
A ``Secondary Section'' is a named appendix or a front-matter section
|
||||
of the Document that deals exclusively with the relationship of the
|
||||
publishers or authors of the Document to the Document's overall
|
||||
subject (or to related matters) and contains nothing that could fall
|
||||
directly within that overall subject. (Thus, if the Document is in
|
||||
part a textbook of mathematics, a Secondary Section may not explain
|
||||
any mathematics.) The relationship could be a matter of historical
|
||||
connection with the subject or with related matters, or of legal,
|
||||
commercial, philosophical, ethical or political position regarding
|
||||
them.
|
||||
|
||||
The ``Invariant Sections'' are certain Secondary Sections whose titles
|
||||
are designated, as being those of Invariant Sections, in the notice
|
||||
that says that the Document is released under this License. If a
|
||||
section does not fit the above definition of Secondary then it is not
|
||||
allowed to be designated as Invariant. The Document may contain zero
|
||||
Invariant Sections. If the Document does not identify any Invariant
|
||||
Sections then there are none.
|
||||
|
||||
The ``Cover Texts'' are certain short passages of text that are listed,
|
||||
as Front-Cover Texts or Back-Cover Texts, in the notice that says that
|
||||
the Document is released under this License. A Front-Cover Text may
|
||||
be at most 5 words, and a Back-Cover Text may be at most 25 words.
|
||||
|
||||
A ``Transparent'' copy of the Document means a machine-readable copy,
|
||||
represented in a format whose specification is available to the
|
||||
general public, that is suitable for revising the document
|
||||
straightforwardly with generic text editors or (for images composed of
|
||||
pixels) generic paint programs or (for drawings) some widely available
|
||||
drawing editor, and that is suitable for input to text formatters or
|
||||
for automatic translation to a variety of formats suitable for input
|
||||
to text formatters. A copy made in an otherwise Transparent file
|
||||
format whose markup, or absence of markup, has been arranged to thwart
|
||||
or discourage subsequent modification by readers is not Transparent.
|
||||
An image format is not Transparent if used for any substantial amount
|
||||
of text. A copy that is not ``Transparent'' is called ``Opaque''.
|
||||
|
||||
Examples of suitable formats for Transparent copies include plain
|
||||
ASCII without markup, Texinfo input format, La@TeX{} input
|
||||
format, SGML or XML using a publicly available
|
||||
DTD, and standard-conforming simple HTML,
|
||||
PostScript or PDF designed for human modification. Examples
|
||||
of transparent image formats include PNG, XCF and
|
||||
JPG@. Opaque formats include proprietary formats that can be
|
||||
read and edited only by proprietary word processors, SGML or
|
||||
XML for which the DTD and/or processing tools are
|
||||
not generally available, and the machine-generated HTML,
|
||||
PostScript or PDF produced by some word processors for
|
||||
output purposes only.
|
||||
|
||||
The ``Title Page'' means, for a printed book, the title page itself,
|
||||
plus such following pages as are needed to hold, legibly, the material
|
||||
this License requires to appear in the title page. For works in
|
||||
formats which do not have any title page as such, ``Title Page'' means
|
||||
the text near the most prominent appearance of the work's title,
|
||||
preceding the beginning of the body of the text.
|
||||
|
||||
The ``publisher'' means any person or entity that distributes copies
|
||||
of the Document to the public.
|
||||
|
||||
A section ``Entitled XYZ'' means a named subunit of the Document whose
|
||||
title either is precisely XYZ or contains XYZ in parentheses following
|
||||
text that translates XYZ in another language. (Here XYZ stands for a
|
||||
specific section name mentioned below, such as ``Acknowledgements'',
|
||||
``Dedications'', ``Endorsements'', or ``History''.) To ``Preserve the Title''
|
||||
of such a section when you modify the Document means that it remains a
|
||||
section ``Entitled XYZ'' according to this definition.
|
||||
|
||||
The Document may include Warranty Disclaimers next to the notice which
|
||||
states that this License applies to the Document. These Warranty
|
||||
Disclaimers are considered to be included by reference in this
|
||||
License, but only as regards disclaiming warranties: any other
|
||||
implication that these Warranty Disclaimers may have is void and has
|
||||
no effect on the meaning of this License.
|
||||
|
||||
@item
|
||||
VERBATIM COPYING
|
||||
|
||||
You may copy and distribute the Document in any medium, either
|
||||
commercially or noncommercially, provided that this License, the
|
||||
copyright notices, and the license notice saying this License applies
|
||||
to the Document are reproduced in all copies, and that you add no other
|
||||
conditions whatsoever to those of this License. You may not use
|
||||
technical measures to obstruct or control the reading or further
|
||||
copying of the copies you make or distribute. However, you may accept
|
||||
compensation in exchange for copies. If you distribute a large enough
|
||||
number of copies you must also follow the conditions in section 3.
|
||||
|
||||
You may also lend copies, under the same conditions stated above, and
|
||||
you may publicly display copies.
|
||||
|
||||
@item
|
||||
COPYING IN QUANTITY
|
||||
|
||||
If you publish printed copies (or copies in media that commonly have
|
||||
printed covers) of the Document, numbering more than 100, and the
|
||||
Document's license notice requires Cover Texts, you must enclose the
|
||||
copies in covers that carry, clearly and legibly, all these Cover
|
||||
Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on
|
||||
the back cover. Both covers must also clearly and legibly identify
|
||||
you as the publisher of these copies. The front cover must present
|
||||
the full title with all words of the title equally prominent and
|
||||
visible. You may add other material on the covers in addition.
|
||||
Copying with changes limited to the covers, as long as they preserve
|
||||
the title of the Document and satisfy these conditions, can be treated
|
||||
as verbatim copying in other respects.
|
||||
|
||||
If the required texts for either cover are too voluminous to fit
|
||||
legibly, you should put the first ones listed (as many as fit
|
||||
reasonably) on the actual cover, and continue the rest onto adjacent
|
||||
pages.
|
||||
|
||||
If you publish or distribute Opaque copies of the Document numbering
|
||||
more than 100, you must either include a machine-readable Transparent
|
||||
copy along with each Opaque copy, or state in or with each Opaque copy
|
||||
a computer-network location from which the general network-using
|
||||
public has access to download using public-standard network protocols
|
||||
a complete Transparent copy of the Document, free of added material.
|
||||
If you use the latter option, you must take reasonably prudent steps,
|
||||
when you begin distribution of Opaque copies in quantity, to ensure
|
||||
that this Transparent copy will remain thus accessible at the stated
|
||||
location until at least one year after the last time you distribute an
|
||||
Opaque copy (directly or through your agents or retailers) of that
|
||||
edition to the public.
|
||||
|
||||
It is requested, but not required, that you contact the authors of the
|
||||
Document well before redistributing any large number of copies, to give
|
||||
them a chance to provide you with an updated version of the Document.
|
||||
|
||||
@item
|
||||
MODIFICATIONS
|
||||
|
||||
You may copy and distribute a Modified Version of the Document under
|
||||
the conditions of sections 2 and 3 above, provided that you release
|
||||
the Modified Version under precisely this License, with the Modified
|
||||
Version filling the role of the Document, thus licensing distribution
|
||||
and modification of the Modified Version to whoever possesses a copy
|
||||
of it. In addition, you must do these things in the Modified Version:
|
||||
|
||||
@enumerate A
|
||||
@item
|
||||
Use in the Title Page (and on the covers, if any) a title distinct
|
||||
from that of the Document, and from those of previous versions
|
||||
(which should, if there were any, be listed in the History section
|
||||
of the Document). You may use the same title as a previous version
|
||||
if the original publisher of that version gives permission.
|
||||
|
||||
@item
|
||||
List on the Title Page, as authors, one or more persons or entities
|
||||
responsible for authorship of the modifications in the Modified
|
||||
Version, together with at least five of the principal authors of the
|
||||
Document (all of its principal authors, if it has fewer than five),
|
||||
unless they release you from this requirement.
|
||||
|
||||
@item
|
||||
State on the Title page the name of the publisher of the
|
||||
Modified Version, as the publisher.
|
||||
|
||||
@item
|
||||
Preserve all the copyright notices of the Document.
|
||||
|
||||
@item
|
||||
Add an appropriate copyright notice for your modifications
|
||||
adjacent to the other copyright notices.
|
||||
|
||||
@item
|
||||
Include, immediately after the copyright notices, a license notice
|
||||
giving the public permission to use the Modified Version under the
|
||||
terms of this License, in the form shown in the Addendum below.
|
||||
|
||||
@item
|
||||
Preserve in that license notice the full lists of Invariant Sections
|
||||
and required Cover Texts given in the Document's license notice.
|
||||
|
||||
@item
|
||||
Include an unaltered copy of this License.
|
||||
|
||||
@item
|
||||
Preserve the section Entitled ``History'', Preserve its Title, and add
|
||||
to it an item stating at least the title, year, new authors, and
|
||||
publisher of the Modified Version as given on the Title Page. If
|
||||
there is no section Entitled ``History'' in the Document, create one
|
||||
stating the title, year, authors, and publisher of the Document as
|
||||
given on its Title Page, then add an item describing the Modified
|
||||
Version as stated in the previous sentence.
|
||||
|
||||
@item
|
||||
Preserve the network location, if any, given in the Document for
|
||||
public access to a Transparent copy of the Document, and likewise
|
||||
the network locations given in the Document for previous versions
|
||||
it was based on. These may be placed in the ``History'' section.
|
||||
You may omit a network location for a work that was published at
|
||||
least four years before the Document itself, or if the original
|
||||
publisher of the version it refers to gives permission.
|
||||
|
||||
@item
|
||||
For any section Entitled ``Acknowledgements'' or ``Dedications'', Preserve
|
||||
the Title of the section, and preserve in the section all the
|
||||
substance and tone of each of the contributor acknowledgements and/or
|
||||
dedications given therein.
|
||||
|
||||
@item
|
||||
Preserve all the Invariant Sections of the Document,
|
||||
unaltered in their text and in their titles. Section numbers
|
||||
or the equivalent are not considered part of the section titles.
|
||||
|
||||
@item
|
||||
Delete any section Entitled ``Endorsements''. Such a section
|
||||
may not be included in the Modified Version.
|
||||
|
||||
@item
|
||||
Do not retitle any existing section to be Entitled ``Endorsements'' or
|
||||
to conflict in title with any Invariant Section.
|
||||
|
||||
@item
|
||||
Preserve any Warranty Disclaimers.
|
||||
@end enumerate
|
||||
|
||||
If the Modified Version includes new front-matter sections or
|
||||
appendices that qualify as Secondary Sections and contain no material
|
||||
copied from the Document, you may at your option designate some or all
|
||||
of these sections as invariant. To do this, add their titles to the
|
||||
list of Invariant Sections in the Modified Version's license notice.
|
||||
These titles must be distinct from any other section titles.
|
||||
|
||||
You may add a section Entitled ``Endorsements'', provided it contains
|
||||
nothing but endorsements of your Modified Version by various
|
||||
parties---for example, statements of peer review or that the text has
|
||||
been approved by an organization as the authoritative definition of a
|
||||
standard.
|
||||
|
||||
You may add a passage of up to five words as a Front-Cover Text, and a
|
||||
passage of up to 25 words as a Back-Cover Text, to the end of the list
|
||||
of Cover Texts in the Modified Version. Only one passage of
|
||||
Front-Cover Text and one of Back-Cover Text may be added by (or
|
||||
through arrangements made by) any one entity. If the Document already
|
||||
includes a cover text for the same cover, previously added by you or
|
||||
by arrangement made by the same entity you are acting on behalf of,
|
||||
you may not add another; but you may replace the old one, on explicit
|
||||
permission from the previous publisher that added the old one.
|
||||
|
||||
The author(s) and publisher(s) of the Document do not by this License
|
||||
give permission to use their names for publicity for or to assert or
|
||||
imply endorsement of any Modified Version.
|
||||
|
||||
@item
|
||||
COMBINING DOCUMENTS
|
||||
|
||||
You may combine the Document with other documents released under this
|
||||
License, under the terms defined in section 4 above for modified
|
||||
versions, provided that you include in the combination all of the
|
||||
Invariant Sections of all of the original documents, unmodified, and
|
||||
list them all as Invariant Sections of your combined work in its
|
||||
license notice, and that you preserve all their Warranty Disclaimers.
|
||||
|
||||
The combined work need only contain one copy of this License, and
|
||||
multiple identical Invariant Sections may be replaced with a single
|
||||
copy. If there are multiple Invariant Sections with the same name but
|
||||
different contents, make the title of each such section unique by
|
||||
adding at the end of it, in parentheses, the name of the original
|
||||
author or publisher of that section if known, or else a unique number.
|
||||
Make the same adjustment to the section titles in the list of
|
||||
Invariant Sections in the license notice of the combined work.
|
||||
|
||||
In the combination, you must combine any sections Entitled ``History''
|
||||
in the various original documents, forming one section Entitled
|
||||
``History''; likewise combine any sections Entitled ``Acknowledgements'',
|
||||
and any sections Entitled ``Dedications''. You must delete all
|
||||
sections Entitled ``Endorsements.''
|
||||
|
||||
@item
|
||||
COLLECTIONS OF DOCUMENTS
|
||||
|
||||
You may make a collection consisting of the Document and other documents
|
||||
released under this License, and replace the individual copies of this
|
||||
License in the various documents with a single copy that is included in
|
||||
the collection, provided that you follow the rules of this License for
|
||||
verbatim copying of each of the documents in all other respects.
|
||||
|
||||
You may extract a single document from such a collection, and distribute
|
||||
it individually under this License, provided you insert a copy of this
|
||||
License into the extracted document, and follow this License in all
|
||||
other respects regarding verbatim copying of that document.
|
||||
|
||||
@item
|
||||
AGGREGATION WITH INDEPENDENT WORKS
|
||||
|
||||
A compilation of the Document or its derivatives with other separate
|
||||
and independent documents or works, in or on a volume of a storage or
|
||||
distribution medium, is called an ``aggregate'' if the copyright
|
||||
resulting from the compilation is not used to limit the legal rights
|
||||
of the compilation's users beyond what the individual works permit.
|
||||
When the Document is included in an aggregate, this License does not
|
||||
apply to the other works in the aggregate which are not themselves
|
||||
derivative works of the Document.
|
||||
|
||||
If the Cover Text requirement of section 3 is applicable to these
|
||||
copies of the Document, then if the Document is less than one half of
|
||||
the entire aggregate, the Document's Cover Texts may be placed on
|
||||
covers that bracket the Document within the aggregate, or the
|
||||
electronic equivalent of covers if the Document is in electronic form.
|
||||
Otherwise they must appear on printed covers that bracket the whole
|
||||
aggregate.
|
||||
|
||||
@item
|
||||
TRANSLATION
|
||||
|
||||
Translation is considered a kind of modification, so you may
|
||||
distribute translations of the Document under the terms of section 4.
|
||||
Replacing Invariant Sections with translations requires special
|
||||
permission from their copyright holders, but you may include
|
||||
translations of some or all Invariant Sections in addition to the
|
||||
original versions of these Invariant Sections. You may include a
|
||||
translation of this License, and all the license notices in the
|
||||
Document, and any Warranty Disclaimers, provided that you also include
|
||||
the original English version of this License and the original versions
|
||||
of those notices and disclaimers. In case of a disagreement between
|
||||
the translation and the original version of this License or a notice
|
||||
or disclaimer, the original version will prevail.
|
||||
|
||||
If a section in the Document is Entitled ``Acknowledgements'',
|
||||
``Dedications'', or ``History'', the requirement (section 4) to Preserve
|
||||
its Title (section 1) will typically require changing the actual
|
||||
title.
|
||||
|
||||
@item
|
||||
TERMINATION
|
||||
|
||||
You may not copy, modify, sublicense, or distribute the Document
|
||||
except as expressly provided under this License. Any attempt
|
||||
otherwise to copy, modify, sublicense, or distribute it is void, and
|
||||
will automatically terminate your rights under this License.
|
||||
|
||||
However, if you cease all violation of this License, then your license
|
||||
from a particular copyright holder is reinstated (a) provisionally,
|
||||
unless and until the copyright holder explicitly and finally
|
||||
terminates your license, and (b) permanently, if the copyright holder
|
||||
fails to notify you of the violation by some reasonable means prior to
|
||||
60 days after the cessation.
|
||||
|
||||
Moreover, your license from a particular copyright holder is
|
||||
reinstated permanently if the copyright holder notifies you of the
|
||||
violation by some reasonable means, this is the first time you have
|
||||
received notice of violation of this License (for any work) from that
|
||||
copyright holder, and you cure the violation prior to 30 days after
|
||||
your receipt of the notice.
|
||||
|
||||
Termination of your rights under this section does not terminate the
|
||||
licenses of parties who have received copies or rights from you under
|
||||
this License. If your rights have been terminated and not permanently
|
||||
reinstated, receipt of a copy of some or all of the same material does
|
||||
not give you any rights to use it.
|
||||
|
||||
@item
|
||||
FUTURE REVISIONS OF THIS LICENSE
|
||||
|
||||
The Free Software Foundation may publish new, revised versions
|
||||
of the GNU Free Documentation License from time to time. Such new
|
||||
versions will be similar in spirit to the present version, but may
|
||||
differ in detail to address new problems or concerns. See
|
||||
@uref{https://www.gnu.org/licenses/}.
|
||||
|
||||
Each version of the License is given a distinguishing version number.
|
||||
If the Document specifies that a particular numbered version of this
|
||||
License ``or any later version'' applies to it, you have the option of
|
||||
following the terms and conditions either of that specified version or
|
||||
of any later version that has been published (not as a draft) by the
|
||||
Free Software Foundation. If the Document does not specify a version
|
||||
number of this License, you may choose any version ever published (not
|
||||
as a draft) by the Free Software Foundation. If the Document
|
||||
specifies that a proxy can decide which future versions of this
|
||||
License can be used, that proxy's public statement of acceptance of a
|
||||
version permanently authorizes you to choose that version for the
|
||||
Document.
|
||||
|
||||
@item
|
||||
RELICENSING
|
||||
|
||||
``Massive Multiauthor Collaboration Site'' (or ``MMC Site'') means any
|
||||
World Wide Web server that publishes copyrightable works and also
|
||||
provides prominent facilities for anybody to edit those works. A
|
||||
public wiki that anybody can edit is an example of such a server. A
|
||||
``Massive Multiauthor Collaboration'' (or ``MMC'') contained in the
|
||||
site means any set of copyrightable works thus published on the MMC
|
||||
site.
|
||||
|
||||
``CC-BY-SA'' means the Creative Commons Attribution-Share Alike 3.0
|
||||
license published by Creative Commons Corporation, a not-for-profit
|
||||
corporation with a principal place of business in San Francisco,
|
||||
California, as well as future copyleft versions of that license
|
||||
published by that same organization.
|
||||
|
||||
``Incorporate'' means to publish or republish a Document, in whole or
|
||||
in part, as part of another Document.
|
||||
|
||||
An MMC is ``eligible for relicensing'' if it is licensed under this
|
||||
License, and if all works that were first published under this License
|
||||
somewhere other than this MMC, and subsequently incorporated in whole
|
||||
or in part into the MMC, (1) had no cover texts or invariant sections,
|
||||
and (2) were thus incorporated prior to November 1, 2008.
|
||||
|
||||
The operator of an MMC Site may republish an MMC contained in the site
|
||||
under CC-BY-SA on the same site at any time before August 1, 2009,
|
||||
provided the MMC is eligible for relicensing.
|
||||
|
||||
@end enumerate
|
||||
|
||||
@page
|
||||
@heading ADDENDUM: How to use this License for your documents
|
||||
|
||||
To use this License in a document you have written, include a copy of
|
||||
the License in the document and put the following copyright and
|
||||
license notices just after the title page:
|
||||
|
||||
@smallexample
|
||||
@group
|
||||
Copyright (C) @var{year} @var{your name}.
|
||||
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, no Front-Cover Texts, and no Back-Cover
|
||||
Texts. A copy of the license is included in the section entitled ``GNU
|
||||
Free Documentation License''.
|
||||
@end group
|
||||
@end smallexample
|
||||
|
||||
If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts,
|
||||
replace the ``with@dots{}Texts.''@: line with this:
|
||||
|
||||
@smallexample
|
||||
@group
|
||||
with the Invariant Sections being @var{list their titles}, with
|
||||
the Front-Cover Texts being @var{list}, and with the Back-Cover Texts
|
||||
being @var{list}.
|
||||
@end group
|
||||
@end smallexample
|
||||
|
||||
If you have Invariant Sections without Cover Texts, or some other
|
||||
combination of the three, merge those two alternatives to suit the
|
||||
situation.
|
||||
|
||||
If your document contains nontrivial examples of program code, we
|
||||
recommend releasing these examples in parallel under your choice of
|
||||
free software license, such as the GNU General Public License,
|
||||
to permit their use in free software.
|
||||
|
||||
@c Local Variables:
|
||||
@c ispell-local-pdict: "ispell-dict"
|
||||
@c End:
|
||||
@@ -0,0 +1,19 @@
|
||||
@c Emacs documentation style settings
|
||||
@documentencoding UTF-8
|
||||
@c These two require Texinfo 5.0 or later, so we use the older
|
||||
@c equivalent @set variables supported in 4.11 and hence
|
||||
@ignore
|
||||
@codequotebacktick on
|
||||
@codequoteundirected on
|
||||
@end ignore
|
||||
@set txicodequoteundirected
|
||||
@set txicodequotebacktick
|
||||
@iftex
|
||||
@c It turns out TeX sometimes fails to hyphenate, so we help it here
|
||||
@hyphenation{au-to-mat-i-cal-ly}
|
||||
@hyphenation{spec-i-fied}
|
||||
@hyphenation{work-a-round}
|
||||
@hyphenation{work-a-rounds}
|
||||
@hyphenation{un-marked}
|
||||
@hyphenation{dic-tion-ary}
|
||||
@end iftex
|
||||
Reference in New Issue
Block a user