// **********************************************************************
//
// Copyright (c) 2003-2017 ZeroC, Inc. All rights reserved.
//
// This copy of Ice is licensed to you under the terms described in the
// ICE_LICENSE file included in this distribution.
//
// **********************************************************************

#ifndef ICE_UTIL_STRING_UTIL_H
#define ICE_UTIL_STRING_UTIL_H

#include <IceUtil/Config.h>
#include <vector>

namespace IceUtilInternal
{

//
// Must be kept in sync with Ice::ToStringMode
//
#ifdef ICE_CPP11_MAPPING
enum class ToStringMode : unsigned char
#else
enum ToStringMode
#endif
{ Unicode, ASCII, Compat };

//
// Add escape sequences (like "\n", or "\123") to the input string
// (first parameter).
// The second parameter adds characters to escape, and can be empty.
//
ICE_API std::string escapeString(const std::string&, const std::string&, ToStringMode);

//
// Remove escape sequences added by escapeString. Throws IllegalArgumentException
// for an invalid input string.
//
ICE_API std::string unescapeString(const std::string&, std::string::size_type, std::string::size_type, const std::string&);

//
// Split a string using the given delimiters. Considers single and double quotes;
// returns false for unbalanced quote, true otherwise.
//
ICE_API bool splitString(const std::string&, const std::string&, std::vector<std::string>&);

//
// Join a list of strings using the given delimiter.
//
ICE_API std::string joinString(const std::vector<std::string>&, const std::string&);

//
// Trim white space
//
ICE_API std::string trim(const std::string&);

//
// If a single or double quotation mark is found at the start
// position, then the position of the matching closing quote is
// returned. If no quotation mark is found at the start position, then
// 0 is returned. If no matching closing quote is found, then
// std::string::npos is returned.
//
ICE_API std::string::size_type checkQuote(const std::string&, std::string::size_type = 0);

//
// Match `s' against the pattern `pat'. A * in the pattern acts
// as a wildcard: it matches any non-empty sequence of characters
// other than a period (`.'). We match by hand here because
// it's portable across platforms (whereas regex() isn't).
//
ICE_API bool match(const std::string&, const std::string&, bool = false);

//
// Get the error message for the last error code or given error code.
//
ICE_API std::string lastErrorToString();
#ifdef _WIN32
ICE_API std::string errorToString(int, LPCVOID = ICE_NULLPTR);
#else
ICE_API std::string errorToString(int);
#endif

//
// Functions to convert to lower/upper case. These functions accept
// UTF8 string/characters but ignore non ASCII characters. Unlike, the
// C methods, these methods are not local dependent.
//
ICE_API std::string toLower(const std::string&);
ICE_API std::string toUpper(const std::string&);
ICE_API bool isAlpha(char);
ICE_API bool isDigit(char);

//
// Remove all whitespace from a string
//
ICE_API std::string removeWhitespace(const std::string&);

}

#endif
