Package ghidra.app.merge

Class MergeManager

    • Field Detail

      • currentIndex

        protected int currentIndex

      • inputReceived

        protected volatile boolean inputReceived

      • mergeStatus

        protected boolean mergeStatus

      • prompting

        protected volatile boolean prompting

      • mergeCompleted

        protected volatile boolean mergeCompleted

      • mergeToolIsVisible

        protected volatile boolean mergeToolIsVisible

      • resolveMap

        protected java.util.Hashtable<java.lang.String,​java.lang.Object> resolveMap

    • Method Detail

      • createMergeResolvers

        protected abstract void createMergeResolvers()

      • getDomainObject

        public UndoableDomainObject getDomainObject​(int version)
        Returns one of the four programs involved in the merge as indicated by the version.
        Parameters:
        version - the program version to return. (LATEST, MY, ORIGINAL, or RESULT).
        Returns:
        the indicated program version or null if a valid version isn't specified.
        See Also:
        MergeConstants

      • initializeMerge

        protected abstract void initializeMerge()

      • cleanupMerge

        protected abstract void cleanupMerge()

      • getPreferredMergeToolSize

        protected java.awt.Dimension getPreferredMergeToolSize()

      • setApplyEnabled

        public void setApplyEnabled​(boolean enabled)
        Enable the apply button according to the "enabled" parameter.
        Specified by:
        setApplyEnabled in interface DomainObjectMergeManager

      • showDefaultMergePanel

        public void showDefaultMergePanel​(java.lang.String description)
        Show the default merge panel. The default merge panel now shows the status of each phase of the merge and also the progress in the current phase.
        Parameters:
        description - description of current merge process near the top of the merge tool.

      • showComponent

        public void showComponent​(javax.swing.JComponent comp,
                          java.lang.String componentID,
                          HelpLocation helpLoc)
        Show the component that is used to resolve conflicts. This method is called by the MergeResolvers when user input is required. If the component is not null, this method blocks until the user either cancels the merge process or resolves a conflict. If comp is null, then the default component is displayed, and the method does not wait for user input.
        Specified by:
        showComponent in interface DomainObjectMergeManager
        Parameters:
        comp - component to show; if component is null, show the default component and do not block
        componentID - id or name for the component

      • removeComponent

        public void removeComponent​(javax.swing.JComponent comp)
        Removes the component that is used to resolve conflicts. This method is called by the MergeResolvers when user input is no longer required using the specified component.
        Parameters:
        comp - component to show; if component is null, show the default component and do not block

      • showMergeTool

        protected void showMergeTool()

      • showMonitorComponent

        public void showMonitorComponent​(boolean show)
        Shows/hides the monitor component at the bottom of the merge tool.
        Parameters:
        show - true means to show the task monitor at the bottom of the merge tool.

      • showProgressIcon

        public void showProgressIcon​(boolean show)
        Shows/hides the progress icon (spinning globe) at the bottom of the merge tool.
        Parameters:
        show - true means to show the icon.

      • isPromptingUser

        public boolean isPromptingUser()
        Determines whether or not the user is being prompted to resolve a conflict.
        Returns:
        true if the user is being prompted for input.

      • processingCompleted

        public boolean processingCompleted()
        Return whether the merge process has completed. (Needed for Junit testing only.)

      • displayErrorAndWait

        public static void displayErrorAndWait​(java.lang.Object originator,
                                       java.lang.String title,
                                       java.lang.String msg)
        Display error message dialog in a blocking fashion.
        Parameters:
        originator - message originator
        title - dialog title
        msg - dialog message

      • waitForInput

        protected void waitForInput()
        Block until the user completes the current merge operation, or cancels the merge process.

      • getResolveInformation

        public java.lang.Object getResolveInformation​(java.lang.String infoType)
        Gets the resolve information object for the indicated standardized name. This is how information is passed between merge managers.
        For example:
        the data type merger knows what data type in the result is equivalent to a given data type from my checked out program. The code unit and function mergers need to be able to get this information so they don't unknowingly re-introduce a data type that was already eliminated by a data type conflict.
        Parameters:
        infoType - the string indicating the type of resolve information
        Returns:
        the object for the named string or null

      • setResolveInformation

        public void setResolveInformation​(java.lang.String infoType,
                                  java.lang.Object infoObject)
        Sets the resolve information object for the indicated standardized name. This is how information is passed between merge managers.
        Specified by:
        setResolveInformation in interface DomainObjectMergeManager
        Parameters:
        infoType - the string indicating the type of resolve information
        infoObject - the object for the named string. This information is determined by the merge manager that creates it.
        See Also:
        getResolveInformation(java.lang.String)

      • getMergeResolverByName

        public MergeResolver getMergeResolverByName​(java.lang.String name)
        Returns the named merge resolver from the ones used directly by the MergeManager.
        Parameters:
        name - the name of the desired merge resolver
        Returns:
        the merge resolver or null.

      • getMergeTool

        public PluginTool getMergeTool()
        For Junit tests
        Returns:
        the merge tool

      • isMergeToolVisible

        public boolean isMergeToolVisible()
        Determines if the modal merge tool is currently displayed on the screen.
        Returns:
        true if the merge tool is displayed.

      • getMergeProgressPanel

        public MergeProgressPanel getMergeProgressPanel()
        gets the default merge progress panel that indicates all the phases and their current status.
        Returns:
        the merge panel that indicates progress.

      • getMonitorComponent

        public javax.swing.JComponent getMonitorComponent()
        Gets the TaskMonitor component that is displayed at the bottom of the merge tool.
        Returns:
        the task monitor component.

      • updateProgress

        public void updateProgress​(java.lang.String description)
        Updates the current phase progress area in the default merge panel.
        Specified by:
        updateProgress in interface MergeProgressModifier
        Parameters:
        description - a message describing what is currently occurring in this phase. Null indicates to use the default message.

      • updateProgress

        public void updateProgress​(int currentProgressPercentage)
        Updates the current phase progress area in the default merge panel.
        Specified by:
        updateProgress in interface MergeProgressModifier
        Parameters:
        currentProgressPercentage - the progress percentage completed for the current phase. This should be a value from 0 to 100.

      • updateProgress

        public void updateProgress​(int currentProgressPercentage,
                           java.lang.String progressMessage)
        Updates the current phase progress area in the default merge panel.
        Specified by:
        updateProgress in interface MergeProgressModifier
        Parameters:
        currentProgressPercentage - the progress percentage completed for the current phase. This should be a value from 0 to 100.
        progressMessage - a message indicating what is currently occurring in this phase.

      • setInProgress

        public void setInProgress​(java.lang.String[] mergePhase)
        The manager (MergeResolver) for a particular merge phase should call this when its phase or sub-phase begins. The string array should match one that the returned by MergeResolver.getPhases().
        Specified by:
        setInProgress in interface MergeProgressModifier
        Parameters:
        mergePhase - identifier for the merge phase to change to in progress status.
        See Also:
        MergeResolver

      • setCompleted

        public void setCompleted​(java.lang.String[] mergePhase)
        The manager (MergeResolver) for a particular merge phase should call this when its phase or sub-phase completes. The string array should match one that the returned by MergeResolver.getPhases().
        Specified by:
        setCompleted in interface MergeProgressModifier
        Parameters:
        mergePhase - identifier for the merge phase to change to completed status.
        See Also:
        MergeResolver