Text edit system with enhanced undo user interface

[0002] The subject invention relates to computer applications in general and more particularly to improvements in the carrying out and performing editing functions on data in computer systems which include a central processing system, an interactive display terminal and a user input device.

[0003] The ability of data processing systems to store, retrieve and manipulate data has been well exploited in the fields of text and program processing. Typically, an author uses an interactive display terminal to create a document or file by entering text or data into a data processing system which stores the data in electronic form and displays the text on a display device, such as a cathode ray tube. When the author is satisfied, the text is stored in the form of a file or document in a memory device which may be, for example, a magnetic disk store. In order to change or manipulate the data, the system must be adapted to perform editing functions.

[0004] Editor programs are well known in the field of data processing. A file of data, which may hold numerical data, computer programs, or documentation such as text, as well as other information, is created by the user. If it is required to make a change to the file of data, it is necessary to use a program executed on the computer to access and allow the user to effect changes. Thus, editors are known to allow users to work with files and perform such activities as to create files, enter data, manipulate the screen display, make changes to the file, and transfer data between files. Use of editors involves the interactive changing, adding or deleting data from files.

[0005] An example of a general text processing editor for use on the Call Management System (CMS) computer environment is the XEDIT program. Details of this program and the functions involved can be found in the XEDIT User's Guide Virtual Machine/Enterprise Systems Architecture, available from International Business Machines Corporation as publication no. SC24-5463. XEDIT is available for use on host computer systems.

[0006] A publication describing editors in general, as well as the LEXX editor in particular, is entitled LEXX—A Programmable Structured Editor, by M. F. Cowlishaw, published in the IBM Journal of Research and Development, Volume 31, No. 1, Jan. 1987, pp. 73-80. This paper describes details of aspects and capabilities of various text editors and structured editors. LEXX is a general purpose editor that can edit both documentation and programs while making evident the structure of the data being edited. LEXX is an editor that can be programmed not only to understand and present the structure of data, but also to display those data in a variety of styles and colors in order to best match the data to the user and to the task being performed. The result is a programmable editor that can be customized to suit the data, the task and the needs of the user.

[0007] A further development of the LEXX editor that can also be used to create and edit many kinds of data, including programs and documentation, is referred to as the Live Parsing Extensible Editor (LPEX), which runs on workstations. The live parsing capability permits external commands and edit macros attached to the editor to monitor changes made to a document as the user works with and manipulates the document. Details of the LPEX editor can be found in the LPEX User's Guide and Reference Manual, IBM publication no. SC09-2202, available from International Business Machines Corporation.

[0008] Text editor applications are continually being improved and made more useful and friendly to the end user. For example, IBM Technical Disclosure Bulletin, Volume 34, No. 7A, Dec. 1991, pp. 20-25, describes a pause review technique for improving the interactivity of direct manipulation in a text editor application. During direct manipulation of a document, a user may be uncertain of the effects of certain changes. This publication describes a technique for providing visual feedback and the effect that the change may have on the document before a direct manipulation is completed. It provides for a conversation-like preview/reject/continue sequence so as to permit the user to actually see what is happening to the document before the changes are finally implemented.

[0009] Word processors are application programs for use in personal computer environments and perform similar functions on a document as an editor, including the creating and editing of files. Examples of available word processor applications are WordPerfect™ from Corel Corporation, Amipro™ from Lotus Development Corporation and PFS WindowWorks™ from Softkey International Inc. Typically, user manuals are provided by the respective suppliers or manufacturers of these programs which readily describe the capabilities and functions of the programs.

[0010] In general, currently available editors and word processing programs, and in particular the programs referred to above, provide for the functions of making a change to a document or file, such as deleting a word, line or some portion of a file, and providing the capability to recover or “undo” the change that had been originally made in the process of editing the document. Some programs also provide the capability to “redo” a change that was previously undone. It has been found, however, that these capabilities are not sufficient for all editing applications and there is a need for a multi-level, random access undo function, thus providing increased usability. There is a further need for an improved graphical user interface so as to display all changes to a document in their context, and to be able to selectively accept them as desired. Thus, new functions to be implemented in computer programs for editing documents are needed, along with an associated meaningful graphical interface.

[0011] Present undo/redo implementations in edit systems provide neither adequate visual feedback of the available undoable changes, nor flexible capabilities to handle these and can be characterized by the following shortcomings or limitations:

[0012] the user can only proceed through changes sequentially, from the most recent change backwards, must apply these changes (undo/redo them) while going through the Undo Stack, consequently eliminating from the document edit view the latest, and any other, variant of the affected text;

[0013] the user cannot selectively restore part of a global change;

[0014] the user cannot see all the text that is going to be restored (e.g., in the case of a global change);

[0015] the user cannot see a certain change in the context of the other changes carried out in the course of editing, before undoing it.

[0016] This lack of user-friendliness prevents users from using undo/redo functions in complex editing situations where they could be most useful, as the user is virtually operating blindly while doing changes to a document. As a result the user is forced to retype, carefully rescan the document manually while looking for changes, keep and open in the edit system several versions of the document or parts of it for reference, or similar unproductive alternatives, resulting in loss of time and productivity.

[0017] It is an object of the present invention to provide an edit system having an enhanced undo interface which selectively displays undo elements (records), that is, previous states of the document text, intermixed in the edit view of the document with the actual text elements, and positioned relative to the affected text. The invention allows the user to display selected undo elements that belong to one or more undo units (sets, or generations of changes), and selectively restore changes to the text. A series of user interface enhancements comprising visual indications, menu items, and key actions available in the enhanced edit system provide a rich and flexible set of capabilities to the user and to external command/edit macro writers to manipulate changes to the document.

[0018] Another object of the invention is to allow the user to view, analyze, select specific undo unit elements and optionally restore changes selectively. For a line that underwent several modifications, the user can select any of those changes to be restored.

[0019] It is an object of the invention is to allow a user of an edit system to view and pick partial changes done in the context of a comprehensive (large-scope) document alteration, such as a global “find and replace” operation, and selectively restore the text in order to regress undesired text replaces.

[0020] Another object of the invention is that, depending on the particular implementation in the enhanced edit system and the active mode of imbedding undo records, any changes being performed to the document text, including the processing of undo elements, may trigger a refresh of the undo elements imbedded in the document edit view.

[0021] Another object of the invention is to display attributes of the undo elements in the edit view such that they are clearly distinguished from the current text elements. The user can navigate easily between the undo elements selected, and zoom-in on one or more types of undo elements selected for display, and then zoom out to the surrounding context.

[0022] Another object of the invention is to permit this enhanced undo interface to be implemented in addition to the conventional undo/redo options or commands currently implemented in edit systems. The described method does not affect the basic underlying mechanism of storing undo information in the edit system (either separate structures, or structures intermixed with the text elements), nor the processing of the regular undo/redo operations.

[0023] According to one aspect of the present invention, there is provided an improved method implemented in a computer system, for editing a document containing text stored in and displayed by said computer system. The method comprises the steps of displaying the document incorporating a plurality of changes, displaying the document with all of the text along with the plurality of changes, selecting and “undoing” certain of said plurality of changes, and displaying and storing an edited document having certain changes implemented and the selected changes undone so that the resulting document has text corresponding to the undone changes along with the remaining plurality of changes.

[0024] According to another aspect of the invention there is provided a programmed computer system to enable a user to edit a document containing text stored in and displayed by said computer system. The programmed computer system comprises means for a user to enter into the computer system a plurality of changes to the text of the document, means for displaying the document with all of the text along with the plurality of changes, means for selecting and undoing certain of said plurality of changes, and means for displaying and storing an edited document having certain changes implemented and the selected changes undone so that the final document has text corresponding to the undone changes along with the remaining plurality of changes.

[0025] According to a further aspect of the invention there is provided a computer program product comprising a computer usable medium having computer readable program code means embodied therein for causing the editing of a document containing text, the computer readable program code means in said computer program product comprises computer readable program code means for causing a computer to enter a plurality of changes to the text of the document, computer readable program code means for causing the document to be displayed on a monitor with the text along with the plurality of changes, computer readable program code means, in response to user inputs, for selecting and undoing certain of said plurality of changes, and computer readable program code means for displaying and storing an edited document having certain changes implemented and the selected changes undone so that the document has text corresponding to the undone changes along with the remaining plurality of changes.

[0026] The foregoing and other objects, aspects and advantages of the invention will be better understood from the following detailed description of the preferred embodiment of the invention with reference to the accompanying drawings in which:

[0027] FIGS. 1A to 1E is a series of document images on a screen display illustrating a sample application of the invention; and

[0028] FIG. 2 provides an overview of the main components of an edit system showing the implementation of the invention.

[0029] The disclosed invention as embodied in a method, computer system and computer program product, is particularly applicable to the live parsing extensible editor (LPEX) environment. Those skilled in the relevant art will appreciate that the invention is also suitable and relevant to various computer system environments, which are appropriately programmed in accordance with the features to be subsequently described, including use in conjunction with host computer systems such as VM/CMS operating systems and personal computer systems such as OS/2®, AIX® and Windows® operating systems.

[0030] The edit screen display depicting an application of the subject invention displays requested undo elements or records, intermixed with the affected text elements. User interface components of the screen provide for the selective display of the undo elements of one or more sets of changes to a document and provide for the undo or redo changes to be selectively made to the text.

[0031] The present invention may be implemented in a computer application in addition to the regular undo options or commands that are currently implemented, including “undo change” which retrieves and undoes the changes in a most recent-earlier order, and “undo line change” which restores the current edit line of the document to its previous state. The subject invention displays the undo elements or changes intermixed in the edit view of the document on the screen with the affected text elements. It allows the user to view, analyze, select specific undo unit elements, and optionally undo the changes selectively. For a line that underwent several modifications, the user can select any of those changes to be undone. The invention allows the user to view and pick partial changes done in the context of a comprehensive, large-scope document alteration, such as a “global find and replace” operation, and selectively undo text replaces which have subsequently been found to be undesirable, for whatever reason. The invention provides that the display attributes of the undo elements in the edit view clearly distinguish them from the current text elements. The user is able to easily navigate between the undo elements selected and zoom in on all the undo elements selected for display and then zoom out to the surrounding related text.

[0032] Reference to FIGS. 1A to 1E of the drawings will provide an example of a specific application of the invention. Each of the various screen displays depicted in FIGS. 1A to 1E have the format of a conventional user interface window display, generally indicated by the numeral designation 10, and includes such familiar components as title bar 11, menu bar 12, tool bar 13, status line 14 and document working area generally indicated as 15. FIG. 1A depicts the initial state of a document file which had been previously created and has been opened for editing purposes. This particular file is a C++ program source file. In order to illustrate this sample application of the invention, the user desires to perform the following examples of changes or editing operations on the displayed document:

[0033] (A) add a comment before the last line of code (record 014) in order to explain the value returned by the function;

[0034] (B) delete the instruction in record 012 which is deemed unnecessary, namely “block.setGraphicBundle(bundle);”

[0035] (C) a global find-and-replace of all occurrences of “Colour” to “Color” so that the code conforms to the usage in the C++ libraries; and

[0036] (D) modify the top comment in record 001 to indicate the changes carried out in the document.

[0037] These changes to the document can be entered into the computer and the document in any well known manner such as by use of a keyboard.

[0038] The term “record” as used herein refers to the lines or rows of text in the document and these are numbered along the left side of the window display 10 in the prefix area (16), as shown in FIGS. 1A to 1E. With the above described changes entered by the user, the new state of the document incorporating all of the entered plurality of changes is shown in FIG. 1B. It can be seen that the status line 14 in display 10 indicates that four changes were executed in the document, including a global change that affected several records. Thus there are four undo units recorded in the editor software.

[0039] The above changes are depicted in FIG. 1B as follows:

[0040] Change (A) resulted in a new record 013;

[0041] Change (B) resulted in deletion of record 012 from FIG. 1A so that previous record 013 is now record 012 in FIG. 1B;

[0042] Change (C) resulted in changes to records 009, 010 and 011; and

[0043] Change (D) resulted in a change to record 001.

[0044] All of the changes to the records are recorded in the edit system, and at this point these can be chosen to be displayed as inserted undo elements. These can be displayed, for example, by selecting a menu option “Show all changes”. This results in the screen display as depicted in FIG. 1C. Thus, in FIG. 1C, all of the proposed changes are shown in highlighted format as records following the document text records in which changes have been made. Also shown in FIG. 1C of this example, the editor provides an indication of the type of the undo element shown in the edit view by way of designations in the prefix area towards the left of each record, as shown by reference 17, namely “c” for changed records, “d” for deletions and “i” for insertions. As can be seen, the undo elements are also highlighted in comparison to the text of the document. They generally refer to the text and/or location in the document immediately above or at their position. The changes that would result from their implementation into the text thus become readily apparent.

[0045] The user now carries out a series of editing operations on the sample document in an effort to arrive at a final document. For the purposes of this example, the processing of undo elements is activated by a double right button mouse click or via a pop-up menu. With reference to FIG. 1D, the user performs the following operations:

[0046] Click the right mouse button while pointing the cursor to the change “c” undo element below document record 010. This brings up a pop-up menu 18 with an item “Restore changed record”. The user activates this selective record by clicking on it in order to restore the original statement since it was determined that “lineColour” was incorrectly modified to “lineColor” by the previously indicated global change (C) of “Colour” to “Color”;

[0047] In a similar manner, for change (B), restore the previously deleted statement by double clicking on the “d” (deletion) undo element above document record 012;

[0048] As for change (D), double click on the “c” (change“) element below record 001 so as to restore the original top comment in record 001; and

[0049] Remove the display of the undo elements from the edit view by activating the appropriate pull-down menu, for example, menu item “Remove all undo elements” in the “Actions” pull-down, and then saving the final edited document.

[0050] FIG. 1E illustrates the resulting current and final state of the document in the edited view after all of the changes and selected undo elements as described above have been incorporated into the document.

[0051] A more detailed description of the implementation of the invention will now be provided. The present invention provides for a set of comprehensive enhancements to the user interface of an edit system for the processing of undo/redo elements, through the imbedding in the document edit view of undo elements intermixed with the document text. These enhancements include:

[0052] menu actions;

[0053] pop-up menu actions;

[0054] key and mouse actions;

[0055] font attributes and colors of the undo elements imbedded in the document view in order

[0056] to make them stand out from the regular text,

[0057] to clearly distinguish their type, and

[0058] to highlight a particular generation of changes;

[0059] the marking of the undo elements in a separate area of the document view (such as the prefix area);

[0060] fly-over help;

[0061] context-sensitive help.

[0062] One or more of these may be implemented by an edit system which embodies the subject invention. Also, certain capabilities may be made available in the external command/edit macro interface of the edit system, even if not made available in the basic user interface.

[0063] Edit System

[0064] With reference to FIG. 2 of the drawings, an overview of a high-level description of the main components of a typical edit system will be provided with particular reference to the implementation of the subject invention. The blocks shown in FIG. 2 are intended to pictorially represent the functions performed by the code in an edit system to support the subject invention, as well as data structures maintained for the documents being edited. The control code is generally referred to in various blocks in FIG. 2 by reference numeral 20 and the components of the data structures by reference numeral 21. The various components in the edit system will now be briefly described to the extent needed to provide a context for the subject invention.

[0065] Dealing first with the components of control code 20, Edit Control 22 is responsible for the instantiation and management of the various components of the edit system. It processes the edit system internal commands. It handles the binding of internal commands or external commands and edit macros to menu items, key actions, mouse actions, etc. When an action is received, it invokes the command bound to it (if any).

[0066] Text Processing component 23 handles the loading of documents into the Edit Buffer 29 of the edit system, all the text editing operations and the formatting of the text, and the saving of the document. It records changes to the document in the Undo Stack 31 for subsequent undo and redo. Edit Buffer 29 and Undo Stack 31 temporarily store the documents and changes to the documents during processing.

[0067] Imbedded Undo 24 handles the imbedding, removal, and processing of undo elements in the document edit view. This is the component of the edit system by which the main aspects of the subject invention will be implemented as will be more fully described.

[0068] The Graphical User Interface control 25 controls the document edit view and builds and renders the edit view. Interface control 25 manages the display attributes of the rendered elements. It can show the document Edit Buffer 29 selectively (zoom in/out), by only including in the view those elements whose visibility matches the current settings.

[0069] External Commands/Macros Interface 26 controls the interface to external commands and edit macros, including live (incremental) parsers. Interface 26 loads and runs external commands and macros. It records committed changes into a stack for subsequent processing by any live parser attached to the edit system.

[0070] As part of the data structure 21 of the edit system, edit control structure 27 represents the global data for controlling the edit system. Document control structure 28 contains information to control the operations on a document in the edit system, and as is illustrated pictorially in FIG. 2, there are a plurality of these controls created, one for each document. Edit buffer 29 comprises a linked list of all the elements for a particular document as further described with reference to element structure 30. Classes are defined for a document, that broadly classify element types in the document. Classes are used to filter out elements from the view, and are used by the parsers or external commands to interpret the edit buffer on contents at various degree of detail. Each element can belong to one or more classes.

[0071] Element structure 30 represents the elements that make up the edit buffer 29 and include TEXT elements, SHOW elements and the combination of TEXT and SHOW elements. TEXT elements are the contents of the document loaded in the edit system. The display attributes for each character are usually set by the tokenizer of a live parser attached to the edit system. SHOW elements are the elements that are created for the purpose of display only: error and status messages, imbedded undo records. The display attributes are set separately for SHOW elements. They are protected from regular editing, and are not saved into the document file. For a combination of TEXT and SHOW elements, the SHOW display attributes take precedence, but the element may be edited and it is saved in the document. An element structure contains

[0072] the text contents

[0073] the corresponding prefix area contents

[0074] formatting flags and display attributes

[0075] the type (e.g., TYPE_DELETION for an imbedded DELETION undo SHOW element)

[0076] class information.

[0077] Undo structure 32 within Undo Stack 31 consists of a linked list of undo records created as changes take place to the document during the edit session, while undo recording is enabled. There is a structure 32 for each document being processed in the edit system. The information stored depends on the type of change, and the particular edit system. Undo records are of three basic types:

[0078] INSERTION—records the insertion of elements in the Edit Buffer

[0079] DELETION—records the deletion of elements

[0080] CHANGE—records changes to the contents of the document.

[0081] Complex operations will create a series of the above undo records. For example, a block move will create a series of DELETION and INSERTION undo records that all belong to one undo unit. An undo unit records a set (generation) of changes in the document. It comprises all the data necessary to undo an entire edit operation performed on the text, from one character change in one text record, to all the changes done in the context of one global change operation.

[0082] View control structure 33 comprises data related to the control of an edit view for one document in an edit system window and includes fonts defined for the view, view's size, format of its displayed prefix area, the required visibility of elements (for filtering/zooming in), screen fields for the document view consisting of the particular area of the edit buffer that displays.

[0083] It is believed that the above descriptions of the components of the control code and data structures of an edit system provides sufficient understanding for one skilled in the art of edit systems to be able to fully appreciate further aspects of the implementation of the invention which will now be described.

[0084] Imbedding Undo Elements

[0085] In an edit system which embodies the subject invention there are several ways to display undo elements in the edit view of the document, provided by menu items and/or in the undo dialog (panel) that cycles through the modifications performed to the document contents. They allow the user a choice of options to view, in the context of the current state of the document, certain sets of changes that were carried out in the edit session and consist of:

[0086] Show all changes—imbeds all the stored undo elements (the entire Undo Stack) to the edit view of the document. The latest undo unit displays with highlighted attributes.

[0087] Show changes for line—imbeds all the stored undo elements that refer to the line on which the cursor (entry point) is positioned.

[0088] Show/hide undo unit—incrementally adds or removes a single undo unit, as the user cycles through the changes via the undo/redo dialog or menu items. The latest undo unit displays with highlighted attributes.

[0089] In accordance with the present invention, the views of a document for which undo elements are shown in an edit system, have several of their menus and actions in the menu bar or tool bar respectively, updated with options to embed and manipulate imbedded undo elements.

[0090] (1) “Actions” menu options to process the imbedded undo elements include:

[0091] Select all undo elements

[0092] Deselect all undo elements

[0093] Restore selected undo elements

[0094] Remove selected undo elements

[0095] Remove all undo elements

[0096] Select all undo elements—selects for subsequent processing all the undo elements imbedded in the document view. The user may then deselect particular undo elements.

[0097] Deselect all undo elements—deselects all the imbedded undo elements.

[0098] Restore selected undo elements—processes all the imbedded undo elements currently selected in the document view. This restores changes to the affected current document text.

[0099] Remove selected undo elements—removes from the document view all the selected imbedded undo elements. This does not affect the contents of the document.

[0100] Remove all undo elements—removes all the imbedded undo elements from the document view, which is then restored to its previous state—undo elements-related menus are removed, action keys restored, etc. This option does not affect the contents of the document.

[0101] (2) “View” menu options to filter (zoom-in on) the imbedded undo elements include:

[0102] Insertions

[0103] Deletions

[0104] Changes

[0105] Insertions—only display INSERTION imbedded undo elements.

[0106] Deletions—only display DELETION imbedded undo elements.

[0107] Changes—only display CHANGE imbedded undo elements.

[0108] When activating one or more of these choices, the document view is collapsed to only display undo elements, and only of the selected type(s) (if there are any). The user is shown an overview of the particular changes carried out on the document in the edit session. The user can move the cursor (insertion point) to a particular imbedded undo element and zoom-out (restore normal display of the entire document and all the imbedded undo elements) for the context of the change.

[0109] (3) “Locate” (sub)menu options to navigate between the imbedded undo elements include:

[0110] Edit

[0111] Locate

[0112] Next undo element

[0113] Previous undo element

[0114] Next undo element—move cursor to the next imbedded undo element (if any) in the document edit view.

[0115] Previous undo element—move cursor to the previous imbedded undo element (if any).

[0116] Accelerators are also set up by the invention for selected menu options, and other key combinations can be set up to process individual undo elements. For example, double-clicking with the mouse on an undo element in a view of such a document will be set to process it (i.e., restore the particular change to the text).

[0117] Similarly, fly-over help for additional information when the cursor hovers over imbedded undo elements (e.g., showing the type of change indicated by the particular undo element); any prefix area of each record in the edit view is enlarged to accommodate an indication as to the type of the imbedded undo elements; appropriate menu items are added to the document edit views pop-up menu (e.g., for the particular imbedded undo element at the cursor, for its processing, for general and particular help on imbedded undo elements); context-sensitive help is upgraded to present help on undo elements.

[0118] Imbedded Undo Elements in the Edit System

[0119] The invention provides that undo elements are inserted into the edit view as special lines, assigned the SHOW display and edit attributes, and set the edit system class UNDO. These elements are protected from regular editing and are not regularly saved with the file.

[0120] An element that is both a regular TEXT and a SHOW element (for imbedded undo elements of type INSERTION), is treated appropriately as either TEXT or SHOW, depending on the edit system function handling it. Such an element will display with SHOW display attributes, but will be saved normally with the rest of the document, and will not be read-only (protected from editing).

[0121] The running row number displayed on the status line in a conventional edit system, and queriable by external commands and macros, is not directly affected in the existing interface. Therefore, the user still refers to records in the document text by their real record numbers, and the external “view” of the document seen by an external command/edit macro through the existing interface is not affected.

[0122] The edit system UNDO class also allows external commands or tools attached to the edit system to distinguish the undo elements from regular text, and optionally process them.

[0123] Imbedded undo elements, like the undo records saved by the edit system in the course of the edit session, are of three types, depending on the type of text modification represented:

[0124] INSERTION

[0125] DELETION

[0126] CHANGE.

[0127] This undo type indication is stored in the imbedded undo elements, via three corresponding flag bits, which may appear in combination in certain cases:

[0128] TYPE_INSERTION

[0129] TYPE_DELETION

[0130] TYPE_CHANGE.

[0131] An undo element in the view of a document is displayed differently from the regular text elements, so that it is easily visible in the file. The type of undo element is reflected in the foreground and background colors, and attributes (e.g. bold, italics) of the (user-settable) display fonts:

[0132] FONT_INSERTION

[0133] FONT_DELETION

[0134] FONT_CHANGE.

[0135] A particular generation of changes, usually the latest added to the view or processed, is reflected in a variation to the display attributes (e.g., a different nuance of the colors above, and/or the addition of the bold attribute) to the imbedded undo elements it comprises:

[0136] FONTHIGHLIGHT_INSERTION

[0137] FONTHIGHLIGHT_DELETION

[0138] FONTHIGHLIGHT_CHANGE.

[0139] Each undo element refers:

[0140] to the text or undo element immediately above it;

[0141] to the text element to which it belongs, in the case of INSERTION undo elements; or

[0142] to the location in the document immediately above it, in the case of DELETION undo elements.

[0143] The “View” menu is updated to provide zoom-in on the undo elements. This is achieved by setting a view visibility parameter to the UNDO edit system class, which in combination with the type of the undo element will exclude from the display all the elements for which the UNDO edit system class is not set, and all the undo elements of other types. Other menu items, key actions, mouse actions, etc. are set for the document edit view showing imbedded undo elements.

[0144] The new menu items and key combinations are set via the regular edit system interface to add menu items and accelerators, to set/reset action keys, etc.

[0145] Now that an overview and functional aspects of the subject invention have been introduced and described, pseudo code will now be presented and described for implementing the functions and routines of the subject invention into the edit view of an edit system under the topic headings of (1) Imbedding Undo Elements, (2) Removing Imbedded Undo Elements, (3) Processing Imbedded Undo Elements, and (4) Other Routines. Terms used in this description have been previously introduced and described.

[0146] (1) Imbedding Undo Elements

[0147] AddAllUndoUnits—ADD ALL UNDO UNITS

[0148] This routine adds all of the undo elements that comprise the Undo Stack, to the edit view of the document.

[0149] clear all existing imbedded undo elements for all undo records in the Undo Stack

[0150] if in most recent undo unit

[0151] AddUndoElement—ADD UNDO ELEMENT (highlight)

[0152] else

[0153] AddUndoElement—ADD UNDO ELEMENT

[0154] rebuild view and refresh display

[0155] AddLineUndo—ADD ALL UNDO ELEMENTS FOR A TEXT LINE

[0156] This routine adds all of the undo elements that refer to a particular existing line of text, to the edit view of the document.

[0157] remove all existing imbedded undo records for text line for all undo records in the Undo Stack

[0158] if undo record refers to current text line

[0159] AddUndoElement—ADD UNDO ELEMENT

[0160] rebuild view and refresh display

[0161] AddUndoUnit—ADD UNDO UNIT

[0162] This routine adds the undo elements that comprise one particular undo unit, to the edit view of the document. The routine first scans the document view for previously-imbedded undo elements, and changes their highlight to that defined for older generations of undo

[0163] (1) Imbedding Undo Elements

[0164] AddAllUndoUnits—ADD ALL UNDO UNITS

[0165] This routine adds all of the undo elements that comprise the Undo Stack, to the edit view of the document.

[0166] clear all existing imbedded undo elements for all undo records in the Undo Stack

[0167] if in most recent undo unit

[0168] AddUndoElement—ADD UNDO ELEMENT (highlight)

[0169] else

[0170] AddUndoElement—ADD UNDO ELEMENT

[0171] rebuild view and refresh display

[0172] AddLineUndo—ADD ALL UNDO ELEMENTS FOR A TEXT LINE

[0173] This routine adds all of the undo elements that refer to a particular existing line of text, to the edit view of the document.

[0174] remove all existing imbedded undo records for text line for all undo records in the Undo Stack

[0175] if undo record refers to current text line

[0176] AddUndoElement—ADD UNDO ELEMENT

[0177] rebuild view and refresh display

[0178] AddUndoUnit—ADD UNDO UNIT

[0179] This routine adds the undo elements that comprise one particular undo unit, to the edit view of the document. The routine first scans the document view for previously-imbedded undo elements, and changes their highlight to that defined for older generations of undo elements. It then iteratively invokes the function to add an undo element for all the undo elements that comprise the undo unit. Finally, the screen is rebuilt and refreshed.

[0180] ResetUndoHighlight—UNHIGHLIGHT VIEW'S UNDO ELEMENTS for all undo elements in an undo unit

[0181] AddUndoElement—ADD AN UNDO ELEMENT (highlight)

[0182] rebuild view and refresh display

[0183] AddUndoElement—ADD UNDO ELEMENT

[0184] This routine adds one undo element to the edit view of a document. An optional highlight parameter, is used to highlight undo elements recently added or that belong to a particular (e.g., latest) undo unit. Processing here depends on the type of the undo record in the Undo Stack.

[0185] The undo element is imbedded at a location in the Edit Buffer determined by the undo record in the Undo Stack, and its type. This is the location of the text element for an INSERTION undo record, the location after the text element for a CHANGE undo record, or the location that the undo record refers to for a DELETION undo record. Further, this location is adjusted to point in between any previously imbedded undo elements for the referenced document text or location.

[0186] Parser trigger recording of committed changes is disabled during the insertion of undo elements. The insertion is not recorded in the Undo Stack of the document either.

[0187] When the user edits a document text element that is also marked as an INSERTION imbedded undo element, beginning to type the modification opens a new undo unit in the edit system Undo Stack, which in turn may trigger an automatic refresh of the imbedded undo elements (in this example, a CHANGE undo element is added that contains the current text element before the change). This behavior depends on the particular implementation in the edit system and the active mode of imbedding undo records.

[0188] save original state of parser trigger recording

[0189] disable parser trigger recording

[0190] disable undo recording

[0191] if class UNDO not defined for context document

[0192] InitializeViewForUndo—SET UP VIEW FOR UNDO ELEMENTS

[0193] if INSERTION undo record

[0194] determine and set the Edit Buffer location at the text element that the insertion undo record refers to

[0195] type bits=TYPE_INSERTION

[0196] append to its formatting attributes the SHOW display attributes

[0197] if highlight

[0198] set FONTHIGHLIGHT_INSERTION

[0199] else

[0200] set FONT_INSERTION

[0201] else if DELETION undo record

[0202] determine and set Edit Buffer location at the location that the deletion undo record refers to

[0203] if any other undo element at this location reposition according to sequence of changes in Undo Stack

[0204] insert undo element

[0205] type bits=TYPE_DELETION

[0206] set its formatting attributes to SHOW attributes

[0207] if highlight

[0208] set FONTHIGHLIGHT_DELETION

[0209] else

[0210] set FONT_DELETION

[0211] else /* i.e., CHANGE undo record */

[0212] determine and set Edit Buffer location following the text that the change undo record refers to

[0213] if any other undo element at this location

[0214] reposition according to sequence of changes in Undo Stack

[0215] if element at this location is not a TYPE_INSERTION imbedded undo element

[0216] insert undo element

[0217] if element also indicates an INSERTION undo

[0218] set type bits=TYPE_INSERTION+TYPE_CHANGE

[0219] else

[0220] type bits=TYPE_CHANGE

[0221] set its formatting attributes to SHOW attributes

[0222] if highlight

[0223] set FONTHIGHLIGHT_CHANGE

[0224] else

[0225] set FONT_CHANGE

[0226] append class UNDO to the element's class bits

[0227] set type indication in prefix area

[0228] re-enable undo recording

[0229] restore original state of parser trigger recording

[0230] if not called from another undo function

[0231] rebuild view and refresh display

[0232] InitializeViewForUndo—Set Up View for Undo Elements

[0233] This routine prepares the document edit view for undo elements to be imbedded and is called when the first undo element is being added to the edit view. The routine defines a new UNDO class in the document scope to identify the undo elements for processing. It adds new menu items (and their accelerator keys) and corresponding action bindings to the current edit view, to allow user to view, navigate, process, and remove imbedded undo elements.

[0234] add class UNDO to document's defined classes

[0235] add “Select all undo elements”

[0236] menu item and accelerator to the “Actions” pull-down, and

[0237] bind it to edit system's command SelectAllUndo

[0238] add “Deselect all undo elements”

[0239] menu item and accelerator to the “Actions” pull-down, and

[0240] bind it to edit system's command DeselectAllUndo

[0241] add “Restore selected undo elements”

[0242] menu item and accelerator to the “Actions” pull-down, and

[0243] bind it to edit system's command RestoreSelectedUndo

[0244] add “Remove selected undo elements”

[0245] menu item and accelerator to the “Actions” pull-down, and

[0246] bind it to edit system's command RemoveSelectedUndo

[0247] add “Remove all undo elements”

[0248] menu item and accelerator to the “Actions” pull-down, and

[0249] bind it to edit system's command RemoveAllUndo

[0250] add “Insertions”

[0251] menu item and accelerator to the “View” pull-down, and

[0252] bind it to edit system's command ZoomonUndo TYPE_INSERTION

[0253] add “Deletions”

[0254] menu item and accelerator to the “View” pull-down, and

[0255] bind it to edit system's command ZoomOnUndo TYPE_DELETION

[0256] add “Changes”

[0257] menu item and accelerator to the “View” pull-down, and

[0258] bind it to edit system's command ZoomOnUndo TYPE_CHANGE

[0259] add “Next undo element”

[0260] menu item and accelerator to the “Locate” (sub)menu, and

[0261] bind it to edit system's command NextUndoElement

[0262] add “Previous undo element”

[0263] menu item and accelerator to the “Locate” (sub)menu, and

[0264] bind it to edit system's command PreviousUndoElement

[0265] bind mouse actions to RestoreUndoElement

[0266] set-up fly-over help for imbedded undo elements

[0267] set-up prefix area for indication of type of imbedded undo element

[0268] add call to PopupUndo to edit view's popup initialization binding

[0269] add call to HelpUndo to the current contextual-help key binding

[0270] define the FONT_xxx and FONTHIGHLIGHT_xxx display attributes

[0271] ResetUndoHighlight—Unhighlight View's Undo Elements

[0272] This routine restores the regular display attributes of the imbedded undo elements in the document view.

[0273] for all elements in document

[0274] if UNDO element

[0275] if FONTHIGHLIGHT_xxx

[0276] set corresponding FONT_xxx

[0277] if not called from another undo function

[0278] rebuild view and refresh display

[0279] (2) Removing Imbedded Undo Elements

[0280] The routines below handles the removal of imbedded undo elements in a document from the document edit view.

[0281] Parser trigger recording is disabled during the removal of undo elements, in order to prevent unnecessarily triggering external live parsers during this operation. The resulting change to the Edit Buffer is not recorded in the Undo Stack of the document either.

[0282] When the request to remove imbedded undo elements comes from a live parser attached to the edit system for the document, the selected imbedded undo elements are not immediately removed from the Edit Buffer, but are instead just marked for deletion. They will be actually deleted from the Edit Buffer following the call return from the live parser/external command, after all the pending lines have been processed by the said parser. This ensures edit buffer—parser synchronization, as otherwise the parse range initially determined by the parser would be continuously altered by the deletion of the undo elements.

[0283] RemoveAllUndo—Remove All Undo Elements

[0284] This routine removes all the imbedded undo elements from the document edit view, and restores its original state (undoes the changes performed in InitializeViewForUndo).

[0285] for all elements in document

[0286] if undo element

[0287] RemoveUndoElement—REMOVE UNDO ELEMENT

[0288] remove class UNDO from document's defined classes

[0289] remove class UNDO from the editing-protection selection

[0290] remove “Select all undo elements”, “Deselect all undo elements”,

[0291] “Restore selected undo elements”, “Remove selected undo elements”, and “Remove all undo elements” menu items and accelerators from the “Actions” pull-down

[0292] remove “Insertions”, “Deletions”, and “Changes” menu items and accelerators from the “View” pull-down

[0293] remove “Next undo element” and “Previous undo element” menu items and accelerators from the “Locate” (sub)menu

[0294] restore modified mouse actions

[0295] remove fly-over help for imbedded undo elements

[0296] restore prefix area format

[0297] remove call to PopupUndo from edit view's popup initialization binding

[0298] remove call to HelpUndo from the current contextual-help key binding

[0299] rebuild view and refresh display

[0300] RemoveSelectedUndo—Remove A Selection of Undo Elements

[0301] This routine removes the selected imbedded undo elements from the edit view document.

[0302] for all selected elements in document

[0303] if undo element

[0304] RemoveUndoElement—REMOVE UNDO ELEMENT

[0305] rebuild view and refresh display

[0306] RemoveUndoElement—Remove Undo Element

[0307] This routine removes the specified imbedded undo element from the edit view document. Usually this is invoked by a higher-level function that either removes a processed undo element, or all those imbedded undo elements in the document view that belong to one particular undo unit, or that are of a certain type. If both TYPE_CHANGE and TYPE_INSERTION flag bits are set, the undo element will be treated as a CHANGE one. CHANGE and DELETION undo elements are deleted. An INSERTION undo element is restored to be a regular text element.

[0308] save original state of parser trigger recording

[0309] disable parser trigger recording

[0310] disable undo recording

[0311] if TYPE DELETION or TYPE_CHANGE flag bit set

[0312] delete the element

[0313] else if TYPE_INSERTION flag bit set

[0314] /* i.e., here not both TYPE_CHANGE+TYPE_INSERTION flag bits set */

[0315] remove the SHOW formatting attributes

[0316] drop class UNDO from the element

[0317] clear undo element type indication from prefix area

[0318] re-enable undo recording

[0319] restore original state of parser trigger recording

[0320] if not called from another undo function

[0321] rebuild view and refresh display

[0322] (3) Processing Imbedded Undo Elements

[0323] RestoreSelectedUndo—Process A Selection of Undo Elements

[0324] This routine restores the changes indicated by the selected imbedded undo elements. Where several selected imbedded undo records refer to changes to the same text element, only the most recent change is restored.

[0325] for all selected elements in document

[0326] if undo element

[0327] RestoreUndoElement—RESTORE UNDO ELEMENT

[0328] rebuild view and refresh display

[0329] RestoreUndoElement—Restore Undo Element

[0330] This routine restores the referenced text element or location in the document, according to the type of the imbedded undo element, effectively undoing the particular change. The text element is restored, and the currently affected text is added to the undo buffer in the regular manner. Note that processing an imbedded undo record in this manner is not a regular undo action, but rather a new change to the document. It gets added into the Undo Stack of the document like any other text change.

[0331] The document edit view must now be updated in order to display the current state of the imbedded undo elements that presently refer to this text. Depending of the active mode of imbedding undo elements and the particular edit system implementation, the imbedded undo elements in the document edit view may be updated automatically as a result of restoring the undo element.

[0332] if undo element

[0333] if TYPE_CHANGE flag bit set

[0334] change referenced element with contents (text, prefix area, etc.) of the undo element

[0335] remove the processed undo element

[0336] else if TYPE_INSERTION flag bit set

[0337] /* i.e.here not both TYPE_CHANGE+TYPE_INSERTION flag bits set */

[0338] make referenced element a regular text element (drop anything that has to do with imbedded undo record and SHOW element)

[0339] else /* i.e., TYPE_DELETION flag bit set */

[0340] insert an element at the referenced location with contents (text, prefix area, etc.) of the undo element

[0341] remove the processed undo element

[0342] rebuild view and refresh display

[0343] (4) Other Functions

[0344] NextUndoElement—Go to the Next Imbedded Undo Element

[0345] This routine moves the cursor position to the next (if any) undo element imbedded in the document edit view.

[0346] from current cursor position to end of document

[0347] if an undo element

[0348] move cursor to this element

[0349] rebuild view and refresh display

[0350] PreviousUndoElement—Go to the Previous Imbedded Undo Element

[0351] This routine moves the cursor position the previous (if any) undo element imbedded in the document edit view.

[0352] from current cursor position to start of document

[0353] if an undo element

[0354] move cursor to this element

[0355] rebuild view and refresh display

[0356] HelpUndo—Give Help for Imbedded Undo Element

[0357] This routine provides general help about undo elements and specific help for the type of undo element.

[0358] if cursor located on an undo element

[0359] if help for type of undo registered with the edit system

[0360] create help instance

[0361] invoke help display

[0362] return

[0363] run original command bound to the contextual-help key

[0364] ZoomOnUndo—Zoom in on Imbedded Undo Elements

[0365] This routine zooms in on (filters) undo elements in the document edit view. A parameter indicates what type(s) of undo elements should be toggled, added to, or removed from the display: INSERTION, DELETION, or CHANGE.

[0366] When the document view screen fields are built, their visibility and, accordingly, their inclusion or exclusion from the current view, is determined based on their type, and the type(s) selected to display. ZoomOnUndo routine sets the new desired visibility flags, then calls to rebuild the view and refresh the display.

[0367] SelectAllUndo—Select All Undo Elements

[0368] The routine selects all the undo elements in the document edit view.

[0369] for all elements in document

[0370] if undo element

[0371] select element

[0372] DeselectAllUndo—Deselect All Undo Elements

[0373] This routine deselects all the undo elements in the document edit view.

[0374] for all elements in document

[0375] if undo element

[0376] deselect element

[0377] PopupUndo—Initialize Popup Menu

[0378] This routine adds any menu items related to imbedded undo elements to a popup window ready to display. If both TYPE_CHANGE and TYPE_INSERTION flag bits are set, the undo element will be treated as a CHANGE one.

[0379] if cursor on undo element

[0380] add “Remove undo element” menu item, and

[0381] bind it to edit system's command RemoveUndoElement

[0382] if TYPE_CHANGE flag bit set

[0383] add “Restore changed record” menu item, and

[0384] bind it to edit system's command RestoreUndoElement

[0385] if TYPE_INSERTION flag bit set

[0386] add “Restore inserted record” menu item, and

[0387] bind it to edit system's command RestoreUndoElement

[0388] else /* i.e., TYPE_DELETION flag bit set */

[0389] add “Restore deleted record” menu item, and

[0390] bind it to edit system's command RestoreUndoElement

[0391] From the provisions of the above pseudo code and accompanying descriptions, the building, developing and creating actual code to implement the previously described routines and functions in an edit system in order to carry out the subject invention is believed to be well within the skill and abilities of a competent programmer and particularly one familiar with edit systems.

[0392] It should be readily understood that the foregoing description is only illustrative of the invention and in particular is only a preferred embodiment of the invention. Various alternatives and modifications can be devised by those skilled in the art without departing from the spirit of the invention. Accordingly, the present invention is intended to embrace all such alternatives, modifications and variations which fall within the scope of the appended claims.