/* LIBPIKA - The PIKA Library
 * Copyright (C) 1995-2003 Peter Mattis and Spencer Kimball
 *
 * pikadebug_pdb.c
 *
 * 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 3 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
 * <https://www.gnu.org/licenses/>.
 */

/* NOTE: This file is auto-generated by pdbgen.pl */

#include "config.h"

#include "stamp-pdbgen.h"

#include "pika.h"


/**
 * SECTION: pikadebug
 * @title: pikadebug
 * @short_description: Debug utility functions
 *
 * Miscellaneous debug utility functions. Not part of the stable
 * library interface.
 **/


/**
 * pika_debug_timer_start:
 *
 * Starts measuring elapsed time.
 *
 * This procedure starts a timer, measuring the elapsed time since the
 * call. Each call to this procedure should be matched by a call to
 * pika_debug_timer_end(), which returns the elapsed time.
 * If there is already an active timer, it is not affected by the call,
 * however, a matching pika_debug_timer_end() call is still required.
 *
 * This is a debug utility procedure. It is subject to change at any
 * point, and should not be used in production.
 *
 * Returns: TRUE on success.
 **/
gboolean
pika_debug_timer_start (void)
{
  PikaValueArray *args;
  PikaValueArray *return_vals;
  gboolean success = TRUE;

  args = pika_value_array_new_from_types (NULL,
                                          G_TYPE_NONE);

  return_vals = _pika_pdb_run_procedure_array (pika_get_pdb (),
                                               "pika-debug-timer-start",
                                               args);
  pika_value_array_unref (args);

  success = PIKA_VALUES_GET_ENUM (return_vals, 0) == PIKA_PDB_SUCCESS;

  pika_value_array_unref (return_vals);

  return success;
}

/**
 * pika_debug_timer_end:
 *
 * Finishes measuring elapsed time.
 *
 * This procedure stops the timer started by a previous
 * pika_debug_timer_start() call, and prints and returns the elapsed
 * time.
 * If there was already an active timer at the time of corresponding
 * call to pika_debug_timer_start(), a dummy value is returned.
 *
 * This is a debug utility procedure. It is subject to change at any
 * point, and should not be used in production.
 *
 * Returns: The elapsed time, in seconds.
 **/
gdouble
pika_debug_timer_end (void)
{
  PikaValueArray *args;
  PikaValueArray *return_vals;
  gdouble elapsed = 0.0;

  args = pika_value_array_new_from_types (NULL,
                                          G_TYPE_NONE);

  return_vals = _pika_pdb_run_procedure_array (pika_get_pdb (),
                                               "pika-debug-timer-end",
                                               args);
  pika_value_array_unref (args);

  if (PIKA_VALUES_GET_ENUM (return_vals, 0) == PIKA_PDB_SUCCESS)
    elapsed = PIKA_VALUES_GET_DOUBLE (return_vals, 1);

  pika_value_array_unref (return_vals);

  return elapsed;
}