UT_HprUri.h

Go to the documentation of this file.

/*
* PROPRIETARY INFORMATION.  This software is proprietary to
 * Side Effects Software Inc., and is not to be reproduced,
 * transmitted, or disclosed in any way without written permission.
 *
 * NAME:     UT_HprURI.h ( UT Library, C++)
 *
 * COMMENTS: Class representing HPR paths and methods to extract info
 *           and resolve to filesystem locations.  Also handles versioning
 *           and some utility methods for looking up versions, etc.
 */

#ifndef __UT_HPRURI_H__
#define __UT_HPRURI_H__

#include "FS_API.h"
#include "UT_ShotBuilderConfig.h"
#include <UT/UT_StringMap.h>
#include <UT/UT_StringHolder.h>
#include <UT/UT_StringArray.h>

#define HPR_SIGNATURE               "hpr:"
#define HPR_SIGNATURE_LEN           4
#define HPR_SIGNATURE_NO_COLON      "hpr"
#define HPR_SIGNATURE_NO_COLON_LEN  3
#define HPR_PLACEHOLDER_VERSION     0
#define HPR_PLACEHOLDER_VERSION_STR "0"

class FS_API UT_HprUri
{
public:
    UT_HprUri(const UT_StringHolder&);

    UT_StringHolder        uri() const;
    UT_StringHolder        baseUri() const
                           { return myUri; }
    bool                   isValid() const
                           { return myIsValid; }
    UT_StringHolder        name() const
                           { return myName; }
    UT_StringHolder        extension() const
                           { return myExtension; }
    UT_StringHolder        path() const
                           { return myDirectory; }
    bool                   isVersionSet() const
                           { return myArgs.find("v") != myArgs.end(); }
    UT_StringHolder        version() const
                           { return myArgs.get("v", getPlaceHolderVersion()); }

    void                   setVersion(const UT_StringHolder &version);
    void                   setVersion(int version)
                           { setVersion((std::to_string(version).c_str())); }

    int                    latestVersion() const;
    int                    nextVersion() const;
    UT_IntArray            versions() const;

    // newAsset will only be considered if there is no version specified
    // in the uri.
    UT_StringHolder        resolvedPath(bool newAsset=false);

    static const UT_StringHolder  &getPlaceHolderVersion();

private:
    // Return the full on-disk directory path based on this Uri. If this Uri
    // represents a versioned file, this will include the name.ext suffix
    // (because that's part of the on-disk directory).
    UT_StringHolder                _directory() const;
    UT_StringHolder                _versionFormat() const;
    UT_StringHolder                _fileOrDirName(bool newAsset=false) const;
    int                            _resolveVersion(bool newAsset=false) const;

    UT_StringHolder                myUri;
    UT_StringHolder                myDirectory;
    UT_StringHolder                myName;
    UT_StringHolder                myExtension;
    UT_StringMap<UT_StringHolder>  myArgs;
    UT_StringHolder                myResolvedPath;
    bool                           myIsValid = false;
    bool                           myIsAbsolute = false;
    bool                           myIsVersioned = false;
    bool                           myLastResolvedForNewAsset = false;

    // TODO: do we need a way to set the project path on the config?
    UT_ShotBuilderConfig           myConfig;
};

#endif