VEX/VEX_VexResolver.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.
 *
 * Produced by:
 *      Mark Elendt
 *      Side Effects Software Inc
 *      477 Richmond Street West
 *      Toronto, Ontario
 *      Canada   M5V 3E7
 *      416-504-9876
 *
 * NAME:        VEX_VexResolver.h ( VEX Library, C++)
 *
 * COMMENTS:    A class with virtual functions for getting VEX code from
 *              Vop networks. See VOPNET_VexResolver for the real
 *              implementation.
 */

#ifndef __VEX_VexResolver__
#define __VEX_VexResolver__

#include "VEX_API.h"
#include <iostream.h>
#include <UT/UT_String.h>
#include <UT/UT_PtrArray.h>

class VEX_VexResolver;

typedef UT_PtrArray<VEX_VexResolver *>   VEX_VexResolverArray;

class VEX_API VEX_VexResolver
{
public:
    static bool          needsVexResolver(const char *shader);
    static bool          needsVexResolverForMantraOutput(const char *shader);
    static bool          getVflCode(const char *shader, ostream &os,
                                    const char *shadername = 0);
    static bool          getVexCode(const char *shader, ostream &os,
                                    const char *shadername = 0);
    static bool          getVexContext(const char *shader, UT_String &ctx);

    /// Resolvers may support relative paths in the shader string.  Sometimes,
    /// however, you'll want to use the shader string as an identifier.  For
    /// example, you might want to cache the resolved result.  To safely do so
    /// you'll need a canonical string with the relative paths resolved.  This
    /// method performs this conversion, returning true and setting the output
    /// string only when some resolution had to be performed.
    static bool          convertToCanonicalPath(const char *shader,
                                                UT_String &canonical_shader);

protected:
                         VEX_VexResolver();
    virtual             ~VEX_VexResolver();

    virtual bool         canResolveCode(const char *shader) = 0;
    virtual bool         supportedByMantra() = 0;
    virtual bool         resolveVflCode(const char *shader,
                                        ostream &os,
                                        const char *shadername) = 0;
    virtual bool         resolveVexCode(const char *shader,
                                        ostream &os,
                                        const char *shadername) = 0;
    virtual bool         resolveVexContext(const char *shader,
                                        UT_String &ctx) = 0;
    virtual bool         resolveCanonicalPath(const char *shader,
                                              UT_String &canonical_shader) = 0;

private:
    static void                  addVexResolver(VEX_VexResolver *resolver);
    static void                  removeVexResolver(VEX_VexResolver *resolver);
    static VEX_VexResolverArray &getVexResolvers();
};

#endif

---