Dave Jarvis' Repositories

git clone https://repo.autonoma.ca/repo/keenwrite.git
keenwrite / Commits / 1f4ae83

Merge pull request #106 from DaveJarvis/1_refactor_docking 1 refactor docking

AuthorDave Jarvis <email>
Date2020-12-16 23:47:28 GMT-0800
Commit1f4ae83ac3c755efc8f7e5da7c2024d09b1c7828
Parentb18a848
Delta137 lines added, 1610 lines removed, 1473-line decrease
src/test/java/com/keenwrite/util/CyclicIteratorTest.java
+/* Copyright 2020 White Magic Software, Ltd. -- All rights reserved. */
+package com.keenwrite.util;
+
+import org.junit.jupiter.api.Test;
+
+import java.util.List;
+import java.util.ListIterator;
+import java.util.NoSuchElementException;
+
+import static org.junit.jupiter.api.Assertions.*;
+
+/**
+ * Tests the {@link CyclicIterator} class.
+ */
+public class CyclicIteratorTest {
+ /**
+ * Test that the {@link CyclicIterator} can move forwards and backwards
+ * through a {@link List}.
+ */
+ @Test
+ public void test_Directions_NextPreviousCycles_Success() {
+ final var list = List.of( 0, 1, 2, 3, 4, 5, 6, 7, 8, 9 );
+ final var iterator = createCyclicIterator( list );
+
+ // Test forwards through the iterator.
+ for( int i = 0; i < list.size(); i++ ) {
+ assertTrue( iterator.hasNext() );
+ assertEquals( i, iterator.next() );
+ }
+
+ // Loop to the first item.
+ iterator.next();
+
+ // Test backwards through the iterator.
+ for( int i = list.size() - 1; i >= 0; i-- ) {
+ assertTrue( iterator.hasPrevious() );
+ assertEquals( i, iterator.previous() );
+ }
+ }
+
+ /**
+ * Test that the {@link CyclicIterator} returns the last element when
+ * the very first API call is to {@link ListIterator#previous()}.
+ */
+ @Test
+ public void test_Direction_FirstPrevious_ReturnsLastElement() {
+ final var list = List.of( 1, 2, 3, 4, 5, 6, 7 );
+ final var iterator = createCyclicIterator( list );
+
+ assertEquals( iterator.previous(), list.get( list.size() - 1 ) );
+ }
+
+ @Test
+ public void test_Empty_Next_Exception() {
+ final var iterator = createCyclicIterator( List.of() );
+ assertThrows( NoSuchElementException.class, iterator::next );
+ }
+
+ @Test
+ public void test_Empty_Previous_Exception() {
+ final var iterator = createCyclicIterator( List.of() );
+ assertThrows( NoSuchElementException.class, iterator::previous );
+ }
+
+ private <T> CyclicIterator<T> createCyclicIterator( final List<T> list ) {
+ return new CyclicIterator<>( list );
+ }
+}
src/main/resources/fonts/vollkorn/Vollkorn-BoldItalic.ttf
Binary files differ
src/main/resources/fonts/vollkorn/Vollkorn-Italic.ttf
Binary files differ
src/main/resources/fonts/vollkorn/Vollkorn-Regular.ttf
Binary files differ
src/main/resources/fonts/noto-serif-cjk/NotoSerifCJKsc-Bold.otf
Binary files differ
src/main/resources/fonts/noto-serif-cjk/NotoSerifCJKsc-Regular.otf
Binary files differ
src/main/resources/fonts/noto-serif-cjk/NotoSerifCJKtc-Bold.otf
Binary files differ
src/main/resources/fonts/noto-serif-cjk/NotoSerifCJKtc-Regular.otf
Binary files differ
src/main/resources/fonts/noto-sans-mono-cjk/NotoSansMonoCJKtc-Bold.otf
Binary files differ
src/main/resources/fonts/noto-sans-mono-cjk/NotoSansMonoCJKtc-Regular.otf
Binary files differ
src/main/resources/com/keenwrite/editor/markdown_zh-HK.css
+/* Copyright 2020 White Magic Software, Ltd. -- All rights reserved. */
+
+.markdown {
+ -fx-font-family: 'Noto Sans CJK HK';
+}
src/main/resources/com/keenwrite/editor/markdown_zh-TW.css
+/* Copyright 2020 White Magic Software, Ltd. -- All rights reserved. */
+
+.markdown {
+ -fx-font-family: 'Noto Sans CJK TC';
+}
src/main/java/com/keenwrite/util/StageState.java
*/
public class StageState {
-
- public static final String K_PANE_SPLIT_DEFINITION = "pane.split.definition";
- public static final String K_PANE_SPLIT_EDITOR = "pane.split.editor";
- public static final String K_PANE_SPLIT_PREVIEW = "pane.split.preview";
-
private final Stage mStage;
private final Preferences mState;
src/main/java/com/keenwrite/MainView.java
-/*
- * Copyright 2020 Karl Tauber and 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.keenwrite;
-
-import com.dlsc.preferencesfx.PreferencesFxEvent;
-import com.keenwrite.definition.DefinitionFactory;
-import com.keenwrite.definition.DefinitionPane;
-import com.keenwrite.definition.DefinitionSource;
-import com.keenwrite.definition.MapInterpolator;
-import com.keenwrite.definition.yaml.YamlDefinitionSource;
-import com.keenwrite.editors.DefinitionNameInjector;
-import com.keenwrite.editors.markdown.MarkdownEditorPane;
-import com.keenwrite.exceptions.MissingFileException;
-import com.keenwrite.preferences.UserPreferences;
-import com.keenwrite.preferences.UserPreferencesView;
-import com.keenwrite.preview.HtmlPreview;
-import com.keenwrite.preview.OutputTabPane;
-import com.keenwrite.processors.Processor;
-import com.keenwrite.processors.ProcessorContext;
-import com.keenwrite.processors.ProcessorFactory;
-import com.keenwrite.processors.markdown.MarkdownProcessor;
-import com.keenwrite.service.Options;
-import com.keenwrite.service.Snitch;
-import com.keenwrite.spelling.api.SpellCheckListener;
-import com.keenwrite.spelling.api.SpellChecker;
-import com.keenwrite.spelling.impl.PermissiveSpeller;
-import com.keenwrite.spelling.impl.SymSpellSpeller;
-import com.keenwrite.util.Action;
-import com.keenwrite.util.ActionUtils;
-import com.keenwrite.util.SeparatorAction;
-import com.vladsch.flexmark.parser.Parser;
-import com.vladsch.flexmark.util.ast.NodeVisitor;
-import com.vladsch.flexmark.util.ast.VisitHandler;
-import javafx.beans.binding.Bindings;
-import javafx.beans.binding.BooleanBinding;
-import javafx.beans.property.BooleanProperty;
-import javafx.beans.property.SimpleBooleanProperty;
-import javafx.beans.value.ChangeListener;
-import javafx.beans.value.ObservableBooleanValue;
-import javafx.beans.value.ObservableValue;
-import javafx.collections.ListChangeListener.Change;
-import javafx.collections.ObservableList;
-import javafx.event.Event;
-import javafx.event.EventHandler;
-import javafx.scene.Node;
-import javafx.scene.Scene;
-import javafx.scene.control.*;
-import javafx.scene.image.ImageView;
-import javafx.scene.input.KeyEvent;
-import javafx.scene.layout.BorderPane;
-import javafx.scene.layout.VBox;
-import javafx.scene.text.Text;
-import javafx.stage.FileChooser;
-import javafx.stage.Window;
-import javafx.stage.WindowEvent;
-import javafx.util.Duration;
-import org.controlsfx.control.StatusBar;
-import org.fxmisc.richtext.StyleClassedTextArea;
-import org.fxmisc.richtext.model.StyleSpansBuilder;
-import org.reactfx.value.Val;
-
-import java.io.BufferedReader;
-import java.io.File;
-import java.io.IOException;
-import java.io.InputStreamReader;
-import java.nio.file.Path;
-import java.util.*;
-import java.util.concurrent.atomic.AtomicInteger;
-import java.util.function.Function;
-import java.util.prefs.Preferences;
-import java.util.stream.Collectors;
-
-import static com.keenwrite.Bootstrap.APP_TITLE;
-import static com.keenwrite.Constants.*;
-import static com.keenwrite.ExportFormat.*;
-import static com.keenwrite.Messages.get;
-import static com.keenwrite.StatusBarNotifier.clue;
-import static com.keenwrite.util.StageState.*;
-import static de.jensd.fx.glyphs.fontawesome.FontAwesomeIcon.*;
-import static java.nio.charset.StandardCharsets.UTF_8;
-import static java.nio.file.Files.writeString;
-import static java.util.Collections.emptyList;
-import static java.util.Collections.singleton;
-import static javafx.application.Platform.runLater;
-import static javafx.event.Event.fireEvent;
-import static javafx.geometry.Pos.BASELINE_CENTER;
-import static javafx.scene.control.Alert.AlertType.INFORMATION;
-import static javafx.scene.input.KeyCode.ENTER;
-import static javafx.stage.WindowEvent.WINDOW_CLOSE_REQUEST;
-import static org.apache.commons.lang3.SystemUtils.IS_OS_WINDOWS;
-import static org.fxmisc.richtext.model.TwoDimensional.Bias.Forward;
-
-/**
- * Main window containing a tab pane in the center for file editors.
- */
-public class MainView implements Observer {
- /**
- * The {@code OPTIONS} variable must be declared before all other variables
- * to prevent subsequent initializations from failing due to missing user
- * preferences.
- */
- private static final Options sOptions = Services.load( Options.class );
- private static final Snitch sSnitch = Services.load( Snitch.class );
-
- private final Scene mScene;
- private final Text mLineNumberText;
- private final TextField mFindTextField;
- private final SpellChecker mSpellChecker;
-
- private final Object mMutex = new Object();
-
- /**
- * Prevents re-instantiation of processing classes.
- */
- private final Map<FileEditorTab, Processor<String>> mProcessors =
- new HashMap<>();
-
- private final Map<String, String> mResolvedMap =
- new HashMap<>( DEFAULT_MAP_SIZE );
-
- private final EventHandler<PreferencesFxEvent> mRPreferencesListener =
- event -> rerender();
-
- /**
- * Called when the definition data is changed.
- */
- private final EventHandler<TreeItem.TreeModificationEvent<Event>>
- mTreeHandler = event -> {
- exportDefinitions( getDefinitionPath() );
- interpolateResolvedMap();
- rerender();
- };
-
- /**
- * Called to inject the selected item when the user presses ENTER in the
- * definition pane.
- */
- private final EventHandler<? super KeyEvent> mDefinitionKeyHandler =
- event -> {
- if( event.getCode() == ENTER ) {
- getDefinitionNameInjector().injectSelectedItem();
- }
- };
-
- private final ChangeListener<Integer> mCaretPositionListener =
- ( observable, oldPosition, newPosition ) -> processActiveTab();
-
- private DefinitionSource mDefinitionSource = createDefaultDefinitionSource();
- private final DefinitionPane mDefinitionPane = createDefinitionPane();
- private final OutputTabPane mOutputPane = createOutputTabPane();
- private final FileEditorTabPane mFileEditorPane = new FileEditorTabPane(
- mCaretPositionListener );
-
- /**
- * Listens on the definition pane for double-click events.
- */
- private final DefinitionNameInjector mDefinitionNameInjector
- = new DefinitionNameInjector( mDefinitionPane );
-
- public MainView() {
- mLineNumberText = createLineNumberText();
- mFindTextField = createFindTextField();
- mScene = createScene();
- mSpellChecker = createSpellChecker();
-
- // Add the close request listener before the window is shown.
- initLayout();
- }
-
- /**
- * Called after the stage is shown.
- */
- public void init() {
- initFindInput();
- initSnitch();
- initDefinitionListener();
- initTabAddedListener();
-
- initPreferences();
- initVariableNameInjector();
-
- addShowListener( getScene().getRoot(), this::initTabChangedListener );
- }
-
- private void initLayout() {
- final var scene = getScene();
- final var stylesheets = scene.getStylesheets();
-
- //stylesheets.add( STYLESHEET_DOCK );
- stylesheets.add( STYLESHEET_SCENE );
- scene.windowProperty().addListener(
- ( unused, oldWindow, newWindow ) ->
- newWindow.setOnCloseRequest(
- e -> {
- if( !getFileEditorPane().closeAllEditors() ) {
- e.consume();
- }
- }
- )
- );
- }
-
- /**
- * Initialize the find input text field to listen on F3, ENTER, and
- * ESCAPE key presses.
- */
- private void initFindInput() {
- final TextField input = getFindTextField();
-
- input.setOnKeyPressed( ( KeyEvent event ) -> {
- switch( event.getCode() ) {
- case F3:
- case ENTER:
- editFindNext();
- break;
- case F:
- if( !event.isControlDown() ) {
- break;
- }
- case ESCAPE:
- getStatusBar().setGraphic( null );
- getActiveFileEditorTab().getEditorPane().requestFocus();
- break;
- }
- } );
-
- // Remove when the input field loses focus.
- input.focusedProperty().addListener(
- ( focused, oldFocus, newFocus ) -> {
- if( !newFocus ) {
- getStatusBar().setGraphic( null );
- }
- }
- );
- }
-
- /**
- * Watch for changes to external files. In particular, this awaits
- * modifications to any XSL files associated with XML files being edited.
- * When
- * an XSL file is modified (external to the application), the snitch's ears
- * perk up and the file is reloaded. This keeps the XSL transformation up to
- * date with what's on the file system.
- */
- private void initSnitch() {
- sSnitch.addObserver( this );
- }
-
- /**
- * Listen for {@link FileEditorTabPane} to receive open definition file
- * event.
- */
- private void initDefinitionListener() {
- getFileEditorPane().onOpenDefinitionFileProperty().addListener(
- ( final ObservableValue<? extends Path> file,
- final Path oldPath, final Path newPath ) -> {
- openDefinitions( newPath );
- rerender();
- }
- );
- }
-
- /**
- * Re-instantiates all processors then re-renders the active tab. This
- * will refresh the resolved map, force R to re-initialize, and brute-force
- * XSLT file reloads.
- */
- private void rerender() {
- runLater(
- () -> {
- resetProcessors();
- processActiveTab();
- }
- );
- }
-
- /**
- * When tabs are added, hook the various change listeners onto the new
- * tab so that the preview pane refreshes as necessary.
- */
- private void initTabAddedListener() {
- final FileEditorTabPane editorPane = getFileEditorPane();
-
- // Make sure the text processor kicks off when new files are opened.
- final ObservableList<Tab> tabs = editorPane.getTabs();
-
- tabs.addListener(
- ( final Change<? extends Tab> change ) -> {
- while( change.next() ) {
- if( change.wasAdded() ) {
- // Multiple tabs can be added simultaneously.
- for( final Tab newTab : change.getAddedSubList() ) {
- final FileEditorTab tab = (FileEditorTab) newTab;
-
- initScrollEventListener( tab );
- initSpellCheckListener( tab );
- initTextChangeListener( tab );
-// initSyntaxListener( tab );
- }
- }
- }
- }
- );
- }
-
- /**
- * Listen for new tab selection events.
- */
- private void initTabChangedListener() {
- final FileEditorTabPane editorPane = getFileEditorPane();
-
- // Update the preview pane changing tabs.
- editorPane.addTabSelectionListener(
- ( __, oldTab, newTab ) -> {
- if( newTab == null ) {
- // Clear the preview pane when closing an editor. When the last
- // tab is closed, this ensures that the preview pane is empty.
- getHtmlPreview().clear();
- }
- else {
- final var tab = (FileEditorTab) newTab;
- updateVariableNameInjector( tab );
- process( tab );
- }
- }
- );
- }
-
- private void initTextChangeListener( final FileEditorTab tab ) {
- tab.addTextChangeListener( ( __, ov, nv ) -> process( tab ) );
- }
-
- private void initScrollEventListener( final FileEditorTab tab ) {
- final var scrollPane = tab.getScrollPane();
- final var scrollBar = getHtmlPreview().getVerticalScrollBar();
-
- addShowListener( scrollPane, () -> {
- final var handler = new ScrollEventHandler( scrollPane, scrollBar );
- handler.enabledProperty().bind( tab.selectedProperty() );
- } );
- }
-
- /**
- * Listen for changes to the any particular paragraph and perform a quick
- * spell check upon it. The style classes in the editor will be changed to
- * mark any spelling mistakes in the paragraph. The user may then interact
- * with any misspelled word (i.e., any piece of text that is marked) to
- * revise the spelling.
- *
- * @param tab The tab to spellcheck.
- */
- private void initSpellCheckListener( final FileEditorTab tab ) {
- final var editor = tab.getEditorPane().getEditor();
-
- // When the editor first appears, run a full spell check. This allows
- // spell checking while typing to be restricted to the active paragraph,
- // which is usually substantially smaller than the whole document.
- addShowListener( editor, () -> spellcheck( editor, editor.getText() ) );
-
- // Use the plain text changes so that notifications of style changes
- // are suppressed. Checking against the identity ensures that only
- // new text additions or deletions trigger proofreading.
- editor.plainTextChanges()
- .filter( p -> !p.isIdentity() ).subscribe( change -> {
-
- // Check current paragraph; the whole document was checked upon opening.
- final var offset = change.getPosition();
- final var position = editor.offsetToPosition( offset, Forward );
- final var paraId = position.getMajor();
- final var paragraph = editor.getParagraph( paraId );
- final var text = paragraph.getText();
-
- // Prevent doubling-up styles.
- editor.clearStyle( paraId );
-
- spellcheck( editor, text, paraId );
- } );
- }
-
- /**
- * Reloads the preferences from the previous session.
- */
- private void initPreferences() {
- initDefinitionPane();
- getFileEditorPane().initPreferences();
- getUserPreferencesView().addSaveEventHandler( mRPreferencesListener );
- }
-
- private void initVariableNameInjector() {
- updateVariableNameInjector( getActiveFileEditorTab() );
- }
-
- /**
- * Calls the listener when the given node is shown for the first time. The
- * visible property is not the same as the initial showing event; visibility
- * can be triggered numerous times (such as going off screen).
- * <p>
- * This is called, for example, before the drag handler can be attached,
- * because the scrollbar for the text editor pane must be visible.
- * </p>
- *
- * @param node The node to watch for showing.
- * @param consumer The consumer to invoke when the event fires.
- */
- private void addShowListener(
- final Node node, final Runnable consumer ) {
- final ChangeListener<? super Boolean> listener =
- ( o, oldShow, newShow ) -> {
- if( newShow != null && newShow ) {
- try {
- consumer.run();
- } catch( final Exception ex ) {
- clue( ex );
- }
- }
- };
-
- Val.flatMap( node.sceneProperty(), Scene::windowProperty )
- .flatMap( Window::showingProperty )
- .addListener( listener );
- }
-
- private void scrollToCaret() {
- synchronized( mMutex ) {
- getHtmlPreview().scrollTo( CARET_ID );
- }
- }
-
- private void updateVariableNameInjector( final FileEditorTab tab ) {
- getDefinitionNameInjector().addListener( tab );
- }
-
- /**
- * Called to update the status bar's caret position when a new tab is added
- * or the active tab is switched.
- *
- * @param tab The active tab containing a caret position to show.
- */
- private void updateCaretStatus( final FileEditorTab tab ) {
- getLineNumberText().setText( tab.getCaretPosition().toString() );
- }
-
- /**
- * Called whenever the preview pane becomes out of sync with the file editor
- * tab. This can be called when the text changes, the caret paragraph
- * changes, or the file tab changes.
- *
- * @param tab The file editor tab that has been changed in some fashion.
- */
- private void process( final FileEditorTab tab ) {
- if( tab != null ) {
- getHtmlPreview().setBaseUri( tab.getPath() );
-
- final Processor<String> processor = getProcessors().computeIfAbsent(
- tab, p -> createProcessors( tab )
- );
-
- try {
- updateCaretStatus( tab );
- processor.apply( tab.getEditorText() );
- scrollToCaret();
- } catch( final Exception ex ) {
- clue( ex );
- }
- }
- }
-
- private void processActiveTab() {
- process( getActiveFileEditorTab() );
- }
-
- /**
- * Called when a definition source is opened.
- *
- * @param path Path to the definition source that was opened.
- */
- private void openDefinitions( final Path path ) {
- try {
- final var ds = createDefinitionSource( path );
- setDefinitionSource( ds );
-
- final var prefs = getUserPreferencesView();
- prefs.definitionPathProperty().setValue( path.toFile() );
- prefs.save();
-
- final var tooltipPath = new Tooltip( path.toString() );
- tooltipPath.setShowDelay( Duration.millis( 200 ) );
-
- final var pane = getDefinitionPane();
- pane.update( ds );
- pane.addTreeChangeHandler( mTreeHandler );
- pane.addKeyEventHandler( mDefinitionKeyHandler );
- pane.filenameProperty().setValue( path.getFileName().toString() );
- pane.setTooltip( tooltipPath );
-
- interpolateResolvedMap();
- } catch( final Exception ex ) {
- clue( ex );
- }
- }
-
- private void exportDefinitions( final Path path ) {
- try {
- final var pane = getDefinitionPane();
- final var root = pane.getTreeView().getRoot();
- final var problemChild = pane.isTreeWellFormed();
-
- if( problemChild == null ) {
- getDefinitionSource().getTreeAdapter().export( root, path );
- }
- else {
- clue( "yaml.error.tree.form", problemChild.getValue() );
- }
- } catch( final Exception ex ) {
- clue( ex );
- }
- }
-
- private void interpolateResolvedMap() {
- final var treeMap = getDefinitionPane().toMap();
- final var map = new HashMap<>( treeMap );
- MapInterpolator.interpolate( map );
-
- getResolvedMap().clear();
- getResolvedMap().putAll( map );
- }
-
- private void initDefinitionPane() {
- openDefinitions( getDefinitionPath() );
- }
-
- //---- File actions -------------------------------------------------------
-
- /**
- * Called when an {@link Observable} instance has changed. This is called
- * by both the {@link Snitch} service and the notify service. The @link
- * Snitch} service can be called for different file types, including
- * {@link DefinitionSource} instances.
- *
- * @param observable The observed instance.
- * @param value The noteworthy item.
- */
- @Override
- public void update( final Observable observable, final Object value ) {
- if( value instanceof Path && observable instanceof Snitch ) {
- updateSelectedTab();
- }
- }
-
- /**
- * Called when a file has been modified.
- */
- private void updateSelectedTab() {
- rerender();
- }
-
- /**
- * After resetting the processors, they will refresh anew to be up-to-date
- * with the files (text and definition) currently loaded into the editor.
- */
- private void resetProcessors() {
- getProcessors().clear();
- }
-
- //---- File actions -------------------------------------------------------
-
- private void fileNew() {
- getFileEditorPane().newEditor();
- }
-
- private void fileOpen() {
- getFileEditorPane().openFileDialog();
- }
-
- private void fileClose() {
- getFileEditorPane().closeEditor( getActiveFileEditorTab(), true );
- }
-
- /**
- * TODO: Upon closing, first remove the tab change listeners. (There's no
- * need to re-render each tab when all are being closed.)
- */
- private void fileCloseAll() {
- getFileEditorPane().closeAllEditors();
- }
-
- private void fileSaveAs() {
- final FileEditorTab editor = getActiveFileEditorTab();
- getFileEditorPane().saveEditorAs( editor );
- getProcessors().remove( editor );
-
- try {
- process( editor );
- } catch( final Exception ex ) {
- clue( ex );
- }
- }
-
- private void fileSaveAll() {
- getFileEditorPane().saveAllEditors();
- }
-
- /**
- * Exports the contents of the current tab according to the given
- * {@link ExportFormat}.
- *
- * @param format Configures the {@link MarkdownProcessor} when exporting.
- */
- private void fileExport( final ExportFormat format ) {
- final var tab = getActiveFileEditorTab();
- final var context = createProcessorContext( tab, format );
- final var chain = ProcessorFactory.createProcessors( context );
- final var doc = tab.getEditorText();
- final var export = chain.apply( doc );
-
- final var filename = format.toExportFilename( tab.getPath().toFile() );
- final var dir = getPreferences().get( "lastDirectory", null );
- final var lastDir = new File( dir == null ? "." : dir );
-
- final FileChooser chooser = new FileChooser();
- chooser.setTitle( get( "Dialog.file.choose.export.title" ) );
- chooser.setInitialFileName( filename.getName() );
- chooser.setInitialDirectory( lastDir );
-
- final File file = chooser.showSaveDialog( getWindow() );
-
- if( file != null ) {
- try {
- writeString( file.toPath(), export, UTF_8 );
- final var m = get( "Main.status.export.success", file.toString() );
- clue( m );
- } catch( final IOException e ) {
- clue( e );
- }
- }
- }
-
- private void fileExit() {
- final Window window = getWindow();
- fireEvent( window, new WindowEvent( window, WINDOW_CLOSE_REQUEST ) );
- }
-
- //---- Edit actions -------------------------------------------------------
-
- /**
- * Used to find text in the active file editor window.
- */
- private void editFind() {
- final TextField input = getFindTextField();
- getStatusBar().setGraphic( input );
- input.requestFocus();
- }
-
- public void editFindNext() {
- getActiveFileEditorTab().searchNext( getFindTextField().getText() );
- }
-
- public void editPreferences() {
- getUserPreferencesView().show();
- }
-
- //---- Insert actions -----------------------------------------------------
-
- /**
- * Delegates to the active editor to handle wrapping the current text
- * selection with leading and trailing strings.
- *
- * @param leading The string to put before the selection.
- * @param trailing The string to put after the selection.
- */
- private void insertMarkdown(
- final String leading, final String trailing ) {
- getActiveEditorPane().surroundSelection( leading, trailing );
- }
-
- private void insertMarkdown(
- final String leading, final String trailing, final String hint ) {
- getActiveEditorPane().surroundSelection( leading, trailing, hint );
- }
-
- //---- Help actions -------------------------------------------------------
-
- private void helpAbout() {
- final Alert alert = new Alert( INFORMATION );
- alert.setTitle( get( "Dialog.about.title", APP_TITLE ) );
- alert.setHeaderText( get( "Dialog.about.header", APP_TITLE ) );
- alert.setContentText( get( "Dialog.about.content" ) );
- alert.setGraphic( new ImageView( ICON_DIALOG ) );
- alert.initOwner( getWindow() );
-
- alert.showAndWait();
- }
-
- //---- Member creators ----------------------------------------------------
-
- private SpellChecker createSpellChecker() {
- try {
- final Collection<String> lexicon = readLexicon( "en.txt" );
- return SymSpellSpeller.forLexicon( lexicon );
- } catch( final Exception ex ) {
- clue( ex );
- return new PermissiveSpeller();
- }
- }
-
- /**
- * Creates processors suited to parsing and rendering different file types.
- *
- * @param tab The tab that is subjected to processing.
- * @return A processor suited to the file type specified by the tab's path.
- */
- private Processor<String> createProcessors( final FileEditorTab tab ) {
- final var context = createProcessorContext( tab );
- return ProcessorFactory.createProcessors( context );
- }
-
- private ProcessorContext createProcessorContext(
- final FileEditorTab tab, final ExportFormat format ) {
- final var preview = getHtmlPreview();
- final var map = getResolvedMap();
- return new ProcessorContext( preview, map, tab, format );
- }
-
- private ProcessorContext createProcessorContext( final FileEditorTab tab ) {
- return createProcessorContext( tab, NONE );
- }
-
- private DefinitionPane createDefinitionPane() {
- return new DefinitionPane();
- }
-
- private OutputTabPane createOutputTabPane() {
- return new OutputTabPane();
- }
-
- private DefinitionSource createDefaultDefinitionSource() {
- return new YamlDefinitionSource( getDefinitionPath() );
- }
-
- private DefinitionSource createDefinitionSource( final Path path ) {
- try {
- return createDefinitionFactory().createDefinitionSource( path );
- } catch( final Exception ex ) {
- clue( ex );
- return createDefaultDefinitionSource();
- }
- }
-
- private TextField createFindTextField() {
- return new TextField();
- }
-
- private DefinitionFactory createDefinitionFactory() {
- return new DefinitionFactory();
- }
-
- private Scene createScene() {
- final var splitPane = new SplitPane(
- getDefinitionPane(),
- getFileEditorPane(),
- getOutputPane() );
-
- splitPane.setDividerPositions(
- getFloat( K_PANE_SPLIT_DEFINITION, .22f ),
- getFloat( K_PANE_SPLIT_EDITOR, .60f ),
- getFloat( K_PANE_SPLIT_PREVIEW, .18f ) );
-
- getDefinitionPane().prefHeightProperty()
- .bind( splitPane.heightProperty() );
-
- final BorderPane borderPane = new BorderPane();
- borderPane.setPrefSize( 1280, 800 );
- borderPane.setTop( createMenuBar() );
- borderPane.setBottom( getStatusBar() );
- borderPane.setCenter( splitPane );
-
- final VBox statusBar = new VBox();
- statusBar.setAlignment( BASELINE_CENTER );
- statusBar.getChildren().add( getLineNumberText() );
- getStatusBar().getRightItems().add( statusBar );
-
- // Force preview pane refresh on Windows.
- if( IS_OS_WINDOWS ) {
- splitPane.getDividers().get( 1 ).positionProperty().addListener(
- ( l, oValue, nValue ) -> runLater(
- () -> getHtmlPreview().repaintScrollPane()
- )
- );
- }
-
- return new Scene( borderPane );
- }
-
- private Text createLineNumberText() {
- return new Text( get( STATUS_BAR_LINE, 1, 1, 1 ) );
- }
-
- private Node createMenuBar() {
- final BooleanBinding activeFileEditorIsNull =
- getFileEditorPane().activeFileEditorProperty().isNull();
-
- // File actions
- final Action fileNewAction = Action
- .builder()
- .setText( "Main.menu.file.new" )
- .setAccelerator( "Shortcut+N" )
- .setIcon( FILE_ALT )
- .setAction( e -> fileNew() )
- .build();
- final Action fileOpenAction = Action
- .builder()
- .setText( "Main.menu.file.open" )
- .setAccelerator( "Shortcut+O" )
- .setIcon( FOLDER_OPEN_ALT )
- .setAction( e -> fileOpen() )
- .build();
- final Action fileCloseAction = Action
- .builder()
- .setText( "Main.menu.file.close" )
- .setAccelerator( "Shortcut+W" )
- .setAction( e -> fileClose() )
- .setDisabled( activeFileEditorIsNull )
- .build();
- final Action fileCloseAllAction = Action
- .builder()
- .setText( "Main.menu.file.close_all" )
- .setAction( e -> fileCloseAll() )
- .setDisabled( activeFileEditorIsNull )
- .build();
- final Action fileSaveAction = Action
- .builder()
- .setText( "Main.menu.file.save" )
- .setAccelerator( "Shortcut+S" )
- .setIcon( FLOPPY_ALT )
- .setAction( e -> getActiveFileEditorTab().save() )
- .setDisabled( createActiveBooleanProperty(
- FileEditorTab::modifiedProperty ).not() )
- .build();
- final Action fileSaveAsAction = Action
- .builder()
- .setText( "Main.menu.file.save_as" )
- .setAction( e -> fileSaveAs() )
- .setDisabled( activeFileEditorIsNull )
- .build();
- final Action fileSaveAllAction = Action
- .builder()
- .setText( "Main.menu.file.save_all" )
- .setAccelerator( "Shortcut+Shift+S" )
- .setAction( e -> fileSaveAll() )
- .setDisabled( Bindings.not(
- getFileEditorPane().anyFileEditorModifiedProperty() ) )
- .build();
- final Action fileExportAction = Action
- .builder()
- .setText( "Main.menu.file.export" )
- .build();
- final Action fileExportHtmlSvgAction = Action
- .builder()
- .setText( "Main.menu.file.export.html_svg" )
- .setAction( e -> fileExport( HTML_TEX_SVG ) )
- .build();
- final Action fileExportHtmlTexAction = Action
- .builder()
- .setText( "Main.menu.file.export.html_tex" )
- .setAction( e -> fileExport( HTML_TEX_DELIMITED ) )
- .build();
- final Action fileExportMarkdownAction = Action
- .builder()
- .setText( "Main.menu.file.export.markdown" )
- .setAction( e -> fileExport( MARKDOWN_PLAIN ) )
- .build();
- fileExportAction.addSubActions(
- fileExportHtmlSvgAction,
- fileExportHtmlTexAction,
- fileExportMarkdownAction );
-
- final Action fileExitAction = Action
- .builder()
- .setText( "Main.menu.file.exit" )
- .setAction( e -> fileExit() )
- .build();
-
- // Edit actions
- final Action editUndoAction = Action
- .builder()
- .setText( "Main.menu.edit.undo" )
- .setAccelerator( "Shortcut+Z" )
- .setIcon( UNDO )
- .setAction( e -> getActiveEditorPane().undo() )
- .setDisabled( createActiveBooleanProperty(
- FileEditorTab::canUndoProperty ).not() )
- .build();
- final Action editRedoAction = Action
- .builder()
- .setText( "Main.menu.edit.redo" )
- .setAccelerator( "Shortcut+Y" )
- .setIcon( REPEAT )
- .setAction( e -> getActiveEditorPane().redo() )
- .setDisabled( createActiveBooleanProperty(
- FileEditorTab::canRedoProperty ).not() )
- .build();
-
- final Action editCutAction = Action
- .builder()
- .setText( "Main.menu.edit.cut" )
- .setAccelerator( "Shortcut+X" )
- .setIcon( CUT )
- .setAction( e -> getActiveEditorPane().cut() )
- .setDisabled( activeFileEditorIsNull )
- .build();
- final Action editCopyAction = Action
- .builder()
- .setText( "Main.menu.edit.copy" )
- .setAccelerator( "Shortcut+C" )
- .setIcon( COPY )
- .setAction( e -> getActiveEditorPane().copy() )
- .setDisabled( activeFileEditorIsNull )
- .build();
- final Action editPasteAction = Action
- .builder()
- .setText( "Main.menu.edit.paste" )
- .setAccelerator( "Shortcut+V" )
- .setIcon( PASTE )
- .setAction( e -> getActiveEditorPane().paste() )
- .setDisabled( activeFileEditorIsNull )
- .build();
- final Action editSelectAllAction = Action
- .builder()
- .setText( "Main.menu.edit.selectAll" )
- .setAccelerator( "Shortcut+A" )
- .setAction( e -> getActiveEditorPane().selectAll() )
- .setDisabled( activeFileEditorIsNull )
- .build();
-
- final Action editFindAction = Action
- .builder()
- .setText( "Main.menu.edit.find" )
- .setAccelerator( "Ctrl+F" )
- .setIcon( SEARCH )
- .setAction( e -> editFind() )
- .setDisabled( activeFileEditorIsNull )
- .build();
- final Action editFindNextAction = Action
- .builder()
- .setText( "Main.menu.edit.find.next" )
- .setAccelerator( "F3" )
- .setAction( e -> editFindNext() )
- .setDisabled( activeFileEditorIsNull )
- .build();
- final Action editPreferencesAction = Action
- .builder()
- .setText( "Main.menu.edit.preferences" )
- .setAccelerator( "Ctrl+Alt+S" )
- .setAction( e -> editPreferences() )
- .build();
-
- // Format actions
- final Action formatBoldAction = Action
- .builder()
- .setText( "Main.menu.format.bold" )
- .setAccelerator( "Shortcut+B" )
- .setIcon( BOLD )
- .setAction( e -> insertMarkdown( "**", "**" ) )
- .setDisabled( activeFileEditorIsNull )
- .build();
- final Action formatItalicAction = Action
- .builder()
- .setText( "Main.menu.format.italic" )
- .setAccelerator( "Shortcut+I" )
- .setIcon( ITALIC )
- .setAction( e -> insertMarkdown( "*", "*" ) )
- .setDisabled( activeFileEditorIsNull )
- .build();
- final Action formatSuperscriptAction = Action
- .builder()
- .setText( "Main.menu.format.superscript" )
- .setAccelerator( "Shortcut+[" )
- .setIcon( SUPERSCRIPT )
- .setAction( e -> insertMarkdown( "^", "^" ) )
- .setDisabled( activeFileEditorIsNull )
- .build();
- final Action formatSubscriptAction = Action
- .builder()
- .setText( "Main.menu.format.subscript" )
- .setAccelerator( "Shortcut+]" )
- .setIcon( SUBSCRIPT )
- .setAction( e -> insertMarkdown( "~", "~" ) )
- .setDisabled( activeFileEditorIsNull )
- .build();
- final Action formatStrikethroughAction = Action
- .builder()
- .setText( "Main.menu.format.strikethrough" )
- .setAccelerator( "Shortcut+T" )
- .setIcon( STRIKETHROUGH )
- .setAction( e -> insertMarkdown( "~~", "~~" ) )
- .setDisabled( activeFileEditorIsNull )
- .build();
-
- // Insert actions
- final Action insertBlockquoteAction = Action
- .builder()
- .setText( "Main.menu.insert.blockquote" )
- .setAccelerator( "Ctrl+Q" )
- .setIcon( QUOTE_LEFT )
- .setAction( e -> insertMarkdown( "\n\n> ", "" ) )
- .setDisabled( activeFileEditorIsNull )
- .build();
- final Action insertCodeAction = Action
- .builder()
- .setText( "Main.menu.insert.code" )
- .setAccelerator( "Shortcut+K" )
- .setIcon( CODE )
- .setAction( e -> insertMarkdown( "`", "`" ) )
- .setDisabled( activeFileEditorIsNull )
- .build();
- final Action insertFencedCodeBlockAction = Action
- .builder()
- .setText( "Main.menu.insert.fenced_code_block" )
- .setAccelerator( "Shortcut+Shift+K" )
- .setIcon( FILE_CODE_ALT )
- .setAction( e -> insertMarkdown(
- "\n\n```\n",
- "\n```\n\n",
- get( "Main.menu.insert.fenced_code_block.prompt" ) ) )
- .setDisabled( activeFileEditorIsNull )
- .build();
- final Action insertLinkAction = Action
- .builder()
- .setText( "Main.menu.insert.link" )
- .setAccelerator( "Shortcut+L" )
- .setIcon( LINK )
- .setAction( e -> getActiveEditorPane().insertLink() )
- .setDisabled( activeFileEditorIsNull )
- .build();
- final Action insertImageAction = Action
- .builder()
- .setText( "Main.menu.insert.image" )
- .setAccelerator( "Shortcut+G" )
- .setIcon( PICTURE_ALT )
- .setAction( e -> getActiveEditorPane().insertImage() )
- .setDisabled( activeFileEditorIsNull )
- .build();
-
- // Number of heading actions (H1 ... H3)
- final int HEADINGS = 3;
- final Action[] headings = new Action[ HEADINGS ];
-
- for( int i = 1; i <= HEADINGS; i++ ) {
- final String hashes = new String( new char[ i ] ).replace( "\0", "#" );
- final String markup = String.format( "%n%n%s ", hashes );
- final String text = "Main.menu.insert.heading." + i;
- final String accelerator = "Shortcut+" + i;
- final String prompt = text + ".prompt";
-
- headings[ i - 1 ] = Action
- .builder()
- .setText( text )
- .setAccelerator( accelerator )
- .setIcon( HEADER )
- .setAction( e -> insertMarkdown( markup, "", get( prompt ) ) )
- .setDisabled( activeFileEditorIsNull )
- .build();
- }
-
- final Action insertUnorderedListAction = Action
- .builder()
- .setText( "Main.menu.insert.unordered_list" )
- .setAccelerator( "Shortcut+U" )
- .setIcon( LIST_UL )
- .setAction( e -> insertMarkdown( "\n\n* ", "" ) )
- .setDisabled( activeFileEditorIsNull )
- .build();
- final Action insertOrderedListAction = Action
- .builder()
- .setText( "Main.menu.insert.ordered_list" )
- .setAccelerator( "Shortcut+Shift+O" )
- .setIcon( LIST_OL )
- .setAction( e -> insertMarkdown(
- "\n\n1. ", "" ) )
- .setDisabled( activeFileEditorIsNull )
- .build();
- final Action insertHorizontalRuleAction = Action
- .builder()
- .setText( "Main.menu.insert.horizontal_rule" )
- .setAccelerator( "Shortcut+H" )
- .setAction( e -> insertMarkdown(
- "\n\n---\n\n", "" ) )
- .setDisabled( activeFileEditorIsNull )
- .build();
-
- // Definition actions
- final Action definitionCreateAction = Action
- .builder()
- .setText( "Main.menu.definition.create" )
- .setIcon( TREE )
- .setAction( e -> getDefinitionPane().addItem() )
- .build();
- final Action definitionInsertAction = Action
- .builder()
- .setText( "Main.menu.definition.insert" )
- .setAccelerator( "Ctrl+Space" )
- .setIcon( STAR )
- .setAction( e -> definitionInsert() )
- .build();
-
- // Help actions
- final Action helpAboutAction = Action
- .builder()
- .setText( "Main.menu.help.about" )
- .setAction( e -> helpAbout() )
- .build();
-
- final Action SEPARATOR_ACTION = new SeparatorAction();
-
- //---- MenuBar ----
-
- // File Menu
- final var fileMenu = ActionUtils.createMenu(
- get( "Main.menu.file" ),
- fileNewAction,
- fileOpenAction,
- SEPARATOR_ACTION,
- fileCloseAction,
- fileCloseAllAction,
- SEPARATOR_ACTION,
- fileSaveAction,
- fileSaveAsAction,
- fileSaveAllAction,
- SEPARATOR_ACTION,
- fileExportAction,
- SEPARATOR_ACTION,
- fileExitAction );
-
- // Edit Menu
- final var editMenu = ActionUtils.createMenu(
- get( "Main.menu.edit" ),
- SEPARATOR_ACTION,
- editUndoAction,
- editRedoAction,
- SEPARATOR_ACTION,
- editCutAction,
- editCopyAction,
- editPasteAction,
- editSelectAllAction,
- SEPARATOR_ACTION,
- editFindAction,
- editFindNextAction,
- SEPARATOR_ACTION,
- editPreferencesAction );
-
- // Format Menu
- final var formatMenu = ActionUtils.createMenu(
- get( "Main.menu.format" ),
- formatBoldAction,
- formatItalicAction,
- formatSuperscriptAction,
- formatSubscriptAction,
- formatStrikethroughAction
- );
-
- // Insert Menu
- final var insertMenu = ActionUtils.createMenu(
- get( "Main.menu.insert" ),
- insertBlockquoteAction,
- insertCodeAction,
- insertFencedCodeBlockAction,
- SEPARATOR_ACTION,
- insertLinkAction,
- insertImageAction,
- SEPARATOR_ACTION,
- headings[ 0 ],
- headings[ 1 ],
- headings[ 2 ],
- SEPARATOR_ACTION,
- insertUnorderedListAction,
- insertOrderedListAction,
- insertHorizontalRuleAction
- );
-
- // Definition Menu
- final var definitionMenu = ActionUtils.createMenu(
- get( "Main.menu.definition" ),
- definitionCreateAction,
- definitionInsertAction );
-
- // Help Menu
- final var helpMenu = ActionUtils.createMenu(
- get( "Main.menu.help" ),
- helpAboutAction );
-
- //---- MenuBar ----
- final var menuBar = new MenuBar(
- fileMenu,
- editMenu,
- formatMenu,
- insertMenu,
- definitionMenu,
- helpMenu );
-
- //---- ToolBar ----
- final var toolBar = ActionUtils.createToolBar(
- fileNewAction,
- fileOpenAction,
- fileSaveAction,
- SEPARATOR_ACTION,
- editUndoAction,
- editRedoAction,
- editCutAction,
- editCopyAction,
- editPasteAction,
- SEPARATOR_ACTION,
- formatBoldAction,
- formatItalicAction,
- formatSuperscriptAction,
- formatSubscriptAction,
- insertBlockquoteAction,
- insertCodeAction,
- insertFencedCodeBlockAction,
- SEPARATOR_ACTION,
- insertLinkAction,
- insertImageAction,
- SEPARATOR_ACTION,
- headings[ 0 ],
- SEPARATOR_ACTION,
- insertUnorderedListAction,
- insertOrderedListAction );
-
- return new VBox( menuBar, toolBar );
- }
-
- /**
- * Performs the autoinsert function on the active file editor.
- */
- private void definitionInsert() {
- getDefinitionNameInjector().autoinsert();
- }
-
- /**
- * Creates a boolean property that is bound to another boolean value of the
- * active editor.
- */
- private BooleanProperty createActiveBooleanProperty(
- final Function<FileEditorTab, ObservableBooleanValue> func ) {
-
- final BooleanProperty b = new SimpleBooleanProperty();
- final FileEditorTab tab = getActiveFileEditorTab();
-
- if( tab != null ) {
- b.bind( func.apply( tab ) );
- }
-
- getFileEditorPane().activeFileEditorProperty().addListener(
- ( __, oldFileEditor, newFileEditor ) -> {
- b.unbind();
-
- if( newFileEditor == null ) {
- b.set( false );
- }
- else {
- b.bind( func.apply( newFileEditor ) );
- }
- }
- );
-
- return b;
- }
-
- //---- Convenience accessors ----------------------------------------------
-
- private Preferences getPreferences() {
- return sOptions.getState();
- }
-
- private float getFloat( final String key, final float defaultValue ) {
- return getPreferences().getFloat( key, defaultValue );
- }
-
- public Window getWindow() {
- return getScene().getWindow();
- }
-
- private MarkdownEditorPane getActiveEditorPane() {
- return getActiveFileEditorTab().getEditorPane();
- }
-
- private FileEditorTab getActiveFileEditorTab() {
- return getFileEditorPane().getActiveFileEditor();
- }
-
- //---- Member accessors ---------------------------------------------------
-
- protected Scene getScene() {
- return mScene;
- }
-
- private SpellChecker getSpellChecker() {
- return mSpellChecker;
- }
-
- private Map<FileEditorTab, Processor<String>> getProcessors() {
- return mProcessors;
- }
-
- private FileEditorTabPane getFileEditorPane() {
- return mFileEditorPane;
- }
-
- private OutputTabPane getOutputPane() {
- return mOutputPane;
- }
-
- private HtmlPreview getHtmlPreview() {
- return getOutputPane().getHtmlPreview();
- }
-
- private void setDefinitionSource(
- final DefinitionSource definitionSource ) {
- assert definitionSource != null;
- mDefinitionSource = definitionSource;
- }
-
- private DefinitionSource getDefinitionSource() {
- return mDefinitionSource;
- }
-
- private DefinitionPane getDefinitionPane() {
- return mDefinitionPane;
- }
-
- private Text getLineNumberText() {
- return mLineNumberText;
- }
-
- private StatusBar getStatusBar() {
- return StatusBarNotifier.getStatusBar();
- }
-
- private TextField getFindTextField() {
- return mFindTextField;
- }
-
- private DefinitionNameInjector getDefinitionNameInjector() {
- return mDefinitionNameInjector;
- }
-
- /**
- * Returns the variable map of interpolated definitions.
- *
- * @return A map to help dereference variables.
- */
- private Map<String, String> getResolvedMap() {
- return mResolvedMap;
- }
-
- //---- Persistence accessors ----------------------------------------------
-
- private UserPreferences getUserPreferences() {
- return UserPreferences.getInstance();
- }
-
- private UserPreferencesView getUserPreferencesView() {
- return UserPreferencesView.getInstance();
- }
-
- private Path getDefinitionPath() {
- return getUserPreferences().getDefinitionPath();
- }
-
- //---- Spelling -----------------------------------------------------------
-
- /**
- * Delegates to {@link #spellcheck(StyleClassedTextArea, String, int)}.
- * This is called to spell check the document, rather than a single paragraph.
- *
- * @param text The full document text.
- */
- private void spellcheck(
- final StyleClassedTextArea editor, final String text ) {
- spellcheck( editor, text, -1 );
- }
-
- /**
- * Spellchecks a subset of the entire document.
- *
- * @param text Look up words for this text in the lexicon.
- * @param paraId Set to -1 to apply resulting style spans to the entire
- * text.
- */
- private void spellcheck(
- final StyleClassedTextArea editor, final String text, final int paraId ) {
- final var builder = new StyleSpansBuilder<Collection<String>>();
- final var runningIndex = new AtomicInteger( 0 );
- final var checker = getSpellChecker();
-
- // The text nodes must be relayed through a contextual "visitor" that
- // can return text in chunks with correlative offsets into the string.
- // This allows Markdown, R Markdown, XML, and R XML documents to return
- // sets of words to check.
-
- final var node = mParser.parse( text );
- final var visitor = new TextVisitor( ( visited, bIndex, eIndex ) -> {
- // Treat hyphenated compound words as individual words.
- final var check = visited.replace( '-', ' ' );
-
- checker.proofread( check, ( misspelled, prevIndex, currIndex ) -> {
- prevIndex += bIndex;
- currIndex += bIndex;
-
- // Clear styling between lexiconically absent words.
- builder.add( emptyList(), prevIndex - runningIndex.get() );
- builder.add( singleton( "spelling" ), currIndex - prevIndex );
- runningIndex.set( currIndex );
- } );
- } );
-
- visitor.visit( node );
-
- // If the running index was set, at least one word triggered the listener.
- if( runningIndex.get() > 0 ) {
- // Clear styling after the last lexiconically absent word.
- builder.add( emptyList(), text.length() - runningIndex.get() );
-
- final var spans = builder.create();
-
- if( paraId >= 0 ) {
- editor.setStyleSpans( paraId, 0, spans );
- }
- else {
- editor.setStyleSpans( 0, spans );
- }
- }
- }
-
- @SuppressWarnings("SameParameterValue")
- private Collection<String> readLexicon( final String filename )
- throws Exception {
- final var path = '/' + LEXICONS_DIRECTORY + '/' + filename;
-
- try( final var resource = getClass().getResourceAsStream( path ) ) {
- if( resource == null ) {
- throw new MissingFileException( path );
- }
-
- try( final var isr = new InputStreamReader( resource, UTF_8 );
- final var reader = new BufferedReader( isr ) ) {
- return reader.lines().collect( Collectors.toList() );
- }
- }
- }
-
- // TODO: #59 -- Replace using Markdown processor instantiated for Markdown
- // files.
- private final Parser mParser = Parser.builder().build();
-
- // TODO: #59 -- Replace with generic interface; provide Markdown/XML
- // implementations.
- private static final class TextVisitor {
- private final NodeVisitor mVisitor = new NodeVisitor( new VisitHandler<>(
- com.vladsch.flexmark.ast.Text.class, this::visit )
- );
-
- private final SpellCheckListener mConsumer;
-
- public TextVisitor( final SpellCheckListener consumer ) {
- mConsumer = consumer;
- }
-
- private void visit( final com.vladsch.flexmark.util.ast.Node node ) {
- if( node instanceof com.vladsch.flexmark.ast.Text ) {
- mConsumer.accept( node.getChars().toString(),
- node.getStartOffset(),
- node.getEndOffset() );
- }
-
- mVisitor.visitChildren( node );
- }
- }
-}
src/main/java/com/keenwrite/Messages.java
import java.text.MessageFormat;
+import java.util.Enumeration;
import java.util.ResourceBundle;
import java.util.Stack;
public static String get( final String key, final Object... args ) {
return MessageFormat.format( get( key ), args );
+ }
+
+ /**
+ * Answers whether the given key is contained in the application's messages
+ * properties file.
+ *
+ * @param key The key to look for in the {@link ResourceBundle}.
+ * @return {@code true} when the key exists as an exact match.
+ */
+ public static boolean containsKey( final String key ) {
+ return RESOURCE_BUNDLE.containsKey( key );
+ }
+
+ /**
+ * Returns all key names in the application's messages properties file.
+ *
+ * @return All key names in the {@link ResourceBundle} encapsulated by
+ * this class.
+ */
+ public static Enumeration<String> getKeys() {
+ return RESOURCE_BUNDLE.getKeys();
}
}
src/main/java/com/keenwrite/ScrollEventHandler.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.
- */
+/* Copyright 2020 White Magic Software, Ltd. -- All rights reserved. */
package com.keenwrite;
import javafx.beans.property.BooleanProperty;
import javafx.beans.property.SimpleBooleanProperty;
import javafx.event.Event;
import javafx.event.EventHandler;
-import javafx.scene.Node;
import javafx.scene.control.ScrollBar;
import javafx.scene.control.skin.ScrollBarSkin;
import javafx.scene.input.MouseEvent;
import javafx.scene.input.ScrollEvent;
import javafx.scene.layout.StackPane;
import org.fxmisc.flowless.VirtualizedScrollPane;
import org.fxmisc.richtext.StyleClassedTextArea;
import javax.swing.*;
+import java.util.function.Consumer;
import static javafx.geometry.Orientation.VERTICAL;
mEditorScrollPane.addEventFilter( ScrollEvent.ANY, new ScrollHandler() );
- final var thumb = getVerticalScrollBarThumb( mEditorScrollPane );
- thumb.setOnMouseDragged( new MouseHandler( thumb.getOnMouseDragged() ) );
+ initVerticalScrollBarThumb(
+ mEditorScrollPane,
+ thumb -> {
+ final var handler = new MouseHandler( thumb.getOnMouseDragged() );
+ thumb.setOnMouseDragged( handler );
+ }
+ );
}
if( isEnabled() ) {
final var eScrollPane = getEditorScrollPane();
- final int eScrollY =
+ final var eScrollY =
eScrollPane.estimatedScrollYProperty().getValue().intValue();
- final int eHeight = (int)
+ final var eHeight = (int)
(eScrollPane.totalHeightEstimateProperty().getValue().intValue()
- eScrollPane.getHeight());
- final double eRatio = eHeight > 0
+ final var eRatio = eHeight > 0
? Math.min( Math.max( eScrollY / (float) eHeight, 0 ), 1 ) : 0;
}
}
-
- private StackPane getVerticalScrollBarThumb(
- final VirtualizedScrollPane<StyleClassedTextArea> pane ) {
- final ScrollBar scrollBar = getVerticalScrollBar( pane );
- final ScrollBarSkin skin = (ScrollBarSkin) (scrollBar.skinProperty().get());
- for( final Node node : skin.getChildren() ) {
- // Brittle, but what can you do?
- if( node.getStyleClass().contains( "thumb" ) ) {
- return (StackPane) node;
+ private void initVerticalScrollBarThumb(
+ final VirtualizedScrollPane<StyleClassedTextArea> pane,
+ final Consumer<StackPane> consumer ) {
+ // When the skin property is set, the stack pane is available (not null).
+ getVerticalScrollBar( pane ).skinProperty().addListener( ( c, o, n ) -> {
+ for( final var node : ((ScrollBarSkin) n).getChildren() ) {
+ // Brittle, but what can you do?
+ if( node.getStyleClass().contains( "thumb" ) ) {
+ consumer.accept( (StackPane) node );
+ }
}
- }
-
- throw new IllegalArgumentException( "No scroll bar skin found." );
+ } );
}
+ /**
+ * Returns the vertical {@link ScrollBar} instance associated with the
+ * given scroll pane. This is {@code null}-safe because the scroll pane
+ * initializes its vertical {@link ScrollBar} upon construction.
+ *
+ * @param pane The scroll pane that contains a vertical {@link ScrollBar}.
+ * @return The vertical {@link ScrollBar} associated with the scroll pane.
+ * @throws IllegalStateException Could not obtain the vertical scroll bar.
+ */
private ScrollBar getVerticalScrollBar(
final VirtualizedScrollPane<StyleClassedTextArea> pane ) {
- for( final Node node : pane.getChildrenUnmodifiable() ) {
+ for( final var node : pane.getChildrenUnmodifiable() ) {
if( node instanceof ScrollBar ) {
- final ScrollBar scrollBar = (ScrollBar) node;
+ final var scrollBar = (ScrollBar) node;
if( scrollBar.getOrientation() == VERTICAL ) {
return scrollBar;
}
}
}
- throw new IllegalArgumentException( "No vertical scroll pane found." );
+ throw new IllegalStateException( "No vertical scroll bar found." );
}
src/main/java/com/keenwrite/Services.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.
- */
+/* Copyright 2020 White Magic Software, Ltd. -- All rights reserved. */
package com.keenwrite;
src/main/java/com/keenwrite/StatusBarNotifier.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.
- */
+/* Copyright 2020 White Magic Software, Ltd. -- All rights reserved. */
package com.keenwrite;