version.el 6.95 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-2016 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
;; FIXME: The next variable should also be a constant if
;; `deterministic-dump' is t.
43 44
(defconst emacs-build-time (current-time)
  "Time at which Emacs was dumped out.")
Dave Love's avatar
#  
Dave Love committed
45

46 47
(defconst emacs-build-system
  (if deterministic-dump "elided" (system-name))
48
  "Name of the system on which Emacs was built.")
Dave Love's avatar
#  
Dave Love committed
49

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

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

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

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

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

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

117
(defun emacs-repository--version-git-1 (file dir)
118 119
  "Internal subroutine of `emacs-repository-get-version'."
  (when (file-readable-p file)
120 121 122 123 124 125 126 127
    (with-temp-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) dir)
              dir))))))
128 129

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

137 138 139 140
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
141
  (or dir (setq dir source-directory))
142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173
  (let* ((base-dir (expand-file-name ".git" dir))
         (in-main-worktree (file-directory-p base-dir))
         (in-linked-worktree nil)
         sub-dir)
    ;; If the sources are in a linked worktree, .git is a file that points to
    ;; the location of the main worktree and the repo's administrative files.
    (when (and (not in-main-worktree)
               (file-regular-p base-dir)
               (file-readable-p base-dir))
      (with-temp-buffer
        (insert-file-contents base-dir)
        (when (looking-at "gitdir: \\(.*\.git\\)\\(.*\\)$")
          (setq base-dir (match-string 1)
                sub-dir (concat base-dir (match-string 2))
                in-linked-worktree t))))
    ;; We've found a worktree, either main or linked.
    (when (or in-main-worktree in-linked-worktree)
      (if external
          (emacs-repository-version-git dir)
        (or (if in-linked-worktree
                (emacs-repository--version-git-1
                 (expand-file-name "HEAD" sub-dir) base-dir)
              (let ((files '("HEAD" "refs/heads/master"))
                    file rev)
                (while (and (not rev)
                            (setq file (car files)))
                  (setq file (expand-file-name file base-dir)
                        files (cdr files)
                        rev (emacs-repository--version-git-1 file base-dir)))
                rev))
            ;; AFAICS this doesn't work during dumping (bug#20799).
            (emacs-repository-version-git dir))))))
Glenn Morris's avatar
Glenn Morris committed
174

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

;;; version.el ends here