////////////////////////////////////////////////////////////////////////
//
// 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_ov_colon_h)
#define octave_ov_colon_h 1

#include "octave-config.h"

#include <cstdlib>

#include <iosfwd>
#include <string>

#include "mx-base.h"
#include "str-vec.h"

#include "error.h"
#include "ov-base.h"
#include "ov-typeinfo.h"

class octave_value_list;

// A type to represent ':' as used for indexing.

class octave_magic_colon : public octave_base_value
{
public:

  octave_magic_colon ()
    : octave_base_value () { }

  octave_magic_colon (const octave_magic_colon&)
    : octave_base_value () { }

  ~octave_magic_colon () = default;

  octave_base_value * clone () const
  { return new octave_magic_colon (*this); }
  octave_base_value * empty_clone () const
  { return new octave_magic_colon (); }

  octave::idx_vector index_vector (bool /* require_integers */ = false) const
  { return octave::idx_vector (':'); }

  bool is_defined () const { return true; }

  bool is_constant () const { return true; }

  bool is_magic_colon () const { return true; }

  OCTINTERP_API void print (std::ostream& os, bool pr_as_read_syntax = false);

  OCTINTERP_API void print_raw (std::ostream& os,
                                bool pr_as_read_syntax = false) const;

#if defined (OCTAVE_ENABLE_BYTECODE_EVALUATOR)

  octave_base_value::vm_call_dispatch_type vm_dispatch_call ()
  {
    return vm_call_dispatch_type::OCT_SUBSREF;
  }

#endif

private:

  DECLARE_OV_TYPEID_FUNCTIONS_AND_DATA_API (OCTINTERP_API)
};

#endif