1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232
|
from enum import Enum, auto
import logging
from typing import TYPE_CHECKING, Callable, Optional
from patshared import ViewData, ViewsDictEnsureOne, PortTypesViewFlag
if TYPE_CHECKING:
from patchbay_manager import PatchbayManager
_logger = logging.getLogger(__name__)
class CancelOp(Enum):
PTV_CHOICE = auto()
'Save the port types view choice only'
VIEW_CHOICE = auto()
'save the view choice only'
VIEW = auto()
'save all the current view'
ALL_VIEWS = auto()
'save all the views'
ALL_VIEWS_NO_POS = auto()
'save all the views, without group positions'
class ActionRestorer:
def __init__(self, op_type: CancelOp):
self.type = op_type
self.name = ''
self.view_num_bef = 1
self.view_num_aft = 1
self.view_data_bef: Optional[ViewData] = None
self.view_data_aft: Optional[ViewData] = None
self.views_bef : Optional[ViewsDictEnsureOne] = None
self.views_aft: Optional[ViewsDictEnsureOne] = None
self.ptv_bef: Optional[PortTypesViewFlag] = None
self.ptv_aft: Optional[PortTypesViewFlag] = None
self.undo_func: Optional[Callable] = None
self.undo_args: tuple = ()
self.redo_func: Optional[Callable] = None
self.redo_args: tuple = ()
class CancellableAction:
'''Context for 'with' statment. save the data at begin and at end
for undo/redo actions'''
def __init__(self, mng: 'PatchbayManager', op_type: CancelOp, *datas):
self.cancel_mng = mng.cancel_mng
self.op_type = op_type
def __enter__(self) -> ActionRestorer:
return self.cancel_mng.prepare(self.op_type)
def __exit__(self, *args, **kwargs):
self.cancel_mng.post_prepare(self.op_type)
class CancelMng:
def __init__(self, mng: 'PatchbayManager'):
self.mng = mng
self.actions = list[ActionRestorer]()
self.canceled_acts = list[ActionRestorer]()
self.new_pos_created = False
'''In VIEW_CHOICE action, GroupPos can be be created in a view
, in this case, cancel_mng considers finally this action
as ALL_VIEWS.'''
self._recording = False
def prepare(self, op_type: CancelOp):
if self._recording:
raise RecursionError
self.new_pos_created = False
self._recording = True
action = ActionRestorer(op_type)
action.view_num_bef = self.mng.view_number
match op_type:
case CancelOp.VIEW|CancelOp.PTV_CHOICE:
action.view_data_bef = self.mng.view().copy()
if op_type is CancelOp.PTV_CHOICE:
action.ptv_bef = self.mng.port_types_view
case CancelOp.VIEW_CHOICE|CancelOp.ALL_VIEWS:
action.views_bef = self.mng.views.copy()
case CancelOp.ALL_VIEWS_NO_POS:
action.views_bef = self.mng.views.copy(with_positions=False)
self.actions.append(action)
self.canceled_acts.clear()
return action
def post_prepare(self, op_type: CancelOp):
self._recording = False
if not self.actions:
# should not happen, prepare has just added an action
return
action = self.actions[-1]
if not action.type is op_type:
# should not happen, for the same reason
return
match op_type:
case CancelOp.VIEW_CHOICE:
if self.new_pos_created:
action.type = CancelOp.ALL_VIEWS
else:
action.view_data_bef = None
case CancelOp.PTV_CHOICE:
if self.new_pos_created:
action.type = CancelOp.VIEW
action.ptv_bef = None
else:
action.view_data_bef = None
action.ptv_aft = self.mng.port_types_view
action.view_num_aft = self.mng.view_number
match action.type:
case CancelOp.VIEW:
action.view_data_aft = self.mng.view().copy()
case CancelOp.ALL_VIEWS:
action.views_aft = self.mng.views.copy()
case CancelOp.ALL_VIEWS_NO_POS:
action.views_aft = self.mng.views.copy(with_positions=False)
self.mng.sg.undo_redo_changed.emit()
def undo(self):
if not self.actions:
return
action = self.actions.pop(-1)
self.canceled_acts.append(action)
if action.undo_func is not None:
action.undo_func(*action.undo_args)
match action.type:
case CancelOp.PTV_CHOICE:
if action.ptv_bef is None:
_logger.error(f"action {action.name} has no ptv_bef")
return
self.mng.change_port_types_view(action.ptv_bef)
case CancelOp.VIEW_CHOICE:
self.mng.change_view(action.view_num_bef)
case CancelOp.VIEW:
if action.view_data_bef is None:
_logger.error(f"action {action.name} has no view_data_bef")
return
self.mng.views[action.view_num_bef] = action.view_data_bef.copy()
self.mng.set_views_changed()
self.mng.change_view(action.view_num_bef)
case CancelOp.ALL_VIEWS:
if action.views_bef is None:
_logger.error(f"action {action.name} has no views_bef")
return
self.mng.views = action.views_bef.copy()
self.mng.set_views_changed()
self.mng.change_view(action.view_num_bef)
case CancelOp.ALL_VIEWS_NO_POS:
if action.views_bef is None:
_logger.error(f"action {action.name} has no views_bef")
return
self.mng.views.eat_views_dict_datas(action.views_bef)
self.mng.set_views_changed()
self.mng.change_view(action.view_num_bef)
self.mng.sg.undo_redo_changed.emit()
def redo(self):
if not self.canceled_acts:
return
action = self.canceled_acts.pop(-1)
self.actions.append(action)
if action.redo_func is not None:
action.redo_func(*action.redo_args)
if action.type is CancelOp.VIEW_CHOICE:
self.mng.change_view(action.view_num_aft)
elif action.type is CancelOp.PTV_CHOICE:
if action.ptv_aft is None:
_logger.error(f"action {action.name} has no ptv_aft")
return
self.mng.change_port_types_view(action.ptv_aft)
elif action.type is CancelOp.VIEW:
if action.view_data_aft is None:
_logger.error(f"action {action.name} has no ptv_aft")
return
self.mng.views[action.view_num_aft] = action.view_data_aft.copy()
self.mng.set_views_changed()
self.mng.change_view(action.view_num_aft)
elif action.type is CancelOp.ALL_VIEWS:
if action.views_aft is None:
_logger.error(f"action {action.name} has no ptv_aft")
return
self.mng.views = action.views_aft.copy()
self.mng.set_views_changed()
self.mng.change_view(action.view_num_aft)
self.mng.sg.undo_redo_changed.emit()
def reset(self):
self.actions.clear()
self.canceled_acts.clear()
self.mng.sg.undo_redo_changed.emit()
|