#ifndef PatternLocation_h
#define PatternLocation_h

/******************************************************************************
*
* Copyright (C) 2002 Hugo PEREIRA <mailto: hugo.pereira@free.fr>
*
* This 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 software 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, see <http://www.gnu.org/licenses/>.
*
*******************************************************************************/

#include "Counter.h"
#include "HighlightPattern.h"
#include "QOrderedSet.h"
#include "TextFormat.h"

#include <QTextCharFormat>

//* encapsulate highlight location, pattern and style
class PatternLocation final: private Base::Counter<PatternLocation>
{
    public:


    using SetIterator = QOrderedSetIterator<PatternLocation>;

    //* construtor
    explicit PatternLocation();

    //* constructor
    explicit PatternLocation( const HighlightPattern&, int, int );

    //*@name accessors
    //@{

    //* valid
    bool isValid() const
    { return id_ >= 0 && position_ >= 0 && length_ > 0; }

    //* position
    int position() const
    { return position_; }

    //* length
    int length() const
    { return length_; }


    //* pattern id
    int id() const
    { return id_; }

    //* parent pattern id
    int parentId() const
    { return parentId_; }

    //* flags
    HighlightPattern::Flags flags() const
    { return flags_; }

    //* flags
    bool hasFlag( const HighlightPattern::Flag& flag ) const
    { return flags() & flag; }

    //* format
    Format::TextFormatFlags fontFormat() const
    { return format_; }

    //* color
    QColor color() const
    { return color_; }

    //* formated font
    QTextCharFormat format() const;

    //@}

    //* used to find a location matching index
    class ContainsFTor
    {

        public:

        //* constructor
        explicit ContainsFTor( int index ):
            index_( index )
        {}

        //* prediction
        bool operator() (const PatternLocation& location ) const
        {
            return
                index_ >= location.position() &&
                index_ < location.position()+int(location.length());
        }

        private:

        //* predicted index
        int index_;

    };

    // overlaps
    class OverlapFTor
    {

        public:

        //* predicate
        bool operator() (const PatternLocation& first, const PatternLocation& second )
        { return second.position() < first.position() + (int)first.length(); }

    };

    //@}

    private:

    //* pattern id
    int id_ = 0;

    //* pattern parent id
    int parentId_ = 0;

    //* pattern flags
    HighlightPattern::Flags flags_ = 0;

    //* style font format
    Format::TextFormatFlags format_ = 0;

    //* style color
    QColor color_;

    //* position in text
    int position_ = 0;

    //* length of the pattern
    int length_ = 0;

    //* dump
    friend QTextStream& operator << (QTextStream& out, const PatternLocation& location )
    {
        out << "id: " << location.id() << " parent id:" << location.parentId() << " position: " << location.position() << " length: " << location.length() ;
        return out;
    }

};

//* less than operator
inline bool operator < (const PatternLocation& first, const PatternLocation& second)
{
    return
        (first.position() < second.position()) ||
        (first.position() == second.position() && first.parentId() < second.parentId() ) ;
}

//* equal to operator
inline bool operator == (const PatternLocation& first, const PatternLocation& second)
{ return first.position() == second.position() && first.parentId() == second.parentId(); }

#endif