version.el 5.96 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-2015 Free Software
4
;; Foundation, Inc.
Dave Love's avatar
#  
Dave Love committed
5

6
;; Maintainer: emacs-devel@gnu.org
Dave Love's avatar
#  
Dave Love committed
7
;; Keywords: internal
8
;; Package: emacs
Dave Love's avatar
#  
Dave Love committed
9 10 11

;; This file is part of GNU Emacs.

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

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

25 26
;;; Commentary:

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

29 30 31 32
(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
33 34
This variable first existed in version 19.23.")

35 36 37 38
(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
39 40
This variable first existed in version 19.23.")

41 42
(defconst emacs-build-time (current-time)
  "Time at which Emacs was dumped out.")
Dave Love's avatar
#  
Dave Love committed
43

44 45
;; I think this should be obsoleted/removed.  It's just one more meaningless
;; difference between different builds.  It's usually not even an fqdn.
46 47
(defconst emacs-build-system (system-name)
  "Name of the system on which Emacs was built.")
Dave Love's avatar
#  
Dave Love committed
48

49 50 51
(defvar motif-version-string)
(defvar gtk-version-string)
(defvar ns-version-string)
52
(defvar cairo-version-string)
53

54 55
(defun emacs-version (&optional here)
  "Return string describing the version of Emacs that is running.
Dave Love's avatar
#  
Dave Love committed
56 57 58 59
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")
60
  (let ((version-string
61
         (format (if (not (called-interactively-p 'interactive))
62 63
		     "GNU Emacs %s (%s%s%s%s)\n of %s"
		   "GNU Emacs %s (%s%s%s%s) of %s")
Dave Love's avatar
#  
Dave Love committed
64 65
                 emacs-version
		 system-configuration
66
		 (cond ((featurep 'motif)
67
			(concat ", " (substring motif-version-string 4)))
68 69
		       ((featurep 'gtk)
			(concat ", GTK+ Version " gtk-version-string))
70
		       ((featurep 'x-toolkit) ", X toolkit")
Dan Nicolaescu's avatar
Dan Nicolaescu committed
71
		       ((featurep 'ns)
72
			(format ", NS %s" ns-version-string))
Dave Love's avatar
#  
Dave Love committed
73
		       (t ""))
Jan D's avatar
Jan D committed
74 75 76
		 (if (featurep 'cairo)
		     (format ", cairo version %s" cairo-version-string)
		   "")
77 78 79 80 81
		 (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)))
		   "")
82
		 (format-time-string "%Y-%m-%d" emacs-build-time))))
83
    (if here
Dave Love's avatar
#  
Dave Love committed
84
        (insert version-string)
85
      (if (called-interactively-p 'interactive)
Dave Love's avatar
#  
Dave Love committed
86 87 88
          (message "%s" version-string)
        version-string))))

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

Glenn Morris's avatar
Glenn Morris committed
92
;; Set during dumping, this is a defvar so that it can be setq'd.
93
(defvar emacs-repository-version nil
94 95 96 97 98
  "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.")

(define-obsolete-variable-alias 'emacs-bzr-version
99
                                'emacs-repository-version "24.4")
Glenn Morris's avatar
Glenn Morris committed
100

101
(define-obsolete-function-alias 'emacs-bzr-get-version
102
                                'emacs-repository-get-version "24.4")
103

104 105 106 107 108 109
(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
110
	       (with-demoted-errors "Error running git rev-parse: %S"
111
		 (call-process "git" nil '(t nil) nil "rev-parse" "HEAD")))
112 113 114
	   (progn (goto-char (point-min))
		  (looking-at "[0-9a-fA-F]\\{40\\}"))
	   (match-string 0)))))
115 116 117 118 119 120 121 122 123 124 125 126 127 128

(defun emacs-repository--version-git-1 (file)
  "Internal subroutine of `emacs-repository-get-version'."
  (when (file-readable-p file)
    (erase-buffer)
    (insert-file-contents file)
    (cond ((looking-at "[0-9a-fA-F]\\{40\\}")
	   (match-string 0))
	  ((looking-at "ref: \\(.*\\)")
	   (emacs-repository--version-git-1
	    (expand-file-name (match-string 1)
			      (file-name-directory file)))))))

(defun emacs-repository-get-version (&optional dir external)
129 130 131 132 133 134 135
  "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.

136 137 138 139
Optional argument DIR is a directory to use instead of `source-directory'.
Optional argument EXTERNAL non-nil means to just ask the VCS itself,
if the sources appear to be under version control.  Otherwise only ask
the VCS if we cannot find any information ourselves."
Glenn Morris's avatar
Glenn Morris committed
140
  (or dir (setq dir source-directory))
141 142 143 144 145
  (when (file-directory-p (expand-file-name ".git" dir))
    (if external
	(emacs-repository-version-git dir)
      (or (let ((files '("HEAD" "refs/heads/master"))
		file rev)
146
	    (with-temp-buffer
147 148 149 150 151 152 153 154
	      (while (and (not rev)
			  (setq file (car files)))
		(setq file (expand-file-name (format ".git/%s" file) dir)
		      files (cdr files)
		      rev (emacs-repository--version-git-1 file))))
	    rev)
	  ;; AFAICS this doesn't work during dumping (bug#20799).
	  (emacs-repository-version-git dir)))))
Glenn Morris's avatar
Glenn Morris committed
155

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

;;; version.el ends here