lyx_mirror/src/Changes.h
Michael Schmitt 038cc70650 change tracking:
introduce 'semantic' TeX commands \lyxinserted and \lyxdeleted in order to decouple change tracking
output from dvipost. Raise user warning if dvipost is not installed (i.e. no changes are shown in TeX output)


git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@18237 a592a061-630c-0410-9148-cb99ea01b6c8
2007-05-08 17:46:03 +00:00

136 lines
3.2 KiB
C++

// -*- C++ -*-
/**
* \file Changes.h
* This file is part of LyX, the document processor.
* Licence details can be found in the file COPYING.
*
* \author John Levon
* \author Michael Gerz
*
* Full author contact details are available in file CREDITS.
*
* Record changes in a paragraph.
*/
#ifndef CHANGES_H
#define CHANGES_H
#include "support/docstream.h"
#include "support/lyxtime.h"
#include <vector>
namespace lyx {
class Change {
public:
/// the type of change
enum Type {
UNCHANGED, // no change
INSERTED, // new text
DELETED // deleted text
};
explicit Change(Type t, int a = 0, time_type ct = current_time())
: type(t), author(a), changetime(ct) {}
/// is the change similar to the given change such that both can be merged?
bool isSimilarTo(Change const & change);
Type type;
int author;
time_type changetime;
};
bool operator==(Change const & l, Change const & r);
bool operator!=(Change const & l, Change const & r);
class BufferParams;
class Changes {
public:
/// set the pos to the given change
void set(Change const & change, pos_type pos);
/// set the range (excluding end) to the given change
void set(Change const & change, pos_type start, pos_type end);
/// erase the entry at pos and adjust all range bounds past it
/// (assumes that a character was deleted at pos)
void erase(lyx::pos_type pos);
/// insert a new entry at pos and adjust all range bounds past it
/// (assumes that a character was inserted at pos)
void insert(Change const & change, lyx::pos_type pos);
///
/// return the change at the given pos
Change const & lookup(pos_type pos) const;
/// return true if there is a change in the given range (excluding end)
bool isChanged(pos_type start, pos_type end) const;
///
/// output latex to mark a transition between two change types
/// returns length of text outputted
static int latexMarkChange(odocstream & os, BufferParams const & bparams,
Change const & oldChange, Change const & change);
/// output .lyx file format for transitions between changes
static void lyxMarkChange(std::ostream & os, int & column,
Change const & old, Change const & change);
private:
class Range {
public:
Range(pos_type s, pos_type e)
: start(s), end(e) {}
// does this range contain r ? (inlined as the result of profiling)
bool contains(Range const & r) const {
return r.start >= start && r.end <= end;
}
// does this range contain pos ? (inlined as the result of profiling)
bool contains(pos_type pos) const {
return pos >= start && pos < end;
}
// do the ranges intersect ?
bool intersects(Range const & r) const;
pos_type start;
pos_type end; // Caution: end is not in the range!
};
friend bool operator==(Range const & r1, Range const & r2);
friend bool operator!=(Range const & r1, Range const & r2);
class ChangeRange {
public:
ChangeRange(Change const & c, Range const & r)
: change(c), range(r) {}
Change change;
Range range;
};
/// merge equal changes with adjoining ranges
void merge();
typedef std::vector<ChangeRange> ChangeTable;
/// table of changes, every row a change and range descriptor
ChangeTable table_;
};
} // namespace lyx
#endif // CHANGES_H