Blame Automation/Modules/Help/help_getOptions.sh

Alain Reguera Delgado 8f60cb
#!/bin/bash
Alain Reguera Delgado 8f60cb
#
Alain Reguera Delgado 8f60cb
# help_getOptions.sh -- This function interpretes option arguments
Alain Reguera Delgado 8f60cb
# passed to `help' functionality through the command-line and defines
Alain Reguera Delgado 8f60cb
# action names accordingly.
Alain Reguera Delgado 8f60cb
#
Alain Reguera Delgado 8f60cb
# Copyright (C) 2009-2013 The CentOS Project
Alain Reguera Delgado 8f60cb
#
Alain Reguera Delgado 8f60cb
# This program is free software; you can redistribute it and/or modify
Alain Reguera Delgado 8f60cb
# it under the terms of the GNU General Public License as published by
Alain Reguera Delgado 8f60cb
# the Free Software Foundation; either version 2 of the License, or (at
Alain Reguera Delgado 8f60cb
# your option) any later version.
Alain Reguera Delgado 8f60cb
#
Alain Reguera Delgado 8f60cb
# This program is distributed in the hope that it will be useful, but
Alain Reguera Delgado 8f60cb
# WITHOUT ANY WARRANTY; without even the implied warranty of
Alain Reguera Delgado 8f60cb
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
Alain Reguera Delgado 8f60cb
# General Public License for more details.
Alain Reguera Delgado 8f60cb
#
Alain Reguera Delgado 8f60cb
# You should have received a copy of the GNU General Public License
Alain Reguera Delgado 8f60cb
# along with this program; if not, write to the Free Software
Alain Reguera Delgado 8f60cb
# Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
Alain Reguera Delgado 8f60cb
#
Alain Reguera Delgado 8f60cb
# ----------------------------------------------------------------------
Alain Reguera Delgado 8f60cb
# $Id$
Alain Reguera Delgado 8f60cb
# ----------------------------------------------------------------------
Alain Reguera Delgado 8f60cb
Alain Reguera Delgado 8f60cb
function help_getOptions {
Alain Reguera Delgado 8f60cb
Alain Reguera Delgado 8f60cb
    # Define short options we want to support.
Alain Reguera Delgado 8f60cb
    local ARGSS="h,q"
Alain Reguera Delgado 8f60cb
Alain Reguera Delgado 8f60cb
    # Define long options we want to support.
Alain Reguera Delgado 8f60cb
    local ARGSL="help,quiet,answer-yes,read,search:,format:,edit,update-output,update-structure,copy,delete,rename,synchronize"
Alain Reguera Delgado 8f60cb
Alain Reguera Delgado 8f60cb
    # Redefine ARGUMENTS using getopt(1) command parser.
Alain Reguera Delgado 8f60cb
    cli_parseArguments
Alain Reguera Delgado 8f60cb
Alain Reguera Delgado 8f60cb
    # Reset positional parameters using output from (getopt) argument
Alain Reguera Delgado 8f60cb
    # parser.
Alain Reguera Delgado 8f60cb
    eval set -- "$ARGUMENTS"
Alain Reguera Delgado 8f60cb
Alain Reguera Delgado 8f60cb
    # Define action to take for each option passed.
Alain Reguera Delgado 8f60cb
    while true; do
Alain Reguera Delgado 8f60cb
        case "$1" in
Alain Reguera Delgado 8f60cb
Alain Reguera Delgado 8f60cb
            -h | --help )
Alain Reguera Delgado 8f60cb
                cli_runFnEnvironment help --read --format="texinfo" "tcar-fs::scripts:bash-functions-help"
Alain Reguera Delgado 8f60cb
                shift 1
Alain Reguera Delgado 8f60cb
                exit
Alain Reguera Delgado 8f60cb
                ;;
Alain Reguera Delgado 8f60cb
Alain Reguera Delgado 8f60cb
            -q | --quiet )
Alain Reguera Delgado 8f60cb
                FLAG_QUIET="true"
Alain Reguera Delgado 8f60cb
                shift 1
Alain Reguera Delgado 8f60cb
                ;;
Alain Reguera Delgado 8f60cb
Alain Reguera Delgado 8f60cb
            --answer-yes )
Alain Reguera Delgado 8f60cb
                FLAG_ANSWER="true"
Alain Reguera Delgado 8f60cb
                shift 1
Alain Reguera Delgado 8f60cb
                ;;
Alain Reguera Delgado 8f60cb
Alain Reguera Delgado 8f60cb
            --synchronize )
Alain Reguera Delgado 8f60cb
                FLAG_SYNCHRONIZE="true"
Alain Reguera Delgado 8f60cb
                shift 1
Alain Reguera Delgado 8f60cb
                ;;
Alain Reguera Delgado 8f60cb
Alain Reguera Delgado 8f60cb
            --search )
Alain Reguera Delgado 8f60cb
                ACTIONNAM="searchIndex"
Alain Reguera Delgado 8f60cb
                FLAG_SEARCH="$2"
Alain Reguera Delgado 8f60cb
                shift 2
Alain Reguera Delgado 8f60cb
                ;;
Alain Reguera Delgado 8f60cb
Alain Reguera Delgado 8f60cb
            --format )
Alain Reguera Delgado 8f60cb
                FLAG_FORMAT=$(cli_getRepoName "$2" -f)
Alain Reguera Delgado 8f60cb
                # Verify supported documentation manual formats. This
Alain Reguera Delgado 8f60cb
                # is required in order to prevent building paths to
Alain Reguera Delgado 8f60cb
                # non-existent documentation structures.
Alain Reguera Delgado 8f60cb
                if [[ ! $FLAG_FORMAT =~ '^(texinfo)$' ]];then
Alain Reguera Delgado 8f60cb
                    cli_printMessage "`gettext "The documentation format provided is not supported."`" --as-error-line
Alain Reguera Delgado 8f60cb
                fi
Alain Reguera Delgado 8f60cb
                shift 2
Alain Reguera Delgado 8f60cb
                ;;
Alain Reguera Delgado 8f60cb
Alain Reguera Delgado 8f60cb
            --read )
Alain Reguera Delgado 8f60cb
                ACTIONNAM="searchNode"
Alain Reguera Delgado 8f60cb
                shift 1
Alain Reguera Delgado 8f60cb
                ;;
Alain Reguera Delgado 8f60cb
    
Alain Reguera Delgado 8f60cb
            --edit )
Alain Reguera Delgado 8f60cb
                ACTIONNAM="editEntry"
Alain Reguera Delgado 8f60cb
                shift 1
Alain Reguera Delgado 8f60cb
                ;;
Alain Reguera Delgado 8f60cb
Alain Reguera Delgado 8f60cb
            --copy )
Alain Reguera Delgado 8f60cb
                ACTIONNAM="copyEntry"
Alain Reguera Delgado 8f60cb
                shift 1
Alain Reguera Delgado 8f60cb
                ;;
Alain Reguera Delgado 8f60cb
    
Alain Reguera Delgado 8f60cb
            --delete )
Alain Reguera Delgado 8f60cb
                ACTIONNAM="deleteEntry"
Alain Reguera Delgado 8f60cb
                shift 1
Alain Reguera Delgado 8f60cb
                ;;
Alain Reguera Delgado 8f60cb
Alain Reguera Delgado 8f60cb
            --rename )
Alain Reguera Delgado 8f60cb
                ACTIONNAM="renameEntry"
Alain Reguera Delgado 8f60cb
                shift 1
Alain Reguera Delgado 8f60cb
                ;;
Alain Reguera Delgado 8f60cb
    
Alain Reguera Delgado 8f60cb
            --update-output )
Alain Reguera Delgado 8f60cb
                ACTIONNAM="updateOutputFiles"
Alain Reguera Delgado 8f60cb
                shift 1
Alain Reguera Delgado 8f60cb
                ;;
Alain Reguera Delgado 8f60cb
Alain Reguera Delgado 8f60cb
            --update-structure )
Alain Reguera Delgado 8f60cb
                ACTIONNAM="updateStructureSection"
Alain Reguera Delgado 8f60cb
                shift 1
Alain Reguera Delgado 8f60cb
                ;;
Alain Reguera Delgado 8f60cb
Alain Reguera Delgado 8f60cb
            -- )
Alain Reguera Delgado 8f60cb
                # Remove the `--' argument from the list of arguments
Alain Reguera Delgado 8f60cb
                # in order for processing non-option arguments
Alain Reguera Delgado 8f60cb
                # correctly. At this point all option arguments have
Alain Reguera Delgado 8f60cb
                # been processed already but the `--' argument still
Alain Reguera Delgado 8f60cb
                # remains to mark ending of option arguments and
Alain Reguera Delgado 8f60cb
                # beginning of non-option arguments. The `--' argument
Alain Reguera Delgado 8f60cb
                # needs to be removed here in order to avoid
Alain Reguera Delgado 8f60cb
                # centos-art.sh script to process it as a path inside
Alain Reguera Delgado 8f60cb
                # the repository, which obviously is not.
Alain Reguera Delgado 8f60cb
                shift 1
Alain Reguera Delgado 8f60cb
                break
Alain Reguera Delgado 8f60cb
                ;;
Alain Reguera Delgado 8f60cb
        esac
Alain Reguera Delgado 8f60cb
    done
Alain Reguera Delgado 8f60cb
Alain Reguera Delgado 8f60cb
    # Redefine ARGUMENTS variable using current positional parameters. 
Alain Reguera Delgado 8f60cb
    cli_parseArgumentsReDef "$@"
Alain Reguera Delgado 8f60cb
Alain Reguera Delgado 8f60cb
}