/* $Id: optionentry.hg,v 1.11 2005/07/31 13:11:05 murrayc Exp $ */

/* Copyright (C) 2004 The glibmm Development Team
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library 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
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Library General Public
 * License along with this library; if not, write to the Free
 * Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 */

_DEFS(glibmm,glib)

#include <glibmm/ustring.h>

#ifndef DOXYGEN_SHOULD_SKIP_THIS
extern "C" { typedef struct _GOptionEntry GOptionEntry; }
#endif


namespace Glib
{

/** An OptionEntry defines a single option. To have an effect, it must be added to an OptionGroup with 
 * OptionGroup::add_entry().
 * 
 * The long name of an option can be used to specify it in a commandline as --long_name. 
 * Every option must have a long name. To resolve conflicts if multiple option groups contain the same long name, it is also 
 * possible to specify the option as --groupname-long_name.
 *
 * If an option has a short name, it can be specified as -short_name in a commandline.
 *
 * The description for the option is shown in the --help  output.
 *
 * The arg_descripton is the placeholder to use for the extra argument parsed by the option in --help  output. 
 */
class OptionEntry
{
  _CLASS_GENERIC(OptionEntry, GOptionEntry)
public:

  //Copied from goption.h, instead of generated, so that we can put it inside the class.
  enum Flags
  {
    FLAG_HIDDEN = 1 << 0,
    FLAG_IN_MAIN = 1 << 1,
    FLAG_REVERSE = 1 << 2,
    FLAG_NO_ARG = 1 << 3,
    FLAG_FILENAME = 1 << 4,
    FLAG_OPTIONAL_ARG = 1 << 5,
    FLAG_NOALIAS = 1 << 6
  } GOptionFlags;

  OptionEntry();
  OptionEntry(const OptionEntry& src);
  virtual ~OptionEntry();
  
  OptionEntry& operator=(const OptionEntry& src);

#m4 _CONVERSION(`Glib::ustring',`const gchar*',`g_strdup(($3).c_str())')
  
  _MEMBER_GET(long_name, long_name, Glib::ustring, const char*)
  _MEMBER_SET(long_name, long_name, Glib::ustring, const char*)
  
  _MEMBER_GET(short_name, short_name, gchar, gchar)
  _MEMBER_SET(short_name, short_name, gchar, gchar)
  
  _MEMBER_GET(flags, flags, int, int)
  _MEMBER_SET(flags, flags, int, int)
  
  //TODO: G_OPTION_ARG_CALLBACK,
    
  _MEMBER_GET(description, description, Glib::ustring, const char*)
  _MEMBER_SET(description, description, Glib::ustring, const char*)
  
  _MEMBER_GET(arg_description, arg_description, Glib::ustring, const char*)
  _MEMBER_SET(arg_description, arg_description, Glib::ustring, const char*)
  
  GOptionEntry*       gobj()       { return gobject_; }
  const GOptionEntry* gobj() const { return gobject_; }
  
protected:

  GOptionEntry* gobject_;
};

} // namespace Glib