ModemManager/libmm-common/mm-common-helpers.c

/* -*- 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 <gio/gio.h>

#include <ModemManager.h>

#include "mm-enums-types.h"
#include "mm-errors-types.h"
#include "mm-common-helpers.h"

gchar *
mm_common_get_capabilities_string (MMModemCapability caps)
{
	GFlagsClass *flags_class;
    GString *str;

    str = g_string_new ("");
    flags_class = G_FLAGS_CLASS (g_type_class_ref (MM_TYPE_MODEM_CAPABILITY));

    if (caps == MM_MODEM_CAPABILITY_NONE) {
        GFlagsValue *value;

        value = g_flags_get_first_value (flags_class, caps);
        g_string_append (str, value->value_nick);
    } else {
        MMModemCapability it;
        gboolean first = TRUE;

        for (it = MM_MODEM_CAPABILITY_POTS; /* first */
             it <= MM_MODEM_CAPABILITY_LTE_ADVANCED; /* last */
             it = it << 1) {
            if (caps & it) {
                GFlagsValue *value;

                value = g_flags_get_first_value (flags_class, it);
                g_string_append_printf (str, "%s%s",
                                        first ? "" : ", ",
                                        value->value_nick);

                if (first)
                    first = FALSE;
            }
        }
    }
    g_type_class_unref (flags_class);

    return g_string_free (str, FALSE);
}

gchar *
mm_common_get_access_technologies_string (MMModemAccessTechnology access_tech)
{
	GFlagsClass *flags_class;
    GString *str;

    str = g_string_new ("");
    flags_class = G_FLAGS_CLASS (g_type_class_ref (MM_TYPE_MODEM_ACCESS_TECHNOLOGY));

    if (access_tech == MM_MODEM_ACCESS_TECHNOLOGY_UNKNOWN) {
        GFlagsValue *value;

        value = g_flags_get_first_value (flags_class, access_tech);
        g_string_append (str, value->value_nick);
    } else {
        MMModemAccessTechnology it;
        gboolean first = TRUE;

        for (it = MM_MODEM_ACCESS_TECHNOLOGY_GSM; /* first */
             it <= MM_MODEM_ACCESS_TECHNOLOGY_LTE; /* last */
             it = it << 1) {
            if (access_tech & it) {
                GFlagsValue *value;

                value = g_flags_get_first_value (flags_class, it);
                g_string_append_printf (str, "%s%s",
                                        first ? "" : ", ",
                                        value->value_nick);

                if (first)
                    first = FALSE;
            }
        }
    }
    g_type_class_unref (flags_class);

    return g_string_free (str, FALSE);
}

gchar *
mm_common_get_modes_string (MMModemMode mode)
{
	GFlagsClass *flags_class;
    GString *str;

    str = g_string_new ("");
    flags_class = G_FLAGS_CLASS (g_type_class_ref (MM_TYPE_MODEM_MODE));

    if (mode == MM_MODEM_MODE_NONE ||
        mode == MM_MODEM_MODE_ANY) {
        GFlagsValue *value;

        value = g_flags_get_first_value (flags_class, mode);
        g_string_append (str, value->value_nick);
    } else {
        MMModemMode it;
        gboolean first = TRUE;

        for (it = MM_MODEM_MODE_1G; /* first */
             it <= MM_MODEM_MODE_4G; /* last */
             it = it << 1) {
            if (mode & it) {
                GFlagsValue *value;

                value = g_flags_get_first_value (flags_class, it);
                g_string_append_printf (str, "%s%s",
                                        first ? "" : ", ",
                                        value->value_nick);

                if (first)
                    first = FALSE;
            }
        }
    }
    g_type_class_unref (flags_class);

    return g_string_free (str, FALSE);
}

gchar *
mm_common_get_bands_string (const MMModemBand *bands,
                            guint n_bands)
{
	GEnumClass *enum_class;
    gboolean first = TRUE;
    GString *str;
    guint i;

    str = g_string_new ("");
    if (n_bands == 0) {
        g_string_append (str, "none");
        return g_string_free (str, FALSE);
    }

    enum_class = G_ENUM_CLASS (g_type_class_ref (MM_TYPE_MODEM_BAND));
    for (i = 0; i < n_bands; i++) {
        GEnumValue *value;

        value = g_enum_get_value (enum_class, bands[i]);
        g_string_append_printf (str, "%s%s",
                                first ? "" : ", ",
                                value->value_nick);

        if (first)
            first = FALSE;
    }
    g_type_class_unref (enum_class);

    return g_string_free (str, FALSE);
}

MMModemMode
mm_common_get_modes_from_string (const gchar *str,
                                 GError **error)
{
    GError *inner_error = NULL;
    MMModemMode modes;
    gchar **mode_strings;
	GFlagsClass *flags_class;

    modes = MM_MODEM_MODE_NONE;

    flags_class = G_FLAGS_CLASS (g_type_class_ref (MM_TYPE_MODEM_MODE));
    mode_strings = g_strsplit (str, "|", -1);

    if (mode_strings) {
        guint i;

        for (i = 0; mode_strings[i]; i++) {
            guint j;
            gboolean found = FALSE;

            for (j = 0; flags_class->values[j].value_nick; j++) {
                if (g_str_equal (mode_strings[i], flags_class->values[j].value_nick)) {
                    modes |= flags_class->values[j].value;
                    found = TRUE;
                    break;
                }
            }

            if (!found) {
                inner_error = g_error_new (
                    MM_CORE_ERROR,
                    MM_CORE_ERROR_INVALID_ARGS,
                    "Couldn't match '%s' with a valid MMModemMode value",
                    mode_strings[i]);
                break;
            }
        }
    }

    if (inner_error) {
        g_propagate_error (error, inner_error);
        modes = MM_MODEM_MODE_NONE;
    }

    g_type_class_unref (flags_class);
    g_strfreev (mode_strings);
    return modes;
}

void
mm_common_get_bands_from_string (const gchar *str,
                                 MMModemBand **bands,
                                 guint *n_bands,
                                 GError **error)
{
    GError *inner_error = NULL;
    GArray *array;
    gchar **band_strings;
	GEnumClass *enum_class;

    array = g_array_new (FALSE, FALSE, sizeof (MMModemBand));

    enum_class = G_ENUM_CLASS (g_type_class_ref (MM_TYPE_MODEM_BAND));
    band_strings = g_strsplit (str, "|", -1);

    if (band_strings) {
        guint i;

        for (i = 0; band_strings[i]; i++) {
            guint j;
            gboolean found = FALSE;

            for (j = 0; enum_class->values[j].value_nick; j++) {
                if (g_str_equal (band_strings[i], enum_class->values[j].value_nick)) {
                    g_array_append_val (array, enum_class->values[j].value);
                    found = TRUE;
                    break;
                }
            }

            if (!found) {
                inner_error = g_error_new (MM_CORE_ERROR,
                                           MM_CORE_ERROR_INVALID_ARGS,
                                           "Couldn't match '%s' with a valid MMModemBand value",
                                           band_strings[i]);
                break;
            }
        }
    }

    if (inner_error) {
        g_propagate_error (error, inner_error);
        g_array_free (array, TRUE);
        *n_bands = 0;
        *bands = NULL;
    } else {
        if (!array->len) {
            GEnumValue *value;

            value = g_enum_get_value (enum_class, MM_MODEM_BAND_UNKNOWN);
            g_array_append_val (array, value->value);
        }

        *n_bands = array->len;
        *bands = (MMModemBand *)g_array_free (array, FALSE);
    }

    g_type_class_unref (enum_class);
    g_strfreev (band_strings);
}

GArray *
mm_common_bands_variant_to_garray (GVariant *variant)
{
    GArray *array;
    GVariantIter iter;
    guint32 band = MM_MODEM_BAND_UNKNOWN;

    g_variant_iter_init (&iter, variant);
    array = g_array_sized_new (FALSE,
                               FALSE,
                               sizeof (MMModemBand),
                               g_variant_iter_n_children (&iter));
    while (g_variant_iter_loop (&iter, "u", &band))
        g_array_append_val (array, band);

    return array;
}

GVariant *
mm_common_bands_array_to_variant (const MMModemBand *bands,
                                  guint n_bands)
{
    GVariantBuilder builder;
    guint i;

    g_variant_builder_init (&builder, G_VARIANT_TYPE ("au"));
    for (i = 0; i < n_bands; i++) {
        g_variant_builder_add_value (&builder,
                                     g_variant_new_uint32 ((guint32)bands[i]));
    }

    return g_variant_builder_end (&builder);
}

GVariant *
mm_common_bands_garray_to_variant (GArray *array)
{
    return mm_common_bands_array_to_variant ((const MMModemBand *)array->data,
                                             array->len);
}

gboolean
mm_common_get_boolean_from_string (const gchar *value,
                                   GError **error)
{
    if (!g_ascii_strcasecmp (value, "true") || g_str_equal (value, "1"))
        return TRUE;

    if (g_ascii_strcasecmp (value, "false") && g_str_equal (value, "0"))
        g_set_error (error,
                     MM_CORE_ERROR,
                     MM_CORE_ERROR_INVALID_ARGS,
                     "Cannot get boolean from string '%s'", value);

    return FALSE;
}