consolelogic.h

Go to the documentation of this file.

// © Copyright 2010 - 2016 BlackTopp Studios Inc.
/* This file is part of The Mezzanine Engine.

    The Mezzanine Engine 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 3 of the License, or
    (at your option) any later version.

    The Mezzanine Engine 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 The Mezzanine Engine.  If not, see <http://www.gnu.org/licenses/>.
*/
/* The original authors have included a copy of the license specified above in the
   'Docs' folder. See 'gpl.txt'
*/
/* We welcome the use of the Mezzanine engine to anyone, including companies who wish to
   Build professional software and charge for their product.

   However there are some practical restrictions, so if your project involves
   any of the following you should contact us and we will try to work something
   out:
    - DRM or Copy Protection of any kind(except Copyrights)
    - Software Patents You Do Not Wish to Freely License
    - Any Kind of Linking to Non-GPL licensed Works
    - Are Currently In Violation of Another Copyright Holder's GPL License
    - If You want to change our code and not add a few hundred MB of stuff to
        your distribution

   These and other limitations could cause serious legal problems if you ignore
   them, so it is best to simply contact us or the Free Software Foundation, if
   you have any questions.

   Joseph Toppi - toppij@gmail.com
   John Blackwood - makoenergy02@gmail.com
*/
#ifndef _consolelogic_h
#define _consolelogic_h

/// @file
/// @brief The definition of a few command line tools

#include "datatypes.h"

#include "testdata.h"

namespace Mezzanine
{
    namespace Testing
    {
        /// @brief Print a message for the user onf the standard output that briefly describes hwo to use this.
        /// @param ThisName The name of the current executable
        /// @param TestGroups This is searched for the current list of valid test names.
        /// @return Always returns ExitInvalidArguments
        int Usage(Mezzanine::String ThisName, CoreTestGroup& TestGroups);

        /// @brief Asked the user a question on the std output and get a TestResult as an answer
        /// @param Question The question to ask the user.
        /// @param FailStatusOnIncorrect Defaults to true,FailStatusOnIncorrect if true False answers with return Fail Status otherwise they will return Warnings.
        /// @details The following strings provide the following results.
        ///     -  "True", "Yes" as Success
        ///     -  "False", "No" as Failed or Warn
        ///     -  "Cancel" as "Canceled"
        ///     -  "Unsure", "Inconclusive" as Inconclusive
        /// @return Depends on users input
        TestResult GetTestAnswerFromStdin(Mezzanine::String Question, Boole FailStatusOnIncorrect = true);

        /// @brief Execute a command in a process, piping its standard output to a file
        /// @return The contents of the file as String
        String GetCommandResults(String Command);

        /// @brief Sleeps the current thread for an amount of microseconds.
        /// @param MicroSeconds the amount of micro seconds.
        void sleep_for(UInt32 MicroSeconds);
    }// Testing
}// Mezzanine

#endif