1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
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
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
|
;;; ede-proj-info.el --- EDE Generic Project texinfo support -*- lexical-binding: t; -*-
;; Copyright (C) 1998-2021 Free Software Foundation, Inc.
;; Author: Eric M. Ludlam <zappo@gnu.org>
;; Keywords: project, make
;; 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:
;;
;; Handle texinfo in and EDE Project file.
(require 'ede/pmake)
;;; Code:
(defclass ede-proj-target-makefile-info (ede-proj-target-makefile)
((menu :initform nil)
(keybindings :initform nil)
(availablecompilers :initform '(ede-makeinfo-compiler
ede-texi2html-compiler))
(sourcetype :initform '(ede-makeinfo-source))
(mainmenu :initarg :mainmenu
:initform ""
:type string
:custom string
:documentation "The main menu resides in this file.
All other sources should be included independently."))
"Target for a single info file.")
(defvar ede-makeinfo-source
(ede-sourcecode :name "Texinfo"
:sourcepattern "\\.texi?$"
:garbagepattern '("*.info*" "*.html"))
"Texinfo source code definition.")
(defvar ede-makeinfo-compiler
(ede-compiler
:name "makeinfo"
:variables '(("MAKEINFO" . "makeinfo"))
:commands '("$(MAKEINFO) $<")
:autoconf '(("AC_CHECK_PROG" . "MAKEINFO, makeinfo"))
:sourcetype '(ede-makeinfo-source)
)
"Compile texinfo files into info files.")
(defvar ede-texi2html-compiler
(ede-compiler
:name "texi2html"
:variables '(("TEXI2HTML" . "makeinfo -html"))
:commands '("makeinfo -o $@ $<")
:sourcetype '(ede-makeinfo-source)
)
"Compile texinfo files into html files.")
;;; Makefile generation
;;
(cl-defmethod ede-proj-configure-add-missing
((_this ede-proj-target-makefile-info))
"Query if any files needed by THIS provided by automake are missing.
Results in --add-missing being passed to automake."
(not (ede-expand-filename (ede-toplevel) "texinfo.tex")))
(cl-defmethod ede-proj-makefile-sourcevar ((this ede-proj-target-makefile-info))
"Return the variable name for THIS's sources."
(concat (ede-pmake-varname this) "_TEXINFOS"))
(cl-defmethod ede-proj-makefile-insert-source-variables
((this ede-proj-target-makefile-info) &optional moresource)
"Insert the source variables needed by THIS info target.
Optional argument MORESOURCE is a list of additional sources to add to the
sources variable.
Does the usual for Makefile mode, but splits source into two variables
when working in Automake mode."
(if (not (ede-proj-automake-p))
(cl-call-next-method)
(let* ((sv (ede-proj-makefile-sourcevar this))
(src (copy-sequence (oref this source)))
(menu (or (oref this menu) (car src))))
(setq src (delq menu src))
;; the info_TEXINFOS variable is probably shared
(ede-pmake-insert-variable-shared "info_TEXINFOS"
(insert menu))
;; Now insert the rest of the source elsewhere
(ede-pmake-insert-variable-shared sv
(insert (mapconcat #'identity src " ")))
(if moresource
(error "Texinfo files should not have moresource")))))
(defun ede-makeinfo-find-info-filename (source)
"Find the info filename produced by SOURCE texinfo file."
(let ((opened (get-file-buffer source))
(buffer (or (get-file-buffer source)
(find-file-noselect source nil t)))
info)
(with-current-buffer buffer
(save-excursion
(goto-char (point-min))
(and (re-search-forward "^@setfilename\\s-+\\([^.]+\\).info$" nil t)
(setq info (match-string 1)))))
(unless (eq buffer opened)
(kill-buffer buffer))
info))
(cl-defmethod ede-proj-makefile-target-name ((this ede-proj-target-makefile-info))
"Return the name of the main target for THIS target."
;; The target should be the main-menu file name translated to .info.
(let* ((source (if (not (string= (oref this mainmenu) ""))
(oref this mainmenu)
(car (oref this source))))
(info (ede-makeinfo-find-info-filename source)))
(concat (or info (file-name-sans-extension source)) ".info")))
(cl-defmethod ede-proj-makefile-insert-dist-dependencies ((this ede-proj-target-makefile-info))
"Insert any symbols that the DIST rule should depend on.
Texinfo files want to insert generated `.info' files.
Argument THIS is the target which needs to insert an info file."
;; In some cases, this is ONLY the index file. That should generally
;; be ok.
(insert " " (ede-proj-makefile-target-name this))
)
(cl-defmethod ede-proj-makefile-insert-dist-filepatterns ((this ede-proj-target-makefile-info))
"Insert any symbols that the DIST rule should depend on.
Texinfo files want to insert generated `.info' files.
Argument THIS is the target which needs to insert an info file."
;; In some cases, this is ONLY the index file. That should generally
;; be ok.
(insert " " (ede-proj-makefile-target-name this) "*")
)
; (let ((n (ede-name this)))
; (if (string-match "\\.info$" n)
; n
; (concat n ".info"))))
(cl-defmethod object-write ((this ede-proj-target-makefile-info))
"Before committing any change to THIS, make sure the mainmenu is first."
(let ((mm (oref this mainmenu))
(s (oref this source))
(nl nil))
(if (or (string= mm "") (not mm) (string= mm (car s)))
nil
;; Make sure that MM is first in the list of items.
(setq nl (cons mm (delq mm s)))
(oset this source nl)))
(cl-call-next-method))
(cl-defmethod ede-documentation ((this ede-proj-target-makefile-info))
"Return a list of files that provides documentation.
Documentation is not for object THIS, but is provided by THIS for other
files in the project."
(let* ((src (oref this source))
(proj (ede-target-parent this))
(dir (oref proj directory))
(out nil)
)
;; convert src to full file names.
(while src
(setq out (cons
(expand-file-name (car src) dir)
out))
(setq src (cdr src)))
;; Return it
out))
(provide 'ede/proj-info)
;;; ede/proj-info.el ends here
|
