// Copyright (C) 2019-2026 Provable Inc.
// This file is part of the Leo library.

// The Leo library 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.

// The Leo library 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 the Leo library. If not, see <https://www.gnu.org/licenses/>.

use core::fmt;
use serde::{Deserialize, Serialize};

/// The mode associated with a type.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
pub enum Mode {
    None,
    Constant,
    Private,
    Public,
}

impl Mode {
    /// Are the modes considered equal as far as the Leo user is concerned?
    ///
    /// In particular, `None` defaults to `Private`.
    pub fn eq_user(&self, other: &Mode) -> bool {
        match (self, other) {
            (Self::None | Self::Private, Self::None | Self::Private) => true,
            (a, b) => a == b,
        }
    }
}

impl fmt::Display for Mode {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        use Mode::*;

        match self {
            None => write!(f, ""),
            Constant => write!(f, "constant"),
            Private => write!(f, "private"),
            Public => write!(f, "public"),
        }
    }
}
