xmipp_program.h

Go to the documentation of this file.

/***************************************************************************
 * Authors:     J.M. de la Rosa Trevin (jmdelarosa@cnb.csic.es)
 *
 *
 * Unidad de  Bioinformatica of Centro Nacional de Biotecnologia , CSIC
 *
 * 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 2 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, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
 * 02111-1307  USA
 *
 *  All comments concerning this program package may be sent to the
 *  e-mail address 'xmipp@cnb.csic.es'
 ***************************************************************************/

#ifndef CORE_PROGRAM_H_
#define CORE_PROGRAM_H_

#include <map>
#include "comment_list.h"

class ProgramDef;
class ParamDef;

class XmippProgram
{
private:
    void init();

    bool checkBuiltIns();

    void writeToDB();
    void writeToAutocomplete();

    void createWiki();

    size_t progressTotal;
    size_t progressStep;
    size_t progressLast;

protected:
    void defineCommons();
    int errorCode;
    ProgramDef * progDef;

    std::map<String, CommentList> defaultComments;

    int argc;
    const char ** argv;

public:
    bool doRun;
    bool runWithoutArgs;
    void processDefaultComment(const char *param, const char *left);
    void setDefaultComment(const char *param, const char *comment);
    virtual void initComments();
    virtual void defineParams();
    virtual void readParams();
    void setProgramName(const char * name);
    void addUsageLine(const char * line, bool verbatim=false);
    void clearUsage();
    void addExampleLine(const char * example, bool verbatim=true);
    void addSeeAlsoLine(const char * seeAlso);
    void addKeywords(const char * keywords);

    const char * getParam(const char * param, int arg = 0);
    const char * getParam(const char * param, const char * subparam, int arg = 0);
    int getIntParam(const char * param, int arg = 0);
    int getIntParam(const char * param, const char * subparam, int arg = 0);
    double getDoubleParam(const char * param, int arg = 0);
    double getDoubleParam(const char * param, const char * subparam, int arg = 0);
    float getFloatParam(const char * param, int arg = 0);
    float getFloatParam(const char * param, const char * subparam, int arg = 0);
    void getListParam(const char * param, StringVector &list);
    int getCountParam(const char * param);
    bool checkParam(const char * param);
    bool existsParam(const char * param);

    void addParamsLine(const String &line);
    void addParamsLine(const char * line);

    ParamDef * getParamDef(const char * param) const;

    int verbose;
    int debug;

    const char * name() const;
    virtual void usage(int verb = 0) const;
    virtual void usage(const String & param, int verb = 2);

    int version() const;

    virtual void show() const;

    virtual void read(int argc, const char ** argv, bool reportErrors = true);

    virtual void read(int argc, char ** argv, bool reportErrors = true);

    void read(const String &argumentsLine);

    virtual void run();
    virtual void quit(int exit_code = 0) const;
    virtual int tryRun();

    void initProgress(size_t total, size_t stepBin = 60);

    void setProgress(size_t value = 0);

    void endProgress();



    XmippProgram();
    XmippProgram(int argc, const char ** argv);
    virtual ~XmippProgram();
}
;//end of class XmippProgram

#define RUN_XMIPP_PROGRAM(progName) \
  int main(int argc, char** argv) { \
      progName program; program.read(argc, argv);\
      return program.tryRun();}



#endif /* PROGRAM_H_ */