PDGT_Utils.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 __PDGT_UTILS_H__
#define __PDGT_UTILS_H__

#include "PDGT_API.h"

#include <UT/UT_KnownPath.h>

class UT_StringArray;
class UT_StringHolder;
class UT_WorkBuffer;

/**
 * Utility functions for loading PDG type definitions from Python modules
 * and shared libraries.
 */
class PDGT_API PDGT_Utils
{
public:
    /// Loads a shared library containing PDG type definitions, given a path
    /// to the dso, the name of the function to call in the library and the
    /// argument to that function.
    static bool loadDSO(const UT_StringHolder& dso_path,
                        const UT_StringHolder& dso_function,
                        void* dso_arg);

    static bool loadDSOFromPath(const UT_StringHolder& dso_path,
                        const UT_StringHolder& dso_function,
                        void* dso_arg);

    /// Loads shared libraries on the Houdini dso path that have the specified
    /// dso_function and calls that function with the dso_arg.
    static bool loadDSO(const UT_StringHolder& dso_function, void* dso_arg);

    /// Loads PDG types from all Python modules, and stores them in the module
    /// specified by `type_module`. For example, in PDG the type_module is
    /// set to `pdg.types`.
    static bool loadPythonModules(const UT_StringHolder& type_module,
                                  UT_WorkBuffer& errors);

    /// Loads PDG types from a Python module at a specifc path on the system.
    static bool loadPythonPath(const UT_StringHolder& type_module,
                               const UT_StringHolder& path,
                               UT_WorkBuffer& errors);

    /// Reloads the PDG type from the specified Python module.
    static bool reloadPythonModule(const UT_StringHolder& type_module,
                                   const UT_StringHolder& python_module,
                                   bool reregister,
                                   UT_WorkBuffer& errors);

    /// Returns the array of search paths for finding PDG types definitions.
    static void searchPath(UT_StringArray& path_list,
                           UT_KnownPath search_instance);

    /// Finds the specified file name on the search path, and returns the
    /// absolute path to the file.
    static bool findFile(const UT_StringHolder& file_name,
                         UT_StringHolder& output_file,
                         UT_KnownPath search_instance);


    /// Globs all files with the specified extension on the PDG search path,
    /// with an optional subdirectory.
    static bool globFiles(UT_StringArray& file_list,
                          UT_KnownPath search_instance,
                          const UT_StringHolder& extension,
                          const UT_StringHolder& subdirectory,
                          bool full_path);

    /// Globs all of the directories from the search path
    static bool globDirectories(UT_StringArray& dir_list,
                                UT_KnownPath search_instance,
                                const UT_StringHolder& search,
                                bool full_path,
                                bool unique);

    /// Globs the list of import-able Python modules from the PDG type
    /// search path.
    static bool globPythonModules(UT_StringArray& file_list,
                                  UT_KnownPath search_instance,
                                  const UT_StringHolder& subdir,
                                  bool full_path,
                                  bool unique);

    /// Returns a list of directories/files to skip when globbing python
    /// modules
    static bool moduleSkipList(UT_StringArray& skip_list);
};

#endif