lyx_mirror/src/Changes.h

168 lines
4.1 KiB
C
Raw Normal View History

// -*- 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 "Color.h"
#include "support/docstream.h"
#include "support/strfwd.h"
#include "support/types.h"
#include "support/lyxtime.h"
#include <vector>
namespace lyx {
class AuthorList;
class Buffer;
class DocIterator;
class OutputParams;
class Change {
public:
/// the type of change
enum Type {
UNCHANGED, // no change
INSERTED, // new text
DELETED // deleted text
};
explicit Change(Type t = UNCHANGED, int a = 0, time_t ct = support::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) const;
/// The color of this change on screen
Color color() const;
///
bool changed() const { return type != UNCHANGED; }
///
void setUnchanged() { type = UNCHANGED; }
///
bool inserted() const { return type == INSERTED; }
///
void setInserted() { type = INSERTED; }
///
bool deleted() const { return type == DELETED; }
///
void setDeleted() { type = DELETED; }
/// Is this change made by the current author ?
bool currentAuthor() const { return author == 0; }
Type type;
int author;
time_t 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;
/// return true if the whole range is deleted
bool isDeleted(pos_type start, pos_type end) const;
/// output latex to mark a transition between two change types
/// returns length of text outputted
Introduce a wrapper class for odocstream to help ensuring that no blank lines may be inadvertently output. This is achieved by using two special iomanip-like variables (breakln and safebreakln) in the lyx:: namespace. When they are inserted in the stream, a newline is output only if not already at the beginning of a line. The difference between breakln and safebreakln is that, if needed, the former outputs '\n' and the latter "%\n". In future, the new class will also be used for counting the number of newlines issued. Even if the infractrure for doing that is already in place, the counting is essentially still done the old way. There are still places in the code where the functionality of the class could be used, most probably. ATM, it is used for InsetTabular, InsetListings, InsetFloat, and InsetText. The Comment and GreyedOut insets required a special treatment and a new InsetLayout parameter (Display) has been introduced. The default for Display is "true", meaning that the corresponding latex environment is of "display" type, i.e., it stands on its own, whereas "false" means that the contents appear inline with the text. The latter is the case for both Comment and GreyedOut insets. Mostly, the only visible effects on latex exports should be the disappearing of some redundant % chars and the appearing/disappearing of null {} latex groups after a comment or lyxgreyedout environments (they are related to the presence or absence of a space immediately after those environments), as well as the fact that math environments are now started on their own lines. As a last thing, only the latex code between \begin{document} and \end{document} goes through the new class, the preamble being directly output through odocstream, as usual. git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@37360 a592a061-630c-0410-9148-cb99ea01b6c8
2011-01-29 02:41:13 +00:00
static int latexMarkChange(otexstream & os, BufferParams const & bparams,
Change const & oldChange, Change const & change,
OutputParams const & runparams);
/// output .lyx file format for transitions between changes
static void lyxMarkChange(std::ostream & os, BufferParams const & bparams,
int & column, Change const & old, Change const & change);
///
void checkAuthors(AuthorList const & authorList);
///
void addToToc(DocIterator const & cdit, Buffer const & buffer) const;
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