OP/OP_OTLLibrary.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:        OP_OTLLibrary.h ( OTL Library, C++)
 *
 * COMMENTS:
 *
 */

#ifndef __OP_OTLLibrary__
#define __OP_OTLLibrary__

#include "OP_API.h"
#include <UT/UT_String.h>
#include <UT/UT_SymbolTable.h>
#include <FS/FS_IndexFile.h>
#include <VEX/VEX_VexTypes.h>
#include "OP_OTLDefinition.h"

#define OTL_LIBRARY_PREFIX              "oplib:"
#define OTL_DEFINITION_PREFIX           "opdef:"
#define OTL_DS_SECTION                  "DialogScript"
#define OTL_CREATESCRIPT_SECTION        "CreateScript"
#define OTL_CONTENTS_SECTION            "Contents"
#define OTL_CONTENTS_GZ_SECTION         "Contents.gz"
#define OTL_EDITABLE_SUBNODES_SECTION   "EditableNodes"
#define OTL_MESSAGE_SUBNODES_SECTION    "MessageNodes"
#define OTL_SELECTORS_SECTION           "Selectors"
#define OTL_SHELFTOOLS_SECTION          "Tools.shelf"
#define OTL_VEX_SECTION                 "VexCode"
#define OTL_PYTHON_COOK_SECTION         "PythonCook"
#define OTL_VFL_SECTION                 "VflCode"
#define OTL_HELP_SECTION                "Help"
#define OTL_HELPURL_SECTION             "HelpUrl"
#define OTL_ICON_SECTION                "Icon"
#define OTL_ICONIMAGE_SECTION           "IconImage"
#define OTL_ICONSVG_SECTION             "IconSVG"
#define OTL_PRESETS_SECTION             "Presets"
#define OTL_COMMENT_SECTION             "Comment"
#define OTL_VERSION_SECTION             "Version"
#define OTL_EXPRESSIONS_SECTION         "Expressions"
#define OTL_PYTHONMODULE_SECTION        "PythonModule"
#define OTL_PREFIRSTCREATE_SECTION      "PreFirstCreate"
#define OTL_ONCREATED_SECTION           "OnCreated"
#define OTL_ONLOADED_SECTION            "OnLoaded"
#define OTL_ONUPDATED_SECTION           "OnUpdated"
#define OTL_ONDELETED_SECTION           "OnDeleted"
#define OTL_POSTLASTDELETE_SECTION      "PostLastDelete"
#define OTL_ONINPUTCHANGED_SECTION      "OnInputChanged"
#define OTL_ONNAMECHANGED_SECTION       "OnNameChanged"
#define OTL_TYPEPROPOPTIONS_SECTION     "TypePropertiesOptions"
#define OTL_EXTRAFILEOPTIONS_SECTION    "ExtraFileOptions"
#define OTL_SDLAYOUT_SECTION            "SDLayout"
#define OTL_CPLAYOUT_SECTION            "CPLayout"
#define OTL_CPIMAGE_SECTION             "CPImage"
#define OTL_GALLERY_SECTION             "Gallery"
#define OTL_GLSL_VERTEX_SECTION         "GlslVertex"
#define OTL_GLSL_FRAGMENT_SECTION       "GlslFragment"
#define OTL_SCRIPT_MAT_INFO_SECTION     "ScriptMaterialInfo"

#define OTL_VEX_SECTION_SUFFIX          OTL_VEX_SECTION
#define OTL_VFL_SECTION_SUFFIX          OTL_VFL_SECTION

#define OTL_SURFACE_VEX_SECTION         "Surface"OTL_VEX_SECTION_SUFFIX
#define OTL_SURFACE_VFL_SECTION         "Surface"OTL_VFL_SECTION_SUFFIX
#define OTL_DISPLACE_VEX_SECTION        "Displacement"OTL_VEX_SECTION_SUFFIX
#define OTL_DISPLACE_VFL_SECTION        "Displacement"OTL_VFL_SECTION_SUFFIX
#define OTL_LIGHT_VEX_SECTION           "Light"OTL_VEX_SECTION_SUFFIX
#define OTL_LIGHT_VFL_SECTION           "Light"OTL_VFL_SECTION_SUFFIX
#define OTL_SHADOW_VEX_SECTION          "Shadow"OTL_VEX_SECTION_SUFFIX
#define OTL_SHADOW_VFL_SECTION          "Shadow"OTL_VFL_SECTION_SUFFIX
#define OTL_FOG_VEX_SECTION             "Fog"OTL_VEX_SECTION_SUFFIX
#define OTL_FOG_VFL_SECTION             "Fog"OTL_VFL_SECTION_SUFFIX
#define OTL_PHOTON_VEX_SECTION          "Photon"OTL_VEX_SECTION_SUFFIX
#define OTL_PHOTON_VFL_SECTION          "Photon"OTL_VFL_SECTION_SUFFIX
#define OTL_CHOP_VEX_SECTION            "Chop"OTL_VEX_SECTION_SUFFIX
#define OTL_CHOP_VFL_SECTION            "Chop"OTL_VFL_SECTION_SUFFIX
#define OTL_POP_VEX_SECTION             "Pop"OTL_VEX_SECTION_SUFFIX
#define OTL_POP_VFL_SECTION             "Pop"OTL_VFL_SECTION_SUFFIX
#define OTL_SOP_VEX_SECTION             "Sop"OTL_VEX_SECTION_SUFFIX
#define OTL_SOP_VFL_SECTION             "Sop"OTL_VFL_SECTION_SUFFIX
#define OTL_COP2_VEX_SECTION            "Cop2"OTL_VEX_SECTION_SUFFIX
#define OTL_COP2_VFL_SECTION            "Cop2"OTL_VFL_SECTION_SUFFIX
#define OTL_I3D_VEX_SECTION             "Image3d"OTL_VEX_SECTION_SUFFIX
#define OTL_I3D_VFL_SECTION             "Image3d"OTL_VFL_SECTION_SUFFIX
#define OTL_CVEX_VEX_SECTION            "CVex"OTL_VEX_SECTION_SUFFIX
#define OTL_CVEX_VFL_SECTION            "CVex"OTL_VFL_SECTION_SUFFIX


#define OTL_INTERNAL                    "Embedded"
#define OTL_INTERNAL_META               "Current HIP File"
#define OTL_FALLBACK_META               "Fallback Libraries"
#define OTL_OTLSCAN_META                "Scanned OTL Directories"



class OP_API OP_OTLLibrary : public FS_IndexFile
{
public:
             OP_OTLLibrary();
             OP_OTLLibrary(FS_Reader *reader);
             OP_OTLLibrary(const char *source, const char *metasrc);
    virtual ~OP_OTLLibrary();

    const UT_String     &getMetaSource() const;
    const UT_String     &getSource() const;

    enum OP_ModTimeStatus 
    {
        MOD_TIME_OK,            //modifiction time was obtained without errors
        MOD_TIME_INTERNAL,      //error; definition is internal (embedded)
        MOD_TIME_SAVE_QUIT,     //error; user chose save and quit
        MOD_TIME_DISCARD_QUIT,  //error; user chose discard and quit
        MOD_TIME_EMBED          //error; user chose to embed dummy definition
    };

    /// Checks if filename has a .otl, if not, appends it.
    /// Respects OTL_INTERNAL and other magic constants.
    /// Returns true if filename was modified
    static bool          forceOTLExtension(UT_String &filename);
    
    /// Constructs a good vfl and vex code section names given the original
    /// suggestion.
    static void          getVexAndVflSectionNames( const char * suggestion,
                                    UT_String & vexsect, UT_String & vflsect);

    // obtains the source's modification time. If source is not accessible,
    // a pop-up dialog is displayed to prompt for an action:
    // save & quit, discard & quit, retry, or embed)
    // OUTPUTS:
    //  mod_time - a modification time of the source
    // RETURNS:
    //  status of the attempt of getting modification time
    OP_ModTimeStatus     getSourceModTime( int &mod_time ) const;

    bool                 addDefinition(const OP_OTLDefinition &definition,
                                       int modtime = -1);
    bool                 removeDefinition(int index);

    int                  getNumDefinitions() const;
    int                  getDefinitionIndex(const char *tablename,
                                            const char *opname) const;
    int                  getDefinitionModTime(int index) const;
    const UT_String     &getDefinitionName(int index) const;
    const UT_String     &getDefinitionOpTableName(int index) const;
    bool                 getDefinitionIsDummy(int index) const;
    bool                 getDefinition(int index,
                                       OP_OTLDefinition &definition) const;

    void                 mergeLibrary(const OP_OTLLibrary &lib);

    virtual bool         expandToDirectory(const char *destdir);
    virtual bool         collapseFromDirectory(const char *srcdir);
    virtual void         writeFile(ostream &os);

    void                 setIsBeingRefreshed(bool beingrefreshed);
    bool                 getIsBeingRefreshed() const;

    static bool          createBackupFile(const char *filename);
    static bool          isReservedSectionName(const char *sectname);
    static const char   *getEventName(int index);
    static const char   *getEventSectionName(int index);

    static const char   *getVexCodeSectionName(VEX_ContextType type);
    static const char   *getVflCodeSectionName(VEX_ContextType type);

private:
    void                 readDefinitions();
    void                 saveDefinitionsToSection(bool binary);

    static const char   *getTableSymbol(const char *table, const char *op);

    const UT_String              mySource;
    const UT_String              myMetaSource;
    OP_OTLDefinitionArray        myDefinitions;
    UT_SymbolTable               myDefinitionTable;
    bool                         myIsBeingRefreshed;
};

#endif

---