/* GDBus - GLib D-Bus Library

 *

 * Copyright (C) 2008-2010 Red Hat, Inc.

 *

 * 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.1 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, see <http://www.gnu.org/licenses/>.

 *

 * Author: David Zeuthen <davidz@redhat.com>

 */

#include "config.h"

#include <stdlib.h>

#include <string.h>

#include "gdbusintrospection.h"

#include "glibintl.h"

/**

 * SECTION:gdbusintrospection

 * @title: D-Bus Introspection Data

 * @short_description: Node and interface description data structures

 * @include: gio/gio.h

 *

 * Various data structures and convenience routines to parse and

 * generate D-Bus introspection XML. Introspection information is

 * used when registering objects with g_dbus_connection_register_object().

 *

 * The format of D-Bus introspection XML is specified in the

 * [D-Bus specification](http://dbus.freedesktop.org/doc/dbus-specification.html#introspection-format)

 */

/* ---------------------------------------------------------------------------------------------------- */

#define _MY_DEFINE_BOXED_TYPE(TypeName, type_name) \

  G_DEFINE_BOXED_TYPE (TypeName, type_name, type_name##_ref, type_name##_unref)

_MY_DEFINE_BOXED_TYPE (GDBusNodeInfo,       g_dbus_node_info)

_MY_DEFINE_BOXED_TYPE (GDBusInterfaceInfo,  g_dbus_interface_info)

_MY_DEFINE_BOXED_TYPE (GDBusMethodInfo,     g_dbus_method_info)

_MY_DEFINE_BOXED_TYPE (GDBusSignalInfo,     g_dbus_signal_info)

_MY_DEFINE_BOXED_TYPE (GDBusPropertyInfo,   g_dbus_property_info)

_MY_DEFINE_BOXED_TYPE (GDBusArgInfo,        g_dbus_arg_info)

_MY_DEFINE_BOXED_TYPE (GDBusAnnotationInfo, g_dbus_annotation_info)

#undef _MY_DEFINE_BOXED_TYPE

/* ---------------------------------------------------------------------------------------------------- */

typedef struct

{

  /* stuff we are currently collecting */

  GPtrArray *args;

  GPtrArray *out_args;

  GPtrArray *methods;

  GPtrArray *signals;

  GPtrArray *properties;

  GPtrArray *interfaces;

  GPtrArray *nodes;

  GPtrArray *annotations;

  /* A list of GPtrArray's containing annotations */

  GSList *annotations_stack;

  /* A list of GPtrArray's containing interfaces */

  GSList *interfaces_stack;

  /* A list of GPtrArray's containing nodes */

  GSList *nodes_stack;

  /* Whether the direction was "in" for last parsed arg */

  gboolean last_arg_was_in;

  /* Number of args currently being collected; used for assigning

   * names to args without a "name" attribute

   */

  guint num_args;

} ParseData;

/* ---------------------------------------------------------------------------------------------------- */

/**

 * g_dbus_node_info_ref:

 * @info: A #GDBusNodeInfo

 *

 * If @info is statically allocated does nothing. Otherwise increases

 * the reference count.

 *

 * Returns: The same @info.

 *

 * Since: 2.26

 */

GDBusNodeInfo *

g_dbus_node_info_ref (GDBusNodeInfo *info)

{

  if (info->ref_count == -1)

    return info;

  g_atomic_int_inc (&info->ref_count);

  return info;

}

/**

 * g_dbus_interface_info_ref:

 * @info: A #GDBusInterfaceInfo

 *

 * If @info is statically allocated does nothing. Otherwise increases

 * the reference count.

 *

 * Returns: The same @info.

 *

 * Since: 2.26

 */

GDBusInterfaceInfo *

g_dbus_interface_info_ref (GDBusInterfaceInfo *info)

{

  if (info->ref_count == -1)

    return info;

  g_atomic_int_inc (&info->ref_count);

  return info;

}

/**

 * g_dbus_method_info_ref:

 * @info: A #GDBusMethodInfo

 *

 * If @info is statically allocated does nothing. Otherwise increases

 * the reference count.

 *

 * Returns: The same @info.

 *

 * Since: 2.26

 */

GDBusMethodInfo *

g_dbus_method_info_ref (GDBusMethodInfo *info)

{

  if (info->ref_count == -1)

    return info;

  g_atomic_int_inc (&info->ref_count);

  return info;

}

/**

 * g_dbus_signal_info_ref:

 * @info: A #GDBusSignalInfo

 *

 * If @info is statically allocated does nothing. Otherwise increases

 * the reference count.

 *

 * Returns: The same @info.

 *

 * Since: 2.26

 */

GDBusSignalInfo *

g_dbus_signal_info_ref (GDBusSignalInfo *info)

{

  if (info->ref_count == -1)

    return info;

  g_atomic_int_inc (&info->ref_count);

  return info;

}

/**

 * g_dbus_property_info_ref:

 * @info: A #GDBusPropertyInfo

 *

 * If @info is statically allocated does nothing. Otherwise increases

 * the reference count.

 *

 * Returns: The same @info.

 *

 * Since: 2.26

 */

GDBusPropertyInfo *

g_dbus_property_info_ref (GDBusPropertyInfo *info)

{

  if (info->ref_count == -1)

    return info;

  g_atomic_int_inc (&info->ref_count);

  return info;

}

/**

 * g_dbus_arg_info_ref:

 * @info: A #GDBusArgInfo

 *

 * If @info is statically allocated does nothing. Otherwise increases

 * the reference count.

 *

 * Returns: The same @info.

 *

 * Since: 2.26

 */

GDBusArgInfo *

g_dbus_arg_info_ref (GDBusArgInfo *info)

{

  if (info->ref_count == -1)

    return info;

  g_atomic_int_inc (&info->ref_count);

  return info;

}

/**

 * g_dbus_annotation_info_ref:

 * @info: A #GDBusNodeInfo

 *

 * If @info is statically allocated does nothing. Otherwise increases

 * the reference count.

 *

 * Returns: The same @info.

 *

 * Since: 2.26

 */

GDBusAnnotationInfo *

g_dbus_annotation_info_ref (GDBusAnnotationInfo *info)

{

  if (info->ref_count == -1)

    return info;

  g_atomic_int_inc (&info->ref_count);

  return info;

}

/* ---------------------------------------------------------------------------------------------------- */

static void

free_null_terminated_array (gpointer array, GDestroyNotify unref_func)

{

  guint n;

  gpointer *p = array;

  if (p == NULL)

    return;

  for (n = 0; p[n] != NULL; n++)

    unref_func (p[n]);

  g_free (p);

}

/**

 * g_dbus_annotation_info_unref:

 * @info: A #GDBusAnnotationInfo.

 *

 * If @info is statically allocated, does nothing. Otherwise decreases

 * the reference count of @info. When its reference count drops to 0,

 * the memory used is freed.

 *

 * Since: 2.26

 */

void

g_dbus_annotation_info_unref (GDBusAnnotationInfo *info)

{

  if (info->ref_count == -1)

    return;

  if (g_atomic_int_dec_and_test (&info->ref_count))

    {

      g_free (info->key);

      g_free (info->value);

      free_null_terminated_array (info->annotations, (GDestroyNotify) g_dbus_annotation_info_unref);

      g_free (info);

    }

}

/**

 * g_dbus_arg_info_unref:

 * @info: A #GDBusArgInfo.

 *

 * If @info is statically allocated, does nothing. Otherwise decreases

 * the reference count of @info. When its reference count drops to 0,

 * the memory used is freed.

 *

 * Since: 2.26

 */

void

g_dbus_arg_info_unref (GDBusArgInfo *info)

{

  if (info->ref_count == -1)

    return;

  if (g_atomic_int_dec_and_test (&info->ref_count))

    {

      g_free (info->name);

      g_free (info->signature);

      free_null_terminated_array (info->annotations, (GDestroyNotify) g_dbus_annotation_info_unref);

      g_free (info);

    }

}

/**

 * g_dbus_method_info_unref:

 * @info: A #GDBusMethodInfo.

 *

 * If @info is statically allocated, does nothing. Otherwise decreases

 * the reference count of @info. When its reference count drops to 0,

 * the memory used is freed.

 *

 * Since: 2.26

 */

void

g_dbus_method_info_unref (GDBusMethodInfo *info)

{

  if (info->ref_count == -1)

    return;

  if (g_atomic_int_dec_and_test (&info->ref_count))

    {

      g_free (info->name);

      free_null_terminated_array (info->in_args, (GDestroyNotify) g_dbus_arg_info_unref);

      free_null_terminated_array (info->out_args, (GDestroyNotify) g_dbus_arg_info_unref);

      free_null_terminated_array (info->annotations, (GDestroyNotify) g_dbus_annotation_info_unref);

      g_free (info);

    }

}

/**

 * g_dbus_signal_info_unref:

 * @info: A #GDBusSignalInfo.

 *

 * If @info is statically allocated, does nothing. Otherwise decreases

 * the reference count of @info. When its reference count drops to 0,

 * the memory used is freed.

 *

 * Since: 2.26

 */

void

g_dbus_signal_info_unref (GDBusSignalInfo *info)

{

  if (info->ref_count == -1)

    return;

  if (g_atomic_int_dec_and_test (&info->ref_count))

    {

      g_free (info->name);

      free_null_terminated_array (info->args, (GDestroyNotify) g_dbus_arg_info_unref);

      free_null_terminated_array (info->annotations, (GDestroyNotify) g_dbus_annotation_info_unref);

      g_free (info);

    }

}

/**

 * g_dbus_property_info_unref:

 * @info: A #GDBusPropertyInfo.

 *

 * If @info is statically allocated, does nothing. Otherwise decreases

 * the reference count of @info. When its reference count drops to 0,

 * the memory used is freed.

 *

 * Since: 2.26

 */

void

g_dbus_property_info_unref (GDBusPropertyInfo *info)

{

  if (info->ref_count == -1)

    return;

  if (g_atomic_int_dec_and_test (&info->ref_count))

    {

      g_free (info->name);

      g_free (info->signature);

      free_null_terminated_array (info->annotations, (GDestroyNotify) g_dbus_annotation_info_unref);

      g_free (info);

    }

}

/**

 * g_dbus_interface_info_unref:

 * @info: A #GDBusInterfaceInfo.

 *

 * If @info is statically allocated, does nothing. Otherwise decreases

 * the reference count of @info. When its reference count drops to 0,

 * the memory used is freed.

 *

 * Since: 2.26

 */

void

g_dbus_interface_info_unref (GDBusInterfaceInfo *info)

{

  if (info->ref_count == -1)

    return;

  if (g_atomic_int_dec_and_test (&info->ref_count))

    {

      g_free (info->name);

      free_null_terminated_array (info->methods, (GDestroyNotify) g_dbus_method_info_unref);

      free_null_terminated_array (info->signals, (GDestroyNotify) g_dbus_signal_info_unref);

      free_null_terminated_array (info->properties, (GDestroyNotify) g_dbus_property_info_unref);

      free_null_terminated_array (info->annotations, (GDestroyNotify) g_dbus_annotation_info_unref);

      g_free (info);

    }

}

/**

 * g_dbus_node_info_unref:

 * @info: A #GDBusNodeInfo.

 *

 * If @info is statically allocated, does nothing. Otherwise decreases

 * the reference count of @info. When its reference count drops to 0,

 * the memory used is freed.

 *

 * Since: 2.26

 */

void

g_dbus_node_info_unref (GDBusNodeInfo *info)

{

  if (info->ref_count == -1)

    return;

  if (g_atomic_int_dec_and_test (&info->ref_count))

    {

      g_free (info->path);

      free_null_terminated_array (info->interfaces, (GDestroyNotify) g_dbus_interface_info_unref);

      free_null_terminated_array (info->nodes, (GDestroyNotify) g_dbus_node_info_unref);

      free_null_terminated_array (info->annotations, (GDestroyNotify) g_dbus_annotation_info_unref);

      g_free (info);

    }

}

/* ---------------------------------------------------------------------------------------------------- */

static void

g_dbus_annotation_info_set (ParseData            *data,

                            GDBusAnnotationInfo  *info,

                            const gchar          *key,

                            const gchar          *value,

                            GDBusAnnotationInfo **embedded_annotations)

{

  info->ref_count = 1;

  if (key != NULL)

    info->key = g_strdup (key);

  if (value != NULL)

    info->value = g_strdup (value);

  if (embedded_annotations != NULL)

    info->annotations = embedded_annotations;

}

static void

g_dbus_arg_info_set (ParseData            *data,

                     GDBusArgInfo         *info,

                     const gchar          *name,

                     const gchar          *signature,

                     GDBusAnnotationInfo **annotations)

{

  info->ref_count = 1;

  /* name may be NULL - TODO: compute name? */

  if (name != NULL)

    info->name = g_strdup (name);

  if (signature != NULL)

    info->signature = g_strdup (signature);

  if (annotations != NULL)

    info->annotations = annotations;

}

static void

g_dbus_method_info_set (ParseData            *data,

                        GDBusMethodInfo      *info,

                        const gchar          *name,

                        GDBusArgInfo        **in_args,

                        GDBusArgInfo        **out_args,

                        GDBusAnnotationInfo **annotations)

{

  info->ref_count = 1;

  if (name != NULL)

    info->name = g_strdup (name);

  if (in_args != NULL)

    info->in_args = in_args;

  if (out_args != NULL)

    info->out_args = out_args;

  if (annotations != NULL)

    info->annotations = annotations;

}

static void

g_dbus_signal_info_set (ParseData            *data,

                        GDBusSignalInfo      *info,

                        const gchar          *name,

                        GDBusArgInfo        **args,

                        GDBusAnnotationInfo **annotations)

{

  info->ref_count = 1;

  if (name != NULL)

    info->name = g_strdup (name);

  if (args != NULL)

    info->args = args;

  if (annotations != NULL)

    info->annotations = annotations;

}

static void

g_dbus_property_info_set (ParseData               *data,

                          GDBusPropertyInfo       *info,

                          const gchar             *name,

                          const gchar             *signature,

                          GDBusPropertyInfoFlags   flags,

                          GDBusAnnotationInfo    **annotations)

{

  info->ref_count = 1;

  if (name != NULL)

    info->name = g_strdup (name);

  if (flags != G_DBUS_PROPERTY_INFO_FLAGS_NONE)

    info->flags = flags;

  if (signature != NULL)

    info->signature = g_strdup (signature);

  if (annotations != NULL)

    info->annotations = annotations;

}

static void

g_dbus_interface_info_set (ParseData            *data,

                           GDBusInterfaceInfo   *info,

                           const gchar          *name,

                           GDBusMethodInfo     **methods,

                           GDBusSignalInfo     **signals,

                           GDBusPropertyInfo   **properties,

                           GDBusAnnotationInfo **annotations)

{

  info->ref_count = 1;

  if (name != NULL)

    info->name = g_strdup (name);

  if (methods != NULL)

    info->methods = methods;

  if (signals != NULL)

    info->signals = signals;

  if (properties != NULL)

    info->properties = properties;

  if (annotations != NULL)

    info->annotations = annotations;

}

static void

g_dbus_node_info_set (ParseData            *data,

                      GDBusNodeInfo        *info,

                      const gchar          *path,

                      GDBusInterfaceInfo  **interfaces,

                      GDBusNodeInfo       **nodes,

                      GDBusAnnotationInfo **annotations)

{

  info->ref_count = 1;

  if (path != NULL)

    {

      info->path = g_strdup (path);

      /* TODO: relative / absolute path snafu */

    }

  if (interfaces != NULL)

    info->interfaces = interfaces;

  if (nodes != NULL)

    info->nodes = nodes;

  if (annotations != NULL)

    info->annotations = annotations;

}

/* ---------------------------------------------------------------------------------------------------- */

static void

g_dbus_annotation_info_generate_xml (GDBusAnnotationInfo *info,

                                     guint                indent,

                                     GString             *string_builder)

{

  gchar *tmp;

  guint n;

  tmp = g_markup_printf_escaped ("%*s

                                 indent, "",

                                 info->key,

                                 info->value);

  g_string_append (string_builder, tmp);

  g_free (tmp);

  if (info->annotations == NULL)

    {

      g_string_append (string_builder, "/>\n");

    }

  else

    {

      g_string_append (string_builder, ">\n");

      for (n = 0; info->annotations != NULL && info->annotations[n] != NULL; n++)

        g_dbus_annotation_info_generate_xml (info->annotations[n],

                                             indent + 2,

                                             string_builder);

      g_string_append_printf (string_builder, "%*s</annotation>\n",

                              indent, "");

    }

}

static void

g_dbus_arg_info_generate_xml (GDBusArgInfo *info,

                              guint         indent,

                              const gchar  *extra_attributes,

                              GString      *string_builder)

{

  guint n;

  g_string_append_printf (string_builder, "%*s

                          indent, "",

                          info->signature);

  if (info->name != NULL)

    g_string_append_printf (string_builder, " name=\"%s\"", info->name);

  if (extra_attributes != NULL)

    g_string_append_printf (string_builder, " %s", extra_attributes);

  if (info->annotations == NULL)

    {

      g_string_append (string_builder, "/>\n");

    }

  else

    {

      g_string_append (string_builder, ">\n");

      for (n = 0; info->annotations != NULL && info->annotations[n] != NULL; n++)

        g_dbus_annotation_info_generate_xml (info->annotations[n],

                                             indent + 2,

                                             string_builder);

      g_string_append_printf (string_builder, "%*s</arg>\n", indent, "");

    }

}

static void

g_dbus_method_info_generate_xml (GDBusMethodInfo *info,

                                 guint            indent,

                                 GString         *string_builder)

{

  guint n;

  g_string_append_printf (string_builder, "%*s

                          indent, "",

                          info->name);

  if (info->annotations == NULL && info->in_args == NULL && info->out_args == NULL)

    {

      g_string_append (string_builder, "/>\n");

    }

  else

    {

      g_string_append (string_builder, ">\n");

      for (n = 0; info->annotations != NULL && info->annotations[n] != NULL; n++)

        g_dbus_annotation_info_generate_xml (info->annotations[n],

                                             indent + 2,

                                             string_builder);

      for (n = 0; info->in_args != NULL && info->in_args[n] != NULL; n++)

        g_dbus_arg_info_generate_xml (info->in_args[n],

                                      indent + 2,

                                      "direction=\"in\"",

                                      string_builder);

      for (n = 0; info->out_args != NULL && info->out_args[n] != NULL; n++)

        g_dbus_arg_info_generate_xml (info->out_args[n],

                                      indent + 2,

                                      "direction=\"out\"",

                                      string_builder);

      g_string_append_printf (string_builder, "%*s</method>\n", indent, "");

    }

}

static void

g_dbus_signal_info_generate_xml (GDBusSignalInfo *info,

                                 guint            indent,

                                 GString         *string_builder)

{

  guint n;

  g_string_append_printf (string_builder, "%*s

                          indent, "",

                          info->name);

  if (info->annotations == NULL && info->args == NULL)

    {

      g_string_append (string_builder, "/>\n");

    }

  else

    {

      g_string_append (string_builder, ">\n");

      for (n = 0; info->annotations != NULL && info->annotations[n] != NULL; n++)

        g_dbus_annotation_info_generate_xml (info->annotations[n],

                                             indent + 2,

                                             string_builder);

      for (n = 0; info->args != NULL && info->args[n] != NULL; n++)

        g_dbus_arg_info_generate_xml (info->args[n],

                                      indent + 2,

                                      NULL,

                                      string_builder);

      g_string_append_printf (string_builder, "%*s</signal>\n", indent, "");

    }

}

static void

g_dbus_property_info_generate_xml (GDBusPropertyInfo *info,

                                   guint              indent,

                                   GString           *string_builder)

{

  guint n;

  const gchar *access_string;

  if ((info->flags & G_DBUS_PROPERTY_INFO_FLAGS_READABLE) &&

      (info->flags & G_DBUS_PROPERTY_INFO_FLAGS_WRITABLE))

    {

      access_string = "readwrite";

    }

  else if (info->flags & G_DBUS_PROPERTY_INFO_FLAGS_READABLE)

    {

      access_string = "read";

    }

  else if (info->flags & G_DBUS_PROPERTY_INFO_FLAGS_WRITABLE)

    {

      access_string = "write";

    }

  else

    {

      g_assert_not_reached ();

    }

  g_string_append_printf (string_builder, "%*s

                          indent, "",

                          info->signature,

                          info->name,

                          access_string);

  if (info->annotations == NULL)

    {

      g_string_append (string_builder, "/>\n");

    }

  else

    {

      g_string_append (string_builder, ">\n");

      for (n = 0; info->annotations != NULL && info->annotations[n] != NULL; n++)

        g_dbus_annotation_info_generate_xml (info->annotations[n],

                                               indent + 2,

                                               string_builder);

      g_string_append_printf (string_builder, "%*s</property>\n", indent, "");

    }

}

/**

 * g_dbus_interface_info_generate_xml:

 * @info: A #GDBusNodeInfo

 * @indent: Indentation level.

 * @string_builder: A #GString to to append XML data to.

 *

 * Appends an XML representation of @info (and its children) to @string_builder.

 *

 * This function is typically used for generating introspection XML

 * documents at run-time for handling the

 * `org.freedesktop.DBus.Introspectable.Introspect`

 * method.

 *

 * Since: 2.26

 */

void

g_dbus_interface_info_generate_xml (GDBusInterfaceInfo *info,

                                    guint               indent,

                                    GString            *string_builder)

{

  guint n;

  g_string_append_printf (string_builder, "%*s<interface name=\"%s\">\n",

                          indent, "",

                          info->name);

  for (n = 0; info->annotations != NULL && info->annotations[n] != NULL; n++)

    g_dbus_annotation_info_generate_xml (info->annotations[n],

                                         indent + 2,

                                         string_builder);

  for (n = 0; info->methods != NULL && info->methods[n] != NULL; n++)

    g_dbus_method_info_generate_xml (info->methods[n],

                                     indent + 2,

                                     string_builder);

  for (n = 0; info->signals != NULL && info->signals[n] != NULL; n++)

    g_dbus_signal_info_generate_xml (info->signals[n],

                                     indent + 2,

                                     string_builder);

  for (n = 0; info->properties != NULL && info->properties[n] != NULL; n++)

    g_dbus_property_info_generate_xml (info->properties[n],

                                       indent + 2,

                                       string_builder);

  g_string_append_printf (string_builder, "%*s</interface>\n", indent, "");

}

/**

 * g_dbus_node_info_generate_xml:

 * @info: A #GDBusNodeInfo.

 * @indent: Indentation level.

 * @string_builder: A #GString to to append XML data to.

 *

 * Appends an XML representation of @info (and its children) to @string_builder.

 *

 * This function is typically used for generating introspection XML documents at run-time for

 * handling the `org.freedesktop.DBus.Introspectable.Introspect`  method.

 *

 * Since: 2.26

 */

void

g_dbus_node_info_generate_xml (GDBusNodeInfo *info,

                               guint          indent,

                               GString       *string_builder)

{

  guint n;

  g_string_append_printf (string_builder, "%*s

  if (info->path != NULL)

    g_string_append_printf (string_builder, " name=\"%s\"", info->path);

  if (info->interfaces == NULL && info->nodes == NULL && info->annotations == NULL)

    {

      g_string_append (string_builder, "/>\n");

    }

  else

    {

      g_string_append (string_builder, ">\n");

      for (n = 0; info->annotations != NULL && info->annotations[n] != NULL; n++)

        g_dbus_annotation_info_generate_xml (info->annotations[n],

                                             indent + 2,

                                             string_builder);

      for (n = 0; info->interfaces != NULL && info->interfaces[n] != NULL; n++)

        g_dbus_interface_info_generate_xml (info->interfaces[n],

                                            indent + 2,

                                            string_builder);

      for (n = 0; info->nodes != NULL && info->nodes[n] != NULL; n++)

        g_dbus_node_info_generate_xml (info->nodes[n],

                                       indent + 2,

                                       string_builder);

      g_string_append_printf (string_builder, "%*s</node>\n", indent, "");

    }

}

/* ---------------------------------------------------------------------------------------------------- */

static GDBusAnnotationInfo **

parse_data_steal_annotations (ParseData *data,

                              guint     *out_num_elements)

{