VString.hpp

/******************************************************************************
 
  nomlib - C++11 cross-platform game engine
 
Copyright (c) 2013, 2014 Jeffrey Carpenter <i8degrees@gmail.com>
All rights reserved.
 
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
 
1. Redistributions of source code must retain the above copyright notice, this
   list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice,
   this list of conditions and the following disclaimer in the documentation
   and/or other materials provided with the distribution.
 
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
******************************************************************************/
#ifndef NOMLIB_PTREE_VSTRING_HPP
#define NOMLIB_PTREE_VSTRING_HPP
 
#include <cstring>
 
#include "nomlib/config.hpp"
 
namespace nom {
 
typedef nom::size_type ArrayIndex;
 
class VString
{
  public:
    typedef VString self_type;

    VString();
 
    ~VString();

    VString(const char* key);

    VString(const std::string& key);

    VString(ArrayIndex index);

    VString(const self_type& rhs);

    self_type& operator =(const self_type& rhs);

    bool operator <(const self_type& rhs) const;

    bool operator ==(const self_type& rhs) const;

    std::string string() const;

    const char* c_str() const;

    ArrayIndex index() const;
 
  private:
    void swap(self_type& rhs);
 
    std::string cstr_;
    ArrayIndex index_;
};
 
} // namespace nom
 
#endif // include guard defined