]> git.lyx.org Git - lyx.git/blobdiff - src/Compare.cpp
\\subfloat captions are moving arguments
[lyx.git] / src / Compare.cpp
index 95eaf5abaef0f9cc1bf3eacfc89297b7348d8062..c2a01a64df8a189b0e85ed73a7877a6cf1823500 100644 (file)
 
 #include "Compare.h"
 
+#include "Author.h"
 #include "BufferParams.h"
 #include "Changes.h"
+#include "Font.h"
 
 #include "insets/InsetText.h"
 
 #include "support/lassert.h"   
+#include "support/qstring_helpers.h"
 
 #include <boost/next_prior.hpp>
 
-#include <cmath>
-
 using namespace std;
 using namespace lyx::support;
 
@@ -97,13 +98,15 @@ size_t DocRange::length() const
 
 class DocPair {
 public:
-       DocPair() {}
+       DocPair()
+       {}
 
        DocPair(DocIterator o_, DocIterator n_)
                : o(o_), n(n_)
        {}
 
-       bool operator!=(DocPair const & rhs) {
+       bool operator!=(DocPair const & rhs)
+       {
                // this might not be intuitive but correct for our purpose
                return o != rhs.o && n != rhs.n;
        }
@@ -146,10 +149,16 @@ public:
        {}
 
        /// Returns the from pair
-       DocPair from() const { return DocPair(o.from, n.from); }
+       DocPair from() const
+       {
+               return DocPair(o.from, n.from);
+       }
 
        /// Returns the to pair
-       DocPair to() const { return DocPair(o.to, n.to); }
+       DocPair to() const
+       {
+               return DocPair(o.to, n.to);
+       }
 
        DocRange o;
        DocRange n;
@@ -181,7 +190,8 @@ static DocRangePair stepIntoInset(DocPair const & inset_location)
 template<class T>
 class compl_vector {
 public:
-       compl_vector() {}
+       compl_vector()
+       {}
 
        void reset(T const & def)
        {
@@ -219,11 +229,12 @@ class Compare::Impl {
 public:
        ///
        Impl(Compare const & compare) 
-               : abort_(false), compare_(compare)
+               : abort_(false), compare_(compare), recursion_level_(0), D_(0)
        {}
 
        ///
-       ~Impl() {}
+       ~Impl()
+       {}
 
        // Algorithm to find the shortest edit string. This algorithm 
        // only needs a linear amount of memory (linear with the sum
@@ -234,10 +245,19 @@ public:
        /// Set to true to cancel the algorithm
        bool abort_;
 
+       ///
+       QString status()
+       {
+               QString status;
+               status += toqstr("recursion level:") + " " + QString::number(recursion_level_)
+                       + " " + toqstr("differences:") + " " + QString::number(D_);
+               return status;
+       }
+
 private:
        /// Finds the middle snake and returns the length of the
        /// shortest edit script.
-       int find_middle_snake(DocRangePair const & rp, DocPair & middle_snake);
+       int findMiddleSnake(DocRangePair const & rp, DocPair & middle_snake);
 
        enum SnakeResult {
                NoSnake,
@@ -247,13 +267,13 @@ private:
 
        /// Retrieve the middle snake when there is overlap between
        /// the forward and backward path.
-       SnakeResult retrieve_middle_snake(int k, int D, Direction direction,
+       SnakeResult retrieveMiddleSnake(int k, int D, Direction direction,
                DocPair & middle_snake);
        
-       /// Find the the furthest reaching D-path (number of horizontal
+       /// Find the furthest reaching D-path (number of horizontal
        /// and vertical steps; differences between the old and new
        /// document) in the k-diagonal (vertical minus horizontal steps).
-       void furthest_Dpath_kdiagonal(int D, int k,
+       void furthestDpathKdiagonal(int D, int k,
                DocRangePair const & rp, Direction direction);
 
        /// Is there overlap between the forward and backward path
@@ -264,17 +284,17 @@ private:
        /// around the middle snake.
        void diff_i(DocRangePair const & rp);
 
-       /// Processes the splitted chunks. It either adds them as deleted,
+       /// Processes the split chunks. It either adds them as deleted,
        /// as added, or call diff_i for further processing.
-       void diff_part(DocRangePair const & rp);
+       void diffPart(DocRangePair const & rp);
 
        /// Runs the algorithm for the inset located at /c it and /c it_n 
        /// and adds the result to /c pars.
-       void diff_inset(Inset * inset, DocPair const & p);
+       void diffInset(Inset * inset, DocPair const & p);
 
        /// Adds the snake to the destination buffer. The algorithm will
        /// recursively be applied to any InsetTexts that are within the snake.
-       void process_snake(DocRangePair const & rp);
+       void processSnake(DocRangePair const & rp);
 
        /// Writes the range to the destination buffer
        void writeToDestBuffer(DocRange const & range,
@@ -322,6 +342,10 @@ private:
        compl_vector<DocIterator> nrp;
        compl_vector<DocIterator> ors;
        compl_vector<DocIterator> nrs;
+       
+       /// The number of differences in the path the algorithm
+       /// is currently processing.
+       int D_;
 };
 
 /////////////////////////////////////////////////////////////////////
@@ -335,6 +359,15 @@ Compare::Compare(Buffer const * new_buf, Buffer const * old_buf,
        : new_buffer(new_buf), old_buffer(old_buf), dest_buffer(dest_buf),
          options_(options), pimpl_(new Impl(*this))
 {
+       connect(&status_timer_, SIGNAL(timeout()),
+               this, SLOT(doStatusMessage()));
+       status_timer_.start(1000);
+}
+
+
+void Compare::doStatusMessage()
+{
+       statusMessage(pimpl_->status());
 }
 
 
@@ -343,10 +376,19 @@ void Compare::run()
        if (!dest_buffer || !new_buffer || !old_buffer)
                return;
 
-       // Copy the buffer params to the new buffer
+       // Copy the buffer params to the destination buffer
        dest_buffer->params() = options_.settings_from_new
                ? new_buffer->params() : old_buffer->params();
        
+       // Copy extra authors to the destination buffer
+       AuthorList const & extra_authors = options_.settings_from_new ?
+               old_buffer->params().authors() : new_buffer->params().authors();
+       AuthorList::Authors::const_iterator it = extra_authors.begin();
+       for (; it != extra_authors.end(); ++it)
+               dest_buffer->params().authors().record(*it);
+       
+       doStatusMessage();
+
        // do the real work
        if (!doCompare())
                return;
@@ -371,7 +413,7 @@ void Compare::abort()
 }
 
 
-static void get_paragraph_list(DocRange const & range,
+static void getParagraphList(DocRange const & range,
        ParagraphList & pars)
 {
        // Clone the paragraphs within the selection.
@@ -421,7 +463,15 @@ static bool equal(Inset const * i_o, Inset const * i_n)
 }
 
 
-static bool equal(DocIterator & o, DocIterator & n) {
+static bool equal(DocIterator & o, DocIterator & n)
+{
+       // Explicitly check for this, so we won't call
+       // Paragraph::getChar for the last pos.
+       bool const o_lastpos = o.pos() == o.lastpos();
+       bool const n_lastpos = n.pos() == n.lastpos();
+       if (o_lastpos || n_lastpos)
+               return o_lastpos && n_lastpos;
+
        Paragraph const & old_par = o.text()->getPar(o.pit());
        Paragraph const & new_par = n.text()->getPar(n.pit());
 
@@ -448,7 +498,7 @@ static bool equal(DocIterator & o, DocIterator & n) {
 /// position in the old and new file and they are synchronously
 /// moved along the snake. The function returns true if a snake
 /// was found.
-static bool traverse_snake(DocPair & p, DocRangePair const & range,
+static bool traverseSnake(DocPair & p, DocRangePair const & range,
        Direction direction)
 {
        bool ret = false;
@@ -478,7 +528,7 @@ static bool traverse_snake(DocPair & p, DocRangePair const & range,
 /////////////////////////////////////////////////////////////////////
 
 
-void Compare::Impl::furthest_Dpath_kdiagonal(int D, int k,
+void Compare::Impl::furthestDpathKdiagonal(int D, int k,
         DocRangePair const & rp, Direction direction)
 {
        compl_vector<DocIterator> & op = direction == Forward ? ofp : orp;
@@ -496,6 +546,7 @@ void Compare::Impl::furthest_Dpath_kdiagonal(int D, int k,
        // Where do we take the step from ?
        int const kk = vertical_step ? k + 1 : k - 1;
        DocPair p(op[kk], np[kk]);
+       DocPair const s(os[kk], ns[kk]);
 
        // If D==0 we simulate a vertical step from (0,-1) by doing nothing.
        if (D != 0) {
@@ -511,14 +562,14 @@ void Compare::Impl::furthest_Dpath_kdiagonal(int D, int k,
        }       
        
        // Traverse snake
-       if (traverse_snake(p, rp, direction)) {
+       if (traverseSnake(p, rp, direction)) {
                // Record last snake
                os[k] = p.o;
                ns[k] = p.n;
        } else {
                // Copy last snake from the previous step
-               os[k] = os[kk];
-               ns[k] = ns[kk];
+               os[k] = s.o;
+               ns[k] = s.n;
        }
 
        //Record new position
@@ -544,7 +595,7 @@ bool Compare::Impl::overlap(int k, int D)
 }
 
 
-Compare::Impl::SnakeResult Compare::Impl::retrieve_middle_snake(
+Compare::Impl::SnakeResult Compare::Impl::retrieveMiddleSnake(
        int k, int D, Direction direction, DocPair & middle_snake)
 {
        compl_vector<DocIterator> & os = direction == Forward ? ofs : ors;
@@ -559,7 +610,7 @@ Compare::Impl::SnakeResult Compare::Impl::retrieve_middle_snake(
        if (os[k].empty() && os_r[kk].empty()) {
                // No, there is no snake at all, in which case
                // the length of the shortest edit script is M+N.
-               LASSERT(2 * D - odd_offset_ == M_ + N_, /**/);
+               LATTEST(2 * D - odd_offset_ == M_ + N_);
                return NoSnake;
        } 
        
@@ -577,7 +628,7 @@ Compare::Impl::SnakeResult Compare::Impl::retrieve_middle_snake(
 }
 
 
-int Compare::Impl::find_middle_snake(DocRangePair const & rp,
+int Compare::Impl::findMiddleSnake(DocRangePair const & rp,
        DocPair & middle_snake)
 {
        // The lengths of the old and new chunks.
@@ -601,10 +652,13 @@ int Compare::Impl::find_middle_snake(DocRangePair const & rp,
        ors.reset(DocIterator());
        nrs.reset(DocIterator());
 
+       // In the formula below, the "+ 1" ensures we round like ceil()
+       int const D_max = (M_ + N_ + 1)/2;
        // D is the number of horizontal and vertical steps, i.e.
        // different characters in the old and new chunk.
-       int const D_max = ceil(((double)M_ + N_)/2);
        for (int D = 0; D <= D_max; ++D) {
+               // to be used in the status messages
+               D_ = D; 
 
                // Forward and reverse paths
                for (int f = 0; f < 2; ++f) {
@@ -613,7 +667,7 @@ int Compare::Impl::find_middle_snake(DocRangePair const & rp,
                        // Diagonals between -D and D can be reached by a D-path
                        for (int k = -D; k <= D; k += 2) {                      
                                // Find the furthest reaching D-path on this diagonal
-                               furthest_Dpath_kdiagonal(D, k, rp, direction);
+                               furthestDpathKdiagonal(D, k, rp, direction);
 
                                // Only check for overlap for forward paths if the offset is odd
                                // and only for reverse paths if the offset is even.
@@ -621,10 +675,12 @@ int Compare::Impl::find_middle_snake(DocRangePair const & rp,
 
                                        // Do the forward and backward paths overlap ?
                                        if (overlap(k, D - odd_offset_)) {
-                                               retrieve_middle_snake(k, D, direction, middle_snake);
+                                               retrieveMiddleSnake(k, D, direction, middle_snake);
                                                return 2 * D - odd_offset_;
                                        }
                                }
+                               if (abort_)
+                                       return 0;
                        }
                }
        }
@@ -651,12 +707,14 @@ bool Compare::Impl::diff(Buffer const * new_buf, Buffer const * old_buf,
        DocRangePair rp(old_buf_, new_buf_);
 
        DocPair from = rp.from();
-       traverse_snake(from, rp, Forward);
+       traverseSnake(from, rp, Forward);
        DocRangePair const snake(rp.from(), from);
-       process_snake(snake);
+       processSnake(snake);
        
        // Start the recursive algorithm
-       diff_i(rp);
+       DocRangePair rp_new(from, rp.to());
+       if (!rp_new.o.empty() || !rp_new.n.empty())
+               diff_i(rp_new);
 
        for (pit_type p = 0; p < (pit_type)dest_pars_->size(); ++p) {
                (*dest_pars_)[p].setBuffer(const_cast<Buffer &>(*dest_buf));
@@ -669,12 +727,15 @@ bool Compare::Impl::diff(Buffer const * new_buf, Buffer const * old_buf,
 
 void Compare::Impl::diff_i(DocRangePair const & rp)
 {
+       if (abort_)
+               return;
+
        // The middle snake
        DocPair middle_snake;
 
        // Divides the problem into two smaller problems, split around
        // the snake in the middle.
-       int const L_ses = find_middle_snake(rp, middle_snake);
+       int const L_ses = findMiddleSnake(rp, middle_snake);
 
        // Set maximum of progress bar
        if (++recursion_level_ == 1)
@@ -696,29 +757,29 @@ void Compare::Impl::diff_i(DocRangePair const & rp)
        } else {
                // Retrieve the complete snake
                DocPair first_part_end = middle_snake;
-               traverse_snake(first_part_end, rp, Backward);
+               traverseSnake(first_part_end, rp, Backward);
                DocRangePair first_part(rp.from(), first_part_end);
                        
                DocPair second_part_begin = middle_snake;
-               traverse_snake(second_part_begin, rp, Forward);
+               traverseSnake(second_part_begin, rp, Forward);
                DocRangePair second_part(second_part_begin, rp.to());
                                
                // Split the string in three parts:
                // 1. in front of the snake
-               diff_part(first_part);
+               diffPart(first_part);
 
                // 2. the snake itself, and
                DocRangePair const snake(first_part.to(), second_part.from());
-               process_snake(snake);
+               processSnake(snake);
 
                // 3. behind the snake.
-               diff_part(second_part);
+               diffPart(second_part);
        }
        --recursion_level_;
 }
 
 
-void Compare::Impl::diff_part(DocRangePair const & rp)
+void Compare::Impl::diffPart(DocRangePair const & rp)
 {
        // Is there a finite length string in both buffers, if not there
        // is an empty string and we write the other one to the buffer.
@@ -733,7 +794,7 @@ void Compare::Impl::diff_part(DocRangePair const & rp)
 }
 
 
-void Compare::Impl::diff_inset(Inset * inset, DocPair const & p)
+void Compare::Impl::diffInset(Inset * inset, DocPair const & p)
 {
        // Find the dociterators for the beginning and the
        // end of the inset, for the old and new document.
@@ -753,10 +814,10 @@ void Compare::Impl::diff_inset(Inset * inset, DocPair const & p)
 }
 
 
-void Compare::Impl::process_snake(DocRangePair const & rp)
+void Compare::Impl::processSnake(DocRangePair const & rp)
 {
        ParagraphList pars;
-       get_paragraph_list(rp.o, pars);
+       getParagraphList(rp.o, pars);
 
        // Find insets in this paragaph list
        DocPair it = rp.from();
@@ -769,8 +830,8 @@ void Compare::Impl::process_snake(DocRangePair const & rp)
                        pit_type const pit = it.o.pit() - rp.o.from.pit();
                        pos_type const pos = pit ? it.o.pos() : it.o.pos() - rp.o.from.pos();
                        inset = pars[pit].getInset(pos);
-                       LASSERT(inset, /**/);
-                       diff_inset(inset, it);
+                       LASSERT(inset, continue);
+                       diffInset(inset, it);
                }
        }
        writeToDestBuffer(pars);
@@ -781,7 +842,7 @@ void Compare::Impl::writeToDestBuffer(DocRange const & range,
        Change::Type type)
 {
        ParagraphList pars;
-       get_paragraph_list(range, pars);
+       getParagraphList(range, pars);
 
        pos_type size = 0;