/*
 * peas-utils.c
 * This file is part of libpeas
 *
 * Copyright (C) 2010 Steve Frécinaux
 * Copyright (C) 2011-2017 Garrett Regier
 *
 * libpeas 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.1 of the License, or (at your option) any later version.
 *
 * libpeas 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 St, Fifth Floor, Boston, MA  02110-1301  USA.
 *
 * SPDX-License-Identifier: LGPL-2.1-or-later
 */

#include "config.h"

#include <string.h>

#include <gobject/gvaluecollector.h>

#include "peas-utils.h"

static const char *all_plugin_loaders[] = {
  "c", "lua5.1", "python",
};

static const char *all_plugin_loader_modules[] = {
  "cloader", "lua51loader", "pythonloader",
};

static const int conflicting_plugin_loaders[PEAS_UTILS_N_LOADERS][2] = {
  { -1, -1 }, /* c       => {} */
  { -1, -1 }, /* lua5.1  => {} */
  { -1, -1 }, /* python  => {} */
};

G_STATIC_ASSERT (G_N_ELEMENTS (all_plugin_loaders) == PEAS_UTILS_N_LOADERS);
G_STATIC_ASSERT (G_N_ELEMENTS (all_plugin_loader_modules) == PEAS_UTILS_N_LOADERS);
G_STATIC_ASSERT (G_N_ELEMENTS (conflicting_plugin_loaders) == PEAS_UTILS_N_LOADERS);

static
G_DEFINE_QUARK (peas-extension-base-class-and-interfaces-cache,
                exten_type_cache)

static void
add_all_prerequisites (GType      iface_type,
                       GType     *base_type,
                       GPtrArray *ifaces)
{
  GType *prereq;
  guint n_prereq;
  guint i;

  g_ptr_array_add (ifaces, g_type_default_interface_ref (iface_type));

  prereq = g_type_interface_prerequisites (iface_type, &n_prereq);

  for (i = 0; i < n_prereq; ++i)
    {
      if (G_TYPE_IS_INTERFACE (prereq[i]))
        {
          add_all_prerequisites (prereq[i], base_type, ifaces);
          continue;
        }

      if (!G_TYPE_IS_OBJECT (prereq[i]))
        continue;

      if (*base_type != G_TYPE_INVALID)
        {
          /* We already have the descendant GType */
          if (g_type_is_a (*base_type, prereq[i]))
            continue;

          /* Neither GType are descendant of the other, this is an
           * error and GObject will not be able to create an object
           */
          g_warn_if_fail (g_type_is_a (prereq[i], *base_type));
        }

      *base_type = prereq[i];
    }

  g_free (prereq);
}

static gpointer *
find_base_class_and_interfaces (GType exten_type)
{
  GPtrArray *results;
  GType base_type = G_TYPE_INVALID;
  static GMutex cache_lock;
  gpointer *data, *cached_data;

  results = g_ptr_array_new ();

  /* This is used for the GObjectClass of the base_type */
  g_ptr_array_add (results, NULL);

  if (G_TYPE_IS_INTERFACE (exten_type))
    {
      add_all_prerequisites (exten_type, &base_type, results);
    }
  else
    {
      int i;
      GType *interfaces;

      interfaces = g_type_interfaces (exten_type, NULL);
      for (i = 0; interfaces[i] != G_TYPE_INVALID; ++i)
        add_all_prerequisites (interfaces[i], &base_type, results);

      base_type = exten_type;

      g_free (interfaces);
    }

  if (base_type != G_TYPE_INVALID)
    g_ptr_array_index (results, 0) = g_type_class_ref (base_type);

  g_ptr_array_add (results, NULL);
  data = g_ptr_array_free (results, FALSE);

  g_mutex_lock (&cache_lock);
  cached_data = g_type_get_qdata (exten_type, exten_type_cache_quark ());

  if (cached_data != NULL)
    {
      g_free (data);
      data = cached_data;
    }
  else
    {
      g_type_set_qdata (exten_type, exten_type_cache_quark (), data);
    }

  g_mutex_unlock (&cache_lock);
  return data;
}

static inline gpointer *
get_base_class_and_interfaces (GType          exten_type,
                               GObjectClass **base_class)
{
  gpointer *data;

  data = g_type_get_qdata (exten_type, exten_type_cache_quark ());
  if (G_UNLIKELY (data == NULL))
    data = find_base_class_and_interfaces (exten_type);

  *base_class = data[0];
  return &data[1];
}

static inline GParamSpec *
find_param_spec_for_prerequisites (const char   *name,
                                   GObjectClass *base_class,
                                   gpointer     *ifaces)
{
  guint i;
  GParamSpec *pspec = NULL;

  if (base_class != NULL)
    pspec = g_object_class_find_property (base_class, name);

  for (i = 0; ifaces[i] != NULL && pspec == NULL; ++i)
    pspec = g_object_interface_find_property (ifaces[i], name);

  return pspec;
}

G_GNUC_BEGIN_IGNORE_DEPRECATIONS
gboolean
peas_utils_properties_array_to_parameter_list (GType          exten_type,
                                               guint          n_properties,
                                               const char   **prop_names,
                                               const GValue  *prop_values,
                                               GParameter    *parameters)
{
  guint i;
  gpointer *ifaces;
  GObjectClass *base_class;

  g_return_val_if_fail (n_properties == 0 || prop_names != NULL, FALSE);
  g_return_val_if_fail (n_properties == 0 || prop_values != NULL, FALSE);
  g_return_val_if_fail (n_properties == 0 || parameters != NULL, FALSE);

  ifaces = get_base_class_and_interfaces (exten_type, &base_class);
  memset (parameters, 0, sizeof (GParameter) * n_properties);
  for (i = 0; i < n_properties; i++)
    {
      GParamSpec *pspec;
      if (prop_names[i] == NULL)
        {
          g_warning ("The property name at index %u should not be NULL.", i);
          goto error;
        }
      if (!G_IS_VALUE (&prop_values[i]))
        {
          g_warning ("The property value at index %u should be an initialized GValue.", i);
          goto error;
        }
      pspec = find_param_spec_for_prerequisites (prop_names[i], base_class,
                                                 ifaces);
      if (!pspec)
        {
          g_warning ("%s: type '%s' has no property named '%s'",
                     G_STRFUNC, g_type_name (exten_type), prop_names[i]);
          goto error;
        }

      parameters[i].name = prop_names[i];

      g_value_init (&parameters[i].value,
                    G_VALUE_TYPE (&prop_values[i]));
      g_value_copy (&prop_values[i], &parameters[i].value);
    }
  return TRUE;

error:
  n_properties = i;
  for (i = 0; i < n_properties; i++)
    g_value_unset (&parameters[i].value);
  return FALSE;
}

gboolean
peas_utils_valist_to_parameter_list (GType        exten_type,
                                     const char  *first_property,
                                     va_list      args,
                                     GParameter **params,
                                     guint       *n_params)
{
  gpointer *ifaces;
  GObjectClass *base_class;
  const char *name;
  guint n_allocated_params;

  g_return_val_if_fail (G_TYPE_IS_INTERFACE (exten_type) ||
                        G_TYPE_IS_OBJECT (exten_type), FALSE);

  ifaces = get_base_class_and_interfaces (exten_type, &base_class);

  *n_params = 0;
  n_allocated_params = 16;
  *params = g_new0 (GParameter, n_allocated_params);

  name = first_property;
  while (name)
    {
      char *error_msg = NULL;
      GParamSpec *pspec;

      pspec = find_param_spec_for_prerequisites (name, base_class, ifaces);

      if (!pspec)
        {
          g_warning ("%s: type '%s' has no property named '%s'",
                     G_STRFUNC, g_type_name (exten_type), name);
          goto error;
        }

      if (*n_params >= n_allocated_params)
        {
          n_allocated_params += 16;
          *params = g_renew (GParameter, *params, n_allocated_params);
          memset (*params + (n_allocated_params - 16),
                  0, sizeof (GParameter) * 16);
        }

      (*params)[*n_params].name = name;
      G_VALUE_COLLECT_INIT (&(*params)[*n_params].value, pspec->value_type,
                            args, 0, &error_msg);

      (*n_params)++;

      if (error_msg)
        {
          g_warning ("%s: %s", G_STRFUNC, error_msg);
          g_free (error_msg);
          goto error;
        }

      name = va_arg (args, char*);
    }

  return TRUE;

error:

  for (; *n_params > 0; --(*n_params))
    g_value_unset (&(*params)[*n_params].value);

  g_free (*params);
  return FALSE;
}
G_GNUC_END_IGNORE_DEPRECATIONS

int
peas_utils_get_loader_id (const char *loader)
{
  int i;
  gsize len;
  char lowercase[32];

  len = strlen (loader);

  /* No loader has a name that long */
  if (len >= G_N_ELEMENTS (lowercase))
    return -1;

  for (i = 0; i < len; ++i)
    lowercase[i] = g_ascii_tolower (loader[i]);

  lowercase[len] = '\0';

  for (i = 0; i < G_N_ELEMENTS (all_plugin_loaders); ++i)
    {
      if (g_strcmp0 (lowercase, all_plugin_loaders[i]) == 0)
        return i;
    }

  return -1;
}

const char *
peas_utils_get_loader_from_id (int loader_id)
{
  g_return_val_if_fail (loader_id >= 0, NULL);
  g_return_val_if_fail (loader_id < PEAS_UTILS_N_LOADERS, NULL);

  return all_plugin_loaders[loader_id];
}

const char *
peas_utils_get_loader_module_from_id (int loader_id)
{
  g_return_val_if_fail (loader_id >= 0, NULL);
  g_return_val_if_fail (loader_id < PEAS_UTILS_N_LOADERS, NULL);

  return all_plugin_loader_modules[loader_id];
}

const int *
peas_utils_get_conflicting_loaders_from_id (int loader_id)
{
  g_return_val_if_fail (loader_id >= 0, NULL);
  g_return_val_if_fail (loader_id < PEAS_UTILS_N_LOADERS, NULL);

  return conflicting_plugin_loaders[loader_id];
}