star-ty

sty-hooks (5994B)

---

 #!/bin/sh
 
 # Copyright (C) 2017-2025 |Méso|Star> (contact@meso-star.com)
 #
 # This program 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.
 #
 # This program 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 this program. If not, see <http://www.gnu.org/licenses/>.
 
 . "sty.sh"
 
 set -e
 
 if [ ! -e "menu.tsv" ]; then
   >&2 printf \
     '%s: not a star-typesetting directory (the menu.tsv file is missing)\n' \
     "${0##*/}"
   exit 1
 fi
 
 # Print on standard output the Makefile targets used to automate hook
 # management
 
 shtml="$(sty-list shtml)"
 hook="$(sty-list hook)"
 
 sections | while read -r i; do
   shtml_section="$(printf '%s\n' "${shtml}" \
     | sed -n "/^${i}\//{s/\.sh/\.md/g;p;}" | tr '\n' ' ')"
   hook_section="$(printf '%s\n' "${hook}" \
     | sed -n "/^${i}\//p" | tr '\n' ' ' \
     | sed -e 's/\.sh[[:space:]]/.hook /g')"
 
   # Define Makefile target that makes section hooks prerequisites for
   # the HTML content of the section.
   #
   # It is the files generated by each of the hooks that are
   # prerequisites for the HTML files, not the scripts  of the hooks
   # themselves, because even if the scripts have not changed, their
   # output may have been updated, which can impact the HTML content
   # generated at build time.
   #
   # Furthermore, it is not the HTML file itself that depends on the
   # hook's output, but rather the intermediate Markdown dynamically
   # generated by the script, whose output may depend on the execution of
   # hooks.
   if [ -n "${shtml_section}" ] \
   && [ -n "${hook_section}" ]; then
     printf '%s: %s\n' "${shtml_section}" "${hook_section}"
   fi
 done
 
 printf '%s\n' "${hook}" | while read -r i; do
   # Discard empty line
   if [ -z "${i}" ]; then continue; fi
 
   # Divide the path into two parts:
   #   - the top-level directory, i.e. the section
   #   - the shell script to be executed from the section directory
   section="${i%%/*}"
   hook="${i##"${section}"/}"
 
   # The hook is the first one in the current section: it has the highest
   # priority and therefore has no prerequisites.
   if [ "${section}" != "${prev_section}" ]; then
     dep=""
     tgt_list=""
     prev_priority=""
   fi
 
   # Retrieve the hook priority
   priority="$(basename "${i}")"
   priority="${priority%%-*}"
 
   # Define a name for the hook used as a prefix for Makefile targets in
   # order to automate its execution and the management of the file it
   # generates. To ensure that this name is unique, and thus avoid
   # conflicts between different hooks, it is  constructed from the names
   # of the section and file corresponding to the hook.
   file="$(basename "${hook}")"
   prefix="${section}-${file%%.*}"
 
   # Set the file in which the names of the files generated by the hook
   # are stored as resources for the website, i.e., the files that must
   # be deployed with the website.
   tgt="${i%%.*}.hook"
 
   if [ "${priority}" = "${prev_priority}" ]; then
     # The hook's priority is the same as the previous one. Add its
     # target to the list of prerequisites for hooks with lower priority
     tgt_list="${tgt_list} ${tgt}"
   else
     # The priority of the current hook is lower than those processed
     # previously. Define as a prerequisite the execution of hooks whose
     # priority precedes the priority of the current hook.
     dep="${tgt_list}"
 
     # The execution of the current hook becomes a prerequisite for hooks
     # with lower priority.
     tgt_list="${tgt}"
   fi
 
   # Define the Makefile target that automate the hook executation. Its
   # pre-requisites are the hook script and the output of the # previous
   # hook in the section, i.e. with an higher priority. So that
   # execution priority is ensured.
   #
   # Finally, make this target a prerequisite for building the website
   # in order to enforce its execution during the build call.
   printf '%s: %s %s\n' "${tgt}" "${i}" "${dep}"
   printf '	@cd -- %s; ' "${section}"
   printf "\$(SHELL) %s > \$\${OLDPWD}/\$@ " "${hook}"
   printf "|| { rm -f \$\${OLDPWD}/\$@; exit 1; } \n"
 
   # Set the target for cleaning files generated by executing the hook.
   # Run it on "distclean" and not on "clean", as their generation can be
   # costly while effectively being files generated to "distribute" the
   # website.
   printf '%s-distclean:\n' "${prefix}"
   printf '	if [ -f %s ]; then cat %s | xargs rm -f; fi\n' \
     "${tgt}" "${tgt}"
   printf '	rm -f %s\n' "${tgt}"
   printf 'distclean__: %s-distclean\n' "${prefix}"
 
   # Set the target to "lightly" clean up the hook, i.e., force it to
   # re-execute without deleting the files it would generate. This way,
   # the hooks could query these files in order to regenerate them
   # depending on whether they deem it necessary or not.
   #
   # This aims to speed up the re-execution of hooks, as there is no way
   # to track their dependencies, meaning that their (conditional)
   # re-execution is often the only way to ensure that content is up to
   # date with the latest updates.
   printf '%s-clean:\n' "${prefix}"
   printf '	rm -f %s\n' "${tgt}"
   printf 'clean__: %s-clean\n' "${prefix}"
 
   # Set the target that installs website resources generated by the hook
   printf '%s-install: %s\n' "${prefix}" "${tgt}"
   printf '	@rsync -avzrR --delete-after --progress \\\n'
   printf '	--chmod=Dg+s,g+w,Fg+w --chown=:'"\$(GROUP)"' --omit-dir-times \\\n'
   printf '	--files-from=%s ./ '"\$(PREFIX)"'\n' "${tgt}"
   printf 'install__: %s-install\n' "${prefix}"
 
   # Save the current section and priority of the hook that has just been
   # processed
   prev_section="${section}"
   prev_priority="${priority}"
 done