Path.h

Go to the documentation of this file.

//**************************************************************************/
// Copyright (c) 1998-2006 Autodesk, Inc.
// All rights reserved.
// 
// These coded instructions, statements, and computer programs contain
// unpublished proprietary information written by Autodesk, Inc., and are
// protected by Federal copyright law. They may not be disclosed to third
// parties or copied or duplicated in any form, in whole or in part, without
// the prior written consent of Autodesk, Inc.
//**************************************************************************/
// DESCRIPTION: Path class
// AUTHOR: Nicolas Desjardins
// DATE: 2006-02-27 
//***************************************************************************/

#ifndef _MAXSDK_UTIL_PATH_H_
#define _MAXSDK_UTIL_PATH_H_


#include "maxheap.h"
#include "utilexp.h"
#include "strclass.h"
#include "maxversion.h"
#include "autoptr.h"

namespace MaxSDK
{
namespace Util
{
class Path : public MaxHeapOperators
{
private:
    class PathImpl;
    const AutoPtr<PathImpl> mImpl;

public:

    UtilExport Path();

    UtilExport Path(const MSTR &pathString);

    UtilExport Path(const MCHAR *pathString);

    UtilExport Path(const Path &other);

    UtilExport ~Path();

    UtilExport Path& SetPath(const Path &other);

    UtilExport Path& SetPath(const MCHAR *pathString);

    UtilExport Path& SetPath(const MSTR &pathString);

    UtilExport Path& operator=(const Path &other);

    UtilExport Path& operator=(const MCHAR *pathString);

    UtilExport Path& operator=(const MSTR &pathString);
    

    UtilExport bool IsAbsolute() const;

    UtilExport bool IsEmpty() const;

    UtilExport bool IsLegal() const;

    UtilExport bool IsRoot() const;

    UtilExport bool IsUnc() const;

    UtilExport bool IsUncShare() const;

    UtilExport bool IsRootedAtBackslash() const;

    UtilExport bool IsRootedAtDriveLetter() const;

    UtilExport bool HasUnresolvedSymbols() const;

    UtilExport bool StartsWithUpDirectory() const;

    UtilExport bool IsEqual(const Path &other) const;

    UtilExport bool operator==(const Path &other) const;

    UtilExport bool ResolvesEquivalent(const Path &other) const;

    UtilExport bool HasTrailingBackslash() const;

    UtilExport Path& AddTrailingBackslash();

    UtilExport Path& RemoveTrailingBackslash();
    
    UtilExport Path& Prepend(const Path &newParent);

    UtilExport Path& Append(const Path &relativeChild);
    
    UtilExport Path& StripToTopParent();

    UtilExport Path& RemoveTopParent();

    UtilExport Path& StripToLeaf();

    UtilExport Path& RemoveLeaf();

    UtilExport Path& ResolveSymbols();

    UtilExport Path& Normalize();

    UtilExport Path& ConvertToLowerCase();

    UtilExport Path& ConvertToRelativeTo(const Path &newBase);

    UtilExport Path& ConvertToUNC();

    UtilExport Path& ConvertToAbsolute();

    UtilExport const Path& GetResolvedAbsolutePath() const;

    UtilExport Path& ConvertToRelativeToProjectFolder();

    UtilExport MSTR GetString() const;

    UtilExport const MCHAR* GetCStr() const;

    PathImpl& GetImpl();

    const PathImpl& GetImpl() const;
};

}
}

#if !defined(NDEBUG) && defined(BUILD_WITH_IMPL)
// Debug and Hybrid builds can pull in implementation details
#include "..\..\include\SymbolString\TSymbolString.h"
#include "..\..\util\pathImpl.h"
#endif


#endif