-

-Methods such as basicCommand.Done, basicCommand._enterMode,

-basicCommand._exitMode and CommandSequencer.start_using_mode need cleanup

-(needs to be done together).

-

-This is happening as part of a big command sequencer refactoring

-by Bruce & Ninad, circa 080812 (ongoing).

-from utilities.debug_prefs import debug_pref, Choice_boolean_False ##, Choice_boolean_True

-DEBUG_TO_HELP_STRIP_OUT_OLD_COMMAND_API_METHODS = False # Temporary debug flag, can be removed when safe -- Ninad 2008-09-26

-

- abstract superclass for all Command objects, including nullCommand

-

- from utilities.constants import CL_ABSTRACT

- command_level = CL_ABSTRACT

- # command_level is not yet documented, part of command stack refactoring

-

- command_parent = None

- # Subclasses should set this to the commandName of the parent command

- # they require, if any (and if that is not the default command).

- # (Whether they require a parent command at all is determined by

- # their command_level attribute.)

- #

- # For example, BreakStrands_Command requires parent command "Build Dna",

- # so it sets this to 'BUILD_DNA' == BuildDna_EditCommand.commandName.

- # This attr is used in a revised command stack scheme as of 2008-07-28

- # (still being developed).

-

- is_null = False # overridden only in nullCommand

-

- # internal name of command, e.g. 'DEPOSIT',

- # only seen by users in "debug" error messages;

- # might be used to create some prefs_keys and/or in some prefs values

- # [but I don't know if any such uses remain -- bruce 080727 comment]

- commandName = "(bug: missing commandName 1)"

-

-

-

- def get_featurename(self):

- return "null command" # should never be seen [revised, bruce 080727]

-

-

- # TODO: revise the 'mode' term in the following attribute names

-

- def Done(self, *args, **kws):

- #bruce 060316 added this to remove frequent harmless debug print

- pass

-

- # in conjunction with the Command Sequencer (e.g. it implements

- # Done, _f_userEnterCommand, init_gui, etc etc); and basicCommand, which

- from utilities.constants import CL_ABSTRACT

- command_level = CL_ABSTRACT

-

- # [bruce 080909]

-

-

- FlyoutToolbar_class = None

- #Command subclasses can override this class constant with the appropriate

- #Flyout Toolbar class.

-

- flyoutToolbar = None #bruce 080924, redundant with baseCommand when we use that

-

- ### bruce 050130 removing 'Done' temporarily; see PanMode.Done for why.

- # later note: as of 070521, we always get warned "subclass movieMode

- # overrides basicMode._exitMode". I am not sure whether this override is

- # legitimate, so I'm not removing the warning for now. [bruce 070521]

- if DEBUG_TO_HELP_STRIP_OUT_OLD_COMMAND_API_METHODS: ### TODO: enable this once we'll never go back, to help strip out obsolete code

- # also complain about commands not fully ported to the new API

- # (i.e. in which obsolete methods are still defined)

- for methodname, howtofix in (

- ('Enter', ""),

- ('init_gui', ""),

- ('resume_gui', ""),

- ('Done', ""),

- ('StateDone', ""),

- ('StateCancel', ""),

- ('restore_gui', ""),

- ('restore_patches_by_Command', ""),

- ('clear_command_state', ""),

- ('haveNontrivialState', ""),

- ):

- weird_to_override += [methodname]

- # todo: print howtofix when needed

- continue

- pass

- (self.__class__.__name__, attr) # todo: print howtofix as well

-

-

- # Note [obs?]: if we extend the conf. corner to "generators" in the short term,

- # before the "command sequencer" is implemented, some of the following methods

- # may be revised to delegate to the "current generator" or its PM.

- # If so, when doing this, note that many modes currently act as their own PM widget.

-

- def _KLUGE_current_PM(self, get_old_PM = False): #bruce 070627; new option 080819

- """

- private method, and a kluge;

- see KLUGE_current_PropertyManager docstring for more info

- """

- if not get_old_PM:

- return self.propMgr

-

- pw = self.w.activePartWindow()

- if not pw:

- # I don't know if pw can be None

- print "fyi: _KLUGE_current_PM sees pw of None" ###

- return None

- try:

- res = pw.KLUGE_current_PropertyManager()

- if res is not self.propMgr and not get_old_PM:

- # I think this should now be rare, now that Ninad removed

- # all official "guest PM" commands; let's find out...

- # unfortunately it's common, apparently due to a logic bug

- # in terms of when we access this vs. when various things are

- # updated, since the PMs don't match the command objects in the

- # debug prints (see below, when entering or exiting Break Strands) --

- # or maybe it's a side effect of an exception in entering it, in

- # current code? Try again when that bug is fixed... #### trying this now, 080812

- #

- ## debug note: _KLUGE_current_PM returns

- ## <dna.commands.BreakStrands.BreakStrands_PropertyManager.BreakStrands_PropertyManager

- ## object at 0xb333858>, but <commands.SelectChunks.SelectChunks_Command.SelectChunks_Command

- ## object at 0x9f66870>.propMgr is None

- #

- # [bruce 080806]

- ## pass

- print "debug note: _KLUGE_current_PM returns %r, but %r.propMgr is %r" % \

- (res, self, self.propMgr) ### if happens, fix; if not, clean up all calls

-## assert 0, "failure in _KLUGE_current_PM, see console prints"

-## #bruce 080812 (temporary) -- make this un-missable by

-## # developers, for next few days -- also added 'raise' below

- return res

- except:

-## raise #bruce 080812 (temporary) -- goes with above assert 0

- # I don't know if this can happen

- msg = "ignoring exception in %r.KLUGE_current_PropertyManager()" % (pw,)

- print_compact_traceback(msg + ": ")

- return None

- pass

-

- pm = self._KLUGE_current_PM()

-

-

-

- def _init_gui_flyout_action( self, action_attr, parentCommandName = None ):

- """

- [helper method for command entry]

-

- If our direct parent command has the expected commandName,

- copy self.flyoutToolbar from it and call setChecked on the specified

- action in it (if it has that action) (setting self.flyoutToolbar = None

- if any of this fails by raising AttributeError, with no error message)

- and return the parent command. Otherwise return None.

-

- @param action_attr: attribute name of this command's action in

- this or parent command's flyout toolbar.

- Example: 'breakStrandAction'

- @type: string

-

- @param parentCommandName: commandName of expected parent command;

- if not provided or None, we use

- self.command_parent for this.

- Example: 'BUILD_DNA'

- @type: string

-

- @return: parent command, if it has expected commandName, otherwise None.

- @rtype: Command or None

-

- [helper method for use in init_gui implementations;

- might need refactoring]

- """

-

- if not action_attr:

- return

-

- #bruce 080726 split this out of init_gui methods (by Ninad)

- # of several Commands.

- if parentCommandName is None:

- parentCommandName = self.command_parent

- assert self.command_parent, \

- "_init_gui_flyout_action in %r requires " \

- "self.command_parent assignment" % self

- # note: it's ok that we don't interpret command_parent = None

- # as the default commandName here, since the default command has no

- # flyout toolbar. This only works by accident; it might be more

- # principled to check self.is_fixed_parent_command() instead, once

- # that's always defined, and if it's true, interpret

- # command_parent = None as being the name of the default command.

- # [bruce 080814 comment]

-

- #bruce 080804

- parentCommand = self.parentCommand

- assert parentCommand # should be already set by now (during command_entered)

- if parentCommand.commandName == parentCommandName:

- try:

- self.flyoutToolbar = parentCommand.flyoutToolbar

- #Need a better way to deal with changing state of the

- #corresponding action in the flyout toolbar. To be revised

- #during command toolbar cleanup

- action = getattr(self.flyoutToolbar, action_attr)

- action.setChecked(True)

- except AttributeError:

- # REVIEW: this could have several causes; would any of them

- # be bugs and deserve an error message? [bruce 080726 questions]

- self.flyoutToolbar = None

- return parentCommand

- else:

- print "fyi: _init_gui_flyout_action in %r found wrong kind " \

- "of parent command" % self # not sure if this ever happens; might be a bug if so

- return None

- pass

- def is_default_command(self): #bruce 080709 refactoring

- return self.commandName == self.commandSequencer.default_commandName()

-

-

- # [mostly obsolete after USE_COMMAND_STACK (new command API , which

- def _warning_for_abandon(self, str, bother_user_with_dialog = 0, ensure_visible = 1):

- # TODO: cleanup; rename str to not mask python builtin;

- # merge with other 'def warning' methods and with

- str = str[0].upper() + str[1:] # capitalize the sentence

- msg = "%s: %s" % (prefix, str,)

- return

-

-

- # note: this implem ought to work both before and after the

- # command stack refactoring related to USE_COMMAND_STACK;

- # after it, it could be rewritten to not use self.commandSequencer

- def find_parent_command_named(self, commandName): #bruce 080801; maybe untested

- # note: this implem ought to work both before and after the

- # command stack refactoring related to USE_COMMAND_STACK;

- # after it, it should be reviewed for possible simplification.

- def find_parentCommand(self): #bruce 080813; won't be needed once .parentCommand always works

- cseq = self.commandSequencer

- commands = cseq.all_active_commands( starting_from = self )

- commands = commands[1:] # only look at our parent commands

- if not commands:

- res = None

- else:

- res = commands[0]

- if self.command_parent:

- assert res is self.find_parent_command_named( self.command_parent) # not sure this is always required...

- # note: this doesn't run when self.is_fixed_parent_command() and

- # self.command_parent is None, meaning the default command!

- # ok for now, since it's only an assert.

-

- assert res is self.parentCommand

- # maybe: if not, add a property to make this always true... then use it

- # to replace all calls of _reuse_attr_of_parentCommand with direct assignments.

- return res

-

-

-

- FlyoutToolbar_class = None #Ninad 2008-09-12

- #Command subclasses can override this class attr with the appropriate

- #Flyout Toolbar class. This is used to create a FlyoutToolbar object

- #for the commands. this attr is also used to do flyout toolbar updates.

- #Example: if the value of this attr is None then it either implies the

- #command should use the flyout toolbar of the parent command and do

- #some more UI changes to it (example check an action) OR the command

- #shouldn't do anything with the flyout at all (this is decided using the

- #'command_level)

- #@see: self.command_update_flyout()

- #@see: self._command_entered_prepare_flyout()

- #@see: self._createFlyouttoolbarObject()

-

- flyoutToolbar = None

-

-

- (e.g. Done vs Cancel vs Abandon/exit_all_commands), or on

- the command being exited from or intended to be entered,

- command_exit_misc_actions and command_exit_flyout.

-

- and command_enter_misc_actions.

-

- self.graphicsMode.Enter_GraphicsMode() ### REVIEW: refactor into a subclass which defines this attr?

- # note: existing implems do some state-resetting (good)

-

- This method is called in self.command_entered(). Subclasses shoule

- return flyout

-

-

- def command_update_state(self): ### tentative; details under discussion

- # note: likely implem of call to this: a new cseq method is called by

- # existing method command_post_event_ui_updater, which loops over the methods

- # described in the docstring

- # note: code now in model_changed and other update methods

- # is divided up into the new update methods listed here.

-

- parentCommandName = parentCommandString)

-