ucg/src/convert/flags.rs

// Copyright 2017 Jeremy Wall <jeremy@marzhillstudios.com>
//
//  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
//
//      http://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.

//! Contains code for converting a UCG Val into the command line flag output target.
use std::io::Write;
use std::rc::Rc;

use crate::build::Val;
use crate::convert::traits::{ConvertResult, Converter};
use crate::error::{BuildError, ErrorType};

/// FlagConverter implements the conversion logic for converting a Val into a set
/// of command line flags.
pub struct FlagConverter {
    sep: &'static str,
}

impl FlagConverter {
    pub fn new() -> Self {
        FlagConverter { sep: "." }
    }

    pub fn with_sep(mut self, sep: &'static str) -> Self {
        self.sep = sep;
        self
    }

    fn write_flag_name(&self, pfx: &str, name: &str, w: &mut Write) -> ConvertResult {
        if name.chars().count() > 1 || pfx.chars().count() > 0 {
            write!(w, "--{}{} ", pfx, name)?;
        } else {
            write!(w, "-{} ", name)?;
        }
        return Ok(());
    }

    fn write_list_flag(
        &self,
        pfx: &str,
        name: &str,
        def: &Vec<Rc<Val>>,
        w: &mut Write,
    ) -> ConvertResult {
        // first of all we need to make sure that each &Val is only a primitive type.
        for v in def.iter() {
            let vref = v.as_ref();
            if vref.is_list() || vref.is_tuple() || vref.is_func() || vref.is_module() {
                eprintln!(
                    "Skipping non primitive val in list for flag {}{}",
                    pfx, name
                );
            } else {
                self.write_flag_name(pfx, name, w)?;
                self.write_simple_value(vref, w)?;
            }
        }
        return Ok(());
    }

    fn write_simple_value(&self, v: &Val, w: &mut Write) -> ConvertResult {
        match v {
            &Val::Empty => {
                // Empty is a noop.
                return Ok(());
            }
            &Val::Boolean(b) => {
                write!(w, "{} ", if b { "true" } else { "false" })?;
            }
            &Val::Float(ref f) => {
                write!(w, "{} ", f)?;
            }
            &Val::Int(ref i) => {
                write!(w, "{} ", i)?;
            }
            &Val::Str(ref s) => {
                write!(w, "'{}' ", s)?;
            }
            &Val::List(_) | &Val::Tuple(_) | &Val::Func(_) | &Val::Env(_) | &Val::Module(_) => {
                // This is ignored
                eprintln!("Skipping {}...", v.type_name());
            }
        }
        Ok(())
    }

    fn write(&self, pfx: &str, flds: &Vec<(String, Rc<Val>)>, w: &mut Write) -> ConvertResult {
        for &(ref name, ref val) in flds.iter() {
            if let &Val::Empty = val.as_ref() {
                self.write_flag_name(pfx, name, w)?;
                continue;
            }
            match val.as_ref() {
                &Val::Tuple(_) | &Val::Module(_) | &Val::Func(_) | &Val::Env(_) => {
                    eprintln!("Skipping {} in flag output tuple.", val.type_name());
                }
                &Val::List(ref def) => {
                    self.write_list_flag(pfx, name, def, w)?;
                }
                &Val::Boolean(_) | &Val::Empty | &Val::Float(_) | &Val::Int(_) | &Val::Str(_) => {
                    self.write_flag_name(pfx, name, w)?;
                    self.write_simple_value(val, w)?;
                }
            }
        }
        Ok(())
    }
}

impl Converter for FlagConverter {
    fn convert(&self, v: Rc<Val>, mut w: &mut Write) -> ConvertResult {
        if let &Val::Tuple(ref flds) = v.as_ref() {
            self.write("", flds, &mut w)
        } else {
            return Err(Box::new(BuildError::new(
                "Flag outputs must be a tuple",
                ErrorType::ConvertError,
            )));
        }
    }

    fn file_ext(&self) -> String {
        String::from("txt")
    }

    fn description(&self) -> String {
        "Convert ucg Vals into command line flags.".to_string()
    }

    #[allow(unused_must_use)]
    fn help(&self) -> String {
        include_str!("flags_help.txt").to_string()
    }
}