cdc15cb2a6
Remove all the GParamSpec docs, since everything now uses the gtk-doc docs instead, so there's no point in having two copies of each (which are often out of sync anyway). Since we're touching so many lines anyway, also fix up the indentation of the remaining property-installing lines, and add G_PARAM_STATIC_STRINGS to each paramspec (so the nick strings don't get strduped). Also, be consistent about starting a new line between "g_object_class_install_property" and its opening parenthesis.
319 lines
8.5 KiB
C
319 lines
8.5 KiB
C
/* -*- Mode: C; tab-width: 4; indent-tabs-mode: t; c-basic-offset: 4 -*- */
|
|
|
|
/*
|
|
* Dan Williams <dcbw@redhat.com>
|
|
* Tambet Ingo <tambet@gmail.com>
|
|
*
|
|
* 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.
|
|
*
|
|
* (C) Copyright 2007 - 2011 Red Hat, Inc.
|
|
* (C) Copyright 2007 - 2008 Novell, Inc.
|
|
*/
|
|
|
|
#include <string.h>
|
|
|
|
#include "nm-setting-serial.h"
|
|
#include "nm-glib-compat.h"
|
|
#include "nm-setting-private.h"
|
|
|
|
/**
|
|
* SECTION:nm-setting-serial
|
|
* @short_description: Describes connection properties for devices that use
|
|
* serial communications
|
|
* @include: nm-setting-serial.h
|
|
*
|
|
* The #NMSettingSerial object is a #NMSetting subclass that describes
|
|
* properties necessary for connections that may use serial communications,
|
|
* such as mobile broadband or analog telephone connections.
|
|
**/
|
|
|
|
/**
|
|
* nm_setting_serial_error_quark:
|
|
*
|
|
* Registers an error quark for #NMSettingSerial if necessary.
|
|
*
|
|
* Returns: the error quark used for #NMSettingSerial errors.
|
|
**/
|
|
GQuark
|
|
nm_setting_serial_error_quark (void)
|
|
{
|
|
static GQuark quark;
|
|
|
|
if (G_UNLIKELY (!quark))
|
|
quark = g_quark_from_static_string ("nm-setting-serial-error-quark");
|
|
return quark;
|
|
}
|
|
|
|
|
|
G_DEFINE_TYPE_WITH_CODE (NMSettingSerial, nm_setting_serial, NM_TYPE_SETTING,
|
|
_nm_register_setting (NM_SETTING_SERIAL_SETTING_NAME,
|
|
g_define_type_id,
|
|
2,
|
|
NM_SETTING_SERIAL_ERROR))
|
|
NM_SETTING_REGISTER_TYPE (NM_TYPE_SETTING_SERIAL)
|
|
|
|
#define NM_SETTING_SERIAL_GET_PRIVATE(o) (G_TYPE_INSTANCE_GET_PRIVATE ((o), NM_TYPE_SETTING_SERIAL, NMSettingSerialPrivate))
|
|
|
|
typedef struct {
|
|
guint baud;
|
|
guint bits;
|
|
char parity;
|
|
guint stopbits;
|
|
guint64 send_delay;
|
|
} NMSettingSerialPrivate;
|
|
|
|
|
|
enum {
|
|
PROP_0,
|
|
PROP_BAUD,
|
|
PROP_BITS,
|
|
PROP_PARITY,
|
|
PROP_STOPBITS,
|
|
PROP_SEND_DELAY,
|
|
|
|
LAST_PROP
|
|
};
|
|
|
|
/**
|
|
* nm_setting_serial_new:
|
|
*
|
|
* Creates a new #NMSettingSerial object with default values.
|
|
*
|
|
* Returns: (transfer full): the new empty #NMSettingSerial object
|
|
**/
|
|
NMSetting *
|
|
nm_setting_serial_new (void)
|
|
{
|
|
return (NMSetting *) g_object_new (NM_TYPE_SETTING_SERIAL, NULL);
|
|
}
|
|
|
|
/**
|
|
* nm_setting_serial_get_baud:
|
|
* @setting: the #NMSettingSerial
|
|
*
|
|
* Returns: the #NMSettingSerial:baud property of the setting
|
|
**/
|
|
guint
|
|
nm_setting_serial_get_baud (NMSettingSerial *setting)
|
|
{
|
|
g_return_val_if_fail (NM_IS_SETTING_SERIAL (setting), 0);
|
|
|
|
return NM_SETTING_SERIAL_GET_PRIVATE (setting)->baud;
|
|
}
|
|
|
|
/**
|
|
* nm_setting_serial_get_bits:
|
|
* @setting: the #NMSettingSerial
|
|
*
|
|
* Returns: the #NMSettingSerial:bits property of the setting
|
|
**/
|
|
guint
|
|
nm_setting_serial_get_bits (NMSettingSerial *setting)
|
|
{
|
|
g_return_val_if_fail (NM_IS_SETTING_SERIAL (setting), 0);
|
|
|
|
return NM_SETTING_SERIAL_GET_PRIVATE (setting)->bits;
|
|
}
|
|
|
|
/**
|
|
* nm_setting_serial_get_parity:
|
|
* @setting: the #NMSettingSerial
|
|
*
|
|
* Returns: the #NMSettingSerial:parity property of the setting
|
|
**/
|
|
char
|
|
nm_setting_serial_get_parity (NMSettingSerial *setting)
|
|
{
|
|
g_return_val_if_fail (NM_IS_SETTING_SERIAL (setting), 0);
|
|
|
|
return NM_SETTING_SERIAL_GET_PRIVATE (setting)->parity;
|
|
}
|
|
|
|
/**
|
|
* nm_setting_serial_get_stopbits:
|
|
* @setting: the #NMSettingSerial
|
|
*
|
|
* Returns: the #NMSettingSerial:stopbits property of the setting
|
|
**/
|
|
guint
|
|
nm_setting_serial_get_stopbits (NMSettingSerial *setting)
|
|
{
|
|
g_return_val_if_fail (NM_IS_SETTING_SERIAL (setting), 0);
|
|
|
|
return NM_SETTING_SERIAL_GET_PRIVATE (setting)->stopbits;
|
|
}
|
|
|
|
/**
|
|
* nm_setting_serial_get_send_delay:
|
|
* @setting: the #NMSettingSerial
|
|
*
|
|
* Returns: the #NMSettingSerial:send-delay property of the setting
|
|
**/
|
|
guint64
|
|
nm_setting_serial_get_send_delay (NMSettingSerial *setting)
|
|
{
|
|
g_return_val_if_fail (NM_IS_SETTING_SERIAL (setting), 0);
|
|
|
|
return NM_SETTING_SERIAL_GET_PRIVATE (setting)->send_delay;
|
|
}
|
|
|
|
static gboolean
|
|
verify (NMSetting *setting, GSList *all_settings, GError **error)
|
|
{
|
|
return TRUE;
|
|
}
|
|
|
|
static void
|
|
nm_setting_serial_init (NMSettingSerial *setting)
|
|
{
|
|
}
|
|
|
|
static void
|
|
set_property (GObject *object, guint prop_id,
|
|
const GValue *value, GParamSpec *pspec)
|
|
{
|
|
NMSettingSerialPrivate *priv = NM_SETTING_SERIAL_GET_PRIVATE (object);
|
|
|
|
switch (prop_id) {
|
|
case PROP_BAUD:
|
|
priv->baud = g_value_get_uint (value);
|
|
break;
|
|
case PROP_BITS:
|
|
priv->bits = g_value_get_uint (value);
|
|
break;
|
|
case PROP_PARITY:
|
|
priv->parity = g_value_get_schar (value);
|
|
break;
|
|
case PROP_STOPBITS:
|
|
priv->stopbits = g_value_get_uint (value);
|
|
break;
|
|
case PROP_SEND_DELAY:
|
|
priv->send_delay = g_value_get_uint64 (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)
|
|
{
|
|
NMSettingSerial *setting = NM_SETTING_SERIAL (object);
|
|
|
|
switch (prop_id) {
|
|
case PROP_BAUD:
|
|
g_value_set_uint (value, nm_setting_serial_get_baud (setting));
|
|
break;
|
|
case PROP_BITS:
|
|
g_value_set_uint (value, nm_setting_serial_get_bits (setting));
|
|
break;
|
|
case PROP_PARITY:
|
|
g_value_set_schar (value, nm_setting_serial_get_parity (setting));
|
|
break;
|
|
case PROP_STOPBITS:
|
|
g_value_set_uint (value, nm_setting_serial_get_stopbits (setting));
|
|
break;
|
|
case PROP_SEND_DELAY:
|
|
g_value_set_uint64 (value, nm_setting_serial_get_send_delay (setting));
|
|
break;
|
|
default:
|
|
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
|
|
break;
|
|
}
|
|
}
|
|
|
|
static void
|
|
nm_setting_serial_class_init (NMSettingSerialClass *setting_class)
|
|
{
|
|
GObjectClass *object_class = G_OBJECT_CLASS (setting_class);
|
|
NMSettingClass *parent_class = NM_SETTING_CLASS (setting_class);
|
|
|
|
g_type_class_add_private (setting_class, sizeof (NMSettingSerialPrivate));
|
|
|
|
/* virtual methods */
|
|
object_class->set_property = set_property;
|
|
object_class->get_property = get_property;
|
|
parent_class->verify = verify;
|
|
|
|
/* Properties */
|
|
|
|
/**
|
|
* NMSettingSerial:baud:
|
|
*
|
|
* Speed to use for communication over the serial port. Note that this
|
|
* value usually has no effect for mobile broadband modems as they generally
|
|
* ignore speed settings and use the highest available speed.
|
|
**/
|
|
g_object_class_install_property
|
|
(object_class, PROP_BAUD,
|
|
g_param_spec_uint (NM_SETTING_SERIAL_BAUD, "", "",
|
|
0, G_MAXUINT, 57600,
|
|
G_PARAM_READWRITE | G_PARAM_CONSTRUCT |
|
|
G_PARAM_STATIC_STRINGS));
|
|
|
|
/**
|
|
* NMSettingSerial:bits:
|
|
*
|
|
* Byte-width of the serial communication. The 8 in "8n1" for example.
|
|
**/
|
|
g_object_class_install_property
|
|
(object_class, PROP_BITS,
|
|
g_param_spec_uint (NM_SETTING_SERIAL_BITS, "", "",
|
|
5, 8, 8,
|
|
G_PARAM_READWRITE | G_PARAM_CONSTRUCT |
|
|
G_PARAM_STATIC_STRINGS));
|
|
|
|
/**
|
|
* NMSettingSerial:parity:
|
|
*
|
|
* Parity setting of the serial port. Either 'E' for even parity, 'o' for
|
|
* odd parity, or 'n' for no parity.
|
|
**/
|
|
g_object_class_install_property
|
|
(object_class, PROP_PARITY,
|
|
g_param_spec_char (NM_SETTING_SERIAL_PARITY, "", "",
|
|
'E', 'o', 'n',
|
|
G_PARAM_READWRITE | G_PARAM_CONSTRUCT |
|
|
G_PARAM_STATIC_STRINGS));
|
|
|
|
/**
|
|
* NMSettingSerial:stopbits:
|
|
*
|
|
* Number of stop bits for communication on the serial port. Either 1 or 2.
|
|
* The 1 in "8n1" for example.
|
|
**/
|
|
g_object_class_install_property
|
|
(object_class, PROP_STOPBITS,
|
|
g_param_spec_uint (NM_SETTING_SERIAL_STOPBITS, "", "",
|
|
1, 2, 1,
|
|
G_PARAM_READWRITE | G_PARAM_CONSTRUCT |
|
|
G_PARAM_STATIC_STRINGS));
|
|
|
|
/**
|
|
* NMSettingSerial:send-delay:
|
|
*
|
|
* Time to delay between each byte sent to the modem, in microseconds.
|
|
**/
|
|
g_object_class_install_property
|
|
(object_class, PROP_SEND_DELAY,
|
|
g_param_spec_uint64 (NM_SETTING_SERIAL_SEND_DELAY, "", "",
|
|
0, G_MAXUINT64, 0,
|
|
G_PARAM_READWRITE | G_PARAM_CONSTRUCT |
|
|
G_PARAM_STATIC_STRINGS));
|
|
}
|