cargo-kconfig 0.0.4

/*
 Cargo KConfig - KConfig parser
 Copyright (C) 2022  Sjoerd van Leent

--------------------------------------------------------------------------------

Copyright Notice: Apache

Licensed under the Apache License, Version 2.0 (the "License"); you may not use
this file except in compliance with the License. You may obtain a copy of the
License at

   https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed
under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
CONDITIONS OF ANY KIND, either express or implied. See the License for the
specific language governing permissions and limitations under the License.

--------------------------------------------------------------------------------

Copyright Notice: GPLv2

This program 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 2 of the License, or
(at your option) any later version.

This program 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 this program.  If not, see <https://www.gnu.org/licenses/>.

--------------------------------------------------------------------------------

Copyright Notice: MIT

Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the “Software”), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
the Software, and to permit persons to whom the Software is furnished to do so,
subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/

use std::{collections::HashMap, path::PathBuf};

#[derive(Clone)]
pub enum ClientOpts {
    /// The Set Command has been called
    ConfigSet(ConfigSetOpt),

    /// The Get Command has been called
    ConfigGet(ConfigGetOpt),

    /// The Show Command has been called containing a list of hierarchical
    /// options, starting from the top-level menu, navigating down to the
    /// submenus
    List(Vec<String>),

    /// The Info Command shows the help text of a configuration item entry
    Info(String),

    /// The Update Command updates a configuration item's value with a new
    /// value. Depending on the kind of configuration item, the item can
    /// either be updated by shifting it's value, be updated by input
    /// through the terminal or by input through an editor.
    Update(String),
}

#[derive(Clone)]
pub enum ConfigSetOpt {
    /// Override the Kconfig default filename
    Kconfig(String),

    /// Override the .config default filename
    Dotconfig(String),
}

#[derive(Clone)]
pub enum ConfigGetOpt {
    /// Show all the different options
    List,

    /// Show the used Kconfig file name, shows the default file name, if not altered
    Kconfig,

    /// Show the used .config file name, shows the default file name, if not altered
    Dotconfig,
}

/// This structure represents the configuration set in the.cargo-kconfig
/// file, if available, otherwise represents the defaults.
pub struct CargoKconfigConfig {
    kconfig: PathBuf,
    dotconfig: PathBuf,
}

impl CargoKconfigConfig {
    /// Returns the location of the Kconfig file, typically this would be
    /// the Kconfig file in the current working directory.
    pub fn kconfig(&self) -> PathBuf {
        self.kconfig.clone()
    }

    /// Returns the location of the .config file, typically this would be
    /// the .config file in the current working directory.
    pub fn dotconfig(&self) -> PathBuf {
        self.dotconfig.clone()
    }

    /// Sets the location of the Kconfig file, if it is to deviate from the
    /// default location in the current working directory.
    pub fn set_kconfig(&mut self, v: &PathBuf) {
        self.kconfig = v.clone()
    }

    /// Sets the location of the .config file, if it is to deviate from the
    /// default location in the current working directory.
    pub fn set_dotconfig(&mut self, v: &PathBuf) {
        self.dotconfig = v.clone()
    }
}

impl Default for CargoKconfigConfig {
    /// Returns a default implementation of Self, pointing to the Kconfig
    /// and .config files in the current working directory.
    fn default() -> Self {
        let kconfig = PathBuf::from("Kconfig");
        let dotconfig = PathBuf::from(".config");
        Self { kconfig, dotconfig }
    }
}

impl From<&HashMap<String, String>> for CargoKconfigConfig {
    /// Loads the configuration from a raw interpretation, typically read
    /// from the .cargo-kconfig file in the current working directory.
    fn from(rawentries: &HashMap<String, String>) -> Self {
        let mut new = Self::default();

        for (key, value) in rawentries {
            match key.as_str() {
                "input" => new.kconfig = PathBuf::from(value.clone()),
                "output" => new.dotconfig = PathBuf::from(value.clone()),
                _ => eprintln!("Key {key} is not a valid configuration value"),
            }
        }

        new
    }
}