CHitNodesTransformer.java

/*
Copyright 2011-2016 Google Inc. All Rights Reserved.

Licensed under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
package com.google.security.zynamics.zylib.yfileswrap.gui.zygraph.editmode.transformations;

import com.google.security.zynamics.zylib.gui.zygraph.editmode.CStateChange;
import com.google.security.zynamics.zylib.gui.zygraph.editmode.IMouseState;
import com.google.security.zynamics.zylib.gui.zygraph.editmode.IMouseStateChange;
import com.google.security.zynamics.zylib.yfileswrap.gui.zygraph.editmode.CStateFactory;

import y.base.Node;
import y.view.HitInfo;

import java.awt.event.MouseEvent;

/**
 * Utility class to encapsulate state changes for nodes.
 */
public final class CHitNodesTransformer {
  /**
   * Changes the state of the node depending on the current hitInfo.
   * 
   * @param m_factory The state factory for all states.
   * @param event The mouse event that caused the state change.
   * @param hitInfo The information about what was hit.
   * @param oldNode The node which we come from.
   * 
   * @return The state object that describes the mouse state.
   */
  public static CStateChange changeNode(final CStateFactory<?, ?> m_factory,
      final MouseEvent event, final HitInfo hitInfo, final Node oldNode) {
    final Node node = hitInfo.getHitNode();

    if (node == oldNode) {
      // TODO @Nils please check if this change does not break BinDiff behavior
      // It fixes case 4207.
      return new CStateChange(m_factory.createNodeHoverState(node, event), false);
    } else {
      m_factory.createNodeExitState(oldNode, event);

      return new CStateChange(m_factory.createNodeEnterState(node, event), true);
    }
  }

  /**
   * Changes the state to node enter state.
   * 
   * @param m_factory The state factory for all states.
   * @param event The mouse event that caused the state change.
   * @param hitInfo The information about what was hit.
   * 
   * @return The state object that describes the mouse state.
   */
  public static IMouseStateChange enterNode(final CStateFactory<?, ?> m_factory,
      final MouseEvent event, final HitInfo hitInfo) {
    final Node n = hitInfo.getHitNode();

    return new CStateChange(m_factory.createNodeEnterState(n, event), true);
  }

  /**
   * Changes the state depending on the hit information from a node state to a non node state.
   * 
   * @param m_factory The state factory for all states.
   * @param event The mouse event that caused the state change.
   * @param hitInfo The information about what was hit.
   * @param state The state which we come from.
   * 
   * @return The state object that describes the mouse state.
   */
  public static IMouseStateChange exitNode(final CStateFactory<?, ?> m_factory,
      final MouseEvent event, final HitInfo hitInfo, final IMouseState state) {
    if (hitInfo.hasHitNodeLabels()) {
      throw new IllegalStateException();
    } else if (hitInfo.hasHitEdges()) {
      return CHitEdgesTransformer.enterEdge(m_factory, event, hitInfo);
    } else if (hitInfo.hasHitEdgeLabels()) {
      return CHitEdgeLabelsTransformer.enterEdgeLabel(m_factory, event, hitInfo);
    } else if (hitInfo.hasHitBends()) {
      return CHitBendsTransformer.enterBend(m_factory, event, hitInfo);
    } else if (hitInfo.hasHitPorts()) {
      return new CStateChange(state, true);
    } else {
      // TODO @Nils please check if this change does not break BinDiff behavior
      // It fixes case 4207.
      // return new CStateChange(m_factory.createDefaultState(), true);
      return new CStateChange(m_factory.createDefaultState(), false);
    }
  }
}