#!/bin/bash
#
# help_getEntry.sh -- This function builds a documentation entry based
# on a location specified. Location specification can be both action
# value (ACTIONVAL) variable or a value passed as first positional
# parameter.
#
# Copyright (C) 2009-2011 Alain Reguera Delgado
# 
# 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307
# USA.
# 
# ----------------------------------------------------------------------
# $Id$
# ----------------------------------------------------------------------

function help_getEntry {

    # Define variables as local to avoid conflicts outside.
    local ENTRY=''
    local LOCATION=''

    # Redefine location in order to make this function reusable not
    # just for action value variable but whatever value passed as
    # first possitional argument.
    if [[ "$1" != '' ]];then
        LOCATION="$1"
    else
        LOCATION="$ACTIONVAL"
    fi

    # Define relative path of entry, from trunk directory on.
    ENTRY=$(echo $LOCATION | sed -r "s!^${HOME}/artwork/!!")

    # Verify the entry relative path to find out which documentation
    # manual we are acting on. As convenction, whatever documentation
    # entry you provide outside trunk/Manuals/ directory structure is
    # considered as you are documenting the repository directory
    # structure. Otherwise, if an entry inside trunk/Manuals/ is
    # provided, the directory structure provided is used as default
    # documentation manual for actions like `--create' and `--update'
    # to take place on. Other options like `--edit', `--delete' and
    # `--read' cannot be applied to paths provided is inside
    # trunk/Manuals/ such actions made manually.
    if [[ ${ENTRY} =~ '\.texi$' ]];then
        ENTRY=$(echo ${ENTRY} | sed 's!trunk/Manual/!!')
    else
        ENTRY=$(dirname Filesystem/${ENTRY})/$(basename $LOCATION).texi
    fi

    # Re-define entry to set absolute path to manuals base directory
    # structure.
    ENTRY=${MANUAL_BASEDIR}/${ENTRY}

    # Output entry's absolute path.
    echo ${ENTRY}

}