Dave Jarvis' Repositories

<?xml version="1.0" encoding="UTF-8"?>

<classpath>

	<classpathentry kind="src" path="src/main/java">

		<attributes>

			<attribute name="FROM_GRADLE_MODEL" value="true"/>

		</attributes>

	</classpathentry>

	<classpathentry kind="src" path="src/main/resources">

		<attributes>

			<attribute name="FROM_GRADLE_MODEL" value="true"/>

		</attributes>

	</classpathentry>

	<classpathentry kind="con" path="org.eclipse.jdt.launching.JRE_CONTAINER/org.eclipse.jdt.internal.debug.ui.launcher.StandardVMType/JavaSE-1.8">

		<accessrules>

			<accessrule kind="accessible" pattern="javafx/**"/>

		</accessrules>

	</classpathentry>

	<classpathentry exported="true" kind="con" path="org.eclipse.buildship.core.gradleclasspathcontainer"/>

	<classpathentry kind="output" path="bin"/>

</classpath>

# always use LF line endings

# ALL FILES:

#   Normalize line endings to LF on checkin and

#   prevent conversion to CRLF when the file is checked out.

* text eol=lf

# BINARY FILES:

#   Disable line ending normalize on checkin.

*.gif binary

*.jar binary

*.png binary

*.zip binary

/bin/

/build/

/.gradle/

/gradle/

/.nb-gradle

/private

.nb-gradle-properties

scrivenvar.pro

<?xml version="1.0" encoding="UTF-8"?>

<projectDescription>

	<name>Markdown Writer FX</name>

	<comment></comment>

	<projects>

	</projects>

	<buildSpec>

		<buildCommand>

			<name>org.eclipse.jdt.core.javabuilder</name>

			<arguments>

			</arguments>

		</buildCommand>

		<buildCommand>

			<name>org.eclipse.buildship.core.gradleprojectbuilder</name>

			<arguments>

			</arguments>

		</buildCommand>

	</buildSpec>

	<natures>

		<nature>org.eclipse.jdt.core.javanature</nature>

		<nature>org.eclipse.buildship.core.gradleprojectnature</nature>

	</natures>

	<filteredResources>

		<filter>

			<id>1438449113801</id>

			<name></name>

			<type>26</type>

			<matcher>

				<id>org.eclipse.ui.ide.multiFilter</id>

				<arguments>1.0-projectRelativePath-matches-false-false-build</arguments>

			</matcher>

		</filter>

		<filter>

			<id>1438449113801</id>

			<name></name>

			<type>26</type>

			<matcher>

				<id>org.eclipse.ui.ide.multiFilter</id>

				<arguments>1.0-projectRelativePath-matches-false-false-.gradle</arguments>

			</matcher>

		</filter>

	</filteredResources>

</projectDescription>

GRADLE_BUILD_COMMANDS=org.eclipse.jdt.core.javabuilder

GRADLE_NATURES=org.eclipse.jdt.core.javanature

build.commands=org.eclipse.jdt.core.javabuilder

connection.arguments=

connection.gradle.distribution=GRADLE_DISTRIBUTION(WRAPPER)

connection.gradle.user.home=null

connection.java.home=null

connection.jvm.arguments=

connection.project.dir=

derived.resources=.gradle,build

eclipse.preferences.version=1

natures=org.eclipse.jdt.core.javanature

project.path=\:

eclipse.preferences.version=1

line.separator=\n

eclipse.preferences.version=1

org.eclipse.jdt.core.compiler.codegen.inlineJsrBytecode=enabled

org.eclipse.jdt.core.compiler.codegen.targetPlatform=1.8

org.eclipse.jdt.core.compiler.compliance=1.8

org.eclipse.jdt.core.compiler.problem.assertIdentifier=error

org.eclipse.jdt.core.compiler.problem.enumIdentifier=error

org.eclipse.jdt.core.compiler.source=1.8

eclipse.preferences.version=1

editor_save_participant_org.eclipse.jdt.ui.postsavelistener.cleanup=true

org.eclipse.jdt.ui.ignorelowercasenames=true

org.eclipse.jdt.ui.importorder=java;javafx;javax;org;com;

org.eclipse.jdt.ui.ondemandthreshold=99

org.eclipse.jdt.ui.staticondemandthreshold=99

sp_cleanup.add_default_serial_version_id=true

sp_cleanup.add_generated_serial_version_id=false

sp_cleanup.add_missing_annotations=true

sp_cleanup.add_missing_deprecated_annotations=true

sp_cleanup.add_missing_methods=false

sp_cleanup.add_missing_nls_tags=false

sp_cleanup.add_missing_override_annotations=true

sp_cleanup.add_missing_override_annotations_interface_methods=true

sp_cleanup.add_serial_version_id=false

sp_cleanup.always_use_blocks=true

sp_cleanup.always_use_parentheses_in_expressions=false

sp_cleanup.always_use_this_for_non_static_field_access=false

sp_cleanup.always_use_this_for_non_static_method_access=false

sp_cleanup.convert_functional_interfaces=false

sp_cleanup.convert_to_enhanced_for_loop=false

sp_cleanup.correct_indentation=false

sp_cleanup.format_source_code=false

sp_cleanup.format_source_code_changes_only=false

sp_cleanup.insert_inferred_type_arguments=false

sp_cleanup.make_local_variable_final=false

sp_cleanup.make_parameters_final=false

sp_cleanup.make_private_fields_final=true

sp_cleanup.make_type_abstract_if_missing_method=false

sp_cleanup.make_variable_declarations_final=true

sp_cleanup.never_use_blocks=false

sp_cleanup.never_use_parentheses_in_expressions=true

sp_cleanup.on_save_use_additional_actions=true

sp_cleanup.organize_imports=false

sp_cleanup.qualify_static_field_accesses_with_declaring_class=false

sp_cleanup.qualify_static_member_accesses_through_instances_with_declaring_class=true

sp_cleanup.qualify_static_member_accesses_through_subtypes_with_declaring_class=true

sp_cleanup.qualify_static_member_accesses_with_declaring_class=false

sp_cleanup.qualify_static_method_accesses_with_declaring_class=false

sp_cleanup.remove_private_constructors=true

sp_cleanup.remove_redundant_type_arguments=true

sp_cleanup.remove_trailing_whitespaces=true

sp_cleanup.remove_trailing_whitespaces_all=true

sp_cleanup.remove_trailing_whitespaces_ignore_empty=false

sp_cleanup.remove_unnecessary_casts=true

sp_cleanup.remove_unnecessary_nls_tags=false

sp_cleanup.remove_unused_imports=true

sp_cleanup.remove_unused_local_variables=false

sp_cleanup.remove_unused_private_fields=true

sp_cleanup.remove_unused_private_members=false

sp_cleanup.remove_unused_private_methods=true

sp_cleanup.remove_unused_private_types=true

sp_cleanup.sort_members=false

sp_cleanup.sort_members_all=false

sp_cleanup.use_anonymous_class_creation=false

sp_cleanup.use_blocks=false

sp_cleanup.use_blocks_only_for_return_and_throw=false

sp_cleanup.use_lambda=true

sp_cleanup.use_parentheses_in_expressions=false

sp_cleanup.use_this_for_non_static_field_access=false

sp_cleanup.use_this_for_non_static_field_access_only_if_necessary=true

sp_cleanup.use_this_for_non_static_method_access=false

sp_cleanup.use_this_for_non_static_method_access_only_if_necessary=true

sp_cleanup.use_type_arguments=false

language: java

jdk:

- oraclejdk8

# enable Java 8u45+, see https://github.com/travis-ci/travis-ci/issues/4042

addons:

  apt:

    packages:

      - oracle-java8-installer

os:

  - linux

# run in container

sudo: false

# Change Log

## 0.8

- Load YAML variables from files

- Upgraded to Apache Commons Configuration 2.1

- Fixed bug with settings using comma-separated file extensions

## 0.7

- Added cursor to the preview pane

- Reconfigured constants to use settings

- Organized MainWindow code by similar method calls

- Added single entry point for refreshing file editor tab

## 0.6

- Revised synchronized scrolling with preview panel

- Added universal character encoding detection

- Removed options panel

- Decoupled Editor Tab and Preview Pane

## 0.5

- Added document processors for Markdown and Variables

- Simplified code base

- Added `Ctrl+Space` hot key for quick variable injection

- Replaced commonmark-java with flexmark

- Insert `CARETPOSITION` into document for preview pane scroll position reference

## 0.4

- Changed name to Scrivenvar

- Added hot-keys for variable mode and autocomplete

- Replaced pegdown with commonmark-java

- Started document processors to provide XSLT and variable dereferencing

## 0.3

- Changed name to Scrivendor

- Changed logo to match

- Started to implement service-oriented architecture

## 0.2

- RichTextFX (and dependencies) updated to version 0.6.10 (fixes bugs)

- pegdown Markdown parser updated to version 1.6

- Added five new pegdown 1.6 extension flags to Markdown Options tab

- Minor improvements

## 0.1

- Initial release

Credits

===

  * Dave Jarvis: [Scrivenvar](https://github.com/DaveJarvis/scrivenvar/)

  * Karl Tauber: [Markdown Writer FX](https://github.com/JFormDesigner/markdown-writer-fx)

  * Tomas Mikula: [RichTextFX](https://github.com/TomasMikula/RichTextFX), [ReactFX](https://github.com/TomasMikula/ReactFX), [WellBehavedFX](https://github.com/TomasMikula/WellBehavedFX), [Flowless](https://github.com/TomasMikula/Flowless), and [UndoFX](https://github.com/TomasMikula/UndoFX)

  * Mikael Grev: [MigLayout](http://www.miglayout.com/)

  * Tom Eugelink: [MigPane](https://github.com/mikaelgrev/miglayout/blob/master/javafx/src/main/java/org/tbee/javafx/scene/layout/fxml/MigPane.java)

  * Vladimir Schneider: [flexmark](https://website.com)

  * Jens Deters: [FontAwesomeFX](https://bitbucket.org/Jerady/fontawesomefx)

  * Shy Shalom, Kohei Taketa: [juniversalchardet](https://github.com/takscape/juniversalchardet)

Copyright (c) 2015 Karl Tauber <karl at jformdesigner dot com>

All rights reserved.

Redistribution and use in source and binary forms, with or without

modification, are permitted provided that the following conditions are met:

* Redistributions of source code must retain the above copyright

  notice, this list of conditions and the following disclaimer.

* 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.

![Logo](images/logo64.png)

$application.title$

===

Word processing with variables.

![Screenshot](images/screenshot.png)

Features

---

* User-defined variables

* Recursive variable definitions

* Real-time document preview with variable substitution

* Platform independent (Windows, Linux, MacOS)

* Auto-insert variable names pressing `Control+Space`

Future Features

---

* Spell check

* Search and replace, with or without variables

* XML and XSL processing

* R integration using [Rserve](https://rforge.net/Rserve/)

* Re-organize variable names

Requirements

---

Download and install [Java 8u40](http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html).

Installation

---

1. [Download](https://github.com/DaveJarvis/scrivenvar/releases) the latest zip archive and extract it to any folder.

1. Double-click `scrivenvar.jar` to start the application.

License

---

This software is licensed under the [BSD 2-Clause License](LICENSE).

<?xml version="1.0" encoding="UTF-8"?>

<project>

  <entry key="classpath1" value="bin" />

  <entry key="classpath2" value="lib/fontawesomefx-8.9.jar" />

  <entry key="sourcefolders1" value="src/main/java" />

  <entry key="sourcefolders2" value="src/main/resources" />

  <node name="designer">

    <entry key="_i18nJavaSettingsEnabled" value="true" />

    <entry key="_i18nSettingsEnabled" value="true" />

    <entry key="i18n.externalizeexcludes1" value="com.scrivenvar.controls.EscapeTextField#escapeCharacters" />

    <entry key="i18n.externalizeexcludes2" value="com.scrivenvar.controls.WebHyperlink#uri" />

    <entry key="i18n.javagetstringformat" value="Messages.get(${key})" />

  </node>

  <node name="javacodegenerator">

    <entry key="_codeStyleSettingsEnabled" value="true" />

    <entry key="_generalSettingsEnabled" value="true" />

    <entry key="explicitimports" value="true" />

    <entry key="lineseparator" value="\n" />

  </node>

</project>

# Introduction

This document describes how to write documentation (technical or otherwise) using a master copy for generating a variety of output formats, such as: HTML pages, PDFs, and EPUBs. What's more, the document provides an overview of how to use variables and--for the unintimidated--leverage the power of R, a programming language.

# Software Requirements

Install Java, ConTeXt, Pandoc, R, and Lib V8. Then install the R packages knitr, yaml, and devtools, and pluralize by running the following commands:

    sudo su -

    apt-get install default-jre

    apt-get install context

    apt-get install pandoc

    apt-get install r

    apt-get install libv8-dev

    r

    url <- "http://cran.us.r-project.org"

    install.packages('knitr', repos=url)

    install.packages('yaml', repos=url)

    install.packages('devtools', repos=url)

    devtools::install_github("hrbrmstr/pluralize")

To exit R, press `Ctrl+d` or type `q()` followed by pressing `Enter`.

The required software packages are installed.

# Markdown

|Table|Table|

|---|---|

|Data|Data|

version = '0.5'

apply plugin: 'java'

apply plugin: 'java-library-distribution'

apply plugin: 'application'

sourceCompatibility = 1.8

mainClassName = 'com.scrivenvar.Main'

repositories {

	jcenter()

}

compileJava {

  options.compilerArgs << "-Xlint:unchecked" << "-Xlint:deprecation"

}

dependencies {

  compile group: 'org.fxmisc.richtext', name: 'richtextfx', version: '0.7-M2'

	compile group: 'com.miglayout', name: 'miglayout-javafx', version: '5.0'

	compile group: 'de.jensd', name: 'fontawesomefx-fontawesome', version: '4.5.0'

  compile group: 'org.ahocorasick', name: 'ahocorasick', version: '0.3.0'

  compile group: 'com.vladsch.flexmark', name: 'flexmark', version: '0.6.1'

  compile group: 'com.vladsch.flexmark', name: 'flexmark-ext-gfm-tables', version: '0.6.1'

  compile group: 'com.fasterxml.jackson.core', name: 'jackson-core', version: '2.8.4'

  compile group: 'com.fasterxml.jackson.core', name: 'jackson-databind', version: '2.8.4'

  compile group: 'com.fasterxml.jackson.core', name: 'jackson-annotations', version: '2.8.4'

  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.googlecode.juniversalchardet', name: 'juniversalchardet', version: '1.0.3'

  compile group: 'org.apache.commons', name: 'commons-configuration2', version: '2.1'

}

jar {

	baseName = 'scrivenvar'

  from {

    (configurations.runtime).collect {

      it.isDirectory() ? it : zipTree(it)

    }

  }

	manifest {

		attributes 'Main-Class': mainClassName,

					'Class-Path': configurations.compile.collect { 'lib/' + it.getName() }.join(' ')

	}

}

distributions {

	main {

		baseName = 'scrivenvar'

		contents {

			from { ['LICENSE', 'README.md'] }

			into( 'images' ) {

				from { 'images' }

			}

		}

	}

}

application:

  title: Scrivenvar

/*

 * 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;

import com.scrivenvar.Services;

import com.scrivenvar.service.Options;

import java.util.prefs.Preferences;

import org.tbee.javafx.scene.layout.fxml.MigPane;

/**

 * Provides options to all subclasses.

 *

 * @author White Magic Software, Ltd.

 */

public abstract class AbstractPane extends MigPane {

  private final Options options = Services.load( Options.class );

  protected Options getOptions() {

    return this.options;

  }

  protected Preferences getState() {

    return getOptions().getState();

  }

}

/*

 * 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;

import com.scrivenvar.service.Settings;

/**

 * @author White Magic Software, Ltd.

 */

public class Constants {

  private static final Settings SETTINGS = Services.load( Settings.class );

  /**

   * Prevent instantiation.

   */

  private Constants() {

  }

  private static String get( final String key ) {

    return SETTINGS.getSetting( key, "" );

  }

  // Bootstrapping...

  public static final String SETTINGS_NAME = "/com/scrivenvar/settings.properties";

  public static final String APP_BUNDLE_NAME = get( "application.messages" );

  public static final String STYLESHEET_SCENE = get( "file.stylesheet.scene" );

  public static final String STYLESHEET_MARKDOWN = get( "file.stylesheet.markdown" );

  public static final String STYLESHEET_PREVIEW = get( "file.stylesheet.preview" );

  public static final String FILE_LOGO_16 = get( "file.logo.16" );

  public static final String FILE_LOGO_32 = get( "file.logo.32" );

  public static final String FILE_LOGO_128 = get( "file.logo.128" );

  public static final String FILE_LOGO_256 = get( "file.logo.256" );

  public static final String FILE_LOGO_512 = get( "file.logo.512" );

  public static final String CARET_POSITION_BASE = get( "caret.token.base" );

  public static final String CARET_POSITION_MD = get( "caret.token.markdown" );

  public static final String CARET_POSITION_XML = get( "caret.token.xml" );

  public static final String CARET_POSITION_HTML = get( "caret.token.html" );

  public static final String PREFS_ROOT = get( "preferences.root" );

  public static final String PREFS_STATE = get( "preferences.root.state" );

  public static final String PREFS_OPTIONS = get( "preferences.root.options" );

  public static final String PREFS_DEFINITION_SOURCE = get( "preferences.root.definition.source" );

}

/*

 * Copyright 2016 Karl Tauber and White Magic Software, Ltd.

 *

 * 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;

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.

   */

  protected 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;

  }

  private Charset getEncoding() {

    return this.encoding;

  }

  private void setEncoding( final Charset encoding ) {

    this.encoding = encoding;

  }

  /**

   * Returns the tab title, without any modified indicators.

   *

   * @return The tab title.

   */

  @Override

  public String toString() {

    return getTabTitle();

  }

}

/*

 * Copyright 2016 Karl Tauber and White Magic Software, Ltd.

 *

 * All rights reserved.

 *

 * Redistribution and use in source and binary forms, with or without

 * modification, are permitted provided that the following conditions are met:

 *

 *  o Redistributions of source code must retain the above copyright

 *    notice, this list of conditions and the following disclaimer.

 *

 *  o Redistributions in binary form must reproduce the above copyright

 *    notice, this list of conditions and the following disclaimer in the

 *    documentation and/or other materials provided with the distribution.

 *

 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS

 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT

 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR

 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT

 * HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,

 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT

 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,

 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY

 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT

 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE

 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

 */

package com.scrivenvar;

import static com.scrivenvar.Messages.get;

import com.scrivenvar.predicates.files.FileTypePredicate;

import com.scrivenvar.service.Options;

import com.scrivenvar.service.Settings;

import com.scrivenvar.service.events.AlertMessage;

import com.scrivenvar.service.events.AlertService;

import static com.scrivenvar.service.events.AlertService.NO;

import static com.scrivenvar.service.events.AlertService.YES;

import com.scrivenvar.util.Utils;

import java.io.File;

import java.nio.file.Path;

import java.util.ArrayList;

import java.util.List;

import java.util.function.Consumer;

import java.util.prefs.Preferences;

import java.util.stream.Collectors;

import javafx.beans.property.ReadOnlyBooleanProperty;

import javafx.beans.property.ReadOnlyBooleanWrapper;

import javafx.beans.property.ReadOnlyObjectProperty;

import javafx.beans.property.ReadOnlyObjectWrapper;

import javafx.beans.value.ChangeListener;

import javafx.beans.value.ObservableValue;

import javafx.collections.ListChangeListener;

import javafx.collections.ObservableList;

import javafx.event.Event;

import javafx.scene.Node;

import javafx.scene.control.Alert;

import javafx.scene.control.ButtonType;

import javafx.scene.control.Tab;

import javafx.scene.control.TabPane;

import javafx.scene.control.TabPane.TabClosingPolicy;

import javafx.scene.input.InputEvent;

import javafx.stage.FileChooser;

import javafx.stage.FileChooser.ExtensionFilter;

import javafx.stage.Window;

import org.fxmisc.richtext.StyledTextArea;

import org.fxmisc.wellbehaved.event.EventPattern;

import org.fxmisc.wellbehaved.event.InputMap;

/**

 * Tab pane for file editors.

 *

 * @author Karl Tauber and White Magic Software, Ltd.

 */

public final class FileEditorTabPane extends TabPane {

  private final static String FILTER_EXTENSIONS = "filter.file";

  private final static String FILTER_EXTENSION_TITLES = "Dialog.file.choose.filter";

  private final Options options = Services.load( Options.class );

  private final Settings settings = Services.load( Settings.class );

  private final AlertService alertService = Services.load( AlertService.class );

  private final ReadOnlyObjectWrapper<Path> openDefinition = new ReadOnlyObjectWrapper<>();

  private final ReadOnlyObjectWrapper<FileEditorTab> activeFileEditor = new ReadOnlyObjectWrapper<>();

  private final ReadOnlyBooleanWrapper anyFileEditorModified = new ReadOnlyBooleanWrapper();

  /**

   * Constructs a new file editor tab pane.

   */

  public FileEditorTabPane() {

    final ObservableList<Tab> tabs = getTabs();

    setFocusTraversable( false );

    setTabClosingPolicy( TabClosingPolicy.ALL_TABS );

    addTabSelectionListener(

      (ObservableValue<? extends Tab> tabPane,

        final Tab oldTab, final Tab newTab) -> {

        if( newTab != null ) {

          activeFileEditor.set( (FileEditorTab)newTab );

        }

      }

    );

    final ChangeListener<Boolean> modifiedListener = (observable, oldValue, newValue) -> {

      for( final Tab tab : tabs ) {

        if( ((FileEditorTab)tab).isModified() ) {

          this.anyFileEditorModified.set( true );

          break;

        }

      }

    };

    tabs.addListener(

      (ListChangeListener<Tab>)change -> {

        while( change.next() ) {

          if( change.wasAdded() ) {

            change.getAddedSubList().stream().forEach( (tab) -> {

              ((FileEditorTab)tab).modifiedProperty().addListener( modifiedListener );

            } );

          } else if( change.wasRemoved() ) {

            change.getRemoved().stream().forEach( (tab) -> {

              ((FileEditorTab)tab).modifiedProperty().removeListener( modifiedListener );

            } );

          }

        }

        // Changes in the tabs may also change anyFileEditorModified property

        // (e.g. closed modified file)

        modifiedListener.changed( null, null, null );

      }

    );

  }

  /**

   * Delegates to the active file editor.

   *

   * @param <T> Event type.

   * @param <U> Consumer type.

   * @param event Event to pass to the editor.

   * @param consumer Consumer to pass to the editor.

   */

  public <T extends Event, U extends T> void addEventListener(

    final EventPattern<? super T, ? extends U> event,

    final Consumer<? super U> consumer ) {

    getActiveFileEditor().addEventListener( event, consumer );

  }

  /**

   * Delegates to the active file editor pane, and, ultimately, to its text

   * area.

   *

   * @param map The map of methods to events.

   */

  public void addEventListener( final InputMap<InputEvent> map ) {

    getActiveFileEditor().addEventListener( map );

  }

  /**

   * Remove a keyboard event listener from the active file editor.

   *

   * @param map The keyboard events to remove.

   */

  public void removeEventListener( final InputMap<InputEvent> map ) {

    getActiveFileEditor().removeEventListener( map );

  }

  /**

   * Allows observers to be notified when the current file editor tab changes.

   *

   * @param listener The listener to notify of tab change events.

   */

  public void addTabSelectionListener( final ChangeListener<Tab> listener ) {

    // Observe the tab so that when a new tab is opened or selected,

    // a notification is kicked off.

    getSelectionModel().selectedItemProperty().addListener( listener );

  }

  /**

   * Allows clients to manipulate the editor content directly.

   *

   * @return The text area for the active file editor.

   */

  public StyledTextArea getEditor() {

    return getActiveFileEditor().getEditorPane().getEditor();

  }

  public FileEditorTab getActiveFileEditor() {

    return this.activeFileEditor.get();

  }

  public ReadOnlyObjectProperty<FileEditorTab> activeFileEditorProperty() {

    return this.activeFileEditor.getReadOnlyProperty();

  }

  ReadOnlyBooleanProperty anyFileEditorModifiedProperty() {

    return this.anyFileEditorModified.getReadOnlyProperty();

  }

  private FileEditorTab createFileEditor( final Path path ) {

    final FileEditorTab tab = new FileEditorTab( path );

    tab.setOnCloseRequest( e -> {

      if( !canCloseEditor( tab ) ) {

        e.consume();

      }

    } );

    return tab;

  }

  /**

   * Called when the user selects New from the File menu.

   *

   * @return The newly added tab.

   */

  void newEditor() {

    final FileEditorTab tab = createFileEditor( null );

    getTabs().add( tab );

    getSelectionModel().select( tab );

  }

  void openFileDialog() {

    final String title = get( "Dialog.file.choose.open.title" );

    final FileChooser dialog = createFileChooser( title );

    final List<File> files = dialog.showOpenMultipleDialog( getWindow() );

    if( files != null ) {

      openFiles( files );

    }

  }

  /**

   * Opens the files into new editors, unless one of those files was a

   * definition file. The definition file is loaded into the definition pane,

   * but only the first one selected (multiple definition files will result in a

   * warning).

   *

   * @param files The list of non-definition files that the were requested to

   * open.

   *

   * @return A list of files that can be opened in text editors.

   */

  private void openFiles( final List<File> files ) {

    final FileTypePredicate predicate

      = new FileTypePredicate( createExtensionFilter( "definition" ).getExtensions() );

    // The user might have opened multiple definitions files. These will

    // be discarded from the text editable files.

    final List<File> definitions

      = files.stream().filter( predicate ).collect( Collectors.toList() );

    // Create a modifiable list to remove any definition files that were

    // opened.

    final List<File> editors = new ArrayList<>( files );

    if( editors.size() > 0 ) {

      saveLastDirectory( editors.get( 0 ) );

    }

    editors.removeAll( definitions );

    // Open editor-friendly files (e.g,. Markdown, XML) in new tabs.

    if( editors.size() > 0 ) {

      openEditors( editors, 0 );

    }

    if( definitions.size() > 0 ) {

      openDefinition( definitions.get( 0 ) );

    }

  }

  private void openEditors( final List<File> files, final int activeIndex ) {

    final int fileTally = files.size();

    final List<Tab> tabs = getTabs();

    // Close single unmodified "Untitled" tab.

    if( tabs.size() == 1 ) {

      final FileEditorTab fileEditor = (FileEditorTab)(tabs.get( 0 ));

      if( fileEditor.getPath() == null && !fileEditor.isModified() ) {

        closeEditor( fileEditor, false );

      }

    }

    for( int i = 0; i < fileTally; i++ ) {

      final Path path = files.get( i ).toPath();

      FileEditorTab fileEditorTab = findEditor( path );

      // Only open new files.

      if( fileEditorTab == null ) {

        fileEditorTab = createFileEditor( path );

        getTabs().add( fileEditorTab );

      }

      // Select the first file in the list.

      if( i == activeIndex ) {

        getSelectionModel().select( fileEditorTab );

      }

    }

  }

  /**

   * Returns a property that changes when a new definition file is opened.

   *

   * @return The path to a definition file that was opened.

   */

  public ReadOnlyObjectProperty<Path> onOpenDefinitionFileProperty() {

    return getOnOpenDefinitionFile().getReadOnlyProperty();

  }

  private ReadOnlyObjectWrapper<Path> getOnOpenDefinitionFile() {

    return this.openDefinition;

  }

  /**

   * Called when the user has opened a definition file (using the file open

   * dialog box). This will replace the current set of definitions for the

   * active tab.

   *

   * @param definition The file to open.

   */

  private void openDefinition( final File definition ) {

    // TODO: Prevent reading this file twice when a new text document is opened.

    // (might be a matter of checking the value first).

    getOnOpenDefinitionFile().set( definition.toPath() );

  }

  boolean saveEditor( final FileEditorTab fileEditor ) {

    if( fileEditor == null || !fileEditor.isModified() ) {

      return true;

    }

    if( fileEditor.getPath() == null ) {

      getSelectionModel().select( fileEditor );

      final FileChooser fileChooser = createFileChooser( Messages.get( "Dialog.file.choose.save.title" ) );

      final File file = fileChooser.showSaveDialog( getWindow() );

      if( file == null ) {

        return false;

      }

      saveLastDirectory( file );

      fileEditor.setPath( file.toPath() );

    }

    return fileEditor.save();

  }

  boolean saveAllEditors() {

    boolean success = true;

    for( FileEditorTab fileEditor : getAllEditors() ) {

      if( !saveEditor( fileEditor ) ) {

        success = false;

      }

    }

    return success;

  }

  /**

   * Answers whether the file has had modifications. '

   *

   * @param tab THe tab to check for modifications.

   *

   * @return false The file is unmodified.

   */

  boolean canCloseEditor( final FileEditorTab tab ) {

    if( !tab.isModified() ) {

      return true;

    }

    final AlertMessage message = getAlertService().createAlertMessage(

      Messages.get( "Alert.file.close.title" ),

      Messages.get( "Alert.file.close.text" ),

      tab.getText()

    );

    final Alert alert = getAlertService().createAlertConfirmation( message );

    final ButtonType response = alert.showAndWait().get();

    return response == YES ? saveEditor( tab ) : response == NO;

  }

  private AlertService getAlertService() {

    return this.alertService;

  }

  boolean closeEditor( FileEditorTab fileEditor, boolean save ) {

    if( fileEditor == null ) {

      return true;

    }

    final Tab tab = fileEditor;

    if( save ) {

      Event event = new Event( tab, tab, Tab.TAB_CLOSE_REQUEST_EVENT );

      Event.fireEvent( tab, event );

      if( event.isConsumed() ) {

        return false;

      }

    }

    getTabs().remove( tab );

    if( tab.getOnClosed() != null ) {

      Event.fireEvent( tab, new Event( Tab.CLOSED_EVENT ) );

    }

    return true;

  }

  boolean closeAllEditors() {

    final FileEditorTab[] allEditors = getAllEditors();

    final FileEditorTab activeEditor = getActiveFileEditor();

    // try to save active tab first because in case the user decides to cancel,

    // then it stays active

    if( activeEditor != null && !canCloseEditor( activeEditor ) ) {

      return false;

    }

    // This should be called any time a tab changes.

    persistPreferences();

    // save modified tabs

    for( int i = 0; i < allEditors.length; i++ ) {

      final FileEditorTab fileEditor = allEditors[ i ];

      if( fileEditor == activeEditor ) {

        continue;

      }

      if( fileEditor.isModified() ) {

        // activate the modified tab to make its modified content visible to the user

        getSelectionModel().select( i );

        if( !canCloseEditor( fileEditor ) ) {

          return false;

        }

      }

    }

    // Close all tabs.

    for( final FileEditorTab fileEditor : allEditors ) {

      if( !closeEditor( fileEditor, false ) ) {

        return false;

      }

    }

    return getTabs().isEmpty();

  }

  private FileEditorTab[] getAllEditors() {

    final ObservableList<Tab> tabs = getTabs();

    final int length = tabs.size();

    final FileEditorTab[] allEditors = new FileEditorTab[ length ];

    for( int i = 0; i < length; i++ ) {

      allEditors[ i ] = (FileEditorTab)tabs.get( i );

    }

    return allEditors;

  }

  /**

   * Returns the file editor tab that has the given path.

   *

   * @return null No file editor tab for the given path was found.

   */

  private FileEditorTab findEditor( final Path path ) {

    for( final Tab tab : getTabs() ) {

      final FileEditorTab fileEditor = (FileEditorTab)tab;

      if( fileEditor.isPath( path ) ) {

        return fileEditor;

      }

    }

    return null;

  }

  private FileChooser createFileChooser( String title ) {

    final FileChooser fileChooser = new FileChooser();

    fileChooser.setTitle( title );

    fileChooser.getExtensionFilters().addAll(

      createExtensionFilters() );

    final String lastDirectory = getPreferences().get( "lastDirectory", null );

    File file = new File( (lastDirectory != null) ? lastDirectory : "." );

    if( !file.isDirectory() ) {

      file = new File( "." );

    }

    fileChooser.setInitialDirectory( file );

    return fileChooser;

  }

  private List<ExtensionFilter> createExtensionFilters() {

    final List<ExtensionFilter> list = new ArrayList<>();

    // TODO: Return a list of all properties that match the filter prefix.

    // This will allow dynamic filters to be added and removed just by

    // updating the properties file.

    list.add( createExtensionFilter( "definition" ) );

    list.add( createExtensionFilter( "markdown" ) );

    list.add( createExtensionFilter( "xml" ) );

    list.add( createExtensionFilter( "all" ) );

    return list;

  }

  private ExtensionFilter createExtensionFilter( final String filetype ) {

    final String tKey = String.format( "%s.title.%s", FILTER_EXTENSION_TITLES, filetype );

    final String eKey = String.format( "%s.ext.%s", FILTER_EXTENSIONS, filetype );

    return new ExtensionFilter( Messages.get( tKey ), getExtensions( eKey ) );

  }

  private List<String> getExtensions( final String key ) {

    return getSettings().getStringSettingList( key );

  }

  private void saveLastDirectory( final File file ) {

    getPreferences().put( "lastDirectory", file.getParent() );

  }

  public void restorePreferences() {

    int activeIndex = 0;

    final Preferences preferences = getPreferences();

    final String[] fileNames = Utils.getPrefsStrings( preferences, "file" );

    final String activeFileName = preferences.get( "activeFile", null );

    final ArrayList<File> files = new ArrayList<>( fileNames.length );

    for( final String fileName : fileNames ) {

      final File file = new File( fileName );

      if( file.exists() ) {

        files.add( file );

        if( fileName.equals( activeFileName ) ) {

          activeIndex = files.size() - 1;

        }

      }

    }

    if( files.isEmpty() ) {

      newEditor();

    } else {

      openEditors( files, activeIndex );

    }

  }