/*
 * Copyright (c) 2012 Maciej Niedzielski
 * Licensed under the simplified BSD license.
 * See Documentation/Licenses/BSD-simplified.txt for more information.
 */

/*
 * Copyright (c) 2014-2015 Isode Limited.
 * All rights reserved.
 * See the COPYING file for more information.
 */

#pragma once

#include <string>

#include <boost/archive/text_iarchive.hpp>
#include <boost/archive/text_oarchive.hpp>

namespace Swift {

    class HighlightRule;

    class HighlightAction {
        public:
            HighlightAction() : highlightWholeMessage_(false), playSound_(false) {}

            /**
            * Gets the flag that indicates the entire message should be highlighted.
            */
            bool highlightWholeMessage() const { return highlightWholeMessage_; }
            void setHighlightWholeMessage(bool highlightText);

            /**
            * Gets the foreground highlight color.
            */
            const std::string& getTextColor() const { return textColor_; }
            void setTextColor(const std::string& textColor) { textColor_ = textColor; }

            /**
            * Gets the background highlight color.
            */
            const std::string& getTextBackground() const { return textBackground_; }
            void setTextBackground(const std::string& textBackground) { textBackground_ = textBackground; }

            bool playSound() const { return playSound_; }
            void setPlaySound(bool playSound);

            /**
            * Gets the sound filename. If the string is empty, assume a default sound file.
            */
            const std::string& getSoundFile() const { return soundFile_; }
            void setSoundFile(const std::string& soundFile) { soundFile_ = soundFile; }

            bool isEmpty() const { return !highlightWholeMessage_ && !playSound_; }

        private:
            friend class boost::serialization::access;
            template<class Archive> void serialize(Archive & ar, const unsigned int version);

            bool highlightWholeMessage_;
            std::string textColor_;
            std::string textBackground_;

            bool playSound_;
            std::string soundFile_;
    };

    bool operator ==(HighlightAction const& a, HighlightAction const& b);
    bool operator !=(HighlightAction const& a, HighlightAction const& b);

    template<class Archive>
    void HighlightAction::serialize(Archive& ar, const unsigned int /*version*/)
    {
        ar & highlightWholeMessage_;
        ar & textColor_;
        ar & textBackground_;
        ar & playSound_;
        ar & soundFile_;
    }

}