gOptions.hh

Go to the documentation of this file.

/*
This file is part of CASToR.

    CASToR 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.

    CASToR 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
    CASToR (in file GNU_GPL.TXT). If not, see <http://www.gnu.org/licenses/>.

Copyright 2017-2018 all CASToR contributors listed below:

    --> current contributors: Thibaut MERLIN, Simon STUTE, Didier BENOIT, Claude COMTAT, Marina FILIPOVIC, Mael MILLARDET
    --> past contributors: Valentin VIELZEUF

This is CASToR version 2.0.
*/

#ifndef GOPTIONS_HH
#define GOPTIONS_HH 1

// =====================================================================
// ---------------------------------------------------------------------
// ---------------------------------------------------------------------
// =====================================================================
#define KEYWORD_MANDATORY true

#define KEYWORD_OPTIONAL false

#define KEYWORD_MANDATORY_NOT_FOUND 1

#define KEYWORD_OPTIONAL_SUCCESS 0

#define KEYWORD_OPTIONAL_ERROR 1

#define KEYWORD_OPTIONAL_NOT_FOUND 2

// =====================================================================
// ---------------------------------------------------------------------
// ---------------------------------------------------------------------
// =====================================================================
// Functions for command line parameters reading
// Functions parsing a string composed of several numbers separated by commas.
template<typename T> int ReadStringOption(const string& a_input, T* ap_return, int a_nbElts, const string& sep, const string& a_option);

// =====================================================================
// ---------------------------------------------------------------------
// ---------------------------------------------------------------------
// =====================================================================
// Functions for ASCII file input reading
template<typename T> int ReadDataASCIIFile(const string& a_file, const string& a_keyword, T* ap_return, int a_nbElts, bool a_mandatoryFlag);

template<typename T> int ReadDataASCIIFile(const string& a_file, const string& a_keyword, T* ap_return, int a_nbElts, int a_nbLines, bool a_mandatoryFlag);

template<typename T> int ReadDataASCIIFile(const string& a_file, const string& a_keyword, T** a2p_return, int a_nbElts, int a_nbLines, bool a_mandatoryFlag);

template<typename T> int ReadDataASCIIFile(const string& a_file, const string& a_keyword, T* ap_return, int a_nbElts, bool a_mandatoryFlag, string a_firstTag, string a_lastTag);

template<typename T> int ReadDataASCIIFile(const string& a_file, const string& a_keyword, T** a2p_return, int a_nbElts, int a_nbLines, bool a_mandatoryFlag, string a_firstTag, string a_lastTag);

// =====================================================================
// ---------------------------------------------------------------------
// ---------------------------------------------------------------------
// =====================================================================
// Functions for data conversion
int ConvertFromString(const string& a_str, string* a_result);

int ConvertFromString(const string& a_str, float* a_result);

int ConvertFromString(const string& a_str, double* a_result);

int ConvertFromString(const string& a_str, long double* a_result);

int ConvertFromString(const string& a_str, int* a_result);

int ConvertFromString(const string& a_str, int64_t* a_result);

int ConvertFromString(const string& a_str, uint8_t* a_result);

int ConvertFromString(const string& a_str, uint16_t* a_result);

int ConvertFromString(const string& a_str, uint32_t* a_result);

int ConvertFromString(const string& a_str, bool* a_result);


bool FLTNBIsEqual(FLTNB a, FLTNB b, FLTNB a_eps);


string GetFileFromPath(const string& a_pathToFile);

string GetPathOfFile(const string& a_pathToFile);

string ConvertAllSlashOccurrencesToBackSlash(const string& a_path);

#endif