src/Changes.h

   1 // -*- C++ -*-
   2 /**
   3  * \file Changes.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author John Levon
   8  * \author Michael Gerz
   9  *
  10  * Full author contact details are available in file CREDITS.
  11  *
  12  * Record changes in a paragraph.
  13  */
  14
  15 #ifndef CHANGES_H
  16 #define CHANGES_H
  17
  18 #include "Color.h"
  19
  20 #include "support/strfwd.h"
  21 #include "support/types.h"
  22 #include "support/lyxtime.h"
  23
  24 #include <vector>
  25
  26
  27 namespace lyx {
  28
  29 class AuthorList;
  30 class Buffer;
  31 class DocIterator;
  32
  33 class Change {
  34 public:
  35         /// the type of change
  36         enum Type {
  37                 UNCHANGED, // no change
  38                 INSERTED, // new text
  39                 DELETED // deleted text
  40         };
  41
  42         explicit Change(Type t = UNCHANGED, int a = 0, time_t ct = current_time())
  43                 : type(t), author(a), changetime(ct) {}
  44
  45         /// is the change similar to the given change such that both can be merged?
  46         bool isSimilarTo(Change const & change) const;
  47         /// The color of this change on screen
  48         Color color() const;
  49         ///
  50         bool changed() const { return type != UNCHANGED; }
  51         ///
  52         void setUnchanged() { type = UNCHANGED; }
  53         ///
  54         bool inserted() const { return type == INSERTED; }
  55         ///
  56         void setInserted() { type = INSERTED; }
  57         ///
  58         bool deleted() const { return type == DELETED; }
  59         ///
  60         void setDeleted() { type = DELETED; }
  61         /// Is this change made by the current author ?
  62         bool currentAuthor() const { return author == 0; }
  63
  64         Type type;
  65
  66         int author;
  67
  68         time_t changetime;
  69 };
  70
  71 bool operator==(Change const & l, Change const & r);
  72 bool operator!=(Change const & l, Change const & r);
  73
  74 class BufferParams;
  75
  76 class Changes {
  77 public:
  78         /// set the pos to the given change
  79         void set(Change const & change, pos_type pos);
  80         /// set the range (excluding end) to the given change
  81         void set(Change const & change, pos_type start, pos_type end);
  82
  83         /// erase the entry at pos and adjust all range bounds past it
  84         /// (assumes that a character was deleted at pos)
  85         void erase(lyx::pos_type pos);
  86
  87         /// insert a new entry at pos and adjust all range bounds past it
  88         /// (assumes that a character was inserted at pos)
  89         void insert(Change const & change, lyx::pos_type pos);
  90
  91         ///
  92
  93         /// return the change at the given pos
  94         Change const & lookup(pos_type pos) const;
  95
  96         /// return true if there is a change in the given range (excluding end)
  97         bool isChanged(pos_type start, pos_type end) const;
  98
  99         /// return true if the whole range is deleted
 100         bool isFullyDeleted(pos_type const start, pos_type const end) const;
 101
 102         /// output latex to mark a transition between two change types
 103         /// returns length of text outputted
 104         static int latexMarkChange(odocstream & os, BufferParams const & bparams,
 105                                    Change const & oldChange, Change const & change);
 106
 107         /// output .lyx file format for transitions between changes
 108         static void lyxMarkChange(std::ostream & os, BufferParams const & bparams,
 109                 int & column, Change const & old, Change const & change);
 110
 111         ///
 112         void checkAuthors(AuthorList const & authorList);
 113
 114         ///
 115         void addToToc(DocIterator const & cdit, Buffer const & buffer) const;
 116
 117 private:
 118         class Range {
 119         public:
 120                 Range(pos_type s, pos_type e)
 121                         : start(s), end(e) {}
 122
 123                 // does this range contain r ? (inlined as the result of profiling)
 124                 bool contains(Range const & r) const {
 125                         return r.start >= start && r.end <= end;
 126                 }
 127
 128                 // does this range contain pos ? (inlined as the result of profiling)
 129                 bool contains(pos_type pos) const {
 130                         return pos >= start && pos < end;
 131                 }
 132
 133                 // do the ranges intersect ?
 134                 bool intersects(Range const & r) const;
 135
 136                 pos_type start;
 137                 pos_type end; // Caution: end is not in the range!
 138         };
 139
 140         friend bool operator==(Range const & r1, Range const & r2);
 141         friend bool operator!=(Range const & r1, Range const & r2);
 142
 143         class ChangeRange {
 144         public:
 145                 ChangeRange(Change const & c, Range const & r)
 146                         : change(c), range(r) {}
 147
 148                 Change change;
 149                 Range range;
 150         };
 151
 152         /// merge equal changes with adjoining ranges
 153         void merge();
 154
 155         typedef std::vector<ChangeRange> ChangeTable;
 156
 157         /// table of changes, every row a change and range descriptor
 158         ChangeTable table_;
 159 };
 160
 161
 162 } // namespace lyx
 163
 164 #endif // CHANGES_H