CmdLine.h

Go to the documentation of this file.

// Copyright (C) 2003--2004 Ronan Collobert (collober@idiap.ch)
//                
// This file is part of Torch 3.1.
//
// All rights reserved.
// 
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions
// are met:
// 1. Redistributions of source code must retain the above copyright
//    notice, this list of conditions and the following disclaimer.
// 2. Redistributions in binary form must reproduce the above copyright
//    notice, this list of conditions and the following disclaimer in the
//    documentation and/or other materials provided with the distribution.
// 3. The name of the author may not be used to endorse or promote products
//    derived from this software without specific prior written permission.
// 
// THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
// IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
// OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
// IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
// INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
// NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
// THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

#ifndef CMD_LINE_INC
#define CMD_LINE_INC

#include <qualia/core/common.h>
#include <qualia/computer/CmdOption.h>
#include <qualia/computer/DiskXFile.h>

class CmdLine
{
  public:
    char *program_name;
    bool write_log;
    int n_master_switches;
    int *n_cmd_options;
    CmdOption ***cmd_options;
    char *text_info;

    char *working_directory;
    char **associated_files;
    int n_associated_files;
    int master_switch;

    char **argv;
    int argc;

    // -----

    CmdLine();

    int read(int argc_, char **argv_);

    void help();

    //-----


    void addICmdOption(const char *name, int *ptr, int init_value, const char *help="", bool save_it=false);
    void addBCmdOption(const char *name, bool *ptr, bool init_value, const char *help="", bool save_it=false);
    void addRCmdOption(const char *name, real *ptr, real init_value, const char *help="", bool save_it=false);
    void addSCmdOption(const char *name, char **ptr, const char *init_value, const char *help="", bool save_it=false);


    void addICmdArg(const char *name, int *ptr, const char *help="", bool save_it=false);
    void addBCmdArg(const char *name, bool *ptr, const char *help="", bool save_it=false);
    void addRCmdArg(const char *name, real *ptr, const char *help="", bool save_it=false);
    void addSCmdArg(const char *name, char **ptr, const char *help="", bool save_it=false);

    void addText(const char *text);

    void info(const char *text);

    void addMasterSwitch(const char *text);

    void setWorkingDirectory(const char* dirname);

    char *getPath(const char *filename);

    DiskXFile *getXFile(const char *filename);
    
    virtual void load(DiskXFile *file);

    virtual void save(DiskXFile *file);

    //-----

    void addCmdOption(CmdOption *option);

    void writeLog(DiskXFile *file, bool write_associated_files);

    virtual ~CmdLine();
};

#endif