Show consecutive keystrokes

Author	DaveJarvis <email>
Date	2020-07-25 18:25:41 GMT-0700
Commit	71a613939ee91ac53e77c6efb492a5a2622e6d06
Parent	357d4ef

src/main/com/whitemagicsoftware/kmcaster/ConsecutiveEventCounter.java

		+/*
		+ * Copyright 2020 White Magic Software, Ltd.
		+ *
		+ * All rights reserved.
		+ *
		+ * Redistribution and use in source and binary forms, with or without
		+ * modification, are permitted provided that the following conditions are met:
		+ *
		+ * o Redistributions of source code must retain the above copyright
		+ * notice, this list of conditions and the following disclaimer.
		+ *
		+ * o Redistributions in binary form must reproduce the above copyright
		+ * notice, this list of conditions and the following disclaimer in the
		+ * documentation and/or other materials provided with the distribution.
		+ *
		+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
		+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
		+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
		+ * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
		+ * HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
		+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
		+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
		+ * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
		+ * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
		+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
		+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
		+ */
		+package com.whitemagicsoftware.kmcaster;
		+
		+/**
		+ * Responsible for formatting a string that represents a particular count.
		+ * When the count exceeds the limit, the string representation shows that
		+ * the number of tallied events exceeds the limit. The string representation
		+ * is empty if fewer than two equal consecutive values are tallied.
		+ * <p>
		+ * If the new value is not the same as the old value, the tally is reset.
		+ * </p>
		+ */
		+public class ConsecutiveEventCounter<Event> {
		+ /**
		+ * Previous event in the event chain, used to decide when the sequence breaks.
		+ */
		+ private Event mPrevious;
		+
		+ /**
		+ * Increments when a repeated event is encountered, resets to 1 when the chain
		+ * of consecutive events is broken.
		+ */
		+ private int mCount = 1;
		+
		+ /**
		+ * The limit dictates how {@code mCount} is formatted.
		+ */
		+ private final int mLimit;
		+
		+ /**
		+ * Creates a new counter that will change its format if the value to apply
		+ * causes the count to exceed the given limit.
		+ *
		+ * @param limit The maximum consecutive values before changing the format,
		+ * must be greater than 1.
		+ */
		+ public ConsecutiveEventCounter( final int limit ) {
		+ assert limit > 1;
		+
		+ mLimit = limit;
		+ }
		+
		+ /**
		+ * Increments the internal counter if the given event matches the previous.
		+ * Answers whether the current count is part of a sequence.
		+ *
		+ * @param event The next event to tally.
		+ * @return {@code true} when the count is greater than 1.
		+ */
		+ public boolean apply( final Event event ) {
		+ assert event != null;
		+
		+ mCount = event.equals( mPrevious ) ? mCount + 1 : 1;
		+ mPrevious = event;
		+ return mCount > 1;
		+ }
		+
		+ /**
		+ * Returns a formatted string to indicate the number of times that the
		+ * given event has been applied in succession. If the number of times is
		+ * fewer than two, this will return the empty string.
		+ *
		+ * @return A formatted string that includes the tally.
		+ */
		+ @Override
		+ public String toString() {
		+ // Race-condition guard.
		+ final var count = mCount;
		+ final var s = Integer.toString( count );
		+ return count > 1 ? (count < mLimit ? "×" + s : mLimit + "+") : "";
		+ }
		+}

src/main/com/whitemagicsoftware/kmcaster/EventHandler.java

		import static com.whitemagicsoftware.kmcaster.HardwareState.SWITCH_RELEASED;
		import static com.whitemagicsoftware.kmcaster.ui.Constants.*;
		-import static javax.swing.SwingConstants.CENTER;
		-import static javax.swing.SwingConstants.TOP;
		+import static javax.swing.SwingConstants.*;

		/**

		component.setState( switchState );
		}
		-

		+ private final ConsecutiveEventCounter<String> mKeyCounter =
		+ new ConsecutiveEventCounter<>( 9 );

		/**

		else if( state.isHardwareState( SWITCH_PRESSED ) ) {
		// A non-modifier key has been pressed.
		+
		+ // Determine whether there are separate parts for the key label.
		final var index = keyValue.indexOf( ' ' );
		+
		+ final var calculator = new BoundsCalculator( component );
		+ final var compDimen = new ScalableDimension( calculator.computeSize() );

		// If there's a space in the name, the text before the space is
		// positioned in the upper-left while the text afterwards takes up
		// the remainder. This is used for number pad keys, backspace, enter,
		// tab, and a few others.
		if( index > 0 ) {
		- final var calculator = new BoundsCalculator( component );
		- final var compDimen = new ScalableDimension( calculator.computeSize() );
		final var supSize = compDimen.scale( .6f );
		final var mainSize = compDimen.scale( .9f );

		component.removeAll();
		updateLabel( state, keyColour );
		+ }
		+
		+ // Track the consecutive key presses for this value.
		+ if( mKeyCounter.apply( keyValue ) ) {
		+ final var count = mKeyCounter.toString();
		+ final var tallySize = compDimen.scale( .25f );
		+
		+ final var tally = new AutofitLabel( count, LABEL_FONT );
		+ tally.setVisible( false );
		+ component.add( tally );
		+
		+ tally.setSize( tallySize );
		+ tally.setVerticalAlignment( TOP );
		+ tally.setHorizontalAlignment( RIGHT );
		+
		+ // Get the upper-left point, accounting for padding and insets.
		+ final var ul = calculator.getLocation();
		+ final var tx = (int) (ul.x + compDimen.getWidth() - tally.getWidth());
		+ final var ty = ul.y;
		+
		+ tally.setLocation( tx, ty );
		+ tally.setVisible( true );
		}
		}

Delta	128 lines added, 5 lines removed, 123-line increase