mystring.h

Go to the documentation of this file.

/* Copyright (C) 2001-2012 Stefan Buehler <sbuehler@ltu.se>
 
   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, 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. */
 
#ifndef mystring_h
#define mystring_h
 
#include <fast_float/fast_float.h>
 
#include <algorithm>
#include <charconv>
#include <climits>
#include <sstream>
#include <string>
#include <string_view>
#include <type_traits>
 
#include "array.h"
#include "debug.h"
#include "matpack.h"
 
template <class charT>
class my_basic_string : public std::basic_string<charT> {
 public:
  // Constructors:
  my_basic_string() = default;
 
  explicit my_basic_string(Index n, char c = ' ')
      : std::basic_string<charT>(n, c) {}
 
  my_basic_string(const std::basic_string<charT>& A,
                  Index pos = 0,
                  Index numpos = my_basic_string<charT>::npos) {
    // Range checks:
    ARTS_ASSERT(0 <= pos);  // Start index must be 0 or greater 0.
 
    if (!A.size()) return;
 
    //   cout << "A = " << A << "\n";
    //   cout << "pos = " << pos << "\n";
    //   cout << "size = " << A.size() << "\n";
 
    ARTS_ASSERT(static_cast<typename std::basic_string<charT>::size_type>(pos) <
                A.size());
    // At most the last element of the original string.
 
    ARTS_ASSERT(
        numpos == my_basic_string<charT>::npos ||
        ((numpos >= 0) &&
         (static_cast<typename std::basic_string<charT>::size_type>(numpos) <=
          (A.size() -
           pos))));  // Number of characters to copy must be at the most the
                     // number left. -1 means all remaining characters.
 
    // The assertions look complicated, because we have to cast pos and
    // npos to the unsigned size type of basic string to avoid warning
    // messages from the compiler. Both casts are save, because previous
    // assertions check that pos and npos are positive. (The allowed
    // case npos -1 (=my_basic_string<charT>::npos) is also handled
    // correctly.)
 
    std::basic_string<charT>::operator=(
        std::basic_string<charT>(A, pos, numpos));
  }
 
  my_basic_string(const char* A)
      : std::basic_string<charT>(A) { /* Nothing to do here. */
  }
 
  my_basic_string(const std::string_view& sv)
      : std::basic_string<charT>(std::string(sv)) { /* Nothing to do here. */
  }
 
  // Insert string before all occurrences of the substring.
  void insert_substr(const my_basic_string<charT>& searchstr,
                     const my_basic_string<charT>& insstr) {
    size_t searchstr_size = searchstr.size();
    size_t insstr_size = insstr.size();
    size_t start_pos = 0;
 
    while (start_pos != std::string::npos) {
      start_pos = this->find(searchstr, start_pos);
      if (start_pos && start_pos != std::string::npos) {
        this->insert(start_pos, insstr);
        start_pos += searchstr_size + insstr_size;
      }
    }
  }
 
  // Split string
  void split(Array<my_basic_string<charT>>& aos,
             const my_basic_string<charT>& delim) const {
    size_t pos, oldpos;
    pos = oldpos = 0;
    aos.resize(0);
 
    while (oldpos < (size_t)this->nelem() &&
           (pos = this->find(delim, oldpos)) !=
               (size_t)my_basic_string<charT>::npos) {
      if (pos && pos - oldpos)
        aos.push_back(this->substr(oldpos, pos - oldpos));
      oldpos = pos + delim.nelem();
    }
 
    if (oldpos < (size_t)this->nelem()) aos.push_back(this->substr(oldpos));
  }
 
  void toupper() {
    std::transform(this->begin(), this->end(), this->begin(), ::toupper);
  }
 
  [[nodiscard]] my_basic_string toupper() const {
    my_basic_string s = *this;
    s.toupper();
    return s;
  }
 
  void tolower() {
    std::transform(this->begin(), this->end(), this->begin(), ::tolower);
  }
 
  [[nodiscard]] my_basic_string tolower() const {
    my_basic_string s = *this;
    s.tolower();
    return s;
  }
 
  void trim() {
    // Create ref to self for readability
    my_basic_string& this_string = *this;
 
    // Remove leading whitespace
    while (0 != this_string.nelem() &&
           (' ' == this_string[0] || '\t' == this_string[0] ||
            '\n' == this_string[0] || '\r' == this_string[0]))
      this_string.erase(0, 1);
 
    // Remove trailing whitespace
    while (0 != this_string.nelem() &&
           (' ' == this_string[this_string.nelem() - 1] ||
            '\t' == this_string[this_string.nelem() - 1] ||
            '\n' == this_string[this_string.nelem() - 1] ||
            '\r' == this_string[this_string.nelem() - 1]))
      this_string.erase(this_string.nelem() - 1);
  }
 
  // Number of elements:
  [[nodiscard]] Index nelem() const {
    size_t s = this->size();
    ARTS_ASSERT(s < LONG_MAX);
    return static_cast<long>(s);
  }
 
  // Index operators:
  char operator[](Index n) const {
    ARTS_ASSERT(0 <= n);
    ARTS_ASSERT(n < nelem());
    return std::basic_string<charT>::operator[](n);
  }
 
  char& operator[](Index n) {
    ARTS_ASSERT(0 <= n);
    ARTS_ASSERT(n < nelem());
    return std::basic_string<charT>::operator[](n);
  }
 
  static const Index npos = static_cast<Index>(std::basic_string<charT>::npos);
 
  using size_type = Index;
};
 
using String = my_basic_string<char>;
 
using ArrayOfString = Array<String>;
 
using ArrayOfArrayOfString = Array<Array<String>>;
 
template <class T>
void extract(T& x, String& line, std::size_t n) {
  // Initialize output to zero! This is important, because otherwise
  // the output variable could `remember' old values.
  x = T(0);
 
  const std::size_t N = n;
  std::size_t i = 0;
  while (i < N and i < line.size() and isspace(line[i])) ++i;
  while (n > i and (n-1) < line.size() and isspace(line[n-1])) --n;
  
  if constexpr (std::is_same_v<double, T> or std::is_same_v<float, T>) {
    fast_float::from_chars(line.data() + i, line.data() + n, x);
  } else if constexpr (std::is_same_v<long long, T> or
                       std::is_same_v<long, T> or std::is_same_v<int, T>) {
    std::from_chars(line.data() + i, line.data() + n, x);
  } else {
    // This will contain the short subString with the item to extract.
    // Make it a String stream, for easy parsing,
    // extracting subString of width n from line:
    std::istringstream item(line.substr(i, n));
 
    // Convert with the aid of String stream item:
    item >> x;
  }
 
  // Shorten line by n:
  line.erase(0, N);
}
 
#endif  // mystring_h