Dave Jarvis' Repositories

Home Files Commits Tags Clone

Repository:

git clone https://repo.autonoma.ca/repo/keenwrite.git

M build.gradle

 version = '0.5'
 version = '1.0.0'
 apply plugin: 'java'
   compile group: 'com.fasterxml.jackson.dataformat', name: 'jackson-dataformat-yaml', version: '2.8.4'
   compile group: 'org.yaml', name: 'snakeyaml', version: '1.17'
   compile group: 'com.ximpleware', name: 'vtd-xml', version: '2.13'
   compile group: 'net.sf.saxon', name: 'Saxon-HE', version: '9.7.0-14'
   compile group: 'com.googlecode.juniversalchardet', name: 'juniversalchardet', version: '1.0.3'
   compile group: 'org.apache.commons', name: 'commons-configuration2', version: '2.1'

M src/main/java/com/scrivenvar/FileEditorTab.java

 import com.scrivenvar.editors.EditorPane;
 import com.scrivenvar.editors.markdown.MarkdownEditorPane;
 import com.scrivenvar.service.Options;
 import com.scrivenvar.service.events.AlertMessage;
 import com.scrivenvar.service.events.AlertService;
 import java.nio.charset.Charset;
 import java.nio.file.Files;
 import java.nio.file.Path;
 import static java.util.Locale.ENGLISH;
 import java.util.function.Consumer;
 import javafx.application.Platform;
 import javafx.beans.binding.Bindings;
 import javafx.beans.property.BooleanProperty;
 import javafx.beans.property.ReadOnlyBooleanProperty;
 import javafx.beans.property.ReadOnlyBooleanWrapper;
 import javafx.beans.property.SimpleBooleanProperty;
 import javafx.beans.value.ChangeListener;
 import javafx.event.Event;
 import javafx.scene.Node;
 import javafx.scene.control.Tab;
 import javafx.scene.control.Tooltip;
 import javafx.scene.input.InputEvent;
 import javafx.scene.text.Text;
 import org.fxmisc.undo.UndoManager;
 import org.fxmisc.wellbehaved.event.EventPattern;
 import org.fxmisc.wellbehaved.event.InputMap;
 import org.mozilla.universalchardet.UniversalDetector;
 /**
  * Editor for a single file.
+ *
  * @author Karl Tauber and White Magic Software, Ltd.
  */
 public final class FileEditorTab extends Tab {
   private final Options options = Services.load( Options.class );
   private final AlertService alertService = Services.load( AlertService.class );
   private EditorPane editorPane;
   /**
    * Character encoding used by the file (or default encoding if none found).
    */
   private Charset encoding;
   private final ReadOnlyBooleanWrapper modified = new ReadOnlyBooleanWrapper();
   private final BooleanProperty canUndo = new SimpleBooleanProperty();
   private final BooleanProperty canRedo = new SimpleBooleanProperty();
   private Path path;
   FileEditorTab( final Path path ) {
     setPath( path );
     this.modified.addListener( (observable, oldPath, newPath) -> updateTab() );
     updateTab();
     setOnSelectionChanged( e -> {
       if( isSelected() ) {
         Platform.runLater( () -> activated() );
+      }
     } );
+  }
   private void updateTab() {
     setText( getTabTitle() );
     setGraphic( getModifiedMark() );
     setTooltip( getTabTooltip() );
+  }
   /**
    * Returns the base filename (without the directory names).
+   *
    * @return The untitled text if the path hasn't been set.
    */
   private String getTabTitle() {
     final Path filePath = getPath();
     return (filePath == null)
       ? Messages.get( "FileEditor.untitled" )
       : filePath.getFileName().toString();
+  }
   /**
    * Returns the full filename represented by the path.
+   *
    * @return The untitled text if the path hasn't been set.
    */
   private Tooltip getTabTooltip() {
     final Path filePath = getPath();
     return (filePath == null)
       ? null
       : new Tooltip( filePath.toString() );
+  }
   /**
    * Returns a marker to indicate whether the file has been modified.
+   *
    * @return "*" when the file has changed; otherwise null.
    */
   private Text getModifiedMark() {
     return isModified() ? new Text( "*" ) : null;
+  }
   /**
    * Called when the user switches tab.
    */
   private void activated() {
     // Tab is closed or no longer active.
     if( getTabPane() == null || !isSelected() ) {
       return;
+    }
     // Switch to the tab without loading if the contents are already in memory.
     if( getContent() != null ) {
       getEditorPane().requestFocus();
       return;
+    }
     // Load the text and update the preview before the undo manager.
     load();
     // Track undo requests -- can only be called *after* load.
     initUndoManager();
     initLayout();
     initFocus();
+  }
   private void initLayout() {
     setContent( getScrollPane() );
+  }
   private Node getScrollPane() {
     return getEditorPane().getScrollPane();
+  }
   private void initFocus() {
     getEditorPane().requestFocus();
+  }
   private void initUndoManager() {
     final UndoManager undoManager = getUndoManager();
     // Clear undo history after first load.
     undoManager.forgetHistory();
     // Bind the editor undo manager to the properties.
     modified.bind( Bindings.not( undoManager.atMarkedPositionProperty() ) );
     canUndo.bind( undoManager.undoAvailableProperty() );
     canRedo.bind( undoManager.redoAvailableProperty() );
+  }
   /**
    * Returns the index into the text where the caret blinks happily away.
+   *
    * @return A number from 0 to the editor's document text length.
    */
   public int getCaretPosition() {
     return getEditorPane().getEditor().getCaretPosition();
+  }
   /**
    * Returns true if the given path exactly matches this tab's path.
+   *
    * @param check The path to compare against.
+   *
    * @return true The paths are the same.
    */
   public boolean isPath( final Path check ) {
     final Path filePath = getPath();
     return filePath == null ? false : filePath.equals( check );
+  }
   /**
    * Reads the entire file contents from the path associated with this tab.
    */
   private void load() {
     final Path filePath = getPath();
     if( filePath != null ) {
       try {
         getEditorPane().setText( asString( Files.readAllBytes( filePath ) ) );
       } catch( Exception ex ) {
         alert(
           "FileEditor.loadFailed.title", "FileEditor.loadFailed.message", ex
         );
+      }
+    }
+  }
   /**
    * Saves the entire file contents from the path associated with this tab.
+   *
    * @return true The file has been saved.
    */
   public boolean save() {
     try {
       Files.write( getPath(), asBytes( getEditorPane().getText() ) );
       getEditorPane().getUndoManager().mark();
       return true;
     } catch( Exception ex ) {
       return alert(
         "FileEditor.saveFailed.title", "FileEditor.saveFailed.message", ex
       );
+    }
+  }
   /**
    * Creates an alert dialog and waits for it to close.
+   *
    * @param titleKey Resource bundle key for the alert dialog title.
    * @param messageKey Resource bundle key for the alert dialog message.
    * @param e The unexpected happening.
+   *
    * @return false
    */
   private boolean alert(
     final String titleKey, final String messageKey, final Exception e ) {
     final AlertService service = getAlertService();
     final AlertMessage message = service.createAlertMessage(
       Messages.get( titleKey ),
       Messages.get( messageKey ),
       getPath(),
       e.getMessage()
     );
     service.createAlertError( message ).showAndWait();
     return false;
+  }
   /**
    * Returns a best guess at the file encoding. If the encoding could not be
    * detected, this will return the default charset for the JVM.
+   *
    * @param bytes The bytes to perform character encoding detection.
+   *
    * @return The character encoding.
    */
   private Charset detectEncoding( final byte[] bytes ) {
     final UniversalDetector detector = new UniversalDetector( null );
     detector.handleData( bytes, 0, bytes.length );
     detector.dataEnd();
     final String charset = detector.getDetectedCharset();
     final Charset charEncoding = charset == null
       ? Charset.defaultCharset()
       : Charset.forName( charset.toUpperCase( ENGLISH ) );
     detector.reset();
     return charEncoding;
+  }
   /**
    * Converts the given string to an array of bytes using the encoding that was
    * originally detected (if any) and associated with this file.
+   *
    * @param text The text to convert into the original file encoding.
+   *
    * @return A series of bytes ready for writing to a file.
    */
   private byte[] asBytes( final String text ) {
     return text.getBytes( getEncoding() );
+  }
   /**
    * Converts the given bytes into a Java String. This will call setEncoding
    * with the encoding detected by the CharsetDetector.
+   *
    * @param text The text of unknown character encoding.
+   *
    * @return The text, in its auto-detected encoding, as a String.
    */
   private String asString( final byte[] text ) {
     setEncoding( detectEncoding( text ) );
     return new String( text, getEncoding() );
+  }
   Path getPath() {
     return this.path;
+  }
   void setPath( final Path path ) {
     this.path = path;
+  }
   public boolean isModified() {
     return this.modified.get();
+  }
   ReadOnlyBooleanProperty modifiedProperty() {
     return this.modified.getReadOnlyProperty();
+  }
   BooleanProperty canUndoProperty() {
     return this.canUndo;
+  }
   BooleanProperty canRedoProperty() {
     return this.canRedo;
+  }
   private UndoManager getUndoManager() {
     return getEditorPane().getUndoManager();
+  }
   /**
    * Forwards the request to the editor pane.
+   *
    * @param <T> The type of event listener to add.
    * @param <U> The type of consumer to add.
    * @param event The event that should trigger updates to the listener.
    * @param consumer The listener to receive update events.
    */
   public <T extends Event, U extends T> void addEventListener(
     final EventPattern<? super T, ? extends U> event,
     final Consumer<? super U> consumer ) {
     getEditorPane().addEventListener( event, consumer );
+  }
   /**
    * Forwards to the editor pane's listeners for keyboard events.
+   *
    * @param map The new input map to replace the existing keyboard listener.
    */
   public void addEventListener( final InputMap<InputEvent> map ) {
     getEditorPane().addEventListener( map );
+  }
   /**
    * Forwards to the editor pane's listeners for keyboard events.
+   *
    * @param map The existing input map to remove from the keyboard listeners.
    */
   public void removeEventListener( final InputMap<InputEvent> map ) {
     getEditorPane().removeEventListener( map );
+  }
   /**
    * Forwards to the editor pane's listeners for text change events.
+   *
    * @param listener The listener to notify when the text changes.
    */
   public void addTextChangeListener( final ChangeListener<String> listener ) {
     getEditorPane().addTextChangeListener( listener );
+  }
   /**
    * Forwards to the editor pane's listeners for caret paragraph change events.
+   *
    * @param listener The listener to notify when the caret changes paragraphs.
    */
   public void addCaretParagraphListener( final ChangeListener<Integer> listener ) {
     getEditorPane().addCaretParagraphListener( listener );
+  }
   /**
    * Forwards the request to the editor pane.
+   *
    * @return The text to process.
    */
   public String getEditorText() {
     return getEditorPane().getText();
+  }
   /**
    * Returns the editor pane, or creates one if it doesn't yet exist.
+   *
    * @return The editor pane, never null.
    */
   public EditorPane getEditorPane() {
     if( this.editorPane == null ) {
       this.editorPane = new MarkdownEditorPane();
+    }
     return this.editorPane;
+  }
   private AlertService getAlertService() {
     return this.alertService;
+  }
   private Options getOptions() {
     return this.options;
 import com.scrivenvar.service.events.AlertMessage;
 import com.scrivenvar.service.events.AlertService;
 import java.nio.charset.Charset;
 import java.nio.file.Files;
 import java.nio.file.Path;
 import static java.util.Locale.ENGLISH;
 import java.util.function.Consumer;
 import javafx.application.Platform;
 import javafx.beans.binding.Bindings;
 import javafx.beans.property.BooleanProperty;
 import javafx.beans.property.ReadOnlyBooleanProperty;
 import javafx.beans.property.ReadOnlyBooleanWrapper;
 import javafx.beans.property.SimpleBooleanProperty;
 import javafx.beans.value.ChangeListener;
 import javafx.event.Event;
 import javafx.scene.Node;
 import javafx.scene.control.Tab;
 import javafx.scene.control.Tooltip;
 import javafx.scene.input.InputEvent;
 import javafx.scene.text.Text;
 import org.fxmisc.undo.UndoManager;
 import org.fxmisc.wellbehaved.event.EventPattern;
 import org.fxmisc.wellbehaved.event.InputMap;
 import org.mozilla.universalchardet.UniversalDetector;
 /**
  * Editor for a single file.
+ *
  * @author Karl Tauber and White Magic Software, Ltd.
  */
 public final class FileEditorTab extends Tab {
   private final AlertService alertService = Services.load( AlertService.class );
   private EditorPane editorPane;
   /**
    * Character encoding used by the file (or default encoding if none found).
    */
   private Charset encoding;
   private final ReadOnlyBooleanWrapper modified = new ReadOnlyBooleanWrapper();
   private final BooleanProperty canUndo = new SimpleBooleanProperty();
   private final BooleanProperty canRedo = new SimpleBooleanProperty();
   private Path path;
   FileEditorTab( final Path path ) {
     setPath( path );
     this.modified.addListener( (observable, oldPath, newPath) -> updateTab() );
     updateTab();
     setOnSelectionChanged( e -> {
       if( isSelected() ) {
         Platform.runLater( () -> activated() );
+      }
     } );
+  }
   private void updateTab() {
     setText( getTabTitle() );
     setGraphic( getModifiedMark() );
     setTooltip( getTabTooltip() );
+  }
   /**
    * Returns the base filename (without the directory names).
+   *
    * @return The untitled text if the path hasn't been set.
    */
   private String getTabTitle() {
     final Path filePath = getPath();
     return (filePath == null)
       ? Messages.get( "FileEditor.untitled" )
       : filePath.getFileName().toString();
+  }
   /**
    * Returns the full filename represented by the path.
+   *
    * @return The untitled text if the path hasn't been set.
    */
   private Tooltip getTabTooltip() {
     final Path filePath = getPath();
     return (filePath == null)
       ? null
       : new Tooltip( filePath.toString() );
+  }
   /**
    * Returns a marker to indicate whether the file has been modified.
+   *
    * @return "*" when the file has changed; otherwise null.
    */
   private Text getModifiedMark() {
     return isModified() ? new Text( "*" ) : null;
+  }
   /**
    * Called when the user switches tab.
    */
   private void activated() {
     // Tab is closed or no longer active.
     if( getTabPane() == null || !isSelected() ) {
       return;
+    }
     // Switch to the tab without loading if the contents are already in memory.
     if( getContent() != null ) {
       getEditorPane().requestFocus();
       return;
+    }
     // Load the text and update the preview before the undo manager.
     load();
     // Track undo requests -- can only be called *after* load.
     initUndoManager();
     initLayout();
     initFocus();
+  }
   private void initLayout() {
     setContent( getScrollPane() );
+  }
   private Node getScrollPane() {
     return getEditorPane().getScrollPane();
+  }
   private void initFocus() {
     getEditorPane().requestFocus();
+  }
   private void initUndoManager() {
     final UndoManager undoManager = getUndoManager();
     // Clear undo history after first load.
     undoManager.forgetHistory();
     // Bind the editor undo manager to the properties.
     modified.bind( Bindings.not( undoManager.atMarkedPositionProperty() ) );
     canUndo.bind( undoManager.undoAvailableProperty() );
     canRedo.bind( undoManager.redoAvailableProperty() );
+  }
   /**
    * Returns the index into the text where the caret blinks happily away.
+   *
    * @return A number from 0 to the editor's document text length.
    */
   public int getCaretPosition() {
     return getEditorPane().getEditor().getCaretPosition();
+  }
   /**
    * Returns true if the given path exactly matches this tab's path.
+   *
    * @param check The path to compare against.
+   *
    * @return true The paths are the same.
    */
   public boolean isPath( final Path check ) {
     final Path filePath = getPath();
     return filePath == null ? false : filePath.equals( check );
+  }
   /**
    * Reads the entire file contents from the path associated with this tab.
    */
   private void load() {
     final Path filePath = getPath();
     if( filePath != null ) {
       try {
         getEditorPane().setText( asString( Files.readAllBytes( filePath ) ) );
       } catch( Exception ex ) {
         alert(
           "FileEditor.loadFailed.title", "FileEditor.loadFailed.message", ex
         );
+      }
+    }
+  }
   /**
    * Saves the entire file contents from the path associated with this tab.
+   *
    * @return true The file has been saved.
    */
   public boolean save() {
     try {
       Files.write( getPath(), asBytes( getEditorPane().getText() ) );
       getEditorPane().getUndoManager().mark();
       return true;
     } catch( Exception ex ) {
       return alert(
         "FileEditor.saveFailed.title", "FileEditor.saveFailed.message", ex
       );
+    }
+  }
   /**
    * Creates an alert dialog and waits for it to close.
+   *
    * @param titleKey Resource bundle key for the alert dialog title.
    * @param messageKey Resource bundle key for the alert dialog message.
    * @param e The unexpected happening.
+   *
    * @return false
    */
   private boolean alert(
     final String titleKey, final String messageKey, final Exception e ) {
     final AlertService service = getAlertService();
     final AlertMessage message = service.createAlertMessage(
       Messages.get( titleKey ),
       Messages.get( messageKey ),
       getPath(),
       e.getMessage()
     );
     service.createAlertError( message ).showAndWait();
     return false;
+  }
   /**
    * Returns a best guess at the file encoding. If the encoding could not be
    * detected, this will return the default charset for the JVM.
+   *
    * @param bytes The bytes to perform character encoding detection.
+   *
    * @return The character encoding.
    */
   private Charset detectEncoding( final byte[] bytes ) {
     final UniversalDetector detector = new UniversalDetector( null );
     detector.handleData( bytes, 0, bytes.length );
     detector.dataEnd();
     final String charset = detector.getDetectedCharset();
     final Charset charEncoding = charset == null
       ? Charset.defaultCharset()
       : Charset.forName( charset.toUpperCase( ENGLISH ) );
     detector.reset();
     return charEncoding;
+  }
   /**
    * Converts the given string to an array of bytes using the encoding that was
    * originally detected (if any) and associated with this file.
+   *
    * @param text The text to convert into the original file encoding.
+   *
    * @return A series of bytes ready for writing to a file.
    */
   private byte[] asBytes( final String text ) {
     return text.getBytes( getEncoding() );
+  }
   /**
    * Converts the given bytes into a Java String. This will call setEncoding
    * with the encoding detected by the CharsetDetector.
+   *
    * @param text The text of unknown character encoding.
+   *
    * @return The text, in its auto-detected encoding, as a String.
    */
   private String asString( final byte[] text ) {
     setEncoding( detectEncoding( text ) );
     return new String( text, getEncoding() );
+  }
   public Path getPath() {
     return this.path;
+  }
   void setPath( final Path path ) {
     this.path = path;
+  }
   public boolean isModified() {
     return this.modified.get();
+  }
   ReadOnlyBooleanProperty modifiedProperty() {
     return this.modified.getReadOnlyProperty();
+  }
   BooleanProperty canUndoProperty() {
     return this.canUndo;
+  }
   BooleanProperty canRedoProperty() {
     return this.canRedo;
+  }
   private UndoManager getUndoManager() {
     return getEditorPane().getUndoManager();
+  }
   /**
    * Forwards the request to the editor pane.
+   *
    * @param <T> The type of event listener to add.
    * @param <U> The type of consumer to add.
    * @param event The event that should trigger updates to the listener.
    * @param consumer The listener to receive update events.
    */
   public <T extends Event, U extends T> void addEventListener(
     final EventPattern<? super T, ? extends U> event,
     final Consumer<? super U> consumer ) {
     getEditorPane().addEventListener( event, consumer );
+  }
   /**
    * Forwards to the editor pane's listeners for keyboard events.
+   *
    * @param map The new input map to replace the existing keyboard listener.
    */
   public void addEventListener( final InputMap<InputEvent> map ) {
     getEditorPane().addEventListener( map );
+  }
   /**
    * Forwards to the editor pane's listeners for keyboard events.
+   *
    * @param map The existing input map to remove from the keyboard listeners.
    */
   public void removeEventListener( final InputMap<InputEvent> map ) {
     getEditorPane().removeEventListener( map );
+  }
   /**
    * Forwards to the editor pane's listeners for text change events.
+   *
    * @param listener The listener to notify when the text changes.
    */
   public void addTextChangeListener( final ChangeListener<String> listener ) {
     getEditorPane().addTextChangeListener( listener );
+  }
   /**
    * Forwards to the editor pane's listeners for caret paragraph change events.
+   *
    * @param listener The listener to notify when the caret changes paragraphs.
    */
   public void addCaretParagraphListener( final ChangeListener<Integer> listener ) {
     getEditorPane().addCaretParagraphListener( listener );
+  }
   /**
    * Forwards the request to the editor pane.
+   *
    * @return The text to process.
    */
   public String getEditorText() {
     return getEditorPane().getText();
+  }
   /**
    * Returns the editor pane, or creates one if it doesn't yet exist.
+   *
    * @return The editor pane, never null.
    */
   public EditorPane getEditorPane() {
     if( this.editorPane == null ) {
       this.editorPane = new MarkdownEditorPane();
+    }
     return this.editorPane;
+  }
   private AlertService getAlertService() {
     return this.alertService;
+  }

M src/main/java/com/scrivenvar/Main.java

 import static com.scrivenvar.Constants.*;
 import com.scrivenvar.service.Options;
 import com.scrivenvar.service.Snitch;
 import com.scrivenvar.service.events.AlertService;
 import com.scrivenvar.util.StageState;
 public final class Main extends Application {
   private static Application app;
   private final Options options = Services.load( Options.class );
   private final Snitch snitch = Services.load( Snitch.class );
   private Thread snitchThread;
   private static Application app;
   private final MainWindow mainWindow = new MainWindow();
   private final Options options = Services.load( Options.class );
   public static void main( String[] args ) {
   public static void main( final String[] args ) {
     launch( args );
+  }
     initStage( stage );
     initAlertService();
     initWatchDog();
     stage.show();
+  }
   private void initApplication() {
     app = this;
+  }
   private Options getOptions() {
     return this.options;
   public static void showDocument( final String uri ) {
     getApplication().getHostServices().showDocument( uri );
+  }
   private String getApplicationTitle() {
     return Messages.get( "Main.title" );
   private void initApplication() {
     app = this;
+  }
   private StageState initState( Stage stage ) {
   private StageState initState( final Stage stage ) {
     return new StageState( stage, getOptions().getState() );
+  }
   private void initStage( Stage stage ) {
   private void initStage( final Stage stage ) {
     stage.getIcons().addAll(
       createImage( FILE_LOGO_16 ),
     final AlertService service = Services.load( AlertService.class );
     service.setWindow( getScene().getWindow() );
+  }
   private void initWatchDog() {
     setSnitchThread( new Thread( getWatchDog() ) );
     getSnitchThread().start();
+  }
   /**
    * Stops the snitch service, if its running.
+   *
    * @throws InterruptedException Couldn't stop the snitch thread.
    */
   @Override
   public void stop() throws InterruptedException {
     getWatchDog().stop();
     final Thread thread = getSnitchThread();
     if( thread != null ) {
       thread.interrupt();
       thread.join();
+    }
+  }
   private Snitch getWatchDog() {
     return this.snitch;
+  }
   private Thread getSnitchThread() {
     return this.snitchThread;
+  }
   private void setSnitchThread( final Thread thread ) {
     this.snitchThread = thread;
+  }
   private Options getOptions() {
     return this.options;
+  }
+  }
   private static Application getApplication() {
     return app;
   private String getApplicationTitle() {
     return Messages.get( "Main.title" );
+  }
   public static void showDocument( String uri ) {
     getApplication().getHostServices().showDocument( uri );
   private static Application getApplication() {
     return app;
+  }

M src/main/java/com/scrivenvar/MainWindow.java

 import static com.scrivenvar.Constants.PREFS_DEFINITION_SOURCE;
 import static com.scrivenvar.Constants.STYLESHEET_SCENE;
 import com.scrivenvar.definition.DefinitionFactory;
 import com.scrivenvar.definition.DefinitionPane;
 import com.scrivenvar.definition.DefinitionSource;
 import com.scrivenvar.definition.EmptyDefinitionSource;
 import com.scrivenvar.editors.VariableNameInjector;
 import com.scrivenvar.editors.markdown.MarkdownEditorPane;
 import com.scrivenvar.preview.HTMLPreviewPane;
 import com.scrivenvar.processors.HTMLPreviewProcessor;
 import com.scrivenvar.processors.MarkdownCaretInsertionProcessor;
 import com.scrivenvar.processors.MarkdownCaretReplacementProcessor;
 import com.scrivenvar.processors.MarkdownProcessor;
 import com.scrivenvar.processors.Processor;
 import com.scrivenvar.processors.VariableProcessor;
 import com.scrivenvar.service.Options;
 import com.scrivenvar.util.Action;
 import com.scrivenvar.util.ActionUtils;
 import static com.scrivenvar.util.StageState.K_PANE_SPLIT_DEFINITION;
 import static com.scrivenvar.util.StageState.K_PANE_SPLIT_EDITOR;
 import static com.scrivenvar.util.StageState.K_PANE_SPLIT_PREVIEW;
 import static de.jensd.fx.glyphs.fontawesome.FontAwesomeIcon.BOLD;
 import static de.jensd.fx.glyphs.fontawesome.FontAwesomeIcon.CODE;
 import static de.jensd.fx.glyphs.fontawesome.FontAwesomeIcon.FILE_ALT;
 import static de.jensd.fx.glyphs.fontawesome.FontAwesomeIcon.FILE_CODE_ALT;
 import static de.jensd.fx.glyphs.fontawesome.FontAwesomeIcon.FLOPPY_ALT;
 import static de.jensd.fx.glyphs.fontawesome.FontAwesomeIcon.FOLDER_OPEN_ALT;
 import static de.jensd.fx.glyphs.fontawesome.FontAwesomeIcon.HEADER;
 import static de.jensd.fx.glyphs.fontawesome.FontAwesomeIcon.ITALIC;
 import static de.jensd.fx.glyphs.fontawesome.FontAwesomeIcon.LINK;
 import static de.jensd.fx.glyphs.fontawesome.FontAwesomeIcon.LIST_OL;
 import static de.jensd.fx.glyphs.fontawesome.FontAwesomeIcon.LIST_UL;
 import static de.jensd.fx.glyphs.fontawesome.FontAwesomeIcon.PICTURE_ALT;
 import static de.jensd.fx.glyphs.fontawesome.FontAwesomeIcon.QUOTE_LEFT;
 import static de.jensd.fx.glyphs.fontawesome.FontAwesomeIcon.REPEAT;
 import static de.jensd.fx.glyphs.fontawesome.FontAwesomeIcon.STRIKETHROUGH;
 import static de.jensd.fx.glyphs.fontawesome.FontAwesomeIcon.UNDO;
 import java.net.MalformedURLException;
 import java.nio.file.Path;
 import java.util.Map;
 import java.util.function.Function;
 import java.util.prefs.Preferences;
 import javafx.beans.binding.Bindings;
 import javafx.beans.binding.BooleanBinding;
 import javafx.beans.property.BooleanProperty;
 import javafx.beans.property.SimpleBooleanProperty;
 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.scene.Node;
 import javafx.scene.Scene;
 import javafx.scene.control.Alert;
 import javafx.scene.control.Alert.AlertType;
 import javafx.scene.control.Menu;
 import javafx.scene.control.MenuBar;
 import javafx.scene.control.SplitPane;
 import javafx.scene.control.Tab;
 import javafx.scene.control.ToolBar;
 import javafx.scene.control.TreeView;
 import javafx.scene.image.Image;
 import javafx.scene.image.ImageView;
 import static javafx.scene.input.KeyCode.ESCAPE;
 import javafx.scene.input.KeyEvent;
 import static javafx.scene.input.KeyEvent.CHAR_UNDEFINED;
 import static javafx.scene.input.KeyEvent.KEY_PRESSED;
 import javafx.scene.layout.BorderPane;
 import javafx.scene.layout.VBox;
 import javafx.stage.Window;
 import javafx.stage.WindowEvent;
 import static com.scrivenvar.Messages.get;
 /**
  * Main window containing a tab pane in the center for file editors.
+ *
  * @author Karl Tauber and White Magic Software, Ltd.
  */
 public class MainWindow {
   private final Options options = Services.load( Options.class );
   private Scene scene;
   private MenuBar menuBar;
   private DefinitionPane definitionPane;
   private FileEditorTabPane fileEditorPane;
   private HTMLPreviewPane previewPane;
   private DefinitionSource definitionSource;
   public MainWindow() {
     initLayout();
     initOpenDefinitionListener();
     initTabAddedListener();
     initTabChangedListener();
     initPreferences();
+  }
   /**
    * Listen for file editor tab pane to receive an open definition source event.
    */
   private void initOpenDefinitionListener() {
     getFileEditorPane().onOpenDefinitionFileProperty().addListener(
       (ObservableValue<? extends Path> definitionFile,
         final Path oldPath, final Path newPath) -> {
         openDefinition( newPath );
         refreshSelectedTab( getActiveFileEditor() );
       } );
+  }
   /**
    * 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();
     // Update the preview pane on tab changes.
     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;
               initTextChangeListener( tab );
               initCaretParagraphListener( tab );
               initVariableNameInjector( tab );
+            }
+          }
+        }
+      }
     );
+  }
   /**
    * Reloads the preferences from the previous load.
    */
   private void initPreferences() {
     getFileEditorPane().restorePreferences();
     restoreDefinitionSource();
+  }
   /**
    * Listen for new tab selection events.
    */
   private void initTabChangedListener() {
     final FileEditorTabPane editorPane = getFileEditorPane();
     // Update the preview pane changing tabs.
     editorPane.addTabSelectionListener(
       (ObservableValue<? extends Tab> tabPane,
         final Tab oldTab, final Tab newTab) -> {
         // If there was no old tab, then this is a first time load, which
         // can be ignored.
         if( oldTab != null ) {
           if( newTab == null ) {
             closeRemainingTab();
           } else {
             // Synchronize the preview with the edited text.
             refreshSelectedTab( (FileEditorTab)newTab );
+          }
+        }
+      }
     );
+  }
   private void initTextChangeListener( final FileEditorTab tab ) {
     tab.addTextChangeListener(
       (ObservableValue<? extends String> editor,
         final String oldValue, final String newValue) -> {
         refreshSelectedTab( tab );
+      }
     );
+  }
   private void initCaretParagraphListener( final FileEditorTab tab ) {
     tab.addCaretParagraphListener(
       (ObservableValue<? extends Integer> editor,
         final Integer oldValue, final Integer newValue) -> {
         refreshSelectedTab( tab );
+      }
     );
+  }
   private void initVariableNameInjector( final FileEditorTab tab ) {
     VariableNameInjector vni = new VariableNameInjector( tab, getDefinitionPane() );
+  }
   /**
    * 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 refreshSelectedTab( final FileEditorTab tab ) {
     final HTMLPreviewPane preview = getPreviewPane();
     preview.setPath( tab.getPath() );
     final Processor<String> hpp = new HTMLPreviewProcessor( preview );
     final Processor<String> mcrp = new MarkdownCaretReplacementProcessor( hpp );
     final Processor<String> mp = new MarkdownProcessor( mcrp );
     final Processor<String> mcip = new MarkdownCaretInsertionProcessor( mp, tab.getCaretPosition() );
     final Processor<String> vp = new VariableProcessor( mcip, getResolvedMap() );
     vp.processChain( tab.getEditorText() );
+  }
   /**
    * Returns the variable map of interpolated definitions.
+   *
    * @return A map to help dereference variables.
    */
   private Map<String, String> getResolvedMap() {
     return getDefinitionSource().getResolvedMap();
+  }
   /**
    * Returns the root node for the hierarchical definition source.
+   *
    * @return Data to display in the definition pane.
    */
   private TreeView<String> getTreeView() {
     try {
       return getDefinitionSource().asTreeView();
     } catch( Exception e ) {
       alert( e );
+    }
     return new TreeView<>();
+  }
   private void openDefinition( final Path path ) {
     openDefinition( path.toString() );
+  }
   private void openDefinition( final String path ) {
     try {
       final DefinitionSource ds = createDefinitionSource( path );
       setDefinitionSource( ds );
       storeDefinitionSource();
       getDefinitionPane().setRoot( ds.asTreeView() );
     } catch( Exception e ) {
       alert( e );
+    }
+  }
   private void restoreDefinitionSource() {
     final Preferences preferences = getPreferences();
     final String source = preferences.get( PREFS_DEFINITION_SOURCE, null );
     if( source != null ) {
       openDefinition( source );
+    }
+  }
   private void storeDefinitionSource() {
     final Preferences preferences = getPreferences();
     final DefinitionSource ds = getDefinitionSource();
     preferences.put( PREFS_DEFINITION_SOURCE, ds.toString() );
+  }
   /**
    * Called when the last open tab is closed. This clears out the preview pane
    * and the definition pane.
    */
   private void closeRemainingTab() {
     getPreviewPane().clear();
     getDefinitionPane().clear();
+  }
   /**
    * Called when an exception occurs that warrants the user's attention.
+   *
    * @param e The exception with a message that the user should know about.
    */
   private void alert( final Exception e ) {
     // TODO: Raise a notice.
+  }
   //---- File actions -------------------------------------------------------
   private void fileNew() {
     getFileEditorPane().newEditor();
+  }
   private void fileOpen() {
     getFileEditorPane().openFileDialog();
+  }
   private void fileClose() {
     getFileEditorPane().closeEditor( getActiveFileEditor(), true );
+  }
   private void fileCloseAll() {
     getFileEditorPane().closeAllEditors();
+  }
   private void fileSave() {
     getFileEditorPane().saveEditor( getActiveFileEditor() );
+  }
   private void fileSaveAll() {
     getFileEditorPane().saveAllEditors();
+  }
   private void fileExit() {
     final Window window = getWindow();
     Event.fireEvent( window,
       new WindowEvent( window, WindowEvent.WINDOW_CLOSE_REQUEST ) );
+  }
   //---- Help actions -------------------------------------------------------
   private void helpAbout() {
     Alert alert = new Alert( AlertType.INFORMATION );
     alert.setTitle( get( "Dialog.about.title" ) );
     alert.setHeaderText( get( "Dialog.about.header" ) );
     alert.setContentText( get( "Dialog.about.content" ) );
     alert.setGraphic( new ImageView( new Image( FILE_LOGO_32 ) ) );
     alert.initOwner( getWindow() );
     alert.showAndWait();
+  }
   //---- Convenience accessors ----------------------------------------------
   private float getFloat( final String key, final float defaultValue ) {
     return getPreferences().getFloat( key, defaultValue );
+  }
   private Preferences getPreferences() {
     return getOptions().getState();
+  }
   private Window getWindow() {
     return getScene().getWindow();
+  }
   private MarkdownEditorPane getActiveEditor() {
     return (MarkdownEditorPane)(getActiveFileEditor().getEditorPane());
+  }
   private FileEditorTab getActiveFileEditor() {
     return getFileEditorPane().getActiveFileEditor();
+  }
   //---- Member accessors ---------------------------------------------------
   public Scene getScene() {
     return this.scene;
+  }
   private void setScene( Scene scene ) {
     this.scene = scene;
+  }
   private FileEditorTabPane getFileEditorPane() {
     if( this.fileEditorPane == null ) {
       this.fileEditorPane = createFileEditorPane();
+    }
     return this.fileEditorPane;
+  }
   private synchronized HTMLPreviewPane getPreviewPane() {
     if( this.previewPane == null ) {
       this.previewPane = createPreviewPane();
+    }
     return this.previewPane;
+  }
   private void setDefinitionSource( final DefinitionSource definitionSource ) {
     this.definitionSource = definitionSource;
+  }
   private synchronized DefinitionSource getDefinitionSource() {
     if( this.definitionSource == null ) {
       this.definitionSource = new EmptyDefinitionSource();
+    }
     return this.definitionSource;
+  }
   private DefinitionPane getDefinitionPane() {
     if( this.definitionPane == null ) {
       this.definitionPane = createDefinitionPane();
+    }
     return this.definitionPane;
+  }
   private Options getOptions() {
     return this.options;
+  }
   public MenuBar getMenuBar() {
     return this.menuBar;
+  }
   public void setMenuBar( MenuBar menuBar ) {
     this.menuBar = menuBar;
+  }
   //---- Member creators ----------------------------------------------------
   private DefinitionSource createDefinitionSource( final String path )
     throws MalformedURLException {
     return createDefinitionFactory().createDefinitionSource( path );
+  }
   /**
    * Create an editor pane to hold file editor tabs.
+   *
    * @return A new instance, never null.
    */
   private FileEditorTabPane createFileEditorPane() {
     return new FileEditorTabPane();
+  }
   private HTMLPreviewPane createPreviewPane() {
     return new HTMLPreviewPane();
+  }
   private DefinitionPane createDefinitionPane() {
     return new DefinitionPane( getTreeView() );
+  }
   private DefinitionFactory createDefinitionFactory() {
     return new DefinitionFactory();
+  }
   private Node createMenuBar() {
     final BooleanBinding activeFileEditorIsNull = getFileEditorPane().activeFileEditorProperty().isNull();
     // File actions
     Action fileNewAction = new Action( get( "Main.menu.file.new" ), "Shortcut+N", FILE_ALT, e -> fileNew() );
     Action fileOpenAction = new Action( get( "Main.menu.file.open" ), "Shortcut+O", FOLDER_OPEN_ALT, e -> fileOpen() );
     Action fileCloseAction = new Action( get( "Main.menu.file.close" ), "Shortcut+W", null, e -> fileClose(), activeFileEditorIsNull );
     Action fileCloseAllAction = new Action( get( "Main.menu.file.close_all" ), null, null, e -> fileCloseAll(), activeFileEditorIsNull );
     Action fileSaveAction = new Action( get( "Main.menu.file.save" ), "Shortcut+S", FLOPPY_ALT, e -> fileSave(),
       createActiveBooleanProperty( FileEditorTab::modifiedProperty ).not() );
     Action fileSaveAllAction = new Action( get( "Main.menu.file.save_all" ), "Shortcut+Shift+S", null, e -> fileSaveAll(),
       Bindings.not( getFileEditorPane().anyFileEditorModifiedProperty() ) );
     Action fileExitAction = new Action( get( "Main.menu.file.exit" ), null, null, e -> fileExit() );
     // Edit actions
     Action editUndoAction = new Action( get( "Main.menu.edit.undo" ), "Shortcut+Z", UNDO,
       e -> getActiveEditor().undo(),
       createActiveBooleanProperty( FileEditorTab::canUndoProperty ).not() );
     Action editRedoAction = new Action( get( "Main.menu.edit.redo" ), "Shortcut+Y", REPEAT,
       e -> getActiveEditor().redo(),
       createActiveBooleanProperty( FileEditorTab::canRedoProperty ).not() );
     // Insert actions
     Action insertBoldAction = new Action( get( "Main.menu.insert.bold" ), "Shortcut+B", BOLD,
       e -> getActiveEditor().surroundSelection( "**", "**" ),
       activeFileEditorIsNull );
     Action insertItalicAction = new Action( get( "Main.menu.insert.italic" ), "Shortcut+I", ITALIC,
       e -> getActiveEditor().surroundSelection( "*", "*" ),
       activeFileEditorIsNull );
     Action insertStrikethroughAction = new Action( get( "Main.menu.insert.strikethrough" ), "Shortcut+T", STRIKETHROUGH,
       e -> getActiveEditor().surroundSelection( "~~", "~~" ),
       activeFileEditorIsNull );
     Action insertBlockquoteAction = new Action( get( "Main.menu.insert.blockquote" ), "Ctrl+Q", QUOTE_LEFT, // not Shortcut+Q because of conflict on Mac
       e -> getActiveEditor().surroundSelection( "\n\n> ", "" ),
       activeFileEditorIsNull );
     Action insertCodeAction = new Action( get( "Main.menu.insert.code" ), "Shortcut+K", CODE,
       e -> getActiveEditor().surroundSelection( "`", "`" ),
       activeFileEditorIsNull );
     Action insertFencedCodeBlockAction = new Action( get( "Main.menu.insert.fenced_code_block" ), "Shortcut+Shift+K", FILE_CODE_ALT,
       e -> getActiveEditor().surroundSelection( "\n\n```\n", "\n```\n\n", get( "Main.menu.insert.fenced_code_block.prompt" ) ),
       activeFileEditorIsNull );
     Action insertLinkAction = new Action( get( "Main.menu.insert.link" ), "Shortcut+L", LINK,
       e -> getActiveEditor().insertLink(),
       activeFileEditorIsNull );
     Action insertImageAction = new Action( get( "Main.menu.insert.image" ), "Shortcut+G", PICTURE_ALT,
       e -> getActiveEditor().insertImage(),
       activeFileEditorIsNull );
     final Action[] headers = new Action[ 6 ];
     // Insert header actions (H1 ... H6)
     for( int i = 1; i <= 6; i++ ) {
       final String hashes = new String( new char[ i ] ).replace( "\0", "#" );
       final String markup = String.format( "\n\n%s ", hashes );
 import static com.scrivenvar.Messages.get;
 import com.scrivenvar.definition.DefinitionFactory;
 import com.scrivenvar.definition.DefinitionPane;
 import com.scrivenvar.definition.DefinitionSource;
 import com.scrivenvar.definition.EmptyDefinitionSource;
 import com.scrivenvar.editors.EditorPane;
 import com.scrivenvar.editors.VariableNameInjector;
 import com.scrivenvar.editors.markdown.MarkdownEditorPane;
 import com.scrivenvar.preview.HTMLPreviewPane;
 import com.scrivenvar.processors.CaretReplacementProcessor;
 import com.scrivenvar.processors.HTMLPreviewProcessor;
 import com.scrivenvar.processors.MarkdownProcessor;
 import com.scrivenvar.processors.Processor;
 import com.scrivenvar.processors.VariableProcessor;
 import com.scrivenvar.processors.XMLCaretInsertionProcessor;
 import com.scrivenvar.processors.XMLProcessor;
 import com.scrivenvar.service.Options;
 import com.scrivenvar.util.Action;
 import com.scrivenvar.util.ActionUtils;
 import static com.scrivenvar.util.StageState.K_PANE_SPLIT_DEFINITION;
 import static com.scrivenvar.util.StageState.K_PANE_SPLIT_EDITOR;
 import static com.scrivenvar.util.StageState.K_PANE_SPLIT_PREVIEW;
 import static de.jensd.fx.glyphs.fontawesome.FontAwesomeIcon.BOLD;
 import static de.jensd.fx.glyphs.fontawesome.FontAwesomeIcon.CODE;
 import static de.jensd.fx.glyphs.fontawesome.FontAwesomeIcon.FILE_ALT;
 import static de.jensd.fx.glyphs.fontawesome.FontAwesomeIcon.FILE_CODE_ALT;
 import static de.jensd.fx.glyphs.fontawesome.FontAwesomeIcon.FLOPPY_ALT;
 import static de.jensd.fx.glyphs.fontawesome.FontAwesomeIcon.FOLDER_OPEN_ALT;
 import static de.jensd.fx.glyphs.fontawesome.FontAwesomeIcon.HEADER;
 import static de.jensd.fx.glyphs.fontawesome.FontAwesomeIcon.ITALIC;
 import static de.jensd.fx.glyphs.fontawesome.FontAwesomeIcon.LINK;
 import static de.jensd.fx.glyphs.fontawesome.FontAwesomeIcon.LIST_OL;
 import static de.jensd.fx.glyphs.fontawesome.FontAwesomeIcon.LIST_UL;
 import static de.jensd.fx.glyphs.fontawesome.FontAwesomeIcon.PICTURE_ALT;
 import static de.jensd.fx.glyphs.fontawesome.FontAwesomeIcon.QUOTE_LEFT;
 import static de.jensd.fx.glyphs.fontawesome.FontAwesomeIcon.REPEAT;
 import static de.jensd.fx.glyphs.fontawesome.FontAwesomeIcon.STRIKETHROUGH;
 import static de.jensd.fx.glyphs.fontawesome.FontAwesomeIcon.UNDO;
 import java.net.MalformedURLException;
 import java.nio.file.Path;
 import java.util.Map;
 import java.util.function.Function;
 import java.util.prefs.Preferences;
 import javafx.beans.binding.Bindings;
 import javafx.beans.binding.BooleanBinding;
 import javafx.beans.property.BooleanProperty;
 import javafx.beans.property.SimpleBooleanProperty;
 import javafx.beans.value.ObservableBooleanValue;
 import javafx.beans.value.ObservableValue;
 import javafx.collections.ListChangeListener.Change;
 import javafx.collections.ObservableList;
 import static javafx.event.Event.fireEvent;
 import javafx.scene.Node;
 import javafx.scene.Scene;
 import javafx.scene.control.Alert;
 import javafx.scene.control.Alert.AlertType;
 import javafx.scene.control.Menu;
 import javafx.scene.control.MenuBar;
 import javafx.scene.control.SplitPane;
 import javafx.scene.control.Tab;
 import javafx.scene.control.ToolBar;
 import javafx.scene.control.TreeView;
 import javafx.scene.image.Image;
 import javafx.scene.image.ImageView;
 import static javafx.scene.input.KeyCode.ESCAPE;
 import javafx.scene.input.KeyEvent;
 import static javafx.scene.input.KeyEvent.CHAR_UNDEFINED;
 import static javafx.scene.input.KeyEvent.KEY_PRESSED;
 import javafx.scene.layout.BorderPane;
 import javafx.scene.layout.VBox;
 import javafx.stage.Window;
 import javafx.stage.WindowEvent;
 import static javafx.stage.WindowEvent.WINDOW_CLOSE_REQUEST;
 /**
  * Main window containing a tab pane in the center for file editors.
+ *
  * @author Karl Tauber and White Magic Software, Ltd.
  */
 public class MainWindow {
   private final Options options = Services.load( Options.class );
   private Scene scene;
   private MenuBar menuBar;
   private DefinitionPane definitionPane;
   private FileEditorTabPane fileEditorPane;
   private HTMLPreviewPane previewPane;
   private DefinitionSource definitionSource;
   public MainWindow() {
     initLayout();
     initOpenDefinitionListener();
     initTabAddedListener();
     initTabChangedListener();
     initPreferences();
+  }
   /**
    * Listen for file editor tab pane to receive an open definition source event.
    */
   private void initOpenDefinitionListener() {
     getFileEditorPane().onOpenDefinitionFileProperty().addListener(
       (ObservableValue<? extends Path> definitionFile,
         final Path oldPath, final Path newPath) -> {
         openDefinition( newPath );
         refreshSelectedTab( getActiveFileEditor() );
       } );
+  }
   /**
    * 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();
     // Update the preview pane on tab changes.
     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;
               initTextChangeListener( tab );
               initCaretParagraphListener( tab );
               initVariableNameInjector( tab );
+            }
+          }
+        }
+      }
     );
+  }
   /**
    * Reloads the preferences from the previous load.
    */
   private void initPreferences() {
     getFileEditorPane().restorePreferences();
     restoreDefinitionSource();
+  }
   /**
    * Listen for new tab selection events.
    */
   private void initTabChangedListener() {
     final FileEditorTabPane editorPane = getFileEditorPane();
     // Update the preview pane changing tabs.
     editorPane.addTabSelectionListener(
       (ObservableValue<? extends Tab> tabPane,
         final Tab oldTab, final Tab newTab) -> {
         // If there was no old tab, then this is a first time load, which
         // can be ignored.
         if( oldTab != null ) {
           if( newTab == null ) {
             closeRemainingTab();
           } else {
             // Update the preview with the edited text.
             refreshSelectedTab( (FileEditorTab)newTab );
+          }
+        }
+      }
     );
+  }
   private void initTextChangeListener( final FileEditorTab tab ) {
     tab.addTextChangeListener(
       (ObservableValue<? extends String> editor,
         final String oldValue, final String newValue) -> {
         refreshSelectedTab( tab );
+      }
     );
+  }
   private void initCaretParagraphListener( final FileEditorTab tab ) {
     tab.addCaretParagraphListener(
       (ObservableValue<? extends Integer> editor,
         final Integer oldValue, final Integer newValue) -> {
         refreshSelectedTab( tab );
+      }
     );
+  }
   private void initVariableNameInjector( final FileEditorTab tab ) {
     VariableNameInjector.listen( tab, getDefinitionPane() );
+  }
   /**
    * 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 refreshSelectedTab( final FileEditorTab tab ) {
     final Path path = tab.getPath();
     final HTMLPreviewPane preview = getPreviewPane();
     preview.setPath( tab.getPath() );
     final Processor<String> hpp = new HTMLPreviewProcessor( preview );
     final Processor<String> mcrp = new CaretReplacementProcessor( hpp );
     final Processor<String> mp = new MarkdownProcessor( mcrp );
 //    final Processor<String> mcip = new MarkdownCaretInsertionProcessor( mp, tab.getCaretPosition() );
     final Processor<String> xmlp = new XMLProcessor( mp, tab.getPath() );
     final Processor<String> xcip = new XMLCaretInsertionProcessor( xmlp, tab.getCaretPosition() );
     final Processor<String> vp = new VariableProcessor( xcip, getResolvedMap() );
     vp.processChain( tab.getEditorText() );
+  }
   /**
    * Returns the variable map of interpolated definitions.
+   *
    * @return A map to help dereference variables.
    */
   private Map<String, String> getResolvedMap() {
     return getDefinitionSource().getResolvedMap();
+  }
   /**
    * Returns the root node for the hierarchical definition source.
+   *
    * @return Data to display in the definition pane.
    */
   private TreeView<String> getTreeView() {
     try {
       return getDefinitionSource().asTreeView();
     } catch( Exception e ) {
       alert( e );
+    }
     return new TreeView<>();
+  }
   private void openDefinition( final Path path ) {
     openDefinition( path.toString() );
+  }
   private void openDefinition( final String path ) {
     try {
       final DefinitionSource ds = createDefinitionSource( path );
       setDefinitionSource( ds );
       storeDefinitionSource();
       getDefinitionPane().setRoot( ds.asTreeView() );
     } catch( Exception e ) {
       alert( e );
+    }
+  }
   private void restoreDefinitionSource() {
     final Preferences preferences = getPreferences();
     final String source = preferences.get( PREFS_DEFINITION_SOURCE, null );
     if( source != null ) {
       openDefinition( source );
+    }
+  }
   private void storeDefinitionSource() {
     final Preferences preferences = getPreferences();
     final DefinitionSource ds = getDefinitionSource();
     preferences.put( PREFS_DEFINITION_SOURCE, ds.toString() );
+  }
   /**
    * Called when the last open tab is closed. This clears out the preview pane
    * and the definition pane.
    */
   private void closeRemainingTab() {
     getPreviewPane().clear();
     getDefinitionPane().clear();
+  }
   /**
    * Called when an exception occurs that warrants the user's attention.
+   *
    * @param e The exception with a message that the user should know about.
    */
   private void alert( final Exception e ) {
     // TODO: Raise a notice.
+  }
   //---- File actions -------------------------------------------------------
   private void fileNew() {
     getFileEditorPane().newEditor();
+  }
   private void fileOpen() {
     getFileEditorPane().openFileDialog();
+  }
   private void fileClose() {
     getFileEditorPane().closeEditor( getActiveFileEditor(), true );
+  }
   private void fileCloseAll() {
     getFileEditorPane().closeAllEditors();
+  }
   private void fileSave() {
     getFileEditorPane().saveEditor( getActiveFileEditor() );
+  }
   private void fileSaveAll() {
     getFileEditorPane().saveAllEditors();
+  }
   private void fileExit() {
     final Window window = getWindow();
     fireEvent( window, new WindowEvent( window, WINDOW_CLOSE_REQUEST ) );
+  }
   //---- Help actions -------------------------------------------------------
   private void helpAbout() {
     Alert alert = new Alert( AlertType.INFORMATION );
     alert.setTitle( get( "Dialog.about.title" ) );
     alert.setHeaderText( get( "Dialog.about.header" ) );
     alert.setContentText( get( "Dialog.about.content" ) );
     alert.setGraphic( new ImageView( new Image( FILE_LOGO_32 ) ) );
     alert.initOwner( getWindow() );
     alert.showAndWait();
+  }
   //---- Convenience accessors ----------------------------------------------
   private float getFloat( final String key, final float defaultValue ) {
     return getPreferences().getFloat( key, defaultValue );
+  }
   private Preferences getPreferences() {
     return getOptions().getState();
+  }
   private Window getWindow() {
     return getScene().getWindow();
+  }
   private MarkdownEditorPane getActiveEditor() {
     final EditorPane pane = getActiveFileEditor().getEditorPane();
     return pane instanceof MarkdownEditorPane ? (MarkdownEditorPane)pane : null;
+  }
   private FileEditorTab getActiveFileEditor() {
     return getFileEditorPane().getActiveFileEditor();
+  }
   //---- Member accessors ---------------------------------------------------
   public Scene getScene() {
     return this.scene;
+  }
   private void setScene( Scene scene ) {
     this.scene = scene;
+  }
   private FileEditorTabPane getFileEditorPane() {
     if( this.fileEditorPane == null ) {
       this.fileEditorPane = createFileEditorPane();
+    }
     return this.fileEditorPane;
+  }
   private HTMLPreviewPane getPreviewPane() {
     if( this.previewPane == null ) {
       this.previewPane = createPreviewPane();
+    }
     return this.previewPane;
+  }
   private void setDefinitionSource( final DefinitionSource definitionSource ) {
     this.definitionSource = definitionSource;
+  }
   private DefinitionSource getDefinitionSource() {
     if( this.definitionSource == null ) {
       this.definitionSource = new EmptyDefinitionSource();
+    }
     return this.definitionSource;
+  }
   private DefinitionPane getDefinitionPane() {
     if( this.definitionPane == null ) {
       this.definitionPane = createDefinitionPane();
+    }
     return this.definitionPane;
+  }
   private Options getOptions() {
     return this.options;
+  }
   public MenuBar getMenuBar() {
     return this.menuBar;
+  }
   public void setMenuBar( MenuBar menuBar ) {
     this.menuBar = menuBar;
+  }
   //---- Member creators ----------------------------------------------------
   private DefinitionSource createDefinitionSource( final String path )
     throws MalformedURLException {
     return createDefinitionFactory().createDefinitionSource( path );
+  }
   /**
    * Create an editor pane to hold file editor tabs.
+   *
    * @return A new instance, never null.
    */
   private FileEditorTabPane createFileEditorPane() {
     return new FileEditorTabPane();
+  }
   private HTMLPreviewPane createPreviewPane() {
     return new HTMLPreviewPane();
+  }
   private DefinitionPane createDefinitionPane() {
     return new DefinitionPane( getTreeView() );
+  }
   private DefinitionFactory createDefinitionFactory() {
     return new DefinitionFactory();
+  }
   private Node createMenuBar() {
     final BooleanBinding activeFileEditorIsNull = getFileEditorPane().activeFileEditorProperty().isNull();
     // File actions
     Action fileNewAction = new Action( get( "Main.menu.file.new" ), "Shortcut+N", FILE_ALT, e -> fileNew() );
     Action fileOpenAction = new Action( get( "Main.menu.file.open" ), "Shortcut+O", FOLDER_OPEN_ALT, e -> fileOpen() );
     Action fileCloseAction = new Action( get( "Main.menu.file.close" ), "Shortcut+W", null, e -> fileClose(), activeFileEditorIsNull );
     Action fileCloseAllAction = new Action( get( "Main.menu.file.close_all" ), null, null, e -> fileCloseAll(), activeFileEditorIsNull );
     Action fileSaveAction = new Action( get( "Main.menu.file.save" ), "Shortcut+S", FLOPPY_ALT, e -> fileSave(),
       createActiveBooleanProperty( FileEditorTab::modifiedProperty ).not() );
     Action fileSaveAllAction = new Action( get( "Main.menu.file.save_all" ), "Shortcut+Shift+S", null, e -> fileSaveAll(),
       Bindings.not( getFileEditorPane().anyFileEditorModifiedProperty() ) );
     Action fileExitAction = new Action( get( "Main.menu.file.exit" ), null, null, e -> fileExit() );
     // Edit actions
     Action editUndoAction = new Action( get( "Main.menu.edit.undo" ), "Shortcut+Z", UNDO,
       e -> getActiveEditor().undo(),
       createActiveBooleanProperty( FileEditorTab::canUndoProperty ).not() );
     Action editRedoAction = new Action( get( "Main.menu.edit.redo" ), "Shortcut+Y", REPEAT,
       e -> getActiveEditor().redo(),
       createActiveBooleanProperty( FileEditorTab::canRedoProperty ).not() );
     // Insert actions
     Action insertBoldAction = new Action( get( "Main.menu.insert.bold" ), "Shortcut+B", BOLD,
       e -> getActiveEditor().surroundSelection( "**", "**" ),
       activeFileEditorIsNull );
     Action insertItalicAction = new Action( get( "Main.menu.insert.italic" ), "Shortcut+I", ITALIC,
       e -> getActiveEditor().surroundSelection( "*", "*" ),
       activeFileEditorIsNull );
     Action insertStrikethroughAction = new Action( get( "Main.menu.insert.strikethrough" ), "Shortcut+T", STRIKETHROUGH,
       e -> getActiveEditor().surroundSelection( "~~", "~~" ),
       activeFileEditorIsNull );
     Action insertBlockquoteAction = new Action( get( "Main.menu.insert.blockquote" ), "Ctrl+Q", QUOTE_LEFT, // not Shortcut+Q because of conflict on Mac
       e -> getActiveEditor().surroundSelection( "\n\n> ", "" ),
       activeFileEditorIsNull );
     Action insertCodeAction = new Action( get( "Main.menu.insert.code" ), "Shortcut+K", CODE,
       e -> getActiveEditor().surroundSelection( "`", "`" ),
       activeFileEditorIsNull );
     Action insertFencedCodeBlockAction = new Action( get( "Main.menu.insert.fenced_code_block" ), "Shortcut+Shift+K", FILE_CODE_ALT,
       e -> getActiveEditor().surroundSelection( "\n\n```\n", "\n```\n\n", get( "Main.menu.insert.fenced_code_block.prompt" ) ),
       activeFileEditorIsNull );
     Action insertLinkAction = new Action( get( "Main.menu.insert.link" ), "Shortcut+L", LINK,
       e -> getActiveEditor().insertLink(),
       activeFileEditorIsNull );
     Action insertImageAction = new Action( get( "Main.menu.insert.image" ), "Shortcut+G", PICTURE_ALT,
       e -> getActiveEditor().insertImage(),
       activeFileEditorIsNull );
     final Action[] headers = new Action[ 6 ];
     // Insert header actions (H1 ... H6)
     for( int i = 1; i <= 6; i++ ) {
       final String hashes = new String( new char[ i ] ).replace( "\0", "#" );
       final String markup = String.format( "%n%n%s ", hashes );
       final String text = get( "Main.menu.insert.header_" + i );
       final String accelerator = "Shortcut+" + i;

M src/main/java/com/scrivenvar/Services.java

 package com.scrivenvar;
 import java.util.HashMap;
 import java.util.Map;
 import java.util.ServiceLoader;
 /**
  * Responsible for loading services.
  * Responsible for loading services. The services are treated as singleton
  * instances.
+ *
  * @author White Magic Software, Ltd.
  */
 public class Services {
   private static final Map<Class, Object> SINGLETONS = new HashMap<>( 8 );
   /**
    * Loads a service based on its interface definition.
    * Loads a service based on its interface definition. This will return an
    * existing instance if the class has already been instantiated.
+   *
    * @param <T> The service to load.
    * @param api The interface definition for the service.
+   *
    * @return A class that implements the interface.
    */
   public static <T> T load( Class<T> api ) {
   public static <T> T load( final Class<T> api ) {
     @SuppressWarnings( "unchecked" )
     final T o = (T)get( api );
     return o == null ? newInstance( api ) : o;
+  }
   private static <T> T newInstance( final Class<T> api ) {
     final ServiceLoader<T> services = ServiceLoader.load( api );
     T result = null;
     for( T service : services ) {
     for( final T service : services ) {
       result = service;
       throw new RuntimeException( "No implementation for: " + api );
+    }
     // Re-use the same instance the next time the class is loaded.
     put( api, result );
     return result;
+  }
   private static void put( Class key, Object value ) {
     SINGLETONS.put( key, value );
+  }
   private static Object get( Class api ) {
     return SINGLETONS.get( api );
+  }
+}

M src/main/java/com/scrivenvar/controls/WebHyperlink.java

  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
 package com.scrivenvar.controls;
 import com.scrivenvar.Main;
 import javafx.beans.property.SimpleStringProperty;
 import javafx.beans.property.StringProperty;
 import javafx.scene.control.Hyperlink;
 import com.scrivenvar.Main;
 /**
  * Opens a web site in the default web browser.
+ *
  * @author Karl Tauber
  */
 public class WebHyperlink
 	extends Hyperlink
+{
 	public WebHyperlink() {
 		setStyle("-fx-padding: 0; -fx-border-width: 0");
+	}
 public class WebHyperlink extends Hyperlink {
 	@Override
 	public void fire() {
 		Main.showDocument(getUri());
+	}
   // 'uri' property
   private final StringProperty uri = new SimpleStringProperty();
 	// 'uri' property
 	private final StringProperty uri = new SimpleStringProperty();
 	public String getUri() { return uri.get(); }
 	public void setUri(String uri) { this.uri.set(uri); }
 	public StringProperty UriProperty() { return uri; }
   public WebHyperlink() {
     setStyle( "-fx-padding: 0; -fx-border-width: 0" );
+  }
   @Override
   public void fire() {
     Main.showDocument( getUri() );
+  }
   public String getUri() {
     return uri.get();
+  }
   public void setUri( String uri ) {
     this.uri.set( uri );
+  }
   public StringProperty uriProperty() {
     return uri;
+  }
+}

M src/main/java/com/scrivenvar/definition/DefinitionFactory.java

     final String protocol = getProtocol( path );
     DefinitionSource result = new EmptyDefinitionSource();
     DefinitionSource result = null;
     switch( protocol ) {
   private DefinitionSource createFileDefinitionSource(
     final String filetype, final Path path ) {
     DefinitionSource result = new EmptyDefinitionSource();
     DefinitionSource result = null;
     switch( filetype ) {

M src/main/java/com/scrivenvar/definition/DefinitionPane.java

 import com.scrivenvar.AbstractPane;
 import static com.scrivenvar.definition.yaml.YamlParser.SEPARATOR;
 import static com.scrivenvar.definition.yaml.YamlParser.SEPARATOR_CHAR;
 import com.scrivenvar.predicates.strings.ContainsPredicate;
 import com.scrivenvar.predicates.strings.StartsPredicate;
     TreeItem<String> pItem = cItem;
     int index = path.indexOf( SEPARATOR );
     int index = path.indexOf( SEPARATOR_CHAR );
     while( index >= 0 ) {
       final String node = path.substring( 0, index );
       path = path.substring( index + 1 );
       if( (cItem = findStartsNode( cItem, node )) == null ) {
         break;
+      }
       index = path.indexOf( SEPARATOR );
       index = path.indexOf( SEPARATOR_CHAR );
       pItem = cItem;
+    }
    */
   private VariableTreeItem<String> getTreeRoot() {
     return (VariableTreeItem<String>)getTreeView().getRoot();
     final TreeItem<String> root = getTreeView().getRoot();
     return root instanceof VariableTreeItem ? (VariableTreeItem<String>)root : null;
+  }

M src/main/java/com/scrivenvar/definition/yaml/YamlFileDefinitionSource.java

    this.yamlParser = yamlParser;
  }

  private InputStream asStream( final String resource ) {
    return getClass().getResourceAsStream( resource );
  }
}


M src/main/java/com/scrivenvar/definition/yaml/YamlParser.java

  * @author White Magic Software, Ltd.
  */
 public class YamlParser {
   /**
    * Separates YAML variable nodes (e.g., the dots in
    * <code>$root.node.var$</code>).
    */
   public static final String SEPARATOR = ".";
   private final static int GROUP_DELIMITED = 1;
   private final static int GROUP_REFERENCE = 2;
   private final static VariableDecorator VARIABLE_DECORATOR
     = new YamlVariableDecorator();
   /**
    * Compiled version of DEFAULT_REGEX.
    */
   private final static Pattern REGEX_PATTERN
     = Pattern.compile( YamlVariableDecorator.REGEX );
   /**
    * Should be JsonPointer.SEPARATOR, but Jackson YAML uses magic values.
    */
   private final static char SEPARATOR_YAML = '/';
   /**
    * Start of the Universe (the YAML document node that contains all others).
    */
   private ObjectNode documentRoot;
   /**
    * Map of references to dereferenced field values.
    */
   private Map<String, String> references;
   public YamlParser() {
+  }
   /**
    * Returns the given string with all the delimited references swapped with
    * their recursively resolved values.
+   *
    * @param text The text to parse with zero or more delimited references to
    * replace.
+   *
    * @return The substituted value.
    */
   public String substitute( String text ) {
     final Matcher matcher = patternMatch( text );
     final Map<String, String> map = getReferences();
     while( matcher.find() ) {
       final String key = matcher.group( GROUP_DELIMITED );
       final String value = map.get( key );
       if( value == null ) {
         missing( text );
       } else {
         text = text.replace( key, value );
+      }
+    }
     return text;
+  }
   /**
    * Returns all the strings with their values resolved in a flat hierarchy.
    * This copies all the keys and resolved values into a new map.
+   *
    * @return The new map created with all values having been resolved,
    * recursively.
    */
   public Map<String, String> createResolvedMap() {
     final Map<String, String> map = new HashMap<>( 1024 );
     resolve( getDocumentRoot(), "", map );
     return map;
+  }
   /**
    * Iterate over a given root node (at any level of the tree) and adapt each
    * leaf node.
+   *
    * @param rootNode A JSON node (YAML node) to adapt.
    */
   private void resolve(
     final JsonNode rootNode, final String path, final Map<String, String> map ) {
     if( rootNode != null ) {
       rootNode.fields().forEachRemaining(
         (Entry<String, JsonNode> leaf) -> resolve( leaf, path, map )
       );
+    }
+  }
   /**
    * Recursively adapt each rootNode to a corresponding rootItem.
+   *
    * @param rootNode The node to adapt.
    */
   private void resolve(
     final Entry<String, JsonNode> rootNode,
     final String path,
     final Map<String, String> map ) {
     final JsonNode leafNode = rootNode.getValue();
     final String key = rootNode.getKey();
     if( leafNode.isValueNode() ) {
       final String value = rootNode.getValue().asText();
       map.put( VARIABLE_DECORATOR.decorate( path + key ), substitute( value ) );
+    }
     if( leafNode.isObject() ) {
       resolve( leafNode, path + key + SEPARATOR, map );
+    }
+  }
   /**
    * Reads the first document from the given stream of YAML data and returns a
    * corresponding object that represents the YAML hierarchy. The calling class
    * is responsible for closing the stream. Calling classes should use
    * <code>JsonNode.fields()</code> to walk through the YAML tree of fields.
+   *
    * @param in The input stream containing YAML content.
+   *
    * @return An object hierarchy to represent the content.
+   *
    * @throws IOException Could not read the stream.
    */
   public JsonNode process( final InputStream in ) throws IOException {
     final ObjectNode root = (ObjectNode)getObjectMapper().readTree( in );
     setDocumentRoot( root );
     process( root );
     return getDocumentRoot();
+  }
   /**
    * Iterate over a given root node (at any level of the tree) and process each
    * leaf node.
+   *
    * @param root A node to process.
    */
   private void process( final JsonNode root ) {
     root.fields().forEachRemaining( this::process );
+  }
   /**
    * Process the given field, which is a named node. This is where the
    * application does the up-front work of mapping references to their fully
    * recursively dereferenced values.
+   *
    * @param field The named node.
    */
   private void process( final Entry<String, JsonNode> field ) {
     final JsonNode node = field.getValue();
     if( node.isObject() ) {
       process( node );
     } else {
       final JsonNode fieldValue = field.getValue();
       // Only basic data types can be parsed into variable values. For
       // node structures, YAML has a built-in mechanism.
       if( fieldValue.isValueNode() ) {
         try {
           resolve( fieldValue.asText() );
         } catch( StackOverflowError e ) {
           throw new IllegalArgumentException(
             "Unresolvable: " + node.textValue() + " = " + fieldValue );
+        }
+      }
+    }
+  }
   /**
    * Inserts the delimited references and field values into the cache. This will
    * overwrite existing references.
+   *
    * @param fieldValue YAML field containing zero or more delimited references.
    * If it contains a delimited reference, the parameter is modified with the
    * dereferenced value before it is returned.
+   *
    * @return fieldValue without delimited references.
    */
   private String resolve( String fieldValue ) {
     final Matcher matcher = patternMatch( fieldValue );
     while( matcher.find() ) {
       final String delimited = matcher.group( GROUP_DELIMITED );
       final String reference = matcher.group( GROUP_REFERENCE );
       final String dereference = resolve( lookup( reference ) );
       fieldValue = fieldValue.replace( delimited, dereference );
       // This will perform some superfluous calls by overwriting existing
       // items in the delimited reference map.
       put( delimited, dereference );
+    }
     return fieldValue;
+  }
   /**
    * Inserts a key/value pair into the references map. The map retains
    * references and dereferenced values found in the YAML. If the reference
    * already exists, this will overwrite with a new value.
+   *
    * @param delimited The variable name.
    * @param dereferenced The resolved value.
    */
   private void put( String delimited, String dereferenced ) {
     if( dereferenced.isEmpty() ) {
       missing( delimited );
     } else {
       getReferences().put( delimited, dereferenced );
+    }
+  }
   /**
    * Writes the modified YAML document to standard output.
    */
   private void writeDocument() throws IOException {
     getObjectMapper().writeValue( System.out, getDocumentRoot() );
+  }
   /**
    * Called when a delimited reference is dereferenced to an empty string. This
    * should produce a warning for the user.
+   *
    * @param delimited Delimited reference with no derived value.
    */
   private void missing( final String delimited ) {
     throw new InvalidParameterException(
       MessageFormat.format( "Missing value for '{0}'.", delimited ) );
+  }
   /**
    * Returns a REGEX_PATTERN matcher for the given text.
+   *
    * @param text The text that contains zero or more instances of a
    * REGEX_PATTERN that can be found using the regular expression.
    */
   private Matcher patternMatch( String text ) {
     return getPattern().matcher( text );
+  }
   /**
    * Finds the YAML value for a reference.
+   *
    * @param reference References a value in the YAML document.
+   *
    * @return The dereferenced value.
    */
   private String lookup( final String reference ) {
     return getDocumentRoot().at( asPath( reference ) ).asText();
+  }
   /**
    * Converts a reference (not delimited) to a path that can be used to find a
    * value that should exist inside the YAML document.
+   *
    * @param reference The reference to convert to a YAML document path.
+   *
    * @return The reference with a leading slash and its separator characters
    * converted to slashes.
    */
   private String asPath( final String reference ) {
     return SEPARATOR_YAML + reference.replace( getDelimitedSeparator(), SEPARATOR_YAML );
+  }
   /**
    * Sets the parent node for the entire YAML document tree.
+   *
    * @param documentRoot The parent node.
    */
   private void setDocumentRoot( ObjectNode documentRoot ) {
     this.documentRoot = documentRoot;
+  }
   /**
    * Returns the parent node for the entire YAML document tree.
+   *
    * @return The parent node.
    */
   private ObjectNode getDocumentRoot() {
     return this.documentRoot;
+  }
   /**
    * Returns the compiled regular expression REGEX_PATTERN used to match
    * delimited references.
+   *
    * @return A compiled regex for use with the Matcher.
    */
   private Pattern getPattern() {
     return REGEX_PATTERN;
+  }
   /**
    * Returns the list of references mapped to dereferenced values.
+   *
    * @return
    */
   private Map<String, String> getReferences() {
     if( this.references == null ) {
       this.references = createReferences();
+    }
     return this.references;
+  }
   /**
    * Subclasses can override this method to insert their own map.
+   *
    * @return An empty HashMap, never null.
    */
   protected Map<String, String> createReferences() {
     return new HashMap<>();
+  }
   private class ResolverYAMLFactory extends YAMLFactory {
 public class YamlParser  {
   /**
    * Separates YAML variable nodes (e.g., the dots in
    * <code>$root.node.var$</code>).
    */
   public static final String SEPARATOR = ".";
   public static final char SEPARATOR_CHAR = SEPARATOR.charAt( 0 );
   private final static int GROUP_DELIMITED = 1;
   private final static int GROUP_REFERENCE = 2;
   private final static VariableDecorator VARIABLE_DECORATOR
     = new YamlVariableDecorator();
   /**
    * Compiled version of DEFAULT_REGEX.
    */
   private final static Pattern REGEX_PATTERN
     = Pattern.compile( YamlVariableDecorator.REGEX );
   /**
    * Should be JsonPointer.SEPARATOR, but Jackson YAML uses magic values.
    */
   private final static char SEPARATOR_YAML = '/';
   /**
    * Start of the Universe (the YAML document node that contains all others).
    */
   private ObjectNode documentRoot;
   /**
    * Map of references to dereferenced field values.
    */
   private Map<String, String> references;
   public YamlParser() {
+  }
   /**
    * Returns the given string with all the delimited references swapped with
    * their recursively resolved values.
+   *
    * @param text The text to parse with zero or more delimited references to
    * replace.
+   *
    * @return The substituted value.
    */
   public String substitute( String text ) {
     final Matcher matcher = patternMatch( text );
     final Map<String, String> map = getReferences();
     while( matcher.find() ) {
       final String key = matcher.group( GROUP_DELIMITED );
       final String value = map.get( key );
       if( value == null ) {
         missing( text );
       } else {
         text = text.replace( key, value );
+      }
+    }
     return text;
+  }
   /**
    * Returns all the strings with their values resolved in a flat hierarchy.
    * This copies all the keys and resolved values into a new map.
+   *
    * @return The new map created with all values having been resolved,
    * recursively.
    */
   public Map<String, String> createResolvedMap() {
     final Map<String, String> map = new HashMap<>( 1024 );
     resolve( getDocumentRoot(), "", map );
     return map;
+  }
   /**
    * Iterate over a given root node (at any level of the tree) and adapt each
    * leaf node.
+   *
    * @param rootNode A JSON node (YAML node) to adapt.
    */
   private void resolve(
     final JsonNode rootNode, final String path, final Map<String, String> map ) {
     if( rootNode != null ) {
       rootNode.fields().forEachRemaining(
         (Entry<String, JsonNode> leaf) -> resolve( leaf, path, map )
       );
+    }
+  }
   /**
    * Recursively adapt each rootNode to a corresponding rootItem.
+   *
    * @param rootNode The node to adapt.
    */
   private void resolve(
     final Entry<String, JsonNode> rootNode,
     final String path,
     final Map<String, String> map ) {
     final JsonNode leafNode = rootNode.getValue();
     final String key = rootNode.getKey();
     if( leafNode.isValueNode() ) {
       final String value = rootNode.getValue().asText();
       map.put( VARIABLE_DECORATOR.decorate( path + key ), substitute( value ) );
+    }
     if( leafNode.isObject() ) {
       resolve( leafNode, path + key + SEPARATOR, map );
+    }
+  }
   /**
    * Reads the first document from the given stream of YAML data and returns a
    * corresponding object that represents the YAML hierarchy. The calling class
    * is responsible for closing the stream. Calling classes should use
    * <code>JsonNode.fields()</code> to walk through the YAML tree of fields.
+   *
    * @param in The input stream containing YAML content.
+   *
    * @return An object hierarchy to represent the content.
+   *
    * @throws IOException Could not read the stream.
    */
   public JsonNode process( final InputStream in ) throws IOException {
     final ObjectNode root = (ObjectNode)getObjectMapper().readTree( in );
     setDocumentRoot( root );
     process( root );
     return getDocumentRoot();
+  }
   /**
    * Iterate over a given root node (at any level of the tree) and process each
    * leaf node.
+   *
    * @param root A node to process.
    */
   private void process( final JsonNode root ) {
     root.fields().forEachRemaining( this::process );
+  }
   /**
    * Process the given field, which is a named node. This is where the
    * application does the up-front work of mapping references to their fully
    * recursively dereferenced values.
+   *
    * @param field The named node.
    */
   private void process( final Entry<String, JsonNode> field ) {
     final JsonNode node = field.getValue();
     if( node.isObject() ) {
       process( node );
     } else {
       final JsonNode fieldValue = field.getValue();
       // Only basic data types can be parsed into variable values. For
       // node structures, YAML has a built-in mechanism.
       if( fieldValue.isValueNode() ) {
         try {
           resolve( fieldValue.asText() );
         } catch( StackOverflowError e ) {
           throw new IllegalArgumentException(
             "Unresolvable: " + node.textValue() + " = " + fieldValue );
+        }
+      }
+    }
+  }
   /**
    * Inserts the delimited references and field values into the cache. This will
    * overwrite existing references.
+   *
    * @param fieldValue YAML field containing zero or more delimited references.
    * If it contains a delimited reference, the parameter is modified with the
    * dereferenced value before it is returned.
+   *
    * @return fieldValue without delimited references.
    */
   private String resolve( String fieldValue ) {
     final Matcher matcher = patternMatch( fieldValue );
     while( matcher.find() ) {
       final String delimited = matcher.group( GROUP_DELIMITED );
       final String reference = matcher.group( GROUP_REFERENCE );
       final String dereference = resolve( lookup( reference ) );
       fieldValue = fieldValue.replace( delimited, dereference );
       // This will perform some superfluous calls by overwriting existing
       // items in the delimited reference map.
       put( delimited, dereference );
+    }
     return fieldValue;
+  }
   /**
    * Inserts a key/value pair into the references map. The map retains
    * references and dereferenced values found in the YAML. If the reference
    * already exists, this will overwrite with a new value.
+   *
    * @param delimited The variable name.
    * @param dereferenced The resolved value.
    */
   private void put( String delimited, String dereferenced ) {
     if( dereferenced.isEmpty() ) {
       missing( delimited );
     } else {
       getReferences().put( delimited, dereferenced );
+    }
+  }
   /**
    * Writes the modified YAML document to standard output.
    */
   private void writeDocument() throws IOException {
     getObjectMapper().writeValue( System.out, getDocumentRoot() );
+  }
   /**
    * Called when a delimited reference is dereferenced to an empty string. This
    * should produce a warning for the user.
+   *
    * @param delimited Delimited reference with no derived value.
    */
   private void missing( final String delimited ) {
     throw new InvalidParameterException(
       MessageFormat.format( "Missing value for '{0}'.", delimited ) );
+  }
   /**
    * Returns a REGEX_PATTERN matcher for the given text.
+   *
    * @param text The text that contains zero or more instances of a
    * REGEX_PATTERN that can be found using the regular expression.
    */
   private Matcher patternMatch( String text ) {
     return getPattern().matcher( text );
+  }
   /**
    * Finds the YAML value for a reference.
+   *
    * @param reference References a value in the YAML document.
+   *
    * @return The dereferenced value.
    */
   private String lookup( final String reference ) {
     return getDocumentRoot().at( asPath( reference ) ).asText();
+  }
   /**
    * Converts a reference (not delimited) to a path that can be used to find a
    * value that should exist inside the YAML document.
+   *
    * @param reference The reference to convert to a YAML document path.
+   *
    * @return The reference with a leading slash and its separator characters
    * converted to slashes.
    */
   private String asPath( final String reference ) {
     return SEPARATOR_YAML + reference.replace( getDelimitedSeparator(), SEPARATOR_YAML );
+  }
   /**
    * Sets the parent node for the entire YAML document tree.
+   *
    * @param documentRoot The parent node.
    */
   private void setDocumentRoot( ObjectNode documentRoot ) {
     this.documentRoot = documentRoot;
+  }
   /**
    * Returns the parent node for the entire YAML document tree.
+   *
    * @return The parent node.
    */
   private ObjectNode getDocumentRoot() {
     return this.documentRoot;
+  }
   /**
    * Returns the compiled regular expression REGEX_PATTERN used to match
    * delimited references.
+   *
    * @return A compiled regex for use with the Matcher.
    */
   private Pattern getPattern() {
     return REGEX_PATTERN;
+  }
   /**
    * Returns the list of references mapped to dereferenced values.
+   *
    * @return
    */
   private Map<String, String> getReferences() {
     if( this.references == null ) {
       this.references = createReferences();
+    }
     return this.references;
+  }
   /**
    * Subclasses can override this method to insert their own map.
+   *
    * @return An empty HashMap, never null.
    */
   protected Map<String, String> createReferences() {
     return new HashMap<>();
+  }
   private final class ResolverYAMLFactory extends YAMLFactory {
     private static final long serialVersionUID = 1L;
     @Override

M src/main/java/com/scrivenvar/editors/VariableNameInjector.java

 import com.scrivenvar.definition.VariableTreeItem;
 import static com.scrivenvar.definition.yaml.YamlParser.SEPARATOR;
 import com.scrivenvar.service.Settings;
 import static com.scrivenvar.util.Lists.getFirst;
 import static com.scrivenvar.util.Lists.getLast;
 import static java.lang.Character.isSpaceChar;
 import static java.lang.Character.isWhitespace;
 import static java.lang.Math.min;
 import java.util.function.Consumer;
 import javafx.collections.ObservableList;
 import javafx.event.Event;
 import javafx.scene.control.IndexRange;
 import javafx.scene.control.TreeItem;
 import javafx.scene.input.InputEvent;
 import javafx.scene.input.KeyCode;
 import static javafx.scene.input.KeyCode.AT;
 import static javafx.scene.input.KeyCode.DIGIT2;
 import static javafx.scene.input.KeyCode.ENTER;
 import static javafx.scene.input.KeyCode.MINUS;
 import static javafx.scene.input.KeyCode.SPACE;
 import static javafx.scene.input.KeyCombination.CONTROL_DOWN;
 import static javafx.scene.input.KeyCombination.SHIFT_DOWN;
 import javafx.scene.input.KeyEvent;
 import org.fxmisc.richtext.StyledTextArea;
 import org.fxmisc.wellbehaved.event.EventPattern;
 import static org.fxmisc.wellbehaved.event.EventPattern.keyPressed;
 import static org.fxmisc.wellbehaved.event.EventPattern.keyTyped;
 import org.fxmisc.wellbehaved.event.InputMap;
 import static org.fxmisc.wellbehaved.event.InputMap.consume;
 import static org.fxmisc.wellbehaved.event.InputMap.sequence;
 /**
  * Provides the logic for injecting variable names within the editor.
+ *
  * @author White Magic Software, Ltd.
  */
 public class VariableNameInjector {
   public static final int DEFAULT_MAX_VAR_LENGTH = 64;
   private static final int NO_DIFFERENCE = -1;
   private final Settings settings = Services.load( Settings.class );
   /**
    * Used to capture keyboard events once the user presses @.
    */
   private InputMap<InputEvent> keyboardMap;
   private FileEditorTab tab;
   private DefinitionPane definitionPane;
   /**
    * Position of the variable in the text when in variable mode (0 by default).
    */
   private int initialCaretPosition;
   public VariableNameInjector(
     final FileEditorTab tab,
     final DefinitionPane definitionPane ) {
     setFileEditorTab( tab );
     setDefinitionPane( definitionPane );
     initKeyboardEventListeners();
+  }
   /**
    * Traps keys for performing various short-cut tasks, such as @-mode variable
    * insertion and control+space for variable autocomplete.
+   *
    * @ key is pressed, a new keyboard map is inserted in place of the current
    * map -- this class goes into "variable edit mode" (a.k.a. vMode).
+   *
    * @see createKeyboardMap()
    */
   private void initKeyboardEventListeners() {
     addEventListener( keyPressed( SPACE, CONTROL_DOWN ), this::autocomplete );
     // @ key in Linux?
     addEventListener( keyPressed( DIGIT2, SHIFT_DOWN ), this::vMode );
     // @ key in Windows.
     addEventListener( keyPressed( AT ), this::vMode );
+  }
   /**
    * The @ symbol is a short-cut to inserting a YAML variable reference.
+   *
    * @param e Superfluous information about the key that was pressed.
    */
   private void vMode( KeyEvent e ) {
     setInitialCaretPosition();
     vModeStart();
     vModeAutocomplete();
+  }
   /**
    * Receives key presses until the user completes the variable selection. This
    * allows the arrow keys to be used for selecting variables.
+   *
    * @param e The key that was pressed.
    */
   private void vModeKeyPressed( KeyEvent e ) {
     final KeyCode keyCode = e.getCode();
     switch( keyCode ) {
       case BACK_SPACE:
         // Don't decorate the variable upon exiting vMode.
         vModeBackspace();
         break;
       case ESCAPE:
         // Don't decorate the variable upon exiting vMode.
         vModeStop();
         break;
       case ENTER:
       case PERIOD:
       case RIGHT:
       case END:
         // Stop at a leaf node, ENTER means accept.
         if( vModeConditionalComplete() && keyCode == ENTER ) {
           vModeStop();
           // Decorate the variable upon exiting vMode.
           decorateVariable();
+        }
         break;
       case UP:
         cyclePathPrev();
         break;
       case DOWN:
         cyclePathNext();
         break;
       default:
         vModeFilterKeyPressed( e );
         break;
+    }
     e.consume();
+  }
   private void vModeBackspace() {
     deleteSelection();
     // Break out of variable mode by back spacing to the original position.
     if( getCurrentCaretPosition() > getInitialCaretPosition() ) {
       vModeAutocomplete();
     } else {
       vModeStop();
+    }
+  }
   /**
    * Updates the text with the path selected (or typed) by the user.
    */
   private void vModeAutocomplete() {
     final TreeItem<String> node = getCurrentNode();
     if( !node.isLeaf() ) {
       final String word = getLastPathWord();
       final String label = node.getValue();
       final int delta = difference( label, word );
       final String remainder = delta == NO_DIFFERENCE
         ? label
         : label.substring( delta );
       final StyledTextArea textArea = getEditor();
       final int posBegan = getCurrentCaretPosition();
       final int posEnded = posBegan + remainder.length();
       textArea.replaceSelection( remainder );
       if( posEnded - posBegan > 0 ) {
         textArea.selectRange( posEnded, posBegan );
+      }
       expand( node );
+    }
+  }
   /**
    * Only variable name keys can pass through the filter. This is called when
    * the user presses a key.
+   *
    * @param e The key that was pressed.
    */
   private void vModeFilterKeyPressed( final KeyEvent e ) {
     if( isVariableNameKey( e ) ) {
       typed( e.getText() );
+    }
+  }
   /**
    * Performs an autocomplete depending on whether the user has finished typing
    * in a word. If there is a selected range, then this will complete the most
    * recent word and jump to the next child.
+   *
    * @return true The auto-completed node was a terminal node.
    */
   private boolean vModeConditionalComplete() {
     acceptPath();
     final TreeItem<String> node = getCurrentNode();
     final boolean terminal = isTerminal( node );
     if( !terminal ) {
       typed( SEPARATOR );
+    }
     return terminal;
+  }
   /**
    * Pressing control+space will find a node that matches the current word and
    * substitute the YAML variable reference. This is called when the user is not
    * editing in vMode.
+   *
    * @param e Ignored -- it can only be Ctrl+Space.
    */
   private void autocomplete( final KeyEvent e ) {
     final String paragraph = getCaretParagraph();
     final int[] boundaries = getWordBoundaries( paragraph );
     final String word = paragraph.substring( boundaries[ 0 ], boundaries[ 1 ] );
     final VariableTreeItem<String> leaf = findLeaf( word );
     if( leaf != null ) {
       replaceText( boundaries[ 0 ], boundaries[ 1 ], leaf.toPath() );
       decorateVariable();
       expand( leaf );
+    }
+  }
   /**
    * Called when autocomplete finishes on a valid leaf or when the user presses
    * Enter to finish manual autocomplete.
    */
   private void decorateVariable() {
     // A little bit of duplication...
     final String paragraph = getCaretParagraph();
     final int[] boundaries = getWordBoundaries( paragraph );
     final String old = paragraph.substring( boundaries[ 0 ], boundaries[ 1 ] );
     final String newVariable = getVariableDecorator().decorate( old );
     final int posEnded = getCurrentCaretPosition();
     final int posBegan = posEnded - old.length();
     getEditor().replaceText( posBegan, posEnded, newVariable );
+  }
   /**
    * Updates the text at the given position within the current paragraph.
+   *
    * @param posBegan The starting index in the paragraph text to replace.
    * @param posEnded The ending index in the paragraph text to replace.
    * @param text Overwrite the paragraph substring with this text.
    */
   private void replaceText(
     final int posBegan, final int posEnded, final String text ) {
     final int p = getCurrentParagraph();
     getEditor().replaceText( p, posBegan, p, posEnded, text );
+  }
   /**
    * Returns the caret's current paragraph position.
+   *
    * @return A number greater than or equal to 0.
    */
   private int getCurrentParagraph() {
     return getEditor().getCurrentParagraph();
+  }
   /**
    * Returns current word boundary indexes into the current paragraph, including
    * punctuation.
+   *
    * @param p The paragraph wherein to hunt word boundaries.
    * @param offset The offset into the paragraph to begin scanning left and
    * right.
+   *
    * @return The starting and ending index of the word closest to the caret.
    */
   private int[] getWordBoundaries( final String p, final int offset ) {
     // Remove dashes, but retain hyphens. Retain same number of characters
     // to preserve relative indexes.
     final String paragraph = p.replace( "---", "   " ).replace( "--", "  " );
     return getWordAt( paragraph, offset );
+  }
   /**
    * Helper method to get the word boundaries for the current paragraph.
+   *
    * @param paragraph
+   *
    * @return
    */
   private int[] getWordBoundaries( final String paragraph ) {
     return getWordBoundaries( paragraph, getCurrentCaretColumn() );
+  }
   /**
    * Given an arbitrary offset into a string, this returns the word at that
    * index. The inputs and outputs include:
+   *
    * <ul>
    * <li>surrounded by space: <code>hello | world!</code> ("");</li>
    * <li>end of word: <code>hello| world!</code> ("hello");</li>
    * <li>start of a word: <code>hello |world!</code> ("world!");</li>
    * <li>within a word: <code>hello wo|rld!</code> ("world!");</li>
    * <li>end of a paragraph: <code>hello world!|</code> ("world!");</li>
    * <li>start of a paragraph: <code>|hello world!</code> ("hello!"); or</li>
    * <li>after punctuation: <code>hello world!|</code> ("world!").</li>
    * </ul>
+   *
    * @param p The string to scan for a word.
    * @param offset The offset within s to begin searching for the nearest word
    * boundary, must not be out of bounds of s.
+   *
    * @return The word in s at the offset.
+   *
    * @see getWordBegan( String, int )
    * @see getWordEnded( String, int )
    */
   private int[] getWordAt( final String p, final int offset ) {
     return new int[]{ getWordBegan( p, offset ), getWordEnded( p, offset ) };
+  }
   /**
    * Returns the index into s where a word begins.
+   *
    * @param s Never null.
    * @param offset Index into s to begin searching backwards for a word
    * boundary.
+   *
    * @return The index where a word begins.
    */
   private int getWordBegan( final String s, int offset ) {
     while( offset > 0 && isBoundary( s.charAt( offset - 1 ) ) ) {
       offset--;
+    }
     return offset;
+  }
   /**
    * Returns the index into s where a word ends.
+   *
    * @param s Never null.
    * @param offset Index into s to begin searching forwards for a word boundary.
+   *
    * @return The index where a word ends.
    */
   private int getWordEnded( final String s, int offset ) {
     final int length = s.length();
     while( offset < length && isBoundary( s.charAt( offset ) ) ) {
       offset++;
+    }
     return offset;
+  }
   /**
    * Returns true if the given character can be reasonably expected to be part
    * of a word, including punctuation marks.
+   *
    * @param c The character to compare.
+   *
    * @return false The character is a space character.
    */
   private boolean isBoundary( final char c ) {
     return !isSpaceChar( c );
+  }
   /**
    * Returns the text for the paragraph that contains the caret.
+   *
    * @return A non-null string, possibly empty.
    */
   private String getCaretParagraph() {
     return getEditor().getText( getCurrentParagraph() );
+  }
   /**
    * Returns true if the node has children that can be selected (i.e., any
    * non-leaves).
+   *
    * @param <T> The type that the TreeItem contains.
    * @param node The node to test for terminality.
+   *
    * @return true The node has one branch and its a leaf.
    */
   private <T> boolean isTerminal( final TreeItem<T> node ) {
     final ObservableList<TreeItem<T>> branches = node.getChildren();
     return branches.size() == 1 && branches.get( 0 ).isLeaf();
+  }
   /**
    * Inserts text that the user typed at the current caret position, then
    * performs an autocomplete for the variable name.
+   *
    * @param text The text to insert, never null.
    */
   private void typed( final String text ) {
     getEditor().replaceSelection( text );
     vModeAutocomplete();
+  }
   /**
    * Called when the user presses either End or Enter key.
    */
   private void acceptPath() {
     final IndexRange range = getSelectionRange();
     if( range != null ) {
       final int rangeEnd = range.getEnd();
       final StyledTextArea textArea = getEditor();
       textArea.deselect();
       textArea.moveTo( rangeEnd );
+    }
+  }
   /**
    * Replaces the entirety of the existing path (from the initial caret
    * position) with the given path.
+   *
    * @param oldPath The path to replace.
    * @param newPath The replacement path.
    */
   private void replacePath( final String oldPath, final String newPath ) {
     final StyledTextArea textArea = getEditor();
     final int posBegan = getInitialCaretPosition();
     final int posEnded = posBegan + oldPath.length();
     textArea.deselect();
     textArea.replaceText( posBegan, posEnded, newPath );
+  }
   /**
    * Called when the user presses the Backspace key.
    */
   private void deleteSelection() {
     final StyledTextArea textArea = getEditor();
     textArea.replaceSelection( "" );
     textArea.deletePreviousChar();
+  }
   /**
    * Cycles the selected text through the nodes.
+   *
    * @param direction true - next; false - previous
    */
   private void cycleSelection( final boolean direction ) {
     final TreeItem<String> node = getCurrentNode();
     // Find the sibling for the current selection and replace the current
     // selection with the sibling's value
     TreeItem< String> cycled = direction
       ? node.nextSibling()
       : node.previousSibling();
     // When cycling at the end (or beginning) of the list, jump to the first
     // (or last) sibling depending on the cycle direction.
     if( cycled == null ) {
       cycled = direction ? getFirstSibling( node ) : getLastSibling( node );
+    }
     final String path = getCurrentPath();
     final String cycledWord = cycled.getValue();
     final String word = getLastPathWord();
     final int index = path.indexOf( word );
     final String cycledPath = path.substring( 0, index ) + cycledWord;
     expand( cycled );
     replacePath( path, cycledPath );
+  }
   /**
    * Cycles to the next sibling of the currently selected tree node.
    */
   private void cyclePathNext() {
     cycleSelection( true );
+  }
   /**
    * Cycles to the previous sibling of the currently selected tree node.
    */
   private void cyclePathPrev() {
     cycleSelection( false );
+  }
   /**
    * Returns the variable name (or as much as has been typed so far). Returns
    * all the characters from the initial caret column to the the first
    * whitespace character. This will return a path that contains zero or more
    * separators.
+   *
    * @return A non-null string, possibly empty.
    */
   private String getCurrentPath() {
     final String s = extractTextChunk();
     final int length = s.length();
     int i = 0;
     while( i < length && !isWhitespace( s.charAt( i ) ) ) {
       i++;
+    }
     return s.substring( 0, i );
+  }
   private <T> ObservableList<TreeItem<T>> getSiblings(
     final TreeItem<T> item ) {
     final TreeItem<T> parent = item.getParent();
     return parent == null ? item.getChildren() : parent.getChildren();
+  }
   private <T> TreeItem<T> getFirstSibling( final TreeItem<T> item ) {
     return getFirst( getSiblings( item ), item );
+  }
   private <T> TreeItem<T> getLastSibling( final TreeItem<T> item ) {
     return getLast( getSiblings( item ), item );
+  }
   /**
    * Returns the caret position as an offset into the text.
+   *
    * @return A value from 0 to the length of the text (minus one).
    */
   private int getCurrentCaretPosition() {
     return getEditor().getCaretPosition();
+  }
   /**
    * Returns the caret position within the current paragraph.
+   *
    * @return A value from 0 to the length of the current paragraph.
    */
   private int getCurrentCaretColumn() {
     return getEditor().getCaretColumn();
+  }
   /**
    * Returns the last word from the path.
+   *
    * @return The last token.
    */
   private String getLastPathWord() {
     String path = getCurrentPath();
     int i = path.indexOf( SEPARATOR );
     while( i > 0 ) {
       path = path.substring( i + 1 );
       i = path.indexOf( SEPARATOR );
+    }
     return path;
+  }
   /**
    * Returns text from the initial caret position until some arbitrarily long
    * number of characters. The number of characters extracted will be
    * getMaxVarLength, or fewer, depending on how many characters remain to be
    * extracted. The result from this method is trimmed to the first whitespace
    * character.
+   *
    * @return A chunk of text that includes all the words representing a path,
    * and then some.
    */
   private String extractTextChunk() {
     final StyledTextArea textArea = getEditor();
     final int textBegan = getInitialCaretPosition();
     final int remaining = textArea.getLength() - textBegan;
     final int textEnded = min( remaining, getMaxVarLength() );
     return textArea.getText( textBegan, textEnded );
+  }
   /**
    * Returns the node for the current path.
    */
   private TreeItem<String> getCurrentNode() {
     return findNode( getCurrentPath() );
+  }
   /**
    * Finds the node that most closely matches the given path.
+   *
    * @param path The path that represents a node.
+   *
    * @return The node for the path, or the root node if the path could not be
    * found, but never null.
    */
   private TreeItem<String> findNode( final String path ) {
     return getDefinitionPane().findNode( path );
+  }
   /**
    * Finds the first leaf having a value that starts with the given text.
+   *
    * @param text The text to find in the definition tree.
+   *
    * @return The leaf that starts with the given text, or null if not found.
    */
   private VariableTreeItem<String> findLeaf( final String text ) {
     return getDefinitionPane().findLeaf( text );
+  }
   /**
    * Used to ignore typed keys in favour of trapping pressed keys.
+   *
    * @param e The key that was typed.
    */
   private void vModeKeyTyped( KeyEvent e ) {
     e.consume();
+  }
   /**
    * Used to lazily initialize the keyboard map.
+   *
    * @return Mappings for keyTyped and keyPressed.
    */
   protected InputMap<InputEvent> createKeyboardMap() {
     return sequence(
       consume( keyTyped(), this::vModeKeyTyped ),
       consume( keyPressed(), this::vModeKeyPressed )
     );
+  }
   private InputMap<InputEvent> getKeyboardMap() {
     if( this.keyboardMap == null ) {
       this.keyboardMap = createKeyboardMap();
+    }
     return this.keyboardMap;
+  }
   /**
    * Collapses the tree then expands and selects the given node.
+   *
    * @param node The node to expand.
    */
   private void expand( final TreeItem<String> node ) {
     final DefinitionPane pane = getDefinitionPane();
     pane.collapse();
     pane.expand( node );
     pane.select( node );
+  }
   /**
    * Returns true iff the key code the user typed can be used as part of a YAML
    * variable name.
+   *
    * @param keyEvent Keyboard key press event information.
+   *
    * @return true The key is a value that can be inserted into the text.
    */
   private boolean isVariableNameKey( final KeyEvent keyEvent ) {
     final KeyCode kc = keyEvent.getCode();
     return (kc.isLetterKey()
       || kc.isDigitKey()
       || (keyEvent.isShiftDown() && kc == MINUS))
       && !keyEvent.isControlDown();
+  }
   /**
    * Starts to capture user input events.
    */
   private void vModeStart() {
     addEventListener( getKeyboardMap() );
+  }
   /**
    * Restores capturing of user input events to the previous event listener.
    * Also asks the processing chain to modify the variable text into a
    * machine-readable variable based on the format required by the file type.
    * For example, a Markdown file (.md) will substitute a $VAR$ name while an R
    * file (.Rmd, .Rxml) will use `r#xVAR`.
    */
   private void vModeStop() {
     removeEventListener( getKeyboardMap() );
+  }
   private VariableDecorator getVariableDecorator() {
     return new YamlVariableDecorator();
+  }
   /**
    * Returns the index where the two strings diverge.
+   *
    * @param s1 The string that could be a substring of s2, null allowed.
    * @param s2 The string that could be a substring of s1, null allowed.
+   *
    * @return NO_DIFFERENCE if the strings are the same, otherwise the index
    * where they differ.
    */
   @SuppressWarnings( "StringEquality" )
   private int difference( final CharSequence s1, final CharSequence s2 ) {
     if( s1 == s2 ) {
       return NO_DIFFERENCE;
+    }
     if( s1 == null || s2 == null ) {
       return 0;
+    }
     int i = 0;
     final int limit = min( s1.length(), s2.length() );
     while( i < limit && s1.charAt( i ) == s2.charAt( i ) ) {
       i++;
+    }
     // If one string was shorter than the other, that's where they differ.
     return i;
+  }
 import static com.scrivenvar.definition.yaml.YamlParser.SEPARATOR_CHAR;
 import com.scrivenvar.service.Settings;
 import static com.scrivenvar.util.Lists.getFirst;
 import static com.scrivenvar.util.Lists.getLast;
 import static java.lang.Character.isSpaceChar;
 import static java.lang.Character.isWhitespace;
 import static java.lang.Math.min;
 import java.util.function.Consumer;
 import javafx.collections.ObservableList;
 import javafx.event.Event;
 import javafx.scene.control.IndexRange;
 import javafx.scene.control.TreeItem;
 import javafx.scene.input.InputEvent;
 import javafx.scene.input.KeyCode;
 import static javafx.scene.input.KeyCode.AT;
 import static javafx.scene.input.KeyCode.DIGIT2;
 import static javafx.scene.input.KeyCode.ENTER;
 import static javafx.scene.input.KeyCode.MINUS;
 import static javafx.scene.input.KeyCode.SPACE;
 import static javafx.scene.input.KeyCombination.CONTROL_DOWN;
 import static javafx.scene.input.KeyCombination.SHIFT_DOWN;
 import javafx.scene.input.KeyEvent;
 import org.fxmisc.richtext.StyledTextArea;
 import org.fxmisc.wellbehaved.event.EventPattern;
 import static org.fxmisc.wellbehaved.event.EventPattern.keyPressed;
 import static org.fxmisc.wellbehaved.event.EventPattern.keyTyped;
 import org.fxmisc.wellbehaved.event.InputMap;
 import static org.fxmisc.wellbehaved.event.InputMap.consume;
 import static org.fxmisc.wellbehaved.event.InputMap.sequence;
 /**
  * Provides the logic for injecting variable names within the editor.
+ *
  * @author White Magic Software, Ltd.
  */
 public class VariableNameInjector {
   public static final int DEFAULT_MAX_VAR_LENGTH = 64;
   private static final int NO_DIFFERENCE = -1;
   private final Settings settings = Services.load( Settings.class );
   /**
    * Used to capture keyboard events once the user presses @.
    */
   private InputMap<InputEvent> keyboardMap;
   private FileEditorTab tab;
   private DefinitionPane definitionPane;
   /**
    * Position of the variable in the text when in variable mode (0 by default).
    */
   private int initialCaretPosition;
   private VariableNameInjector() {
+  }
   public static void listen( final FileEditorTab tab, final DefinitionPane pane ) {
     VariableNameInjector vni = new VariableNameInjector();
     vni.setFileEditorTab( tab );
     vni.setDefinitionPane( pane );
     vni.initKeyboardEventListeners();
+  }
   /**
    * Traps keys for performing various short-cut tasks, such as @-mode variable
    * insertion and control+space for variable autocomplete.
+   *
    * @ key is pressed, a new keyboard map is inserted in place of the current
    * map -- this class goes into "variable edit mode" (a.k.a. vMode).
+   *
    * @see createKeyboardMap()
    */
   private void initKeyboardEventListeners() {
     addEventListener( keyPressed( SPACE, CONTROL_DOWN ), this::autocomplete );
     // @ key in Linux?
     addEventListener( keyPressed( DIGIT2, SHIFT_DOWN ), this::vMode );
     // @ key in Windows.
     addEventListener( keyPressed( AT ), this::vMode );
+  }
   /**
    * The @ symbol is a short-cut to inserting a YAML variable reference.
+   *
    * @param e Superfluous information about the key that was pressed.
    */
   private void vMode( KeyEvent e ) {
     setInitialCaretPosition();
     vModeStart();
     vModeAutocomplete();
+  }
   /**
    * Receives key presses until the user completes the variable selection. This
    * allows the arrow keys to be used for selecting variables.
+   *
    * @param e The key that was pressed.
    */
   private void vModeKeyPressed( KeyEvent e ) {
     final KeyCode keyCode = e.getCode();
     switch( keyCode ) {
       case BACK_SPACE:
         // Don't decorate the variable upon exiting vMode.
         vModeBackspace();
         break;
       case ESCAPE:
         // Don't decorate the variable upon exiting vMode.
         vModeStop();
         break;
       case ENTER:
       case PERIOD:
       case RIGHT:
       case END:
         // Stop at a leaf node, ENTER means accept.
         if( vModeConditionalComplete() && keyCode == ENTER ) {
           vModeStop();
           // Decorate the variable upon exiting vMode.
           decorateVariable();
+        }
         break;
       case UP:
         cyclePathPrev();
         break;
       case DOWN:
         cyclePathNext();
         break;
       default:
         vModeFilterKeyPressed( e );
         break;
+    }
     e.consume();
+  }
   private void vModeBackspace() {
     deleteSelection();
     // Break out of variable mode by back spacing to the original position.
     if( getCurrentCaretPosition() > getInitialCaretPosition() ) {
       vModeAutocomplete();
     } else {
       vModeStop();
+    }
+  }
   /**
    * Updates the text with the path selected (or typed) by the user.
    */
   private void vModeAutocomplete() {
     final TreeItem<String> node = getCurrentNode();
     if( !node.isLeaf() ) {
       final String word = getLastPathWord();
       final String label = node.getValue();
       final int delta = difference( label, word );
       final String remainder = delta == NO_DIFFERENCE
         ? label
         : label.substring( delta );
       final StyledTextArea textArea = getEditor();
       final int posBegan = getCurrentCaretPosition();
       final int posEnded = posBegan + remainder.length();
       textArea.replaceSelection( remainder );
       if( posEnded - posBegan > 0 ) {
         textArea.selectRange( posEnded, posBegan );
+      }
       expand( node );
+    }
+  }
   /**
    * Only variable name keys can pass through the filter. This is called when
    * the user presses a key.
+   *
    * @param e The key that was pressed.
    */
   private void vModeFilterKeyPressed( final KeyEvent e ) {
     if( isVariableNameKey( e ) ) {
       typed( e.getText() );
+    }
+  }
   /**
    * Performs an autocomplete depending on whether the user has finished typing
    * in a word. If there is a selected range, then this will complete the most
    * recent word and jump to the next child.
+   *
    * @return true The auto-completed node was a terminal node.
    */
   private boolean vModeConditionalComplete() {
     acceptPath();
     final TreeItem<String> node = getCurrentNode();
     final boolean terminal = isTerminal( node );
     if( !terminal ) {
       typed( SEPARATOR );
+    }
     return terminal;
+  }
   /**
    * Pressing control+space will find a node that matches the current word and
    * substitute the YAML variable reference. This is called when the user is not
    * editing in vMode.
+   *
    * @param e Ignored -- it can only be Ctrl+Space.
    */
   private void autocomplete( final KeyEvent e ) {
     final String paragraph = getCaretParagraph();
     final int[] boundaries = getWordBoundaries( paragraph );
     final String word = paragraph.substring( boundaries[ 0 ], boundaries[ 1 ] );
     final VariableTreeItem<String> leaf = findLeaf( word );
     if( leaf != null ) {
       replaceText( boundaries[ 0 ], boundaries[ 1 ], leaf.toPath() );
       decorateVariable();
       expand( leaf );
+    }
+  }
   /**
    * Called when autocomplete finishes on a valid leaf or when the user presses
    * Enter to finish manual autocomplete.
    */
   private void decorateVariable() {
     // A little bit of duplication...
     final String paragraph = getCaretParagraph();
     final int[] boundaries = getWordBoundaries( paragraph );
     final String old = paragraph.substring( boundaries[ 0 ], boundaries[ 1 ] );
     final String newVariable = getVariableDecorator().decorate( old );
     final int posEnded = getCurrentCaretPosition();
     final int posBegan = posEnded - old.length();
     getEditor().replaceText( posBegan, posEnded, newVariable );
+  }
   /**
    * Updates the text at the given position within the current paragraph.
+   *
    * @param posBegan The starting index in the paragraph text to replace.
    * @param posEnded The ending index in the paragraph text to replace.
    * @param text Overwrite the paragraph substring with this text.
    */
   private void replaceText(
     final int posBegan, final int posEnded, final String text ) {
     final int p = getCurrentParagraph();
     getEditor().replaceText( p, posBegan, p, posEnded, text );
+  }
   /**
    * Returns the caret's current paragraph position.
+   *
    * @return A number greater than or equal to 0.
    */
   private int getCurrentParagraph() {
     return getEditor().getCurrentParagraph();
+  }
   /**
    * Returns current word boundary indexes into the current paragraph, including
    * punctuation.
+   *
    * @param p The paragraph wherein to hunt word boundaries.
    * @param offset The offset into the paragraph to begin scanning left and
    * right.
+   *
    * @return The starting and ending index of the word closest to the caret.
    */
   private int[] getWordBoundaries( final String p, final int offset ) {
     // Remove dashes, but retain hyphens. Retain same number of characters
     // to preserve relative indexes.
     final String paragraph = p.replace( "---", "   " ).replace( "--", "  " );
     return getWordAt( paragraph, offset );
+  }
   /**
    * Helper method to get the word boundaries for the current paragraph.
+   *
    * @param paragraph
+   *
    * @return
    */
   private int[] getWordBoundaries( final String paragraph ) {
     return getWordBoundaries( paragraph, getCurrentCaretColumn() );
+  }
   /**
    * Given an arbitrary offset into a string, this returns the word at that
    * index. The inputs and outputs include:
+   *
    * <ul>
    * <li>surrounded by space: <code>hello | world!</code> ("");</li>
    * <li>end of word: <code>hello| world!</code> ("hello");</li>
    * <li>start of a word: <code>hello |world!</code> ("world!");</li>
    * <li>within a word: <code>hello wo|rld!</code> ("world!");</li>
    * <li>end of a paragraph: <code>hello world!|</code> ("world!");</li>
    * <li>start of a paragraph: <code>|hello world!</code> ("hello!"); or</li>
    * <li>after punctuation: <code>hello world!|</code> ("world!").</li>
    * </ul>
+   *
    * @param p The string to scan for a word.
    * @param offset The offset within s to begin searching for the nearest word
    * boundary, must not be out of bounds of s.
+   *
    * @return The word in s at the offset.
+   *
    * @see getWordBegan( String, int )
    * @see getWordEnded( String, int )
    */
   private int[] getWordAt( final String p, final int offset ) {
     return new int[]{ getWordBegan( p, offset ), getWordEnded( p, offset ) };
+  }
   /**
    * Returns the index into s where a word begins.
+   *
    * @param s Never null.
    * @param offset Index into s to begin searching backwards for a word
    * boundary.
+   *
    * @return The index where a word begins.
    */
   private int getWordBegan( final String s, int offset ) {
     while( offset > 0 && isBoundary( s.charAt( offset - 1 ) ) ) {
       offset--;
+    }
     return offset;
+  }
   /**
    * Returns the index into s where a word ends.
+   *
    * @param s Never null.
    * @param offset Index into s to begin searching forwards for a word boundary.
+   *
    * @return The index where a word ends.
    */
   private int getWordEnded( final String s, int offset ) {
     final int length = s.length();
     while( offset < length && isBoundary( s.charAt( offset ) ) ) {
       offset++;
+    }
     return offset;
+  }
   /**
    * Returns true if the given character can be reasonably expected to be part
    * of a word, including punctuation marks.
+   *
    * @param c The character to compare.
+   *
    * @return false The character is a space character.
    */
   private boolean isBoundary( final char c ) {
     return !isSpaceChar( c );
+  }
   /**
    * Returns the text for the paragraph that contains the caret.
+   *
    * @return A non-null string, possibly empty.
    */
   private String getCaretParagraph() {
     return getEditor().getText( getCurrentParagraph() );
+  }
   /**
    * Returns true if the node has children that can be selected (i.e., any
    * non-leaves).
+   *
    * @param <T> The type that the TreeItem contains.
    * @param node The node to test for terminality.
+   *
    * @return true The node has one branch and its a leaf.
    */
   private <T> boolean isTerminal( final TreeItem<T> node ) {
     final ObservableList<TreeItem<T>> branches = node.getChildren();
     return branches.size() == 1 && branches.get( 0 ).isLeaf();
+  }
   /**
    * Inserts text that the user typed at the current caret position, then
    * performs an autocomplete for the variable name.
+   *
    * @param text The text to insert, never null.
    */
   private void typed( final String text ) {
     getEditor().replaceSelection( text );
     vModeAutocomplete();
+  }
   /**
    * Called when the user presses either End or Enter key.
    */
   private void acceptPath() {
     final IndexRange range = getSelectionRange();
     if( range != null ) {
       final int rangeEnd = range.getEnd();
       final StyledTextArea textArea = getEditor();
       textArea.deselect();
       textArea.moveTo( rangeEnd );
+    }
+  }
   /**
    * Replaces the entirety of the existing path (from the initial caret
    * position) with the given path.
+   *
    * @param oldPath The path to replace.
    * @param newPath The replacement path.
    */
   private void replacePath( final String oldPath, final String newPath ) {
     final StyledTextArea textArea = getEditor();
     final int posBegan = getInitialCaretPosition();
     final int posEnded = posBegan + oldPath.length();
     textArea.deselect();
     textArea.replaceText( posBegan, posEnded, newPath );
+  }
   /**
    * Called when the user presses the Backspace key.
    */
   private void deleteSelection() {
     final StyledTextArea textArea = getEditor();
     textArea.replaceSelection( "" );
     textArea.deletePreviousChar();
+  }
   /**
    * Cycles the selected text through the nodes.
+   *
    * @param direction true - next; false - previous
    */
   private void cycleSelection( final boolean direction ) {
     final TreeItem<String> node = getCurrentNode();
     // Find the sibling for the current selection and replace the current
     // selection with the sibling's value
     TreeItem< String> cycled = direction
       ? node.nextSibling()
       : node.previousSibling();
     // When cycling at the end (or beginning) of the list, jump to the first
     // (or last) sibling depending on the cycle direction.
     if( cycled == null ) {
       cycled = direction ? getFirstSibling( node ) : getLastSibling( node );
+    }
     final String path = getCurrentPath();
     final String cycledWord = cycled.getValue();
     final String word = getLastPathWord();
     final int index = path.indexOf( word );
     final String cycledPath = path.substring( 0, index ) + cycledWord;
     expand( cycled );
     replacePath( path, cycledPath );
+  }
   /**
    * Cycles to the next sibling of the currently selected tree node.
    */
   private void cyclePathNext() {
     cycleSelection( true );
+  }
   /**
    * Cycles to the previous sibling of the currently selected tree node.
    */
   private void cyclePathPrev() {
     cycleSelection( false );
+  }
   /**
    * Returns the variable name (or as much as has been typed so far). Returns
    * all the characters from the initial caret column to the the first
    * whitespace character. This will return a path that contains zero or more
    * separators.
+   *
    * @return A non-null string, possibly empty.
    */
   private String getCurrentPath() {
     final String s = extractTextChunk();
     final int length = s.length();
     int i = 0;
     while( i < length && !isWhitespace( s.charAt( i ) ) ) {
       i++;
+    }
     return s.substring( 0, i );
+  }
   private <T> ObservableList<TreeItem<T>> getSiblings(
     final TreeItem<T> item ) {
     final TreeItem<T> parent = item.getParent();
     return parent == null ? item.getChildren() : parent.getChildren();
+  }
   private <T> TreeItem<T> getFirstSibling( final TreeItem<T> item ) {
     return getFirst( getSiblings( item ), item );
+  }
   private <T> TreeItem<T> getLastSibling( final TreeItem<T> item ) {
     return getLast( getSiblings( item ), item );
+  }
   /**
    * Returns the caret position as an offset into the text.
+   *
    * @return A value from 0 to the length of the text (minus one).
    */
   private int getCurrentCaretPosition() {
     return getEditor().getCaretPosition();
+  }
   /**
    * Returns the caret position within the current paragraph.
+   *
    * @return A value from 0 to the length of the current paragraph.
    */
   private int getCurrentCaretColumn() {
     return getEditor().getCaretColumn();
+  }
   /**
    * Returns the last word from the path.
+   *
    * @return The last token.
    */
   private String getLastPathWord() {
     String path = getCurrentPath();
     int i = path.indexOf( SEPARATOR_CHAR );
     while( i > 0 ) {
       path = path.substring( i + 1 );
       i = path.indexOf( SEPARATOR_CHAR );
+    }
     return path;
+  }
   /**
    * Returns text from the initial caret position until some arbitrarily long
    * number of characters. The number of characters extracted will be
    * getMaxVarLength, or fewer, depending on how many characters remain to be
    * extracted. The result from this method is trimmed to the first whitespace
    * character.
+   *
    * @return A chunk of text that includes all the words representing a path,
    * and then some.
    */
   private String extractTextChunk() {
     final StyledTextArea textArea = getEditor();
     final int textBegan = getInitialCaretPosition();
     final int remaining = textArea.getLength() - textBegan;
     final int textEnded = min( remaining, getMaxVarLength() );
     return textArea.getText( textBegan, textEnded );
+  }
   /**
    * Returns the node for the current path.
    */
   private TreeItem<String> getCurrentNode() {
     return findNode( getCurrentPath() );
+  }
   /**
    * Finds the node that most closely matches the given path.
+   *
    * @param path The path that represents a node.
+   *
    * @return The node for the path, or the root node if the path could not be
    * found, but never null.
    */
   private TreeItem<String> findNode( final String path ) {
     return getDefinitionPane().findNode( path );
+  }
   /**
    * Finds the first leaf having a value that starts with the given text.
+   *
    * @param text The text to find in the definition tree.
+   *
    * @return The leaf that starts with the given text, or null if not found.
    */
   private VariableTreeItem<String> findLeaf( final String text ) {
     return getDefinitionPane().findLeaf( text );
+  }
   /**
    * Used to ignore typed keys in favour of trapping pressed keys.
+   *
    * @param e The key that was typed.
    */
   private void vModeKeyTyped( KeyEvent e ) {
     e.consume();
+  }
   /**
    * Used to lazily initialize the keyboard map.
+   *
    * @return Mappings for keyTyped and keyPressed.
    */
   protected InputMap<InputEvent> createKeyboardMap() {
     return sequence(
       consume( keyTyped(), this::vModeKeyTyped ),
       consume( keyPressed(), this::vModeKeyPressed )
     );
+  }
   private InputMap<InputEvent> getKeyboardMap() {
     if( this.keyboardMap == null ) {
       this.keyboardMap = createKeyboardMap();
+    }
     return this.keyboardMap;
+  }
   /**
    * Collapses the tree then expands and selects the given node.
+   *
    * @param node The node to expand.
    */
   private void expand( final TreeItem<String> node ) {
     final DefinitionPane pane = getDefinitionPane();
     pane.collapse();
     pane.expand( node );
     pane.select( node );
+  }
   /**
    * Returns true iff the key code the user typed can be used as part of a YAML
    * variable name.
+   *
    * @param keyEvent Keyboard key press event information.
+   *
    * @return true The key is a value that can be inserted into the text.
    */
   private boolean isVariableNameKey( final KeyEvent keyEvent ) {
     final KeyCode kc = keyEvent.getCode();
     return (kc.isLetterKey()
       || kc.isDigitKey()
       || (keyEvent.isShiftDown() && kc == MINUS))
       && !keyEvent.isControlDown();
+  }
   /**
    * Starts to capture user input events.
    */
   private void vModeStart() {
     addEventListener( getKeyboardMap() );
+  }
   /**
    * Restores capturing of user input events to the previous event listener.
    * Also asks the processing chain to modify the variable text into a
    * machine-readable variable based on the format required by the file type.
    * For example, a Markdown file (.md) will substitute a $VAR$ name while an R
    * file (.Rmd, .Rxml) will use `r#xVAR`.
    */
   private void vModeStop() {
     removeEventListener( getKeyboardMap() );
+  }
   private VariableDecorator getVariableDecorator() {
     return new YamlVariableDecorator();
+  }
   /**
    * Returns the index where the two strings diverge.
+   *
    * @param s1 The string that could be a substring of s2, null allowed.
    * @param s2 The string that could be a substring of s1, null allowed.
+   *
    * @return NO_DIFFERENCE if the strings are the same, otherwise the index
    * where they differ.
    */
   @SuppressWarnings( "StringEquality" )
   private int difference( final CharSequence s1, final CharSequence s2 ) {
     if( s1 == s2 ) {
       return NO_DIFFERENCE;
+    }
     if( s1 == null || s2 == null ) {
       return 0;
+    }
     int i = 0;
     final int limit = min( s1.length(), s2.length() );
     while( i < limit && s1.charAt( i ) == s2.charAt( i ) ) {
       i++;
+    }
     // If one string was shorter than the other, that's where they differ.
     return i;
+  }
   private EditorPane getEditorPane() {
     return getFileEditorTab().getEditorPane();

A src/main/java/com/scrivenvar/processors/CaretInsertionProcessor.java

 /*
  * Copyright 2016 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.scrivenvar.processors;
 import static com.scrivenvar.Constants.CARET_POSITION_MD;
 /**
  * Base class for inserting the magic CARET POSITION into the text so that, upon
  * previewing, the preview pane can scroll to the correct position (relative to
  * the caret position in the editor).
+ *
  * @author White Magic Software, Ltd.
  */
 public abstract class CaretInsertionProcessor extends AbstractProcessor<String> {
   private final int caretPosition;
   public CaretInsertionProcessor(
     final Processor<String> processor, final int position ) {
     super( processor );
     this.caretPosition = position;
+  }
   /**
    * Inserts the caret position token into the text at an offset that won't
    * interfere with parsing the text itself, regardless of text format.
+   *
    * @param text The text document to change.
    * @param i The caret position token insertion point to use, or -1 to
    * return the text without any injection.
+   *
    * @return The given text with a caret position token inserted at the given
    * offset.
    */
   protected String inject( final String text, final int i ) {
     return i > 0 && i <= text.length()
       ? new StringBuilder( text ).replace( i, i, CARET_POSITION_MD ).toString()
       : text;
+  }
   /**
    * Returns the editor's caret position.
+   *
    * @return Where the user has positioned the caret.
    */
   protected int getCaretPosition() {
     return this.caretPosition;
+  }
+}

A src/main/java/com/scrivenvar/processors/CaretReplacementProcessor.java

 /*
  * Copyright 2016 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.scrivenvar.processors;
 import static com.scrivenvar.Constants.CARET_POSITION_HTML;
 import static com.scrivenvar.Constants.CARET_POSITION_MD;
 /**
  * Responsible for replacing the caret position marker with an HTML element
  * suitable to use as a reference for scrolling a view port.
+ *
  * @author White Magic Software, Ltd.
  */
 public class CaretReplacementProcessor extends AbstractProcessor<String> {
   private static final int INDEX_NOT_FOUND = -1;
   public CaretReplacementProcessor( final Processor<String> processor ) {
     super( processor );
+  }
   /**
    * Replaces each MD_CARET_POSITION with an HTML element that has an id
    * attribute of CARET_POSITION. This should only replace one item.
+   *
    * @param t The text that contains
+   *
    * @return
    */
   @Override
   public String processLink( final String t ) {
     return replace(t, CARET_POSITION_MD, CARET_POSITION_HTML );
+  }
   /**
    * Replaces the needle with thread in the given haystack. Based on Apache
    * Commons 3 StringUtils.replace method. Should be faster than
    * String.replace, which performs a little regex under the hood.
+   *
    * @param haystack Search this string for the needle, must not be null.
    * @param needle The text to find in the haystack.
    * @param thread Replace the needle with this text, if the needle is found.
+   *
    * @return The haystack with the first instance of needle replaced with
    * thread.
    */
   private static String replace(
     final String haystack, final String needle, final String thread ) {
     final int end = haystack.indexOf( needle, 0 );
     if( end == INDEX_NOT_FOUND ) {
       return haystack;
+    }
     int start = 0;
     final int needleLength = needle.length();
     int increase = thread.length() - needleLength;
     increase = (increase < 0 ? 0 : increase);
     final StringBuilder buffer = new StringBuilder( haystack.length() + increase );
     if( end != INDEX_NOT_FOUND ) {
       buffer.append( haystack.substring( start, end ) ).append( thread );
       start = end + needleLength;
+    }
     return buffer.append( haystack.substring( start ) ).toString();
+  }
+}

M src/main/java/com/scrivenvar/processors/MarkdownCaretInsertionProcessor.java

 package com.scrivenvar.processors;
 import static com.scrivenvar.Constants.CARET_POSITION_MD;
 import static java.lang.Character.isLetter;
 import static java.lang.Math.min;
 /**
  * Responsible for inserting the magic CARET POSITION into the markdown so that,
  * upon rendering into HTML, the HTML pane can scroll to the correct position
  * (relative to the caret position in the editor).
  * Responsible for inserting a caret position token into a markdown document.
+ *
  * @author White Magic Software, Ltd.
  */
 public class MarkdownCaretInsertionProcessor extends AbstractProcessor<String> {
   private final int caretPosition;
 public  class MarkdownCaretInsertionProcessor extends CaretInsertionProcessor {
   /**
    * Constructs a processor capable of inserting a caret marker into Markdown.
+   *
    * @param processor The next processor in the chain.
    * @param position The caret's current position in the text, cannot be null.
    * @param position The caret's current position in the text.
    */
   public MarkdownCaretInsertionProcessor(
     final Processor<String> processor, final int position ) {
     super( processor );
     this.caretPosition = position;
     super( processor, position );
+  }
   /**
    * Changes the text to insert a "caret" at the caret position. This will
    * insert the unique key of Constants.MD_CARET_POSITION into the document.
+   *
    * @param t The document text to process.
    * @param t The text document to process.
+   *
    * @return The document text with the Markdown caret text inserted at the
    * caret position (given at construction time).
    * @return The text with the caret position token inserted at the caret
    * position.
    */
   @Override
     // 4. Find the nearest text node to the caret.
     // 5. Insert the CARET_POSITION_MD value in the text at that offsset.
     // Insert the caret at the closest non-Markdown delimiter (i.e., the
     // closest character from the caret position forward).
     while( offset < length && !isLetter( t.charAt( offset ) ) ) {
       offset++;
+    }
     // Insert the caret position into the Markdown text, but don't interfere
     // with the Markdown iteself.
     return new StringBuilder( t ).replace(
       offset, offset, CARET_POSITION_MD ).toString();
+  }
   /**
    * Returns the editor's caret position.
+   *
    * @return Where the user has positioned the caret.
    */
   private int getCaretPosition() {
     return this.caretPosition;
     return inject( t, offset );
+  }
+}

D src/main/java/com/scrivenvar/processors/MarkdownCaretReplacementProcessor.java

 /*
  * Copyright 2016 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.scrivenvar.processors;
 import static com.scrivenvar.Constants.CARET_POSITION_HTML;
 import static com.scrivenvar.Constants.CARET_POSITION_MD;
 /**
  * Responsible for replacing the caret position marker with an HTML element
  * suitable to use as a reference for scrolling a view port.
+ *
  * @author White Magic Software, Ltd.
  */
 public class MarkdownCaretReplacementProcessor extends AbstractProcessor<String> {
   private static final int INDEX_NOT_FOUND = -1;
   public MarkdownCaretReplacementProcessor( final Processor<String> processor ) {
     super( processor );
+  }
   /**
    * Replaces each MD_CARET_POSITION with an HTML element that has an id
    * attribute of CARET_POSITION. This should only replace one item.
+   *
    * @param t The text that contains
+   *
    * @return
    */
   @Override
   public String processLink( final String t ) {
     return replace(t, CARET_POSITION_MD, CARET_POSITION_HTML );
+  }
   /**
    * Replaces the needle with thread in the given haystack. Based on Apache
    * Commons 3 StringUtils.replace method. Should be faster than
    * String.replace, which performs a little regex under the hood.
+   *
    * @param haystack Search this string for the needle, must not be null.
    * @param needle The text to find in the haystack.
    * @param thread Replace the needle with this text, if the needle is found.
+   *
    * @return The haystack with the first instance of needle replaced with
    * thread.
    */
   private static String replace(
     final String haystack, final String needle, final String thread ) {
     final int end = haystack.indexOf( needle, 0 );
     if( end == INDEX_NOT_FOUND ) {
       return haystack;
+    }
     int start = 0;
     final int needleLength = needle.length();
     int increase = thread.length() - needleLength;
     increase = (increase < 0 ? 0 : increase);
     final StringBuilder buffer = new StringBuilder( haystack.length() + increase );
     if( end != INDEX_NOT_FOUND ) {
       buffer.append( haystack.substring( start, end ) ).append( thread );
       start = end + needleLength;
+    }
     return buffer.append( haystack.substring( start ) ).toString();
+  }
+}

A src/main/java/com/scrivenvar/processors/XMLCaretInsertionProcessor.java

 /*
  * Copyright 2016 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.scrivenvar.processors;
 import com.scrivenvar.FileEditorTab;
 import com.ximpleware.VTDException;
 import com.ximpleware.VTDGen;
 import static com.ximpleware.VTDGen.TOKEN_CHARACTER_DATA;
 import com.ximpleware.VTDNav;
 import java.text.ParseException;
 /**
  * Inserts a caret position indicator into the document.
+ *
  * @author White Magic Software, Ltd.
  */
 public class XMLCaretInsertionProcessor extends CaretInsertionProcessor {
   private FileEditorTab tab;
   /**
    * Constructs a processor capable of inserting a caret marker into XML.
+   *
    * @param processor The next processor in the chain.
    * @param position The caret's current position in the text, cannot be null.
    */
   public XMLCaretInsertionProcessor(
     final Processor<String> processor, final int position ) {
     super( processor, position );
+  }
   /**
    * Inserts a caret at a valid position within the XML document.
+   *
    * @param t The string into which caret position marker text is inserted.
+   *
    * @return t with a caret position marker included, or t if no place to insert
    * could be found.
    */
   @Override
   public String processLink( final String t ) {
     final int caret = getCaretPosition();
     int insertOffset = -1;
     if( t.length() > 0 ) {
       try {
         final VTDNav vn = getNavigator( t );
         final int tokens = vn.getTokenCount();
         int currTokenIndex = 0;
         int prevTokenIndex = currTokenIndex;
         int currOffset = 0;
         // To find the insertion spot even faster, the algorithm could
         // use a binary search or interpolation search algorithm. This
         // would reduce the worst-case iterations to O(log n) from O(n).
         while( currTokenIndex < tokens ) {
           if( vn.getTokenType( currTokenIndex ) == TOKEN_CHARACTER_DATA ) {
             final int prevOffset = currOffset;
             currOffset = vn.getTokenOffset( currTokenIndex );
             if( currOffset > caret ) {
               final int prevLength = vn.getTokenLength( prevTokenIndex );
               // If the caret falls within the limits of the previous token, then
               // insert the caret position marker at the caret offset.
               if( isBetween( caret, prevOffset, prevOffset + prevLength ) ) {
                 insertOffset = caret;
               } else {
                 // The caret position is outside the previous token's text
                 // boundaries, but not inside the current text token. The
                 // caret should be positioned into the closer text token.
                 // For now, the cursor is positioned at the start of the
                 // current text token.
                 insertOffset = currOffset;
+              }
               break;
+            }
             prevTokenIndex = currTokenIndex;
+          }
           currTokenIndex++;
+        }
       } catch( final Exception ex ) {
         throw new RuntimeException(
           new ParseException( ex.getMessage(), caret )
         );
+      }
+    }
     return inject( t, insertOffset );
+  }
   private boolean isBetween( int i, int min, int max ) {
     return i >= min && i <= max;
+  }
   /**
    * Parses the given XML document and returns a high-performance navigator
    * instance for scanning through the XML elements.
+   *
    * @param xml The XML document to parse.
+   *
    * @return A document navigator instance.
    */
   private VTDNav getNavigator( final String xml ) throws VTDException {
     final VTDGen vg = getParser();
     // TODO: Use the document's encoding...
     vg.setDoc( xml.getBytes() );
     vg.parse( true );
     return vg.getNav();
+  }
   private VTDGen getParser() {
     return new VTDGen();
+  }
+}

A src/main/java/com/scrivenvar/processors/XMLProcessor.java

 /*
  * Copyright 2016 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.scrivenvar.processors;
 import com.scrivenvar.Services;
 import com.scrivenvar.service.Snitch;
 import java.io.File;
 import java.io.Reader;
 import java.io.StringReader;
 import java.io.StringWriter;
 import java.nio.file.Path;
 import java.nio.file.Paths;
 import java.text.ParseException;
 import javax.xml.stream.XMLEventReader;
 import javax.xml.stream.XMLInputFactory;
 import javax.xml.stream.XMLStreamException;
 import javax.xml.stream.events.ProcessingInstruction;
 import javax.xml.stream.events.XMLEvent;
 import javax.xml.transform.Source;
 import javax.xml.transform.Transformer;
 import javax.xml.transform.TransformerConfigurationException;
 import javax.xml.transform.TransformerFactory;
 import javax.xml.transform.stream.StreamResult;
 import javax.xml.transform.stream.StreamSource;
 import net.sf.saxon.TransformerFactoryImpl;
 import static net.sf.saxon.tree.util.ProcInstParser.getPseudoAttribute;
 /**
  * Transforms an XML document. The XML document must have a stylesheet specified
  * as part of its processing instructions, such as:
+ *
  * <code>xml-stylesheet type="text/xsl" href="markdown.xsl"</code>
+ *
  * The XSL must transform the XML document into Markdown, or another format
  * recognized by the next link on the chain.
+ *
  * @author White Magic Software, Ltd.
  */
 public class XMLProcessor extends AbstractProcessor<String> {
   private final Snitch snitch = Services.load( Snitch.class );
   private XMLInputFactory xmlInputFactory;
   private TransformerFactory transformerFactory;
   private Path path;
   /**
    * Constructs an XML processor that can transform an XML document into another
    * format based on the XSL file specified as a processing instruction. The
    * path must point to the directory where the XSL file is found, which implies
    * that they must be in the same directory.
+   *
    * @param processor Next link in the processing chain.
    * @param path The path to the XML file content to be processed.
    */
   public XMLProcessor( final Processor<String> processor, final Path path ) {
     super( processor );
     setPath( path );
+  }
   /**
    * Transforms the given XML text into another form (typically Markdown).
+   *
    * @param text The text to transform, can be empty, cannot be null.
+   *
    * @return The transformed text, or empty if text is empty.
    */
   @Override
   public String processLink( final String text ) {
     try {
       return text.isEmpty() ? text : transform( text );
     } catch( Exception e ) {
       throw new RuntimeException( e );
+    }
+  }
   /**
    * Performs an XSL transformation on the given XML text. The XML text must
    * have a processing instruction that points to the XSL template file to use
    * for the transformation.
+   *
    * @param text The text to transform.
+   *
    * @return The transformed text.
    */
   private String transform( final String text ) throws Exception {
     // Extract the XML stylesheet processing instruction.
     final String template = getXsltFilename( text );
     final Path xsl = getXslPath( template );
     // Listen for external file modification events.
     getWatchDog().listen( xsl );
     try(
       final StringWriter output = new StringWriter( text.length() );
       final StringReader input = new StringReader( text ) ) {
       getTransformer( xsl ).transform(
         new StreamSource( input ),
         new StreamResult( output )
       );
       return output.toString();
+    }
+  }
   /**
    * Returns an XSL transformer ready to transform an XML document using the
    * XSLT file specified by the given path. If the path is already known then
    * this will return the associated transformer.
+   *
    * @param path The path to an XSLT file.
+   *
    * @return A transformer that will transform XML documents using the given
    * XSLT file.
+   *
    * @throws TransformerConfigurationException Could not instantiate the
    * transformer.
    */
   private Transformer getTransformer( final Path path )
     throws TransformerConfigurationException {
     final TransformerFactory factory = getTransformerFactory();
     final Source xslt = new StreamSource( path.toFile() );
     return factory.newTransformer( xslt );
+  }
   private Path getXslPath( final String filename ) {
     final Path xmlPath = getPath();
     final File xmlDirectory = xmlPath.toFile().getParentFile();
     return Paths.get( xmlDirectory.getPath(), filename );
+  }
   /**
    * Given XML text, this will use a StAX pull reader to obtain the XML
    * stylesheet processing instruction. This will throw a parse exception if the
    * href pseudo-attribute filename value cannot be found.
+   *
    * @param xml The XML containing an xml-stylesheet processing instruction.
+   *
    * @return The href pseudo-attribute value.
+   *
    * @throws XMLStreamException Could not parse the XML file.
    * @throws ParseException Could not find a non-empty HREF attribute value.
    */
   private String getXsltFilename( final String xml )
     throws XMLStreamException, ParseException {
     String result = "";
     try( final StringReader sr = new StringReader( xml ) ) {
       boolean found = false;
       int count = 0;
       final XMLEventReader reader = createXMLEventReader( sr );
       // If the processing instruction wasn't found in the first 10 lines,
       // fail fast. This should iterate twice through the loop.
       while( !found && reader.hasNext() && count++ < 10 ) {
         final XMLEvent event = reader.nextEvent();
         if( event.isProcessingInstruction() ) {
           final ProcessingInstruction pi = (ProcessingInstruction)event;
           final String target = pi.getTarget();
           if( "xml-stylesheet".equalsIgnoreCase( target ) ) {
             result = getPseudoAttribute( pi.getData(), "href" );
             found = true;
+          }
+        }
+      }
       sr.close();
+    }
     return result;
+  }
   private XMLEventReader createXMLEventReader( final Reader reader )
     throws XMLStreamException {
     return getXMLInputFactory().createXMLEventReader( reader );
+  }
   private synchronized XMLInputFactory getXMLInputFactory() {
     if( this.xmlInputFactory == null ) {
       this.xmlInputFactory = createXMLInputFactory();
+    }
     return this.xmlInputFactory;
+  }
   private XMLInputFactory createXMLInputFactory() {
     return XMLInputFactory.newInstance();
+  }
   private synchronized TransformerFactory getTransformerFactory() {
     if( this.transformerFactory == null ) {
       this.transformerFactory = createTransformerFactory();
+    }
     return this.transformerFactory;
+  }
   /**
    * Returns a high-performance XSLT 2 transformation engine.
+   *
    * @return An XSL transforming engine.
    */
   private TransformerFactory createTransformerFactory() {
     return new TransformerFactoryImpl();
+  }
   private void setPath( final Path path ) {
     this.path = path;
+  }
   private Path getPath() {
     return this.path;
+  }
   private Snitch getWatchDog() {
     return this.snitch;
+  }
+}

D src/main/java/com/scrivenvar/service/Configuration.java

 /*
  * Copyright 2016 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.scrivenvar.service;
 /**
+ *
  * @author White Magic Software, Ltd.
  */
 public interface Configuration extends Service {
   public Settings getSettings();
   public Options getOptions();
+}

M src/main/java/com/scrivenvar/service/Options.java

  * @author White Magic Software, Ltd.
  */
 public interface Options {
 public interface Options extends Service {
   public Preferences getState();

A src/main/java/com/scrivenvar/service/Snitch.java

 /*
  * Copyright 2016 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.scrivenvar.service;
 import java.io.IOException;
 import java.nio.file.Path;
 /**
  * Listens for changes to file system files and directories.
+ *
  * @author White Magic Software, Ltd.
  */
 public interface Snitch extends Service, Runnable {
   /**
    * Listens for changes to the path. If the path specifies a file, then only
    * notifications pertaining to that file are sent. Otherwise, change events
    * for the directory that contains the file are sent. This method must allow
    * for multiple calls to the same file without incurring additional listeners
    * or events.
+   *
    * @param file Send notifications when this file changes.
+   *
    * @throws IOException Couldn't create a watcher for the given file.
    */
   public void listen( Path file ) throws IOException;
   /**
    * Removes the given file from the notifications list.
+   *
    * @param file The file to stop monitoring for any changes.
    */
   public void ignore( final Path file );
   /**
    * Stop listening for events.
    */
   public void stop();
+}

M src/main/java/com/scrivenvar/service/impl/DefaultOptions.java

 package com.scrivenvar.service.impl;
 import static com.scrivenvar.Constants.PREFS_OPTIONS;
 import static com.scrivenvar.Constants.PREFS_ROOT;
 import static com.scrivenvar.Constants.PREFS_STATE;
 import com.scrivenvar.service.Options;
 import java.util.prefs.Preferences;
 import static java.util.prefs.Preferences.userRoot;
 import static com.scrivenvar.Constants.PREFS_STATE;
 import static com.scrivenvar.Constants.PREFS_OPTIONS;
 /**
  * Persistent options user can change at runtime.
+ *
  * @author Karl Tauber and White Magic Software, Ltd.
  */
 public class DefaultOptions implements Options {
   private Preferences preferences;
   public DefaultOptions() {
     setPreferences(getRootPreferences().node(PREFS_OPTIONS ) );
     setPreferences( getRootPreferences().node( PREFS_OPTIONS ) );
+  }
   @Override
   public void put( final String key, final String value ) {
     getPreferences().put( key, value );
+  }
   @Override
   public String get( final String key, final String defalutValue ) {
     return getPreferences().get( key, defalutValue );
+  }
   private void setPreferences( final Preferences preferences ) {
     this.preferences = preferences;
   @Override
   public Preferences getState() {
     return getRootPreferences().node(PREFS_STATE );
     return getRootPreferences().node( PREFS_STATE );
+  }

M src/main/java/com/scrivenvar/service/impl/DefaultSettings.java

 import java.net.URISyntaxException;
 import java.net.URL;
 import java.nio.charset.Charset;
 import java.util.Iterator;
 import java.util.List;
     if( url != null ) {
       try( final Reader r = new InputStreamReader( url.openStream() ) ) {
       try( final Reader r = new InputStreamReader( url.openStream(), getDefaultEncoding() ) ) {
         configuration.setListDelimiterHandler( createListDelimiterHandler() );
         configuration.read( r );
       } catch( IOException e ) {
         throw new ConfigurationException( e );
+      }
+    }
     return configuration;
+  }
   protected Charset getDefaultEncoding() {
     return Charset.defaultCharset();
+  }
   protected ListDelimiterHandler createListDelimiterHandler() {
     return new DefaultListDelimiterHandler( VALUE_SEPARATOR );
+  }
   private URL getPropertySource() {
     return getClass().getResource( getSettingsFilename() );
     return DefaultSettings.class.getResource( getSettingsFilename() );
+  }

A src/main/java/com/scrivenvar/service/impl/DefaultSnitch.java

 /*
  * Copyright 2016 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.scrivenvar.service.impl;
 import com.scrivenvar.service.Snitch;
 import java.io.IOException;
 import java.nio.file.FileSystem;
 import java.nio.file.FileSystems;
 import java.nio.file.Files;
 import java.nio.file.Path;
 import static java.nio.file.StandardWatchEventKinds.ENTRY_MODIFY;
 import java.nio.file.WatchEvent;
 import java.nio.file.WatchKey;
 import java.nio.file.WatchService;
 import java.util.Collections;
 import java.util.HashMap;
 import java.util.HashSet;
 import java.util.Map;
 import java.util.Set;
 /**
  * Listens for file changes.
+ *
  * @author White Magic Software, Ltd.
  */
 public class DefaultSnitch implements Snitch {
   /**
    * Service for listening to directories for modifications.
    */
   private WatchService watchService;
   /**
    * Directories being monitored for changes.
    */
   private Map<WatchKey, Path> keys;
   /**
    * Files that will kick off notification events if modified.
    */
   private Set<Path> eavesdropped;
   /**
    * Set to true when running; set to false to stop listening.
    */
   private volatile boolean listening;
   public DefaultSnitch() {
+  }
   @Override
   public void stop() {
     setListening( false );
+  }
   /**
    * Adds a listener to the list of files to watch for changes. If the file is
    * already in the monitored list, this will return immediately.
+   *
    * @param file Path to a file to watch for changes.
+   *
    * @throws IOException The file could not be monitored.
    */
   @Override
   public void listen( final Path file ) throws IOException {
     if( getEavesdropped().add( file ) ) {
       final Path dir = toDirectory( file );
       final WatchKey key = dir.register( getWatchService(), ENTRY_MODIFY );
       getWatchMap().put( key, dir );
+    }
+  }
   /**
    * Returns the given path to a file (or directory) as a directory. If the
    * given path is already a directory, it is returned. Otherwise, this returns
    * the directory that contains the file. This will fail if the file is stored
    * in the root folder.
+   *
    * @param path The file to return as a directory, which should always be the
    * case.
+   *
    * @return The given path as a directory, if a file, otherwise the path
    * itself.
    */
   private Path toDirectory( final Path path ) {
     return Files.isDirectory( path )
       ? path
       : path.toFile().getParentFile().toPath();
+  }
   /**
    * Stop listening to the given file for change events. This fails silently.
+   *
    * @param file The file to no longer monitor for changes.
    */
   @Override
   public void ignore( final Path file ) {
     final Path directory = toDirectory( file );
     // Remove all occurrences (there should be only one).
     getWatchMap().values().removeAll( Collections.singleton( directory ) );
     // Remove all occurrences (there can be only one).
     getEavesdropped().remove( file );
+  }
   /**
    * Loops until stop is called, or the application is terminated.
    */
   @Override
   @SuppressWarnings( "SleepWhileInLoop" )
   public void run() {
     setListening( true );
     while( isListening() ) {
       try {
         final WatchKey key = getWatchService().take();
         final Path path = get( key );
         // Prevent receiving two separate ENTRY_MODIFY events: file modified
         // and timestamp updated. Instead, receive one ENTRY_MODIFY event
         // with two counts.
         Thread.sleep( 50 );
         for( final WatchEvent<?> event : key.pollEvents() ) {
           final Path changed = path.resolve( (Path)event.context() );
           if( event.kind() == ENTRY_MODIFY && isListening( changed ) ) {
             System.out.println( "RELOAD XSL: " + changed );
+          }
+        }
         if( !key.reset() ) {
           ignore( path );
+        }
       } catch( IOException | InterruptedException ex ) {
         // Stop eavesdropping.
         setListening( false );
+      }
+    }
+  }
   private boolean isListening( final Path path ) {
     return getEavesdropped().contains( path );
+  }
   /**
    * Returns a path for a given watch key.
+   *
    * @param key The key to lookup its corresponding path.
+   *
    * @return The path for the given key.
    */
   private Path get( final WatchKey key ) {
     return getWatchMap().get( key );
+  }
   private synchronized Map<WatchKey, Path> getWatchMap() {
     if( this.keys == null ) {
       this.keys = createWatchKeys();
+    }
     return this.keys;
+  }
   protected Map<WatchKey, Path> createWatchKeys() {
     return new HashMap<>();
+  }
   /**
    * Returns a list of files that, when changed, will kick off a notification.
+   *
    * @return A non-null, possibly empty, list of files.
    */
   private synchronized Set<Path> getEavesdropped() {
     if( this.eavesdropped == null ) {
       this.eavesdropped = createEavesdropped();
+    }
     return this.eavesdropped;
+  }
   protected Set<Path> createEavesdropped() {
     return new HashSet<>();
+  }
   /**
    * The existing watch service, or a new instance if null.
+   *
    * @return A valid WatchService instance, never null.
+   *
    * @throws IOException Could not create a new watch service.
    */
   private synchronized WatchService getWatchService() throws IOException {
     if( this.watchService == null ) {
       this.watchService = createWatchService();
+    }
     return this.watchService;
+  }
   protected WatchService createWatchService() throws IOException {
     final FileSystem fileSystem = FileSystems.getDefault();
     return fileSystem.newWatchService();
+  }
   /**
    * Answers whether the loop should continue executing.
+   *
    * @return true The internal listening loop should continue listening for file
    * modification events.
    */
   protected boolean isListening() {
     return this.listening;
+  }
   /**
    * Requests the snitch to stop eavesdropping on file changes.
+   *
    * @param listening Use true to indicate the service should stop running.
    */
   private void setListening( final boolean listening ) {
     this.listening = listening;
+  }
+}

M src/main/java/com/scrivenvar/test/TestDefinitionPane.java

    test( pane, "c.protagonist", "protagonist" );

    System.exit( 0 );
    throw new RuntimeException( "Complete" );
  }


M src/main/java/com/scrivenvar/test/TestHarness.java


  protected InputStream asStream( String resource ) {
    return getClass().getResourceAsStream( resource );
    return TestHarness.class.getResourceAsStream( resource );
  }
}

M src/main/java/com/scrivenvar/test/TestVariableNameProcessor.java

     long duration = System.nanoTime();
     // TODO: Test replaceEach (with intercoluated variables) and replaceEachRepeatedly
     // (without intercoluation).
     final String result = testBorAhoCorasick( text, definitions );
     String result = testBorAhoCorasick( text, definitions );
     duration = System.nanoTime() - duration;
     show( result );
     System.out.println( elapsed( duration ) );
     duration = System.nanoTime();
     result = testStringUtils( text, definitions );
     duration = System.nanoTime() - duration;
     show( result );
     System.out.println( elapsed( duration ) );
     System.exit( 0 );
     throw new RuntimeException( "Complete" );
+  }
   private void show( final String s ) {
     if( DEBUG ) {
       System.out.printf( "%s\n\n", s );
       System.out.printf( "%s%n%n", s );
+    }
+  }
     for( final TreeItem<String> child : parent.getChildren() ) {
       if( child.isLeaf() ) {
         final String key = asDefinition( ((VariableTreeItem<String>)child).toPath() );
         final VariableTreeItem<String> item;
         if( child instanceof VariableTreeItem ) {
           item = ((VariableTreeItem<String>)child);
         } else {
           throw new IllegalArgumentException(
             "Child must be subclass of VariableTreeItem: " + child );
+        }
         final String key = asDefinition( item.toPath() );
         final String value = child.getValue();

A src/main/resources/META-INF/services/com.scrivenvar.service.Snitch

1
	1	com.scrivenvar.service.impl.DefaultSnitch

101	101	this.yamlParser = yamlParser;
102	102	}
103
104		private InputStream asStream( final String resource ) {
105		return getClass().getResourceAsStream( resource );
106		}
107	103	}
108	104

67	67	test( pane, "c.protagonist", "protagonist" );
68	68
69		System.exit( 0 );
	69	throw new RuntimeException( "Complete" );
70	70	}
71	71

111	111
112	112	protected InputStream asStream( String resource ) {
113		return getClass().getResourceAsStream( resource );
	113	return TestHarness.class.getResourceAsStream( resource );
114	114	}
115	115	}