#!/bin/bash

#

# help.sh -- This function initializes the interface used by

# centos-art.sh script to perform documentation tasks through

# different documentation formats.

#

# Copyright (C) 2009, 2010, 2011, 2012 The CentOS Project

#

# 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 2 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, write to the Free Software

# Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.

#

# ----------------------------------------------------------------------

# $Id$

# ----------------------------------------------------------------------

function help {

    # Initialize action name with an empty value.

    local ACTIONNAM=''

    # Initialize search option (`--search'). This option is used to

    # look for documentation inside documentation formats.

    local FLAG_SEARCH=""

    # Initialize manual's language.

    local MANUAL_L10N=${CLI_LANG_LC}

    # Initialize manuals' top-level directory. This is the place where

    # source files for documentation manuals will be stored in. 

    local MANUAL_TLDIR="${TCAR_WORKDIR}/Documentation/Models"

    # Initialize documentation format. This information defines the

    # kind of source files we work with inside the documentation

    # manual as well as the kind of actions required by them to

    # perform actions related to document management (e.g., creation,

    # edition, deletion, copying, renaming, etc.). By default texinfo

    # format is used. Other formats can be specified in the

    # command-line using the `--format' option.

    local FLAG_FORMAT='texinfo'

    # Initialize specific function export id. This value is redefined

    # later once we know which is the documentation format.

    local EXPORTID=''

    # Initialize documentation entries arrays. Arrays defined here

    # contain all the information needed to process documentation

    # entries (e.g., manual, part, chapter and section).

    local -a MANUAL_SLFN

    local -a MANUAL_DIRN

    local -a MANUAL_PART

    local -a MANUAL_CHAP

    local -a MANUAL_SECT

    # Initialize documentation entries counter.

    local MANUAL_DOCENTRY_COUNT=0

    local MANUAL_DOCENTRY_ID=0

    # Interpret option arguments passed through the command-line.

    help_getOptions

    # Redefine arrays related to documentation entries using

    # non-option arguments passed through the command-line. At this

    # point all options have been removed from ARGUMENTS and

    # non-option arguments remain. Evaluate ARGUMENTS to retrieve the

    # information related documentation entries from there.

    help_getEntries

    # Execute format-specific documentation tasks for each

    # documentation entry specified in the command-line, individually.

    # Notice that we've stored all documentation entries passed as

    # non-option arguments in array variables in order to process them

    # now, one by one.  This is particularly useful when we need to

    # reach items in the array beyond the current iteration cycle. For

    # example, when we perform actions that require source and target

    # locations (e.g., copying and renaming): we use the current value

    # as source location and the second value in the array as target

    # location; both defined from the first iteration cycle.

    while [[ $MANUAL_DOCENTRY_ID -lt $MANUAL_DOCENTRY_COUNT ]];do

        # Define name used by manual's main definition file.

        MANUAL_NAME=${MANUAL_SLFN[${MANUAL_DOCENTRY_ID}]}

        # Define extension used by documentation manuals. The

        # extension used must be the same passed in the format option.

        MANUAL_EXTENSION=${FLAG_FORMAT}

        # Define absolute path to directory holding language-specific

        # models.

        MANUAL_BASEDIR="${MANUAL_TLDIR}/$(cli_getRepoName \

            ${MANUAL_EXTENSION} -d)/${MANUAL_DIRN[${MANUAL_DOCENTRY_ID}]}"

        # Define absolute path to directory holding language-specific

        # source files.

        MANUAL_BASEDIR_L10N="${MANUAL_BASEDIR}/${MANUAL_L10N}"

        # Define absolute path to changed directories inside the

        # manual. For example, when a section entry is edited, copied

        # or renamed inside  the same manual there is only one

        # absolute path to look for changes, the one holding the

        # section entry.  However, when an entire manual is renamed,

        # there might be two different locations to look changes for,

        # the source location deleted and the target location added.

        MANUAL_CHANGED_DIRS="${MANUAL_BASEDIR_L10N}"

        # Define absolute path to base file. This is the main file

        # name (without extension) we use as reference to build output

        # files in different formats (.info, .pdf, .xml, etc.).

        MANUAL_BASEFILE="${MANUAL_BASEDIR_L10N}/${MANUAL_NAME}"

        # Redefine function export id based on documentation format.

        EXPORTID="${CLI_FUNCDIRNAM}/$(cli_getRepoName ${MANUAL_EXTENSION} -d)/${MANUAL_EXTENSION}"

        # Define manual base file used for output.

        MANUAL_OUTPUT_BASEFILE=$(echo $MANUAL_BASEFILE | sed -r 's!Models/!Manuals/!')

        # Define manual's part name.

        MANUAL_PART_NAME=${MANUAL_PART[${MANUAL_DOCENTRY_ID}]}

        # Define absolute path to manual's part directory.

        MANUAL_PART_DIR="${MANUAL_BASEDIR_L10N}/${MANUAL_PART_NAME}"

        # Define manual's chapter name.

        MANUAL_CHAPTER_NAME=${MANUAL_CHAP[${MANUAL_DOCENTRY_ID}]}

        # Define absolute path to chapter's directory. This is the

        # place where chapter-specific files are stored in. Be sure no

        # extra slash be present in the value (e.g., when the part

        # name isn't provided).

        MANUAL_CHAPTER_DIR="$(echo ${MANUAL_PART_DIR}/${MANUAL_CHAPTER_NAME} \

            | sed -r 's!/{2,}!/!g' )"

        # Define section name.

        MANUAL_SECTION_NAME=${MANUAL_SECT[${MANUAL_DOCENTRY_ID}]}

        # Define absolute path to manual's configuration file.  This

        # is the file that controls the way template files are applied

        # to documentation entries once they have been created as well

        # as the style and order used for printing sections. 

        MANUAL_CONFIG_FILE="${MANUAL_BASEFILE}.conf" 

        # Notice that, because we are processing non-option arguments

        # one by one, there is no need to synchronize changes or

        # initialize functionalities to the same manual time after

        # time (assuming all documentation entries passed as

        # non-option arguments refer the same manual directory name).

        # That would be only necessary when documentation entries

        # refer to different manual directory names that could be

        # written in different documentation formats.

        if [[ ${MANUAL_DOCENTRY_ID} -eq 0 \

            || ( ( ${MANUAL_DOCENTRY_ID} -gt 0 ) && ( \

            ${MANUAL_DIRN[${MANUAL_DOCENTRY_ID}]} != ${MANUAL_DIRN[((${MANUAL_DOCENTRY_ID} - 1))]} ) ) ]];then

            # Synchronize changes between repository and working copy.

            # At this point, changes in the repository are merged in

            # the working copy and changes in the working copy

            # committed up to repository.

            if [[ -d ${MANUAL_CHANGED_DIRS} ]];then

                cli_synchronizeRepoChanges "${MANUAL_CHANGED_DIRS}"

            fi

            # Initialize documentation format functionalities. At

            # this point we load all functionalities required into

            # `centos-art.sh''s execution environment and make them

            # available, this way, to perform format-specific

            # documentation tasks.

            cli_exportFunctions "${EXPORTID}"

        fi

        # Execute format-specific documentation tasks.

        ${MANUAL_EXTENSION}

        # Unset the exported functions before go on with the next

        # documentation entry provided as non-option argument to

        # `centos-art.sh' script. Different documentation entries may

        # be written in different documentation formats. Each

        # documentation format is loaded in order to perform their

        # related documentation tasks. Assuming more that one

        # documentation entry be passed as non-option argument to

        # `centos-art.sh' script and they are written in different

        # formats, we might end up loading documentation format

        # functionalities that aren't used in the current

        # documentation entry being processed. In that sake, unset

        # documentation back-end functionalities when the next

        # documentation entry refers to a manual directory different

        # to that one being currently processed.

        if [[ ${MANUAL_DOCENTRY_ID} -gt 0 \

            && ${MANUAL_DIRN[${MANUAL_DOCENTRY_ID}]} != ${MANUAL_DIRN[((${MANUAL_DOCENTRY_ID} + 1))]} ]];then

            cli_unsetFunctions "${EXPORTID}"

        fi

        # Increment documentation entry counter id.

        MANUAL_DOCENTRY_ID=$(($MANUAL_DOCENTRY_ID + 1))

    done

    # Synchronize changes between repository and working copy. At this

    # point, changes in the repository are merged in the working copy

    # and changes in the working copy committed up to repository.

    cli_synchronizeRepoChanges "${MANUAL_CHANGED_DIRS}"

}