/*
  Copyright 2010 Nathan Phillip Brink, Ethan Zonca

  This file is a part of distren.
  
  Distren is free software: you can redistribute it and/or modify
  it under the terms of the GNU Affero General Public License as published by
  the Free Software Foundation, either version 3 of the License, or
  (at your option) any later version.
  
  Distren 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 Affero General Public License for more details.
  
  You should have received a copy of the GNU Affero General Public License
  along with distren.  If not, see <http://www.gnu.org/licenses/>.
*/

/*
  The point of this file is to handle options parsing that is common to both the server and client of distren. Options parsing that is specific to either should be managed by the server or the client. This means that the user of this interface will be given a handle to a part of a confuse config tree and have to eat that part of the tree to fulfill its own options.
  Unfortunately, this extra layer of abstraction shall possibly require a common_opts struct to be made that must be passed to all functions that use the common config. This would include any interface in /src/common/
 */

#ifndef _DISTREN_OPTIONS_H
#define _DISTREN_OPTIONS_H

#include <confuse.h>

#include "common/multiio.h"

/**
  incomplete:
  maybe remoteio.h should define its own struct which is injected into this struct and have its own handlers that parse its section of the confuse config file... (it'd be more modular)?
  Maybe we should just stick with compile-time modularity :-D (did I just suggest we make tons of macros?)
 */
struct options_common
{
  struct options_common_data *data;
  struct remoteio_opts *remoteio;
  struct client_opts *client;
  struct daemon_opts *daemon;
};

/**
  This function needs to eat some of your arguments to it, just like gtk+ and other libs like to. It particularly needs to be able to find the location of the config file, which should be taken from arguments if it's there. The argument list will have members that I recognize removed.

  Options should be kept alive during the program's life.

  The environment variable DISTREN_CONFIG_PREFIX, the built-in default config file location, or arguments passed on the commandline are used to determine the prefix of the config file name. Order of precedence: The command line is used first, then the environment variable, and then the default if no others sources specify the prefix.

  A calling function must call options_init() before processing its own arguments so that the libdistrencommon-specific help listing may be shown. The caller must also ignore libdistrencommon specific options. To avoid complication, those arguments are "c:h". Obviously, "h" should be handled sspecially ;-) (i.e., the caller should not ignore the "h" switch... it should output information about arguments it supports). Of course, calling functions could just rely on the 

  \param mycfg will be set to the section of the configuration file specific to the caller (client or server specific section). Who is supposed to free this variable?
  \param myopts holds the caller's confuse option declarations
  \param myname holds the name of the section of the config file that refers to mycfg and myopts -- currently ``slave'', ``client'', and ``server'' are valid

  \param allopts will be set to a pointer that many functions need for operation
  \param argc the argc that was passed to main() -- these will be used to determine the location of the config file
  \param argv the argv that was passed to main()
  \param multiio the multiio to associate with remoteio's configuration
 */
int options_init(int argc, char *argv[], cfg_t **mycfg, cfg_opt_t *myopts, char *myname, struct options_common **allopts, multiio_context_t multiio);

/**
   Frees the struct options_common. This should be run before the program exits.
 */
int options_free(struct options_common *allopts);
#endif