/**
 * status.c
 *   A very basic GIMP plugin that provides a function (not accessible
 *   through a menu item) that reports various statuses.
 *
 *   Copyright (c) 2013 Samuel A. Rebelsky.  All rights reserved.
 *
 *   This file is part of The Glimmer Guide to GIMP Plugins (aka GGGP).
 *
 *   GGGP 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.
 *
 *   GGGP 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 GGGP.  If not, see <http://www.gnu.org/licenses/>.
 */


// +---------+---------------------------------------------------------
// | Headers |
// +---------+

#include <libgimp/gimp.h>

#include <stdio.h>


// +--------+----------------------------------------------------------
// | Macros |
// +--------+

/**
 * Print a string (somewhere).  Right now, this prints to stderr, which
 * means it only works when the program is run from the terminal.
 */
#define REPORT(str) fprintf (stderr, "*** %s ***\n", str)

/**
 * Print an integer.
 */
#define REPORT_INT(i) fprintf (stderr, "*** %s: %d ***\n", #i, i)

/**
 * Print a string.
 */
#define REPORT_STRING(s) fprintf (stderr, "*** %s: %s ***\n", #s, s)



// +--------------------------+----------------------------------------
// | Function Predeclarations |
// +--------------------------+

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


// +-------------+-----------------------------------------------------
// | Boilerplate |
// +-------------+

/**
 * The four key functions.  This structure *must* be called PLUG_IN_INFO.
 */
GimpPlugInInfo PLUG_IN_INFO =
  {
    NULL,
    NULL,
    query,
    run
  };

/**
 * Indicate that we're ready to begin the main part of the code.
 */
MAIN ()


// +-------------------------+-----------------------------------------
// | Standard GIMP Functions |
// +-------------------------+

static void
init (void)
{
} // init

static void
quit (void)
{
} // quit

static void 
query (void)
{
  // Build the description of the parameters that the function expects.  
  // Each parameter has a type, a name, and a description
  // All plug-ins must take a run-mode.   Plug-ins associated with an
  // image
  static GimpParamDef args[] =
    {
      { GIMP_PDB_STRING, "status", "'success', 'execution', 'calling', 'pass', or 'cancel'" }
    }; // args

  // Tell the GIMP about our plugin.
  gimp_install_procedure (
    "gggp/status",                                      // Name
    "Report executation status",                        // Blurb
    "Reports one of the valid executation statuses",    // Help
    "Samuel A. Rebelsky",                               // Author
    "Copyright (c) Samuel A. Rebelsky.  All rights reserved.",
                                                        // Copyright
    "2013",                                             // Year
    "",                                                 // Path
    NULL,                                               // Image types
    GIMP_PLUGIN,                                        // Type
    1,                                                  // Number of params
    0,                                                  // Number of return vals
    args,                                               // Param descriptions
    NULL                                                // Return descriptions
    );

} // query

static void
run (const gchar      *name,
           gint              nparams,
           const GimpParam  *params,
           gint             *nreturn_vals,
           GimpParam       **return_vals)
{
  // Prepare return values
  static GimpParam results[1];
  results[0].type = GIMP_PDB_STATUS;
  *nreturn_vals = 1;
  *return_vals = results;

  gchar *msg = params[1].data.d_string;
  REPORT_STRING (msg);
  
  // To do: Rewrite the following with a structure and a loop.
  if (g_strcmp0 (msg, "success") == 0)
    {
      results[0].data.d_status = GIMP_PDB_SUCCESS;
    }
  else if (g_strcmp0 (msg, "execution") == 0)
    {
      results[0].data.d_status = GIMP_PDB_EXECUTION_ERROR;
    }
  else if (g_strcmp0 (msg, "calling") == 0)
    {
      results[0].data.d_status = GIMP_PDB_CALLING_ERROR;
    }
  else if (g_strcmp0 (msg, "pass") == 0)
    {
      results[0].data.d_status = GIMP_PDB_PASS_THROUGH;
    }
  else if (g_strcmp0 (msg, "cancel") == 0)
    {
      results[0].data.d_status = GIMP_PDB_CANCEL;
    }
  else
    {
      results[0].data.d_status = GIMP_PDB_CALLING_ERROR;
    }
} // run