// -*- C++ -*-
-/* This file is part of
- * ======================================================
- *
- * LyX, The Document Processor
- *
- * Copyright (C) 1995 Matthias Ettrich
+/**
+ * \file textutils.h
+ * This file is part of LyX, the document processor.
+ * Licence details can be found in the file COPYING.
*
- *======================================================*/
-#ifndef _TEXTUTILS_H
-#define _TEXTUTILS_H
-
-#include "definitions.h"
-
-///
-inline bool IsNewlineChar(char c) {
- return (c == LYX_META_NEWLINE);
-}
-///
-inline bool IsSeparatorChar(char c) {
- return (c == ' ' || c == LYX_META_PROTECTED_SEPARATOR);
-}
-///
-inline bool IsHfillChar(char c) {
- return (c == LYX_META_HFILL);
-}
-///
-inline bool IsInsetChar(char c) {
- return (c == LYX_META_INSET);
-}
-///
-inline bool IsFloatChar(char c) {
- return (c == LYX_META_FOOTNOTE
- || c == LYX_META_MARGIN
- || c == LYX_META_FIG
- || c == LYX_META_TAB
- || c == LYX_META_ALGORITHM
- || c == LYX_META_WIDE_FIG
- || c == LYX_META_WIDE_TAB);
-}
-///
-inline bool IsLineSeparatorChar(char c) {
- return (c == ' ');
-}
-///
-inline bool IsKommaChar(char c) {
- return (c == ','
- || c=='('
- || c==')'
- || c=='['
- || c==']'
- || c=='{'
- || c=='}'
- || c==';'
- || c=='.'
- || c==':'
- || c=='-'
- || c=='?'
- || c=='!'
- || c=='&'
- || c=='@'
- || c=='+'
- || c=='-'
- || c=='~'
- || c=='#'
- || c=='%'
- || c=='^'
- || c=='/'
- || c=='\\'
- || c==LYX_META_NEWLINE
- || c==LYX_META_PROTECTED_SEPARATOR
- );
-}
-///
-inline bool IsLetterChar(unsigned char c) {
- return ((c>='A' && c<='Z')
- || (c>='a' && c<='z')
- || (c>=192)); // in iso-8859-x these are accented chars
-}
-///
-inline bool IsPrintable(unsigned char c) {
- return (c>=' ');
-}
-/// Word is not IsSeparator or IsKomma or IsHfill or IsFloat or IsInset.
-inline bool IsWordChar(unsigned char c) {
- return !( IsSeparatorChar( c )
- || IsKommaChar( c )
- || IsHfillChar( c )
- || IsFloatChar( c )
- || IsInsetChar( c ) ) ;
-}
-#endif
+ * \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
+/// Common Number Separator [CS]
+bool isCommonNumberSeparator(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