/*
 * 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.uon;

import static org.apache.juneau.commons.utils.AssertionUtils.*;
import static org.apache.juneau.commons.utils.Utils.*;

import java.lang.annotation.*;
import java.lang.reflect.*;
import java.nio.charset.*;
import java.util.*;
import java.util.concurrent.*;

import org.apache.juneau.*;
import org.apache.juneau.commons.collections.*;
import org.apache.juneau.commons.function.*;
import org.apache.juneau.commons.reflect.*;
import org.apache.juneau.httppart.*;
import org.apache.juneau.parser.*;

/**
 * Parses UON (a notation for URL-encoded query parameter values) text into POJO models.
 *
 * <h5 class='topic'>Media types</h5>
 * <p>
 * Handles <c>Content-Type</c> types:  <bc>text/uon</bc>
 *
 * <h5 class='topic'>Description</h5>
 * <p>
 * This parser uses a state machine, which makes it very fast and efficient.
 *
 * <h5 class='section'>Notes:</h5><ul>
 *    <li class='note'>This class is thread safe and reusable.
 * </ul>
 *
 * <h5 class='section'>See Also:</h5><ul>
 *    <li class='link'><a class="doclink" href="https://juneau.apache.org/docs/topics/UonBasics">UON Basics</a>

 * </ul>
 */
public class UonParser extends ReaderParser implements HttpPartParser, UonMetaProvider {
   /**
    * Builder class.
    */
   public static class Builder extends ReaderParser.Builder {

      private static final Cache<HashKey,UonParser> CACHE = Cache.of(HashKey.class, UonParser.class).build();

      private boolean decoding;
      private boolean validateEnd;

      /**
       * Constructor, default settings.
       */
      protected Builder() {
         consumes("text/uon");
         decoding = env("UonParser.decoding", false);
         validateEnd = env("UonParser.validateEnd", false);
      }

      /**
       * Copy constructor.
       *
       * @param copyFrom The builder to copy from.
       *    <br>Cannot be <jk>null</jk>.
       */
      protected Builder(Builder copyFrom) {
         super(assertArgNotNull("copyFrom", copyFrom));
         decoding = copyFrom.decoding;
         validateEnd = copyFrom.validateEnd;
      }

      /**
       * Copy constructor.
       *
       * @param copyFrom The bean to copy from.
       *    <br>Cannot be <jk>null</jk>.
       */
      protected Builder(UonParser copyFrom) {
         super(assertArgNotNull("copyFrom", copyFrom));
         decoding = copyFrom.decoding;
         validateEnd = copyFrom.validateEnd;
      }

      @Override /* Overridden from Builder */
      public Builder annotations(Annotation...values) {
         super.annotations(values);
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder apply(AnnotationWorkList work) {
         super.apply(work);
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder applyAnnotations(Class<?>...from) {
         super.applyAnnotations(from);
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder applyAnnotations(Object...from) {
         super.applyAnnotations(from);
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder autoCloseStreams() {
         super.autoCloseStreams();
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder autoCloseStreams(boolean value) {
         super.autoCloseStreams(value);
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder beanClassVisibility(Visibility value) {
         super.beanClassVisibility(value);
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder beanConstructorVisibility(Visibility value) {
         super.beanConstructorVisibility(value);
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder beanContext(BeanContext value) {
         super.beanContext(value);
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder beanContext(BeanContext.Builder value) {
         super.beanContext(value);
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder beanDictionary(java.lang.Class<?>...values) {
         super.beanDictionary(values);
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder beanFieldVisibility(Visibility value) {
         super.beanFieldVisibility(value);
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder beanInterceptor(Class<?> on, Class<? extends org.apache.juneau.swap.BeanInterceptor<?>> value) {
         super.beanInterceptor(on, value);
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder beanMapPutReturnsOldValue() {
         super.beanMapPutReturnsOldValue();
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder beanMethodVisibility(Visibility value) {
         super.beanMethodVisibility(value);
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder beanProperties(Class<?> beanClass, String properties) {
         super.beanProperties(beanClass, properties);
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder beanProperties(Map<String,Object> values) {
         super.beanProperties(values);
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder beanProperties(String beanClassName, String properties) {
         super.beanProperties(beanClassName, properties);
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder beanPropertiesExcludes(Class<?> beanClass, String properties) {
         super.beanPropertiesExcludes(beanClass, properties);
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder beanPropertiesExcludes(Map<String,Object> values) {
         super.beanPropertiesExcludes(values);
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder beanPropertiesExcludes(String beanClassName, String properties) {
         super.beanPropertiesExcludes(beanClassName, properties);
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder beanPropertiesReadOnly(Class<?> beanClass, String properties) {
         super.beanPropertiesReadOnly(beanClass, properties);
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder beanPropertiesReadOnly(Map<String,Object> values) {
         super.beanPropertiesReadOnly(values);
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder beanPropertiesReadOnly(String beanClassName, String properties) {
         super.beanPropertiesReadOnly(beanClassName, properties);
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder beanPropertiesWriteOnly(Class<?> beanClass, String properties) {
         super.beanPropertiesWriteOnly(beanClass, properties);
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder beanPropertiesWriteOnly(Map<String,Object> values) {
         super.beanPropertiesWriteOnly(values);
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder beanPropertiesWriteOnly(String beanClassName, String properties) {
         super.beanPropertiesWriteOnly(beanClassName, properties);
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder beansRequireDefaultConstructor() {
         super.beansRequireDefaultConstructor();
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder beansRequireSerializable() {
         super.beansRequireSerializable();
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder beansRequireSettersForGetters() {
         super.beansRequireSettersForGetters();
         return this;
      }

      @Override /* Overridden from Context.Builder */
      public UonParser build() {
         return cache(CACHE).build(UonParser.class);
      }

      @Override /* Overridden from Builder */
      public Builder cache(Cache<HashKey,? extends org.apache.juneau.Context> value) {
         super.cache(value);
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder consumes(String value) {
         super.consumes(value);
         return this;
      }

      @Override /* Overridden from Context.Builder */
      public Builder copy() {
         return new Builder(this);
      }

      @Override /* Overridden from Builder */
      public Builder debug() {
         super.debug();
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder debug(boolean value) {
         super.debug(value);
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder debugOutputLines(int value) {
         super.debugOutputLines(value);
         return this;
      }

      /**
       * Decode <js>"%xx"</js> sequences.
       *
       * <p>
       * When enabled, URI encoded characters will be decoded.  Otherwise it's assumed that they've already been decoded
       * before being passed to this parser.
       *
       * <h5 class='section'>Example:</h5>
       * <p class='bjava'>
       *    <jc>// Create a decoding UON parser.</jc>
       *    ReaderParser <jv>parser</jv> = UonParser.
       *       .<jsm>create</jsm>()
       *       .decoding()
       *       .build();
       *
       *  <jc>// Produces: ["foo bar", "baz quz"].</jc>
       *    String[] <jv>foo</jv> = <jv>parser</jv>.parse(<js>"@(foo%20bar,baz%20qux)"</js>, String[].<jk>class</jk>);
       * </p>
       *
       * @return This object.
       */
      public Builder decoding() {
         return decoding(true);
      }

      /**
       * Same as {@link #decoding()} but allows you to explicitly specify the value.
       *
       * @param value The value for this setting.
       * @return This object.
       */
      public Builder decoding(boolean value) {
         decoding = value;
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder dictionaryOn(Class<?> on, java.lang.Class<?>...values) {
         super.dictionaryOn(on, values);
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder disableBeansRequireSomeProperties() {
         super.disableBeansRequireSomeProperties();
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder disableIgnoreMissingSetters() {
         super.disableIgnoreMissingSetters();
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder disableIgnoreTransientFields() {
         super.disableIgnoreTransientFields();
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder disableIgnoreUnknownNullBeanProperties() {
         super.disableIgnoreUnknownNullBeanProperties();
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder disableInterfaceProxies() {
         super.disableInterfaceProxies();
         return this;
      }

      @Override /* Overridden from Builder */
      public <T> Builder example(Class<T> pojoClass, String json) {
         super.example(pojoClass, json);
         return this;
      }

      @Override /* Overridden from Builder */
      public <T> Builder example(Class<T> pojoClass, T o) {
         super.example(pojoClass, o);
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder fileCharset(Charset value) {
         super.fileCharset(value);
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder findFluentSetters() {
         super.findFluentSetters();
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder findFluentSetters(Class<?> on) {
         super.findFluentSetters(on);
         return this;
      }

      @Override /* Overridden from Context.Builder */
      public HashKey hashKey() {
         // @formatter:off
         return HashKey.of(
            super.hashKey(),
            decoding,
            validateEnd
         );
         // @formatter:on
      }

      @Override /* Overridden from Builder */
      public Builder ignoreInvocationExceptionsOnGetters() {
         super.ignoreInvocationExceptionsOnGetters();
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder ignoreInvocationExceptionsOnSetters() {
         super.ignoreInvocationExceptionsOnSetters();
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder ignoreUnknownBeanProperties() {
         super.ignoreUnknownBeanProperties();
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder ignoreUnknownEnumValues() {
         super.ignoreUnknownEnumValues();
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder impl(Context value) {
         super.impl(value);
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder implClass(Class<?> interfaceClass, Class<?> implClass) {
         super.implClass(interfaceClass, implClass);
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder implClasses(Map<Class<?>,Class<?>> values) {
         super.implClasses(values);
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder interfaceClass(Class<?> on, Class<?> value) {
         super.interfaceClass(on, value);
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder interfaces(java.lang.Class<?>...value) {
         super.interfaces(value);
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder listener(Class<? extends org.apache.juneau.parser.ParserListener> value) {
         super.listener(value);
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder locale(Locale value) {
         super.locale(value);
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder mediaType(MediaType value) {
         super.mediaType(value);
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder notBeanClasses(java.lang.Class<?>...values) {
         super.notBeanClasses(values);
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder notBeanPackages(String...values) {
         super.notBeanPackages(values);
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder propertyNamer(Class<?> on, Class<? extends org.apache.juneau.PropertyNamer> value) {
         super.propertyNamer(on, value);
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder propertyNamer(Class<? extends org.apache.juneau.PropertyNamer> value) {
         super.propertyNamer(value);
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder sortProperties() {
         super.sortProperties();
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder sortProperties(java.lang.Class<?>...on) {
         super.sortProperties(on);
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder stopClass(Class<?> on, Class<?> value) {
         super.stopClass(on, value);
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder streamCharset(Charset value) {
         super.streamCharset(value);
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder strict() {
         super.strict();
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder strict(boolean value) {
         super.strict(value);
         return this;
      }

      @Override /* Overridden from Builder */
      public <T,S> Builder swap(Class<T> normalClass, Class<S> swappedClass, ThrowingFunction<T,S> swapFunction) {
         super.swap(normalClass, swappedClass, swapFunction);
         return this;
      }

      @Override /* Overridden from Builder */
      public <T,S> Builder swap(Class<T> normalClass, Class<S> swappedClass, ThrowingFunction<T,S> swapFunction, ThrowingFunction<S,T> unswapFunction) {
         super.swap(normalClass, swappedClass, swapFunction, unswapFunction);
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder swaps(Class<?>...values) {
         super.swaps(values);
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder swaps(Object...values) {
         super.swaps(values);
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder timeZone(TimeZone value) {
         super.timeZone(value);
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder trimStrings() {
         super.trimStrings();
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder trimStrings(boolean value) {
         super.trimStrings(value);
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder type(Class<? extends org.apache.juneau.Context> value) {
         super.type(value);
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder typeName(Class<?> on, String value) {
         super.typeName(on, value);
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder typePropertyName(Class<?> on, String value) {
         super.typePropertyName(on, value);
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder typePropertyName(String value) {
         super.typePropertyName(value);
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder unbuffered() {
         super.unbuffered();
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder unbuffered(boolean value) {
         super.unbuffered(value);
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder useEnumNames() {
         super.useEnumNames();
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder useJavaBeanIntrospector() {
         super.useJavaBeanIntrospector();
         return this;
      }

      /**
       * Validate end.
       *
       * <p>
       * When enabled, after parsing a POJO from the input, verifies that the remaining input in
       * the stream consists of only comments or whitespace.
       *
       * <h5 class='section'>Example:</h5>
       * <p class='bjava'>
       *    <jc>// Create a parser using strict mode.</jc>
       *    ReaderParser <jv>parser</jv> = UonParser.
       *       .<jsm>create</jsm>()
       *       .validateEnd()
       *       .build();
       *
       *    <jc>// Should fail because input has multiple POJOs.</jc>
       *    String <jv>in</jv> = <js>"(foo=bar)(baz=qux)"</js>;
       *    MyBean <jv>myBean</jv> = <jv>parser</jv>.parse(<jv>in</jv>, MyBean.<jk>class</jk>);
       * </p>
       *
       * @return This object.
       */
      public Builder validateEnd() {
         return validateEnd(true);
      }

      /**
       * Same as {@link #validateEnd()} but allows you to explicitly specify the value.
       *
       * @param value The value for this setting.
       * @return This object.
       */
      public Builder validateEnd(boolean value) {
         validateEnd = value;
         return this;
      }
   }

   /** Default parser, decoding. */
   public static class Decoding extends UonParser {

      /**
       * Constructor.
       *
       * @param builder The builder for this object.
       */
      public Decoding(Builder builder) {
         super(builder.decoding());
      }
   }

   /** Reusable instance of {@link UonParser}, all default settings. */
   public static final UonParser DEFAULT = new UonParser(create());
   /** Reusable instance of {@link UonParser} with decodeChars set to true. */
   public static final UonParser DEFAULT_DECODING = new UonParser.Decoding(create());

   /**
    * Creates a new builder for this object.
    *
    * @return A new builder.
    */
   public static Builder create() {
      return new Builder();
   }

   protected final boolean decoding;
   protected final boolean validateEnd;

   private final Map<BeanPropertyMeta,UonBeanPropertyMeta> uonBeanPropertyMetas = new ConcurrentHashMap<>();
   private final Map<ClassMeta<?>,UonClassMeta> uonClassMetas = new ConcurrentHashMap<>();

   /**
    * Constructor.
    *
    * @param builder The builder for this object.
    */
   public UonParser(Builder builder) {
      super(builder);
      decoding = builder.decoding;
      validateEnd = builder.validateEnd;
   }

   @Override /* Overridden from Context */
   public Builder copy() {
      return new Builder(this);
   }

   @Override /* Overridden from Context */
   public UonParserSession.Builder createSession() {
      return UonParserSession.create(this);
   }

   @Override
   public <T> ClassMeta<T> getClassMeta(Class<T> c) {
      return getBeanContext().getClassMeta(c);
   }

   @Override
   public <T> ClassMeta<T> getClassMeta(Type t, Type...args) {
      return getBeanContext().getClassMeta(t, args);
   }

   @Override /* Overridden from HttpPartParser */
   public UonParserSession getPartSession() { return UonParserSession.create(this).build(); }

   @Override /* Overridden from Context */
   public UonParserSession getSession() { return createSession().build(); }

   @Override /* Overridden from UonMetaProvider */
   public UonBeanPropertyMeta getUonBeanPropertyMeta(BeanPropertyMeta bpm) {
      if (bpm == null)
         return UonBeanPropertyMeta.DEFAULT;
      UonBeanPropertyMeta m = uonBeanPropertyMetas.get(bpm);
      if (m == null) {
         m = new UonBeanPropertyMeta(bpm.getDelegateFor(), this);
         uonBeanPropertyMetas.put(bpm, m);
      }
      return m;
   }

   @Override /* Overridden from UonMetaProvider */
   public UonClassMeta getUonClassMeta(ClassMeta<?> cm) {
      UonClassMeta m = uonClassMetas.get(cm);
      if (m == null) {
         m = new UonClassMeta(cm, this);
         uonClassMetas.put(cm, m);
      }
      return m;
   }

   /**
    * Converts the specified input to the specified class type.
    *
    * @param <T> The POJO type to transform the input into.
    * @param partType The part type being parsed.
    * @param schema
    *    Schema information about the part.
    *    <br>May be <jk>null</jk>.
    *    <br>Not all part parsers use the schema information.
    * @param in The input being parsed.
    * @param toType The POJO type to transform the input into.
    * @return The parsed value.
    * @throws ParseException Malformed input encountered.
    * @throws SchemaValidationException If the input or resulting HTTP part object fails schema validation.
    */
   public <T> T parse(HttpPartType partType, HttpPartSchema schema, String in, Class<T> toType) throws ParseException, SchemaValidationException {
      return getPartSession().parse(partType, schema, in, getClassMeta(toType));
   }

   /**
    * Converts the specified input to the specified class type.
    *
    * @param <T> The POJO type to transform the input into.
    * @param partType The part type being parsed.
    * @param schema
    *    Schema information about the part.
    *    <br>May be <jk>null</jk>.
    *    <br>Not all part parsers use the schema information.
    * @param in The input being parsed.
    * @param toType The POJO type to transform the input into.
    * @return The parsed value.
    * @throws ParseException Malformed input encountered.
    * @throws SchemaValidationException If the input or resulting HTTP part object fails schema validation.
    */
   public <T> T parse(HttpPartType partType, HttpPartSchema schema, String in, ClassMeta<T> toType) throws ParseException, SchemaValidationException {
      return getPartSession().parse(partType, schema, in, toType);
   }

   /**
    * Converts the specified input to the specified class type.
    *
    * @param <T> The POJO type to transform the input into.
    * @param partType The part type being parsed.
    * @param schema
    *    Schema information about the part.
    *    <br>May be <jk>null</jk>.
    *    <br>Not all part parsers use the schema information.
    * @param in The input being parsed.
    * @param toType The POJO type to transform the input into.
    * @param toTypeArgs The generic type arguments of the POJO type to transform the input into.
    * @return The parsed value.
    * @throws ParseException Malformed input encountered.
    * @throws SchemaValidationException If the input or resulting HTTP part object fails schema validation.
    */
   public <T> T parse(HttpPartType partType, HttpPartSchema schema, String in, Type toType, Type...toTypeArgs) throws ParseException, SchemaValidationException {
      return getPartSession().parse(partType, schema, in, getClassMeta(toType, toTypeArgs));
   }

   /**
    * Decode <js>"%xx"</js> sequences enabled
    *
    * @see Builder#decoding()
    * @return
    *    <jk>true</jk> if URI encoded characters should be decoded, <jk>false</jk> if they've already been decoded
    *    before being passed to this parser.
    */
   protected final boolean isDecoding() { return decoding; }

   /**
    * Validate end enabled.
    *
    * @see Builder#validateEnd()
    * @return
    *    <jk>true</jk> if after parsing a POJO from the input, verifies that the remaining input in
    *    the stream consists of only comments or whitespace.
    */
   protected final boolean isValidateEnd() { return validateEnd; }

   @Override /* Overridden from ReaderParser */
   protected FluentMap<String,Object> properties() {
      return super.properties()
         .a("decoding", decoding)
         .a("validateEnd", validateEnd);
   }
}