// TortoiseMerge - a Diff/Patch program

// Copyright (C) 2006-2007, 2012-2016, 2019, 2021 - 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
#include "EOL.h"
#include <deque>
#include <regex>

// A template class to make an array which looks like a CStringArray or CDWORDArray but
// is in fact based on a STL vector, which is much faster at large sizes
template <typename T>
class CStdArrayV
{
public:
    int      GetCount() const { return static_cast<int>(m_vec.size()); }
    const T& GetAt(int index) const { return m_vec[index]; }
    void     RemoveAt(int index) { m_vec.erase(m_vec.begin() + index); }
    void     InsertAt(int index, const T& strVal) { m_vec.insert(m_vec.begin() + index, strVal); }
    void     InsertAt(int index, const T& strVal, int nCopies) { m_vec.insert(m_vec.begin() + index, nCopies, strVal); }
    void     SetAt(int index, const T& strVal) { m_vec[index] = strVal; }
    void     Add(const T& strVal)
    {
        if (m_vec.size() == m_vec.capacity())
        {
            m_vec.reserve(m_vec.capacity() ? m_vec.capacity() * 2 : 256);
        }
        m_vec.push_back(strVal);
    }
    void RemoveAll() { m_vec.clear(); }
    void Reserve(int nHintSize) { m_vec.reserve(nHintSize); }

private:
    std::vector<T> m_vec;
};

// A template class to make an array which looks like a CStringArray or CDWORDArray but
// is in fact based on a STL deque, which is much faster at large sizes
template <typename T>
class CStdArrayD
{
public:
    int      GetCount() const { return static_cast<int>(m_vec.size()); }
    const T& GetAt(int index) const { return m_vec[index]; }
    void     RemoveAt(int index) { m_vec.erase(m_vec.begin() + index); }
    void     InsertAt(int index, const T& strVal) { m_vec.insert(m_vec.begin() + index, strVal); }
    void     InsertAt(int index, const T& strVal, int nCopies) { m_vec.insert(m_vec.begin() + index, nCopies, strVal); }
    void     SetAt(int index, const T& strVal) { m_vec[index] = strVal; }
    void     Add(const T& strVal) { m_vec.push_back(strVal); }
    void     RemoveAll() { m_vec.clear(); }

private:
    std::deque<T> m_vec;
};

using CStdDWORDArray = CStdArrayV<DWORD>;

struct CFileTextLine
{
    CString sLine;
    EOL     eEnding;
};

using CStdFileLineArray = CStdArrayD<CFileTextLine>;

/**
 * \ingroup TortoiseMerge
 *
 * Represents an array of text lines which are read from a file.
 * This class is also responsible for determining the encoding of
 * the file (e.g. UNICODE(UTF16), UTF8, ASCII, ...).
 */
class CFileTextLines : public CStdFileLineArray
{
public:
    CFileTextLines();
    ~CFileTextLines();

    enum UnicodeType
    {
        AUTOTYPE,
        BINARY,
        ASCII,
        UTF16_LE,    //=1200,
        UTF16_BE,    //=1201,
        UTF16_LEBOM, //=1200,
        UTF16_BEBOM, //=1201,
        UTF32_LE,    //=12000,
        UTF32_BE,    //=12001,
        UTF8,        //=65001,
        UTF8BOM,     //=UTF8+65536,
    };

    struct SaveParams
    {
        UnicodeType unicodeType;
        EOL         lineEndings;
    };

    /**
     * Loads the text file and adds each line to the array
     * \param sFilePath the path to the file
     * \param lengthHint hint to create line array
     */
    BOOL Load(const CString& sFilePath, int lengthHint = 0);
    /**
     * Saves the whole array of text lines to a file, preserving
     * the line endings detected at Load()
     * \param sFilePath the path to save the file to
     * \param bSaveAsUTF8 enforce encoding for save
     * \param bUseSVNCompatibleEOLs limit EOLs to CRLF, CR and LF, last one is used instead of all others
     * \param dwIgnoreWhitespaces "enum" mode of removing whitespaces
     * \param bIgnoreCase converts whole file to lower case
     * \param bBlame limit line len
     */
    BOOL Save(const CString&      sFilePath,
              bool                bSaveAsUTF8           = false,
              bool                bUseSVNCompatibleEOLs = false,
              DWORD               dwIgnoreWhitespaces   = 0,
              BOOL                bIgnoreCase           = FALSE,
              bool                bBlame                = false,
              bool                bIgnoreComments       = false,
              const CString&      lineStart             = CString(),
              const CString&      blockStart            = CString(),
              const CString&      blockEnd              = CString(),
              const std::wregex&  rx                    = std::wregex(),
              const std::wstring& replacement           = L"");
    /**
     * Returns an error string of the last failed operation
     */
    CString GetErrorString() const { return m_sErrorString; }
    /**
     * Copies the settings of a file like the line ending styles
     * to another CFileTextLines object.
     */
    void CopySettings(CFileTextLines* pFileToCopySettingsTo) const;

    bool        NeedsConversion() const { return m_bNeedsConversion; }
    UnicodeType GetUnicodeType() const { return m_saveParams.unicodeType; }
    EOL         GetLineEndings() const { return m_saveParams.lineEndings; }

    void Add(const CString& sLine, EOL ending)
    {
        CFileTextLine temp = {sLine, ending};
        CStdFileLineArray::Add(temp);
    }
    void InsertAt(int index, const CString& strVal, EOL ending)
    {
        CFileTextLine temp = {strVal, ending};
        CStdFileLineArray::InsertAt(index, temp);
    }

    const CString& GetAt(int index) const { return CStdFileLineArray::GetAt(index).sLine; }
    EOL            GetLineEnding(int index) const { return CStdFileLineArray::GetAt(index).eEnding; }
    void           SetSaveParams(const SaveParams& sp) { m_saveParams = sp; }
    SaveParams     GetSaveParams() const { return m_saveParams; }
    void           KeepEncoding(bool bKeep = true) { m_bKeepEncoding = bKeep; }
    //void            SetLineEnding(int index, EOL ending) { CStdFileLineArray::GetAt(index).eEnding = ending; }

    static const wchar_t* GetEncodingName(UnicodeType);

private:
    /**
     * Checks the Unicode type in a text buffer
     * \param pBuffer pointer to the buffer containing text
     * \param cb size of the text buffer in bytes
     */
    static UnicodeType CheckUnicodeType(LPVOID pBuffer, int cb);

    void SetErrorString();

    static void StripWhiteSpace(CString& sLine, DWORD dwIgnoreWhitespaces, bool blame);
    bool        StripComments(CString& sLine, bool bInBlockComment) const;
    static bool IsInsideString(const CString& sLine, int pos);
    void        LineRegex(CString& sLine, const std::wregex& rx, const std::wstring& replacement) const;

private:
    CString    m_sErrorString;
    bool       m_bNeedsConversion;
    bool       m_bKeepEncoding;
    SaveParams m_saveParams;
    CString    m_sCommentLine;
    CString    m_sCommentBlockStart;
    CString    m_sCommentBlockEnd;
};

class CBuffer
{
public:
    CBuffer() { Init(); }
    CBuffer(const CBuffer& src)
    {
        Init();
        Copy(src);
    }
    CBuffer(const CBuffer* const src)
    {
        Init();
        Copy(*src);
    }
    ~CBuffer() { Free(); }

    CBuffer& operator=(const CBuffer& src)
    {
        Copy(src);
        return *this;
    }

    operator bool() const { return !IsEmpty(); }
    template <typename T>
    operator T() const { return reinterpret_cast<T>(m_pBuffer); }

    void Clear() { m_nUsed = 0; }
    void ExpandToAtLeast(int nNewSize);
    int  GetLength() const { return m_nUsed; }
    bool IsEmpty() const { return GetLength() == 0; }
    void SetLength(int nUsed);
    void Swap(CBuffer& src);

private:
    void Copy(const CBuffer& src);
    void Free() const { delete[] m_pBuffer; }
    void Init()
    {
        m_pBuffer    = nullptr;
        m_nUsed      = 0;
        m_nAllocated = 0;
    }

    BYTE* m_pBuffer;
    int   m_nUsed;
    int   m_nAllocated;
};

class CBaseFilter
{
public:
    CBaseFilter(CStdioFile* pFile)
    {
        m_pFile     = pFile;
        m_nCodePage = 0;
    }
    virtual ~CBaseFilter() {}

    virtual bool           Decode(/*in out*/ CBuffer& s);
    virtual const CBuffer& Encode(const CString& data);
    const CBuffer&         GetBuffer() const { return m_oBuffer; }
    void                   Write(const CString& s) { Write(Encode(s)); } ///< encode into buffer and write
    void                   Write() { Write(m_oBuffer); }                 ///< write preencoded internal buffer
    void                   Write(const CBuffer& buffer);                 ///< write preencoded buffer

protected:
    CBuffer m_oBuffer;
    /**
        Code page for WideCharToMultiByte.
    */
    UINT m_nCodePage;

private:
    CStdioFile* m_pFile;
};

class CAsciiFilter : public CBaseFilter
{
public:
    CAsciiFilter(CStdioFile* pFile)
        : CBaseFilter(pFile)
    {
        m_nCodePage = CP_ACP;
    }
    ~CAsciiFilter() override {}
};

class CUtf8Filter : public CBaseFilter
{
public:
    CUtf8Filter(CStdioFile* pFile)
        : CBaseFilter(pFile)
    {
        m_nCodePage = CP_UTF8;
    }
    ~CUtf8Filter() override {}
};

class CUtf16LeFilter : public CBaseFilter
{
public:
    CUtf16LeFilter(CStdioFile* pFile)
        : CBaseFilter(pFile)
    {
    }
    ~CUtf16LeFilter() override {}

    bool           Decode(/*in out*/ CBuffer& data) override;
    const CBuffer& Encode(const CString& s) override;
};

class CUtf16BeFilter : public CUtf16LeFilter
{
public:
    CUtf16BeFilter(CStdioFile* pFile)
        : CUtf16LeFilter(pFile)
    {
    }
    ~CUtf16BeFilter() override {}

    bool           Decode(/*in out*/ CBuffer& data) override;
    const CBuffer& Encode(const CString& s) override;
};

class CUtf32LeFilter : public CBaseFilter
{
public:
    CUtf32LeFilter(CStdioFile* pFile)
        : CBaseFilter(pFile)
    {
    }
    ~CUtf32LeFilter() override {}

    bool           Decode(/*in out*/ CBuffer& data) override;
    const CBuffer& Encode(const CString& s) override;
};

class CUtf32BeFilter : public CUtf32LeFilter
{
public:
    CUtf32BeFilter(CStdioFile* pFile)
        : CUtf32LeFilter(pFile)
    {
    }
    ~CUtf32BeFilter() override {}

    bool           Decode(/*in out*/ CBuffer& data) override;
    const CBuffer& Encode(const CString& s) override;
};
