Object Types Instructions manual |
OKit: Object Tree, RPL Virtual Machine and compiler shared library Copyright (C) 2000 Yann LANDRIN-SCHWEITZER This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version. This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details. You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA Author: Yann LANDRIN-SCHWEITZER Contact: varkhan@free.fr Homepage: http://varkhan.free.fr/ |
Generic OKit_Object methods |
Returns | ||||
_NULL | : | if no memory was available | ||
else a new undefined OKit_Object. |
Errors | ||||
_ENOMEM | : | if no memory was available |
Args | ||||
_obj | : | OKit_Object to copy |
Returns | ||||
_NULL | : | if a NULL OKit_Object was passed as argument, or no memory was available | ||
else a direct, fully recursive copy of the OKit_Object. |
Errors | ||||
_EINVAL | : | if a NULL OKit_Object was passed as argument | ||
_ENOMEM | : | if no memory was available |
Args | ||||
_obj | : | OKit_Object to clone |
Returns | ||||
_NULL | : | if a NULL OKit_Object was passed as argument, or no memory was available | ||
else a cloned version of the OKit_Object (flat copy). |
Errors | ||||
_EINVAL | : | if a NULL OKit_Object was passed as argument | ||
_ENOMEM | : | if no memory was available |
Args | ||||
_obj | : | OKit_Object to reference |
Returns | ||||
_NULL | : | if a NULL OKit_Object was passed as argument | ||
else the referenced object. |
Errors | ||||
_EINVAL | : | if a NULL OKit_Object was passed as argument |
Args | ||||
_obj | : | OKit_Object to dereference |
Returns | ||||
_NULL | : | if a NULL OKit_Object was passed as argument | ||
else the dereferenced object. |
Errors | ||||
_EINVAL | : | if a NULL OKit_Object was passed as argument |
Args | ||||
_obj | : | OKit_Object to free |
Args | ||||
_obj | : | OKit_Object to query |
Returns | ||||
_-1 | : | if a NULL OKit_Object was passed as argument | ||
else the numeric identifier for the object type. |
Errors | ||||
_EINVAL | : | if a NULL OKit_Object was passed as argument |
Args | ||||
_obj | : | OKit_Object to query |
Returns | ||||
_"" | : | if an unknown type was given | ||
else a unique string usable as a name for that type. |
Args | ||||
_obj | : | OKit_Object to query |
Returns | ||||
_-1 | : | if a NULL OKit_Object was passed as argument | ||
else a pointer to the OKit_Object's content. |
Errors | ||||
_EINVAL | : | if a NULL OKit_Object was passed as argument |
Args | ||||
_obj | : | OKit_Object to query |
Returns | ||||
_-1 | : | if a NULL OKit_Object was passed as argument | ||
else 0. |
Args | ||||
_obj | : | OKit_Object to print | ||
_out | : | allocated output string (at least max+1 characters) | ||
_max | : | max number of characters to print |
Returns | ||||
_-1 | : | if some error occurred | ||
_ the maximum number of character needed to print completely the object if 'out' is NULL (max is ignored) | ||||
else the total number of characters printed |
Errors | ||||
_EINVAL | : | if a NULL OKit_Object was passed as argument |
Args | ||||
_obj | : | OKit_Object to test | ||
_objw | : | reference OKit_Object |
Returns | ||||
_-1 | : | if a NULL OKit_Object was passed as argument | ||
_ 0 | : | if the two OKit_Objects were distinct | ||
_+1 | : | if the two OKit_Objects were equal |
Errors | ||||
_EINVAL | : | if a NULL OKit_Object was passed as argument |
Args | ||||
_obj | : | OKit_Object to print |
Returns | ||||
_NULL | : | if a NULL OKit_Object was passed as argument, or no memory was available | ||
else the OKit_Object's String representation. |
Errors | ||||
_EINVAL | : | if a NULL was passed as argument | ||
_ENOMEM | : | if no memory was available |
OKit_Void object type |
Returns | ||||
_NULL | : | if no memory was available |
Errors | ||||
_EINVAL | : | if a NULL was passed as argument | ||
_ENOMEM | : | if no memory was available |
Args | ||||
_vd | : |
Returns | ||||
_NULL | : | if no memory was available |
Errors | ||||
_EINVAL | : | if a NULL was passed as argument | ||
_ENOMEM | : | if no memory was available |
Args | ||||
_vd | : | |||
_out | : | |||
_max | : |
Returns | ||||
_NULL | : | if no memory was available |
Errors | ||||
_EINVAL | : | if a NULL was passed as argument | ||
_ENOMEM | : | if no memory was available |
OKit_Intg object type |
Returns | ||||
_NULL | : | if no memory was available |
Errors | ||||
_EINVAL | : | if a NULL was passed as argument | ||
_ENOMEM | : | if no memory was available |
Args | ||||
_in | : |
Returns | ||||
_NULL | : | if no memory was available |
Errors | ||||
_EINVAL | : | if a NULL was passed as argument | ||
_ENOMEM | : | if no memory was available |
Args | ||||
_in | : |
Returns | ||||
_NULL | : | if no memory was available |
Errors | ||||
_EINVAL | : | if a NULL was passed as argument | ||
_ENOMEM | : | if no memory was available |
Args | ||||
_nb | : |
Returns | ||||
_NULL | : | if no memory was available |
Errors | ||||
_EINVAL | : | if a NULL was passed as argument | ||
_ENOMEM | : | if no memory was available |
Args | ||||
_in | : |
Returns | ||||
_NULL | : | if no memory was available |
Errors | ||||
_EINVAL | : | if a NULL was passed as argument | ||
_ENOMEM | : | if no memory was available |
Args | ||||
_in | : | |||
_out | : | |||
_max | : |
Returns | ||||
_NULL | : | if no memory was available |
Errors | ||||
_EINVAL | : | if a NULL was passed as argument | ||
_ENOMEM | : | if no memory was available |
Args | ||||
_in | : | |||
_inw | : |
Returns | ||||
_NULL | : | if no memory was available |
Errors | ||||
_EINVAL | : | if a NULL was passed as argument | ||
_ENOMEM | : | if no memory was available |
OKit_Fltp object type |
Returns | ||||
_NULL | : | if no memory was available |
Errors | ||||
_EINVAL | : | if a NULL was passed as argument | ||
_ENOMEM | : | if no memory was available |
Args | ||||
_fp | : |
Returns | ||||
_NULL | : | if no memory was available |
Errors | ||||
_EINVAL | : | if a NULL was passed as argument | ||
_ENOMEM | : | if no memory was available |
Args | ||||
_fp | : |
Returns | ||||
_NULL | : | if no memory was available |
Errors | ||||
_EINVAL | : | if a NULL was passed as argument | ||
_ENOMEM | : | if no memory was available |
Args | ||||
_nb | : |
Returns | ||||
_NULL | : | if no memory was available |
Errors | ||||
_EINVAL | : | if a NULL was passed as argument | ||
_ENOMEM | : | if no memory was available |
Args | ||||
_fp | : |
Returns | ||||
_NULL | : | if no memory was available |
Errors | ||||
_EINVAL | : | if a NULL was passed as argument | ||
_ENOMEM | : | if no memory was available |
Args | ||||
_fp | : | |||
_out | : | |||
_max | : |
Returns | ||||
_NULL | : | if no memory was available |
Errors | ||||
_EINVAL | : | if a NULL was passed as argument | ||
_ENOMEM | : | if no memory was available |
Args | ||||
_fp | : | |||
_fpw | : |
Returns | ||||
_NULL | : | if no memory was available |
Errors | ||||
_EINVAL | : | if a NULL was passed as argument | ||
_ENOMEM | : | if no memory was available |
Args | ||||
_size | : |
Returns | ||||
_NULL | : | if no memory was available |
Errors | ||||
_EINVAL | : | if a NULL was passed as argument | ||
_ENOMEM | : | if no memory was available |
Args | ||||
_str | : |
Returns | ||||
_NULL | : | if no memory was available |
Errors | ||||
_EINVAL | : | if a NULL was passed as argument | ||
_ENOMEM | : | if no memory was available |
Args | ||||
_str | : |
Returns | ||||
_NULL | : | if no memory was available |
Errors | ||||
_EINVAL | : | if a NULL was passed as argument | ||
_ENOMEM | : | if no memory was available |
Args | ||||
_str | : |
Returns | ||||
_NULL | : | if no memory was available |
Errors | ||||
_EINVAL | : | if a NULL was passed as argument | ||
_ENOMEM | : | if no memory was available |
Args | ||||
_str | : |
Returns | ||||
_NULL | : | if no memory was available |
Errors | ||||
_EINVAL | : | if a NULL was passed as argument | ||
_ENOMEM | : | if no memory was available |
Args | ||||
_str | : |
Returns | ||||
_NULL | : | if no memory was available |
Errors | ||||
_EINVAL | : | if a NULL was passed as argument | ||
_ENOMEM | : | if no memory was available |
Args | ||||
_str | : |
Returns | ||||
_NULL | : | if no memory was available |
Errors | ||||
_EINVAL | : | if a NULL was passed as argument | ||
_ENOMEM | : | if no memory was available |
Args | ||||
_str1 | : | |||
_str2 | : |
Returns | ||||
_NULL | : | if no memory was available |
Errors | ||||
_EINVAL | : | if a NULL was passed as argument | ||
_ENOMEM | : | if no memory was available |
Args | ||||
_str | : | |||
_beg | : | |||
_end | : |
Returns | ||||
_NULL | : | if no memory was available |
Errors | ||||
_EINVAL | : | if a NULL was passed as argument | ||
_ENOMEM | : | if no memory was available |
Args | ||||
_str | : | |||
_out | : | |||
_max | : |
Returns | ||||
_NULL | : | if no memory was available |
Errors | ||||
_EINVAL | : | if a NULL was passed as argument | ||
_ENOMEM | : | if no memory was available |
Args | ||||
_str | : | |||
_strw | : |
Returns | ||||
_NULL | : | if no memory was available |
Errors | ||||
_EINVAL | : | if a NULL was passed as argument | ||
_ENOMEM | : | if no memory was available |
Args | ||||
_str | : | |||
_out | : | |||
_max | : |
Returns | ||||
_NULL | : | if no memory was available |
Errors | ||||
_EINVAL | : | if a NULL was passed as argument | ||
_ENOMEM | : | if no memory was available |
Returns | ||||
_NULL | : | if no memory was available |
Errors | ||||
_EINVAL | : | if a NULL was passed as argument | ||
_ENOMEM | : | if no memory was available |
Args | ||||
_numb | : |
Returns | ||||
_NULL | : | if no memory was available |
Errors | ||||
_EINVAL | : | if a NULL was passed as argument | ||
_ENOMEM | : | if no memory was available |
Args | ||||
_lst | : |
Returns | ||||
_NULL | : | if no memory was available |
Errors | ||||
_EINVAL | : | if a NULL was passed as argument | ||
_ENOMEM | : | if no memory was available |
Args | ||||
_lst | : |
Returns | ||||
_NULL | : | if no memory was available |
Errors | ||||
_EINVAL | : | if a NULL was passed as argument | ||
_ENOMEM | : | if no memory was available |
Args | ||||
_lst | : |
Returns | ||||
_NULL | : | if no memory was available |
Errors | ||||
_EINVAL | : | if a NULL was passed as argument | ||
_ENOMEM | : | if no memory was available |
Args | ||||
_lst | : |
Returns | ||||
_NULL | : | if no memory was available |
Errors | ||||
_EINVAL | : | if a NULL was passed as argument | ||
_ENOMEM | : | if no memory was available |
Args | ||||
_lst | : |
Returns | ||||
_NULL | : | if no memory was available |
Errors | ||||
_EINVAL | : | if a NULL was passed as argument | ||
_ENOMEM | : | if no memory was available |
Returns | ||||
_NULL | : | if no memory was available |
Errors | ||||
_EINVAL | : | if a NULL was passed as argument | ||
_ENOMEM | : | if no memory was available |
Args | ||||
_lst | : |
Returns | ||||
_NULL | : | if no memory was available |
Errors | ||||
_EINVAL | : | if a NULL was passed as argument | ||
_ENOMEM | : | if no memory was available |
Args | ||||
_lst | : |
Returns | ||||
_NULL | : | if no memory was available |
Errors | ||||
_EINVAL | : | if a NULL was passed as argument | ||
_ENOMEM | : | if no memory was available |
Args | ||||
_lst | : | |||
_pos | : |
Returns | ||||
_NULL | : | if no memory was available |
Errors | ||||
_EINVAL | : | if a NULL was passed as argument | ||
_ENOMEM | : | if no memory was available |
Args | ||||
_lst | : | |||
_pos | : | |||
_obj | : |
Returns | ||||
_NULL | : | if no memory was available |
Errors | ||||
_EINVAL | : | if a NULL was passed as argument | ||
_ENOMEM | : | if no memory was available |
Args | ||||
_lst | : | |||
_beg | : | |||
_end | : |
Returns | ||||
_NULL | : | if no memory was available |
Errors | ||||
_EINVAL | : | if a NULL was passed as argument | ||
_ENOMEM | : | if no memory was available |
Args | ||||
_lst | : | |||
_pos | : | |||
_lsi | : |
Returns | ||||
_NULL | : | if no memory was available |
Errors | ||||
_EINVAL | : | if a NULL was passed as argument | ||
_ENOMEM | : | if no memory was available |
Note | ||||
To prevent internal structures and memory corruption, lsi is empty after successfull | ||||
insertion. |
Args | ||||
_lst | : | |||
_obj | : |
Returns | ||||
_NULL | : | if no memory was available |
Errors | ||||
_EINVAL | : | if a NULL was passed as argument | ||
_ENOMEM | : | if no memory was available |
Args | ||||
_lst | : |
Returns | ||||
_NULL | : | if no memory was available |
Errors | ||||
_EINVAL | : | if a NULL was passed as argument | ||
_ENOMEM | : | if no memory was available |
Args | ||||
_lst | : | |||
_obj | : |
Returns | ||||
_NULL | : | if no memory was available |
Errors | ||||
_EINVAL | : | if a NULL was passed as argument | ||
_ENOMEM | : | if no memory was available |
Args | ||||
_lst | : |
Returns | ||||
_NULL | : | if no memory was available |
Errors | ||||
_EINVAL | : | if a NULL was passed as argument | ||
_ENOMEM | : | if no memory was available |
Returns | ||||
_-1 | : | if some error occured |
Errors | ||||
_EINVAL | : | if a NULL OKit_List was passed as argument |
Returns | ||||
_NULL | : | if some error occured |
Errors | ||||
_EINVAL | : | if a NULL OKit_List was passed as argument |
Args | ||||
_lst | : | |||
_out | : | |||
_max | : |
Returns | ||||
_NULL | : | if no memory was available |
Errors | ||||
_EINVAL | : | if a NULL was passed as argument | ||
_ENOMEM | : | if no memory was available |
Args | ||||
_lst | : | |||
_lstw | : |
Returns | ||||
_NULL | : | if no memory was available |
Errors | ||||
_EINVAL | : | if a NULL was passed as argument | ||
_ENOMEM | : | if no memory was available |
Returns | ||||
_NULL | : | if no memory was available |
Errors | ||||
_EINVAL | : | if a NULL was passed as argument | ||
_ENOMEM | : | if no memory was available |
Args | ||||
_cod | : |
Returns | ||||
_NULL | : | if no memory was available |
Errors | ||||
_EINVAL | : | if a NULL was passed as argument | ||
_ENOMEM | : | if no memory was available |
Args | ||||
_cod | : |
Returns | ||||
_NULL | : | if no memory was available |
Errors | ||||
_EINVAL | : | if a NULL was passed as argument | ||
_ENOMEM | : | if no memory was available |
Args | ||||
_cod | : |
Returns | ||||
_NULL | : | if no memory was available |
Errors | ||||
_EINVAL | : | if a NULL was passed as argument | ||
_ENOMEM | : | if no memory was available |
Args | ||||
_cod | : |
Returns | ||||
_NULL | : | if no memory was available |
Errors | ||||
_EINVAL | : | if a NULL was passed as argument | ||
_ENOMEM | : | if no memory was available |
Args | ||||
_cod | : |
Returns | ||||
_NULL | : | if no memory was available |
Errors | ||||
_EINVAL | : | if a NULL was passed as argument | ||
_ENOMEM | : | if no memory was available |
Returns | ||||
_NULL | : | if no memory was available |
Errors | ||||
_EINVAL | : | if a NULL was passed as argument | ||
_ENOMEM | : | if no memory was available |
Args | ||||
_cod | : |
Returns | ||||
_NULL | : | if no memory was available |
Errors | ||||
_EINVAL | : | if a NULL was passed as argument | ||
_ENOMEM | : | if no memory was available |
Args | ||||
_cod | : |
Returns | ||||
_NULL | : | if no memory was available |
Errors | ||||
_EINVAL | : | if a NULL was passed as argument | ||
_ENOMEM | : | if no memory was available |
Args | ||||
_cod | : | |||
_argn | : |
Returns | ||||
_NULL | : | if no memory was available |
Errors | ||||
_EINVAL | : | if a NULL was passed as argument | ||
_ENOMEM | : | if no memory was available |
Args | ||||
_cod | : |
Returns | ||||
_NULL | : | if no memory was available |
Errors | ||||
_EINVAL | : | if a NULL was passed as argument | ||
_ENOMEM | : | if no memory was available |
Args | ||||
_cod | : | |||
_argc | : |
Returns | ||||
_NULL | : | if no memory was available |
Errors | ||||
_EINVAL | : | if a NULL was passed as argument | ||
_ENOMEM | : | if no memory was available |
Args | ||||
_cod | : | |||
_argn | : | |||
_argt | : |
Returns | ||||
_NULL | : | if no memory was available |
Errors | ||||
_EINVAL | : | if a NULL was passed as argument | ||
_ENOMEM | : | if no memory was available |
Args | ||||
_cod | : | |||
_retc | : |
Returns | ||||
_NULL | : | if no memory was available |
Errors | ||||
_EINVAL | : | if a NULL was passed as argument | ||
_ENOMEM | : | if no memory was available |
Args | ||||
_cod | : |
Returns | ||||
_NULL | : | if no memory was available |
Errors | ||||
_EINVAL | : | if a NULL was passed as argument | ||
_ENOMEM | : | if no memory was available |
Args | ||||
_cod | : |
Returns | ||||
_NULL | : | if no memory was available |
Errors | ||||
_EINVAL | : | if a NULL was passed as argument | ||
_ENOMEM | : | if no memory was available |
Args | ||||
_cod | : |
Returns | ||||
_NULL | : | if no memory was available |
Errors | ||||
_EINVAL | : | if a NULL was passed as argument | ||
_ENOMEM | : | if no memory was available |
Args | ||||
_cod | : |
Returns | ||||
_NULL | : | if no memory was available |
Errors | ||||
_EINVAL | : | if a NULL was passed as argument | ||
_ENOMEM | : | if no memory was available |
Args | ||||
_cod | : | |||
_func | : |
Returns | ||||
_NULL | : | if no memory was available |
Errors | ||||
_EINVAL | : | if a NULL was passed as argument | ||
_ENOMEM | : | if no memory was available |
Args | ||||
_cod | : | |||
_data | : |
Returns | ||||
_NULL | : | if no memory was available |
Errors | ||||
_EINVAL | : | if a NULL was passed as argument | ||
_ENOMEM | : | if no memory was available |
Args | ||||
_cod | : | |||
_out | : | |||
_max | : |
Returns | ||||
_NULL | : | if no memory was available |
Errors | ||||
_EINVAL | : | if a NULL was passed as argument | ||
_ENOMEM | : | if no memory was available |
Args | ||||
_cod | : | |||
_codw | : |
Returns | ||||
_NULL | : | if no memory was available |
Errors | ||||
_EINVAL | : | if a NULL was passed as argument | ||
_ENOMEM | : | if no memory was available |
Returns | ||||
_NULL | : | if no memory was available |
Errors | ||||
_EINVAL | : | if a NULL was passed as argument | ||
_ENOMEM | : | if no memory was available |
Args | ||||
_blt | : |
Returns | ||||
_NULL | : | if no memory was available |
Errors | ||||
_EINVAL | : | if a NULL was passed as argument | ||
_ENOMEM | : | if no memory was available |
Args | ||||
_blt | : |
Returns | ||||
_NULL | : | if no memory was available |
Errors | ||||
_EINVAL | : | if a NULL was passed as argument | ||
_ENOMEM | : | if no memory was available |
Args | ||||
_blt | : |
Returns | ||||
_NULL | : | if no memory was available |
Errors | ||||
_EINVAL | : | if a NULL was passed as argument | ||
_ENOMEM | : | if no memory was available |
Returns | ||||
_NULL | : | if no memory was available |
Errors | ||||
_EINVAL | : | if a NULL was passed as argument | ||
_ENOMEM | : | if no memory was available |
Args | ||||
_blt | : |
Returns | ||||
_NULL | : | if no memory was available |
Errors | ||||
_EINVAL | : | if a NULL was passed as argument | ||
_ENOMEM | : | if no memory was available |
Args | ||||
_blt | : |
Returns | ||||
_NULL | : | if no memory was available |
Errors | ||||
_EINVAL | : | if a NULL was passed as argument | ||
_ENOMEM | : | if no memory was available |
Args | ||||
_blt | : | |||
_argn | : |
Returns | ||||
_NULL | : | if no memory was available |
Errors | ||||
_EINVAL | : | if a NULL was passed as argument | ||
_ENOMEM | : | if no memory was available |
Args | ||||
_blt | : |
Returns | ||||
_NULL | : | if no memory was available |
Errors | ||||
_EINVAL | : | if a NULL was passed as argument | ||
_ENOMEM | : | if no memory was available |
Args | ||||
_blt | : |
Returns | ||||
_NULL | : | if no memory was available |
Errors | ||||
_EINVAL | : | if a NULL was passed as argument | ||
_ENOMEM | : | if no memory was available |
Args | ||||
_blt | : | |||
_out | : | |||
_max | : |
Returns | ||||
_NULL | : | if no memory was available |
Errors | ||||
_EINVAL | : | if a NULL was passed as argument | ||
_ENOMEM | : | if no memory was available |
Args | ||||
_blt | : | |||
_bltw | : |
Returns | ||||
_NULL | : | if no memory was available |
Errors | ||||
_EINVAL | : | if a NULL was passed as argument | ||
_ENOMEM | : | if no memory was available |