HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
PDGT_Utils Class Reference

#include <PDGT_Utils.h>

Static Public Member Functions

static bool loadDSO (const UT_StringHolder &dso_path, const UT_StringHolder &dso_function, void *dso_arg)
 
static bool loadDSO (const UT_StringHolder &dso_function, void *dso_arg)
 
static bool loadPythonModules (const UT_StringHolder &type_module, UT_WorkBuffer &errors)
 
static bool loadPythonPath (const UT_StringHolder &type_module, const UT_StringHolder &path, UT_WorkBuffer &errors)
 Loads PDG types from a Python module at a specifc path on the system. More...
 
static bool reloadPythonModule (const UT_StringHolder &type_module, const UT_StringHolder &python_module, bool reregister, UT_WorkBuffer &errors)
 Reloads the PDG type from the specified Python module. More...
 
static void searchPath (UT_StringArray &path_list, UT_KnownPath search_instance)
 Returns the array of search paths for finding PDG types definitions. More...
 
static bool findFile (const UT_StringHolder &file_name, UT_StringHolder &output_file, UT_KnownPath search_instance)
 
static bool globFiles (UT_StringArray &file_list, UT_KnownPath search_instance, const UT_StringHolder &extension, const UT_StringHolder &subdirectory, bool full_path)
 
static bool globDirectories (UT_StringArray &dir_list, UT_KnownPath search_instance, const UT_StringHolder &search, bool full_path, bool unique)
 Globs all of the directories from the search path. More...
 
static bool globPythonModules (UT_StringArray &file_list, UT_KnownPath search_instance, const UT_StringHolder &subdir, bool full_path, bool unique)
 
static bool moduleSkipList (UT_StringArray &skip_list)
 

Detailed Description

Utility functions for loading PDG type definitions from Python modules and shared libraries.

Definition at line 24 of file PDGT_Utils.h.

Member Function Documentation

static bool PDGT_Utils::findFile ( const UT_StringHolder file_name,
UT_StringHolder output_file,
UT_KnownPath  search_instance 
)
static

Finds the specified file name on the search path, and returns the absolute path to the file.

static bool PDGT_Utils::globDirectories ( UT_StringArray dir_list,
UT_KnownPath  search_instance,
const UT_StringHolder search,
bool  full_path,
bool  unique 
)
static

Globs all of the directories from the search path.

static bool PDGT_Utils::globFiles ( UT_StringArray file_list,
UT_KnownPath  search_instance,
const UT_StringHolder extension,
const UT_StringHolder subdirectory,
bool  full_path 
)
static

Globs all files with the specified extension on the PDG search path, with an optional subdirectory.

static bool PDGT_Utils::globPythonModules ( UT_StringArray file_list,
UT_KnownPath  search_instance,
const UT_StringHolder subdir,
bool  full_path,
bool  unique 
)
static

Globs the list of import-able Python modules from the PDG type search path.

static bool PDGT_Utils::loadDSO ( const UT_StringHolder dso_path,
const UT_StringHolder dso_function,
void dso_arg 
)
static

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 PDGT_Utils::loadDSO ( const UT_StringHolder dso_function,
void dso_arg 
)
static

Loads shared libraries on the Houdini dso path that have the specified dso_function and calls that function with the dso_arg.

static bool PDGT_Utils::loadPythonModules ( const UT_StringHolder type_module,
UT_WorkBuffer errors 
)
static

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 PDGT_Utils::loadPythonPath ( const UT_StringHolder type_module,
const UT_StringHolder path,
UT_WorkBuffer errors 
)
static

Loads PDG types from a Python module at a specifc path on the system.

static bool PDGT_Utils::moduleSkipList ( UT_StringArray skip_list)
static

Returns a list of directories/files to skip when globbing python modules

static bool PDGT_Utils::reloadPythonModule ( const UT_StringHolder type_module,
const UT_StringHolder python_module,
bool  reregister,
UT_WorkBuffer errors 
)
static

Reloads the PDG type from the specified Python module.

static void PDGT_Utils::searchPath ( UT_StringArray path_list,
UT_KnownPath  search_instance 
)
static

Returns the array of search paths for finding PDG types definitions.


The documentation for this class was generated from the following file: