// TortoiseSVN - a Windows shell extension for easy version control

// Copyright (C) 2007-2008, 2011-2012, 2015-2016 - TortoiseSVN

// 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,
// 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
//
#pragma once

///////////////////////////////////////////////////////////////
// base class and member includes
///////////////////////////////////////////////////////////////

#include "ILogIterator.h"

#include "../Containers/DictionaryBasedTempPath.h"
#include "../Containers/CachedLogInfo.h"

///////////////////////////////////////////////////////////////
// begin namespace LogCache
///////////////////////////////////////////////////////////////

namespace LogCache
{


/**
 * Iterator for log entries.
 */
class CLogIteratorBase : public ILogIterator
{
protected:

    // data source

    const CRevisionInfoContainer& revisionInfo;
    const CRevisionIndex& revisionIndices;
    const CSkipRevisionInfo& skipRevisionInfo;

    // just enough to describe our position
    // and what we are looking for

    revision_t revision;
    CDictionaryBasedTempPath path;
    revision_t copyfromrevision;

    // last position before we hit the last copy operation

    revision_t addRevision;
    CDictionaryBasedTempPath addPath;

    // construction
    // (copy construction & assignment use default methods)

    CLogIteratorBase ( const CCachedLogInfo* cachedLog
                     , revision_t startRevision
                     , const CDictionaryBasedTempPath& startPath);

    // implement copy-history following strategy

    virtual bool HandleCopyAndDelete() = 0;

    // react on cache updates

    void HandleCacheUpdates();

    // do we have data for that revision?

    bool InternalDataIsMissing() const;

    // comparison methods

    static bool PathInRevision
        ( const CRevisionInfoContainer::CChangesIterator& first
        , const CRevisionInfoContainer::CChangesIterator& last
        , const CDictionaryBasedTempPath& path);

    bool PathInRevision() const;

    // utilities for efficient HandleCopyAndDelete() implementation

    // any HandleCopyAndDelete() entries in that revision?

    static bool ContainsCopyOrDelete
        ( const CRevisionInfoContainer::CChangesIterator& first
        , const CRevisionInfoContainer::CChangesIterator& last);

    // return true, searchPath / searchRevision have been modified

    bool InternalHandleCopyAndDelete
        ( const CRevisionInfoContainer::CChangesIterator& first
        , const CRevisionInfoContainer::CChangesIterator& last
        , const CDictionaryBasedPath& revisionRootPath);

    // log scanning sub-routines

    revision_t SkipNARevisions();
    void ToNextRevision();

    // log scanning

    void AdvanceOneStep();
    void InternalAdvance (revision_t last);

public:

    // destruction

    virtual ~CLogIteratorBase(void);

    // provide custom assignment operator to silence C4512

    CLogIteratorBase& operator=(const CLogIteratorBase& rhs);

    // implement ILogIterator

    virtual bool DataIsMissing() const override;
    virtual revision_t GetRevision() const override;
    virtual revision_t GetAddRevision() const override;
    virtual revision_t GetCopyFromRevision() const;
    virtual const CDictionaryBasedTempPath& GetPath() const override;
    virtual const CDictionaryBasedTempPath& GetAddPath() const override;
    virtual bool EndOfPath() const override;

    virtual void Advance (revision_t last = 0) override;
    virtual void ToNextAvailableData() override;

    virtual void Retry (revision_t last = 0) override;

    virtual void SetRevision (revision_t r) override;
    virtual void SetPath (const CDictionaryBasedTempPath& p) override;
};

///////////////////////////////////////////////////////////////
// do we have data for that revision?
///////////////////////////////////////////////////////////////

inline bool CLogIteratorBase::InternalDataIsMissing() const
{
    index_t index = revisionIndices[revision];
    return (index == NO_INDEX)
        || (0 == (  revisionInfo.GetPresenceFlags(index)
                  & CRevisionInfoContainer::HAS_CHANGEDPATHS));
}

///////////////////////////////////////////////////////////////
// implement ILogIterator
///////////////////////////////////////////////////////////////

inline revision_t CLogIteratorBase::GetRevision() const
{
    return revision;
}

inline revision_t CLogIteratorBase::GetCopyFromRevision() const
{
    return copyfromrevision;
}

inline revision_t CLogIteratorBase::GetAddRevision() const
{
    return addRevision;
}

inline const CDictionaryBasedTempPath& CLogIteratorBase::GetPath() const
{
    return path;
}

inline const CDictionaryBasedTempPath& CLogIteratorBase::GetAddPath() const
{
    return addPath;
}

inline bool CLogIteratorBase::EndOfPath() const
{
    return (revision == NO_REVISION);
}

inline void CLogIteratorBase::SetRevision (revision_t r)
{
    this->revision = r;
}

///////////////////////////////////////////////////////////////
// end namespace LogCache
///////////////////////////////////////////////////////////////

}