gettext support, fast_start option, scons all, mingw bug fix and some cleanup for...

[lyx.git] / src / changes.h

diff --git a/src/changes.h b/src/changes.h
index ac378e59257916c61ee55c2b3e56b8a37224b0e8..dabfdf80e818293eeb4689fa6f23cc97677890e8 100644 (file)
--- a/src/changes.h
+++ b/src/changes.h
@@ -1,11 +1,14 @@
+// -*- C++ -*-
 /**
  * \file changes.h
- * Copyright 2002 the LyX Team
- * Read the file COPYING
+ * This file is part of LyX, the document processor.
+ * Licence details can be found in the file COPYING.
  *
- * Record changes in a paragraph.
+ * \author John Levon
+ *
+ * Full author contact details are available in file CREDITS.
  *
- * \author John Levon <levon@movementarian.org>
+ * Record changes in a paragraph.
  */
 
 #ifndef CHANGES_H
@@ -16,9 +19,10 @@
 
 #include <vector>
 #include <iosfwd>
-#include <ctime>
 
-struct Change {
+
+class Change {
+public:
        /// the type of change
        enum Type {
                UNCHANGED, // no change
@@ -29,19 +33,19 @@ struct Change {
        Change(Type t = UNCHANGED, int a = 0, lyx::time_type ct = 0)
                : type(t), author(a), changetime(ct) {}
 
-       Type type; 
+       Type type;
 
        int author;
 
-       lyx::time_type changetime; 
+       lyx::time_type changetime;
 };
- 
+
 bool operator==(Change const & l, Change const & r);
 bool operator!=(Change const & l, Change const & r);
- 
+
 class Changes {
 public:
-               
+
        Changes(Change::Type type);
 
        ~Changes();
@@ -52,10 +56,10 @@ public:
        void reset(Change::Type type) {
                empty_type_ = type;
        }
- 
+
        /// set the position to the given change
        void set(Change change, lyx::pos_type pos);
- 
+
        /// set the position to the given change
        void set(Change::Type, lyx::pos_type pos);
 
@@ -68,31 +72,31 @@ public:
        /// mark the given change and adjust
        void record(Change, lyx::pos_type pos);
 
-       /// return the change type at the given position
-       Change::Type lookup(lyx::pos_type pos) const;
-
        /// return the change at the given position
-       Change const lookupFull(lyx::pos_type pos) const;
+       Change const lookup(lyx::pos_type pos) const;
 
        /// return true if there is a change in the given range
        bool isChange(lyx::pos_type start, lyx::pos_type end) const;
 
        /// return true if there is a deleted or unchanged range contained
        bool isChangeEdited(lyx::pos_type start, lyx::pos_type end) const;
- 
-       /// remove the given entry
+
+       /// remove the given entry. This implies that a character was
+       /// deleted at pos, and will adjust all range bounds past it
        void erase(lyx::pos_type pos);
 
        /// output latex to mark a transition between two changetypes
        /// returns length of text outputted
-       static int latexMarkChange(std::ostream & os, Change::Type old, Change::Type change);
+       static int latexMarkChange(std::ostream & os, Change::Type old,
+               Change::Type change, bool const & output);
 
        /// output .lyx file format for transitions between changes
        static void lyxMarkChange(std::ostream & os, int & column,
                lyx::time_type curtime, Change const & old, Change const & change);
- 
+
 private:
-       struct Range {
+       class Range {
+       public:
                Range(lyx::pos_type s, lyx::pos_type e)
                        : start(s), end(e) {}
 
@@ -103,46 +107,48 @@ private:
                bool contains(lyx::pos_type pos) const;
 
                // does this range contain pos, or can it be appended ?
-               bool loose_contains(lyx::pos_type pos) const;
+               bool containsOrPrecedes(lyx::pos_type pos) const;
 
                // is this range contained within r ?
                bool contained(Range const & r) const;
 
                // do the ranges intersect ?
                bool intersects(Range const & r) const;
- 
+
                lyx::pos_type start;
                lyx::pos_type end;
        };
- 
+
        friend bool operator==(Range const & r1, Range const & r2);
        friend bool operator!=(Range const & r1, Range const & r2);
- 
-       struct ChangeRange {
+
+       class ChangeRange {
+       public:
                ChangeRange(lyx::pos_type s, lyx::pos_type e, Change c)
                        : range(Range(s, e)), change(c) {}
                Range range;
                Change change;
        };
- 
-       typedef std::vector<ChangeRange> ChangeTable; 
 
-       /// our table of changes
+       typedef std::vector<ChangeRange> ChangeTable;
+
+       /// our table of changes, every row a range and change descriptor
        ChangeTable table_;
- 
+
        /// change type for an empty paragraph
        Change::Type empty_type_;
- 
-       /// handle a delete
+
+       /// handle a delete, either logical or physical (see erase)
        void del(Change change, ChangeTable::size_type pos);
 
-       /// handle an add
+       /// handle an add, adjusting range bounds past it
        void add(Change change, ChangeTable::size_type pos);
- 
-       /// merge neighbouring ranges
+
+       /// merge neighbouring ranges, assuming that they are abutting
+       /// (as done by set())
        void merge();
 
-       /// consistency check
+       /// consistency check, needed before merge()
        void check() const;
 
 };