/*

Copyright (C) 1996-2016 John W. Eaton

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
<http://www.gnu.org/licenses/>.

*/

#if ! defined (octave_pt_mat_h)
#define octave_pt_mat_h 1

#include "octave-config.h"

#include <iosfwd>

class octave_value;
class octave_value_list;

#include "base-list.h"
#include "pt-array-list.h"
#include "pt-exp.h"
#include "symtab.h"

// The character to fill with when creating string arrays.
extern char Vstring_fill_char;

namespace octave
{
  class tree_argument_list;

  class tree_walker;

  // General matrices.  This allows us to construct matrices from
  // other matrices, variables, and functions.

  class tree_matrix : public tree_array_list
  {
  public:

    tree_matrix (tree_argument_list *row = 0, int l = -1, int c = -1)
      : tree_array_list (row, l, c)
    { }

    // No copying!

    tree_matrix (const tree_matrix&) = delete;

    tree_matrix& operator = (const tree_matrix&) = delete;

    ~tree_matrix (void) = default;

    bool is_matrix (void) const { return true; }

    bool rvalue_ok (void) const { return true; }

    octave_value rvalue1 (int nargout = 1);

    octave_value_list rvalue (int nargout);

    tree_expression *dup (symbol_table::scope_id scope,
                          symbol_table::context_id context) const;

    void accept (tree_walker& tw);
  };

  extern std::string
  get_concat_class (const std::string& c1, const std::string& c2);

  extern void
  maybe_warn_string_concat (bool all_dq_strings_p, bool all_sq_strings_p);
}

#if defined (OCTAVE_USE_DEPRECATED_FUNCTIONS)

OCTAVE_DEPRECATED ("use 'octave::tree_matrix' instead")
typedef octave::tree_matrix tree_matrix;

OCTAVE_DEPRECATED ("use 'octave::get_concat_class' instead")
static inline std::string
get_concat_class (const std::string& c1, const std::string& c2)
{
  return octave::get_concat_class (c1, c2);
}

OCTAVE_DEPRECATED ("use 'octave::maybe_warn_string_concat' instead")
static inline void
maybe_warn_string_concat (bool all_dq_strings_p, bool all_sq_strings_p)
{
  octave::maybe_warn_string_concat (all_dq_strings_p, all_sq_strings_p);
}

#endif

#endif