librustc_trans and librustdoc: add license::print().

The license document is compressed by DEFLATE and then stored as
pub const license::text::COPYRIGHT of type &'static [u8].
A helper script src/etc/license2rs.sh takes care of updating it.

It is decompressed by flate::inflate_bytes() on runtime.

Fix rust-lang#17690

Signed-off-by: NODA, Kai <[email protected]>

Author: nodakai

AUTHORS.txt

@@ -672,3 +672,5 @@ xales <[email protected]>
 zofrex <[email protected]>
 zslayton <[email protected]>
 zzmp <[email protected]>
+
+Run src/etc/copyright2rs.sh to embed this file to rustc.

COPYRIGHT

@@ -478,3 +478,5 @@ their own copyright notices and license terms:
   has chosen for the collective work, enumerated at the top
   of this file. The only difference is the retention of
   copyright itself, held by the contributor.
+
+Run src/etc/copyright2rs.sh to embed this file to rustc.

mk/crates.mk

@@ -73,7 +73,7 @@ DEPS_rustc := syntax flate arena serialize getopts rbml \
 DEPS_rustc_llvm := native:rustllvm libc std
 DEPS_rustc_back := std syntax rustc_llvm flate log libc
 DEPS_rustdoc := rustc rustc_trans native:hoedown serialize getopts \
-                test time
+                test time flate
 DEPS_flate := std native:miniz
 DEPS_arena := std
 DEPS_graphviz := std

src/etc/copyright2rs.sh

@@ -0,0 +1,121 @@
+#! /bin/sh
+
+# 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.
+
+set -e
+
+clean_tmp() {
+    if [ -n "$g_outf" ]; then
+        echo "ERROR: failed to create \"$g_outf\""
+    fi
+    if [ -d "$g_tmpdir" -a -O "$g_tmpdir" ]; then
+        echo "Cleanup: rm -rf \"$g_tmpdir\""
+        rm -rf "$g_tmpdir" && exit 0
+    fi
+    echo "WARNING: could not remove \"$g_tmpdir\""
+}
+
+trap clean_tmp EXIT;
+
+check_file() {
+    infile=$1
+    if [ ! -r "$infile" ]; then
+        echo "ERROR: could not find file \"$infile\" which should be in the top directory."
+        echo "Did you run this script in the top directory?"
+        exit 10
+    fi
+}
+
+git_final_commit() {
+    infile=$1
+    echo "// git log -n1 '$infile'"
+    # don't use "--" so that git returns an error
+    git log -n1 "$infile" > /dev/null || { echo "ERROR: failed to run git" >&2 ; exit 30; }
+    git log -n1 "$infile" | while read line; do
+        if [ -n "$line" ]; then
+            echo "// $line"
+        else
+            echo //
+        fi
+    done
+    echo
+}
+
+generate() {
+    g_outf=$1
+
+    tmpoutf=$g_tmpdir/$g_outf
+    tmpcomb=$g_tmpdir/combined.txt
+    tmpdeflate=$g_tmpdir/deflate.dat
+    tmpod=$g_tmpdir/deflate.od.txt
+    tmparr=$g_tmpdir/deflate.od.sed.txt
+
+    mkdir -p ${tmpoutf%/*}
+
+    check_file COPYRIGHT
+    check_file LICENSE-MIT
+    check_file LICENSE-APACHE
+    check_file AUTHORS.txt
+
+    # Open a temporary output file.
+    # It will be (atomically) renamed to the final output file.
+    exec 3>"$tmpoutf"
+    cat >&3 <<EOS
+// 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.
+
+EOS
+    echo "// This file (text.rs) was generated by src/etc/copyright2rs.sh at" >&3
+    echo "// $(date -R)" >&3
+    echo >&3
+
+    git_final_commit COPYRIGHT >&3
+    git_final_commit AUTHORS.txt >&3
+
+    echo "pub const COPYRIGHT: &'static [u8] = &[" >&3
+
+    # Process each step w/o pipe so that "-e" can catch an error in intermediate step.s
+    cat > "$tmpcomb" <<EOS
+Four license documents COPYRIGHT, LICENSE-MIT, LICENSE-APACHE, and
+AUTHORS.txt combined as one:
+
+EOS
+    for f in COPYRIGHT LICENSE-MIT LICENSE-APACHE AUTHORS.txt; do
+        echo "---- $f ----" >> "$tmpcomb"
+        cat "$f" >> "$tmpcomb"
+        echo >> "$tmpcomb"
+    done
+    python -c 'import sys,zlib; sys.stdout.write(zlib.compress(sys.stdin.read(), 9))' \
+        < "$tmpcomb" > "$tmpdeflate"
+    od -t x1 -A n < "$tmpdeflate" > "$tmpod"
+    sed -re 's/ (\w+)/0x\1,/g' < "$tmpod" >&3
+    echo "];" >&3
+    exec 3<&-
+
+    mv "$tmpoutf" "$g_outf"
+    echo "Successfully generated \"$g_outf\""
+    g_outf=''
+}
+
+main() {
+    g_tmpdir=$(mktemp -d) || { echo "ERROR: mktemp(1) failed to create a temp directory"; exit 5; }
+    echo "Created a temp dir \"$g_tmpdir\""
+
+    generate src/librustc_trans/driver/license/text.rs
+    generate src/librustdoc/license/text.rs
+}
+
+main

src/librustc/session/config.rs

@@ -572,6 +572,7 @@ pub fn build_target_config(opts: &Options, sp: &SpanHandler) -> Config {
 pub fn optgroups() -> Vec<getopts::OptGroup> {
     vec!(
         optflag("h", "help", "Display this message"),
+        optflag("", "license", "Display license documents"),
         optmulti("", "cfg", "Configure the compilation environment", "SPEC"),
         optmulti("L", "",   "Add a directory to the library search path", "PATH"),
         optmulti("l", "",   "Link the generated crate(s) to the specified native
@@ -631,7 +632,7 @@ pub fn optgroups() -> Vec<getopts::OptGroup> {
             always = always colorize output;
             never  = never colorize output", "auto|always|never"),
         optmulti("", "extern", "Specify where an external rust library is located",
-                 "NAME=PATH"),
+                 "NAME=PATH")
     )
 }
 

src/librustc_trans/driver/license/mod.rs

@@ -0,0 +1,13 @@
+use std::io::{Writer, IoResult, IoError};
+use std::io::IoErrorKind::InvalidInput;
+use flate;
+
+mod text;
+
+pub fn print(out: &mut Writer) -> IoResult<()> {
+    match flate::inflate_bytes_zlib(text::COPYRIGHT) {
+        Some(dat) => out.write(dat.as_slice()),
+        None => Err(IoError { kind: InvalidInput, desc: "decompression error of the COPYRIGHT file",
+                              detail: None })
+    }
+}