CepsString.hpp

Go to the documentation of this file.

/*~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
   This file is part of CEPS.
 
   CEPS 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.
 
   CEPS 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 CEPS (see file LICENSE at root of project).
   If not, see <https://www.gnu.org/licenses/>.
 
 
   Copyright 2019-2024 Inria, Universite de Bordeaux
 
   Authors, in alphabetical order:
 
     Pierre-Elliott BECUE, Florian CARO, Yves COUDIERE(*), Andjela DAVIDOVIC, 
     Charlie DOUANLA-LONTSI, Marc FUENTES, Mehdi JUHOOR, Michael LEGUEBE(*), 
     Pauline MIGERDITICHAN, Valentin PANNETIER(*), Nejib ZEMZEMI.
     * : currently active authors
 
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~*/
#pragma once
 
#include "common/core/CepsTypes.hpp"
 
namespace ceps
{
  CepsVector<CepsString>
  split(const CepsString& s, const CepsString& delimiters = CepsString (" \t"));
 
  CepsMap<CepsString, CepsVector<CepsString>>
  split(const CepsMap<CepsString, CepsString>& map, const CepsString& delimiters = CepsString (" \t"));
 
  CepsVector<CepsVector<CepsString>>
  split(const CepsVector<CepsString>& vec, const CepsString& delimiters = CepsString (" \t"));
 
  CepsString
  join(const CepsVector<CepsString>& vec, const CepsChar& delimeter = ' ');
 
  CepsString
  trim(const CepsString& s);
 
  CepsString
  removeSpaces(const CepsString& s);
 
  CepsString
  substract(const CepsString& s, const CepsString& toErase);
 
  CepsString
  substract(const CepsString& s, const CepsVector<CepsString>& toErase);
 
  CepsString
  toUpper(const CepsString& s);
 
  CepsString
  toLower(const CepsString& s);
 
  CepsBool
  isPathInOneWord(const CepsString& s);
 
  CepsString
  toKey(const CepsString& s);
 
  CepsVector<CepsString>
  toKey(const CepsVector<CepsString>& vec);
 
  void
  toKeyInPlace(CepsVector<CepsString>& vec);
 
  CepsBool
  toBool(const CepsString& s);
 
  CepsReal
  toReal(const CepsString& s);
 
  CepsSet<CepsReal>
  toReals(const CepsString& s);
 
  CepsMathScalar
  toMathScalar(const CepsVector<CepsString>& vec);
 
  CepsMathVertex
  toMathVertex(const CepsVector<CepsString>& vec);
 
  CepsMathTensor
  toMathTensor(const CepsVector<CepsString>& vec);
 
  CepsInt
  toInt(const CepsString& s);
 
  CepsSet<CepsInt>
  toInts(const CepsString& s);
 
  CepsUInt
  toUInt(const CepsString& s);
 
  CepsSet<CepsUInt>
  toUInts(const CepsString& s);
 
  CepsBool
  isNumber(const CepsString& s);
 
  CepsBool
  startsWith(const CepsString& s, const CepsString& comp);
 
  CepsBool
  startsWithOneOf(const CepsString& s, const CepsVector<CepsString>& comps);
 
  CepsBool
  endsWith(const CepsString& s, const CepsString& comp);
 
  CepsBool
  endsWithOneOf(const CepsString& s, const CepsVector<CepsString>& comps);
 
  CepsMap<CepsString, CepsVector<CepsString>>
  splitByKeyword(const CepsString& s, const CepsSet<CepsString>& tags);
 
  CepsVector<CepsString>
  splitAtNthDelimiter(
    const CepsString& s,
    CepsUInt          n,
    CepsString        delimiters = CepsString (" \t")
  );
 
  CepsVector<CepsString>
  splitUntilNthDelimiter(
    const CepsString& s,
    const CepsUInt&   n,
    CepsString        delimiters = CepsString (" \t")
  );
 
  CepsString
  readParams(
    const CepsVector<CepsString>& scope,
    const CepsString&             tag,
    const CepsString&             def = "",
    const CepsUInt&               pad = 1
  );
 
  CepsString
  removeDoubleSlashes(const CepsString& path);
 
  CepsString
  getDir(const CepsString& str);
 
  CepsString
  getFilename(const CepsString& str);
 
  CepsString
  getBaseName(const CepsString& str);
 
  CepsString
  getExtension(const CepsString& str);
 
  CepsString
  changeExtension(const CepsString& str, const CepsString& ext);
 
  template <typename _Tp>
  CepsString
  toString(_Tp value)
  {
    return std::to_string(value);
  }
 
  CepsBool
  fileExists(const CepsString& fileName, const CepsString& directory);
 
  CepsBool
  fileExists(const CepsString& fileName);
 
  CepsBool
  isSameFile(const CepsString& f1, const CepsString& f2);
 
  CepsVector<CepsString>
  cleanup(const CepsVector<CepsString>& vec);
 
  CepsReal
  readReal(std::istream& file, const CepsString& errorMessage="");
 
  CepsInt
  readInt(std::istream& file, const CepsString& errorMessage="");
 
  CepsReal3D
  readVertex(std::istream& file, const CepsString& errorMessage="");
 
  CepsMathTensor
  readTensor(std::istream& file, const CepsString& errorMessage="");
 
  template<CepsUInt n>
  CepsArray<CepsMathScalar,n>
  readReals(std::istream& file, const CepsString& errorMessage="");
 
}  // namespace ceps
 
template<CepsUInt n>
CepsArray<CepsMathScalar,n>
ceps::readReals(std::istream& file, const CepsString& errorMessage)
{
  CepsArray<CepsMathScalar,n> res;
  for (CepsUInt i=0;i<n;i++)
    res[i] = ceps::readReal(file,errorMessage+"("+std::to_string(i)+"/"+std::to_string(n)+")");
  return res; 
}