CommandEvaluation.h

Go to the documentation of this file.

/*
 *   ORXONOX - the hottest 3D action shooter ever to exist
 *                    > www.orxonox.net <
 *
 *
 *   License notice:
 *
 *   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., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 *
 *   Author:
 *      Fabian 'x3n' Landau
 *   Co-authors:
 *      ...
 *
 */

#ifndef _CommandEvaluation_H__
#define _CommandEvaluation_H__

#include "core/CorePrereqs.h"

#include <string>

#include "util/SubString.h"
#include "util/MultiType.h"
#include "ArgumentCompletionListElement.h"
#include "Functor.h"

namespace orxonox
{
    class _CoreExport CommandEvaluation
    {
        friend class CommandExecutor;

        public:
            CommandEvaluation();

            int execute();
            MultiType query(int* error = nullptr);

            std::string complete();
            std::string hint();

            std::string getCommandSuggestion() const;

            int evaluateArguments(bool bPrintError = false);

            inline bool isValid() const
                { return (this->execCommand_ != nullptr); }

            inline const ConsoleCommand* getConsoleCommand() const
                { return this->execCommand_; }

            void setEvaluatedArgument(unsigned int index, const MultiType& arg);
            MultiType getEvaluatedArgument(unsigned int index) const;

            const ArgumentCompletionList& getPossibleArguments() const
                { return this->possibleArguments_; }

            size_t getPossibleArgumentsSize() const
                { return CommandEvaluation::getSize(this->possibleArguments_); }

        private:
            void initialize(const std::string& command);

            unsigned int getNumberOfArguments() const;
            const std::string& getLastArgument() const;
            const std::string& getToken(unsigned int i) const;

            void retrievePossibleArguments();

            static void strip(ArgumentCompletionList& list, const std::string& fragment);
            static size_t getSize(const ArgumentCompletionList& list);

            static std::string dump(const ArgumentCompletionList& list);
            static std::string dump(const ConsoleCommand* command);

            static std::string getCommonBegin(const ArgumentCompletionList& list);

            const ConsoleCommand* execCommand_;             
            const ConsoleCommand* hintCommand_;             
            SubString tokens_;                              
            std::string string_;                            
            unsigned int execArgumentsOffset_;              
            unsigned int hintArgumentsOffset_;              
            bool bPossibleArgumentsRetrieved_;              
            ArgumentCompletionList possibleArguments_;      

            bool bEvaluatedArguments_;                      
            bool bTriedToEvaluatedArguments_;               
            unsigned int numberOfEvaluatedArguments_;       
            MultiType arguments_[MAX_FUNCTOR_ARGUMENTS];    
    };
}

#endif /* _CommandEvaluation_H__ */