[yast-commit] r48668 - /trunk/python-bindings/src/YCP.cc

27 Jun 2008

Author: juhliarik
Date: Fri Jun 27 17:31:56 2008
New Revision: 48668

URL: http://svn.opensuse.org/viewcvs/yast?rev=48668&view=rev
Log:
added description of functions

M    python-bindings/src/YCP.cc
        * added description

Modified:
    trunk/python-bindings/src/YCP.cc

Modified: trunk/python-bindings/src/YCP.cc
URL: http://svn.opensuse.org/viewcvs/yast/trunk/python-bindings/src/YCP.cc?rev=48668&r1=48667&r2=48668&view=diff
==============================================================================

--- trunk/python-bindings/src/YCP.cc (original)
+++ trunk/python-bindings/src/YCP.cc Fri Jun 27 17:31:56 2008
@@ -69,6 +69,13 @@
 
 void InitYCPTermList();
 
+/**
+ * Function check SymbolEntry and add name
+ * to ycpListFunctions if it is function or
+ * add it to ycpListVariables if it is variable
+ * @param const SymbolEntry for analyse
+ * @return bool always return true
+ */
 static bool HandleSymbolTable (const SymbolEntry & se) 
 {
 	if (se.isFunction ()) {
@@ -108,42 +115,76 @@
 	return ns;
 }
 
-
+/**
+ * defined function for "run" from static python module ycp
+ * it is in static PyMethodDef YCPMethods[]
+ * @param PyObject *self
+ * @param PyObject *args
+ * @return PyObject * return value from CallYCPFunction()
+ */
 static PyObject * ycp_handle_function(PyObject *self, PyObject *args) 
 {
 	return CallYCPFunction (args);
 }
 
-
+/**
+ * defined function for "import_module" from static python module ycp
+ * it is in static PyMethodDef YCPMethods[]
+ * @param PyObject *self
+ * @param PyObject *args
+ * @return PyObject * return value from ImportYCPNameSpace()
+ */
 static PyObject * ycp_import_namespace(PyObject *self, PyObject *args) 
 {
 	return ImportYCPNameSpace (args);
 }
 
+/**
+ * defined function for "init_ui" from static python module ycp
+ * it is in static PyMethodDef YCPMethods[]
+ * @param PyObject *self
+ * @param PyObject *args
+ * @return PyObject * return value from InitUI()
+ */
 static PyObject * ycp_init_ui(PyObject *self, PyObject *args) 
 {
 	return InitUI (args);
 }
 
 
-static PyObject * ycp_scr_handle(PyObject *self, PyObject *args) 
-{
-	return _SCR_Run(args);
-}
-
-
+/**
+ * defined function for "y2logger" from static python module ycp
+ * it is in static PyMethodDef YCPMethods[]
+ * @param PyObject *self
+ * @param PyObject *args
+ * @return PyObject * always Py_None
+ */
 static PyObject * ycp_y2logger (PyObject *self, PyObject *args) 
 {
 	PyY2logger(args);
 	return Py_None;
 }
 
-
+/**
+ * defined function for "widget_names" from static python module ycp
+ * it is in static PyMethodDef YCPMethods[]
+ * @param PyObject *self
+ * @param PyObject *args
+ * @return PyObject * return value from InitTerm()
+ */
 static PyObject * ycp_init_term(PyObject *self, PyObject *args) 
 {
 	return InitTerm(args);
 }
 
+
+/**
+ * defined function for "__change_widget_name" from static python module ycp
+ * it is in static PyMethodDef YCPMethods[]
+ * @param PyObject *self
+ * @param PyObject *args
+ * @return PyObject * return value from ChangeWidgetName()
+ */
 static PyObject * ycp_change_widget_name(PyObject *self, PyObject *args)
 {
 	return ChangeWidgetName(args);
@@ -159,9 +200,21 @@
 	{NULL, NULL, 0, NULL}
 };
 
+/**
+ * defined function for "__scr_run" from python module for SCR 
+ * it is in static PyMethodDef scr_methods[]
+ * @param PyObject *self
+ * @param PyObject *args
+ * @return PyObject * return value from _SCR_Run()
+ */
+static PyObject * ycp_scr_handle(PyObject *self, PyObject *args) 
+{
+	return _SCR_Run(args);
+}
+
 
 /**
- * This is necessary for regulat (python style) calling SCR from python
+ * This is necessary for regular (python style) calling SCR from python
  */
 static PyMethodDef scr_methods[] = 
 {
@@ -178,6 +231,9 @@
 	{NULL, NULL, 0, NULL}
 };
 
+/**
+ * Basic definition of methods python module ycp
+ */
 static PyMethodDef YCPMethods[] = 
 {
 	{"run",  ycp_handle_function, METH_VARARGS, "Calling YCP from Python"},
@@ -189,6 +245,12 @@
 	{NULL, NULL, 0, NULL}        /* Sentinel */
 };
 
+
+/**
+ * Init function for python module ycp
+ * it includes definition of debug function and support for localization
+ */
+
 PyMODINIT_FUNC initycp(void) 
 {	
 
@@ -287,7 +349,9 @@
     //InitTerm(NULL);
 }
 
-
+/**
+ * All names of known widget from YCP are added to ycpTermList
+ */
 void InitYCPTermList()
 {
 	// adding terms   
@@ -360,12 +424,15 @@
 
 }
 
-
+/**
+ * Function handle adding all known widgets to python namespace (module ycp)
+ * it is usefull for writting UI in python. 
+ */
 
 PyObject * InitTerm(PyObject *args)
 {
 	int number_args = PyTuple_Size(args);
-    // adding false into pResult
+	// adding false into pResult
 	PyObject *pResult = PyBool_FromLong(0);
 
 	PyObject *dict = PyModule_GetDict(Self);
@@ -380,7 +447,7 @@
 	{
 		
 		PyObject *pPythonValue = PyTuple_GetItem(args, 0);
-        string widget_ns = "term";
+		string widget_ns = "term";
 
 		if (pPythonValue) 
 		{
@@ -401,7 +468,7 @@
 		PyObject *new_module = Py_InitModule(widget_ns.c_str(), term_methods);
 		if (new_module == NULL) return pResult;
 
-    	initYCPTermType(new_module);
+		initYCPTermType(new_module);
 
 		
 		// Add new initialized module into ycp dictionary
@@ -670,6 +737,9 @@
 /**
  * Returns true if NameSpace is registered (is key) in dictionary dict.
  * Otherwise returns false;
+ * @param PyObject *dict - main dictionary of module ycp(python)
+ * @param char *NameSpace - name of namespace
+ * @return true on success
  */
 bool isRegistered(PyObject *dict, const char *NameSpace)
 {
@@ -684,6 +754,13 @@
 	return ret;
 }
 
+/**
+ * Register functions and variables from namespace to python module
+ * @param char *NameSpace - name of namespace
+ * @param YCPList list_functions - names of functions
+ * @param YCPList list_variables - names of variables
+ * @return true on success
+ */
 bool RegFunctions(char *NameSpace, YCPList list_functions, YCPList list_variables) 
 {
 
@@ -736,7 +813,10 @@
 }
 
 
-
+/**
+ * Register SCR namespace with 4 functions: Read, Write, Dir and Execute
+ * @return true on success
+ */
 bool RegSCR() 
 {
     string func_read =
@@ -792,6 +872,9 @@
 
 Y2Component *owned_wfmc = 0;
 
+/**
+ * Init WFM
+ */
 void init_wfm () 
 {
 
@@ -806,6 +889,12 @@
 
 Y2Component *owned_uic = 0;
 
+
+/**
+ * Init UI - select: ncurses, qt or gtk
+ * @param PyObject *args - string - type of UI 
+ * @return PyObject * true on success
+ */
 PyObject * InitUI (PyObject *args) 
 {
 
@@ -862,7 +951,12 @@
 	return PyBool_FromLong(1);
 }
 
-
+/**
+ * Function import module written in YCP.
+ * It means that create module into namespace of python module ycp
+ * @param PyObject *args - string - include name of module written in YCP 
+ * @return PyObject * true on success
+ */
 PyObject * ImportYCPNameSpace (PyObject *args) 
 {
 	PyObject* pResult = PyBool_FromLong(0);
@@ -908,7 +1002,11 @@
 
 	return pResult;
 }
-
+/**
+ * General function handles running SCR command
+ * @param PyObject *args - tuple of arguments for running SCR 
+ * @return PyObject * result of running SCR
+ */
 PyObject * _SCR_Run (PyObject *args) 
 {
 	// access directly the statically declared builtins
@@ -1096,7 +1194,11 @@
 }
 
 
-
+/**
+ * Function handles calling ycp function from python
+ * @param PyObject *args - tuple with namespace name of function and args for function
+ * @return PyObject return result of running function
+ */
 PyObject * CallYCPFunction (PyObject *args) 
 {
 	int number_args = PyTuple_Size(args);
@@ -1258,6 +1360,12 @@
 	}    
 }
 
+/**
+ * General function handles calling debug function in python like: 
+ * y2mileston(), y2error() etc.
+ * @param PyObject *args - tuple of args for debug function
+ */
+
 void PyY2logger(PyObject *args) 
 {
   	int number_args = PyTuple_Size(args);

-- 
To unsubscribe, e-mail: yast-commit+unsubscribe@opensuse.org
For additional commands, e-mail: yast-commit+help@opensuse.org

    

[yast-commit] r48668 - /trunk/python-bindings/src/YCP.cc

juhliarik＠svn.opensuse.org