// -*- 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.
*
- * ====================================================== */
+ * \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 <cctype>
-
-///
-inline bool IsNewlineChar(char c) {
- return (c == LyXParagraph::META_NEWLINE);
-}
-
-
-///
-inline bool IsSeparatorChar(char c) {
- return (c == ' ' || c == LyXParagraph::META_PROTECTED_SEPARATOR);
+/// return true if the char is a meta-character newline
+inline
+bool IsNewlineChar(char c)
+{
+ return (c == Paragraph::META_NEWLINE);
}
-///
-inline bool IsHfillChar(char c) {
- return (c == LyXParagraph::META_HFILL);
+/// return true if the char is a word separator
+inline
+bool IsSeparatorChar(char c)
+{
+ return (c == ' ');
}
-///
-inline bool IsInsetChar(char c) {
- return (c == LyXParagraph::META_INSET);
+/// return true if the char is a line separator
+inline
+bool IsLineSeparatorChar(char c)
+{
+ return (c == ' ');
}
-///
-inline bool IsFloatChar(char c) {
- return (c == LyXParagraph::META_FOOTNOTE
- || c == LyXParagraph::META_MARGIN
- || c == LyXParagraph::META_FIG
- || c == LyXParagraph::META_TAB
- || c == LyXParagraph::META_ALGORITHM
- || c == LyXParagraph::META_WIDE_FIG
- || c == LyXParagraph::META_WIDE_TAB);
+/// return true if the char is a meta-character for hfill
+inline
+bool IsHfillChar(char c)
+{
+ return (c == Paragraph::META_HFILL);
}
-///
-inline bool IsLineSeparatorChar(char c) {
- return (c == ' ');
+/// return true if the char is a meta-character for an inset
+inline
+bool IsInsetChar(char c)
+{
+ return (c == Paragraph::META_INSET);
}
-///
-inline bool IsKommaChar(char c) {
- return (c == ','
+/// return true if the char is "punctuation"
+inline
+bool IsKommaChar(char c)
+{
+ return (c == ','
|| c == '('
|| c == ')'
|| c == '['
|| c == '#'
|| c == '%'
|| c == '^'
- || c == '/'
+ || c == '/'
|| c == '\\'
- || c == LyXParagraph::META_NEWLINE
- || c == LyXParagraph::META_PROTECTED_SEPARATOR
+ || c == Paragraph::META_NEWLINE
);
}
-///
-inline bool IsLetterChar(unsigned char c) {
+/// return true if a char is alphabetical (including accented chars)
+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 >= ' ');
+/// return true if the char is printable (masked to 7-bit ASCII)
+inline
+bool IsPrintable(unsigned char c)
+{
+ return ((c & 127) >= ' ');
}
-/// 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 ) ) ;
+/// return true if the char is printable and not a space (masked to 7-bit ASCII)
+inline
+bool IsPrintableNonspace(unsigned char c)
+{
+ return IsPrintable(c) && (c != ' ');
}
-///
-inline bool IsLetterCharOrDigit(char ch)
+/// return true if the char forms part of a word
+inline
+bool IsWordChar(unsigned char c)
{
- return IsLetterChar(ch) || isdigit(ch);
+ return !(IsSeparatorChar(c)
+ || IsKommaChar(c)
+ || IsHfillChar(c)
+ || IsInsetChar(c));
}
-#endif
+
+
+/// completely pointless FIXME
+inline
+bool IsDigit(unsigned char ch)
+{
+ return ch >= '0' && ch <= '9';
+}
+
+
+/// return true if the char is alphanumeric
+inline
+bool IsLetterCharOrDigit(unsigned char ch)
+{
+ return IsLetterChar(ch) || IsDigit(ch);
+}
+
+#endif // TEXTUTILS_H