pathString.h

Go to the documentation of this file.

#line 1 "S:/jenkins/workspace/ECP/ufe/ufe-full-python3.11-windows/ufe/include/pathString.h"
#ifndef _ufePathString
#define _ufePathString
// ===========================================================================
// Copyright 2021 Autodesk, Inc. All rights reserved.
//
// Use of this software is subject to the terms of the Autodesk license
// agreement provided at the time of installation or download, or which
// otherwise accompanies this software in either electronic or hard copy form.
// ===========================================================================
 
#include "path.h"               // For Path::Segment
 
#include <string>
#include <functional>
#include <list>
 
UFE_NS_DEF {
 
namespace PathString {
 
typedef std::function<Path(const Path::Segments&)> CreatePathFn;
typedef std::function<Path(const std::string&)>    CreateSingleSegmentPathFn;
typedef std::function<std::string(const Path&)>    StringFn;
 
UFE_SDK_DECL Path path(const std::string& pathString);
 
UFE_SDK_DECL std::string string(const Path& path);
 
UFE_SDK_DECL std::string pathSegmentSeparator();
 
UFE_SDK_DECL void setPathSegmentSeparator(const std::string& separator);
 
UFE_SDK_DECL CreatePathFn createPathFn();
 
UFE_SDK_DECL void setCreatePathFn(const CreatePathFn& fn);
 
UFE_SDK_DECL CreateSingleSegmentPathFn createSingleSegmentPathFn(
    const Rtid& rtId);
 
UFE_SDK_DECL void setCreateSingleSegmentPathFn(
    const Rtid&                      rtId,
    const CreateSingleSegmentPathFn& fn);
 
UFE_SDK_DECL StringFn stringFn();
 
UFE_SDK_DECL void setStringFn(const StringFn& fn);
 
UFE_SDK_DECL void registerPathComponentSeparator(const Rtid& rtId, char sep);
 
UFE_SDK_DECL void unregisterPathComponentSeparator(const Rtid& rtId, char sep);
 
UFE_SDK_DECL std::list<Ufe::Rtid> pathComponentSeparatorRunTimeIds(char sep);
 
}
 
}
 
#endif /* _ufePathString */