OSSP CVS Repository

ossp - Check-in [4848]
Not logged in
[Honeypot]  [Browse]  [Home]  [Login]  [Reports
[Search]  [Ticket]  [Timeline
  [Patchset]  [Tagging/Branching

Check-in Number: 4848
Date: 2004-Nov-17 14:15:35 (local)
2004-Nov-17 13:15:35 (UTC)
User:rse
Branch:
Comment: document both the C and Perl APIs
Tickets:
Inspections:
Files:
ossp-pkg/cfg/perl/cfg.pod      1.1 -> 1.2     112 inserted, 12 deleted

ossp-pkg/cfg/perl/cfg.pod 1.1 -> 1.2

--- cfg.pod      2004/11/14 18:38:53     1.1
+++ cfg.pod      2004/11/17 13:15:35     1.2
@@ -53,10 +53,46 @@
 
 =item C<my $cfg = >B<new>C< OSSP::cfg;>
 
-=item C<$cfg-E<gt>>B<FIXME>C<($name);>
-
 =item C<undef $cfg;>
 
+=item [C<(>]C<$error>[C<, $rc)>]C< = $cfg-E<gt>>B<error>C<($cfg>[C<, $rc>]C<);>
+
+=item C<$ver = $cfg-E<gt>>B<version>C<();>
+
+=item C<$cfg-E<gt>>B<import>C<($name, $fmt, $str);>
+
+=item C<$str = $cfg-E<gt>>B<export>C<($name, $fmt);>
+
+=item C<$node = $cfg-E<gt>>B<node_create>C<();>
+
+=item C<$cfg-E<gt>>B<node_destroy>C<($node);>
+
+=item C<$node2 = $cfg-E<gt>>B<node_clone>C<($node);>
+
+=item C<$cfg-E<gt>>B<node_set>C<($node, $attr, $value);>
+
+=item C<$value = $cfg-E<gt>>B<node_get>C<($node, $attr);>
+
+=item C<$node = $cfg-E<gt>>B<node_root>C<();>
+
+=item C<$result = $cfg-E<gt>>B<node_select>C<($node, $spec);>
+
+=item C<$cont = $cfg-E<gt>>B<node_find>C<($node, \&cb_fct_cmp, $cb_ctx_cmp);>
+
+=item C<$cfg-E<gt>>B<node_apply>C<($node, \&cb_fct_cmp, $cb_ctx_cmp, \&cb_fct_cb, $cb_ctx_cb);>
+
+=item C<$cfg-E<gt>>B<node_cmp>C<($node, $token);>
+
+=item C<$cfg-E<gt>>B<node_link>C<($node, $id, $node2);>
+
+=item C<$cfg-E<gt>>B<node_unlink>C<($node);>
+
+=item C<$cfg-E<gt>>B<data_set>C<($data, $attr, $value);>
+
+=item C<$value = $cfg-E<gt>>B<data_get>C<($data, $attr);>
+
+=item C<$cfg-E<gt>>B<data_ctrl>C<($data, $ctrl>[C<, $value>]C<);>
+
 =back
 
 =head2 C-STYLE API
@@ -71,24 +107,88 @@
 
 =item C<my $cfg; $rc = >B<cfg_create>C<($cfg);>
 
-=item C<$str = >B<cfg_FIXME>C<($rc);>
+=item C<$rc = >B<cfg_destroy>C<($cfg);>
 
-=item C<$str = >B<cfg_error>C<($rc);>
+=item C<$rc = >B<cfg_error>C<($cfg, $rc, $error);>
 
 =item C<$ver = >B<cfg_version>C<();>
 
-=item C<$rc = >B<cfg_destroy>C<($cfg);>
+=item C<$rc = >B<cfg_import>C<($cfg, $node, $fmt, $in_ptr, $in_len);>
+
+=item C<$rc = >B<cfg_export>C<($cfg, $node, $fmt, $ex_ptr, $ex_len);>
+
+=item C<$rc = >B<cfg_node_create>C<($cfg, $node);>
+
+=item C<$rc = >B<cfg_node_destroy>C<($cfg, $node);>
+
+=item C<$rc = >B<cfg_node_clone>C<($cfg, $node, $node2);>
+
+=item C<$rc = >B<cfg_node_set>C<($cfg, $node, $attr, ...);>
+
+=item C<$rc = >B<cfg_node_get>C<($cfg, $node, $attr, ...);>
+
+=item C<$rc = >B<cfg_node_root>C<($cfg, $node);>
+
+=item C<$rc = >B<cfg_node_select>C<($cfg, $node, $result, $spec);>
+
+=item C<$rc = >B<cfg_node_find>C<($cfg, $node, $cb_fct_cmp, $cb_ctx_cmp, $cont);>
+
+=item C<$rc = >B<cfg_node_apply>C<($cfg, $node, $cb_fct_cmp, $cb_ctx_cmp, $cb_fct_cb, $cb_ctx_cb);>
+
+=item C<$rc = >B<cfg_node_cmp>C<($cfg, $node, $token);>
+
+=item C<$rc = >B<cfg_node_link>C<($cfg, $node, $id, $node2);>
+
+=item C<$rc = >B<cfg_node_unlink>C<($cfg, $node);>
+
+=item C<$rc = >B<cfg_data_set>C<($data, $attr, ...);>
+
+=item C<$rc = >B<cfg_data_get>C<($data, $attr, ...);>
+
+=item C<$rc = >B<cfg_data_ctrl>C<($data, $ctrl, ...);>
 
 =back
 
-Additionally, the following constants are exported for use in C<$rc>, C<$mode>, C<$fmt> and C<$ver>:
+Additionally, the following constants are exported for use in C<$rc>, C<$attr>, C<$ctrl> and variable
+arguments:
 
-C<CFG_RC_OK>,
-C<CFG_RC_ARG>,
-C<CFG_RC_MEM>,
-C<CFG_RC_SYS>,
-C<CFG_RC_INT>,
-C<CFG_RC_IMP>.
+C<CFG_OK>,
+C<CFG_ERR_ARG>,
+C<CFG_ERR_USE>,
+C<CFG_ERR_MEM>,
+C<CFG_ERR_SYS>,
+C<CFG_ERR_FMT>,
+C<CFG_ERR_INT>,
+C<CFG_ERR_SYN>,
+C<CFG_ERR_NDE>,
+C<CFG_FMT_CFG>,
+C<CFG_FMT_XML>,
+C<CFG_NODE_TYPE_SEQ>,
+C<CFG_NODE_TYPE_DIR>,
+C<CFG_NODE_TYPE_OPT>,
+C<CFG_NODE_TYPE_ARG>,
+C<CFG_NODE_ATTR_PARENT>,
+C<CFG_NODE_ATTR_LBROTH>,
+C<CFG_NODE_ATTR_RBROTH>,
+C<CFG_NODE_ATTR_CHILD1>,
+C<CFG_NODE_ATTR_CHILDL>,
+C<CFG_NODE_ATTR_CHILDS>,
+C<CFG_NODE_ATTR_NODES>,
+C<CFG_NODE_ATTR_DEPTH>,
+C<CFG_NODE_ATTR_SRCNAME>,
+C<CFG_NODE_ATTR_SRCPOS>,
+C<CFG_NODE_ATTR_TYPE>,
+C<CFG_NODE_ATTR_TOKEN>,
+C<CFG_NODE_ATTR_DATA>,
+C<CFG_DATA_TYPE_PTR>,
+C<CFG_DATA_TYPE_STR>,
+C<CFG_DATA_TYPE_INT>,
+C<CFG_DATA_TYPE_FLT>,
+C<CFG_DATA_CTRL_CLONE>,
+C<CFG_DATA_CTRL_DESTROY>,
+C<CFG_DATA_ATTR_TYPE>,
+C<CFG_DATA_ATTR_VALUE>,
+C<CFG_DATA_ATTR_CTRL>.
 
 =head1 EXAMPLES
 

CVSTrac 2.0.1