You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
tdelibs/kjs/ustring.h

477 lines
14 KiB

// -*- c-basic-offset: 2 -*-
/*
* This file is part of the KDE libraries
* Copyright (C) 1999-2000 Harri Porten (porten@kde.org)
* Copyright (C) 2003 Apple Computer, Inc.
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Library General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Library General Public License for more details.
*
* You should have received a copy of the GNU Library General Public License
* along with this library; see the file COPYING.LIB. If not, write to
* the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
* Boston, MA 02110-1301, USA.
*
*/
#ifndef _KJS_USTRING_H_
#define _KJS_USTRING_H_
#include "global.h"
/**
* @internal
*/
namespace DOM {
class DOMString;
}
class KJScript;
class QString;
class QConstString;
namespace KJS {
class UCharReference;
class UString;
/**
* @short Unicode character.
*
* UChar represents a 16 bit Unicode character. It's internal data
* representation is compatible to XChar2b and QChar. It's therefore
* possible to exchange data with X and Qt with shallow copies.
*/
struct KJS_EXPORT UChar {
/**
* Construct a character with uninitialized value.
*/
UChar();
UChar(char u);
UChar(unsigned char u);
/**
* Construct a character with the value denoted by the arguments.
* @param h higher byte
* @param l lower byte
*/
UChar(unsigned char h , unsigned char l);
/**
* Construct a character with the given value.
* @param u 16 bit Unicode value
*/
UChar(unsigned short u);
UChar(const UCharReference &c);
/**
* @return The higher byte of the character.
*/
unsigned char high() const { return uc >> 8; }
/**
* @return The lower byte of the character.
*/
unsigned char low() const { return uc; }
/**
* @return the 16 bit Unicode value of the character
*/
unsigned short unicode() const { return uc; }
public:
/**
* @return The character converted to lower case.
*/
UChar toLower() const;
/**
* @return The character converted to upper case.
*/
UChar toUpper() const;
/**
* A static instance of UChar(0).
*/
static UChar null;
unsigned short uc;
} KJS_PACKED;
inline UChar::UChar() { }
inline UChar::UChar(unsigned char h , unsigned char l) : uc(h << 8 | l) { }
inline UChar::UChar(char u) : uc((unsigned char)u) { }
inline UChar::UChar(unsigned char u) : uc(u) { }
inline UChar::UChar(unsigned short u) : uc(u) { }
/**
* @short Dynamic reference to a string character.
*
* UCharReference is the dynamic counterpart of UChar. It's used when
* characters retrieved via index from a UString are used in an
* assignment expression (and therefore can't be treated as being const):
* \code
* UString s("hello world");
* s[0] = 'H';
* \endcode
*
* If that sounds confusing your best bet is to simply forget about the
* existence of this class and treat is as being identical to UChar.
*/
class KJS_EXPORT UCharReference {
friend class UString;
UCharReference(UString *s, unsigned int off) : str(s), offset(off) { }
public:
/**
* Set the referenced character to c.
*/
UCharReference& operator=(UChar c);
/**
* Same operator as above except the argument that it takes.
*/
UCharReference& operator=(char c) { return operator=(UChar(c)); }
/**
* @return Unicode value.
*/
unsigned short unicode() const { return ref().uc; }
/**
* @return Lower byte.
*/
unsigned char low() const { return ref().uc; }
/**
* @return Higher byte.
*/
unsigned char high() const { return ref().uc >> 8; }
/**
* @return Character converted to lower case.
*/
UChar toLower() const { return ref().toLower(); }
/**
* @return Character converted to upper case.
*/
UChar toUpper() const { return ref().toUpper(); }
private:
// not implemented, can only be constructed from UString
UCharReference();
UChar& ref() const;
UString *str;
int offset;
};
inline UChar::UChar(const UCharReference &c) : uc(c.unicode()) { }
/**
* @short 8 bit char based string class
*/
class KJS_EXPORT CString {
public:
CString() : data(0L), length(0) { }
CString(const char *c);
CString(const char *c, int len);
CString(const CString &);
~CString();
CString &append(const CString &);
CString &operator=(const char *c);
CString &operator=(const CString &);
CString &operator+=(const CString &c) { return append(c); }
int size() const { return length; }
const char *c_str() const { return data; }
private:
char *data;
int length;
};
/**
* @short Unicode string class
*/
class KJS_EXPORT UString {
friend bool operator==(const UString&, const UString&);
friend class UCharReference;
friend class Identifier;
friend class PropertyMap;
friend class PropertyMapHashTableEntry;
/**
* @internal
*/
struct KJS_EXPORT Rep {
friend class UString;
friend bool operator==(const UString&, const UString&);
static Rep *create(UChar *d, int l);
void destroy();
UChar *data() const { return dat; }
int size() const { return len; }
unsigned hash() const { if (_hash == 0) _hash = computeHash(dat, len); return _hash; }
static unsigned computeHash(const UChar *, int length);
static unsigned computeHash(const char *);
void ref() { ++rc; }
void deref() { if (--rc == 0) destroy(); }
UChar *dat;
int len;
int capacity;
int rc;
mutable unsigned _hash;
enum { capacityForIdentifier = 0x10000000 };
static Rep null;
static Rep empty;
};
public:
/**
* Constructs a null string.
*/
UString();
/**
* Constructs a string from the single character c.
*/
explicit UString(char c);
/**
* Constructs a string from a classical zero determined char string.
*/
UString(const char *c);
/**
* Constructs a string from an array of Unicode characters of the specified
* length.
*/
UString(const UChar *c, int length);
/**
* If copy is false the string data will be adopted.
* That means that the data will NOT be copied and the pointer will
* be deleted when the UString object is modified or destroyed.
* Behaviour defaults to a deep copy if copy is true.
*/
UString(UChar *c, int length, bool copy);
/**
* Copy constructor. Makes a shallow copy only.
*/
UString(const UString &s) { attach(s.rep); }
/**
* Convenience declaration only ! You'll be on your own to write the
* implementation for a construction from QString.
*
* Note: feel free to contact me if you want to see a dummy header for
* your favorite FooString class here !
*/
UString(const QString &);
/**
* Convenience declaration only ! See UString(const QString&).
*/
UString(const DOM::DOMString &);
/**
* Concatenation constructor. Makes operator+ more efficient.
*/
UString(const UString &, const UString &);
/**
* Destructor. If this handle was the only one holding a reference to the
* string the data will be freed.
*/
~UString() { release(); }
/**
* Constructs a string from an int.
*/
static UString from(int i);
/**
* Constructs a string from an unsigned int.
*/
static UString from(unsigned int u);
/**
* Constructs a string from a long.
*/
static UString from(long l);
/**
* Constructs a string from a double.
*/
static UString from(double d);
/**
* Append another string.
*/
UString &append(const UString &);
/**
* @return The string converted to the 8-bit string type CString().
*/
CString cstring() const;
/**
* Convert the Unicode string to plain ASCII chars chopping of any higher
* bytes. This method should only be used for *debugging* purposes as it
* is neither Unicode safe nor free from side effects. In order not to
* waste any memory the char buffer is static and *shared* by all UString
* instances.
*/
char *ascii() const;
/**
* @see UString(const QString&).
*/
DOM::DOMString string() const;
/**
* @see UString(const QString&).
*/
QString qstring() const;
/**
* @see UString(const QString&).
*/
QConstString qconststring() const;
/**
* Assignment operator.
*/
UString &operator=(const char *c);
UString &operator=(const UString &);
/**
* Appends the specified string.
*/
UString &operator+=(const UString &s) { return append(s); }
/**
* @return A pointer to the internal Unicode data.
*/
const UChar* data() const { return rep->data(); }
/**
* @return True if null.
*/
bool isNull() const { return (rep == &Rep::null); }
/**
* @return True if null or zero length.
*/
bool isEmpty() const { return (!rep->len); }
/**
* Use this if you want to make sure that this string is a plain ASCII
* string. For example, if you don't want to lose any information when
* using cstring() or ascii().
*
* @return True if the string doesn't contain any non-ASCII characters.
*/
bool is8Bit() const;
/**
* @return The length of the string.
*/
int size() const { return rep->size(); }
/**
* Const character at specified position.
*/
UChar operator[](int pos) const;
/**
* Writable reference to character at specified position.
*/
UCharReference operator[](int pos);
/**
* Attempts an conversion to a number. Apart from floating point numbers,
* the algorithm will recognize hexadecimal representations (as
* indicated by a 0x or 0X prefix) and +/- Infinity.
* Returns NaN if the conversion failed.
* @param tolerateTrailingJunk if true, toDouble can tolerate garbage after the number.
* @param tolerateEmptyString if false, toDouble will turn an empty string into NaN rather than 0.
*/
double toDouble(bool tolerateTrailingJunk, bool tolerateEmptyString) const;
double toDouble(bool tolerateTrailingJunk) const;
double toDouble() const;
/**
* Attempts an conversion to an unsigned long integer. ok will be set
* according to the success.
@ @param ok make this point to a bool in case you need to know whether the conversion succeeded.
* @param tolerateEmptyString if false, toULong will return false for *ok for an empty string.
*/
unsigned long toULong(bool *ok, bool tolerateEmptyString) const;
unsigned long toULong(bool *ok = 0) const;
unsigned int toUInt32(bool *ok = 0) const;
unsigned int toStrictUInt32(bool *ok = 0) const;
/**
* Attempts an conversion to an array index. The "ok" boolean will be set
* to true if it is a valid array index according to the rule from
* ECMA 15.2 about what an array index is. It must exactly match the string
* form of an unsigned integer, and be less than 2^32 - 1.
*/
unsigned toArrayIndex(bool *ok = 0) const;
/**
* Returns this string converted to lower case characters
*/
UString toLower() const;
/**
* Returns this string converted to upper case characters
*/
UString toUpper() const;
/**
* @return Position of first occurrence of f starting at position pos.
* -1 if the search was not successful.
*/
int find(const UString &f, int pos = 0) const;
int find(UChar, int pos = 0) const;
/**
* @return Position of first occurrence of f searching backwards from
* position pos.
* -1 if the search was not successful.
*/
int rfind(const UString &f, int pos) const;
int rfind(UChar, int pos) const;
/**
* @return The sub string starting at position pos and length len.
*/
UString substr(int pos = 0, int len = -1) const;
/**
* Static instance of a null string.
*/
static UString null;
#ifdef KJS_DEBUG_MEM
/**
* Clear statically allocated resources.
*/
static void globalClear();
#endif
private:
UString(Rep *r) { attach(r); }
void attach(Rep *r);
void detach();
void release();
Rep *rep;
};
KJS_EXPORT inline bool operator==(const UChar &c1, const UChar &c2) {
return (c1.uc == c2.uc);
}
KJS_EXPORT inline bool operator!=(const UChar& c1, const UChar& c2) {
return !KJS::operator==(c1, c2);
}
KJS_EXPORT bool operator==(const UString& s1, const UString& s2);
inline bool operator!=(const UString& s1, const UString& s2) {
return !KJS::operator==(s1, s2);
}
KJS_EXPORT bool operator<(const UString& s1, const UString& s2);
KJS_EXPORT bool operator==(const UString& s1, const char *s2);
KJS_EXPORT inline bool operator!=(const UString& s1, const char *s2) {
return !KJS::operator==(s1, s2);
}
KJS_EXPORT inline bool operator==(const char *s1, const UString& s2) {
return operator==(s2, s1);
}
KJS_EXPORT inline bool operator!=(const char *s1, const UString& s2) {
return !KJS::operator==(s1, s2);
}
KJS_EXPORT bool operator==(const CString& s1, const CString& s2);
KJS_EXPORT inline bool operator!=(const CString& s1, const CString& s2) {
return !KJS::operator==(s1, s2);
}
KJS_EXPORT inline UString operator+(const UString& s1, const UString& s2) {
return UString(s1, s2);
}
KJS_EXPORT int compare(const UString &, const UString &);
} // namespace
#endif