////////////////////////////////////////////////////////////////////////
//
// Copyright (C) 1996-2024 The Octave Project Developers
//
// See the file COPYRIGHT.md in the top-level directory of this
// distribution or <https://octave.org/copyright/>.
//
// This file is part of Octave.
//
// Octave 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.
//
// Octave 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 Octave; see the file COPYING.  If not, see
// <https://www.gnu.org/licenses/>.
//
////////////////////////////////////////////////////////////////////////

#if ! defined (octave_str_vec_h)
#define octave_str_vec_h 1

#include "octave-config.h"

#include <iosfwd>
#include <list>
#include <string>

#include "Array.h"

class OCTAVE_API string_vector
{
public:

  string_vector () = default;

  explicit string_vector (octave_idx_type n) : m_data (dim_vector (n, 1)) { }

  string_vector (const char *s) : m_data (dim_vector (1, 1), s) { }

  string_vector (const std::string& s) : m_data (dim_vector (1, 1), s) { }

  string_vector (const string_vector&) = default;

  string_vector (string_vector&&) = default;

  //! Constructor for STL containers of std::string.
  //!
  //! Templated constructor for any template class with std::string as the
  //! first parameter, and begin, end, and size methods, i.e., a class with
  //! similar interface as the STL containers.

  template<template <typename...> class String_Container, typename... Other>
  string_vector (const String_Container<std::string, Other...>& lst);

  string_vector (const Array<std::string>& s)
    : m_data (s.as_column ()) { }

  string_vector (const char * const *s);

  string_vector (const char * const *s, octave_idx_type n);

  string_vector& operator = (const string_vector&) = default;

  string_vector& operator = (string_vector&&) = default;

  ~string_vector () = default;

  bool empty () const { return numel () == 0; }

  octave_idx_type max_length () const
  {
    octave_idx_type n = numel ();
    octave_idx_type longest = 0;

    for (octave_idx_type i = 0; i < n; i++)
      {
        octave_idx_type tmp = elem (i).length ();

        if (tmp > longest)
          longest = tmp;
      }

    return longest;
  }

  void resize (octave_idx_type n, const std::string& rfv = "")
  {
    m_data.resize (dim_vector (n, 1), rfv);
  }

  octave_idx_type numel () const { return m_data.numel (); }

  bool isempty () const { return m_data.isempty (); }

  std::string& elem (octave_idx_type i) { return m_data.elem (i); }

  std::string elem (octave_idx_type i) const { return m_data.elem (i); }

  std::string& xelem (octave_idx_type i) { return m_data.xelem (i); }

  std::string xelem (octave_idx_type i) const { return m_data.xelem (i); }

  std::string& operator[] (octave_idx_type i) { return elem (i); }

  std::string operator[] (octave_idx_type i) const { return elem (i); }

  std::string& operator () (octave_idx_type i) { return elem (i); }

  std::string operator () (octave_idx_type i) const { return elem (i); }

  string_vector& sort (bool make_uniq = false);

  string_vector& uniq ();

  string_vector& append (const std::string& s);

  string_vector& append (const string_vector& sv);

  std::string join (const std::string& sep = "") const;

  char ** c_str_vec () const;

  std::list<std::string> std_list () const;

  static void delete_c_str_vec (const char * const*);

  std::ostream&
  list_in_columns (std::ostream&, int width = 0,
                   const std::string& prefix = "") const;

  string_vector linear_slice (octave_idx_type lo, octave_idx_type up) const
  {
    return string_vector (m_data.linear_slice (lo, up));
  }

  template <typename U, typename F> Array<U> map (F fcn) const
  {
    return m_data.map<U> (fcn);
  }

private:

  Array<std::string> m_data;
};


template<template <typename...> class String_Container, typename... Other>
string_vector::string_vector (const String_Container<std::string, Other...>&
                              lst)
  : m_data ()
{
  resize (lst.size ());

  octave_idx_type i = 0;
  for (const std::string& s : lst)
    elem (i++) = s;
}

#endif