lyx_mirror/src/support/textutils.h

// -*- C++ -*-
/**
 * \file textutils.h
 * This file is part of LyX, the document processor.
 * Licence details can be found in the file COPYING.
 *
 * \author Matthias Ettrich
 * \author Lars Gullik Bjønnes
 *
 * Full author contact details are available in file CREDITS.
 */

// FIXME: I can think of a better name for this file ...

#ifndef TEXTUTILS_H
#define TEXTUTILS_H

#include "support/strfwd.h"


namespace lyx {

/// return true if the char is a line separator
inline bool isLineSeparatorChar(char_type c) { return c == ' '; }

/// return true if a char is alphabetical (including accented chars)
bool isLetterChar(char_type c);

/// return true if a char is lowercase
bool isLower(char_type c);

/// return whether \p c is an alphabetic character in the ASCII range
bool isAlphaASCII(char_type c);

/// return true if the char is printable
bool isPrintable(char_type c);

/// return true if the char is printable and not a space
bool isPrintableNonspace(char_type c);

/// return true if a unicode char is a space.
bool isSpace(char_type c);

/// return true if a unicode char is a numeral.
bool isNumber(char_type c);

/// return true if a unicode char has the direction attribute
/// European Number Separator [ES]
bool isEuropeanNumberSeparator(char_type c);

/// return true if a unicode char has the direction attribute
/// European Number Terminator [ET]
bool isEuropeanNumberTerminator(char_type c);

/// return whether \p c is a digit in the ASCII range
bool isDigitASCII(char_type c);

/// return whether \p c is alpha or a digit in the ASCII range
bool isAlnumASCII(char_type c);

/// return whether \p c is in the ASCII range
bool isASCII(char_type c);

/// return whether \p c is in the 'Punctuation, Open' unicode category
bool isOpenPunctuation(char_type c);

} // namespace lyx

#endif // TEXTUTILS_H