Diff: vm/class.h

Revision:

0:65f1469d6bfb

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/vm/class.h	Sat Mar 02 11:54:20 2013 +0000
@@ -0,0 +1,132 @@
+/*
+# This file is Copyright 2009 Dean Hall.
+# This file is part of the PyMite VM.
+# This file is licensed under the MIT License.
+# See the LICENSE file for details.
+*/
+
+
+#ifndef __CLASS_H__
+#define __CLASS_H__
+
+/** 
+ * \file
+ *  \brief Class header. 
+ */
+
+
+/**
+ * Class struct
+ *
+ * This C struct is used for PyMite class objects
+ * Note: Exceptions are objects.
+ */
+typedef struct PmClass_s
+{
+    /** Object descriptor */
+    PmObjDesc_t od;
+
+    /** Attributes dict */
+    pPmDict_t cl_attrs;
+    
+    /** Bases tuple */
+    pPmTuple_t cl_bases;
+} PmClass_t,
+ *pPmClass_t;
+
+/** Class instance struct */
+typedef struct PmInstance_s
+{
+    /** Object descriptor */
+    PmObjDesc_t od;
+
+    /** Class of this instance */
+    pPmClass_t cli_class;
+
+    /** Attributes dict */
+    pPmDict_t cli_attrs;
+} PmInstance_t, 
+*pPmInstance_t;
+
+/** Method struct */
+typedef struct PmMethod_s
+{
+    /** Object descriptor */
+    PmObjDesc_t od;
+
+    /** Class instance of this method */
+    pPmInstance_t m_instance;
+    
+    /** Func of this method */
+    pPmFunc_t m_func;
+    
+    /** Attributes dict */
+    pPmDict_t m_attrs;
+} PmMethod_t, 
+*pPmMethod_t;
+
+
+/**
+ * Creates a new Class object from the methods dict, bases tuple,
+ * and name string.
+ *
+ * @param   pmeths ptr to methods dict.
+ * @param   pbases ptr to bases tuple.
+ * @param   pname ptr to name string.
+ * @param   r_pclass Return by ref, ptr to new class
+ * @return  Return status
+ */
+PmReturn_t class_new(pPmObj_t pmeths, pPmObj_t pbases, pPmObj_t pname,
+                     pPmObj_t *r_pclass);
+
+/**
+ * Returns an instance of the given class
+ *
+ * @param pclass Pointer to class object
+ * @param r_pobj Return by ref, instance object
+ * @return  Return status
+ */
+PmReturn_t class_instantiate(pPmObj_t pclass, pPmObj_t *r_pobj);
+
+#ifdef HAVE_AUTOBOX
+/**
+ * Autoboxes an object in place
+ *
+ * @param pclass Pointer to object
+ * @return  Return status
+ */
+PmReturn_t class_autobox(pPmObj_t *pobj);
+#endif
+
+/**
+ * Returns a method based on the given inputs
+ *
+ * @param   pinstance ptr to instance
+ * @param   pfunc ptr to func
+ * @param   r_pmeth Return by ref, ptr to new method
+ * @return  Return status
+ */
+PmReturn_t class_method(pPmObj_t pinstance, pPmObj_t pfunc, pPmObj_t *r_pmeth);
+
+/**
+ * Returns the first attribute named __init__ in the class' inheritance tree
+ *
+ * @param   pobj ptr to class or instance to search
+ * @param   pname ptr to name of attr to find
+ * @param   r_pobj Return by ref, ptr to attr if found, or undetermined
+ * @return  Return status
+ */
+PmReturn_t class_getAttr(pPmObj_t pobj, pPmObj_t pname, pPmObj_t *r_pobj);
+
+/**
+ * Returns a C boolean if the base class is found in the inheritance tree
+ * of the test class.  NOTE: This function is recursive.
+ *
+ * @param   ptest_class ptr to class whose inheritance tree is searched
+ * @param   pbase_class ptr to class to look for
+ * @return  Returns C_TRUE if pbase_class is found in the inheritance tree;
+ *          C_FALSE otherwise.
+ */
+uint8_t class_isSubclass(pPmObj_t ptest_class, pPmObj_t pbase_class);
+
+#endif /* __CLASS_H__ */