about summary refs log tree commit diff
path: root/src/librustdoc/attr_parser.rs
diff options
context:
space:
mode:
Diffstat (limited to 'src/librustdoc/attr_parser.rs')
-rw-r--r--src/librustdoc/attr_parser.rs149
1 files changed, 0 insertions, 149 deletions
diff --git a/src/librustdoc/attr_parser.rs b/src/librustdoc/attr_parser.rs
deleted file mode 100644
index ce8d1977443..00000000000
--- a/src/librustdoc/attr_parser.rs
+++ /dev/null
@@ -1,149 +0,0 @@
-// Copyright 2012-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.
-
-/*!
-Attribute parsing
-
-The attribute parser provides methods for pulling documentation out of
-an AST's attributes.
-*/
-
-
-use syntax::ast;
-use syntax::attr;
-use syntax::attr::{AttrMetaMethods, AttributeMethods};
-
-pub struct CrateAttrs {
-    name: Option<~str>
-}
-
-fn doc_metas(attrs: ~[ast::Attribute]) -> ~[@ast::MetaItem] {
-    attrs.iter()
-        .filter(|at| "doc" == at.name())
-        .map(|at| at.desugar_doc().meta())
-        .collect()
-}
-
-pub fn parse_crate(attrs: ~[ast::Attribute]) -> CrateAttrs {
-    let link_metas = attr::find_linkage_metas(attrs);
-    let name = attr::last_meta_item_value_str_by_name(link_metas, "name");
-
-    CrateAttrs {
-        name: name.map(|s| s.to_owned())
-    }
-}
-
-pub fn parse_desc(attrs: ~[ast::Attribute]) -> Option<~str> {
-    let doc_strs = do doc_metas(attrs).move_iter().filter_map |meta| {
-        meta.value_str()
-    }.collect::<~[@str]>();
-    if doc_strs.is_empty() {
-        None
-    } else {
-        Some(doc_strs.connect("\n"))
-    }
-}
-
-pub fn parse_hidden(attrs: ~[ast::Attribute]) -> bool {
-    let r = doc_metas(attrs);
-    do r.iter().any |meta| {
-        match meta.meta_item_list() {
-            Some(metas) => attr::contains_name(metas, "hidden"),
-            None => false
-        }
-    }
-}
-
-#[cfg(test)]
-mod test {
-    use syntax::ast;
-    use syntax;
-    use super::{parse_hidden, parse_crate, parse_desc};
-
-    fn parse_attributes(source: @str) -> ~[ast::Attribute] {
-        use syntax::parse;
-        use syntax::parse::attr::parser_attr;
-
-        let parse_sess = syntax::parse::new_parse_sess(None);
-        let parser = parse::new_parser_from_source_str(
-            parse_sess, ~[], @"-", source);
-
-        parser.parse_outer_attributes()
-    }
-
-
-    #[test]
-    fn should_extract_crate_name_from_link_attribute() {
-        let source = @"#[link(name = \"snuggles\")]";
-        let attrs = parse_attributes(source);
-        let attrs = parse_crate(attrs);
-        assert!(attrs.name == Some(~"snuggles"));
-    }
-
-    #[test]
-    fn should_not_extract_crate_name_if_no_link_attribute() {
-        let source = @"";
-        let attrs = parse_attributes(source);
-        let attrs = parse_crate(attrs);
-        assert!(attrs.name == None);
-    }
-
-    #[test]
-    fn should_not_extract_crate_name_if_no_name_value_in_link_attribute() {
-        let source = @"#[link(whatever)]";
-        let attrs = parse_attributes(source);
-        let attrs = parse_crate(attrs);
-        assert!(attrs.name == None);
-    }
-
-    #[test]
-    fn parse_desc_should_handle_undocumented_mods() {
-        let source = @"";
-        let attrs = parse_attributes(source);
-        let attrs = parse_desc(attrs);
-        assert!(attrs == None);
-    }
-
-    #[test]
-    fn parse_desc_should_parse_simple_doc_attributes() {
-        let source = @"#[doc = \"basic\"]";
-        let attrs = parse_attributes(source);
-        let attrs = parse_desc(attrs);
-        assert!(attrs == Some(~"basic"));
-    }
-
-    #[test]
-    fn should_parse_hidden_attribute() {
-        let source = @"#[doc(hidden)]";
-        let attrs = parse_attributes(source);
-        assert!(parse_hidden(attrs) == true);
-    }
-
-    #[test]
-    fn should_parse_hidden_attribute_with_other_docs() {
-        let source = @"#[doc = \"foo\"] #[doc(hidden)] #[doc = \"foo\"]";
-        let attrs = parse_attributes(source);
-        assert!(parse_hidden(attrs) == true);
-    }
-
-    #[test]
-    fn should_not_parse_non_hidden_attribute() {
-        let source = @"#[doc = \"\"]";
-        let attrs = parse_attributes(source);
-        assert!(parse_hidden(attrs) == false);
-    }
-
-    #[test]
-    fn should_concatenate_multiple_doc_comments() {
-        let source = @"/// foo\n/// bar";
-        let desc = parse_desc(parse_attributes(source));
-        assert!(desc == Some(~" foo\n bar"));
-    }
-}