ValueSupport.java

/*
Copyright (c) 2018 James Ahlborn

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

package com.healthmarketscience.jackcess.impl.expr;

import java.math.BigDecimal;
import java.math.BigInteger;
import java.time.LocalDate;
import java.time.LocalDateTime;
import java.time.LocalTime;
import java.time.format.DateTimeFormatter;
import java.util.regex.Pattern;

import com.healthmarketscience.jackcess.expr.EvalException;
import com.healthmarketscience.jackcess.expr.LocaleContext;
import com.healthmarketscience.jackcess.expr.Value;
import com.healthmarketscience.jackcess.impl.ColumnImpl;

/**
 *
 * @author James Ahlborn
 */
public class ValueSupport
{
  /** the year a short one counts from, which is the windows rule ms access
      takes: 00 to 49 are in the 2000s and 50 to 99 in the 1900s.  a date
      literal and DateSerial both read it this way, measured in ms access by
      evaluating every year from 0 to 99 for each of them.  the turnover at 30
      which is widely quoted for vba is not the one access uses */
  private static final int SHORT_YEAR_BASE = 1950;

  public static final Value NULL_VAL = new BaseValue() {
    @Override public boolean isNull() {
      return true;
    }
    @Override
    public Type getType() {
      return Type.NULL;
    }
    @Override
    public Object get() {
      return null;
    }
  };
  // access seems to like -1 for true and 0 for false (boolean values are
  // basically an illusion)
  public static final Value TRUE_VAL = new LongValue(-1);
  public static final Value FALSE_VAL = new LongValue(0);
  public static final Value EMPTY_STR_VAL = new StringValue("");
  public static final Value ZERO_VAL = FALSE_VAL;
  public static final Value NEG_ONE_VAL = TRUE_VAL;
  public static final Value ONE_VAL = new LongValue(1);
  public static final Value ZERO_D_VAL = new DoubleValue(0d);

  static final char NUMBER_BASE_PREFIX = '&';
  static final Pattern OCTAL_PAT =
    Pattern.compile("^" + NUMBER_BASE_PREFIX + "[oO][0-7]+");
  static final Pattern HEX_PAT =
    Pattern.compile("^" + NUMBER_BASE_PREFIX + "[hH]\\p{XDigit}+");
  static final char CANON_DEC_SEP = '.';
  static final Pattern NUMBER_PAT =
    Pattern.compile("^[+-]?(([0-9]+[.]?[0-9]*)|([.][0-9]+))([eE][+-]?[0-9]+)?");
  static final Pattern WHITESPACE_PAT = Pattern.compile("[ \\t\\r\\n]+");

  private ValueSupport() {}

  public static Value toValue(boolean b) {
    return (b ? TRUE_VAL : FALSE_VAL);
  }

  public static Value toValue(String s) {
    return new StringValue(s);
  }

  public static Value toValue(int i) {
    return new LongValue(i);
  }

  public static Value toValue(Integer i) {
    return new LongValue(i);
  }

  public static Value toValue(float f) {
    return new DoubleValue((double)f);
  }

  public static Value toValue(double s) {
    return new DoubleValue(s);
  }

  public static Value toValue(Double s) {
    return new DoubleValue(s);
  }

  public static Value toValue(BigDecimal s) {
    return new BigDecimalValue(normalize(s));
  }

  static Value toDateValueIfPossible(Value.Type dateType, double dd) {
    if(DefaultDateFunctions.isValidDateDouble(dd)) {
      return toValue(dateType, ColumnImpl.ldtFromLocalDateDouble(dd));
    }
    return toValue(dd);
  }

  public static Value toValue(LocalDate ld) {
    return new DateTimeValue(
        Value.Type.DATE, LocalDateTime.of(ld, ColumnImpl.BASE_LT));
  }

  public static Value toValue(LocalTime lt) {
    return new DateTimeValue(
        Value.Type.TIME, LocalDateTime.of(ColumnImpl.BASE_LD, lt));
  }

  public static Value toValue(LocalDateTime ldt) {
    return new DateTimeValue(getDateTimeType(ldt), ldt);
  }

  public static Value.Type getDateTimeType(LocalDateTime ldt) {
    boolean hasDate = !ColumnImpl.BASE_LD.equals(ldt.toLocalDate());
    boolean hasTime = !ColumnImpl.BASE_LT.equals(ldt.toLocalTime());

    return (hasDate ?
            (hasTime ? Value.Type.DATE_TIME : Value.Type.DATE) :
            Value.Type.TIME);
  }

  public static Value toValue(Value.Type type, LocalDateTime ldt) {
    return new DateTimeValue(type, ldt);
  }

  public static DateTimeFormatter getDateFormatForType(LocaleContext ctx, Value.Type type) {
    String fmtStr = null;
    switch(type) {
    case DATE:
      fmtStr = ctx.getTemporalConfig().getDefaultDateFormat();
      break;
    case TIME:
      fmtStr = ctx.getTemporalConfig().getDefaultTimeFormat();
      break;
    case DATE_TIME:
      fmtStr = ctx.getTemporalConfig().getDefaultDateTimeFormat();
      break;
    default:
      throw new EvalException("Unexpected date/time type " + type);
    }
    return ctx.createDateFormatter(fmtStr);
  }

  /**
   * Converts the given BigDecimal to the minimal scale >= 0;
   */
  static BigDecimal normalize(BigDecimal bd) {
    if(bd.scale() == 0) {
      return bd;
    }
    // handle a bug in the jdk which doesn't strip zero values
    if(bd.compareTo(BigDecimal.ZERO) == 0) {
      return BigDecimal.ZERO;
    }
    bd = bd.stripTrailingZeros();
    if(bd.scale() < 0) {
      bd = bd.setScale(0);
    }
    return bd;
  }

  static BigInteger parseIntegerString(String val, int radix) {
    return new BigInteger(val.substring(2), radix);
  }

  /**
   * @return the given year with a short one expanded to four digits, which ms
   *         access does for any year below 100
   */
  static int expandShortYear(int year) {
    if(year >= 100) {
      return year;
    }
    int century = (SHORT_YEAR_BASE / 100) * 100;
    return year +
      ((year < (SHORT_YEAR_BASE % 100)) ? (century + 100) : century);
  }
}