/*

 * Copyright (c) 2012, 2013, Oracle and/or its affiliates. All rights reserved.

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

 *

 * This code is free software; you can redistribute it and/or modify it

 * under the terms of the GNU General Public License version 2 only, as

 * published by the Free Software Foundation.  Oracle designates this

 * particular file as subject to the "Classpath" exception as provided

 * by Oracle in the LICENSE file that accompanied this code.

 *

 * This code is distributed in the hope that it will be useful, but WITHOUT

 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

 * version 2 for more details (a copy is included in the LICENSE file that

 * accompanied this code).

 *

 * You should have received a copy of the GNU General Public License version

 * 2 along with this work; if not, write to the Free Software Foundation,

 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

 *

 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA

 * or visit www.oracle.com if you need additional information or have any

 * questions.

 */

/*

 * Copyright (c) 2012, Stephen Colebourne & Michael Nascimento Santos

 *

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

 *

 *  * Neither the name of JSR-310 nor the names of its contributors

 *    may be used to endorse or promote products derived from this software

 *    without specific prior written permission.

 *

 * 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 OWNER 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 java.time.chrono;

import static java.time.temporal.ChronoField.EPOCH_DAY;

import java.io.IOException;

import java.io.Serializable;

import java.text.ParseException;

import java.time.Clock;

import java.time.DateTimeException;

import java.time.Instant;

import java.time.LocalDate;

import java.time.ZoneId;

import java.time.temporal.ChronoField;

import java.time.temporal.TemporalAccessor;

import java.time.temporal.ValueRange;

import java.util.Arrays;

import java.util.HashMap;

import java.util.List;

import java.util.Locale;

/**

 * The Hijrah calendar system.

 * <p>

 * This chronology defines the rules of the Hijrah calendar system.

 * <p>

 * The implementation follows the Freeman-Grenville algorithm (*1) and has following features.

 * <p><ul>

 * <li>A year has 12 months.</li>

 * <li>Over a cycle of 30 years there are 11 leap years.</li>

 * <li>There are 30 days in month number 1, 3, 5, 7, 9, and 11,

 * and 29 days in month number 2, 4, 6, 8, 10, and 12.</li>

 * <li>In a leap year month 12 has 30 days.</li>

 * <li>In a 30 year cycle, year 2, 5, 7, 10, 13, 16, 18, 21, 24,

 * 26, and 29 are leap years.</li>

 * <li>Total of 10631 days in a 30 years cycle.</li>

 * </ul><p>

 * <P>

 * The table shows the features described above.

 * <blockquote>

 * <table border="1">

 *   <caption>Hijrah Calendar Months</caption>

 *   <tbody>

 *     <tr>

 *       <th># of month</th>

 *       <th>Name of month</th>

 *       <th>Number of days</th>

 *     </tr>

 *     <tr>

 *       <td>1</td>

 *       <td>Muharram</td>

 *       <td>30</td>

 *     </tr>

 *     <tr>

 *       <td>2</td>

 *       <td>Safar</td>

 *       <td>29</td>

 *     </tr>

 *     <tr>

 *       <td>3</td>

 *       <td>Rabi'al-Awwal</td>

 *       <td>30</td>

 *     </tr>

 *     <tr>

 *       <td>4</td>

 *       <td>Rabi'ath-Thani</td>

 *       <td>29</td>

 *     </tr>

 *     <tr>

 *       <td>5</td>

 *       <td>Jumada l-Ula</td>

 *       <td>30</td>

 *     </tr>

 *     <tr>

 *       <td>6</td>

 *       <td>Jumada t-Tania</td>

 *       <td>29</td>

 *     </tr>

 *     <tr>

 *       <td>7</td>

 *       <td>Rajab</td>

 *       <td>30</td>

 *     </tr>

 *     <tr>

 *       <td>8</td>

 *       <td>Sha`ban</td>

 *       <td>29</td>

 *     </tr>

 *     <tr>

 *       <td>9</td>

 *       <td>Ramadan</td>

 *       <td>30</td>

 *     </tr>

 *     <tr>

 *       <td>10</td>

 *       <td>Shawwal</td>

 *       <td>29</td>

 *     </tr>

 *     <tr>

 *       <td>11</td>

 *       <td>Dhu 'l-Qa`da</td>

 *       <td>30</td>

 *     </tr>

 *     <tr>

 *       <td>12</td>

 *       <td>Dhu 'l-Hijja</td>

 *       <td>29, but 30 days in years 2, 5, 7, 10,<br>

 * 13, 16, 18, 21, 24, 26, and 29</td>

 *     </tr>

 *   </tbody>

 * </table>

 * </blockquote>

 * <p>

 * (*1) The algorithm is taken from the book,

 * The Muslim and Christian Calendars by G.S.P. Freeman-Grenville.

 * <p>

 *

 * <h3>Specification for implementors</h3>

 * This class is immutable and thread-safe.

 *

 * @since 1.8

 */

public final class HijrahChronology extends Chronology implements Serializable {

    /**

     * The Hijrah Calendar id.

     */

    private final String typeId;

    /**

     * The Hijrah calendarType.

     */

    private final String calendarType;

    /**

     * The singleton instance for the era before the current one - Before Hijrah -

     * which has the value 0.

     */

    public static final Era ERA_BEFORE_AH = HijrahEra.BEFORE_AH;

    /**

     * The singleton instance for the current era - Hijrah - which has the value 1.

     */

    public static final Era ERA_AH = HijrahEra.AH;

    /**

     * Serialization version.

     */

    private static final long serialVersionUID = 3127340209035924785L;

    /**

     * The minimum valid year-of-era.

     */

    public static final int MIN_YEAR_OF_ERA = 1;

    /**

     * The maximum valid year-of-era.

     * This is currently set to 9999 but may be changed to increase the valid range

     * in a future version of the specification.

     */

    public static final int MAX_YEAR_OF_ERA = 9999;

    /**

     * Number of Gregorian day of July 19, year 622 (Gregorian), which is epoch day

     * of Hijrah calendar.

     */

    private static final int HIJRAH_JAN_1_1_GREGORIAN_DAY = -492148;

    /**

     * 0-based, for number of day-of-year in the beginning of month in normal

     * year.

     */

    private static final int NUM_DAYS[] =

        {0, 30, 59, 89, 118, 148, 177, 207, 236, 266, 295, 325};

    /**

     * 0-based, for number of day-of-year in the beginning of month in leap year.

     */

    private static final int LEAP_NUM_DAYS[] =

        {0, 30, 59, 89, 118, 148, 177, 207, 236, 266, 295, 325};

    /**

     * 0-based, for day-of-month in normal year.

     */

    private static final int MONTH_LENGTH[] =

        {30, 29, 30, 29, 30, 29, 30, 29, 30, 29, 30, 29};

    /**

     * 0-based, for day-of-month in leap year.

     */

    private static final int LEAP_MONTH_LENGTH[] =

        {30, 29, 30, 29, 30, 29, 30, 29, 30, 29, 30, 30};

    /**

     * <pre>

     *                            Greatest       Least

     * Field name        Minimum   Minimum     Maximum     Maximum

     * ----------        -------   -------     -------     -------

     * ERA                     0         0           1           1

     * YEAR_OF_ERA             1         1        9999        9999

     * MONTH_OF_YEAR           1         1          12          12

     * DAY_OF_MONTH            1         1          29          30

     * DAY_OF_YEAR             1         1         354         355

     * </pre>

     *

     * Minimum values.

     */

    private static final int MIN_VALUES[] =

        {

        0,

        MIN_YEAR_OF_ERA,

        0,

        1,

        0,

        1,

        1

        };

    /**

     * Least maximum values.

     */

    private static final int LEAST_MAX_VALUES[] =

        {

        1,

        MAX_YEAR_OF_ERA,

        11,

        51,

        5,

        29,

        354

        };

    /**

     * Maximum values.

     */

    private static final int MAX_VALUES[] =

        {

        1,

        MAX_YEAR_OF_ERA,

        11,

        52,

        6,

        30,

        355

        };

   /**

     * Position of day-of-month. This value is used to get the min/max value

     * from an array.

     */

    private static final int POSITION_DAY_OF_MONTH = 5;

    /**

     * Position of day-of-year. This value is used to get the min/max value from

     * an array.

     */

    private static final int POSITION_DAY_OF_YEAR = 6;

    /**

     * Zero-based start date of cycle year.

     */

    private static final int CYCLEYEAR_START_DATE[] =

        {

        0,

        354,

        709,

        1063,

        1417,

        1772,

        2126,

        2481,

        2835,

        3189,

        3544,

        3898,

        4252,

        4607,

        4961,

        5315,

        5670,

        6024,

        6379,

        6733,

        7087,

        7442,

        7796,

        8150,

        8505,

        8859,

        9214,

        9568,

        9922,

        10277

        };

    /**

     * Holding the adjusted month days in year. The key is a year (Integer) and

     * the value is the all the month days in year (int[]).

     */

    private final HashMap<Integer, int[]> ADJUSTED_MONTH_DAYS = new HashMap<>();

    /**

     * Holding the adjusted month length in year. The key is a year (Integer)

     * and the value is the all the month length in year (int[]).

     */

    private final HashMap<Integer, int[]> ADJUSTED_MONTH_LENGTHS = new HashMap<>();

    /**

     * Holding the adjusted days in the 30 year cycle. The key is a cycle number

     * (Integer) and the value is the all the starting days of the year in the

     * cycle (int[]).

     */

    private final HashMap<Integer, int[]> ADJUSTED_CYCLE_YEARS = new HashMap<>();

    /**

     * Holding the adjusted cycle in the 1 - 30000 year. The key is the cycle

     * number (Integer) and the value is the starting days in the cycle in the

     * term.

     */

    private final long[] ADJUSTED_CYCLES;

    /**

     * Holding the adjusted min values.

     */

    private final int[] ADJUSTED_MIN_VALUES;

    /**

     * Holding the adjusted max least max values.

     */

    private final int[] ADJUSTED_LEAST_MAX_VALUES;

    /**

     * Holding adjusted max values.

     */

    private final int[] ADJUSTED_MAX_VALUES;

    /**

     * Holding the non-adjusted month days in year for non leap year.

     */

    private static final int[] DEFAULT_MONTH_DAYS;

    /**

     * Holding the non-adjusted month days in year for leap year.

     */

    private static final int[] DEFAULT_LEAP_MONTH_DAYS;

    /**

     * Holding the non-adjusted month length for non leap year.

     */

    private static final int[] DEFAULT_MONTH_LENGTHS;

    /**

     * Holding the non-adjusted month length for leap year.

     */

    private static final int[] DEFAULT_LEAP_MONTH_LENGTHS;

    /**

     * Holding the non-adjusted 30 year cycle starting day.

     */

    private static final int[] DEFAULT_CYCLE_YEARS;

    /**

     * number of 30-year cycles to hold the deviation data.

     */

    private static final int MAX_ADJUSTED_CYCLE = 334; // to support year 9999

    /**

     * Narrow names for eras.

     */

    private static final HashMap<String, String[]> ERA_NARROW_NAMES = new HashMap<>();

    /**

     * Short names for eras.

     */

    private static final HashMap<String, String[]> ERA_SHORT_NAMES = new HashMap<>();

    /**

     * Full names for eras.

     */

    private static final HashMap<String, String[]> ERA_FULL_NAMES = new HashMap<>();

    /**

     * Fallback language for the era names.

     */

    private static final String FALLBACK_LANGUAGE = "en";

    /**

     * Singleton instance of the Hijrah chronology.

     * Must be initialized after the rest of the static initialization.

     */

    public static final HijrahChronology INSTANCE;

    /**

     * Name data.

     */

    static {

        ERA_NARROW_NAMES.put(FALLBACK_LANGUAGE, new String[]{"BH", "HE"});

        ERA_SHORT_NAMES.put(FALLBACK_LANGUAGE, new String[]{"B.H.", "H.E."});

        ERA_FULL_NAMES.put(FALLBACK_LANGUAGE, new String[]{"Before Hijrah", "Hijrah Era"});

        DEFAULT_MONTH_DAYS = Arrays.copyOf(NUM_DAYS, NUM_DAYS.length);

        DEFAULT_LEAP_MONTH_DAYS = Arrays.copyOf(LEAP_NUM_DAYS, LEAP_NUM_DAYS.length);

        DEFAULT_MONTH_LENGTHS = Arrays.copyOf(MONTH_LENGTH, MONTH_LENGTH.length);

        DEFAULT_LEAP_MONTH_LENGTHS = Arrays.copyOf(LEAP_MONTH_LENGTH, LEAP_MONTH_LENGTH.length);

        DEFAULT_CYCLE_YEARS = Arrays.copyOf(CYCLEYEAR_START_DATE, CYCLEYEAR_START_DATE.length);

        INSTANCE = new HijrahChronology();

        String extraCalendars = java.security.AccessController.doPrivileged(

            new sun.security.action.GetPropertyAction("java.time.chrono.HijrahCalendars"));

        if (extraCalendars != null) {

            try {

                // Split on whitespace

                String[] splits = extraCalendars.split("\\s");

                for (String cal : splits) {

                    if (!cal.isEmpty()) {

                        // Split on the delimiter between typeId "-" calendarType

                        String[] type = cal.split("-");

                        Chronology cal2 = new HijrahChronology(type[0], type.length > 1 ? type[1] : type[0]);

                    }

                }

            } catch (Exception ex) {

                // Log the error

                // ex.printStackTrace();

            }

        }

    }

    /**

     * Restricted constructor.

     */

    private HijrahChronology() {

        this("Hijrah", "islamicc");

    }

    /**

     * Constructor for name and type HijrahChronology.

     * @param id the id of the calendar

     * @param calendarType the calendar type

     */

    private HijrahChronology(String id, String calendarType) {

        this.typeId = id;

        this.calendarType = calendarType;

        ADJUSTED_CYCLES = new long[MAX_ADJUSTED_CYCLE];

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

            ADJUSTED_CYCLES[i] = (10631L * i);

        }

        // Initialize min values, least max values and max values.

        ADJUSTED_MIN_VALUES = Arrays.copyOf(MIN_VALUES, MIN_VALUES.length);

        ADJUSTED_LEAST_MAX_VALUES = Arrays.copyOf(LEAST_MAX_VALUES, LEAST_MAX_VALUES.length);

        ADJUSTED_MAX_VALUES = Arrays.copyOf(MAX_VALUES,MAX_VALUES.length);

        try {

            // Implicitly reads deviation data for this HijrahChronology.

            boolean any = HijrahDeviationReader.readDeviation(typeId, calendarType, this::addDeviationAsHijrah);

        } catch (IOException | ParseException e) {

            // do nothing. Log deviation config errors.

            //e.printStackTrace();

        }

    }

    /**

     * Resolve singleton.

     *

     * @return the singleton instance, not null

     */

    private Object readResolve() {

        return INSTANCE;

    }

    //-----------------------------------------------------------------------

    /**

     * Gets the ID of the chronology - 'Hijrah'.

     * <p>

     * The ID uniquely identifies the {@code Chronology}.

     * It can be used to lookup the {@code Chronology} using {@link #of(String)}.

     *

     * @return the chronology ID - 'Hijrah'

     * @see #getCalendarType()

     */

    @Override

    public String getId() {

        return typeId;

    }

    /**

     * Gets the calendar type of the underlying calendar system - 'islamicc'.

     * <p>

     * The calendar type is an identifier defined by the

     * <em>Unicode Locale Data Markup Language (LDML)</em> specification.

     * It can be used to lookup the {@code Chronology} using {@link #of(String)}.

     * It can also be used as part of a locale, accessible via

     * {@link Locale#getUnicodeLocaleType(String)} with the key 'ca'.