introspect.c

Go to the documentation of this file.

/*
 EasyDbus Library: DBUS Binding Library
 Copyright (C) 2007  Daniele Rondina aka Ge@@ru, geaaru@gmail.com 

 This program is free software; you can redistribute it and/or
 modify it under the terms of the GNU General Public License
 as published by the Free Software Foundation; either version 2
 of the License, or (at your option) any later version.

 This program 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 General Public License for more details.

 You should have received a copy of the GNU General Public License
 along with this program; if not, write to the Free Software
 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.

 Filename:  introspect.c
 
 Description: Functions for insert informations about 
        methods/signals managed on a register object. 
 
 Version:  1.0
 Created:  09/12/07 12:36:15 CEST
 Revision:  
    0 - created
    1 - created functions for creation of instropect XML
        string.
    2 - created doxygen documentation and added support for
        opaque struct (Ge@@ru) - 11/03/07 18:32:00 CEST
 
 Author:   Daniele Rondina aka ge@@ru (geaaru@gmail.com) 
 License:  GPL 2.0
*/

#include <stdlib.h>
#include <string.h>
#include <stdarg.h>
// easydbus includes
#include "easydbus-core.h"
#include "debug.h"
#include "introspect_internal.h"
#include "utils.h"

int 
easydbus_add_info_field_on_register_method (EasyDbus_obj_method * method,
                                            unsigned char offset,
                                            char *name_field, 
                                            unsigned char type, ...) 
{
   struct easydbus_introspect_arg_info *el, *list;
   struct easydbus_signature_elem_stack *list_elem;
   enum el_type elem = EASYDBUS_ELTYPE_INVALID;
   int name_length = 0;
   va_list ap;

   if (method == NULL || name_field == NULL || type > 1)
      return -1;

   list = el = NULL;
   list_elem = NULL;

   if (type)
      list = method->output_info;
   else
      list = method->input_info;

   if (list != NULL) {
      // check if there is already a info about
      // a field with an offset == offset
      el = list;
      while (el != NULL) {
         if (el->offset == offset)
            return -1;
         el = el->next;
      }
   }

   el = (struct easydbus_introspect_arg_info *)
      malloc (sizeof (struct easydbus_introspect_arg_info));
   if (el == NULL)
      return -1;

   /* initialize new element */
   memset (el, 0,
           sizeof (struct easydbus_introspect_arg_info));
   el->name = el->signature = NULL;
   el->next = NULL;

   /* get elements list */
   va_start (ap, type);

   /* recover data from input params list */
   elem = va_arg (ap, enum el_type);

   while (elem != EASYDBUS_ELTYPE_INVALID) {
      list_elem =
         easydbus_add_elem_to_stack (elem, list_elem);
      elem = va_arg (ap, enum el_type);
   }
   va_end (ap);

   el->signature =
      easydbus_create_arg_signature (list_elem);
   if (el->signature == NULL)
      goto error;
   list_elem = NULL;

   name_length = strlen (name_field) + 1;
   el->name = (char *) malloc (name_length);
   if (el->name == NULL)
      goto error;

   EASYDBUS_MEMCOPY (el->name, name_field, name_length);
   el->offset = offset;

   if (easydbus_add_new_field_to_list (el, &list))
      goto error;

   if (type)
      method->output_info = list;
   else
      method->input_info = list;


   return 0;

 error:
   if (el != NULL)
      easydbus_free_introspect_info_arg (el);

   easydbus_free_elem_from_stack_list (list_elem);

   return -1;
}


int
easydbus_add_info_field_on_register_signal (EasyDbus_obj_signal * signal, 
                                            unsigned char offset,
                                            char *name_field, ...) 
{
   struct easydbus_introspect_arg_info *el = NULL;
   struct easydbus_signature_elem_stack *list_elem;
   enum el_type elem = EASYDBUS_ELTYPE_INVALID;
   int name_length = 0;
   va_list ap;

   if (signal == NULL || name_field == NULL)
      return -1;

   list_elem = NULL;

   if (signal->output_info != NULL) {
      // check if there is already a info about
      // a field with an offset == offset
      el = signal->output_info;
      while (el != NULL) {
         if (el->offset == offset)
            return -1;
         el = el->next;
      }
   }

   el = (struct easydbus_introspect_arg_info *)
      malloc (sizeof (struct easydbus_introspect_arg_info));
   if (el == NULL)
      return -1;

   /* initialize new element */
   memset (el, 0,
           sizeof (struct easydbus_introspect_arg_info));
   el->name = NULL;
   el->next = NULL;

   /* get elements list */
   va_start (ap, name_field);

   /* recover data from input params list */
   elem = va_arg (ap, enum el_type);

   while (elem != EASYDBUS_ELTYPE_INVALID) {
      list_elem =
         easydbus_add_elem_to_stack (elem, list_elem);
      elem = va_arg (ap, enum el_type);
   }
   va_end (ap);

   el->signature =
      easydbus_create_arg_signature (list_elem);
   if (el->signature == NULL)
      goto error;
   list_elem = NULL;

   name_length = strlen (name_field) + 1;
   el->name = (char *) malloc (name_length);
   if (el->name == NULL)
      goto error;

   EASYDBUS_MEMCOPY (el->name, name_field, name_length);
   el->offset = offset;

   if (easydbus_add_new_field_to_list
       (el, &signal->output_info))
      goto error;

   return 0;

 error:
   if (el != NULL)
      easydbus_free_introspect_info_arg (el);

   easydbus_free_elem_from_stack_list (list_elem);

   return -1;
}


int
easydbus_enable_introspect_check (EasyDbus_conn * data,
                                  EasyDbus_object * object,
                                  char *obj_path)
{
   struct EasyDbus_core *core =
      (struct EasyDbus_core *) data;
   char *introspect_string = NULL;
   introspect_objs_tree *t = NULL;

   if (!data || !object)
      return -1;


   t = easydbus_introspect_objs_tree_build ((struct EasyDbus_object_box *)
                                             object);
   if (!t) return -1;

   /* check if this is needed */
   introspect_string = 
      easydbus_introspect_create_reply_string (obj_path, t, 
                                               (struct EasyDbus_object_box *)
                                                object);

   easydbus_introspect_objs_tree_destroy (t); 

   if (!introspect_string)
      return -1;
   free (introspect_string);

   core->handled_introspect = 1;

   return 0;
}

// vim: ts=3 shiftwidth=3 expandtab

---