summaryrefslogtreecommitdiffstats
path: root/plug-ins/help/gimphelpprogress.c
blob: dd4b224963e7822c2be2e420207919bfd99079ea (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
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
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
/* GIMP - The GNU Image Manipulation Program
 * Copyright (C) 1995 Spencer Kimball and Peter Mattis
 *
 * The GIMP Help plug-in
 * Copyright (C) 1999-2008 Sven Neumann <sven@gimp.org>
 *                         Michael Natterer <mitch@gimp.org>
 *                         Henrik Brix Andersen <brix@gimp.org>
 *
 * 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 3 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.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */

/*  This code is written so that it can also be compiled standalone.
 *  It shouldn't depend on libgimp.
 */

#include "config.h"

#include <string.h>

#include <gio/gio.h>

#include "gimphelptypes.h"
#include "gimphelpprogress.h"
#include "gimphelpprogress-private.h"


struct _GimpHelpProgress
{
  GimpHelpProgressVTable  vtable;
  gpointer                user_data;

  GCancellable           *cancellable;
};


GimpHelpProgress *
gimp_help_progress_new (const GimpHelpProgressVTable *vtable,
                        gpointer                      user_data)
{
  GimpHelpProgress *progress;

  g_return_val_if_fail (vtable != NULL, NULL);

  progress = g_slice_new0 (GimpHelpProgress);

  progress->vtable.start     = vtable->start;
  progress->vtable.end       = vtable->end;
  progress->vtable.set_value = vtable->set_value;

  progress->user_data        = user_data;

  return progress;
}

void
gimp_help_progress_free (GimpHelpProgress *progress)
{
  g_return_if_fail (progress != NULL);

  if (progress->cancellable)
    {
      g_object_unref (progress->cancellable);
      progress->cancellable = NULL;
    }

  g_slice_free (GimpHelpProgress, progress);
}

void
gimp_help_progress_cancel (GimpHelpProgress *progress)
{
  g_return_if_fail (progress != NULL);

  if (progress->cancellable)
    g_cancellable_cancel (progress->cancellable);
}


void
_gimp_help_progress_start (GimpHelpProgress *progress,
                           GCancellable     *cancellable,
                           const gchar      *format,
                           ...)
{
  gchar   *message;
  va_list  args;

  g_return_if_fail (progress != NULL);

  if (cancellable)
    g_object_ref (cancellable);

  if (progress->cancellable)
    g_object_unref (progress->cancellable);

  progress->cancellable = cancellable;

  va_start (args, format);
  message = g_strdup_vprintf (format, args);
  va_end (args);

  if (progress->vtable.start)
    progress->vtable.start (message, cancellable != NULL, progress->user_data);

  g_free (message);
}

void
_gimp_help_progress_update (GimpHelpProgress *progress,
                            gdouble           percentage)
{
  g_return_if_fail (progress != NULL);

  if (progress->vtable.set_value)
    progress->vtable.set_value (percentage, progress->user_data);
}

void
_gimp_help_progress_pulse (GimpHelpProgress *progress)
{
  g_return_if_fail (progress != NULL);

  _gimp_help_progress_update (progress, -1.0);
}

void
_gimp_help_progress_finish (GimpHelpProgress *progress)
{
  g_return_if_fail (progress != NULL);

  if (progress->vtable.end)
    progress->vtable.end (progress->user_data);

  if (progress->cancellable)
    {
      g_object_unref (progress->cancellable);
      progress->cancellable = NULL;
    }
}