Dave Jarvis' Repositories

/*
 * 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;
import org.fxmisc.flowless.VirtualizedScrollPane;

/**
 * Defines application-wide default values.
 *
 * @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, "" );
  }

  @SuppressWarnings("SameParameterValue")
  private static int get( final String key, final int defaultValue ) {
    return SETTINGS.getSetting( key, defaultValue );
  }

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

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

  // Prevent double events when updating files on Linux (save and timestamp).
  public static final int APP_WATCHDOG_TIMEOUT = get(
      "application.watchdog.timeout", 200 );

  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 PREFS_ROOT = get( "preferences.root" );
  public static final String PREFS_STATE = get( "preferences.root.state" );

  // Refer to filename extension settings in the configuration file. Do not
  // terminate these prefixes with a period.
  public static final String GLOB_PREFIX_FILE = "file.ext";
  public static final String GLOB_PREFIX_DEFINITION =
      "definition." + GLOB_PREFIX_FILE;

  // Different definition source protocols.
  public static final String DEFINITION_PROTOCOL_UNKNOWN = "unknown";
  public static final String DEFINITION_PROTOCOL_FILE = "file";

  // Three parameters: line number, column number, and offset
  public static final String STATUS_BAR_LINE = "Main.statusbar.line";

  // "OK" text
  public static final String STATUS_BAR_OK = "Main.statusbar.state.default";
  public static final String STATUS_PARSE_ERROR = "Main.statusbar.parse.error";

  /**
   * Used when creating flat maps relating to resolved variables.
   */
  public static final int DEFAULT_MAP_SIZE = 64;

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

  /**
   * Default working directory to use for R startup script.
   */
  public static final String USER_DIRECTORY = System.getProperty( "user.dir" );

  /**
   * Used as the prefix for uniquely identifying HTML block elements, which
   * helps coordinate scrolling the preview pane to where the user is typing.
   */
  public static final String PARAGRAPH_ID_PREFIX = "p-";

  /**
   * The {@link VirtualizedScrollPane} does not provide a way to differentiate
   * between keyboard entry triggering a scroll event and a mouse event that
   * triggers scrolling. This value ensures that if a user has "just" pressed
   * a key that no synchronized scrolling will be attempted, despite a
   * scrolling event being fired.
   */
  public static final int KEYBOARD_SCROLL_DELAY = 750;
}