UT_VarEncode.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.
 *
 *      See: https://tools.ietf.org/html/rfc3492
 *
 */

#ifndef __UT_VarEncode__
#define __UT_VarEncode__

#include "UT_API.h"
#include <SYS/SYS_Types.h>

class UT_StringHolder;

class UT_API UT_VarEncode
{
public:
    /// @{ Returns an encoded variable name, if @c var contains any characters
    /// illegal in a C-style variable name. Note, the encoding is prefixed.
    /// If @c var contains only valid C-variable characters, returns it unencoded.
    static UT_StringHolder       encodeVar(const UT_StringHolder &var);
    static UT_StringHolder       decodeVar(const UT_StringHolder &var);
    /// @}

    /// @{ Returns an encoded attribute name, if @c var contains any characters
    /// illegal in a geometry attribute name. Note, the encoding is prefixed.
    /// If @c var contains only valid C-variable characters, returns it unencoded.
    static UT_StringHolder       encodeAttrib(const UT_StringHolder &attr);
    static UT_StringHolder       decodeAttrib(const UT_StringHolder &attr);
    /// @}

    /// @{ Returns an encoded parameter name, if @c var contains any characters
    /// illegal in a node parameter name. Note, the encoding is prefixed.
    /// If @c var contains only valid C-variable characters, returns it unencoded.
    static UT_StringHolder       encodeParm(const UT_StringHolder &parm);
    static UT_StringHolder       decodeParm(const UT_StringHolder &parm);
    /// @}

    /// @{ Does a simple test on the string to look for the encoding prefix.
    /// Returns true if found, indicating that the string is already encoded.
    /// This lets us avoid double-encoding the string.
    static bool                  isEncoded(const UT_StringHolder &str);
    /// @}

private:
    static UT_StringHolder       encode(const UT_StringHolder &value,
                                        const char *safechars);
    static UT_StringHolder       decode(const UT_StringHolder &value,
                                        const char *safechars);
};

#endif