help.c 9.82 KB
Newer Older
1
/* GIMP - The GNU Image Manipulation Program
2 3 4
 * Copyright (C) 1995 Spencer Kimball and Peter Mattis
 *
 * The GIMP Help plug-in
5
 * Copyright (C) 1999-2008 Sven Neumann <sven@gimp.org>
6 7 8
 *                         Michael Natterer <mitch@gimp.org>
 *                         Henrik Brix Andersen <brix@gimp.org>
 *
9
 * This program is free software: you can redistribute it and/or modify
10
 * it under the terms of the GNU General Public License as published by
11
 * the Free Software Foundation; either version 3 of the License, or
12 13 14 15 16 17 18 19
 * (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
20
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
21 22 23 24 25 26 27 28 29 30
 */

#include "config.h"

#include <string.h>  /*  strlen  */

#include <glib.h>

#include "libgimp/gimp.h"

31
#include "gimphelp.h"
32

Sven Neumann's avatar
Sven Neumann committed
33 34
#include "libgimp/stdplugins-intl.h"

35 36 37

/*  defines  */

38 39
#define GIMP_HELP_EXT_PROC        "extension-gimp-help"
#define GIMP_HELP_TEMP_EXT_PROC   "extension-gimp-help-temp"
40 41 42 43 44 45


typedef struct
{
  gchar *procedure;
  gchar *help_domain;
46
  gchar *help_locales;
47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68
  gchar *help_id;
} IdleHelp;


/*  forward declarations  */

static void     query             (void);
static void     run               (const gchar      *name,
                                   gint              nparams,
                                   const GimpParam  *param,
                                   gint             *nreturn_vals,
                                   GimpParam       **return_vals);

static void     temp_proc_install (void);
static void     temp_proc_run     (const gchar      *name,
                                   gint              nparams,
                                   const GimpParam  *param,
                                   gint             *nreturn_vals,
                                   GimpParam       **return_vals);

static void     load_help         (const gchar      *procedure,
                                   const gchar      *help_domain,
69
                                   const gchar      *help_locales,
70 71 72
                                   const gchar      *help_id);
static gboolean load_help_idle    (gpointer          data);

73 74
static GimpHelpProgress * load_help_progress_new (void);

75 76 77

/*  local variables  */

78 79
static GMainLoop *main_loop = NULL;

80
const GimpPlugInInfo PLUG_IN_INFO =
81 82 83 84 85 86 87 88 89 90 91 92 93
{
  NULL,  /* init_proc  */
  NULL,  /* quit_proc  */
  query, /* query_proc */
  run,   /* run_proc   */
};


MAIN ()

static void
query (void)
{
94
  static const GimpParamDef args[] =
95
  {
96 97 98 99
    { GIMP_PDB_INT32,       "num-domain-names", "" },
    { GIMP_PDB_STRINGARRAY, "domain-names",     "" },
    { GIMP_PDB_INT32,       "num-domain-uris",  "" },
    { GIMP_PDB_STRINGARRAY, "domain-uris",      "" }
100 101
  };

102
  gimp_install_procedure (GIMP_HELP_EXT_PROC,
103 104 105
                          "", /* FIXME */
                          "", /* FIXME */
                          "Sven Neumann <sven@gimp.org>, "
Jehan's avatar
Jehan committed
106
                          "Michael Natterer <mitch@gimp.org>, "
107 108
                          "Henrik Brix Andersen <brix@gimp.org>",
                          "Sven Neumann, Michael Natterer & Henrik Brix Andersen",
109
                          "1999-2008",
110 111 112 113 114 115 116 117 118 119 120 121 122 123
                          NULL,
                          "",
                          GIMP_EXTENSION,
                          G_N_ELEMENTS (args), 0,
                          args, NULL);
}

static void
run (const gchar      *name,
     gint              nparams,
     const GimpParam  *param,
     gint             *nreturn_vals,
     GimpParam       **return_vals)
{
124 125
  static GimpParam  values[1];
  GimpPDBStatusType status = GIMP_PDB_SUCCESS;
126

Sven Neumann's avatar
Sven Neumann committed
127 128
  INIT_I18N ();

129 130 131
  /*  make sure all the arguments are there  */
  if (nparams == 4)
    {
132 133 134 135
      if (! gimp_help_init (param[0].data.d_int32,
                            param[1].data.d_stringarray,
                            param[2].data.d_int32,
                            param[3].data.d_stringarray))
136 137 138 139 140 141 142 143 144 145 146 147 148
        {
          status = GIMP_PDB_CALLING_ERROR;
        }
    }
  else
    {
      g_printerr ("help: wrong number of arguments in procedure call.\n");

      status = GIMP_PDB_CALLING_ERROR;
    }

  if (status == GIMP_PDB_SUCCESS)
    {
149
      main_loop = g_main_loop_new (NULL, FALSE);
150 151 152 153 154 155

      temp_proc_install ();

      gimp_extension_ack ();
      gimp_extension_enable ();

156 157 158 159
      g_main_loop_run (main_loop);

      g_main_loop_unref (main_loop);
      main_loop = NULL;
Sven Neumann's avatar
Sven Neumann committed
160

161
      gimp_uninstall_temp_proc (GIMP_HELP_TEMP_EXT_PROC);
162 163 164 165 166 167 168 169 170 171 172 173
    }

  values[0].type          = GIMP_PDB_STATUS;
  values[0].data.d_status = status;

  *nreturn_vals = 1;
  *return_vals  = values;
}

static void
temp_proc_install (void)
{
174
  static const GimpParamDef args[] =
175
  {
176
    { GIMP_PDB_STRING, "procedure",    "The procedure of the browser to use" },
177 178 179
    { GIMP_PDB_STRING, "help-domain",  "Help domain to use" },
    { GIMP_PDB_STRING, "help-locales", "Language to use"    },
    { GIMP_PDB_STRING, "help-id",      "Help ID to open"    }
180 181
  };

182
  gimp_install_temp_proc (GIMP_HELP_TEMP_EXT_PROC,
183 184
                          "DON'T USE THIS ONE",
                          "(Temporary procedure)",
Jehan's avatar
Jehan committed
185 186
                          "Sven Neumann <sven@gimp.org>, "
                          "Michael Natterer <mitch@gimp.org>"
187
                          "Henrik Brix Andersen <brix@gimp.org",
Jehan's avatar
Jehan committed
188 189
                          "Sven Neumann, Michael Natterer & Henrik Brix Andersen",
                          "1999-2008",
190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205
                          NULL,
                          "",
                          GIMP_TEMPORARY,
                          G_N_ELEMENTS (args), 0,
                          args, NULL,
                          temp_proc_run);
}

static void
temp_proc_run (const gchar      *name,
               gint              nparams,
               const GimpParam  *param,
               gint             *nreturn_vals,
               GimpParam       **return_vals)
{
  static GimpParam   values[1];
206 207 208 209 210
  GimpPDBStatusType  status       = GIMP_PDB_SUCCESS;
  const gchar       *procedure    = NULL;
  const gchar       *help_domain  = GIMP_HELP_DEFAULT_DOMAIN;
  const gchar       *help_locales = NULL;
  const gchar       *help_id      = GIMP_HELP_DEFAULT_ID;
211 212 213 214 215 216 217 218 219 220 221 222 223 224

  *nreturn_vals = 1;
  *return_vals  = values;

  /*  make sure all the arguments are there  */
  if (nparams == 4)
    {
      if (param[0].data.d_string && strlen (param[0].data.d_string))
        procedure = param[0].data.d_string;

      if (param[1].data.d_string && strlen (param[1].data.d_string))
        help_domain = param[1].data.d_string;

      if (param[2].data.d_string && strlen (param[2].data.d_string))
225
        help_locales = param[2].data.d_string;
226 227 228 229 230

      if (param[3].data.d_string && strlen (param[3].data.d_string))
        help_id = param[3].data.d_string;
    }

231 232 233 234 235 236 237 238
  if (! procedure)
    status = GIMP_PDB_CALLING_ERROR;

  values[0].type          = GIMP_PDB_STATUS;
  values[0].data.d_status = status;

  if (status == GIMP_PDB_SUCCESS)
    load_help (procedure, help_domain, help_locales, help_id);
239 240 241 242 243
}

static void
load_help (const gchar *procedure,
           const gchar *help_domain,
244
           const gchar *help_locales,
245 246
           const gchar *help_id)
{
247
  IdleHelp *idle_help = g_slice_new (IdleHelp);
248

249 250 251 252
  idle_help->procedure    = g_strdup (procedure);
  idle_help->help_domain  = g_strdup (help_domain);
  idle_help->help_locales = g_strdup (help_locales);
  idle_help->help_id      = g_strdup (help_id);
253 254 255 256 257 258 259

  g_idle_add (load_help_idle, idle_help);
}

static gboolean
load_help_idle (gpointer data)
{
260 261
  IdleHelp       *idle_help = data;
  GimpHelpDomain *domain;
262

263
  domain = gimp_help_lookup_domain (idle_help->help_domain);
264 265 266

  if (domain)
    {
267
      GimpHelpProgress *progress = NULL;
268
      GList            *locales;
269
      gchar            *uri;
270
      gboolean          fatal_error;
271

272 273 274 275 276 277 278 279 280 281
      locales = gimp_help_parse_locales (idle_help->help_locales);

      if (! g_str_has_prefix (domain->help_uri, "file:"))
        progress = load_help_progress_new ();

      uri = gimp_help_domain_map (domain, locales, idle_help->help_id,
                                  progress, NULL, &fatal_error);

      if (progress)
        gimp_help_progress_free (progress);
282

283
      g_list_free_full (locales, (GDestroyNotify) g_free);
284

285
      if (uri)
286 287 288 289
        {
          GimpParam *return_vals;
          gint       n_return_vals;

290
#ifdef GIMP_HELP_DEBUG
291
          g_printerr ("help: calling '%s' for '%s'\n",
292
                      idle_help->procedure, uri);
293
#endif
294 295 296

          return_vals = gimp_run_procedure (idle_help->procedure,
                                            &n_return_vals,
297
                                            GIMP_PDB_STRING, uri,
298 299 300 301
                                            GIMP_PDB_END);

          gimp_destroy_params (return_vals, n_return_vals);

302
          g_free (uri);
303
        }
304 305 306 307
      else if (fatal_error)
        {
          g_main_loop_quit (main_loop);
        }
308 309 310 311
    }

  g_free (idle_help->procedure);
  g_free (idle_help->help_domain);
312
  g_free (idle_help->help_locales);
313
  g_free (idle_help->help_id);
314 315

  g_slice_free (IdleHelp, idle_help);
316 317 318

  return FALSE;
}
319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352

static void
load_help_progress_start (const gchar *message,
                          gboolean     cancelable,
                          gpointer     user_data)
{
  gimp_progress_init (message);
}

static void
load_help_progress_update (gdouble  value,
                           gpointer user_data)
{
  gimp_progress_update (value);
}

static void
load_help_progress_end (gpointer user_data)
{
  gimp_progress_end ();
}

static GimpHelpProgress *
load_help_progress_new (void)
{
  static const GimpHelpProgressVTable vtable =
  {
    load_help_progress_start,
    load_help_progress_end,
    load_help_progress_update
  };

  return gimp_help_progress_new (&vtable, NULL);
}