/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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 org.apache.juneau.config;

import static org.apache.juneau.commons.utils.Shorts.*;
import static org.apache.juneau.commons.utils.StringUtils.*;
import static org.apache.juneau.marshall.BinaryFormat.*;

import java.lang.reflect.*;
import java.util.*;
import java.util.function.*;

import org.apache.juneau.commons.utils.*;
import org.apache.juneau.config.internal.*;
import org.apache.juneau.marshall.*;
import org.apache.juneau.marshall.collections.*;
import org.apache.juneau.marshall.json.*;
import org.apache.juneau.marshall.parser.*;

/**
 * A single entry in a {@link Config} file.
 */
public class Entry {

   private static boolean isArray(Type t) {
      if (! (t instanceof Class))
         return false;
      var c = (Class<?>)t;
      return (c.isArray());
   }
   private static boolean isSimpleType(Type t) {
      if (! (t instanceof Class))
         return false;
      var c = (Class<?>)t;
      return (c == String.class || c.isPrimitive() || c.isAssignableFrom(Number.class) || c == Boolean.class || c.isEnum());
   }
   private final ConfigMapEntry configEntry;

   private final Config config;

   private final String value;

   /**
    * Constructor.
    *
    * @param config The config that this entry belongs to.
    * @param configMap The map that this belongs to.
    * @param sectionName The section name of this entry.
    * @param entryName The name of this entry.
    */
   protected Entry(Config config, ConfigMap configMap, String sectionName, String entryName) {
      this.configEntry = configMap.getEntry(sectionName, entryName);
      this.config = config;
      this.value = configEntry == null ? null : config.removeMods(configEntry.getModifiers(), configEntry.getValue());
   }

   /**
    * Returns this entry converted to the specified type.
    *
    * @param <T> The type to convert the value to.
    * @param type The type to convert the value to.
    * @return This entry converted to the specified type.
    */
   public <T> Optional<T> as(Class<T> type) {
      return as((Type)type);
   }

   /**
    * Returns this entry converted to the specified type.
    *
    * @param <T> The type to convert the value to.
    * @param parser The parser to use to parse the entry value.
    * @param type The type to convert the value to.
    * @return This entry converted to the specified type, or {@link Optional#empty()} if the entry does not exist.
    */
   public <T> Optional<T> as(Parser parser, Class<T> type) {
      return as(parser, (Type)type);
   }

   /**
    * Same as {@link #as(Type, Type...)} but specifies the parser to use to parse the entry.
    *
    * @param <T> The object type to create.
    * @param parser
    *    The parser to use to parse the entry.
    * @param type
    *    The object type to create.
    *    <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType}, {@link GenericArrayType}
    * @param args
    *    The type arguments of the class if it's a collection or map.
    *    <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType}, {@link GenericArrayType}
    *    <br>Ignored if the main type is not a map or collection.
    * @return The value, or {@link Optional#empty()} if the section or key does not exist.
    */
   @SuppressWarnings({
      "java:S3776", // Cognitive complexity acceptable for this specific logic
      "unchecked" // Type erasure requires unchecked casts
   })
   public <T> Optional<T> as(Parser parser, Type type, Type...args) {
      if (isNull())
         return oe();

      try {
         var v = toString();
         if (type == String.class)
            return (Optional<T>)asString();
         if (type == String[].class)
            return (Optional<T>)asStringArray();
         if (type == byte[].class)
            return (Optional<T>)asBytes();
         if (type == int.class || type == Integer.class)
            return (Optional<T>)asInteger();
         if (type == long.class || type == Long.class)
            return (Optional<T>)asLong();
         if (type == JsonMap.class)
            return (Optional<T>)asMap();
         if (type == JsonList.class)
            return (Optional<T>)asList();
         if (isEmpty())
            return oe();
         if (isSimpleType(type))
            return o((T)config.marshallingSession.convertToType(v, (Class<?>)type));

         if (parser instanceof JsonParser) {
            var s1 = firstNonWhitespaceChar(v);
            if (isArray(type) && s1 != '[')
               v = '[' + v + ']';
            else if (s1 != '[' && s1 != '{' && neq(v, "null"))
               v = '\'' + v + '\'';
         }
         return o(parser.read(v, type, args));
      } catch (ParseException e) {
         throw brex(e, (Class<?>)null, "Value could not be parsed.");
      }
   }

   /**
    * Returns this entry converted to the specified value.
    *
    * <p>
    * The type can be a simple type (e.g. beans, strings, numbers) or parameterized type (collections/maps).
    *
    * <h5 class='section'>Examples:</h5>
    * <p class='bjava'>
    *    Config <jv>config</jv> = Config.<jsm>create</jsm>().name(<js>"MyConfig.cfg"</js>).build();
    *
    *    <jc>// Parse into a linked-list of strings.</jc>
    *    List <jv>list</jv> = <jv>config</jv>.get(<js>"MySection/myListOfStrings"</js>).to(LinkedList.<jk>class</jk>, String.<jk>class</jk>);
    *
    *    <jc>// Parse into a linked-list of beans.</jc>
    *    List <jv>list</jv> = <jv>config</jv>.get(<js>"MySection/myListOfBeans"</js>).to(LinkedList.<jk>class</jk>, MyBean.<jk>class</jk>);
    *
    *    <jc>// Parse into a linked-list of linked-lists of strings.</jc>
    *    List <jv>list</jv> = <jv>config</jv>.get(<js>"MySection/my2dListOfStrings"</js>).to(LinkedList.<jk>class</jk>,
    *       LinkedList.<jk>class</jk>, String.<jk>class</jk>);
    *
    *    <jc>// Parse into a map of string keys/values.</jc>
    *    Map <jv>map</jv> = <jv>config</jv>.get(<js>"MySection/myMap"</js>).to(TreeMap.<jk>class</jk>, String.<jk>class</jk>,
    *       String.<jk>class</jk>);
    *
    *    <jc>// Parse into a map containing string keys and values of lists containing beans.</jc>
    *    Map <jv>map</jv> = <jv>config</jv>.get(<js>"MySection/myMapOfListsOfBeans"</js>).to(TreeMap.<jk>class</jk>, String.<jk>class</jk>,
    *       List.<jk>class</jk>, MyBean.<jk>class</jk>);
    * </p>
    *
    * <p>
    * <c>Collection</c> classes are assumed to be followed by zero or one objects indicating the element type.
    *
    * <p>
    * <c>Map</c> classes are assumed to be followed by zero or two meta objects indicating the key and value
    * types.
    *
    * <p>
    * The array can be arbitrarily long to indicate arbitrarily complex data structures.
    *
    * <h5 class='section'>Notes:</h5><ul>
    *    <li class='note'>
    *       Use the {@link #as(Class)} method instead if you don't need a parameterized map/collection.
    * </ul>
    *
    * @param <T> The object type to create.
    * @param type
    *    The object type to create.
    *    <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType}, {@link GenericArrayType}
    * @param args
    *    The type arguments of the class if it's a collection or map.
    *    <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType}, {@link GenericArrayType}
    *    <br>Ignored if the main type is not a map or collection.
    * @return The value, or {@link Optional#empty()} if the section or key does not exist.
    */
   public <T> Optional<T> as(Type type, Type...args) {
      return as(config.parser, type, args);
   }

   /**
    * Returns this entry as a parsed boolean.
    *
    * <p>
    * Uses {@link Boolean#parseBoolean(String)} to parse value.
    *
    * @return The value, or {@link Optional#empty()} if the value does not exist or the value is empty.
    */
   public Optional<Boolean> asBoolean() {
      return o(isEmpty() ? null : (Boolean)Boolean.parseBoolean(toString()));
   }

   /**
    * Returns this entry as a byte array.
    *
    * <p>
    * Byte arrays are stored as encoded strings, typically BASE64, but dependent on the {@link Config.Builder#binaryFormat(BinaryFormat)} setting.
    *
    * @return The value, or {@link Optional#empty()} if the section or key does not exist.
    */
   public Optional<byte[]> asBytes() {
      if (isNull())
         return oe();
      var s = toString();
      if (s.indexOf('\n') != -1)
         s = s.replace("\n", "");
      try {
         if (config.binaryFormat == HEX)
            return o(fromHex(s));
         if (config.binaryFormat == SPACED_HEX)
            return o(fromSpacedHex(s));
         return o(base64Decode(s));
      } catch (Exception e) {
         throw brex(e, (Class<?>)null, "Value could not be converted to a byte array.");
      }
   }

   /**
    * Returns this entry as a double.
    *
    * <p>
    * Uses {@link Double#valueOf(String)} underneath, so any of the following number formats are supported:
    * <ul>
    *    <li><js>"0x..."</js>
    *    <li><js>"0X..."</js>
    *    <li><js>"#..."</js>
    *    <li><js>"0..."</js>
    * </ul>
    *
    * @return The value, or {@link Optional#empty()} if the value does not exist or the value is empty.
    */
   public Optional<Double> asDouble() {
      return o(isEmpty() ? null : Double.valueOf(toString()));
   }

   /**
    * Returns this entry as a float.
    *
    * <p>
    * Uses {@link Float#valueOf(String)} underneath, so any of the following number formats are supported:
    * <ul>
    *    <li><js>"0x..."</js>
    *    <li><js>"0X..."</js>
    *    <li><js>"#..."</js>
    *    <li><js>"0..."</js>
    * </ul>
    *
    * @return The value, or {@link Optional#empty()} if the value does not exist or the value is empty.
    */
   public Optional<Float> asFloat() {
      return o(isEmpty() ? null : Float.valueOf(toString()));
   }

   /**
    * Returns this entry as an integer.
    *
    * <p>
    * <js>"K"</js>, <js>"M"</js>, and <js>"G"</js> can be used to identify kilo, mega, and giga in base 2.
    * <br><js>"k"</js>, <js>"m"</js>, and <js>"g"</js> can be used to identify kilo, mega, and giga in base 10.
    *
    * <h5 class='section'>Example:</h5>
    * <ul class='spaced-list'>
    *    <li>
    *       <code><js>"100K"</js> -&gt; 1024000</code>
    *    <li>
    *       <code><js>"100M"</js> -&gt; 104857600</code>
    *    <li>
    *       <code><js>"100k"</js> -&gt; 1000000</code>
    *    <li>
    *       <code><js>"100m"</js> -&gt; 100000000</code>
    * </ul>
    *
    * <p>
    * Uses {@link Integer#decode(String)} underneath, so any of the following integer formats are supported:
    * <ul>
    *    <li><js>"0x..."</js>
    *    <li><js>"0X..."</js>
    *    <li><js>"#..."</js>
    *    <li><js>"0..."</js>
    * </ul>
    *
    * @return The value, or {@link Optional#empty()} if the value does not exist or the value is empty.
    */
   public Optional<Integer> asInteger() {
      return o(isEmpty() ? null : (Integer)parseIntWithSuffix(toString()));
   }

   /**
    * Returns this entry as a parsed list.
    *
    * <p>
    * Uses the parser registered on the {@link Config} to parse the entry.
    *
    * <p>
    * If the parser is a JSON parser, the starting/trailing <js>"["</js>/<js>"]"</js> in the value are optional.
    *
    * @return The value, or {@link Optional#empty()} if the section or key does not exist.
    * @throws ParseException If value could not be parsed.
    */
   public Optional<JsonList> asList() throws ParseException {
      return asList(config.parser);
   }

   /**
    * Returns this entry as a parsed list.
    *
    * <p>
    * If the parser is a JSON parser, the starting/trailing <js>"["</js>/<js>"]"</js> in the value are optional.
    *
    * @param parser
    *    The parser to use to parse the value.
    *    <br>Can be <jk>null</jk> to use the parser defined on the config.
    * @return The value, or {@link Optional#empty()} if the section or key does not exist.
    * @throws ParseException If value could not be parsed.
    */
   public Optional<JsonList> asList(Parser parser) throws ParseException {
      if (isNull())
         return oe();
      if (parser == null)
         parser = config.parser;
      var s = toString();
      if (parser instanceof JsonParser) {
         var s1 = firstNonWhitespaceChar(s);
         if (s1 != '[' && neq(s, "null"))
            s = '[' + s + ']';
      }
      return o(JsonList.ofString(s, parser));
   }

   /**
    * Returns this entry as a long.
    *
    * <p>
    * <js>"K"</js>, <js>"M"</js>, <js>"G"</js>, <js>"T"</js>, and <js>"P"</js> can be used to identify kilo, mega, giga, tera, and penta in base 2.
    * <br><js>"k"</js>, <js>"m"</js>, <js>"g"</js>, <js>"t"</js>, and <js>"p"</js> can be used to identify kilo, mega, giga, tera, and p in base 10.
    *
    * <h5 class='section'>Example:</h5>
    * <ul class='spaced-list'>
    *    <li>
    *       <code><js>"100K"</js> -&gt; 1024000</code>
    *    <li>
    *       <code><js>"100M"</js> -&gt; 104857600</code>
    *    <li>
    *       <code><js>"100k"</js> -&gt; 1000000</code>
    *    <li>
    *       <code><js>"100m"</js> -&gt; 100000000</code>
    * </ul>
    *
    * <p>
    * Uses {@link Long#decode(String)} underneath, so any of the following integer formats are supported:
    * <ul>
    *    <li><js>"0x..."</js>
    *    <li><js>"0X..."</js>
    *    <li><js>"#..."</js>
    *    <li><js>"0..."</js>
    * </ul>
    *
    * @return The value, or {@link Optional#empty()} if the value does not exist or the value is empty.
    */
   public Optional<Long> asLong() {
      return o(isEmpty() ? null : (Long)parseLongWithSuffix(toString()));
   }

   /**
    * Returns this entry as a parsed map.
    *
    * <p>
    * Uses the parser registered on the {@link Config} to parse the entry.
    *
    * <p>
    * If the parser is a JSON parser, the starting/trailing <js>"{"</js>/<js>"}"</js> in the value are optional.
    *
    * @return The value, or {@link Optional#empty()} if the section or key does not exist.
    * @throws ParseException If value could not be parsed.
    */
   public Optional<JsonMap> asMap() throws ParseException {
      return asMap(config.parser);
   }

   /**
    * Returns this entry as a parsed map.
    *
    * <p>
    * If the parser is a JSON parser, the starting/trailing <js>"{"</js>/<js>"}"</js> in the value are optional.
    *
    * @param parser
    *    The parser to use to parse the value.
    *    <br>Can be <jk>null</jk> to use the parser defined on the config.
    * @return The value, or an empty {@link Optional} if the section or key does not exist.
    * @throws ParseException If value could not be parsed.
    */
   public Optional<JsonMap> asMap(Parser parser) throws ParseException {
      if (isNull())
         return oe();
      if (parser == null)
         parser = config.parser;
      var s = toString();
      if (parser instanceof JsonParser) {
         var s1 = firstNonWhitespaceChar(s);
         if (s1 != '{' && neq(s, "null"))
            s = '{' + s + '}';
      }
      return o(JsonMap.ofString(s, parser));
   }

   /**
    * Returns this entry as a string.
    *
    * @return This entry as a string, or {@link Optional#empty()} if the entry does not exist.
    */
   public Optional<String> asString() {
      return o(isPresent() ? config.varSession.resolve(value) : null);
   }

   /**
    * Returns this entry as a string array.
    *
    * <p>
    * If the value exists, splits the value on commas and returns the values as trimmed strings.
    *
    * @return This entry as a string array, or {@link Optional#empty()} if the entry does not exist.
    */
   public Optional<String[]> asStringArray() {
      if (! isPresent())
         return oe();
      var v = toString();
      var s1 = firstNonWhitespaceChar(v);
      var s2 = lastNonWhitespaceChar(v);
      if (s1 == '[' && s2 == ']' && config.parser instanceof JsonParser parser2) {
         try {
            return o(parser2.read(v, String[].class));
         } catch (ParseException e) {
            throw brex(e);
         }
      }
      return o(StringUtils.splita(v));
   }

   /**
    * Returns this entry as a string.
    *
    * @return This entry as a string.
    * @throws NullPointerException if value was <jk>null</jk>.
    */
   public String get() {
      if (isNull())
         throw new NullPointerException("Value was null");
      return toString();
   }

   /**
    * Returns the same-line comment of this entry.
    *
    * @return The same-line comment of this entry, or <jk>null</jk> if this entry does not exist in the config.
    */
   public String getComment() { return configEntry == null ? null : configEntry.getComment(); }

   /**
    * Returns the name of this entry.
    *
    * @return The name of this entry, or <jk>null</jk> if this entry does not exist in the config.
    */
   public String getKey() { return configEntry == null ? null : configEntry.getKey(); }

   /**
    * Returns the modifiers for this entry.
    *
    * @return The modifiers for this entry, or <jk>null</jk> if it has no modifiers or this entry does not exist in the config.
    */
   public String getModifiers() { return configEntry == null ? null : configEntry.getModifiers(); }

   /**
    * Returns the pre-lines of this entry.
    *
    * @return The pre-lines of this entry as an unmodifiable list, or <jk>null</jk> if this entry does not exist in the config.
    */
   public List<String> getPreLines() { return configEntry == null ? null : configEntry.getPreLines(); }

   /**
    * Returns the raw value of this entry.
    *
    * @return The raw value of this entry, or <jk>null</jk> if this entry does not exist in the config.
    */
   public String getValue() { return configEntry == null ? null : configEntry.getValue(); }

   /**
    * Returns <jk>true</jk> if this entry exists in the config and is not empty.
    *
    * @return <jk>true</jk> if this entry exists in the config and is not empty.
    */
   public boolean isNotEmpty() { return ! isEmpty(); }

   /**
    * Returns <jk>true</jk> if this entry exists in the config.
    *
    * @return <jk>true</jk> if this entry exists in the config.
    */
   public boolean isPresent() { return ! isNull(); }

   /**
    * Returns this entry converted to the specified type or returns the default value.
    *
    * <p>
    * This is equivalent to calling <c>as(<jv>def</jv>.getClass()).orElse(<jv>def</jv>)</c> but is simpler and
    * avoids the creation of an {@link Optional} object.
    *
    * @param def The default value to return if value does not exist.
    * @return This entry converted to the specified type or returns the default value.
    */
   public String orElse(String def) {
      return isNull() ? def : get();
   }

   /**
    * Returns this entry converted to the specified type or returns the default value.
    *
    * <p>
    * This is equivalent to calling <c>as(<jv>def</jv>.getClass()).orElse(<jv>def</jv>)</c> but is simpler and
    * avoids the creation of an {@link Optional} object.
    *
    * @param def The default value to return if value does not exist.
    * @return This entry converted to the specified type or returns the default value.
    */
   public String orElseGet(Supplier<String> def) {
      return isNull() ? def.get() : get();
   }

   /**
    * Returns this entry as a string.
    *
    * @return This entry as a string, or <jk>null</jk> if the entry does not exist.
    */
   @Override
   public String toString() {
      return isPresent() ? config.varSession.resolve(value) : null;
   }

   private boolean isEmpty() { return Shorts.ie(value); }  // NOAI

   private boolean isNull() { return value == null; }
}