gimpdebug_pdb.c 3.29 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
/* LIBGIMP - The GIMP Library
 * Copyright (C) 1995-2003 Peter Mattis and Spencer Kimball
 *
 * gimpdebug_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
18
 * <https://www.gnu.org/licenses/>.
19 20 21 22 23 24 25 26 27 28
 */

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

#include "config.h"

#include "gimp.h"


/**
29
 * SECTION: gimpdebug
30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56
 * @title: gimpdebug
 * @short_description: Debug utility functions
 *
 * Miscellaneous debug utility functions. Not part of the stable
 * library interface.
 **/


/**
 * gimp_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
 * gimp_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 gimp_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
gimp_debug_timer_start (void)
{
57 58
  GimpValueArray *args;
  GimpValueArray *return_vals;
59 60
  gboolean success = TRUE;

61 62
  args = gimp_value_array_new_from_types (NULL,
                                          G_TYPE_NONE);
63

64 65 66
  return_vals = gimp_pdb_run_procedure_array (gimp_get_pdb (),
                                              "gimp-debug-timer-start",
                                              args);
67
  gimp_value_array_unref (args);
68

69
  success = GIMP_VALUES_GET_ENUM (return_vals, 0) == GIMP_PDB_SUCCESS;
70 71

  gimp_value_array_unref (return_vals);
72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94

  return success;
}

/**
 * gimp_debug_timer_end:
 *
 * Finishes measuring elapsed time.
 *
 * This procedure stops the timer started by a previous
 * gimp_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 gimp_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
gimp_debug_timer_end (void)
{
95 96
  GimpValueArray *args;
  GimpValueArray *return_vals;
97 98
  gdouble elapsed = 0.0;

99 100
  args = gimp_value_array_new_from_types (NULL,
                                          G_TYPE_NONE);
101

102 103 104
  return_vals = gimp_pdb_run_procedure_array (gimp_get_pdb (),
                                              "gimp-debug-timer-end",
                                              args);
105
  gimp_value_array_unref (args);
106

107
  if (GIMP_VALUES_GET_ENUM (return_vals, 0) == GIMP_PDB_SUCCESS)
108
    elapsed = GIMP_VALUES_GET_DOUBLE (return_vals, 1);
109

110
  gimp_value_array_unref (return_vals);
111 112 113

  return elapsed;
}