// SPDX-License-Identifier: LGPL-2.1-or-later
// SPDX-FileCopyrightText: 1998 Bernie Bright <bbright@bigpond.net.au>

/**
 * @file
 * @brief  String utilities
 */
 

#ifndef STRUTILS_H
#define STRUTILS_H

#include <simgear/compiler.h>

#include <string>
#include <vector>
#include <type_traits>
#include <cstdlib>
#include <cstdint>

typedef std::vector < std::string > string_list;

// forward decls
class SGGeod;

namespace simgear {
  namespace strutils {

	/**
	 * utf8ToLatin1() convert utf8 to latin, useful for accent character (i.e éâàîè...)
	 */
	std::string utf8ToLatin1( std::string & s_utf8 );

// 	/** 
// 	 * atof() wrapper for "string" type
// 	 */
// 	inline double
// 	atof( const string& str )
// 	{
// 	    return ::atof( str.c_str() );
// 	}

// 	/**
// 	 * atoi() wrapper for "string" type
// 	 */
// 	inline int
// 	atoi( const string& str )
// 	{
// 	    return ::atoi( str.c_str() );
// 	}

	/**
	 * Strip leading and/or trailing whitespace from s.
	 * @param s String to strip.
	 * @return The stripped string.
	 */
	std::string lstrip( const std::string& s );
	std::string rstrip( const std::string& s );
	std::string strip( const std::string& s );

    // [lr]find - find first left/right occurence of a single character, or one of characters from a set
    std::string::size_type lfind(const std::string& s, const char c);
    std::string::size_type rfind(const std::string& s, const char c);
    std::string::size_type lfind_any_of(const std::string& s, const std::string& chars);
    std::string::size_type rfind_any_of(const std::string& s, const std::string& chars);

    std::string makeStringSafeForPropertyName(const std::string& str);

    /**
         * Return a new string with any trailing \\r and \\n characters removed.
         * Typically useful to clean a CR-terminated line obtained from
         * std::getline() which, upon reading CRLF (\\r\\n), discards the Line
         * Feed character (\\n) but leaves the Carriage Return (\\r) in the
         * string.
         * @param s Input string
         * @return The cleaned string
         */
        std::string stripTrailingNewlines(const std::string& s);

	/**
         * Strip any trailing \\r and \\n characters from a string.
         * Should have slightly less overhead than stripTrailingNewlines().
         * @param s Input string (modified in-place)
         */
        void stripTrailingNewlines_inplace(std::string& s);

        /**
         * Right-padding of a string to a given length
         * @param s String to pad
         * @param length The total length of the resulting string
         * @param c The character to pad with
         * @return The padded string
         */
        std::string rpad( const std::string & s, size_t length, char c );

        /**
         * Left-padding of a string to a given length
         * @param s String to pad
         * @param length The total length of the resulting string
         * @param c The character to pad with
         * @return The padded string
         */
        std::string lpad( const std::string & s, size_t length, char c );

	/**
	 * Split a string into a words using 'sep' as the delimiter string.
	 * Produces a result similar to the perl and python functions of the
	 * same name.
	 * 
	 * @param s         The string to split into words
	 * @param sep       Word delimiters. If not specified then any whitespace is
	 *                  a separator
	 * @param maxsplit  If given, splits at no more than maxsplit places,
	 *                  resulting in at most maxsplit+1 words
	 * @return Array of words
	 */
	string_list
	split( const std::string& s,
	       const char* sep = 0,
	       int maxsplit = 0 );

      /**
       * Split a string on any of several characters. Commonly used to deal
       * with strings containing whitespace, newlines. To parse CSS style
       * string, use with '\\n\\t ,' as the separator list.
       *
       * @note Consecutive separators will not produce empty entries in the
       * the result, i.e splitting 'a,b,,c,d' with a ',' will produce a result
       * with four entries, not five.
       */
      string_list split_on_any_of(const std::string&, const char* seperators);

       /**
        * create a single string by joining the elements of a list with
        * another string.
        */
       std::string join(const string_list& l, const std::string& joinWith = "");

	/**
	 * Test if a string starts with a string 
	 *
	 * @param s The string to be tested
	 * @param substr The string to test
	 * @return True, if s starts with substr, False otherwise
	 */
	bool starts_with( const std::string & s, const std::string & substr );

	/**
	 * Test if a string ends with a string 
	 *
	 * @param s The string to be tested
	 * @param substr The string to test
	 * @return True, if s ends with substr, False otherwise
	 */
	bool ends_with( const std::string & s, const std::string & substr );
  
    /**
     * Strip all leading/trailing whitespace, and transform all interal
     * whitespace into a single ' ' character - i.e newlines/carriage returns/
     * tabs/multiple spaces will be condensed.
     */
    std::string simplify(const std::string& s);
    
    /**
     * convert a string representing a decimal number, to an int
     */
    int to_int(const std::string& s, int base = 10);

   /** Convert a char to the integer it represents in the specified BASE.
     *
     * Contrary to std::isdigit() and std::isxdigit(), only the standard ASCII
     * digits for BASE are accepted (with both uppercase and lowercase 'a'-'f'
     * letters for base 16). Throw sg_range_exception if the char is not a
     * valid digit for this base.
     *
     * See template specializations in strutils.cxx.
     */
    template<int BASE>
    int digitValue(char c);

    /** Return:
     *   - std::string("decimal") if BASE is 10;
     *   - std::string("hexadecimal") if BASE is 16.
     *
     * Template specializations in strutils.cxx.
     */
    template<int BASE>
    std::string numerationBaseAdjective();

    /** Convert a string representing an integer to an integral type.
     *
     * The input string must be non-empty and contain only digits of the
     * specified BASE (template parameter). Throw:
     *   - sg_format_exception if the input string doesn't respect these
     *     constraints;
     *   - sg_range_exception if the value can't be represented by type T
     *     (i.e., if it is too large).
     *
     * Explicit template instantiations are added as needed in strutils.cxx.
     * Have a look there and enable the ones you need!
     */
    template<
        class T,
        int BASE = 10,
        typename = typename std::enable_if<std::is_integral<T>::value, T>::type >
    T readNonNegativeInt(const std::string& s);

      
      /**
       * Read a time value, seperated by colons, as a value in hours.
       * Allowable input is ([+/-]%f[:%f[:%f]]) 
       * i.e 15:04:35 is parsed as 15 + (04 / 60) + (35 / 2600)
       * This code is moved from flightgear's options.cxx where it was called
       * parse_time(),
       */
      double readTime(const std::string& s);
      
    /**
     * Convert a string representing a boolean, to a bool.
     * Accepted values include YES, true, 0, 1, false, no, True,
     */
    bool to_bool(const std::string& s);

    /**
     * Check if given string is a boolean value ("true", "false", "1", "0", "yes" or "no")
     */
    bool is_bool(const std::string& s);

    /**
     * Compare dotted versions strings NN.NN.NN (analogous to strcmp())
     *
     * @note Any number of terms are supported.
     *
     * @param v1            First version
     * @param v2            Second version
     * @param maxComponents The maximum number of components to look at. This
     *                      can be used to ignore (say) the patch level by
     *                      setting it to 2
     * @return 0 if versions match,
     *         -ve number if @a v1 is lower,
     *         +ve if @a v1 is greater
     */
    int compare_versions( const std::string& v1,
                          const std::string& v2,
                          int maxComponents = 0 );

    /**
        @brief COmpare a version string to a template version string (which can contain wildcards)
     @param aVersion : a regular version such as 2017.6 or 2020.1.2
     @param aCandidate : a version specifier, eg 2020.* or 21.5.*
     */
    bool compareVersionToWildcard(const std::string& aVersion, const std::string& aCandidate);
  
    /**
     * Convert a string to upper case.
     * @return upper case string
     */
    std::string uppercase(const std::string &s);

   /**
    * Convert a string to lower case.
    * @return lower case string
    */
    std::string lowercase(const std::string& s);

    /**
       * case-insensitive string comparisom
       */
    bool iequals(const std::string& a, const std::string& b);
      
	/**
     * convert a string in the local Windows 8-bit encoding to UTF-8
     * (no-op on other platforms)
     */
    std::string convertWindowsLocal8BitToUtf8(const std::string& a);

      /**
       *
       */
      std::string convertUtf8ToWindowsLocal8Bit(const std::string& a);

    std::wstring convertUtf8ToWString(const std::string& a);
	std::string convertWStringToUtf8(const std::wstring& w);

    /**
     * Get md5 hash of raw data.
     */
    std::string md5(const unsigned char* data, size_t num);
    std::string md5(const char* data, size_t num);
    std::string md5(const std::string& str);

    /**
     * convert base-64 encoded data to raw bytes (possibly with embedded
     * NULs). Throws an exception if input data is not base64, or is
     * malformed
     */
      void decodeBase64(const std::string& a, std::vector<unsigned char>& output);

    /**
     * convert bytes to hexadecimal equivalent
     */
    std::string encodeHex(const std::string& bytes);

    std::string encodeHex(const unsigned char* rawBytes, unsigned int length);

  
    std::vector<uint8_t> decodeHex(const std::string& input);

    /**
     * Backslash-escape a string for C/C++ string literal syntax.
     *
     * @param s Input string.
     * @return a copy of the input string with proper escaping, so that if the
     *         result is part of a C or C++ file and enclosed in double
     *         quotes, it can be used to represent a string literal that is
     *         equal to the input string.
     *
     * @note For every std::string s: unescape(escape(s)) == s
     * @see unescape()
     */
    std::string escape(const std::string& s);

    /**
     * Unescape string.
     *
     * @param str String possibly containing escaped characters.
     * @return string with escaped characters replaced by single character
     *         values.
     *
     * @note For every std::string s: unescape(escape(s)) == s
     * @see escape()
     */
    std::string unescape(const char* str);

    inline std::string unescape(const std::string& str)
    { return unescape(str.c_str()); }

    /**
    * Replace matching elements of string.
    *
    * @param source source string
    * @param search search string
    * @param replace replacement string
    * @param start_pos starting position for replacement in source. Checked to ensure less than length of source.
    * @return string with all occurrences of search changed to replace
    */
    std::string replace(std::string source, const std::string search, const std::string replacement, std::size_t start_pos = 0);

    /**
       * Check a printf-style format string for dangerous (buffer-overflowing,
       * memory re-writing) format tokens. If a problematic token is
       * found, logs an error (SG_WARN) and returns an empty format string.
       */
      std::string sanitizePrintfFormat(const std::string& input);

    /**
     * Get the message corresponding to a given value of errno.
     *
     * Similar to strerror(), except it should be thread-safe and returns an
     * std::string.
     */
    std::string error_string(int errnum);


      /**
       * Match a property path, obtained from prop->getPath(), against a
       * template string. Templates are allowed to contain widlcards denoted by
       * an asterix in certain places - at the end of names, or inside indices.
       * Note that paths returned by getPath() always include an index on every
       * path component, so template strings should be structured accordingly.
       *
       * Examples: 
       *   /foo[*]/bar* will match /foo/barber, /foo[2]/bargain
       *   /views[0]/view[*]/f* will match /views[0]/view[99]/foo,
       *      /views[0]/view[4]/fig, /views[0]/view[1000]/flight
       */
      bool matchPropPathToTemplate(const std::string& path, const std::string& templatePath);
      
      bool parseStringAsLatLonValue(const std::string& s, double& result);
      
      /**
       * Attempt to parse a string as a latitude,longitude input. Returns true
       * or false based on success, and returns the SGGeod by pointer. Leading,
       * trailing and internal white-space is skipped / ignored.
       *
       * Supported formats:
       *   <signed decimal degrees latitude>,<signed decimal degress longitude>
       *   <unsigned decimal degrees>[NS],<unsigned decimal degrees>[EW]
       *   <degrees>*<decimal minutes>'[NS],<degrees>*<decimal minutes>'[EW]
       *
       * Latitude and longitude are parsed seperately so the formats for each
       * do not need to agree. Latitude is assumed to precede longitude
       * unless assumeLonLatOrder = true
       *
       * When NSEW characters are used, the order can be swapped and will be
       * fixed correctly (longitude then latitude).
       */
      bool parseStringAsGeod(const std::string& string,
                             SGGeod* result = nullptr,
                             bool assumeLonLatOrder = false);
      
      // enum values here correspond to existing lon-lat format codes inside
      // FlightGear (property: /sim/lon-lat-format )
      // Don't re-order, just add new ones, or things may break
      enum class LatLonFormat
      {
          DECIMAL_DEGREES = 0,          ///< 88.4N,4.54W,
          DEGREES_MINUTES,             ///< 88 24.6'N, 4 30.5'W
          DEGREES_MINUTES_SECONDS,
          SIGNED_DECIMAL_DEGREES,          ///< 88.4,-4.54
          SIGNED_DEGREES_MINUTES,
          SIGNED_DEGREES_MINUTES_SECONDS,
          ZERO_PAD_DECIMAL_DEGRESS,
          ZERO_PAD_DEGREES_MINUTES,
          ZERO_PAD_DEGREES_MINUTES_SECONDS,
          TRINITY_HOUSE,            ///< dd* mm'.mmm X, ddd* mm'.mmm X (Trinity House Navigation standard).
          DECIMAL_DEGREES_SYMBOL,        ///< 88.4*N,4.54*W
          ICAO_ROUTE_DEGREES,              ///< 52N045W or 5212N04512W - precision auto-selected
      };
      
      enum class DegreeSymbol
      {
          ASTERISK = 0,
          SPACE,
          LATIN1_DEGREE,
          UTF8_DEGREE
      };
      
      std::string formatLatLonValueAsString(double deg,
                                            LatLonFormat format, char c,
                                            DegreeSymbol degreeSymbol = DegreeSymbol::ASTERISK);

      /**
       * Format an SGGeod as a string according to the provided rule.
       * if the SGGeod is invalid (default constructed), will return an empty string
       */
      std::string formatGeodAsString(const SGGeod& geod,
                                     LatLonFormat format = LatLonFormat::DECIMAL_DEGREES,
                                     DegreeSymbol degreeSymbol = DegreeSymbol::ASTERISK);


      enum class PrintfFormatType {
          Invalid,
          Int,
          Long,
          Float,
          Double,
          CharPointer
      };

      PrintfFormatType validatePrintfFormat(const char* f);

  } // end namespace strutils
} // end namespace simgear

#endif // STRUTILS_H

