/*
 * Copyright (c) 2021-2022 Huawei Device Co., Ltd.
 * 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.
 */
#ifndef OHOS_GLOBAL_I18N_PREFERRED_LANGUAGE_H
#define OHOS_GLOBAL_I18N_PREFERRED_LANGUAGE_H

#include <set>
#include <string>
#include <vector>
#include "i18n_types.h"
#ifdef SUPPORT_APP_PREFERRED_LANGUAGE
#include "preferences_helper.h"
#endif

namespace OHOS {
namespace Global {
namespace I18n {
class PreferredLanguage {
public:
    /**
     * @brief Add language to system preferred language list on index.
     *
     * @param language Indicates language tag to add.
     * @param index Indicates position to add.
     * @return I18nErrorCode Return SUCCESS indicates that the add operation was successful.
     */
    static I18nErrorCode AddPreferredLanguage(const std::string &language, int32_t index);

    /**
     * @brief Remove language from system preferred language list on index.
     *
     * @param index Indicates position to remove.
     * @return I18nErrorCode Return SUCCESS indicates that the add operation was successful.
     */
    static I18nErrorCode RemovePreferredLanguage(int32_t index);
    static std::vector<std::string> GetPreferredLanguageList();
    static std::string GetFirstPreferredLanguage();
#ifdef SUPPORT_APP_PREFERRED_LANGUAGE
    /**
     * @brief Get App Language.
     * Get the app language from app preferences data which saved by SetAppPreferredLanguage method.
     *
     * @return std::string return current app language.
     */
    static std::string GetAppPreferredLanguage();

    /**
     * @brief check App Language.
     * Check whether the preferred language is set for the app.
     *
     * @return bool return whether preferred language is set.
     */
    static bool IsSetAppPreferredLanguage();

    /**
     * @brief Set App Language.
     * The application interface will be refreshed in real time after call this method. And the language will be saved
     * to app preferences data which will be used the next time the application starts.
     *
     * @param language language to be set.
     * @param errCode Indicates whether the setting was successful; errCode == I18nErrorCode::SUCCESS means successful.
     */
    static void SetAppPreferredLanguage(const std::string &language, I18nErrorCode &errCode);
#endif
    static std::string GetPreferredLocale();

private:
    static bool IsValidLanguage(const std::string &language);
    static bool IsValidTag(const std::string &tag);
    static void Split(const std::string &src, const std::string &sep, std::vector<std::string> &dest);
#ifdef SUPPORT_APP_PREFERRED_LANGUAGE
    static std::shared_ptr<NativePreferences::Preferences> GetI18nAppPreferences();
#endif
    /**
     * @brief Filtering the language list.
     *
     * @param preferredLanguagesList Indicates list of languages to be filtered.
     * @return vector Return list of supported languages.
     */
    static std::vector<std::string> FilterLanguages(std::vector<std::string>& preferredLanguagesList);

    /**
     * @brief Match the language to the supported language.
     *
     * @param language Indicates language code to be matched.
     * @return string Return matching result.
     */
    static std::string GetMatchedLanguage(const std::string& language);

    /**
     * @brief Normalize index to target range [0, max].
     *
     * @param index Indicates value to normalize.
     * @param max Indicates the max value of range.
     * @return int32_t Return normalized index.
     */
    static int32_t NormalizeIndex(int32_t index, int32_t max);

    /**
     * @brief Find the language index in system preferred language list.
     *
     * @param language Indicates language tag to find.
     * @return int32_t Return index of language in system preferred language list.
     */
    static int32_t FindLanguage(const std::string &language);

    /**
     * @brief Add language to position index of system preferred language list when language is not in list.
     *
     * @param language Indicates language tag to add.
     * @param index Indicates position to add.
     * @param preferredLanguages Indicates system preferred language list after inserting language.
     * @param errCode Indicates whether the add operation was successful.
     */
    static void AddNonExistPreferredLanguage(const std::string& language, int32_t index,
        std::vector<std::string> &preferredLanguages, I18nErrorCode &errCode);

    /**
     * @brief Add language to position index of system preferred language list when language is in list.
     *
     * @param language Indicates language tag to add.
     * @param index Indicates position to add.
     * @param preferredLanguages Indicates system preferred language list after inserting language.
     * @param errCode Indicates whether the add operation was successful.
     */
    static void AddExistPreferredLanguage(const std::string& language, int32_t index,
        std::vector<std::string> &preferredLanguages, I18nErrorCode &errCode);

    /**
     * @brief combin preferred language list to string.
     *
     * @param preferredLanguages Indicates preferred language list.
     * @return string Return Indicates the joined preferred languages.
     */
    static std::string JoinPreferredLanguages(const std::vector<std::string> preferredLanguages);

    /**
     * @brief Set the Preferred Languages to System parameter.
     *
     * @param preferredLanguages Indicates preferreder languages.
     * @return I18nErrorCode Return SUCCESS indicates that the add operation was successful.
     */
    static I18nErrorCode SetPreferredLanguages(const std::string &preferredLanguages);
    static const char *RESOURCE_PATH_HEAD;
    static const char *RESOURCE_PATH_TAILOR;
    static const char *RESOURCE_PATH_SPLITOR;
    static const char *PREFERRED_LANGUAGES;
    static const char *APP_LANGUAGE_KEY;
    static const char *I18N_PREFERENCES_FILE_NAME;
    static const char *DEFAULT_PREFERRED_LANGUAGE;
    static std::vector<std::string> supportLanguageListExt;
    static constexpr int CONFIG_LEN = 128;
    static constexpr uint32_t LANGUAGE_LEN = 2;
};
} // namespace I18n
} // namespace Global
} // namespace OHOS
#endif