// -*- C++ -*-
/* This file is part of
* ======================================================
- *
+ *
* LyX, The Document Processor
- *
- * Copyright (C) 1995 Matthias Ettrich, 1995, 1996 LyX Team
*
- *======================================================*/
-#ifndef _UNDO_H
-#define _UNDO_H
-
-#ifdef __GNUG__
-#pragma interface
-#endif
+ * Copyright 1995 Matthias Ettrich
+ * Copyright 1995-2001 The LyX Team.
+ *
+ * ====================================================== */
-#include "definitions.h"
-#include "lyxparagraph.h"
+#ifndef UNDO_H
+#define UNDO_H
+#include "ParagraphList.h"
-///
+/**
+ * These are the elements put on the undo stack. Each object
+ * contains complete paragraphs and sufficient information
+ * to restore the state. The work is done in undo_funcs.C
+ */
class Undo {
public:
- /// The undo kinds
+ /**
+ * The undo kinds are used to combine consecutive undo recordings
+ * of the same kind.
+ */
enum undo_kind {
- ///
+ /**
+ * Insert something - these will combine to one big chunk
+ * when many inserts come after each other.
+ */
INSERT,
- ///
+
+ /**
+ * Delete something - these will combine to one big chunk
+ * when many deletes come after each other.
+ */
DELETE,
- ///
- EDIT,
- ///
- FINISH
+
+ /// Atomic - each of these will have its own entry in the stack
+ ATOMIC
};
///
+ Undo(undo_kind kind, int inset_id,
+ int first, int last,
+ int cursor, int cursor_pos,
+ ParagraphList const & par_arg);
+
+ /// Which kind of operation are we recording for?
undo_kind kind;
- ///
- int number_of_before_par;
- ///
- int number_of_behind_par;
- ///
- int number_of_cursor_par;
- ///
- int cursor_pos; // valid if >= 0
- ///
- LyXParagraph* par;
- ///
- Undo(undo_kind kind_arg,
- int number_before_arg, int number_behind_arg,
- int cursor_par_arg, int cursor_pos_arg,
- LyXParagraph* par_arg)
- {
- kind = kind_arg;
- number_of_before_par = number_before_arg;
- number_of_behind_par = number_behind_arg;
- number_of_cursor_par = cursor_par_arg;
- cursor_pos = cursor_pos_arg;
- par = par_arg;
- }
- ///
- ~Undo(){
- LyXParagraph* tmppar;
- while (par) {
- tmppar = par;
- par = par->next;
- delete tmppar;
- }
- }
-};
+ /**
+ * ID of hosting inset if the cursor is in one.
+ * if -1, then the cursor is not in an inset.
+ * if >= 0, then the cursor is in inset with given id.
+ */
+ int inset_id;
-/// A limited Stack for the undo informations. Matthias 290496
-class UndoStack{
-private:
- ///
- struct StackAtom{
- ///
- StackAtom* previous;
- ///
- Undo* undo;
- };
- ///
- StackAtom* current;
- ///
- StackAtom *tmp;
- ///
- int size;
- ///
- int limit;
-public:
- ///
- UndoStack(){
- current = 0;
- // size must be initialised (thornley)
- size = 0;
- limit = 100; // the maximum number of undo steps stored. 0 means NO LIMIT.
- // Limit can be changed with UndoStack::SetStackLimit(int)
- }
- ///
- Undo *Pop(){
- Undo* result = 0;
- if (current){
- result = current->undo;
- tmp = current;
- current = current->previous;
- delete tmp;
- size--;
- }
- else {
- size = 0; // for safety...
- }
- return result;
- }
- ///
- Undo* Top(){
- if (current)
- return current->undo;
- else
- return 0;
- }
- ///
- ~UndoStack(){
- Clear();
- }
- ///
- void Clear(){
- Undo* tmp_undo = Pop();
- while (tmp_undo){
- delete tmp_undo;
- tmp_undo = Pop();
- }
- }
- ///
- void SetStackLimit(int limit_arg) {
- limit = limit_arg;
- }
-
- ///
- void Push(Undo* undo_arg){
- int i;
- StackAtom* tmp2;
- if (undo_arg){
- tmp = new StackAtom;
- tmp->undo = undo_arg;
- tmp->previous = current;
- current = tmp;
- size++;
- if (limit && size > limit){
- for (i=0; i<limit && tmp; i++)
- tmp = tmp->previous;
- while(tmp && tmp->previous){
- tmp2 = tmp->previous->previous;
- delete tmp->previous;
- size--;
- tmp->previous = tmp2;
- }
- }
- }
- }
+ /// Offset to the first paragraph in the main document paragraph list
+ int first_par_offset;
+
+ /// Offset to the last paragraph from the end of the main par. list
+ int last_par_offset;
+
+ /**
+ * Offset from the start of the main document paragraph list,
+ * except if inside an inset, in which case it's the offset
+ * inside the hosting inset.
+ */
+ int cursor_par_offset;
+
+ /// The position of the cursor in the hosting paragraph
+ int cursor_pos;
+
+ /// The contents of the paragraphs saved
+ ParagraphList pars;
};
+
#endif
projects / lyx.git / blobdiff