/*******************************************************************************
* CogTool Copyright Notice and Distribution Terms
* CogTool 1.3, Copyright (c) 2005-2013 Carnegie Mellon University
* This software is distributed under the terms of the FSF Lesser
* Gnu Public License (see LGPL.txt).
*
* CogTool is free software; you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation; either version 2.1 of the License, or
* (at your option) any later version.
*
* CogTool is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with CogTool; if not, write to the Free Software
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*
* CogTool makes use of several third-party components, with the
* following notices:
*
* Eclipse SWT version 3.448
* Eclipse GEF Draw2D version 3.2.1
*
* Unless otherwise indicated, all Content made available by the Eclipse
* Foundation is provided to you under the terms and conditions of the Eclipse
* Public License Version 1.0 ("EPL"). A copy of the EPL is provided with this
* Content and is also available at http://www.eclipse.org/legal/epl-v10.html.
*
* CLISP version 2.38
*
* Copyright (c) Sam Steingold, Bruno Haible 2001-2006
* This software is distributed under the terms of the FSF Gnu Public License.
* See COPYRIGHT file in clisp installation folder for more information.
*
* ACT-R 6.0
*
* Copyright (c) 1998-2007 Dan Bothell, Mike Byrne, Christian Lebiere &
* John R Anderson.
* This software is distributed under the terms of the FSF Lesser
* Gnu Public License (see LGPL.txt).
*
* Apache Jakarta Commons-Lang 2.1
*
* This product contains software developed by the Apache Software Foundation
* (http://www.apache.org/)
*
* jopt-simple version 1.0
*
* Copyright (c) 2004-2013 Paul R. Holser, Jr.
*
* Permission is hereby granted, free of charge, to any person obtaining
* a copy of this software and associated documentation files (the
* "Software"), to deal in the Software without restriction, including
* without limitation the rights to use, copy, modify, merge, publish,
* distribute, sublicense, and/or sell copies of the Software, and to
* permit persons to whom the Software is furnished to do so, subject to
* the following conditions:
*
* The above copyright notice and this permission notice shall be
* included in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
* LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
* OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
* WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*
* Mozilla XULRunner 1.9.0.5
*
* The contents of this file are subject to the Mozilla Public License
* Version 1.1 (the "License"); you may not use this file except in
* compliance with the License. You may obtain a copy of the License at
* http://www.mozilla.org/MPL/.
* Software distributed under the License is distributed on an "AS IS"
* basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See the
* License for the specific language governing rights and limitations
* under the License.
*
* The J2SE(TM) Java Runtime Environment version 5.0
*
* Copyright 2009 Sun Microsystems, Inc., 4150
* Network Circle, Santa Clara, California 95054, U.S.A. All
* rights reserved. U.S.
* See the LICENSE file in the jre folder for more information.
******************************************************************************/
package edu.cmu.cs.hcii.cogtool.controller;
import java.util.Iterator;
import java.util.Map;
import edu.cmu.cs.hcii.cogtool.model.AUndertaking;
import edu.cmu.cs.hcii.cogtool.model.CognitiveModelGenerator;
import edu.cmu.cs.hcii.cogtool.model.Design;
import edu.cmu.cs.hcii.cogtool.model.Frame;
import edu.cmu.cs.hcii.cogtool.model.ISimilarityDictionary;
import edu.cmu.cs.hcii.cogtool.model.TaskApplication;
import edu.cmu.cs.hcii.cogtool.model.Project;
import edu.cmu.cs.hcii.cogtool.model.WidgetAttributes;
import edu.cmu.cs.hcii.cogtool.model.Project.ITaskDesign;
import edu.cmu.cs.hcii.cogtool.util.NullSafe;
import edu.cmu.cs.hcii.cogtool.util.UndoManager;
/**
* Utility to support the recovery of UndoManagers when the
* undoable edits referring to model objects are no longer accessible.
*/
public class UndoManagerRecovery
{
// Prevent instantiation
private UndoManagerRecovery() { }
/**
* Recover UndoManagers for the given model object.
*
* @param project the project containing the model object
* @param editObject the given model instance.
*/
public static void recoverManagers(Project project, Object editObject)
{
try {
UndoManager.recoverUndoManager(editObject,
project);
}
catch (IllegalStateException ex) {
System.out.println("Ignoring that recoverUndoManager failed");
}
}
/**
* Recover UndoManagers for the given TaskApplication instance and
* all the IScripts it contains.
*
* @param project the project containing the model objects
* @param taskApp TaskApplication
* @param stopTrackingEdits whether to stop tracking edits for the
* associated Demonstration
*/
public static void recoverScriptManagers(Project project,
TaskApplication taskApp,
boolean stopTrackingEdits)
{
recoverManagers(project, taskApp);
Iterator<CognitiveModelGenerator> modelGens =
taskApp.getModelGenerators();
while (modelGens.hasNext()) {
CognitiveModelGenerator modelGen = modelGens.next();
recoverManagers(project, taskApp.getScript(modelGen));
}
if (stopTrackingEdits) {
DemoStateManager.stopTrackingEdits(project, taskApp);
}
}
/**
* Recover UndoManagers for the given TaskApplication instances and
* all the IScripts they contain.
*
* @param project the project containing the model objects
* @param associatedTAs maps ITaskDesign to TaskApplication
* @param stopTrackingEdits whether to stop tracking edits for the
* associated Demonstration
*/
public static void recoverScriptManagers(Project project,
Map<ITaskDesign, TaskApplication> associatedTAs,
boolean stopTrackingEdits)
{
// Recover UndoManagers for associated task applications
// (used by SEFrameChooserControllers)
Iterator<TaskApplication> taskApps = associatedTAs.values().iterator();
while (taskApps.hasNext()) {
TaskApplication ta = taskApps.next();
recoverScriptManagers(project, ta, stopTrackingEdits);
}
}
/**
* Recover UndoManagers for the given task/task group and its associated
* task applications.
*
* @param project the project containing the model objects
* @param undertaking task whose ITaskApplications to recover managers for
* @param associatedTAs maps ITaskDesign to TaskApplication
*/
public static void recoverManagers(Project project,
AUndertaking undertaking,
Map<ITaskDesign, TaskApplication> associatedTAs)
{
recoverScriptManagers(project, associatedTAs, true);
}
/**
* Recover UndoManagers for the given design and its associated
* task applications. Also recovers for the design's frames and widgets.
*
* @param project the project containing the model objects
* @param design design whose ITaskApplications to recover managers for
* @param associatedTAs maps ITaskDesign to TaskApplication
*/
public static void recoverManagers(Project project,
Design design,
Map<ITaskDesign, TaskApplication> associatedTAs)
{
DemoStateManager.removeStateManager(project, design);
// Recover UndoManagers for design's frames
// (used by FrameEditorControllers)
Iterator<Frame> frames = design.getFrames().iterator();
while (frames.hasNext()) {
Frame frame = frames.next();
recoverManagers(project, frame);
}
recoverScriptManagers(project, associatedTAs, false);
// Recover UndoManager for design's dictionary, if one exists
ISimilarityDictionary dict =
(ISimilarityDictionary)
design.getAttribute(WidgetAttributes.DICTIONARY_ATTR);
if (! NullSafe.equals(dict, WidgetAttributes.NO_DICTIONARY)) {
recoverManagers(project, dict);
}
// Recover UndoManager for design (used by DesignEditorController)
recoverManagers(project, design);
}
}