gEDA-cvs: CVS update: g_hook.c

[cvspsrv@xxxxxxxx]

  User: cnieves 
  Date: 06/12/22 14:21:49

  Modified:    .        g_hook.c
  Log:
  * src/g_hook.c: 
  
    -  Added some documentation to custom_world_get_complex_bounds and
  
       g_get_object_bounds.
  
    -  g_add_component: Changed the remaining scheme function's name
  
       left on 2006-12-14.
  
  
  
  
  Revision  Changes    Path
  1.16      +36 -11    eda/geda/gaf/gschem/src/g_hook.c
  
  (In the diff below, changes in quantity of whitespace are not shown.)
  
  Index: g_hook.c
  ===================================================================
  RCS file: /home/cvspsrv/cvsroot/eda/geda/gaf/gschem/src/g_hook.c,v
  retrieving revision 1.15
  retrieving revision 1.16
  diff -u -b -r1.15 -r1.16
  --- g_hook.c	22 Dec 2006 03:48:09 -0000	1.15
  +++ g_hook.c	22 Dec 2006 19:21:49 -0000	1.16
  @@ -379,17 +379,25 @@
     return SCM_BOOL_T;
   }
   
  -/*! \todo Finish function documentation!!!
  - *  \brief
  +/*! \brief Get the object bounds of the given object, excluding the object
  + *  types given as parameters.
    *  \par Function Description
  + *  Get the object bounds without considering the attributes in 
  + *  exclude_attrib_list, neither the object types included in 
  + *  exclude_obj_type_list
  + *  \param [in] w_current TOPLEVEL structure.
  + *  \param [in] o_current The object we want to know the bounds of.
  + *  \param [in] exclude_attrib_list A list with the attribute names we don't
  + *  want to include when calculing the bounds.
  + *  \param [in] exclude_obj_type_list A list with the object types we don't
  + *  want to include when calculing the bounds. 
  + *  The object types are those used in (OBJECT *)->type converted into strings.
  + *  \param [out] left Left bound of the object.
  + *  \param [out] top  Top bound of the object.
  + *  \param [out] right Right bound of the object.
  + *  \param [out] bottom  Bottom bound of the object.
    *
    */
  -/*! \bug FIXME
  - *  Returns a list of the bounds of the <B>object smob</B>. 
  - *  The list has the format: ( (left right) (top bottom) )
  - *  I got top and bottom values reversed from world_get_complex_bounds,
  - *  so don\'t rely on the position in the list. 
  - */
   static void custom_world_get_complex_bounds (TOPLEVEL *w_current, OBJECT *o_current,
                                           int *left, int *top, 
                                           int *right, int *bottom,
  @@ -477,6 +485,23 @@
       }
     } 
   
  +/*! \brief Get the object bounds of the given object, excluding the object
  + *  types or the attributes given as parameters.
  + *  \par Function Description
  + *  Get the object bounds without considering the attributes in 
  + *  scm_exclude_attribs, neither the object types included in 
  + *  scm_exclude_object_type
  + *  \param [in] object_smob The object we want to know the bounds of.
  + *  \param [in] exclude_attrib_list A list with the attribute names we don't
  + *  want to include when calculing the bounds.
  + *  \param [in] exclude_obj_type_list A list with the object types we don't
  + *  want to include when calculing the bounds. 
  + *  The object types are those used in (OBJECT *)->type converted into strings.
  + *  \return a list of the bounds of the <B>object smob</B>. 
  + *  The list has the format: ( (left right) (top bottom) )
  + *  I got top and bottom values reversed from world_get_complex_bounds,
  + *  so don\'t rely on the position in the list. 
  + */
   SCM g_get_object_bounds (SCM object_smob, SCM scm_exclude_attribs, SCM scm_exclude_object_type)
   {
   
  @@ -603,12 +628,12 @@
   
     /* Get w_current and the page */
     SCM_ASSERT (g_get_data_from_page_smob (page_smob, &w_current, &page),
  -	      page_smob, SCM_ARG1, "add-component");
  +	      page_smob, SCM_ARG1, "add-component-at-xy");
     /* Check the arguments */
     SCM_ASSERT (SCM_STRINGP(scm_comp_name), scm_comp_name,
  -	      SCM_ARG2, "add-component");
  +	      SCM_ARG2, "add-component-at-xy");
     SCM_ASSERT ( SCM_INUMP(scm_x), scm_x, 
  -               SCM_ARG3, "add-component");
  +               SCM_ARG3, "add-component-at-xy");
     SCM_ASSERT ( SCM_INUMP(scm_y), scm_y, 
                  SCM_ARG4, "add-component-at-xy");
     SCM_ASSERT ( SCM_INUMP(scm_angle), scm_angle, 
  
  
  


_______________________________________________
geda-cvs mailing list
geda-cvs@xxxxxxxxxxxxxx
http://www.seul.org/cgi-bin/mailman/listinfo/geda-cvs