UTPathNode.h

Go to the documentation of this file.

//==================================================================================================
// Copyright (C) 2010  Brian Tietz    sdbtietz at yahoo dot com
//
// This program is free software; you can redistribute it and/or modify it under the terms of the
// GNU General Public License as published by the Free Software Foundation, version 2.0 of the
// License.
//
// This program 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
// General Public License for more details.
//
// You should have received a copy of the GNU General Public License along with this program; if
// not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
// 02110-1301, USA.
//
// For commercial software, the copyright holder (Brian Tietz, email sdbtietz at yahoo dot com)
// reserves the right and is willing to waive the proprietary source code disclosure aspects of that
// license as applied to the UT library in exchange for either substantial contributions to the
// development of the UT library or other forms of compensation.  Any such waiver must be
// established in writing between the copyright holder and the commercial entity obtaining such a
// waiver.
//==================================================================================================


#ifndef _UT_PATH_NODE_H_
#define _UT_PATH_NODE_H_


//==================================================================================================
//=== Project headers
//==================================================================================================
#include "UT.h"


//==================================================================================================
//=== Types and constants
//==================================================================================================

// \cond DOXYGEN_DOCUMENT_NEVER

enum path_node_result_t
{
    ePNR_bad_path       = -1,
    ePNR_no_more_nodes  = 0,
    ePNR_success        = 1
};


//==================================================================================================
class PathNode_t
//==================================================================================================
// Class to facilitate easy traversal of file paths.  It is used internally by the implementation of
// the Path_t class.
{
    //----------------------------------------------------------------------------------------------
    public:
    //----------------------------------------------------------------------------------------------
    path_node_result_t      Init(const utf8* text);
                                // Initializes the path node to point to and record the length of
                                // the first node in the specified path.  If the operation is
                                // successful, ePNR_success is returned.  If first path node is not
                                // valid, ePNR_bad_path is returned.  If the text specifies an empty
                                // path, ePNR_no_more_nodes is returned.

    path_node_result_t      Next();
                                // Increments this path node to point to and record the length of
                                // the next node in the specified path.  If the operation is
                                // successful, ePNR_success is returned.  If next path node is not
                                // valid, ePNR_bad_path is returned.  If there are no more nodes in
                                // the path originally passed to Init in the text parameter,
                                // ePNR_no_more_nodes is returned.

    inline const utf8*      UTF8() const;
                                // Returns a pointer to the beginning of the text in the current
                                // path node.  Note that the path node is not null-terminated, and
                                // only the length indicated by the Length function is actually a
                                // part of the current path node.

    inline stringliteral*   ConstChars() const;
                                // Returns a pointer to the beginning of the text in the current
                                // path node.  Note that the path node is not null-terminated, and
                                // only the length indicated by the Length function is actually a
                                // part of the current path node.

    inline int              Length() const;
                                // Returns the length of the current path node.

    //----------------------------------------------------------------------------------------------
    private:
    //----------------------------------------------------------------------------------------------
    static int              CountNodeBytes(const utf8* text);
                                // Returns the number of bytes in this path node, -1 if an invalid
                                // character was found.  An invalid character is one which is not
                                // allowed in a file name, excluding path delimiters.

    //----------------------------------------------------------------------------------------------
    private:
    //----------------------------------------------------------------------------------------------
    const utf8*             m_text;
    const utf8*             m_text_base;
    int                     m_node_length;
};




//==================================================================================================
//==================================================================================================
//===
//=== Inline function implementations
//===
//==================================================================================================
//==================================================================================================
inline const utf8*
PathNode_t::UTF8() const
{
    return m_text;
}


inline stringliteral*
PathNode_t::ConstChars() const
{
    return reinterpret_cast<stringliteral*>(m_text);
}


inline int
PathNode_t::Length() const
{
    return m_node_length;
}


// \endcond
#endif // _UT_PATH_NODE_H_