version.el 6.43 KB
Newer Older
1
;;; version.el --- record version number of Emacs
Dave Love's avatar
#  
Dave Love committed
2

Paul Eggert's avatar
Paul Eggert committed
3
;; Copyright (C) 1985, 1992, 1994-1995, 1999-2019 Free Software
4
;; Foundation, Inc.
Dave Love's avatar
#  
Dave Love committed
5 6

;; Keywords: internal
7
;; Package: emacs
Dave Love's avatar
#  
Dave Love committed
8 9 10

;; This file is part of GNU Emacs.

11
;; GNU Emacs is free software: you can redistribute it and/or modify
Dave Love's avatar
#  
Dave Love committed
12
;; it under the terms of the GNU General Public License as published by
13 14
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
Dave Love's avatar
#  
Dave Love committed
15 16 17 18 19 20 21

;; 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
22
;; along with GNU Emacs.  If not, see <https://www.gnu.org/licenses/>.
Dave Love's avatar
#  
Dave Love committed
23

24 25
;;; Commentary:

Dave Love's avatar
#  
Dave Love committed
26 27
;;; Code:

28 29 30 31
(defconst emacs-major-version
  (progn (string-match "^[0-9]+" emacs-version)
         (string-to-number (match-string 0 emacs-version)))
  "Major version number of this version of Emacs.
Dave Love's avatar
#  
Dave Love committed
32 33
This variable first existed in version 19.23.")

34 35 36 37
(defconst emacs-minor-version
  (progn (string-match "^[0-9]+\\.\\([0-9]+\\)" emacs-version)
         (string-to-number (match-string 1 emacs-version)))
  "Minor version number of this version of Emacs.
Dave Love's avatar
#  
Dave Love committed
38 39
This variable first existed in version 19.23.")

Paul Eggert's avatar
Paul Eggert committed
40 41
(defconst emacs-build-system (system-name)
  "Name of the system on which Emacs was built, or nil if not available.")
Dave Love's avatar
#  
Dave Love committed
42

Paul Eggert's avatar
Paul Eggert committed
43 44
(defconst emacs-build-time (if emacs-build-system (current-time))
  "Time at which Emacs was dumped out, or nil if not available.")
Dave Love's avatar
#  
Dave Love committed
45

46 47 48 49 50 51
(defconst emacs-build-number 1          ; loadup.el may increment this
  "The build number of this version of Emacs.
This is an integer that increments each time Emacs is built in a given
directory (without cleaning).  This is likely to only be relevant when
developing Emacs.")

52 53 54
(defvar motif-version-string)
(defvar gtk-version-string)
(defvar ns-version-string)
55
(defvar cairo-version-string)
56

57 58
(defun emacs-version (&optional here)
  "Return string describing the version of Emacs that is running.
Dave Love's avatar
#  
Dave Love committed
59 60 61 62
If optional argument HERE is non-nil, insert string at point.
Don't use this function in programs to choose actions according
to the system configuration; look at `system-configuration' instead."
  (interactive "P")
63
  (let ((version-string
64
         (format "GNU Emacs %s (build %s, %s%s%s%s)%s"
Dave Love's avatar
#  
Dave Love committed
65
                 emacs-version
66
                 emacs-build-number
Dave Love's avatar
#  
Dave Love committed
67
		 system-configuration
68
		 (cond ((featurep 'motif)
69
			(concat ", " (substring motif-version-string 4)))
70 71
		       ((featurep 'gtk)
			(concat ", GTK+ Version " gtk-version-string))
72
		       ((featurep 'x-toolkit) ", X toolkit")
Dan Nicolaescu's avatar
Dan Nicolaescu committed
73
		       ((featurep 'ns)
74
			(format ", NS %s" ns-version-string))
Dave Love's avatar
#  
Dave Love committed
75
		       (t ""))
Jan D's avatar
Jan D committed
76 77 78
		 (if (featurep 'cairo)
		     (format ", cairo version %s" cairo-version-string)
		   "")
79 80 81 82 83
		 (if (and (boundp 'x-toolkit-scroll-bars)
			  (memq x-toolkit-scroll-bars '(xaw xaw3d)))
		     (format ", %s scroll bars"
			     (capitalize (symbol-name x-toolkit-scroll-bars)))
		   "")
Paul Eggert's avatar
Paul Eggert committed
84 85 86 87 88 89 90 91
		 (if emacs-build-time
		     (format-time-string (concat
					  (if (called-interactively-p
					       'interactive)
					      "" "\n")
					  " of %Y-%m-%d")
					 emacs-build-time)
		   ""))))
92
    (if here
Dave Love's avatar
#  
Dave Love committed
93
        (insert version-string)
94
      (if (called-interactively-p 'interactive)
Dave Love's avatar
#  
Dave Love committed
95 96 97
          (message "%s" version-string)
        version-string))))

Stefan Monnier's avatar
Stefan Monnier committed
98
;; We hope that this alias is easier for people to find.
Dave Love's avatar
#  
Dave Love committed
99 100
(defalias 'version 'emacs-version)

Glenn Morris's avatar
Glenn Morris committed
101 102 103
(define-obsolete-variable-alias 'emacs-bzr-version
                                'emacs-repository-version "24.4")

Glenn Morris's avatar
Glenn Morris committed
104
;; Set during dumping, this is a defvar so that it can be setq'd.
105
(defvar emacs-repository-version nil
106 107 108 109
  "String giving the repository revision from which this Emacs was built.
Value is nil if Emacs was not built from a repository checkout,
or if we could not determine the revision.")

110
(define-obsolete-function-alias 'emacs-bzr-get-version
111
                                'emacs-repository-get-version "24.4")
112

113 114 115 116 117 118
(defun emacs-repository-version-git (dir)
  "Ask git itself for the version information for directory DIR."
  (message "Waiting for git...")
  (with-temp-buffer
    (let ((default-directory (file-name-as-directory dir)))
      (and (eq 0
119
	       (with-demoted-errors "Error running git rev-parse: %S"
120
		 (call-process "git" nil '(t nil) nil "rev-parse" "HEAD")))
121 122 123
	   (progn (goto-char (point-min))
		  (looking-at "[0-9a-fA-F]\\{40\\}"))
	   (match-string 0)))))
124 125

(defun emacs-repository-get-version (&optional dir external)
126 127 128 129 130 131 132
  "Try to return as a string the repository revision of the Emacs sources.
The format of the returned string is dependent on the VCS in use.
Value is nil if the sources do not seem to be under version
control, or if we could not determine the revision.  Note that
this reports on the current state of the sources, which may not
correspond to the running Emacs.

133
Optional argument DIR is a directory to use instead of `source-directory'.
134 135
Optional argument EXTERNAL is ignored."
  (emacs-repository-version-git (or dir source-directory)))
Glenn Morris's avatar
Glenn Morris committed
136

137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164
(defvar emacs-repository-branch nil
  "String giving the repository branch from which this Emacs was built.
Value is nil if Emacs was not built from a repository checkout,
or if we could not determine the branch.")

(defun emacs-repository-branch-git (dir)
  "Ask git itself for the branch information for directory DIR."
  (message "Waiting for git...")
  (with-temp-buffer
    (let ((default-directory (file-name-as-directory dir)))
      (and (zerop
	    (with-demoted-errors "Error running git rev-parse --abbrev-ref: %S"
	      (call-process "git" nil '(t nil) nil
                            "rev-parse" "--abbrev-ref" "HEAD")))
           (goto-char (point-min))
           (buffer-substring (point) (line-end-position))))))

(defun emacs-repository-get-branch (&optional dir)
  "Try to return as a string the repository branch of the Emacs sources.
The format of the returned string is dependent on the VCS in use.
Value is nil if the sources do not seem to be under version
control, or if we could not determine the branch.  Note that
this reports on the current state of the sources, which may not
correspond to the running Emacs.

Optional argument DIR is a directory to use instead of `source-directory'."
  (emacs-repository-branch-git (or dir source-directory)))

Richard M. Stallman's avatar
Richard M. Stallman committed
165
;; We put version info into the executable in the form that `ident' uses.
166 167
(purecopy (concat "\n$Id: " (subst-char-in-string ?\n ?\s (emacs-version))
		  " $\n"))
Dave Love's avatar
#  
Dave Love committed
168 169

;;; version.el ends here