/////////////////////////////////////////////////////////////////////////////
// License (GPLv2+):
// 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, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
/////////////////////////////////////////////////////////////////////////////
/**
* @file DiffList.h
*
* @brief Declaration file for DiffList class
*/
// RCS ID line follows -- this is updated by CVS
// $Id: DiffList.h,v 1.10 2006/05/24 20:14:04 kimmov Exp $
#ifndef _DIFFLIST_H_
#define _DIFFLIST_H_
/**
* @brief One difference defined by linenumbers.
*
* This struct defines one set of different lines "diff".
* @p begin0, @p end0, @p begin1 & @p end1 are linenumbers
* in original files. Other struct members point to linenumbers
* calculated by WinMerge after adding empty lines to make diffs
* be in line in screen.
*
* @note @p blank0 & @p blank1 are -1 if there are no blank lines
*/
struct DIFFRANGE
{
UINT begin0; /**< First diff line in original file1 */
UINT end0; /**< Last diff line in original file1 */
UINT begin1; /**< First diff line in original file2 */
UINT end1; /**< Last diff line in original file2 */
UINT dbegin0; /**< Synchronised (ghost lines added) first diff line in file1 */
UINT dend0; /**< Synchronised (ghost lines added) last diff line in file1 */
UINT dbegin1; /**< Synchronised (ghost lines added) first diff line in file2 */
UINT dend1; /**< Synchronised (ghost lines added) last diff line in file2 */
int blank0; /**< Number of blank lines in file1 */
int blank1; /**< Number of blank lines in file2 */
BYTE op; /**< Operation done with this diff */
DIFFRANGE() { memset(this, 0, sizeof(*this)); }
};
/**
* @brief DIFFRANGE with links for chain of non-trivial entries
*
* Next and prev are array indices used by the owner (DiffList)
*/
struct DiffRangeInfo
{
DIFFRANGE diffrange;
int next; /**< link (array index) for doubly-linked chain of non-trivial DIFFRANGEs */
int prev; /**< link (array index) for doubly-linked chain of non-trivial DIFFRANGEs */
DiffRangeInfo() { InitLinks(); }
DiffRangeInfo(const DIFFRANGE & di) : diffrange(di) { InitLinks(); }
void InitLinks() { next = prev = -1; }
};
/**
* @brief Operations in diffranges.
* DIFFRANGE structs op-member can have these values
*/
enum
{
OP_NONE = 0,
OP_LEFTONLY,
OP_DIFF,
OP_RIGHTONLY,
OP_TRIVIAL
};
/**
* @brief Class for storing differences in files (difflist).
*
* This class stores diffs in list and also offers diff-related
* functions to e.g. check if linenumber is inside diff.
*
* There are two kinds of diffs:
* - significant diffs are 'normal' diffs we want to merge and browse
* - non-significant diffs are diffs ignored by linefilters
*/
class DiffList
{
public:
DiffList();
void Clear();
int GetSize() const;
int GetSignificantDiffs() const;
void AddDiff(const DIFFRANGE & di);
BOOL IsDiffSignificant(int nDiff) const;
BOOL GetDiff(int nDiff, DIFFRANGE & di) const;
BOOL SetDiff(int nDiff, const DIFFRANGE & di);
int LineRelDiff(UINT nLine, UINT nDiff) const;
BOOL LineInDiff(UINT nLine, UINT nDiff) const;
int LineToDiff(UINT nLine) const;
BOOL GetPrevDiff(int nLine, int & nDiff) const;
BOOL GetNextDiff(int nLine, int & nDiff) const;
BOOL HasSignificantDiffs() const;
int PrevSignificantDiffFromLine(UINT nLine) const;
int NextSignificantDiffFromLine(UINT nLine) const;
int FirstSignificantDiff() const;
int NextSignificantDiff(int nDiff) const;
int PrevSignificantDiff(int nDiff) const;
int LastSignificantDiff() const;
const DIFFRANGE * FirstSignificantDiffRange() const;
const DIFFRANGE * LastSignificantDiffRange() const;
const DIFFRANGE * DiffRangeAt(int nDiff) const;
void ConstructSignificantChain(); // must be called after diff list is entirely populated
void Swap();
void GetExtraLinesCounts(int &nLeftLines, int &nRightLines);
private:
CArray<DiffRangeInfo,DiffRangeInfo> m_diffs; /**< Difference list */
int m_firstSignificant; /**< Index of first significant diff in m_diffs */
int m_lastSignificant; /**< Index of last significant diff in m_diffs */
};
#endif // _DIFFLIST_H_
