mirror of
https://git.lyx.org/repos/lyx.git
synced 2024-11-11 13:46:43 +00:00
8d06b3049b
git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@21544 a592a061-630c-0410-9148-cb99ea01b6c8
286 lines
8.3 KiB
C++
286 lines
8.3 KiB
C++
// -*- C++ -*-
|
|
/**
|
|
* \file lstrings.h
|
|
* This file is part of LyX, the document processor.
|
|
* Licence details can be found in the file COPYING.
|
|
*
|
|
* \author Lars Gullik Bjønnes
|
|
* \author Jean-Marc Lasgouttes
|
|
*
|
|
* Full author contact details are available in file CREDITS.
|
|
*
|
|
* A collection of string helper functions that works with string.
|
|
* Some of these would certainly benefit from a rewrite/optimization.
|
|
*/
|
|
|
|
#ifndef LSTRINGS_H
|
|
#define LSTRINGS_H
|
|
|
|
#include "support/docstring.h"
|
|
|
|
#include <cstring>
|
|
#include <vector>
|
|
|
|
|
|
namespace lyx {
|
|
namespace support {
|
|
|
|
/// Compare \p s and \p s2, ignoring the case.
|
|
/// Does not depend on the locale.
|
|
int compare_no_case(docstring const & s, docstring const & s2);
|
|
|
|
/// Compare \p s and \p s2, ignoring the case of ASCII characters only.
|
|
int compare_ascii_no_case(std::string const & s, std::string const & s2);
|
|
|
|
/// Compare \p s and \p s2, ignoring the case of ASCII characters only.
|
|
int compare_ascii_no_case(docstring const & s, docstring const & s2);
|
|
|
|
///
|
|
inline
|
|
int compare(char const * a, char const * b)
|
|
{
|
|
#ifndef CXX_GLOBAL_CSTD
|
|
return std::strcmp(a, b);
|
|
#else
|
|
return strcmp(a, b);
|
|
#endif
|
|
}
|
|
|
|
///
|
|
inline
|
|
int compare(char const * a, char const * b, unsigned int len)
|
|
{
|
|
#ifndef CXX_GLOBAL_CSTD
|
|
return std::strncmp(a, b, len);
|
|
#else
|
|
return strncmp(a, b, len);
|
|
#endif
|
|
}
|
|
|
|
///
|
|
bool isStrInt(std::string const & str);
|
|
|
|
/// does the std::string represent an unsigned integer value ?
|
|
bool isStrUnsignedInt(std::string const & str);
|
|
|
|
///
|
|
bool isStrDbl(std::string const & str);
|
|
|
|
bool isHex(docstring const & str);
|
|
|
|
int hexToInt(docstring const & str);
|
|
|
|
/// is \p str pure ascii?
|
|
bool isAscii(docstring const & str);
|
|
|
|
/// is \p str pure ascii?
|
|
bool isAscii(std::string const & str);
|
|
|
|
/**
|
|
* Changes the case of \p c to lowercase.
|
|
* Don't use this for non-ASCII characters, since it depends on the locale.
|
|
* This overloaded function is only implemented because the char_type variant
|
|
* would be used otherwise, and we assert in this function that \p c is in
|
|
* the ASCII range.
|
|
*/
|
|
char lowercase(char c);
|
|
|
|
/**
|
|
* Changes the case of \p c to uppercase.
|
|
* Don't use this for non-ASCII characters, since it depends on the locale.
|
|
* This overloaded function is only implemented because the char_type variant
|
|
* would be used otherwise, and we assert in this function that \p c is in
|
|
* the ASCII range.
|
|
*/
|
|
char uppercase(char c);
|
|
|
|
/// Changes the case of \p c to lowercase.
|
|
/// Does not depend on the locale.
|
|
char_type lowercase(char_type c);
|
|
|
|
/// Changes the case of \p c to uppercase.
|
|
/// Does not depend on the locale.
|
|
char_type uppercase(char_type c);
|
|
|
|
/// same as lowercase(), but ignores locale
|
|
std::string const ascii_lowercase(std::string const &);
|
|
docstring const ascii_lowercase(docstring const &);
|
|
|
|
/// Changes the case of \p s to lowercase.
|
|
/// Does not depend on the locale.
|
|
docstring const lowercase(docstring const & s);
|
|
|
|
/// Changes the case of \p s to uppercase.
|
|
/// Does not depend on the locale.
|
|
docstring const uppercase(docstring const & s);
|
|
|
|
/// Does the string start with this prefix?
|
|
bool prefixIs(docstring const &, char_type);
|
|
|
|
/// Does the std::string start with this prefix?
|
|
bool prefixIs(std::string const &, std::string const &);
|
|
bool prefixIs(docstring const &, docstring const &);
|
|
|
|
/// Does the string end with this char?
|
|
bool suffixIs(std::string const &, char);
|
|
bool suffixIs(docstring const &, char_type);
|
|
|
|
/// Does the std::string end with this suffix?
|
|
bool suffixIs(std::string const &, std::string const &);
|
|
|
|
///
|
|
inline bool contains(std::string const & a, std::string const & b)
|
|
{
|
|
return a.find(b) != std::string::npos;
|
|
}
|
|
|
|
inline bool contains(docstring const & a, docstring const & b)
|
|
{
|
|
return a.find(b) != docstring::npos;
|
|
}
|
|
|
|
inline bool contains(std::string const & a, char b)
|
|
{
|
|
return a.find(b) != std::string::npos;
|
|
}
|
|
|
|
inline bool contains(docstring const & a, char_type b)
|
|
{
|
|
return a.find(b) != docstring::npos;
|
|
}
|
|
|
|
///
|
|
bool containsOnly(std::string const &, std::string const &);
|
|
|
|
/** Extracts a token from this string at the nth delim.
|
|
Doesn't modify the original string. Similar to strtok.
|
|
Example:
|
|
\code
|
|
token("a;bc;d", ';', 1) == "bc";
|
|
token("a;bc;d", ';', 2) == "d";
|
|
\endcode
|
|
*/
|
|
std::string const token(std::string const & a, char delim, int n);
|
|
|
|
docstring const token(docstring const & a, char_type delim, int n);
|
|
|
|
/** Search a token in this string using the delim.
|
|
Doesn't modify the original string. Returns -1 in case of
|
|
failure.
|
|
Example:
|
|
\code
|
|
tokenPos("a;bc;d", ';', "bc") == 1;
|
|
tokenPos("a;bc;d", ';', "d") == 2;
|
|
\endcode
|
|
*/
|
|
int tokenPos(std::string const & a, char delim, std::string const & tok);
|
|
|
|
|
|
/// Substitute all \a oldchar with \a newchar
|
|
std::string const subst(std::string const & a, char oldchar, char newchar);
|
|
|
|
/// Substitute all \a oldchar with \a newchar
|
|
docstring const subst(docstring const & a, char_type oldchar, char_type newchar);
|
|
|
|
/// substitutes all instances of \a oldstr with \a newstr
|
|
std::string const subst(std::string const & a,
|
|
std::string const & oldstr, std::string const & newstr);
|
|
|
|
/// substitutes all instances of \a oldstr with \a newstr
|
|
docstring const subst(docstring const & a,
|
|
docstring const & oldstr, docstring const & newstr);
|
|
|
|
/** Trims characters off the end and beginning of a string.
|
|
\code
|
|
trim("ccabccc", "c") == "ab".
|
|
\endcode
|
|
*/
|
|
docstring const trim(docstring const & a, char const * p = " ");
|
|
|
|
/** Trims characters off the end and beginning of a string.
|
|
\code
|
|
trim("ccabccc", "c") == "ab".
|
|
\endcode
|
|
*/
|
|
std::string const trim(std::string const & a, char const * p = " ");
|
|
|
|
/** Trims characters off the end of a string.
|
|
\code
|
|
rtrim("abccc", "c") == "ab".
|
|
\endcode
|
|
*/
|
|
std::string const rtrim(std::string const & a, char const * p = " ");
|
|
docstring const rtrim(docstring const & a, char const * p = " ");
|
|
|
|
/** Trims characters off the beginning of a string.
|
|
\code
|
|
("ababcdef", "ab") = "cdef"
|
|
\endcode
|
|
*/
|
|
std::string const ltrim(std::string const & a, char const * p = " ");
|
|
docstring const ltrim(docstring const & a, char const * p = " ");
|
|
|
|
/** Splits the string given in the first argument at the first occurence
|
|
of the third argumnent, delim.
|
|
What precedes delim is returned in the second argument, piece; this
|
|
will be the whole of the string if no delimiter is found.
|
|
The return value is what follows delim, if anything. So the return
|
|
value is the null string if no delimiter is found.
|
|
Examples:
|
|
\code
|
|
s1= "a;bc"; s2= ""
|
|
ret = split(s1, s2, ';') -> ret = "bc", s2 == "a"
|
|
\endcode
|
|
*/
|
|
std::string const split(std::string const & a, std::string & piece, char delim);
|
|
docstring const split(docstring const & a, docstring & piece, char_type delim);
|
|
|
|
/// Same as split but does not return a piece
|
|
std::string const split(std::string const & a, char delim);
|
|
|
|
/// Same as split but uses the last delim.
|
|
std::string const rsplit(std::string const & a, std::string & piece, char delim);
|
|
|
|
/// Escapes non ASCII chars and other problematic characters that cause
|
|
/// problems in latex labels.
|
|
docstring const escape(docstring const & lab);
|
|
|
|
/// gives a vector of stringparts which have the delimiter delim
|
|
std::vector<std::string> const getVectorFromString(std::string const & str,
|
|
std::string const & delim = std::string(","));
|
|
std::vector<docstring> const getVectorFromString(docstring const & str,
|
|
docstring const & delim = from_ascii(","));
|
|
|
|
// the same vice versa
|
|
std::string const getStringFromVector(std::vector<std::string> const & vec,
|
|
std::string const & delim = std::string(","));
|
|
|
|
/// Search \p search_token in \p str and return the position if it is
|
|
/// found, else -1. The last item in \p str must be "".
|
|
int findToken(char const * const str[], std::string const & search_token);
|
|
|
|
/// Convert internal line endings to line endings as expected by the OS
|
|
docstring const externalLineEnding(docstring const & str);
|
|
|
|
/// Convert line endings in any formnat to internal line endings
|
|
docstring const internalLineEnding(docstring const & str);
|
|
|
|
|
|
template <class Arg1>
|
|
docstring bformat(docstring const & fmt, Arg1);
|
|
|
|
template <class Arg1, class Arg2>
|
|
docstring bformat(docstring const & fmt, Arg1, Arg2);
|
|
|
|
template <class Arg1, class Arg2, class Arg3>
|
|
docstring bformat(docstring const & fmt, Arg1, Arg2, Arg3);
|
|
|
|
template <class Arg1, class Arg2, class Arg3, class Arg4>
|
|
docstring bformat(docstring const & fmt, Arg1, Arg2, Arg3, Arg4);
|
|
|
|
|
|
} // namespace support
|
|
} // namespace lyx
|
|
|
|
#endif
|