/*

Copyright (C) 1996-2020 The Octave Project Developers

See the file COPYRIGHT.md in the top-level directory of this distribution
or <https://octave.org/COPYRIGHT.html/>.


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_pt_unop_h)
#define octave_pt_unop_h 1

#include "octave-config.h"

#include <string>

class octave_value;
class octave_value_list;

#include "ov.h"
#include "pt-exp.h"
#include "pt-walk.h"

namespace octave
{
  class symbol_scope;

  // Unary expressions.

  class tree_unary_expression : public tree_expression
  {
  protected:

    tree_unary_expression (int l = -1, int c = -1,
                           octave_value::unary_op t
                           = octave_value::unknown_unary_op)
      : tree_expression (l, c), m_op (nullptr), m_etype (t)  { }

    tree_unary_expression (tree_expression *e, int l = -1, int c = -1,
                           octave_value::unary_op t
                           = octave_value::unknown_unary_op)
      : tree_expression (l, c), m_op (e), m_etype (t) { }

  public:

    // No copying!

    tree_unary_expression (const tree_unary_expression&) = delete;

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

    ~tree_unary_expression (void) { delete m_op; }

    bool is_unary_expression (void) const { return true; }

    bool has_magic_end (void) const { return (m_op && m_op->has_magic_end ()); }

    tree_expression * operand (void) { return m_op; }

    std::string oper (void) const;

    octave_value::unary_op op_type (void) const { return m_etype; }

  protected:

    // The operand for the expression.
    tree_expression *m_op;

    // The type of the expression.
    octave_value::unary_op m_etype;
  };

  // Prefix expressions.

  class tree_prefix_expression : public tree_unary_expression
  {
  public:

    tree_prefix_expression (int l = -1, int c = -1)
      : tree_unary_expression (l, c, octave_value::unknown_unary_op) { }

    tree_prefix_expression (tree_expression *e, int l = -1, int c = -1,
                            octave_value::unary_op t
                            = octave_value::unknown_unary_op)
      : tree_unary_expression (e, l, c, t) { }

    // No copying!

    tree_prefix_expression (const tree_prefix_expression&) = delete;

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

    ~tree_prefix_expression (void) = default;

    bool rvalue_ok (void) const { return true; }

    tree_expression * dup (symbol_scope& scope) const;

    octave_value evaluate (tree_evaluator&, int nargout = 1);

    octave_value_list evaluate_n (tree_evaluator& tw, int nargout = 1)
    {
      return ovl (evaluate (tw, nargout));
    }

    void accept (tree_walker& tw)
    {
      tw.visit_prefix_expression (*this);
    }

    std::string profiler_name (void) const { return "prefix " + oper (); }
  };

  // Postfix expressions.

  class tree_postfix_expression : public tree_unary_expression
  {
  public:

    tree_postfix_expression (int l = -1, int c = -1)
      : tree_unary_expression (l, c, octave_value::unknown_unary_op) { }

    tree_postfix_expression (tree_expression *e, int l = -1, int c = -1,
                             octave_value::unary_op t
                             = octave_value::unknown_unary_op)
      : tree_unary_expression (e, l, c, t) { }

    // No copying!

    tree_postfix_expression (const tree_postfix_expression&) = delete;

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

    ~tree_postfix_expression (void) = default;

    bool rvalue_ok (void) const { return true; }

    tree_expression * dup (symbol_scope& scope) const;

    octave_value evaluate (tree_evaluator&, int nargout = 1);

    octave_value_list evaluate_n (tree_evaluator& tw, int nargout = 1)
    {
      return ovl (evaluate (tw, nargout));
    }

    void accept (tree_walker& tw)
    {
      tw.visit_postfix_expression (*this);
    }

    std::string profiler_name (void) const { return "postfix " + oper (); }
  };
}

#endif