HOM_text.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.
 *
 * COMMENTS:
 */

#ifndef __HOM_text_h__
#define __HOM_text_h__

#include "HOM_API.h"
#include "HOM_Defines.h"
#include <SYS/SYS_Types.h>
#include <vector>
#include <map>

SWIGOUT(%rename(text) HOM_text;)

class HOM_API HOM_text
{
public:
    virtual ~HOM_text()
    { }

    virtual std::string __repr__() = 0;

    virtual std::string expandString(const char *str,
            bool expand_tilde = true) = 0;
    virtual std::string expandStringAtFrame(const char *str, double frame,
            bool expand_tilde = true) = 0;
    virtual std::string expandHuskFilePath(const char *str,
            double frame_start = 1.0,
            double frame_inc = 1.0,
            int frame_idx = 0) = 0;
    virtual std::string incrementNumberedString(const char *str) = 0;

    // Use Punycode-like scheme to encode and decode strings with special
    // characters into a form that can be used as a variable, attribute, or
    // parameter name.
    virtual std::string encode(const char *varname) = 0;
    virtual std::string decode(const char *varname) = 0;
    virtual std::string encodeAttrib(const char *attribname) = 0;
    virtual std::string decodeAttrib(const char *attribname) = 0;
    virtual std::string encodeParm(const char *parmname) = 0;
    virtual std::string decodeParm(const char *parmname) = 0;

    virtual std::string _obfuscate(const char *text) = 0;
    virtual std::string _deobfuscate(const char *text) = 0;

    // Expose the UT_String forceAlphaNumeric method.
    virtual std::string alphaNumeric(const char *str) = 0;

    // parse strings like 1-10:2,3 to return
    // an array of all the integers comprised within that pattern
    virtual std::vector<int> parseNumericPattern(const char *str, 
                                                 int max=SYS_INT32_MAX) = 0;

    // Expose the UT_String forceValidVariableName method.
    SWIGOUT(%kwargs variableName;)
    virtual std::string variableName(
            const char *str,
            const char *safe_chars = nullptr) = 0;

    SWIGOUT(%kwargs isValidVariableName;)
    virtual bool isValidVariableName(
            const char *str,
            const char *safe_chars = nullptr) = 0;

    // Expose the GU_PackedFolder forceValidPathName method.
    virtual std::string packedFolderName(
            const char *str) = 0;

    virtual bool isValidPackedFolderName(
            const char *str) = 0;

    // Expose the UT_String compareVersionString method.
    virtual int compareVersionString(const char *str1, const char *str2) = 0;

    // Convert paths from relative to absolute, or vice versa.
    SWIGOUT(%kwargs abspath;)
    virtual std::string abspath(const char *path,
            const char *anchor_path = nullptr) = 0;
    SWIGOUT(%kwargs relpath;)
    virtual std::string relpath(const char *path,
            const char *anchor_path = nullptr,
            bool allow_relative_path_from_root = true) = 0;
    virtual std::string normpath(const char *path) = 0;

    // Collapse a file path if it starts with the expanded form of one of our
    // standard env vars (HIP, JOB).
    SWIGOUT(%kwargs collapseCommonVars;)
    virtual std::string collapseCommonVars(const char *path,
            const std::vector<std::string> &vars =
                std::vector<std::string>()) = 0;

    // Access to CE_Snippet, allows processing of opencl snippets.
    /// Returns set of bindings specified with #bind commands.
    virtual std::vector<std::map<std::string,hboost::any> > oclExtractBindings(const char *code) = 0;
    /// Returns the value specified with #runover
    virtual std::string oclExtractRunOver(const char *code) = 0;

    virtual std::string patternRename(const char *str, const char* find, const char* replace) = 0;
    SWIGOUT(%kwargs patternMatch;)
    virtual bool patternMatch(const char *pattern, const char* str, bool ignore_case=false, bool path_match=false) = 0;
};

#endif