#!/usr/bin/env bash ############################################################################# ## ## XML documenting files to (X)HTML conversion script ## Last updated on July 18, 2022 ## ## This file is part of Logtalk ## SPDX-FileCopyrightText: 1998-2023 Paulo Moura ## SPDX-License-Identifier: Apache-2.0 ## ## Licensed under the Apache License, Version 2.0 (the "License"); ## you may not use this file except in compliance with the License. ## You may obtain a copy of the License at ## ## http://www.apache.org/licenses/LICENSE-2.0 ## ## Unless required by applicable law or agreed to in writing, software ## distributed under the License is distributed on an "AS IS" BASIS, ## WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. ## See the License for the specific language governing permissions and ## limitations under the License. ## ############################################################################# print_version() { echo "$(basename "$0") 2.3" exit 0 } if ! [ "$LOGTALKHOME" ]; then echo "The environment variable LOGTALKHOME should be defined first, pointing" echo "to your Logtalk installation directory!" echo "Trying the default locations for the Logtalk installation..." if [ -d "/usr/local/share/logtalk" ]; then LOGTALKHOME=/usr/local/share/logtalk echo "... using Logtalk installation found at /usr/local/share/logtalk" elif [ -d "/usr/share/logtalk" ]; then LOGTALKHOME=/usr/share/logtalk echo "... using Logtalk installation found at /usr/share/logtalk" elif [ -d "/opt/local/share/logtalk" ]; then LOGTALKHOME=/opt/local/share/logtalk echo "... using Logtalk installation found at /opt/local/share/logtalk" elif [ -d "/opt/share/logtalk" ]; then LOGTALKHOME=/opt/share/logtalk echo "... using Logtalk installation found at /opt/share/logtalk" elif [ -d "$HOME/share/logtalk" ]; then LOGTALKHOME="$HOME/share/logtalk" echo "... using Logtalk installation found at $HOME/share/logtalk" elif [ -f "$( cd "$( dirname "$0" )" && pwd )/../core/core.pl" ]; then LOGTALKHOME="$( cd "$( dirname "$0" )" && pwd )/.." echo "... using Logtalk installation found at $( cd "$( dirname "$0" )" && pwd )/.." else echo "... unable to locate Logtalk installation directory!" >&2 echo exit 1 fi echo elif ! [ -d "$LOGTALKHOME" ]; then echo "The environment variable LOGTALKHOME points to a non-existing directory!" >&2 echo "Its current value is: $LOGTALKHOME" >&2 echo "The variable must be set to your Logtalk installation directory!" >&2 echo exit 1 fi export LOGTALKHOME if ! [ "$LOGTALKUSER" ]; then echo "The environment variable LOGTALKUSER should be defined first, pointing" echo "to your Logtalk user directory!" echo "Trying the default location for the Logtalk user directory..." export LOGTALKUSER=$HOME/logtalk if [ -d "$LOGTALKUSER" ]; then echo "... using Logtalk user directory found at $LOGTALKUSER" else echo "... Logtalk user directory not found at default location. Creating a new" echo "Logtalk user directory by running the \"logtalk_user_setup\" shell script:" logtalk_user_setup fi elif ! [ -d "$LOGTALKUSER" ]; then echo "Cannot find \$LOGTALKUSER directory! Creating a new Logtalk user directory" echo "by running the \"logtalk_user_setup\" shell script:" logtalk_user_setup fi echo html_entity_xslt="$LOGTALKUSER/tools/lgtdoc/xml/logtalk_entity_to_html.xsl" xhtml_entity_xslt="$LOGTALKUSER/tools/lgtdoc/xml/logtalk_entity_to_xhtml.xsl" html_index_xslt="$LOGTALKUSER/tools/lgtdoc/xml/logtalk_index_to_html.xsl" xhtml_index_xslt="$LOGTALKUSER/tools/lgtdoc/xml/logtalk_index_to_xhtml.xsl" format=xhtml directory="." index_file=index.html index_title="Documentation index" processor=xsltproc # processor=xalan # processor=saxon usage_help() { echo echo "This script converts all Logtalk XML files documenting files in the" echo "current directory to XHTML or HTML files" echo echo "Usage:" echo " $(basename "$0") [-f format] [-d directory] [-i index] [-t title] [-p processor]" echo " $(basename "$0") -v" echo " $(basename "$0") -h" echo echo "Optional arguments:" echo " -f output file format (either xhtml or html; default is $format)" echo " -d output directory for the generated files (default is $directory)" echo " -i name of the index file (default is $index_file)" echo " -t title to be used in the index file (default is $index_title)" echo " -p XSLT processor (xsltproc, xalan, or saxon; default is $processor)" echo " -v print version" echo " -h help" echo } create_index_file() { echo "" > "$index_file" case "$format" in xhtml) echo "" >> "$index_file" echo "" >> "$index_file" echo "" >> "$index_file" echo "" >> "$index_file" ;; html) echo "" >> "$index_file" echo "" >> "$index_file" ;; esac echo "" >> "$index_file" echo " " >> "$index_file" echo " $index_title" >> "$index_file" echo " " >> "$index_file" echo "" >> "$index_file" echo "" >> "$index_file" echo "

$index_title

" >> "$index_file" echo "" >> "$index_file" date="$(eval date)" echo "

Generated on $date

" >> "$index_file" echo "" >> "$index_file" echo "" >> "$index_file" } while getopts "vf:d:i:t:p:h" Option do case $Option in v) print_version;; f) f_arg="$OPTARG";; d) d_arg="$OPTARG";; i) i_arg="$OPTARG";; t) t_arg="$OPTARG";; p) p_arg="$OPTARG";; h) usage_help; exit;; *) usage_help; exit;; esac done if [ "$f_arg" != "" ] && [ "$f_arg" != "xhtml" ] && [ "$f_arg" != "html" ] ; then echo "Error! Unsupported output format: $f_arg" >&2 usage_help exit 1 elif [ "$f_arg" != "" ] ; then format=$f_arg fi if [ "$d_arg" != "" ] && [ ! -d "$d_arg" ] ; then echo "Error! output directory does not exists: $d_arg" >&2 usage_help exit 1 elif [ "$d_arg" != "" ] ; then directory=$d_arg fi if [ "$i_arg" != "" ] ; then index_file=$i_arg fi if [ "$t_arg" != "" ] ; then index_title=$t_arg fi if [ "$p_arg" != "" ] && [ "$p_arg" != "xsltproc" ] && [ "$p_arg" != "xalan" ] && [ "$p_arg" != "saxon" ] ; then echo "Error! Unsupported XSLT processor: $p_arg" >&2 usage_help exit 1 elif [ "$p_arg" != "" ] ; then processor=$p_arg fi if [ "$format" = "xhtml" ] ; then entity_xslt=$xhtml_entity_xslt index_xslt=$xhtml_index_xslt else entity_xslt=$html_entity_xslt index_xslt=$html_index_xslt fi if ! [ -e "./logtalk_entity.dtd" ] ; then cp "$LOGTALKHOME"/tools/lgtdoc/xml/logtalk_entity.dtd . fi if ! [ -e "./logtalk_index.dtd" ] ; then cp "$LOGTALKHOME"/tools/lgtdoc/xml/logtalk_index.dtd . fi if ! [ -e "./custom.ent" ] ; then cp "$LOGTALKUSER"/tools/lgtdoc/xml/custom.ent . fi if ! [ -e "./logtalk_entity.xsd" ] ; then cp "$LOGTALKHOME"/tools/lgtdoc/xml/logtalk_entity.xsd . fi if ! [ -e "./logtalk_index.xsd" ] ; then cp "$LOGTALKHOME"/tools/lgtdoc/xml/logtalk_index.xsd . fi if ! [ -e "$directory/logtalk.css" ] ; then cp "$LOGTALKUSER"/tools/lgtdoc/xml/logtalk.css "$directory" fi if grep -q "