libmm-glib: simplify handling of interfaces

Avoid trying to merge all interfaces into the same set of APIs, and keep having
a specific object (proxy) for each interface handled by the GDBusObjects
reported listed by the GDBusObjectManager.
This commit is contained in:
Aleksander Morgado
2011-12-09 15:44:56 +01:00
parent 838f38ec8c
commit 7acacbbfd7
8 changed files with 917 additions and 433 deletions

View File

@@ -13,8 +13,12 @@ libmm_glib_la_SOURCES = \
libmm-glib.h \
mm-manager.h \
mm-manager.c \
mm-object.h \
mm-object.c \
mm-modem.h \
mm-modem.c \
mm-modem-3gpp.h \
mm-modem-3gpp.c \
mm-sim.h \
mm-sim.c

View File

@@ -23,7 +23,11 @@
#ifndef _LIBMM_GLIB_H_
#define _LIBMM_GLIB_H_
#include <ModemManager.h>
#include <mm-errors-types.h>
#include <mm-enums-types.h>
#include <mm-manager.h>
#include <mm-modem.h>
#include <mm-object.h>
#endif /* _LIBMM_GLIB_H_ */

302
libmm-glib/mm-modem-3gpp.c Normal file
View File

@@ -0,0 +1,302 @@
/* -*- Mode: C; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* libmm -- Access modem status & information from glib applications
*
* 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 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., 51 Franklin Street, Fifth Floor,
* Boston, MA 02110-1301 USA.
*
* Copyright (C) 2011 Aleksander Morgado <aleksander@gnu.org>
*/
#include <gio/gio.h>
#include "mm-modem-3gpp.h"
/**
* mm_modem_3gpp_get_path:
* @self: A #MMModem3gpp.
*
* Gets the DBus path of the #MMObject which implements this interface.
*
* Returns: (transfer none): The DBus path of the #MMObject object.
*/
const gchar *
mm_modem_3gpp_get_path (MMModem3gpp *self)
{
g_return_val_if_fail (G_IS_DBUS_PROXY (self), NULL);
return g_dbus_proxy_get_object_path (G_DBUS_PROXY (self));
}
/**
* mm_modem_3gpp_dup_path:
* @self: A #MMModem3gpp.
*
* Gets a copy of the DBus path of the #MMObject object which implements this interface.
*
* Returns: (transfer full): The DBus path of the #MMObject. The returned value should be freed with g_free().
*/
gchar *
mm_modem_3gpp_dup_path (MMModem3gpp *self)
{
gchar *value;
g_return_val_if_fail (G_IS_DBUS_PROXY (self), NULL);
g_object_get (G_OBJECT (self),
"g-object-path", &value,
NULL);
return value;
}
/**
* mm_modem_3gpp_get_imei:
* @self: A #MMModem3gpp.
*
* Gets the <ulink url="http://en.wikipedia.org/wiki/Imei">IMEI</ulink>,
* as reported by this #MMModem.
*
* <warning>It is only safe to use this function on the thread where @self was constructed. Use mm_modem_3gpp_dup_imei() if on another thread.</warning>
*
* Returns: (transfer none): The IMEI, or %NULL if none available.
*/
const gchar *
mm_modem_3gpp_get_imei (MMModem3gpp *self)
{
g_return_val_if_fail (MM_GDBUS_IS_MODEM3GPP (self), NULL);
return mm_gdbus_modem3gpp_get_imei (self);
}
/**
* mm_modem_3gpp_dup_imei:
* @self: A #MMModem3gpp.
*
* Gets a copy of the <ulink url="http://en.wikipedia.org/wiki/Imei">IMEI</ulink>,
* as reported by this #MMModem.
*
* Returns: (transfer full): The IMEI, or %NULL if none available. The returned value should be freed with g_free().
*/
gchar *
mm_modem_3gpp_dup_imei (MMModem3gpp *self)
{
g_return_val_if_fail (MM_GDBUS_IS_MODEM3GPP (self), NULL);
return mm_gdbus_modem3gpp_dup_imei (self);
}
/**
* mm_modem_3gpp_get_operator_code:
* @self: A #MMModem3gpp.
*
* Gets the code of the operator to which the mobile is
* currently registered.
*
* Returned in the format <literal>"MCCMNC"</literal>, where
* <literal>MCC</literal> is the three-digit ITU E.212 Mobile Country Code
* and <literal>MNC</literal> is the two- or three-digit GSM Mobile Network
* Code. e.g. e<literal>"31026"</literal> or <literal>"310260"</literal>.
*
* If the <literal>MCC</literal> and <literal>MNC</literal> are not known
* or the mobile is not registered to a mobile network, this property will
* be a zero-length (blank) string.
*
* <warning>It is only safe to use this function on the thread where @self was constructed. Use mm_modem_3gpp_dup_operator_code() if on another thread.</warning>
*
* Returns: (transfer none): The operator code, or %NULL if none available.
*/
const gchar *
mm_modem_3gpp_get_operator_code (MMModem3gpp *self)
{
g_return_val_if_fail (MM_GDBUS_IS_MODEM3GPP (self), NULL);
return mm_gdbus_modem3gpp_get_operator_code (self);
}
/**
* mm_modem_3gpp_dup_operator_code:
* @self: A #MMModem3gpp.
*
* Gets a copy of the code of the operator to which the mobile is
* currently registered.
*
* Returned in the format <literal>"MCCMNC"</literal>, where
* <literal>MCC</literal> is the three-digit ITU E.212 Mobile Country Code
* and <literal>MNC</literal> is the two- or three-digit GSM Mobile Network
* Code. e.g. e<literal>"31026"</literal> or <literal>"310260"</literal>.
*
* Returns: (transfer full): The operator code, or %NULL if none available. The returned value should be freed with g_free().
*/
gchar *
mm_modem_3gpp_dup_operator_code (MMModem3gpp *self)
{
g_return_val_if_fail (MM_GDBUS_IS_MODEM3GPP (self), NULL);
return mm_gdbus_modem3gpp_dup_operator_code (self);
}
/**
* mm_modem_3gpp_get_operator_name:
* @self: A #MMModem3gpp.
*
* Gets the name of the operator to which the mobile is
* currently registered.
*
* <warning>It is only safe to use this function on the thread where @self was constructed. Use mm_modem_3gpp_dup_operator_name() if on another thread.</warning>
*
* Returns: (transfer none): The operator name, or %NULL if none available.
*/
const gchar *
mm_modem_3gpp_get_operator_name (MMModem3gpp *self)
{
g_return_val_if_fail (MM_GDBUS_IS_MODEM3GPP (self), NULL);
return mm_gdbus_modem3gpp_get_operator_name (self);
}
/**
* mm_modem_3gpp_dup_operator_name:
* @self: A #MMModem3gpp.
*
* Gets a copy of the name of the operator to which the mobile is
* currently registered.
*
* Returns: (transfer full): The operator name, or %NULL if none available. The returned value should be freed with g_free().
*/
gchar *
mm_modem_3gpp_dup_operator_name (MMModem3gpp *self)
{
g_return_val_if_fail (MM_GDBUS_IS_MODEM3GPP (self), NULL);
return mm_gdbus_modem3gpp_dup_operator_name (self);
}
/**
* mm_modem_3gpp_get_registration_state:
* @self: A #MMModem.
*
* Get the the mobile registration status as defined in 3GPP TS 27.007
* section 10.1.19.
*
* Returns: A #MMModem3gppRegistrationState value, specifying the current registration state.
*/
MMModem3gppRegistrationState
mm_modem_3gpp_get_registration_state (MMModem3gpp *self)
{
g_return_val_if_fail (MM_GDBUS_IS_MODEM3GPP (self), MM_MODEM_3GPP_REGISTRATION_STATE_IDLE);
return mm_gdbus_modem3gpp_get_registration_state (self);
}
/**
* mm_modem_3gpp_get_enabled_facility_locks:
* @self: A #MMModem3gpp.
*
* Get the list of facilities for which PIN locking is enabled.
*
* Returns: A bitmask of #MMModem3gppFacility flags, specifying which facilities have locks enabled.
*/
MMModem3gppFacility
mm_modem_3gpp_get_enabled_facility_locks (MMModem3gpp *self)
{
g_return_val_if_fail (MM_GDBUS_IS_MODEM3GPP (self), MM_MODEM_3GPP_FACILITY_NONE);
return mm_gdbus_modem3gpp_get_enabled_facility_locks (self);
}
void
mm_modem_3gpp_register (MMModem3gpp *self,
const gchar *network_id,
GCancellable *cancellable,
GAsyncReadyCallback callback,
gpointer user_data)
{
g_return_if_fail (MM_GDBUS_IS_MODEM3GPP (self));
mm_gdbus_modem3gpp_call_register (self,
network_id,
cancellable,
callback,
user_data);
}
gboolean
mm_modem_3gpp_register_finish (MMModem3gpp *self,
GAsyncResult *res,
GError **error)
{
g_return_val_if_fail (MM_GDBUS_IS_MODEM3GPP (self), FALSE);
return mm_gdbus_modem3gpp_call_register_finish (self,
res,
error);
}
gboolean
mm_modem_3gpp_register_sync (MMModem3gpp *self,
const gchar *network_id,
GCancellable *cancellable,
GError **error)
{
g_return_val_if_fail (MM_GDBUS_IS_MODEM3GPP (self), FALSE);
return mm_gdbus_modem3gpp_call_register_sync (self,
network_id,
cancellable,
error);
}
void
mm_modem_3gpp_scan (MMModem3gpp *self,
GCancellable *cancellable,
GAsyncReadyCallback callback,
gpointer user_data)
{
g_return_if_fail (MM_GDBUS_IS_MODEM3GPP (self));
mm_gdbus_modem3gpp_call_scan (self,
cancellable,
callback,
user_data);
}
gboolean
mm_modem_3gpp_scan_finish (MMModem3gpp *self,
GVariant **results,
GAsyncResult *res,
GError **error)
{
g_return_val_if_fail (MM_GDBUS_IS_MODEM3GPP (self), FALSE);
return mm_gdbus_modem3gpp_call_scan_finish (self,
results,
res,
error);
}
gboolean
mm_modem_3gpp_scan_sync (MMModem3gpp *self,
GVariant **results,
GCancellable *cancellable,
GError **error)
{
g_return_val_if_fail (MM_GDBUS_IS_MODEM3GPP (self), FALSE);
return mm_gdbus_modem3gpp_call_scan_sync (self,
results,
cancellable,
error);
}

View File

@@ -0,0 +1,77 @@
/* -*- Mode: C; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* libmm -- Access modem status & information from glib applications
*
* 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 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., 51 Franklin Street, Fifth Floor,
* Boston, MA 02110-1301 USA.
*
* Copyright (C) 2011 Aleksander Morgado <aleksander@gnu.org>
*/
#ifndef _MM_MODEM_3GPP_H_
#define _MM_MODEM_3GPP_H_
#include <ModemManager.h>
#include <mm-gdbus-modem.h>
G_BEGIN_DECLS
typedef MmGdbusModem3gpp MMModem3gpp;
#define MM_TYPE_MODEM_3GPP(o) MM_GDBUS_TYPE_MODEM3GPP (o)
#define MM_MODEM_3GPP(o) MM_GDBUS_MODEM3GPP(o)
#define MM_IS_MODEM_3GPP(o) MM_GDBUS_IS_MODEM3GPP(o)
const gchar *mm_modem_3gpp_get_path (MMModem3gpp *self);
gchar *mm_modem_3gpp_dup_path (MMModem3gpp *self);
const gchar *mm_modem_3gpp_get_imei (MMModem3gpp *self);
gchar *mm_modem_3gpp_dup_imei (MMModem3gpp *self);
const gchar *mm_modem_3gpp_get_operator_code (MMModem3gpp *self);
gchar *mm_modem_3gpp_dup_operator_code (MMModem3gpp *self);
const gchar *mm_modem_3gpp_get_operator_name (MMModem3gpp *self);
gchar *mm_modem_3gpp_dup_operator_name (MMModem3gpp *self);
MMModem3gppRegistrationState mm_modem_3gpp_get_registration_state (MMModem3gpp *self);
MMModem3gppFacility mm_modem_3gpp_get_enabled_facility_locks (MMModem3gpp *self);
void mm_modem_3gpp_register (MMModem3gpp *self,
const gchar *network_id,
GCancellable *cancellable,
GAsyncReadyCallback callback,
gpointer user_data);
gboolean mm_modem_3gpp_register_finish (MMModem3gpp *self,
GAsyncResult *res,
GError **error);
gboolean mm_modem_3gpp_register_sync (MMModem3gpp *self,
const gchar *network_id,
GCancellable *cancellable,
GError **error);
void mm_modem_3gpp_scan (MMModem3gpp *self,
GCancellable *cancellable,
GAsyncReadyCallback callback,
gpointer user_data);
gboolean mm_modem_3gpp_scan_finish (MMModem3gpp *self,
GVariant **results,
GAsyncResult *res,
GError **error);
gboolean mm_modem_3gpp_scan_sync (MMModem3gpp *self,
GVariant **results,
GCancellable *cancellable,
GError **error);
G_END_DECLS
#endif /* _MM_MODEM_3GPP_H_ */

File diff suppressed because it is too large Load Diff

View File

@@ -30,12 +30,14 @@
G_BEGIN_DECLS
typedef MmGdbusObject MMModem;
#define MM_TYPE_MODEM(o) MM_GDBUS_TYPE_OBJECT (o)
#define MM_MODEM(o) MM_GDBUS_OBJECT(o)
#define MM_IS_MODEM(o) MM_GDBUS_IS_OBJECT(o)
typedef MmGdbusModem MMModem;
#define MM_TYPE_MODEM(o) MM_GDBUS_TYPE_MODEM (o)
#define MM_MODEM(o) MM_GDBUS_MODEM(o)
#define MM_IS_MODEM(o) MM_GDBUS_IS_MODEM(o)
const gchar *mm_modem_get_path (MMModem *self);
gchar *mm_modem_dup_path (MMModem *self);
const gchar *mm_modem_get_path (MMModem *self);
const gchar *mm_modem_get_sim_path (MMModem *self);
gchar *mm_modem_dup_sim_path (MMModem *self);
MMModemCapability mm_modem_get_modem_capabilities (MMModem *self);

129
libmm-glib/mm-object.c Normal file
View File

@@ -0,0 +1,129 @@
/* -*- Mode: C; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* libmm -- Access modem status & information from glib applications
*
* 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 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., 51 Franklin Street, Fifth Floor,
* Boston, MA 02110-1301 USA.
*
* Copyright (C) 2011 Aleksander Morgado <aleksander@gnu.org>
*/
#include "mm-object.h"
/**
* mm_object_get_path:
* @self: A #MMObject.
*
* Gets the DBus path of the #MMObject object.
*
* Returns: (transfer none): The DBus path of the #MMObject object.
*/
const gchar *
mm_object_get_path (MMObject *self)
{
g_return_val_if_fail (G_IS_DBUS_OBJECT (self), NULL);
return g_dbus_object_get_object_path (G_DBUS_OBJECT (self));
}
/**
* mm_object_dup_path:
* @self: A #MMObject.
*
* Gets a copy of the DBus path of the #MMObject object.
*
* Returns: (transfer full): The DBus path of the #MMObject. The returned value should be freed with g_free().
*/
gchar *
mm_object_dup_path (MMObject *self)
{
gchar *value;
g_return_val_if_fail (G_IS_DBUS_OBJECT_PROXY (self), NULL);
g_object_get (G_OBJECT (self),
"g-object-path", &value,
NULL);
return value;
}
/**
* mm_object_get_modem:
* @object: A #MMModem
*
* Gets the #MMModem instance for the D-Bus interface <link linkend="gdbus-interface-org-freedesktop-ModemManager1-Modem.top_of_page">org.freedesktop.ModemManager1.Modem</link> on @object, if any.
*
* Returns: (transfer full): A #MMModem that must be freed with g_object_unref() or %NULL if @object does not implement the interface.
*/
MMModem *
mm_object_get_modem (MMObject *object)
{
g_return_val_if_fail (MM_GDBUS_IS_OBJECT (object), NULL);
return mm_gdbus_object_get_modem (object);
}
/**
* mm_object_get_modem_3gpp:
* @object: A #MMObject.
*
* Gets the #MMModem3gpp instance for the D-Bus interface <link linkend="gdbus-interface-org-freedesktop-ModemManager1-Modem-Modem3gpp.top_of_page">org.freedesktop.ModemManager1.Modem.Modem3gpp</link> on @object, if any.
*
* Returns: (transfer full): A #MMModem3gpp that must be freed with g_object_unref() or %NULL if @object does not implement the interface.
*/
MMModem3gpp *
mm_object_get_modem_3gpp (MMObject *object)
{
g_return_val_if_fail (MM_GDBUS_IS_OBJECT (object), NULL);
return mm_gdbus_object_get_modem3gpp (object);
}
/**
* mm_object_peek_modem: (skip)
* @object: A #MMObject.
*
* Like mm_object_get_modem() but doesn't increase the reference count on the returned object.
*
* <warning>It is not safe to use the returned object if you are on another thread than the one where the #MMManager is running.</warning>
*
* Returns: (transfer none): A #MMModem or %NULL if @object does not implement the interface. Do not free the returned object, it is owned by @object.
*/
MMModem *
mm_object_peek_modem (MMObject *object)
{
g_return_val_if_fail (MM_GDBUS_IS_OBJECT (object), NULL);
return mm_gdbus_object_peek_modem (object);
}
/**
* mm_object_peek_modem_3gpp: (skip)
* @object: A #MMObject.
*
* Like mm_object_get_modem_3gpp() but doesn't increase the reference count on the returned object.
*
* <warning>It is not safe to use the returned object if you are on another thread than the one where the #MMManager is running.</warning>
*
* Returns: (transfer none): A #MMModem3gpp or %NULL if @object does not implement the interface. Do not free the returned object, it is owned by @object.
*/
MMModem3gpp *
mm_object_peek_modem_3gpp (MMObject *object)
{
g_return_val_if_fail (MM_GDBUS_IS_OBJECT (object), NULL);
return mm_gdbus_object_peek_modem3gpp (object);
}

50
libmm-glib/mm-object.h Normal file
View File

@@ -0,0 +1,50 @@
/* -*- Mode: C; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* libmm -- Access modem status & information from glib applications
*
* 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 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., 51 Franklin Street, Fifth Floor,
* Boston, MA 02110-1301 USA.
*
* Copyright (C) 2011 Aleksander Morgado <aleksander@gnu.org>
*/
#ifndef _MM_OBJECT_H_
#define _MM_OBJECT_H_
#include <ModemManager.h>
#include <mm-gdbus-modem.h>
#include "mm-modem.h"
#include "mm-modem-3gpp.h"
G_BEGIN_DECLS
typedef MmGdbusObject MMObject;
#define MM_TYPE_OBJECT(o) MM_GDBUS_TYPE_OBJECT (o)
#define MM_OBJECT(o) MM_GDBUS_OBJECT(o)
#define MM_IS_OBJECT(o) MM_GDBUS_IS_OBJECT(o)
const gchar *mm_object_get_path (MMObject *self);
gchar *mm_object_dup_path (MMObject *self);
MMModem *mm_object_get_modem (MMObject *object);
MMModem3gpp *mm_object_get_modem_3gpp (MMObject *object);
MMModem *mm_object_peek_modem (MMObject *object);
MMModem3gpp *mm_object_peek_modem_3gpp (MMObject *object);
G_END_DECLS
#endif /* _MM_OBJECT_H_ */