########################################################################
##
## Copyright (C) 2010-2026 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/>.
##
########################################################################

## -*- texinfo -*-
## @deftypefn {} {@var{style} =} __next_line_style__ (@var{hax})
## Undocumented internal function.
## @end deftypefn

## Return the next line style in the rotation.


function [linestyle, marker] = __next_line_style__ (hax)

  if (nargin == 1)
    ca = hax;
  else
    ca = gca ();
  endif

  styleorder = get (ca, "linestyleorder");
  if (isempty (styleorder))
    linestyle = "-";   # basic line
    marker = "none";   # no marker
    return;
  endif

  if (ischar (styleorder))
    styleorder = cellstr (styleorder);
  endif

  style_idx = fix (get (ca, "linestyleorderindex"));
  num_styles = rows (styleorder);
  style_idx = mod (style_idx, num_styles);
  if (style_idx == 0)
    style_idx = num_styles;
  elseif (style_idx < 0)
    style_idx = 1;
  endif

  options = __pltopt__ ("__next_line_style__", styleorder{style_idx});
  linestyle = options.linestyle;
  marker = options.marker;

endfunction


%!test
%! hf = figure ("visible", "off");
%! unwind_protect
%!   hax = axes ();
%!   set (hax, "colororder", [0 0 1]);
%!   set (hax, "linestyleorder", {"-", ":", "--"});
%!   hold on;
%!   h = plot (1:2,1:2, 2:3,2:3, 3:4,3:4);
%!   assert (get (h, "linestyle"), {"-"; ":"; "--"});
%!   cla (hax);
%!   hold on;
%!   h1 = plot (1:2,1:2);
%!   h2 = plot (2:3,2:3);
%!   h3 = plot (3:4,3:4);
%!   assert (get ([h1;h2;h3], "linestyle"), {"-"; ":"; "--"});
%! unwind_protect_cleanup
%!   close (hf);
%! end_unwind_protect
