context.rs

// Copyright 2013 The Rust Project Developers. See the COPYRIGHT
// file at the top-level directory of this distribution and at
// http://rust-lang.org/COPYRIGHT.
//
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
// option. This file may not be copied, modified, or distributed
// except according to those terms.

// Context data structure used by rustpkg

use extra::workcache;
use rustc::driver::session;
use rustc::metadata::filesearch::rustlibdir;

use std::hashmap::HashSet;

#[deriving(Clone)]
pub struct Context {
    // Config strings that the user passed in with --cfg
    cfgs: ~[~str],
    // Flags to pass to rustc
    rustc_flags: RustcFlags,
    // If use_rust_path_hack is true, rustpkg searches for sources
    // in *package* directories that are in the RUST_PATH (for example,
    // FOO/src/bar-0.1 instead of FOO). The flag doesn't affect where
    // rustpkg stores build artifacts.
    use_rust_path_hack: bool,
}

#[deriving(Clone)]
pub struct BuildContext {
    // Context for workcache
    workcache_context: workcache::Context,
    // Parsed command line options
    context: Context,
    // The root directory containing the Rust standard libraries
    sysroot: Path
}

impl BuildContext {
    pub fn sysroot(&self) -> Path {
        self.sysroot.clone()
    }

    // Hack so that rustpkg can run either out of a rustc target dir,
    // or the host dir
    pub fn sysroot_to_use(&self) -> Path {
        if !in_target(&self.sysroot) {
            self.sysroot.clone()
        } else {
            let mut p = self.sysroot.clone();
            p.pop();
            p.pop();
            p.pop();
            p
        }
    }

    /// Returns the flags to pass to rustc, as a vector of strings
    pub fn flag_strs(&self) -> ~[~str] {
        self.context.flag_strs()
    }

    pub fn compile_upto(&self) -> StopBefore {
        self.context.compile_upto()
    }

    pub fn add_library_path(&mut self, p: Path) {
        debug!("Adding library path: {}", p.display());
        self.context.add_library_path(p);
    }

    pub fn additional_library_paths(&self) -> HashSet<Path> {
        self.context.rustc_flags.additional_library_paths.clone()
    }
}

/*
Deliberately unsupported rustc flags:
   --bin, --lib           inferred from crate file names
   -L                     inferred from extern mods
   --out-dir              inferred from RUST_PATH
   --test                 use `rustpkg test`
   -v -h --ls             don't make sense with rustpkg
   -W -A -D -F -          use pragmas instead

rustc flags that aren't implemented yet:
   --passes
   --llvm-arg
   --target-feature
   --android-cross-path
*/
pub struct RustcFlags {
    compile_upto: StopBefore,
    // Linker to use with the --linker flag
    linker: Option<~str>,
    // Extra arguments to pass to rustc with the --link-args flag
    link_args: Option<~str>,
    // Optimization level. 0 = default. -O = 2.
    optimization_level: session::OptLevel,
    // True if the user passed in --save-temps
    save_temps: bool,
    // Target (defaults to rustc's default target)
    target: Option<~str>,
    // Target CPU (defaults to rustc's default target CPU)
    target_cpu: Option<~str>,
    // Additional library directories, which get passed with the -L flag
    // This can't be set with a rustpkg flag, only from package scripts
    additional_library_paths: HashSet<Path>,
    // Any -Z features
    experimental_features: Option<~[~str]>
}

impl Clone for RustcFlags {
    fn clone(&self) -> RustcFlags {
        RustcFlags {
            compile_upto: self.compile_upto,
            linker: self.linker.clone(),
            link_args: self.link_args.clone(),
            optimization_level: self.optimization_level,
            save_temps: self.save_temps,
            target: self.target.clone(),
            target_cpu: self.target_cpu.clone(),
            additional_library_paths: self.additional_library_paths.clone(),
            experimental_features: self.experimental_features.clone()
        }
    }
}

#[deriving(Eq)]
pub enum StopBefore {
    Nothing,  // compile everything
    Link,     // --no-link
    LLVMCompileBitcode, // --emit-llvm without -S
    LLVMAssemble, // -S --emit-llvm
    Assemble, // -S without --emit-llvm
    Trans,    // --no-trans
    Pretty,   // --pretty
    Analysis, // --parse-only
}

impl Context {

    /// Returns the flags to pass to rustc, as a vector of strings
    pub fn flag_strs(&self) -> ~[~str] {
        self.rustc_flags.flag_strs()
    }

    pub fn compile_upto(&self) -> StopBefore {
        self.rustc_flags.compile_upto
    }

    pub fn add_library_path(&mut self, p: Path) {
        self.rustc_flags.additional_library_paths.insert(p);
    }
}

/// We assume that if ../../rustlib exists, then we're running
/// rustpkg from a Rust target directory. This is part of a
/// kludgy hack used to adjust the sysroot.
pub fn in_target(sysroot: &Path) -> bool {
    debug!("Checking whether {} is in target", sysroot.display());
    let mut p = sysroot.dir_path();
    p.set_filename(rustlibdir());
    p.is_dir()
}

impl RustcFlags {
    fn flag_strs(&self) -> ~[~str] {
        let linker_flag = match self.linker {
            Some(ref l) => ~[~"--linker", l.clone()],
            None    => ~[]
        };
        let link_args_flag = match self.link_args {
            Some(ref l) => ~[~"--link-args", l.clone()],
            None        => ~[]
        };
        let save_temps_flag = if self.save_temps { ~[~"--save-temps"] } else { ~[] };
        let target_flag = match self.target {
            Some(ref l) => ~[~"--target", l.clone()],
            None        => ~[]
        };
        let target_cpu_flag = match self.target_cpu {
            Some(ref l) => ~[~"--target-cpu", l.clone()],
            None        => ~[]
        };
        let z_flags = match self.experimental_features {
            Some(ref ls)    => ls.flat_map(|s| ~[~"-Z", s.clone()]),
            None            => ~[]
        };
        linker_flag
            + link_args_flag
            + save_temps_flag
            + target_flag
            + target_cpu_flag
            + z_flags + (match self.compile_upto {
            LLVMCompileBitcode => ~[~"--emit-llvm"],
            LLVMAssemble => ~[~"--emit-llvm", ~"-S"],
            Link => ~[~"-c"],
            Trans => ~[~"--no-trans"],
            Assemble => ~[~"-S"],
            // n.b. Doesn't support all flavors of --pretty (yet)
            Pretty => ~[~"--pretty"],
            Analysis => ~[~"--parse-only"],
            Nothing => ~[]
        })
    }

    pub fn default() -> RustcFlags {
        RustcFlags {
            linker: None,
            link_args: None,
            compile_upto: Nothing,
            optimization_level: session::Default,
            save_temps: false,
            target: None,
            target_cpu: None,
            additional_library_paths: HashSet::new(),
            experimental_features: None
        }
    }
}


#[deriving(Eq)]
pub enum Command {
    BuildCmd,
    CleanCmd,
    DoCmd,
    HelpCmd,
    InfoCmd,
    InitCmd,
    InstallCmd,
    ListCmd,
    PreferCmd,
    TestCmd,
    UninstallCmd,
    UnpreferCmd,
}

impl FromStr for Command {

    fn from_str(s: &str) -> Option<Command>  {
       match s {
            &"build" => Some(BuildCmd),
            &"clean" => Some(CleanCmd),
            &"do" => Some(DoCmd),
            &"help" => Some(HelpCmd),
            &"info" => Some(InfoCmd),
            &"install" => Some(InstallCmd),
            &"list"    => Some(ListCmd),
            &"prefer" => Some(PreferCmd),
            &"test" => Some(TestCmd),
            &"init" => Some(InitCmd),
            &"uninstall" => Some(UninstallCmd),
            &"unprefer" => Some(UnpreferCmd),
            _ => None
        }
    }
}

/// Returns true if any of the flags given are incompatible with the cmd
pub fn flags_forbidden_for_cmd(flags: &RustcFlags,
                        cfgs: &[~str],
                        cmd: Command, user_supplied_opt_level: bool) -> bool {
    let complain = |s| {
        println!("The {} option can only be used with the `build` command:
                  rustpkg [options..] build {} [package-ID]", s, s);
    };

    if flags.linker.is_some() && cmd != BuildCmd && cmd != InstallCmd {
        println("The --linker option can only be used with the build or install commands.");
        return true;
    }
    if flags.link_args.is_some() && cmd != BuildCmd && cmd != InstallCmd {
        println("The --link-args option can only be used with the build or install commands.");
        return true;
    }

    if !cfgs.is_empty() && cmd != BuildCmd && cmd != InstallCmd && cmd != TestCmd {
        println("The --cfg option can only be used with the build, test, or install commands.");
        return true;
    }

    if user_supplied_opt_level && cmd != BuildCmd && cmd != InstallCmd {
        println("The -O and --opt-level options can only be used with the build \
                    or install commands.");
        return true;
    }

    if flags.save_temps  && cmd != BuildCmd && cmd != InstallCmd {
        println("The --save-temps option can only be used with the build \
                    or install commands.");
        return true;
    }

    if flags.target.is_some()  && cmd != BuildCmd && cmd != InstallCmd {
        println("The --target option can only be used with the build \
                    or install commands.");
        return true;
    }
    if flags.target_cpu.is_some()  && cmd != BuildCmd && cmd != InstallCmd {
        println("The --target-cpu option can only be used with the build \
                    or install commands.");
        return true;
    }
    if flags.experimental_features.is_some() && cmd != BuildCmd && cmd != InstallCmd {
        println("The -Z option can only be used with the build or install commands.");
        return true;
    }

    match flags.compile_upto {
        Link if cmd != BuildCmd => {
            complain("--no-link");
            true
        }
        Trans if cmd != BuildCmd => {
            complain("--no-trans");
            true
        }
        Assemble if cmd != BuildCmd => {
            complain("-S");
            true
        }
        Pretty if cmd != BuildCmd => {
            complain("--pretty");
            true
        }
        Analysis if cmd != BuildCmd => {
            complain("--parse-only");
            true
        }
        LLVMCompileBitcode if cmd != BuildCmd => {
            complain("--emit-llvm");
            true
        }
        LLVMAssemble if cmd != BuildCmd => {
            complain("--emit-llvm");
            true
        }
        _ => false
    }
}