module.h

00001 /*
00002 # This file is Copyright 2003, 2006, 2007, 2009 Dean Hall.
00003 #
00004 # This file is part of the PyMite VM.
00005 # The PyMite VM is free software: you can redistribute it and/or modify
00006 # it under the terms of the GNU GENERAL PUBLIC LICENSE Version 2.
00007 #
00008 # The PyMite VM is distributed in the hope that it will be useful,
00009 # but WITHOUT ANY WARRANTY; without even the implied warranty of
00010 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
00011 # A copy of the GNU GENERAL PUBLIC LICENSE Version 2
00012 # is seen in the file COPYING in this directory.
00013 */
00014 
00015 
00016 #ifndef __MODULE_H__
00017 #define __MODULE_H__
00018 
00019 
00020 /**
00021  * \file
00022  * \brief Module Object Type
00023  *
00024  * Module object type header.
00025  */
00026 
00027 
00028 /**
00029  * Creates a Module Obj for the given Code Obj.
00030  *
00031  * Use a func struct to represent the Module obj because
00032  * the module's construction code must execute later,
00033  * but set the type to OBJ_TYPE_MOD so that it is
00034  * not otherwise callable.
00035  *
00036  * @param   pco Ptr to code obj
00037  * @param   pmod Return by reference; ptr to new module obj
00038  * @return  Return status
00039  */
00040 PmReturn_t mod_new(pPmObj_t pco, pPmObj_t *pmod);
00041 
00042 /**
00043  * Imports a module of the given name.
00044  * Searches for an image with a matching name.
00045  * A code obj is created for the code image.
00046  * A module obj is created for the code obj.
00047  *
00048  * @param   pstr String obj containing name of code obj to load.
00049  * @param   pmod Return by reference; ptr to imported module
00050  * @return  Return status
00051  */
00052 PmReturn_t mod_import(pPmObj_t pstr, pPmObj_t *pmod);
00053 
00054 #endif /* __MODULE_H__ */