gimp/app/widgets/gimphelp.c

/* The GIMP -- an image manipulation program
 * Copyright (C) 1995 Spencer Kimball and Peter Mattis
 *
 * gimphelp.c
 * Copyright (C) 1999-2000 Michael Natterer <mitch@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 2 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, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 */

#include "config.h"

#ifdef HAVE_UNISTD_H
#include <unistd.h>
#endif
#include <string.h>
#include "sys/types.h"

#include <gtk/gtk.h>

#include "libgimpbase/gimpbase.h"
#include "libgimpwidgets/gimpwidgets.h"

#include "widgets-types.h"

#include "config/gimpguiconfig.h"

#include "core/gimp.h"

#include "pdb/procedural_db.h"

#include "plug-in/plug-ins.h"
#include "plug-in/plug-in-run.h"

#include "gimphelp.h"
#include "gimphelp-ids.h"

#include "gimp-intl.h"


#ifndef G_OS_WIN32
#define DEBUG_HELP
#endif

typedef struct _GimpIdleHelp GimpIdleHelp;

struct _GimpIdleHelp
{
  Gimp  *gimp;
  gchar *help_domain;
  gchar *help_locale;
  gchar *help_id;
};


/*  local function prototypes  */

static gint      gimp_idle_help       (gpointer     data);
static gboolean  gimp_help_internal   (Gimp        *gimp,
                                       const gchar *help_domain,
                                       const gchar *help_locale,
                                       const gchar *help_id);
static void      gimp_help_webbrowser (Gimp        *gimp,
                                       const gchar *help_domain,
                                       const gchar *help_locale,
                                       const gchar *help_id);


/*  public functions  */

void
gimp_help (Gimp        *gimp,
           const gchar *help_domain,
	   const gchar *help_id)
{
  g_return_if_fail (GIMP_IS_GIMP (gimp));

  if (GIMP_GUI_CONFIG (gimp->config)->use_help)
    {
      GimpIdleHelp *idle_help;

      idle_help = g_new0 (GimpIdleHelp, 1);

      idle_help->gimp = gimp;

      if (help_domain && strlen (help_domain))
	idle_help->help_domain = g_strdup (help_domain);

      idle_help->help_locale = g_strdup ("C");

      if (help_id && strlen (help_id))
	idle_help->help_id = g_strdup (help_id);

      g_idle_add (gimp_idle_help, idle_help);
    }
}


/*  private functions  */

static gboolean
gimp_idle_help (gpointer data)
{
  GimpIdleHelp        *idle_help;
  GimpHelpBrowserType  browser;

  idle_help = (GimpIdleHelp *) data;

  browser = GIMP_GUI_CONFIG (idle_help->gimp->config)->help_browser;

#ifdef DEBUG_HELP
  if (idle_help->help_domain)
    g_print ("Help Domain: %s\n", idle_help->help_domain);
  else
    g_print ("Help Domain: NULL\n");

  if (idle_help->help_id)
    g_print ("Help ID: %s\n", idle_help->help_id);
  else
    g_print ("Help ID: NULL\n");

  g_print ("\n");
#endif  /*  DEBUG_HELP  */

  switch (browser)
    {
    case GIMP_HELP_BROWSER_GIMP:
      if (gimp_help_internal (idle_help->gimp,
                              idle_help->help_domain,
			      idle_help->help_locale,
			      idle_help->help_id))
	break;

    case GIMP_HELP_BROWSER_WEBBROWSER:
      gimp_help_webbrowser (idle_help->gimp,
                            idle_help->help_domain,
                            idle_help->help_locale,
                            idle_help->help_id);
      break;

    default:
      break;
    }

  g_free (idle_help->help_domain);
  g_free (idle_help->help_locale);
  g_free (idle_help->help_id);
  g_free (idle_help);

  return FALSE;
}

static void
gimp_help_internal_not_found_callback (GtkWidget *widget,
				       gboolean   use_webbrowser,
				       gpointer   data)
{
  Gimp *gimp = GIMP (data);

  if (use_webbrowser)
    g_object_set (gimp->config,
		  "help-browser", GIMP_HELP_BROWSER_WEBBROWSER,
		  NULL);

  gtk_main_quit ();
}

static gboolean
gimp_help_internal (Gimp        *gimp,
                    const gchar *help_domain,
		    const gchar *help_locale,
		    const gchar *help_id)
{
  ProcRecord *proc_rec;

  static gboolean busy = FALSE;

  if (busy)
    return TRUE;

  busy = TRUE;

  /*  Check if a help browser is already running  */
  proc_rec = procedural_db_lookup (gimp, "extension_gimp_help_browser_temp");

  if (proc_rec == NULL)
    {
      Argument  *args         = NULL;
      gint       n_domains    = 0;
      gchar    **help_domains = NULL;
      gchar    **help_uris    = NULL;

      proc_rec = procedural_db_lookup (gimp, "extension_gimp_help_browser");

      if (proc_rec == NULL)
	{
	  GtkWidget *not_found =
	    gimp_query_boolean_box (_("Could not find GIMP Help Browser"),
				    NULL, NULL, NULL, FALSE,
				    _("Could not find the GIMP Help Browser procedure.\n"
				      "It probably was not compiled because\n"
				      "you don't have GtkXmHTML installed."),
				    _("Use web browser instead"),
				    GTK_STOCK_CANCEL,
				    NULL, NULL,
				    gimp_help_internal_not_found_callback,
				    gimp);
	  gtk_widget_show (not_found);
	  gtk_main ();

          busy = FALSE;

	  return (GIMP_GUI_CONFIG (gimp->config)->help_browser
		  != GIMP_HELP_BROWSER_WEBBROWSER);
	}

      n_domains = plug_ins_help_domains (gimp, &help_domains, &help_uris);

      args = g_new (Argument, 5);
      args[0].arg_type          = GIMP_PDB_INT32;
      args[0].value.pdb_int     = GIMP_RUN_INTERACTIVE;
      args[1].arg_type          = GIMP_PDB_INT32;
      args[1].value.pdb_int     = n_domains;
      args[2].arg_type          = GIMP_PDB_STRINGARRAY;
      args[2].value.pdb_pointer = help_domains;
      args[3].arg_type          = GIMP_PDB_INT32;
      args[3].value.pdb_int     = n_domains;
      args[4].arg_type          = GIMP_PDB_STRINGARRAY;
      args[4].value.pdb_pointer = help_uris;

      plug_in_run (gimp, proc_rec, args, 5, FALSE, TRUE, -1);

      procedural_db_destroy_args (args, 5);
    }

  /*  Check if the help browser started properly  */
  proc_rec = procedural_db_lookup (gimp, "extension_gimp_help_browser_temp");

  if (proc_rec == NULL)
    {
      GtkWidget *not_found =
        gimp_query_boolean_box (_("Could not start GIMP Help Browser"),
                                NULL, NULL, NULL, FALSE,
                                _("Could not start the GIMP Help Browser."),
                                _("Use web browser instead"),
                                GTK_STOCK_CANCEL,
                                NULL, NULL,
                                gimp_help_internal_not_found_callback,
                                gimp);
      gtk_widget_show (not_found);
      gtk_main ();

      busy = FALSE;

      return (GIMP_GUI_CONFIG (gimp->config)->help_browser
              != GIMP_HELP_BROWSER_WEBBROWSER);
    }
  else
    {
      Argument *return_vals;
      gint      nreturn_vals;

      return_vals =
        procedural_db_run_proc (gimp,
				"extension_gimp_help_browser_temp",
                                &nreturn_vals,
				GIMP_PDB_STRING, help_domain,
				GIMP_PDB_STRING, help_locale,
                                GIMP_PDB_STRING, help_id,
                                GIMP_PDB_END);

      procedural_db_destroy_args (return_vals, nreturn_vals);
    }

  busy = FALSE;

  return TRUE;
}

static void
gimp_help_webbrowser (Gimp        *gimp,
                      const gchar *help_domain,
                      const gchar *help_locale,
                      const gchar *help_id)
{
  Argument *return_vals;
  gint      nreturn_vals;
  gchar    *url;

  if (! help_id)
    help_id = GIMP_HELP_MAIN;

  if (! help_domain)
    {
      url = g_strconcat ("file:",
                         gimp_data_directory (), "/help/",
                         help_locale, "/",
                         help_id,
                         NULL);
    }
  else
    {
      url = g_strconcat ("file:",
                         help_domain, "/",
                         help_locale, "/",
                         help_id,
                         NULL);
    }

  return_vals =
    procedural_db_run_proc (gimp,
			    "plug_in_web_browser",
			    &nreturn_vals,
			    GIMP_PDB_STRING, url,
			    GIMP_PDB_END);

  procedural_db_destroy_args (return_vals, nreturn_vals);

  g_free (url);
}