/*
  This file is part of LilyPond, the GNU music typesetter.

  Copyright (C) 1997--2026 Han-Wen Nienhuys <hanwen@xs4all.nl>

  LilyPond 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.

  LilyPond 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 LilyPond.  If not, see <http://www.gnu.org/licenses/>.
*/

#ifndef DIRECTION_HH
#define DIRECTION_HH

#include <algorithm>
#include <cmath>

// a direction on an unspecified axis, represented as {-1, 0, 1}
class Direction final
{
public:
  constexpr Direction () = default;

  // Create a Direction from the sign of the input.

  constexpr explicit Direction (int x)
    : Direction (static_cast<long long> (x))
  {
  }

  constexpr explicit Direction (long x)
    : Direction (static_cast<long long> (x))
  {
  }

  constexpr explicit Direction (long long x)
    : val_ (x ? ((x < 0) ? -1 : 1) : 0)
  {
  }

  explicit Direction (const double &x)
    : val_ ((x != 0.0) ? (std::signbit (x) ? -1 : 1) : 0)
  {
  }

  static constexpr Direction negative () { return Direction (-1); }
  static constexpr Direction positive () { return Direction (1); }
  static constexpr Direction zero () { return Direction (0); }

  // Direction is copiable
  Direction (const Direction &) = default;
  Direction &operator= (const Direction &) & = default;

  // Implicit conversion to int keeps legacy code working, but it has its
  // quirks.  All of these are true:
  //
  //     Direction (1) == 1
  //     Direction (2) != 2
  //     Direction (2) == 1
  //
  constexpr operator int () const { return val_; }

  // unary minus reverses the direction
  constexpr Direction operator- () const { return Direction (-val_); }

  // unary plus is implemented for symmetry
  constexpr Direction operator+ () const { return *this; }

  // Multiplying two directions maintains the type as a Direction.  Multiplying
  // by other types is supported via implicit conversion of Direction to int.
  constexpr Direction operator* (Direction other) const
  {
    return Direction (val_ * other.val_);
  }

  constexpr Direction &operator*= (Direction other) &
  {
    return (*this = (*this) * other);
  }

  // convert to a zero-based index: {negative->0, zero->1, positive->2}
  constexpr size_t to_index () const { return static_cast<size_t> (val_ + 1); }

private:
  int val_ = 0;
};

// the directions are opposite and nonzero
constexpr bool
directed_opposite (Direction a, Direction b)
{
  return (a * b) < Direction::zero ();
}

// the directions are equal and nonzero
constexpr bool
directed_same (Direction a, Direction b)
{
  return (a * b) > Direction::zero ();
}

/**
   if d > 0: the max operator
   if d < 0: the min operator
*/
template <class T>
constexpr T
minmax (Direction d, T a, T b)
{
  if (d == Direction::positive ())
    return std::max (a, b);
  else
    return std::min (a, b);
}

inline constexpr auto UP = Direction::positive ();
inline constexpr auto DOWN = Direction::negative ();
inline constexpr auto LEFT = Direction::negative ();
inline constexpr auto RIGHT = Direction::positive ();
inline constexpr auto CENTER = Direction::zero ();
inline constexpr auto SMALLER = Direction::negative ();
inline constexpr auto BIGGER = Direction::positive ();
inline constexpr auto START = Direction::negative ();
inline constexpr auto STOP = Direction::positive ();

#endif // DIRECTION_HH
