Skip to content

Commit

Permalink
libsyntax: librustdoc: ignore utf-8 BOM in .rs files
Browse files Browse the repository at this point in the history
Closes #12974
  • Loading branch information
liigo authored and alexcrichton committed Mar 18, 2014
1 parent 8f7a797 commit 20e178c
Show file tree
Hide file tree
Showing 3 changed files with 31 additions and 2 deletions.
9 changes: 8 additions & 1 deletion src/librustdoc/html/render.rs
Expand Up @@ -463,6 +463,13 @@ impl<'a> SourceCollector<'a> {
};
let contents = str::from_utf8_owned(contents).unwrap();

// Remove the utf-8 BOM if any
let contents = if contents.starts_with("\ufeff") {
contents.as_slice().slice_from(3)
} else {
contents.as_slice()
};

// Create the intermediate directories
let mut cur = self.dst.clone();
let mut root_path = ~"../../";
Expand All @@ -482,7 +489,7 @@ impl<'a> SourceCollector<'a> {
root_path: root_path,
};
try!(layout::render(&mut w as &mut Writer, &self.cx.layout,
&page, &(""), &Source(contents.as_slice())));
&page, &(""), &Source(contents)));
try!(w.flush());
return Ok(());
}
Expand Down
11 changes: 10 additions & 1 deletion src/libsyntax/codemap.rs
Expand Up @@ -271,13 +271,22 @@ impl CodeMap {
}
}

pub fn new_filemap(&self, filename: FileName, mut src: ~str) -> Rc<FileMap> {
pub fn new_filemap(&self, filename: FileName, src: ~str) -> Rc<FileMap> {
let mut files = self.files.borrow_mut();
let start_pos = match files.get().last() {
None => 0,
Some(last) => last.deref().start_pos.to_uint() + last.deref().src.len(),
};

// Remove utf-8 BOM if any.
// FIXME #12884: no efficient/safe way to remove from the start of a string
// and reuse the allocation.
let mut src = if src.starts_with("\ufeff") {
src.as_slice().slice_from(3).into_owned()
} else {
src
};

// Append '\n' in case it's not already there.
// This is a workaround to prevent CodeMap.lookup_filemap_idx from accidentally
// overflowing into the next filemap in case the last byte of span is also the last
Expand Down
13 changes: 13 additions & 0 deletions src/test/run-pass/utf8-bom.rs
@@ -0,0 +1,13 @@
// Copyright 2014 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.

// This file has utf-8 BOM, it should be compiled normally without error.

pub fn main() {}

0 comments on commit 20e178c

Please sign in to comment.