result.h

/*
    This file is part of Cute Chess.
    Copyright (C) 2008-2018 Cute Chess authors
 
    Cute Chess 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.
 
    Cute Chess 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 Cute Chess.  If not, see <http://www.gnu.org/licenses/>.
*/
 
#ifndef RESULT_H
#define RESULT_H
 
#include "side.h"
#include <QMetaType>
#include <QCoreApplication>
 
namespace Chess {

class LIB_EXPORT Result
{
    Q_DECLARE_TR_FUNCTIONS(Result)
 
    public:
        enum Type
        {
            Win,
            Draw,
            Resignation,
            Timeout,
            Adjudication,
            IllegalMove,
            Disconnection,
            StalledConnection,
            Agreement,
            NoResult,
            ResultError
        };

        explicit Result(Type type = NoResult,
                Side winner = Side(),
                const QString& description = QString());
        explicit Result(const QString& str);

        bool operator==(const Result& other) const;
        bool operator!=(const Result& other) const;
        bool isNone() const;
        bool isDraw() const;

        Side winner() const;
        Side loser() const;

        Type type() const;
        QString description() const;
        QString toShortString() const;
        QString toVerboseString() const;
 
    private:
        Type m_type;
        Side m_winner;
        QString m_description;
};
 
} // namespace Chess
 
Q_DECLARE_METATYPE(Chess::Result)
 
#endif // RESULT_H