VOP/VOP_Language.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:
 *      Side Effects Software Inc
 *      477 Richmond Street West
 *      Toronto, Ontario
 *      Canada   M5V 3E7
 *      416-504-9876
 *
 * NAME:        VOP_Language.h ( VOP Library, C++)
 *
 * COMMENTS:    This is an abstraction for different languages for VOPs.
 *              This class is basically a mapper from the parameters to types
 *              and other stuff.
 */

#ifndef __VOP_Language__
#define __VOP_Language__

#include "VOP_API.h"
#include <iostream.h>
#include <PRM/PRM_Type.h>
#include "VOP_Types.h"

class UT_String;
class UT_WorkBuffer;
class UT_SymbolTable;
class PRM_ChoiceList;
class PRM_Template;

class VOP_API VOP_Language {
public:
             VOP_Language();
    virtual ~VOP_Language();

    static VOP_Type      castVexType(VEX_Type type);

    static VOP_Language         *getVex();
    static VOP_Language         *getRsl();
    static VOP_Language         *guessFromNetworkPattern(const char *pattern);

    static const char           *getTypeDescription(VOP_Type type);
    virtual const char          *getTypeUIColor(VOP_Type type) const;

    static bool                  isValidType(int type);

    virtual const char          *getName() const = 0;
    virtual const char          *getFileExtension() const = 0;

    virtual int                  isVex() const;

    virtual int                  supportsUniformVarying() const = 0;
    virtual int                  isParameterUniformVarying(int idx) const = 0;

    // PRM mappings used for constant and parameter VOPs
    virtual int                  getNumParmTypes() const;
    virtual VOP_Type             getParmType(int idx) const;
    virtual VOP_Type             getUnconditionedParmType(int idx) const;
    virtual const char          *getParmName(int idx) const;
    virtual int                  allowMenu(int idx) const;
    virtual void                 fillSwitcherTemplate(PRM_Template *,
                                            int with_ranges) const;
    virtual void                 fillParmTemplate(PRM_Template *, int) const;
    virtual int                  fillDialogScript(int idx,
                                                  UT_String &ds_type,
                                                  int &ds_size) const;
    virtual int                  fillVexPragma(int idx,
                                               UT_String &vex_pragma) const;
    virtual int                  guessParmIndex(VOP_Type voptype,
                                                PRM_Type parmtype,
                                                int size) const;
    virtual int                  getParmIndex(VOP_Type type) const;
    virtual int                  getSingleFloatParmIndex() const;
    virtual int                  getSingleIntParmIndex() const;
    virtual int                  getPossibleOpListIndex() const;
    virtual PRM_ChoiceList      *getParmTypeMenu() const;

    // Take an arbitrary type and return the language supported type
    virtual VOP_Type             conditionType(VOP_Type type) const = 0;
    int                          isTypeSupported(VOP_Type type) const
                                   { return conditionType(type) == type; }

    virtual const char          *getExportKeyword() const = 0;
    virtual const char          *getSprintf() const = 0;
    virtual const char          *getIsBoundFunction() const = 0;

    virtual const char          *getParameterOpName() const;
    virtual const char          *getConstantOpName() const;

    virtual const char          *getEmptyConstantString(VOP_Type t) const = 0;
    virtual void                 getConstantString(UT_String &str,
                                                VOP_Type t,
                                                int unquoted,
                                                const UT_String v[]) const = 0;

    // Type name mappings.  The different languages may perform different
    // mappings for the abstract VOP types/storage.
    virtual VOP_Type             getTypeFromString(const char *str) const;
    virtual const char          *getDialogStringFromType(VOP_Type type) const;
    virtual const char          *getCodeStringFromType(VOP_Type type) const=0;
    virtual const char          *getVaryingStringFromType(VOP_Type type) const;

    virtual const UT_SymbolTable&getReservedWords() const = 0;
};

#endif

---