dox/Common/vtkUnicodeString.h

Go to the documentation of this file.

/*=========================================================================

  Program:   Visualization Toolkit
  Module:    vtkUnicodeString.h
  
-------------------------------------------------------------------------
  Copyright 2008 Sandia Corporation.
  Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
  the U.S. Government retains certain rights in this software.
-------------------------------------------------------------------------

  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
  All rights reserved.
  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.

     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
     PURPOSE.  See the above copyright notice for more information.

=========================================================================*/

#ifndef __vtkUnicodeString_h
#define __vtkUnicodeString_h

#include <vtkSystemIncludes.h>
#include <vtkstd/string>
#include <vtkstd/vector>

class vtkUnicodeString;

typedef vtkTypeUInt32 vtkUnicodeStringValueType;

//
// The following should be eventually placed in vtkSetGet.h
//

// This is same as extra extended template macro with an 
// additional case for VTK_UNICODE_STRING
#define vtkSuperExtraExtendedTemplateMacro(call)                                 \
  vtkExtraExtendedTemplateMacro(call);                                            \
  vtkTemplateMacroCase(VTK_UNICODE_STRING, vtkUnicodeString, call)

class VTK_COMMON_EXPORT vtkUnicodeString
{
public:
  typedef vtkUnicodeStringValueType value_type;
  typedef vtkstd::string::size_type size_type;

  class VTK_COMMON_EXPORT const_iterator
  {
  public:
    typedef vtkstd::bidirectional_iterator_tag iterator_category;
    typedef vtkUnicodeStringValueType value_type;
    typedef vtkstd::string::difference_type difference_type;
    typedef value_type* pointer;
    typedef value_type& reference;
  
    const_iterator();

    value_type operator*() const;
    bool operator==(const const_iterator&) const;
    bool operator!=(const const_iterator&) const;
    const_iterator& operator++();
    const_iterator operator++(int);
    const_iterator& operator--();
    const_iterator operator--(int);

  private:
    const_iterator(vtkstd::string::const_iterator);
    friend class vtkUnicodeString;
    vtkstd::string::const_iterator Position;
  };


  vtkUnicodeString();
  // Description:
  // Makes a deep-copy of another sequence.
  vtkUnicodeString(const vtkUnicodeString&);
  // Description:
  // Constructs a sequence of repeated characters.  Note: throws an exception if
  // the character isn't a valid Unicode code point.
  vtkUnicodeString(size_type count, value_type character);
  // Description:
  // Constructs a string from a sequence of Unicode characters.
  vtkUnicodeString(const_iterator begin, const_iterator end);


  static bool is_utf8(const char*);
  static bool is_utf8(const vtkstd::string&);


  static vtkUnicodeString from_utf8(const char*);
  // Constructs a string from a half-open sequence of UTF-8 encoded characters.
  static vtkUnicodeString from_utf8(const char* begin, const char* end);
  // Constructs a string from a sequence of UTF-8 encoded characters.
  static vtkUnicodeString from_utf8(const vtkstd::string&);
  // Description:
  // Constructs a string from a null-terminated sequence of UTF-16 encoded characters.
  static vtkUnicodeString from_utf16(const vtkTypeUInt16*);

  vtkUnicodeString& operator=(const vtkUnicodeString&);


  const_iterator begin() const;
  // Description:
  // Returns a forward iterator that points just beyond the end of the sequence.
  const_iterator end() const;


  value_type at(size_type offset) const;
  // Description:
  // Returns the Unicode character at the given character offset within the sequence.
  // Behavior is undefined if the position is invalid.
  value_type operator[](size_type offset) const;


  const char* utf8_str() const;
  // Description:
  // Inserts the sequence into the supplied storage as a collection of UTF-8 encoded
  // characters.
  void utf8_str(vtkstd::string& result) const;
  // Description:
  // Returns the sequence as a collection of UTF-16 encoded characters.
  vtkstd::vector<vtkTypeUInt16> utf16_str() const;
  // Description:
  // Inserts the sequence into the supplied storage as a collection of UTF-16 encoded
  // characters
  void utf16_str(vtkstd::vector<vtkTypeUInt16>& result) const;


  size_type byte_count() const;
  // Description:
  // Returns the number of characters (not bytes) in the sequence.
  size_type character_count() const;
  // Description:
  // Returns true if the string contains an empty sequence.
  bool empty() const;

  static const size_type npos;


  vtkUnicodeString& operator+=(value_type); 
  // Description:
  // Append a Unicode sequence to the end of the current sequence.
  vtkUnicodeString& operator+=(const vtkUnicodeString& rhs);
  
  void push_back(value_type);


  void append(const vtkUnicodeString& value);
  void append(size_type count, value_type character);
  void append(const_iterator begin, const_iterator end);


  void assign(const vtkUnicodeString& value);
  void assign(size_type count, value_type character);
  void assign(const_iterator begin, const_iterator end);
 
  void clear();

  vtkUnicodeString fold_case() const;

  int compare(const vtkUnicodeString&) const;

  vtkUnicodeString substr(size_type offset = 0, size_type count = npos) const;
  
  void swap(vtkUnicodeString&);

private:
  vtkstd::string Storage;
  class back_insert_iterator;
};

VTK_COMMON_EXPORT bool operator==(const vtkUnicodeString& lhs, const vtkUnicodeString& rhs);
VTK_COMMON_EXPORT bool operator!=(const vtkUnicodeString& lhs, const vtkUnicodeString& rhs);
VTK_COMMON_EXPORT bool operator<(const vtkUnicodeString& lhs, const vtkUnicodeString& rhs);
VTK_COMMON_EXPORT bool operator<=(const vtkUnicodeString& lhs, const vtkUnicodeString& rhs);
VTK_COMMON_EXPORT bool operator>=(const vtkUnicodeString& lhs, const vtkUnicodeString& rhs);
VTK_COMMON_EXPORT bool operator>(const vtkUnicodeString& lhs, const vtkUnicodeString& rhs);

#endif

---