doxygen.sh

Go to the documentation of this file.

#!/bin/zsh
#
#--------------------------------------------------------------------------------------
#
#                Utility script for generation of HTML Doxygen main page.
#
#--------------------------------------------------------------------------------------
# \author mdejong
#
script=${0##*/}

if [ -z $JPP_DIR ]; then
    echo "Variable JPP_DIR undefined."
    exit 1
fi

source $JPP_DIR/setenv.sh $JPP_DIR >& /dev/null

if do_usage $*; then
    usage "$script"
fi

setopt +o nomatch

set_variable NUMBER_OF_COLUMNS   3

#
function findapps()
{
    find  $*  -mindepth 1  -executable  ! -regex ".*\.\(\(\|c\|z\)sh\|py\)"  -printf "%f\n"  |  sort
}

#
function findscripts()
{
    find  $*  -mindepth 1  -executable    -regex ".*\.\(\(\|c\|z\)sh\|py\)"  -printf "%f\n"  |  sort
}

#
function findexamples()
{
    find  $*  -mindepth 1  -executable  |  sort
}

#
# Method to get file name of source code.
#
# \param  1       executable file
# \return         source     file
#
function get_source()
{
    file=`which $1 2> /dev/null`

    if [[ -n "${file}" && -x ${file} ]]; then
        if [[ $file == *\.((|c|z)sh|py) ]]; then
            source=${file}
        else
            source=`${file} -v 2> /dev/null | sed -n 's/source: *//p'`
        fi
    else
        source=$1
    fi

    echo ${source:a}
}


echo "/**"
echo " * \mainpage Documentation"
echo " * \htmlonly"
echo " * <style>"
echo " * ul.b { list-style-type: none; counter-reset: section; columns: ${NUMBER_OF_COLUMNS}; -moz-column-count: ${NUMBER_OF_COLUMNS}; -webkit-column-count: ${NUMBER_OF_COLUMNS}; column-count: ${NUMBER_OF_COLUMNS}; }"
echo " * </style>"

# Documents

echo " * <hr>"
echo " * <h2>Documents</h2>"
echo " * <ul class=\"b\">"
for file in `ls ${JPP_DOC}/*`; do
    if [ -f ${file} ]; then
        echo " * <li><a href=\"${file##*/}\">${file##*/}</a></li>"
    fi
done
echo " * </ul>"


# Applications header

echo " * <hr>"
echo " * <h2>Applications</h2>"
echo " * <ul class=\"b\">"
for file in `findapps ${JPP_BIN}`; do
    echo " * <li><a href=\"#${file}\">${file}</a></li>"
done
echo " * </ul>"


# Scripts header

echo " * <hr>"
echo " * <h2>Scripts</h2>"
echo " * <ul class=\"b\">"
for file in `findscripts ${JPP_BIN}`; do
    echo " * <li><a href=\"#${file}\">${file}</a></li>"
done
echo " * </ul>"


# Examples header

echo " * <hr>"
echo " * <h2>Examples</h2>"
echo " * <ul class=\"b\">"
for dir in `ls $JPP_DIR/examples`; do
    echo " * <li><a href=\"#examples/${dir}\">${dir}</a></li>"
done
echo " * </ul>"


# Applications data

for file in `findapps ${JPP_BIN}`; do

    source=`get_source ${file}`

    echo " * <hr>"
    echo " * <h4 id=\"${file}\">"
    if [[ -n "${source}" ]]; then
        if (`ls $JPP_DIR/examples/*/${source:t} >& /dev/null`); then
            source=${source##${JPP_DIR:a}/}
        else
            source=${source:t}
        fi
        echo " * \\\\endhtmlonly"
        echo " * ${source}"
        echo " * \htmlonly"
    else
        echo " * ${file}"
    fi
    echo " * </h4>"
    echo " * <pre>"
    ${file} -h! 2> /dev/null | sed 's/</\&lt;/g;s/>/\&gt;/g'
    echo " * </pre>"
    echo " * <a href="#top">Go back to top of page.</a>"
done


# Scripts data

for file in `findscripts ${JPP_BIN}`; do

    source=`eval ls $JPP_DIR/software/*/$file`

    echo " * <hr>"
    echo " * <h4 id=\"${file}\">"
    if [[ -n "${source}" ]]; then
        if (`ls $JPP_DIR/examples/*/${source:t} >& /dev/null`); then
            source=${source##${JPP_DIR:a}/}
        else
            source=${source:t}
        fi
        echo " * \\\\endhtmlonly"
        echo " * ${source}"
        echo " * \htmlonly"
    else
        echo " * ${file}"
    fi
    echo " * </h4>"
    echo " * <pre>"
    ${file} -h! 2> /dev/null | sed 's/</\&lt;/g;s/>/\&gt;/g'
    echo " * </pre>"
    echo " * <a href="#top">Go back to top of page.</a>"
done

    
# Examples data

for dir in `ls $JPP_DIR/examples`; do
        
    echo " * <hr>"
    echo " * <h4 id=\"examples/${dir}\">${dir}</h4>"
    echo " * <ul class=\"b\">"
    for file in `findexamples $JPP_DIR/examples/${dir}`; do
        echo " * <li><a href=\"#${file}\">${file:t}</a></li>"
    done
    echo " * </ul>"
    echo " * <a href="#top">Go back to top of page.</a>"

    for file in `findexamples $JPP_DIR/examples/${dir}/`; do

        if [[ ! $file = *.sh && ! $file = *.csh ]]; then
            source=`get_source ${file}`
        else
            source=$file
        fi

        echo " * <hr>"
        echo " * <h4 id=\"${file}\">"
        if [[ -n "${source}" ]]; then
            if (`ls ${JPP_DIR}/software/*/${source:t} >& /dev/null` || `ls ${JPP_DIR}/examples/^${dir}/${source:t} >& /dev/null`); then
                source=${source##${JPP_DIR:a}/}
            else
                source=${source:t}
            fi
            echo " * \\\\endhtmlonly"
            echo " * ${source}"
            echo " * \htmlonly"
        else
            echo " * ${file}"
        fi
        echo " * </h4>"
        echo " * <pre>"
        ${file} -h! 2>&1 | sed 's/</\&lt;/g;s/>/\&gt;/g'
        echo " * </pre>"
        echo " * <a href="#top">Go back to top of page.</a>"
    done
done

echo " * \\\\endhtmlonly"
echo " */"