irreco/src/core/irreco_backend_device.c

   1 /*
   2  * irreco - Ir Remote Control
   3  * Copyright (C) 2007  Arto Karppinen (arto.karppinen@iki.fi)
   4  *
   5  * This program is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU General Public License
   7  * as published by the Free Software Foundation; either version 2
   8  * of the License, or (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program; if not, write to the Free Software Foundation,
  17  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  18  */
  19
  20 #include "irreco_backend_device.h"
  21
  22 /**
  23  * @addtogroup IrrecoBackendDevice
  24  * @ingroup Irreco
  25  *
  26  * Used to storage the information and data provided about the device by
  27  * an instance of some backend.
  28  *
  29  * @{
  30  */
  31
  32 /**
  33  * @file
  34  * Source file of @ref IrrecoBackendDevice.
  35  */
  36
  37
  38
  39 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-*/
  40 /* Construction & Destruction                                                 */
  41 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-*/
  42
  43 /**
  44  * @name Construction & Destruction
  45  * @{
  46  */
  47
  48 IrrecoBackendDevice *
  49 irreco_backend_device_create(const gchar *name,
  50                              IrrecoBackendInstance * backend_instance,
  51                              gpointer *contex)
  52 {
  53         IrrecoBackendDevice *backend_device;
  54         IRRECO_ENTER
  55
  56         g_assert(name != NULL);
  57         g_assert(backend_instance != NULL);
  58
  59         backend_device = g_slice_new0(IrrecoBackendDevice);
  60         backend_device->backend_instance = backend_instance;
  61         backend_device->name = g_strdup(name);
  62         backend_device->contex = contex;
  63         backend_device->command_list = irreco_string_table_new(NULL, NULL);
  64         IRRECO_RETURN_PTR(backend_device);
  65 }
  66
  67 void irreco_backend_device_destroy(IrrecoBackendDevice *backend_device)
  68 {
  69         IRRECO_ENTER
  70         if (backend_device == NULL) IRRECO_RETURN
  71         irreco_string_table_free(backend_device->command_list);
  72         g_free(backend_device->name);
  73         backend_device->name = NULL;
  74         g_slice_free(IrrecoBackendDevice, backend_device);
  75         IRRECO_RETURN
  76 }
  77
  78 /** @} */
  79
  80
  81
  82 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-*/
  83 /* Backend API                                                                */
  84 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-*/
  85
  86 /**
  87  * @name Backend API
  88  * @{
  89  */
  90
  91 /**
  92  * Can this device be exported?
  93  *
  94  * @sa irreco_backend_instance_api_export
  95  */
  96 gboolean irreco_backend_device_is_editable(IrrecoBackendDevice * device)
  97 {
  98         gboolean rvalue;
  99         IRRECO_ENTER
 100
 101         g_assert(device != NULL);
 102
 103         /* Does the backend support editable devices at all? */
 104         if ( ! irreco_backend_instance_api_edit(device->backend_instance)) {
 105                 IRRECO_RETURN_BOOL(FALSE);
 106         }
 107
 108         /* Is this device editable? */
 109         IRRECO_BACKEND_ENTER(device->backend_instance, "is_device_editable()");
 110         rvalue = device->backend_instance->lib->api->is_device_editable(
 111                 device->backend_instance->contex, device->name, device->contex);
 112         IRRECO_BACKEND_RETURN("is_device_editable()");
 113         IRRECO_RETURN_BOOL(rvalue);
 114 }
 115
 116 /**
 117  * Can this device be exported?
 118  *
 119  * @sa irreco_backend_instance_api_export
 120  */
 121 gboolean irreco_backend_device_is_exportable(IrrecoBackendDevice * device)
 122 {
 123         IRRECO_ENTER
 124         g_assert(device != NULL);
 125         IRRECO_RETURN_BOOL(
 126                 irreco_backend_instance_api_export(
 127                         device->backend_instance))
 128 }
 129
 130 void irreco_backend_device_edit(IrrecoBackendDevice * device,
 131                                 GtkWindow * parent)
 132 {
 133         IrrecoBackendStatus status;
 134         IRRECO_ENTER
 135
 136         g_assert(device != NULL);
 137         g_assert(parent != NULL);
 138
 139         IRRECO_BACKEND_ENTER(device->backend_instance, "edit_device()");
 140         status = device->backend_instance->lib->api->edit_device(
 141                 device->backend_instance->contex, device->name,
 142                 device->contex, parent);
 143         IRRECO_BACKEND_RETURN("edit_device()");
 144         irreco_backend_instance_check_status(device->backend_instance, status);
 145
 146         IRRECO_RETURN
 147 }
 148
 149 void irreco_backend_device_delete(IrrecoBackendDevice * device,
 150                                   GtkWindow * parent)
 151 {
 152         IrrecoBackendStatus status;
 153         IRRECO_ENTER
 154
 155         g_assert(device != NULL);
 156         g_assert(parent != NULL);
 157
 158         IRRECO_BACKEND_ENTER(device->backend_instance, "delete_device()");
 159         status = device->backend_instance->lib->api->delete_device(
 160                 device->backend_instance->contex, device->name,
 161                 device->contex, parent);
 162         IRRECO_BACKEND_RETURN("delete_device()");
 163         irreco_backend_instance_check_status(device->backend_instance, status);
 164
 165         IRRECO_RETURN
 166 }
 167
 168 /** @} */
 169 /** @} */
 170
 171