colin/ModemManager
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

libmm-common: new helper object to handle simple properties from all interfaces

Browse Source
This commit is contained in:
Aleksander Morgado
2011-12-28 13:49:32 +01:00
parent b0272444cb
commit 111cd56a2b
4 changed files with 436 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
libmm-common/Makefile.am
View File

@@ -151,6 +151,7 @@ include_HEADERS = \
mm-errors-types.h \
mm-enums-types.h \
mm-common-helpers.h \
mm-common-simple-properties.h \
mm-common-connect-properties.h \
mm-common-bearer-properties.h \
mm-gdbus-manager.h \
@@ -165,6 +166,8 @@ libmm_common_la_SOURCES = \
mm-errors-quarks.c \
mm-common-helpers.h \
mm-common-helpers.c \
mm-common-simple-properties.h \
mm-common-simple-properties.c \
mm-common-connect-properties.h \
mm-common-connect-properties.c \
mm-common-bearer-properties.h \

1
libmm-common/libmm-common.h
View File

@@ -26,6 +26,7 @@
#include "mm-errors-types.h"
#include "mm-enums-types.h"
#include "mm-common-helpers.h"
#include "mm-common-simple-properties.h"
#include "mm-common-connect-properties.h"
#include "mm-common-bearer-properties.h"
#include "mm-gdbus-manager.h"

361
libmm-common/mm-common-simple-properties.c Normal file
View File

@@ -0,0 +1,361 @@
/* -*- Mode: C; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* 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:
*
* Copyright (C) 2011 Google, Inc.
*/
#include <string.h>
#include <libmm-common.h>
#include "mm-common-simple-properties.h"
G_DEFINE_TYPE (MMCommonSimpleProperties, mm_common_simple_properties, G_TYPE_OBJECT);
enum {
PROP_0,
PROP_STATE,
PROP_SIGNAL_QUALITY,
PROP_BANDS,
PROP_ACCESS_TECHNOLOGIES,
PROP_3GPP_REGISTRATION_STATE,
PROP_3GPP_OPERATOR_CODE,
PROP_3GPP_OPERATOR_NAME,
PROP_LAST
};
static GParamSpec *properties[PROP_LAST];
struct _MMCommonSimplePropertiesPrivate {
/* <--- From the Modem interface ---> */
/* Overall modem state, signature 'u' */
MMModemState state;
/* Signal quality, given only when registered, signature '(ub)' */
GVariant *signal_quality;
/* List of bands, given only when registered, signature: au */
GVariant *bands;
GArray *bands_array;
/* Access technologies, given only when registered, signature: u */
MMModemAccessTechnology access_technologies;
/* <--- From the Modem 3GPP interface ---> */
/* 3GPP registration state, signature 'u' */
MMModem3gppRegistrationState registration_state;
/* 3GPP operator code, given only when registered, signature 's' */
gchar *operator_code;
/* 3GPP operator name, given only when registered, signature 's' */
gchar *operator_name;
};
/*****************************************************************************/
MMModemState
mm_common_simple_properties_get_state (MMCommonSimpleProperties *self)
{
return self->priv->state;
}
guint32
mm_common_simple_properties_get_signal_quality (MMCommonSimpleProperties *self,
gboolean *recent)
{
guint32 signal_quality = 0;
gboolean signal_quality_recent = FALSE;
if (self->priv->signal_quality) {
g_variant_get (self->priv->signal_quality,
"(ub)",
&signal_quality,
&signal_quality_recent);
}
if (recent)
*recent = signal_quality_recent;
return signal_quality;
}
void
mm_common_simple_properties_get_bands (MMCommonSimpleProperties *self,
const MMModemBand **bands,
guint *n_bands)
{
if (!self->priv->bands_array)
self->priv->bands_array = mm_common_bands_variant_to_garray (self->priv->bands);
*n_bands = self->priv->bands_array->len;
*bands = (const MMModemBand *)self->priv->bands_array->data;
}
MMModemAccessTechnology
mm_common_simple_properties_get_access_technologies (MMCommonSimpleProperties *self)
{
return self->priv->access_technologies;
}
MMModem3gppRegistrationState
mm_common_simple_properties_get_registration_state (MMCommonSimpleProperties *self)
{
return self->priv->registration_state;
}
const gchar *
mm_common_simple_properties_get_operator_code (MMCommonSimpleProperties *self)
{
return self->priv->operator_code;
}
const gchar *
mm_common_simple_properties_get_operator_name (MMCommonSimpleProperties *self)
{
return self->priv->operator_name;
}
/*****************************************************************************/
GVariant *
mm_common_simple_properties_get_dictionary (MMCommonSimpleProperties *self)
{
GVariantBuilder builder;
g_variant_builder_init (&builder, G_VARIANT_TYPE ("a{sv}"));
g_variant_builder_add (&builder,
"{sv}",
MM_COMMON_SIMPLE_PROPERTY_STATE,
g_variant_new_uint32 (self->priv->state));
/* Next ones, only when registered */
if (self->priv->state >= MM_MODEM_STATE_REGISTERED) {
g_variant_builder_add (&builder,
"{sv}",
MM_COMMON_SIMPLE_PROPERTY_SIGNAL_QUALITY,
self->priv->signal_quality);
g_variant_builder_add (&builder,
"{sv}",
MM_COMMON_SIMPLE_PROPERTY_BANDS,
self->priv->bands);
g_variant_builder_add (&builder,
"{sv}",
MM_COMMON_SIMPLE_PROPERTY_ACCESS_TECHNOLOGIES,
g_variant_new_uint32 (self->priv->access_technologies));
g_variant_builder_add (&builder,
"{sv}",
MM_COMMON_SIMPLE_PROPERTY_3GPP_REGISTRATION_STATE,
g_variant_new_uint32 (self->priv->registration_state));
if (self->priv->operator_code)
g_variant_builder_add (&builder,
"{sv}",
MM_COMMON_SIMPLE_PROPERTY_3GPP_OPERATOR_CODE,
g_variant_new_string (self->priv->operator_code));
if (self->priv->operator_name)
g_variant_builder_add (&builder,
"{sv}",
MM_COMMON_SIMPLE_PROPERTY_3GPP_OPERATOR_NAME,
g_variant_new_string (self->priv->operator_name));
}
return g_variant_ref_sink (g_variant_builder_end (&builder));
}
/*****************************************************************************/
MMCommonSimpleProperties *
mm_common_simple_properties_new (void)
{
return (MM_COMMON_SIMPLE_PROPERTIES (
g_object_new (MM_TYPE_COMMON_SIMPLE_PROPERTIES, NULL)));
}
static void
set_property (GObject *object,
guint prop_id,
const GValue *value,
GParamSpec *pspec)
{
MMCommonSimpleProperties *self = MM_COMMON_SIMPLE_PROPERTIES (object);
switch (prop_id) {
case PROP_STATE:
self->priv->state = g_value_get_enum (value);
break;
case PROP_SIGNAL_QUALITY:
if (self->priv->signal_quality)
g_variant_unref (self->priv->signal_quality);
self->priv->signal_quality = g_value_dup_variant (value);
break;
case PROP_BANDS:
if (self->priv->bands)
g_variant_unref (self->priv->bands);
if (self->priv->bands_array) {
g_array_unref (self->priv->bands_array);
self->priv->bands_array = NULL;
}
self->priv->bands = g_value_dup_variant (value);
break;
case PROP_ACCESS_TECHNOLOGIES:
self->priv->access_technologies = g_value_get_flags (value);
break;
case PROP_3GPP_REGISTRATION_STATE:
self->priv->registration_state = g_value_get_enum (value);
break;
case PROP_3GPP_OPERATOR_CODE:
g_free (self->priv->operator_code);
self->priv->operator_code = g_value_dup_string (value);
break;
case PROP_3GPP_OPERATOR_NAME:
g_free (self->priv->operator_name);
self->priv->operator_name = g_value_dup_string (value);
break;
default:
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
break;
}
}
static void
get_property (GObject *object,
guint prop_id,
GValue *value,
GParamSpec *pspec)
{
MMCommonSimpleProperties *self = MM_COMMON_SIMPLE_PROPERTIES (object);
switch (prop_id) {
case PROP_STATE:
g_value_set_enum (value, self->priv->state);
break;
case PROP_SIGNAL_QUALITY:
g_value_set_variant (value, self->priv->signal_quality);
break;
case PROP_BANDS:
g_value_set_variant (value, self->priv->bands);
break;
case PROP_ACCESS_TECHNOLOGIES:
g_value_set_flags (value, self->priv->access_technologies);
break;
case PROP_3GPP_REGISTRATION_STATE:
g_value_set_enum (value, self->priv->registration_state);
break;
case PROP_3GPP_OPERATOR_CODE:
g_value_set_string (value, self->priv->operator_code);
break;
case PROP_3GPP_OPERATOR_NAME:
g_value_set_string (value, self->priv->operator_name);
break;
default:
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
break;
}
}
static void
mm_common_simple_properties_init (MMCommonSimpleProperties *self)
{
self->priv = G_TYPE_INSTANCE_GET_PRIVATE ((self),
MM_TYPE_COMMON_SIMPLE_PROPERTIES,
MMCommonSimplePropertiesPrivate);
/* Some defaults */
self->priv->state = MM_MODEM_STATE_UNKNOWN;
self->priv->access_technologies = MM_MODEM_ACCESS_TECHNOLOGY_UNKNOWN;
self->priv->registration_state = MM_MODEM_3GPP_REGISTRATION_STATE_UNKNOWN;
self->priv->bands = g_variant_ref_sink (mm_common_build_bands_unknown ());
self->priv->signal_quality = g_variant_ref_sink (g_variant_new ("(ub)", 0, 0));
}
static void
finalize (GObject *object)
{
MMCommonSimpleProperties *self = MM_COMMON_SIMPLE_PROPERTIES (object);
g_variant_unref (self->priv->bands);
if (self->priv->bands_array)
g_array_unref (self->priv->bands_array);
g_free (self->priv->operator_code);
g_free (self->priv->operator_name);
G_OBJECT_CLASS (mm_common_simple_properties_parent_class)->finalize (object);
}
static void
mm_common_simple_properties_class_init (MMCommonSimplePropertiesClass *klass)
{
GObjectClass *object_class = G_OBJECT_CLASS (klass);
g_type_class_add_private (object_class, sizeof (MMCommonSimplePropertiesPrivate));
/* Virtual methods */
object_class->set_property = set_property;
object_class->get_property = get_property;
object_class->finalize = finalize;
properties[PROP_STATE] =
g_param_spec_enum (MM_COMMON_SIMPLE_PROPERTY_STATE,
"State",
"State of the modem",
MM_TYPE_MODEM_STATE,
MM_MODEM_STATE_UNKNOWN,
G_PARAM_READWRITE);
g_object_class_install_property (object_class, PROP_STATE, properties[PROP_STATE]);
properties[PROP_SIGNAL_QUALITY] =
g_param_spec_variant (MM_COMMON_SIMPLE_PROPERTY_SIGNAL_QUALITY,
"Signal quality",
"Signal quality reported by the modem",
G_VARIANT_TYPE ("(ub)"),
NULL,
G_PARAM_READWRITE);
g_object_class_install_property (object_class, PROP_SIGNAL_QUALITY, properties[PROP_SIGNAL_QUALITY]);
properties[PROP_BANDS] =
g_param_spec_variant (MM_COMMON_SIMPLE_PROPERTY_BANDS,
"Bands",
"Frequency bands used by the modem",
G_VARIANT_TYPE ("au"),
NULL,
G_PARAM_READWRITE);
g_object_class_install_property (object_class, PROP_BANDS, properties[PROP_BANDS]);
properties[PROP_ACCESS_TECHNOLOGIES] =
g_param_spec_flags (MM_COMMON_SIMPLE_PROPERTY_ACCESS_TECHNOLOGIES,
"Access Technologies",
"Access technologies used by the modem",
MM_TYPE_MODEM_ACCESS_TECHNOLOGY,
MM_MODEM_ACCESS_TECHNOLOGY_UNKNOWN,
G_PARAM_READWRITE);
g_object_class_install_property (object_class, PROP_ACCESS_TECHNOLOGIES, properties[PROP_ACCESS_TECHNOLOGIES]);
properties[PROP_3GPP_REGISTRATION_STATE] =
g_param_spec_enum (MM_COMMON_SIMPLE_PROPERTY_3GPP_REGISTRATION_STATE,
"3GPP registration state",
"Registration state in the 3GPP network",
MM_TYPE_MODEM_3GPP_REGISTRATION_STATE,
MM_MODEM_3GPP_REGISTRATION_STATE_UNKNOWN,
G_PARAM_READWRITE);
g_object_class_install_property (object_class, PROP_3GPP_REGISTRATION_STATE, properties[PROP_3GPP_REGISTRATION_STATE]);
properties[PROP_3GPP_OPERATOR_CODE] =
g_param_spec_string (MM_COMMON_SIMPLE_PROPERTY_3GPP_OPERATOR_CODE,
"3GPP operator code",
"Code of the current operator in the 3GPP network",
NULL,
G_PARAM_READWRITE);
g_object_class_install_property (object_class, PROP_3GPP_OPERATOR_CODE, properties[PROP_3GPP_OPERATOR_CODE]);
properties[PROP_3GPP_OPERATOR_NAME] =
g_param_spec_string (MM_COMMON_SIMPLE_PROPERTY_3GPP_OPERATOR_NAME,
"3GPP operator name",
"Name of the current operator in the 3GPP network",
NULL,
G_PARAM_READWRITE);
g_object_class_install_property (object_class, PROP_3GPP_OPERATOR_NAME, properties[PROP_3GPP_OPERATOR_NAME]);
}

71
libmm-common/mm-common-simple-properties.h Normal file
View File

@@ -0,0 +1,71 @@
/* -*- Mode: C; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* 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:
*
* Copyright (C) 2011 Google, Inc.
*/
#ifndef MM_COMMON_SIMPLE_PROPERTIES_H
#define MM_COMMON_SIMPLE_PROPERTIES_H
#include <ModemManager.h>
#include <glib-object.h>
G_BEGIN_DECLS
#define MM_TYPE_COMMON_SIMPLE_PROPERTIES (mm_common_simple_properties_get_type ())
#define MM_COMMON_SIMPLE_PROPERTIES(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), MM_TYPE_COMMON_SIMPLE_PROPERTIES, MMCommonSimpleProperties))
#define MM_COMMON_SIMPLE_PROPERTIES_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), MM_TYPE_COMMON_SIMPLE_PROPERTIES, MMCommonSimplePropertiesClass))
#define MM_IS_COMMON_SIMPLE_PROPERTIES(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), MM_TYPE_COMMON_SIMPLE_PROPERTIES))
#define MM_IS_COMMON_SIMPLE_PROPERTIES_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), MM_TYPE_COMMON_SIMPLE_PROPERTIES))
#define MM_COMMON_SIMPLE_PROPERTIES_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), MM_TYPE_COMMON_SIMPLE_PROPERTIES, MMCommonSimplePropertiesClass))
#define MM_COMMON_SIMPLE_PROPERTY_STATE "state"
#define MM_COMMON_SIMPLE_PROPERTY_SIGNAL_QUALITY "signal-quality"
#define MM_COMMON_SIMPLE_PROPERTY_BANDS "bands"
#define MM_COMMON_SIMPLE_PROPERTY_ACCESS_TECHNOLOGIES "access-technologies"
#define MM_COMMON_SIMPLE_PROPERTY_3GPP_REGISTRATION_STATE "registration-state"
#define MM_COMMON_SIMPLE_PROPERTY_3GPP_OPERATOR_CODE "operator-code"
#define MM_COMMON_SIMPLE_PROPERTY_3GPP_OPERATOR_NAME "operator-name"
typedef struct _MMCommonSimpleProperties MMCommonSimpleProperties;
typedef struct _MMCommonSimplePropertiesClass MMCommonSimplePropertiesClass;
typedef struct _MMCommonSimplePropertiesPrivate MMCommonSimplePropertiesPrivate;
struct _MMCommonSimpleProperties {
GObject parent;
MMCommonSimplePropertiesPrivate *priv;
};
struct _MMCommonSimplePropertiesClass {
GObjectClass parent;
};
GType mm_common_simple_properties_get_type (void);
MMCommonSimpleProperties *mm_common_simple_properties_new (void);
MMModemState mm_common_simple_properties_get_state (MMCommonSimpleProperties *self);
guint32 mm_common_simple_properties_get_signal_quality (MMCommonSimpleProperties *self,
gboolean *recent);
void mm_common_simple_properties_get_bands (MMCommonSimpleProperties *self,
const MMModemBand **bands,
guint *n_bands);
MMModemAccessTechnology mm_common_simple_properties_get_access_technologies (MMCommonSimpleProperties *self);
MMModem3gppRegistrationState mm_common_simple_properties_get_registration_state (MMCommonSimpleProperties *self);
const gchar *mm_common_simple_properties_get_operator_code (MMCommonSimpleProperties *self);
const gchar *mm_common_simple_properties_get_operator_name (MMCommonSimpleProperties *self);
GVariant *mm_common_simple_properties_get_dictionary (MMCommonSimpleProperties *self);
G_END_DECLS
#endif /* MM_COMMON_SIMPLE_PROPERTIES_H */