rust/src/librustc/front/std_inject.rs

// Copyright 2012 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.


use driver::session::Session;

use std::vec;
use syntax::ast;
use syntax::attr;
use syntax::codemap::DUMMY_SP;
use syntax::codemap;
use syntax::fold::Folder;
use syntax::fold;
use syntax::opt_vec;
use syntax::parse::token::InternedString;
use syntax::parse::token;
use syntax::util::small_vector::SmallVector;

pub static VERSION: &'static str = "0.10-pre";

pub fn maybe_inject_crates_ref(sess: Session, crate: ast::Crate)
                               -> ast::Crate {
    if use_std(&crate) {
        inject_crates_ref(sess, crate)
    } else {
        crate
    }
}

pub fn maybe_inject_prelude(sess: Session, crate: ast::Crate) -> ast::Crate {
    if use_std(&crate) {
        inject_prelude(sess, crate)
    } else {
        crate
    }
}

fn use_std(crate: &ast::Crate) -> bool {
    !attr::contains_name(crate.attrs, "no_std")
}

fn use_uv(crate: &ast::Crate) -> bool {
    !attr::contains_name(crate.attrs, "no_uv")
}

fn no_prelude(attrs: &[ast::Attribute]) -> bool {
    attr::contains_name(attrs, "no_implicit_prelude")
}

struct StandardLibraryInjector {
    sess: Session,
}

pub fn with_version(crate: &str) -> Option<(InternedString, ast::StrStyle)> {
    match option_env!("CFG_DISABLE_INJECT_STD_VERSION") {
        Some("1") => None,
        _ => {
            Some((token::intern_and_get_ident(format!("{}\\#{}",
                                                      crate,
                                                      VERSION)),
                  ast::CookedStr))
        }
    }
}

impl fold::Folder for StandardLibraryInjector {
    fn fold_crate(&mut self, crate: ast::Crate) -> ast::Crate {
        let mut vis = ~[ast::ViewItem {
            node: ast::ViewItemExternMod(self.sess.ident_of("std"),
                                         with_version("std"),
                                         ast::DUMMY_NODE_ID),
            attrs: ~[
                attr::mk_attr(attr::mk_list_item(
                        InternedString::new("phase"),
                        ~[
                            attr::mk_word_item(InternedString::new("syntax")),
                            attr::mk_word_item(InternedString::new("link")
                        )]))
            ],
            vis: ast::Inherited,
            span: DUMMY_SP
        }];

        if use_uv(&crate) && !self.sess.building_library.get() {
            vis.push(ast::ViewItem {
                node: ast::ViewItemExternMod(self.sess.ident_of("green"),
                                             with_version("green"),
                                             ast::DUMMY_NODE_ID),
                attrs: ~[],
                vis: ast::Inherited,
                span: DUMMY_SP
            });
            vis.push(ast::ViewItem {
                node: ast::ViewItemExternMod(self.sess.ident_of("rustuv"),
                                             with_version("rustuv"),
                                             ast::DUMMY_NODE_ID),
                attrs: ~[],
                vis: ast::Inherited,
                span: DUMMY_SP
            });
        }

        vis.push_all(crate.module.view_items);
        let new_module = ast::Mod {
            view_items: vis,
            ..crate.module.clone()
        };

        ast::Crate {
            module: new_module,
            ..crate
        }
    }
}

fn inject_crates_ref(sess: Session, crate: ast::Crate) -> ast::Crate {
    let mut fold = StandardLibraryInjector {
        sess: sess,
    };
    fold.fold_crate(crate)
}

struct PreludeInjector {
    sess: Session,
}


impl fold::Folder for PreludeInjector {
    fn fold_crate(&mut self, crate: ast::Crate) -> ast::Crate {
        if !no_prelude(crate.attrs) {
            // only add `use std::prelude::*;` if there wasn't a
            // `#[no_implicit_prelude];` at the crate level.
            ast::Crate {
                module: self.fold_mod(&crate.module),
                ..crate
            }
        } else {
            crate
        }
    }

    fn fold_item(&mut self, item: @ast::Item) -> SmallVector<@ast::Item> {
        if !no_prelude(item.attrs) {
            // only recur if there wasn't `#[no_implicit_prelude];`
            // on this item, i.e. this means that the prelude is not
            // implicitly imported though the whole subtree
            fold::noop_fold_item(item, self)
        } else {
            SmallVector::one(item)
        }
    }

    fn fold_mod(&mut self, module: &ast::Mod) -> ast::Mod {
        let prelude_path = ast::Path {
            span: DUMMY_SP,
            global: false,
            segments: ~[
                ast::PathSegment {
                    identifier: self.sess.ident_of("std"),
                    lifetimes: opt_vec::Empty,
                    types: opt_vec::Empty,
                },
                ast::PathSegment {
                    identifier: self.sess.ident_of("prelude"),
                    lifetimes: opt_vec::Empty,
                    types: opt_vec::Empty,
                },
            ],
        };

        let vp = @codemap::dummy_spanned(ast::ViewPathGlob(prelude_path, ast::DUMMY_NODE_ID));
        let vi2 = ast::ViewItem {
            node: ast::ViewItemUse(~[vp]),
            attrs: ~[],
            vis: ast::Inherited,
            span: DUMMY_SP,
        };

        let vis = vec::append(~[vi2], module.view_items);

        // FIXME #2543: Bad copy.
        let new_module = ast::Mod {
            view_items: vis,
            ..(*module).clone()
        };
        fold::noop_fold_mod(&new_module, self)
    }
}

fn inject_prelude(sess: Session, crate: ast::Crate) -> ast::Crate {
    let mut fold = PreludeInjector {
        sess: sess,
    };
    fold.fold_crate(crate)
}