Parameters.h

/*
 *  Copyright (C) 2010-2012  Regents of the University of Michigan
 *
 *   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 3 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, see <http://www.gnu.org/licenses/>.
 */

#ifndef __PARAMETERS_H__
#define __PARAMETERS_H__

#include "StringMap.h"
#include "PhoneHome.h"

#include <ctype.h>
#include <stddef.h>

class ParameterList;

class Parameter
{
protected:

    static const char PARAM_STR_SEP = ',';
    char ch;
    char * description;
    void * var;

    static int nameCol;
    static int statusCol;

    virtual void Translate(const char * value) = 0;
    virtual bool TranslateExtras(const char * value, const char * extras);

    static bool CheckInteger(const char * value);
    static bool CheckDouble(const char * value);

    String * warnings;
    bool myNoPhoneHome;
    String myVersion;

public:

    Parameter(char c, const char * desc, void * v);

    virtual ~Parameter()
    {
        delete [] description;
    }

    virtual bool Read(int argc, char ** argv, int argn);
    virtual void Status() = 0;
    virtual void addParamsToString(String& params)
    {
        if(var != NULL)
        {
            if(!params.IsEmpty())
            {
                params += PARAM_STR_SEP;
            }
            params += description;
        }
    }


    static void SetNameLen(int len)
    {
        nameCol = len;
    }
    static void SetStatusLen(int len)
    {
        statusCol = len;
    }

    void SetWarningBuffer(String & buffer)
    {
        warnings = &buffer;
    }
    void warning(const char * format, ...);

    friend class ParameterList;
};

class IntParameter : public Parameter
{
public:
    IntParameter(char c, const char * desc, int & v)
        : Parameter(c, desc, &v)
    {}

    virtual void Status();

protected:
    virtual void Translate(const char * value);
    virtual bool TranslateExtras(const char * value, const char * extras);
};

class HiddenInteger : public IntParameter
{
public:
    HiddenInteger(char c, const char * desc, int & v)
        : IntParameter(c, desc, v)
    {}

    virtual void Status() { }
};


class SwitchParameter : public Parameter
{
public:
    SwitchParameter(char c, const char * desc, bool & v)
        : Parameter(c, desc, &v)
    {}

    virtual void Status();

protected:
    virtual void Translate(const char * value);
};

class HiddenSwitch : public SwitchParameter
{
public:
    HiddenSwitch(char c, const char * desc, bool & v)
        : SwitchParameter(c, desc, v)
    {}

    virtual void Status() { }
};

class DoubleParameter : public Parameter
{
public:
    DoubleParameter(char c, const char * desc, double & v);

    virtual void Status();

    DoubleParameter & SetPrecision(int precision)
    {
        this->precision = precision;

        return *this;
    }

protected:
    virtual void Translate(const char * value);
    virtual bool TranslateExtras(const char * value, const char * extras);

    int precision;
};

class HiddenDouble : public DoubleParameter
{
public:
    HiddenDouble(char c, const char * desc, double &v)
        : DoubleParameter(c, desc, v)
    {}

    virtual void Status() { }
};

class StringParameter : public Parameter
{
public:
    StringParameter(char c, const char * desc, String & v, bool allowBlank = true)
            : Parameter(c, desc, &v)
    {
        required = !allowBlank;
    }

    virtual void Status();

protected:
    bool required;

    virtual void Translate(const char * value);
    virtual bool TranslateExtras(const char * value, const char * extras);
};

class HiddenString : public StringParameter
{
public:
    HiddenString(char c, const char * desc, String & v)
        : StringParameter(c, desc, v)
    {}

    virtual void Status() { }
};

struct OptionList
{
    char     ch;
    char *   description;
    int      code;
};

#define BEGIN_OPTION_LIST(name)     ; OptionList name[] = {
#define END_OPTION_LIST(none)       , {0, none, 0} };

class ListParameter : public Parameter
{
public:
    ListParameter(char c, const char * desc, int & v, OptionList * opt);

    virtual void Status();

protected:
    String       key;
    OptionList * options;
    virtual void Translate(const char * value);
};

class SetParameter : public Parameter
{
public:
    SetParameter(char c, const char * desc, int & v, OptionList * opt);

    virtual void Status();

protected:
    String       key;
    OptionList * options;
    virtual void Translate(const char * value);
};

struct LongParameterList
{
    const char * description;
    void * value;
    bool exclusive;
    int  type;
    bool touched;
};

#define LP_BOOL_PARAMETER     1
#define LP_INT_PARAMETER      2
#define LP_DOUBLE_PARAMETER   3
#define LP_STRING_PARAMETER   4
#define LP_LEGACY_PARAMETERS  99
#define LP_PHONEHOME_VERSION   98

#define BEGIN_LONG_PARAMETERS(array)   LongParameterList array[] = {\
                                              { NULL,  NULL,      false,  0, 0},
#define LONG_PARAMETER_GROUP(label)           { label, NULL,      false,  0, 0},
#define LONG_PARAMETER(label,boolptr)         { label, boolptr,   false,  1, 0},
#define EXCLUSIVE_PARAMETER(label,boolptr)    { label, boolptr,   true,   1, 0},
#define LONG_INTPARAMETER(label,intptr)       { label, intptr,    false,  2, 0},
#define LONG_SMARTINTPARAMETER(label,intptr)  { label, intptr,    true,   2, 0},
#define LONG_DOUBLEPARAMETER(label,doubleptr) { label, doubleptr, false,  3, 0},
#define LONG_STRINGPARAMETER(label,stringptr) { label, stringptr, false,  4, 0},
#define LONG_PHONEHOME(version)               { "PhoneHome", NULL, false,  0, 0}, { version, NULL,    false,  LP_PHONEHOME_VERSION, 0}, {"phoneHomeThinning", &PhoneHome::allThinning, false, LP_INT_PARAMETER, 0},
#define BEGIN_LEGACY_PARAMETERS()             { "$$$", NULL,      false, 99, 0},
#define END_LONG_PARAMETERS()                 { NULL,  NULL,      false,  0, 0}};

class LongParameters : public Parameter
{
public:
    LongParameters(const char * desc, LongParameterList * list);

    virtual void Status();
    virtual void addParamsToString(String& params);

    LongParameters * SetPrecision(int precision)
    {
        this->precision = precision;

        return this;
    }

protected:
    StringMap index;
    StringMap legacyIndex;

    LongParameterList * list;
    int group_len;
    int precision;

    virtual void Translate(const char * value);
    virtual bool TranslateExtras(const char * value, const char * extras);

    void ExplainAmbiguity(const char * value);

    void Status(LongParameterList * ptr, int & line_len, bool & need_a_comma);
};

class ParameterList
{
protected:
    Parameter ** pl;
    int count;
    int size;

    void MakeString(int argc, char ** argv, int start = 1);
    void HandlePhoneHome(int argc, char ** argv, int start);

public:
    char * string;

    ParameterList(int s = 36)
    {
        size = s;
        count = 0;
        pl = new Parameter * [size];
        string = NULL;
    }

    virtual ~ParameterList();

    void Add(Parameter * p);

    // Tries to process all command line arguments
    virtual void Read(int argc, char ** argv, int start = 1);

    // Allows for trailing, unprocessed, filenames in the command line
    // The number of translated argv[] items is returned
    virtual int ReadWithTrailer(int argc, char ** argv, int start = 1);

    // Outputs summary of parameter switches and settings
    virtual void Status();

    // Keeps track of warnings generated during parameter processing
    String  warnings;
    String  messages;

    // Functions that gracefully enforce parameter settings
    void Enforce(bool & var, bool value, const char * reason, ...);
    void Enforce(int & var, int value, const char * reason, ...);
    void Enforce(double & var, double value, const char * reason, ...);
    void Enforce(String & var, const char * value, const char * reason, ...);
};


// Container for holding the long parameter list.
// Allows parameters to be added.
// Allows users to not have to use BEGIN_LONG_PARAMETERS or to understand
// the details of a LongParameterList.
class LongParamContainer
{
public:
    LongParamContainer();
    ~LongParamContainer();

    // Get a pointer to the LongParameterList.
    inline LongParameterList* getLongParameterList()
    { return(myArray); }

    void add(const char * label, void * val, bool excl, 
             int paramType, bool touch = 0);

    inline void addGroup(const char * label)
    { add(label, NULL, false, 0, 0); }

    inline void addBool(const char * label, void * boolptr)
    { add(label, boolptr, false, LP_BOOL_PARAMETER, 0); }

    inline void addExclusiveBool(const char * label, void * boolptr)
    { add(label, boolptr, true, LP_BOOL_PARAMETER, 0); }

    inline void addInt(const char * label, void * intptr)
    { add(label, intptr, false, LP_INT_PARAMETER, 0); }

    inline void addSmartInt(const char * label, void * intptr)
    { add(label, intptr, true, LP_INT_PARAMETER, 0); }

    inline void addDouble(const char * label, void * doubleptr)
    { add(label, doubleptr, false, LP_DOUBLE_PARAMETER, 0); }

    inline void addString(const char * label, void * stringptr)
    { add(label, stringptr, false, LP_STRING_PARAMETER, 0); }

    inline void addPhoneHome(const char* version)
    { 
        add("PhoneHome", NULL, false,  0, 0);
        add(version, NULL,    false,  LP_PHONEHOME_VERSION, 0);
        add("phoneHomeThinning", &PhoneHome::allThinning, false, LP_INT_PARAMETER, 0);
    }

    inline void startLegacyParams()
    { add("$$$", NULL, false, 99, 0); }

private:
    // At most 100 parameters are allowed.
    static const int MAX_PARAM_ARRAY_SIZE = 100;
    LongParameterList myArray[MAX_PARAM_ARRAY_SIZE];

    int myEndIndex;
};


#endif