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 <vector>

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) = 0;
    virtual std::string expandStringAtFrame(const char *str, double frame) = 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;

    // 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) = 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;
};

#endif