/**
 * basic.c
 *   A very basic GIMP plugin that tells you what happens when the
 *   four functions are called.
 *
 *   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, "*** [basic] %s ***\n", str)

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

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

static void basic_init (void);
static void basic_quit (void);
static void basic_query (void);
static void basic_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 =
  {
    basic_init,
    basic_quit,
    basic_query,
    basic_run
  };

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

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

static void
basic_init (void)
{
  REPORT ("init");
} // basic_init

static void
basic_quit (void)
{
  REPORT ("quit");
} // basic_quit

static void 
basic_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.  
  static GimpParamDef args[] =
    {
      { GIMP_PDB_INT32, "run-mode", "Run mode" }
    }; // args

  // Tell the GIMP about our plugin.
  gimp_install_procedure (
    "gggp/basic",                                       // Name
    "A basic plugin",                                   // Blurb
    "Prints messages when functions called",            // Help
    "Samuel A. Rebelsky",                               // Author
    "Copyright (c) Samuel A. Rebelsky.  All rights reserved.",
                                                        // Copyright
    "2013",                                             // Year
    "<Toolbox>/Filters/GGGP/Basic",                     // Path
    NULL,                                               // Image types
    GIMP_PLUGIN,                                        // Type
    1,                                                  // Number of params
    0,                                                  // Number of return vals
    args,                                               // Param descriptions
    NULL                                                // Return descriptions
    );

  REPORT ("query");
} // basic_query

static void
basic_run (const gchar      *name,
           gint              nparams,
           const GimpParam  *params,
           gint             *nreturn_vals,
           GimpParam       **return_vals)
{
  REPORT ("run");
  REPORT_INT (nparams);
  REPORT_INT (params[0].data.d_int32);
  // Set up return
  *nreturn_vals = 0;
  *return_vals = NULL;
} // basic_run