Debian Codegraph @

texmf-dist/source/latex/tudscr/tudscr-gitinfo.dtx

raw
1 % \iffalse meta-comment
2 %/GitFileInfo=tudscr-gitinfo.dtx
3 %
4 % TUD-Script -- Corporate Design of Technische Universität Dresden
5 % ----------------------------------------------------------------------------
6 %
7 % Copyright (C) Falk Hanisch <[email protected]>, 2012-2022
8 %
9 % ----------------------------------------------------------------------------
10 %
11 % This work may be distributed and/or modified under the conditions of the
12 % LaTeX Project Public License, version 1.3c of the license. The latest
13 % version of this license is in http://www.latex-project.org/lppl.txt and
14 % version 1.3c or later is part of all distributions of LaTeX 2005/12/01
15 % or later and of this work. This work has the LPPL maintenance status
16 % "author-maintained". The current maintainer and author of this work
17 % is Falk Hanisch.
18 %
19 % ----------------------------------------------------------------------------
20 %
21 % Dieses Werk darf nach den Bedingungen der LaTeX Project Public Lizenz
22 % in der Version 1.3c, verteilt und/oder verändert werden. Die aktuelle
23 % Version dieser Lizenz ist http://www.latex-project.org/lppl.txt und
24 % Version 1.3c oder später ist Teil aller Verteilungen von LaTeX 2005/12/01
25 % oder später und dieses Werks. Dieses Werk hat den LPPL-Verwaltungs-Status
26 % "author-maintained", wird somit allein durch den Autor verwaltet. Der
27 % aktuelle Verwalter und Autor dieses Werkes ist Falk Hanisch.
28 %
29 % ----------------------------------------------------------------------------
30 %
31 % \fi
32 %
33 % \iffalse comment
34 % Nicht verwirren lassen! In dieser Datei steht ein Teil der Dokumentation und
35 % des Codes vor dem Treiber. Das ist notwendig, weil der Teil des Codes bereits
36 % am Anfang des Treibers selbst benötigt wird. Genauer gesagt handelt es sich
37 % dabei um den Teil zur Versionsangbabe.
38 % \fi
39 %
40 % \selectlanguage{ngerman}
41 %
42 %
43 %
44 % \section{Versionsinformationen aus dem GitHub-Repository}
45 %
46 % Um sich das ganze Aktualisieren von irgendwelchen Versionangaben zu sparen,
47 % werden diese einfach aus dem GitHub-Repository übernommen. Hierfür ist ein
48 % externer Aufruf von \file{git~log} notwendig, die Informationen werden dabei
49 % in die Datei \file{\GitContainerFile} (\cs{GitContainerFile})
50 % geschrieben und entweder während des Durchlaufs mit \app{docstrip} oder aber
51 % beim Erzeugen der Doku mithilfe des Paketes \pkg{tudscr-gitinfo} ausgelesen.
52 %
53 % \subsection{GitHub-Versionsinformationen für \app{docstrip}}
54 %
55 % \begin{macro}{\GitFileInfo}
56 % \changes{v2.06o}{2022/08/09}{neu}^^A
57 % \begin{macro}{\GitContainerFile}
58 % \changes{v2.06o}{2022/08/09}{neu}^^A
59 % \begin{macro}{\InputGitContainer}
60 % \changes{v2.06o}{2022/08/09}{neu}^^A
61 % In \cs{GitContainerFile} wird der Name der Datei gespeichert, welche die
62 % Versionsinformationen für alle Quelldateien enthält. Diese definiert für alle
63 % relevanten Dateien Makros in der Form
64 % |\|\meta{Dateiname}|-ver{|\meta{Datum}| |\meta{Zeit}| |\meta{Hash}|}|. Diese
65 % Datei wird eingebunden, falls vorhanden sowie der Befehl \cs{GitFileInfo} für
66 % das Hinzufügen der Versionsinformationen für das Erzeugen der Zieldateien mit
67 % \app{docstrip} definiert.
68 % \begin{macrocode}
69 \def\GitContainerFile{tudscr-gitinfo-ver.aux}
70 %<*!package>
71 \begingroup
72 \catcode`\@11\relax%
73 \ifx\documentclass\undefined%
74 \ifx\@@input\undefined\global\let\@@input\input\fi%
75 \newread\@inputcheck%
76 \immediate\openin\@inputcheck=\GitContainerFile\relax%
77 \ifeof\@inputcheck%
78 \global\let\InputGitContainer\relax%
79 \else%
80 \gdef\InputGitContainer{\@@input\GitContainerFile\relax}%
81 \fi%
82 \closein\@inputcheck%
83 \gdef\GitFileInfo#1{%
84 \MetaPrefix\MetaPrefix\space From File:\space#1\space%
85 \expandafter\ifx\csname#1-ver\endcsname\relax%
86 (no git version info was found)%
87 \else%
88 \csname#1-ver\endcsname%
89 \fi%
90 }%
91 \aftergroup\InputGitContainer%
92 \fi%
93 \endgroup
94 \let\InputGitContainer\undefined
95 %</!package>
96 % \end{macrocode}
97 % \end{macro}^^A \InputGitContainer
98 % \end{macro}^^A \GitContainerFile
99 % \end{macro}^^A \GitFileInfo
100 %
101 % \iffalse ins:batch + dtx:driver
102 %<*ins>
103 \ifx\documentclass\undefined
104 \input docstrip.tex
105 \ifToplevel{\batchinput{tudscr.ins}}
106 \else
107 \let\endbatchfile\relax
108 \fi
109 \endbatchfile
110 %</ins>
111 %<*dtx>
112 \ProvidesFile{tudscr-gitinfo.dtx}[2022/08/09]
113 \RequirePackage{tudscr-gitinfo}
114 \documentclass[english,ngerman,xindy]{tudscrdoc}
115 \iftutex
116 \usepackage{fontspec}
117 \else
118 \usepackage[T1]{fontenc}
119 \usepackage[ngerman=ngerman-x-latest]{hyphsubst}
120 \fi
121 \usepackage{babel}
122 \usepackage{tudscrfonts}
123 \usepackage[babel]{microtype}
124
125 \GitHubBase{\TUDScriptRepository}
126 \begin{document}
127 \author{Falk Hanisch\TUDScriptContactTitle}
128 \maketitle
129 \tableofcontents
130 \DocInput{\filename}
131 \end{document}
132 %</dtx>
133 % \fi
134 %
135 % \iffalse comment
136 % Der Rest wird nicht mehr vom Treiber benötigt.
137 % \fi
138 %
139 % \subsection{GitHub-Versionsinformationen für das Paket \pkg{tudscr-gitinfo}}
140 %
141 % Gleich zu Beginn werden die Versionsinformationen geladen, wenn dies nicht
142 % schon passiert ist und diese vorhanden sind.
143 %^^A https://www.juandebravo.com/2017/12/02/git-filter-smudge-and-clean/
144 %^^A https://git-scm.com/book/en/v2/Customizing-Git-Git-Attributes#filters_b
145 %^^A file:///C:/Program%20Files/Git/mingw64/share/doc/git-doc/gitattributes.html
146 % \begin{macrocode}
147 \ProvidesPackage{tudscr-gitinfo}[%
148 %!TUD@Version
149 package (obtaining git version)%
150 ]
151 \ifcsname ver@\GitContainerFile\endcsname\else
152 \InputIfFileExists{\GitContainerFile}{}{}%
153 \fi
154 % \end{macrocode}
155 % \begin{macro}{\GetFileInfo}
156 % \changes{v2.06o}{2022/08/09}{neu}^^A
157 % \begin{macro}{\tud@GetFileInfo}
158 % \changes{v2.06o}{2022/08/09}{neu}^^A
159 % \begin{macro}{\tud@@GetFileInfo}
160 % \changes{v2.06o}{2022/08/09}{neu}^^A
161 % \begin{macro}{\tud@git@file@list}
162 % \changes{v2.06o}{2022/08/09}{neu}^^A
163 % Der Befehl \cs{GetFileInfo} hat das gleiche Ziel wie der gleichnamige Befehl
164 % aus dem Paket \pkg{doc}. Allerdings werden vorliegende Versionsinformationen
165 % aus einem GitHub-Repository bevorzugt geladen. Das Lesen der Informationen,
166 % welche mit \cs{ProvidesFile} gegeben werden können, wird lediglich als
167 % Rückfallebene verwendet. Das angegebene Argument wird für den Dateinamen der
168 % Quelldatei genutzt, wobei bei einer fehlenden Dateiendung \file{dtx}-Dateien
169 % gegenüber \file{tex}-Dateien bevorzugt werden.
170 % \begin{macrocode}
171 \def\GetFileInfo{\tud@GetFileInfo}
172 \newcommand*\tud@git@file@list{}
173 \newcommand*\tud@GetFileInfo[1]{%
174 \filename@parse{#1}%
175 \ifx\filename@ext\relax%
176 \edef\filename{\filename@area\[email protected]}%
177 \expandafter\IfFileExists\expandafter{\filename}{}{%
178 \edef\filename{\filename@area\[email protected]}%
179 }%
180 \else%
181 \edef\filename{#1}%
182 \fi%
183 % \end{macrocode}
184 % Mit dem Dateinamen werden über \cs{tud@git@log} Versionsinformation aus einem
185 % GitHub-Repository abgerufen und verwendet (falls vorhanden). Der dazugehörige
186 % Dateiname wird der Liste \cs{tud@git@file@list} hinzugefügt.
187 % \begin{macrocode}
188 \expandafter\tud@git@log\expandafter{\filename}%
189 \ifcsname\filename-ver\endcsname%
190 \def\@tempa##1 ##2 ##3\@nil{%
191 \def\filedate{##1}%
192 \let\fileversion\@empty%
193 \def\filerevision{##3}%
194 }%
195 \edef\@tempb{\csname\filename-ver\endcsname}%
196 \expandafter\@tempa\@tempb\@nil%
197 \let\fileinfo\@empty%
198 \edef\tud@git@file@list{\tud@git@file@list,\filename}%
199 \else%
200 % \end{macrocode}
201 % Andernfalls wird eine Warnung erzeugt und auf das durch \pkg{doc} definierte
202 % Verhalten von \cs{GetFileInfo} zurückgeschaltet.
203 % \begin{macrocode}
204 \PackageWarningNoLine{tudscr-gitinfo}{No git info found for \filename}%
205 \expandafter\tud@@GetFileInfo\expandafter{\filename}%
206 \fi%
207 }
208 \newcommand*\tud@@GetFileInfo[1]{%
209 \@ifundefined{filedate}{\def\filedate{?}}{}%
210 \@ifundefined{fileversion}{\def\fileversion{?}}{}%
211 \@ifundefined{filerevision}{\let\filerevision\@empty}{}%
212 \@ifundefined{fileinfo}{\let\fileinfo\@empty}{}%
213 % \end{macrocode}
214 % Verbesserte Variante, um nicht \cs{relax?} in die Felder zu schreiben.
215 % \begin{macrocode}
216 \ifcsname ver@\filename\endcsname%
217 \def\@tempa##1 ##2 ##3\relax##4\relax{%
218 \def\@tempb####1\relax?####2\@nil{\edef\@tempc{####1}}%
219 \@tempb##1\relax?\@nil%
220 \ifx\@tempc\@empty\else%
221 \let\filedate\@tempc%
222 \@tempb##2\relax?\@nil%
223 \ifx\@tempc\@empty\else%
224 \let\fileversion\@tempc%
225 \@tempb##3\relax?\@nil%
226 \ifx\@tempc\@empty\else%
227 \let\fileinfo\@tempc%
228 \fi%
229 \fi%
230 \fi%
231 }%
232 \edef\@tempb{\csname ver@#1\endcsname}%
233 \expandafter\@tempa\@tempb\relax? ? \relax\relax%
234 \fi%
235 }
236 % \end{macrocode}
237 % Hiermit wird der Befehl \cs{GetFileInfo} ggf. wieder überschrieben.
238 % \begin{macrocode}
239 \RequirePackage{scrlfile}[%
240 %!TUD@KOMAVersion
241 ]
242 \AfterPackage*{doc}{\def\GetFileInfo{\tud@GetFileInfo}}
243 % \end{macrocode}
244 % \end{macro}^^A \tud@git@file@list
245 % \end{macro}^^A \tud@@GetFileInfo
246 % \end{macro}^^A \tud@GetFileInfo
247 % \end{macro}^^A \GetFileInfo
248 % \begin{macro}{\tud@git@log}
249 % \changes{v2.06o}{2022/08/09}{neu}^^A
250 % \begin{macro}{\tud@git@@log}
251 % \changes{v2.06o}{2022/08/09}{neu}^^A
252 % Der Befehl \cs{tud@git@log} definiert für die im Argument angegebene Datei
253 % das Makro |\|\meta{Dateiname}|-ver| mit den Versionsinformationen, welche mit
254 % \cs{tud@git@@log} ausgelesen wurden.
255 % \begin{macrocode}
256 \RequirePackage{pdftexcmds}
257 \newcommand*\tud@git@log[1]{%
258 \ifnum\pdf@shellescape=\@ne%
259 \begingroup%
260 \endlinechar=\m@ne%
261 \everyeof{\noexpand}%
262 \edef\@tempa{\tud@git@@log{#1}}%
263 \ifx\@tempa\@empty\else%
264 \edef\@tempa{%
265 \unexpanded{\expandafter\gdef\csname #1-ver\endcsname}{\@tempa}%
266 }%
267 \@tempa%
268 \fi%
269 \endgroup%
270 \fi%
271 }
272 % \end{macrocode}
273 % Der Befehl \cs{tud@git@@log} startet den Aufruf von \file{git~log} mit den
274 % notwendigen Formatierungsoptionen.
275 % \begin{macrocode}
276 \begingroup
277 \@makeother\|
278 \newcommand*\tud@git@@log[1]{}
279 \xdef\tud@git@@log#1{%
280 \noexpand\@@input|"git log -1 %
281 --format='\@percentchar ad \@percentchar h' %
282 --date=format:'\@percentchar Y/\@percentchar m/\@percentchar d %
283 \@percentchar H:\@percentchar M:\@percentchar S' %
284 -- #1" %
285 }
286 \endgroup
287 % \end{macrocode}
288 % \end{macro}^^A \tud@git@@log
289 % \end{macro}^^A \tud@git@log
290 % Am Dokumentende wird für alle Dateien, für die eine Versionsinformation
291 % gefunden werden konnte und in \cs{tud@git@file@list} gesammelt wurden, diese
292 % in die externe Datei \cs{GitContainerFile} geschrieben, damit diese auch
293 % ohne den abermaligen Aufruf mit dem Parameter \file{-{}-shell-escape} genutzt
294 % werden können.
295 % \begin{macrocode}
296 \AtEndDocument{%
297 \ifnum\pdf@shellescape=\@ne%
298 \ifx\tud@git@file@list\@empty\else%
299 \edef\tud@git@file@list{\expandafter\@gobble\tud@git@file@list}%
300 \def\@tempa{%
301 \@percentchar\@percentchar\space%
302 This file was generated with `tudscr-gitinfo.sty'^^J%
303 \@percentchar\@percentchar\space%
304 It is intended to be used for generating either a documentation^^J%
305 \@percentchar\@percentchar\space%
306 with class `tudscrdoc' or installation files with `docstrip'%
307 }%
308 \chardef\reserved@c15 %
309 \ch@ck7\reserved@c\write%
310 \immediate\openout\reserved@c\GitContainerFile\relax%
311 \immediate\write\reserved@c{\@tempa}%
312 \@for\@tempa:=\tud@git@file@list\do{%
313 \edef\@tempb{%
314 \unexpanded{\expandafter\gdef\csname}%
315 \@tempa-ver%
316 \noexpand\endcsname%
317 {\csname\@tempa-ver\endcsname}%
318 }%
319 \immediate\write\reserved@c{\unexpanded\expandafter{\@tempb}}%
320 }%
321 \immediate\closeout\reserved@c%
322 \fi%
323 \fi%
324 }
325 % \end{macrocode}
326 % Am Ende des Paketes werden die Versionsinformationen der aktuellen Datei
327 % ausgelesen und anschließend mit \cs{ProvidesFile} gesetzt, wobei eine Warnung
328 % erzeugt wird, wenn für die Datei schon einmal \cs{ProvidesFile} mit einer
329 % anderen Angabe genutzt wurde. Die zu schreibende Angabe wird hierfür in
330 % \cs{@tempa} expandiert und mit |\ ver@|\meta{Dateiname} verglichen.
331 % \begin{macrocode}
332 \AtEndOfPackage{%
333 \GetFileInfo{\jobname}%
334 \edef\@tempa{%
335 \filedate\space\fileversion\space%
336 \ifx\filerevision\@empty\else%
337 \filerevision\ifx\fileinfo\@empty\else\space\fi%
338 \fi%
339 \fileinfo%
340 }%
341 \ifcsname ver@\filename\endcsname%
342 \edef\@tempb{\csname ver@\filename\endcsname}%
343 \ifx\@tempb\filedate\else%
344 \PackageWarningNoLine{tudscr-gitinfo}{%
345 The obtained info for \filename\space is\MessageBreak%
346 \@tempa\MessageBreak%
347 so the current info\MessageBreak%
348 \csname ver@\filename\endcsname\MessageBreak%
349 is overwritten%
350 }%
351 \fi%
352 \fi%
353 \ProvidesFile{\filename}[\@tempa]%
354 }
355 % \end{macrocode}
356 %
357 % \PrintBackMatter
358 %
359 \endinput