Add HEAD recording

Ensure that a recompilation is triggered when the HEAD or its ref is changed.

Author: MacLotsen

scripts/gitinfo-lua-cmd.lua

@@ -1,5 +1,5 @@
 -- gitinfo-lua-cmd.lua
--- Copyright 2023 E. Nijenhuis
+-- Copyright 2024 E. Nijenhuis
 --
 -- This work may be distributed and/or modified under the
 -- conditions of the LaTeX Project Public License, either version 1.3c
@@ -14,14 +14,15 @@
 -- The Current Maintainer of this work is E. Nijenhuis.
 --
 -- This work consists of the files gitinfo-lua.sty gitinfo-lua.pdf
--- gitinfo-cmd.lua and gitinfo-lua.lua
+-- gitinfo-lua-cmd.lua, gitinfo-lua-recorder.lua and gitinfo-lua.lua
 
 local api = {
     cwd = nil,
     executable = 'git',
     default_sort = '',
     attribute_separator = '\\pop',
-    record_separator = '\\end'
+    record_separator = '\\end',
+    recorder = require('gitinfo-lua-recorder')
 }
 local cache = {}
 function cache:seek(_key)
@@ -40,6 +41,7 @@ end
 function api:exec(command, do_caching, target_dir)
     local cmd = self.executable .. ' ' .. command
     local cwd = target_dir or self.cwd
+    api.recorder.record_head(cwd)
     if cwd then
         cmd = 'cd ' .. cwd .. ' && ' .. cmd
     end

scripts/gitinfo-lua-recorder.lua

@@ -0,0 +1,79 @@
+-- gitinfo-lua-recorder.lua
+-- Copyright 2024 E. Nijenhuis
+--
+-- This work may be distributed and/or modified under the
+-- conditions of the LaTeX Project Public License, either version 1.3c
+-- of this license or (at your option) any later version.
+-- The latest version of this license is in
+-- http://www.latex-project.org/lppl.txt
+-- and version 1.3c or later is part of all distributions of LaTeX
+-- version 2005/12/01 or later.
+--
+-- This work has the LPPL maintenance status ‘maintained’.
+--
+-- The Current Maintainer of this work is E. Nijenhuis.
+--
+-- This work consists of the files gitinfo-lua.sty gitinfo-lua.pdf
+-- gitinfo-lua-cmd.lua, gitinfo-lua-recorder.lua and gitinfo-lua.lua
+
+local kpse = kpse or require('kpse')
+local texio = texio or require('texio')
+
+local api = {
+    record_list = {}
+}
+
+---record_head
+---Records .git/HEAD and .git/refs/heads/<branch> respectively,
+---in order to trigger a rebuild in LaTeX.
+---@param git_directory string
+function api.record_head(git_directory)
+    local head_path = '.git/HEAD'
+    if git_directory then
+        head_path = git_directory .. head_path
+    end
+    if not api.record_list[head_path] then
+        api.record_list[head_path] = true
+        if kpse.in_name_ok(head_path) then
+            local head_file = io.open(head_path, 'rb')
+            if not head_file then
+                texio.write_nl('Warning: couldn\'t read HEAD from git project directory')
+                return
+            end
+            kpse.record_input_file(head_path)
+            texio.write_nl('Info: recording input file ' .. head_path)
+            local head_info = head_file:read('*a')
+            head_file:close()
+            local i, j = string.find(head_info, '^ref: .+\n$')
+            local ref_path = string.sub(head_info, i + 5, j-1)
+            if not ref_path then
+                texio.write_nl('Warning: couldn\'t find ref of HEAD')
+                return
+            end
+            ref_path = '.git/' .. ref_path
+            if git_directory then
+                ref_path = git_directory .. ref_path
+            end
+            if kpse.in_name_ok(ref_path) then
+                kpse.record_input_file(ref_path)
+                texio.write_nl('Info: recording input file ' .. ref_path)
+            else
+                texio.write_nl('Warning: couldn\'t read ref file: ' .. ref_path)
+            end
+        else
+            texio.write_nl('Couldn\'t open input file ' .. head_path)
+        end
+    end
+end
+
+
+
+local gitinfo_recorder = {}
+local gitinfo_recorder_mt = {
+    __index = api,
+    __newindex = nil
+}
+
+setmetatable(gitinfo_recorder, gitinfo_recorder_mt)
+
+return gitinfo_recorder

scripts/gitinfo-lua.lua

@@ -1,5 +1,5 @@
 -- gitinfo-lua.lua
--- Copyright 2023 E. Nijenhuis
+-- Copyright 2024 E. Nijenhuis
 --
 -- This work may be distributed and/or modified under the
 -- conditions of the LaTeX Project Public License, either version 1.3c
@@ -14,7 +14,7 @@
 -- The Current Maintainer of this work is E. Nijenhuis.
 --
 -- This work consists of the files gitinfo-lua.sty gitinfo-lua.pdf
--- gitinfo-cmd.lua and gitinfo-lua.lua
+-- gitinfo-lua-cmd.lua, gitinfo-lua-recorder.lua and gitinfo-lua.lua
 
 if not modules then
     modules = {}
@@ -81,58 +81,6 @@ function api:escape_str(value)
     return buf
 end
 
--- experimental
-function api:get_tok()
-    if self.cur_tok == nil then
-        self.cur_tok = token.get_next()
-    end
-    return self.cur_tok
-end
-
--- experimental
-function api:parse_opts()
-    local tok = self:get_tok()
-    if tok.cmdname == 'other_char' then
-        --token.put_next(tok)
-        local opts = token.scan_word()
-        self.cur_tok = nil
-        -- todo: parse []
-        return opts
-    end
-end
-
--- experimental
-function api:parse_arguments(argc)
-    local result_list = {}
-    for _ = 1, argc do
-        local tok = self:get_tok()
-        if tok.cmdname == 'left_brace' then
-            token.put_next(tok)
-            table.insert(result_list, token.scan_argument())
-            self.cur_tok = nil
-        else
-            tex.error("Expected left brace")
-            return
-        end
-    end
-    return table.unpack(result_list)
-end
-
--- experimental
-function api:parse_macro()
-    --tex.print('\\noexpand')
-    local tok = self:get_tok()
-    if (tok.cmdname == 'call') or tok.cmdname == 'long_call' then
-        self.cur_tok = nil
-        return tok
-    else
-        tex.error("Expected Macro")
-        for i = 1, 5 do
-            local _tok = token.get_next()
-        end
-    end
-end
-
 function api:dir(path)
     self.cmd.cwd = path
 end

tex/gitinfo-lua.sty

@@ -1,5 +1,5 @@
 %% gitinfo-lua.sty
-%% Copyright 2023 E. Nijenhuis
+%% Copyright 2024 E. Nijenhuis
 %
 % This work may be distributed and/or modified under the
 % conditions of the LaTeX Project Public License, either version 1.3c
@@ -14,7 +14,7 @@
 % The Current Maintainer of this work is E. Nijenhuis.
 %
 % This work consists of the files gitinfo-lua.sty gitinfo-lua.pdf
-% gitinfo-cmd.lua and gitinfo-lua.lua
+% gitinfo-lua-cmd.lua, gitinfo-lua-recorder.lua and gitinfo-lua.lua
 \NeedsTeXFormat{LaTeX2e}
 \ProvidesPackage{gitinfo-lua}[2024/02/23 1.0.2 Xerdi's Git Package]