Files
archived-winres/lib.rs
Max Resch 34c43c8243 Merge pull request #16 from gliheng/master
set_icon support an optional nameId
2019-03-25 08:09:19 +01:00

644 lines
24 KiB
Rust

//! Rust Windows resource helper
//!
//! This crate implements a simple generator for Windows resource (.rc) files
//! for use with either Microsoft `rc.exe` resource compiler or with GNU `windres.exe`
//!
//! The [`WindowsResorce::compile()`] method is intended to be used from a build script and
//! needs environment variables from cargo to be set. It not only compiles the resource
//! but directs cargo to link the resource compiler's output.
//!
//! # Example
//!
//! ```rust
//! # extern crate winres;
//! # use std::io;
//! # fn test_main() -> io::Result<()> {
//! if cfg!(target_os = "windows") {
//! let mut res = winres::WindowsResource::new();
//! res.set_icon("test.ico")
//! # .set_output_directory(".")
//! .set("InternalName", "TEST.EXE")
//! // manually set version 1.0.0.0
//! .set_version_info(winres::VersionInfo::PRODUCTVERSION, 0x0001000000000000);
//! res.compile()?;
//! }
//! # Ok(())
//! # }
//! ```
//!
//! # Defaults
//!
//! We try to guess some sensible default values from Cargo's build time environement variables
//! This is described in [`WindowsResource::new()`]. Furthermore we have to know where to find the
//! resource compiler for the MSVC Toolkit. This can be done by looking up a registry key but
//! for MinGW this has to be done manually.
//!
//! The following paths are the hardcoded defaults:
//! MSVC the last registry key at
//! `HKLM\SOFTWARE\Microsoft\Windows Kits\Installed Roots`, for MinGW we try our luck by simply
//! using the `%PATH%` environment variable.
//!
//! Note that the toolkit bitness as to match the one from the current Rust compiler. If you are
//! using Rust GNU 64-bit you have to use MinGW64. For MSVC this is simpler as (recent) Windows
//! SDK always installs both versions on a 64-bit system.
//!
//! [`WindowsResorce::compile()`]: struct.WindowsResource.html#method.compile
//! [`WindowsResource::new()`]: struct.WindowsResource.html#method.new
use std::env;
use std::path::{PathBuf, Path};
use std::process;
use std::collections::HashMap;
use std::io;
use std::io::prelude::*;
use std::fs;
use std::error::Error;
extern crate toml;
/// Version info field names
#[derive(PartialEq, Eq, Hash, Debug)]
pub enum VersionInfo {
/// The version value consists of four 16 bit words, e.g.,
/// `MAJOR << 48 | MINOR << 32 | PATCH << 16 | RELEASE`
FILEVERSION,
/// The version value consists of four 16 bit words, e.g.,
/// `MAJOR << 48 | MINOR << 32 | PATCH << 16 | RELEASE`
PRODUCTVERSION,
/// Should be Windows NT Win32, with value `0x40004`
FILEOS,
/// The value (for a rust compiler output) should be
/// 1 for a EXE and 2 for a DLL
FILETYPE,
/// Only for Windows drivers
FILESUBTYPE,
/// Bit mask for FILEFLAGS
FILEFLAGSMASK,
/// Only the bits set in FILEFLAGSMASK are read
FILEFLAGS,
}
#[derive(Debug)]
pub struct WindowsResource {
toolkit_path: PathBuf,
properties: HashMap<String, String>,
version_info: HashMap<VersionInfo, u64>,
rc_file: Option<String>,
icon_id: Option<String>,
icon: Option<String>,
language: u16,
manifest: Option<String>,
manifest_file: Option<String>,
output_directory: String,
}
impl WindowsResource {
/// Create a new resource with version info struct
///
///
/// We initialize the resource file with values provided by cargo
///
/// | Field | Cargo / Values |
/// |----------------------|------------------------------|
/// | `"FileVersion"` | `package.version` |
/// | `"ProductVersion"` | `package.version` |
/// | `"ProductName"` | `package.name` |
/// | `"FileDescription"` | `package.description` |
///
/// Furthermore if a section `package.metadata.winres` exists
/// in `Cargo.toml` it will be parsed. Values in this section take precedence
/// over the values provided natively by cargo. Only the string table
/// of the version struct can be set this way.
/// Additionally, the language field is set to neutral (i.e. `0`)
/// and no icon is set. These settings have to be done programmatically.
///
/// `Cargo.toml` files have to be written in UTF-8, so we support all valid UTF-8 strings
/// provided.
///
/// ```,toml
/// #Cargo.toml
/// [package.metadata.winres]
/// OriginalFilename = "testing.exe"
/// FileDescription = "⛄❤☕"
/// LegalCopyright = "Copyright © 2016"
/// ```
///
/// The version info struct is set to some values
/// sensible for creating an executable file.
///
/// | Property | Cargo / Values |
/// |----------------------|------------------------------|
/// | `FILEVERSION` | `package.version` |
/// | `PRODUCTVERSION` | `package.version` |
/// | `FILEOS` | `VOS_NT_WINDOWS32 (0x40004)` |
/// | `FILETYPE` | `VFT_APP (0x1)` |
/// | `FILESUBTYPE` | `VFT2_UNKNOWN (0x0)` |
/// | `FILEFLAGSMASK` | `VS_FFI_FILEFLAGSMASK (0x3F)`|
/// | `FILEFLAGS` | `0x0` |
///
pub fn new() -> Self {
let mut props: HashMap<String, String> = HashMap::new();
let mut ver: HashMap<VersionInfo, u64> = HashMap::new();
props.insert("FileVersion".to_string(),
env::var("CARGO_PKG_VERSION").unwrap().to_string());
props.insert("ProductVersion".to_string(),
env::var("CARGO_PKG_VERSION").unwrap().to_string());
props.insert("ProductName".to_string(),
env::var("CARGO_PKG_NAME").unwrap().to_string());
props.insert("FileDescription".to_string(),
env::var("CARGO_PKG_DESCRIPTION").unwrap().to_string());
parse_cargo_toml(&mut props).unwrap();
let mut version = 0 as u64;
version |= env::var("CARGO_PKG_VERSION_MAJOR").unwrap().parse().unwrap_or(0) << 48;
version |= env::var("CARGO_PKG_VERSION_MINOR").unwrap().parse().unwrap_or(0) << 32;
version |= env::var("CARGO_PKG_VERSION_PATCH").unwrap().parse().unwrap_or(0) << 16;
// version |= env::var("CARGO_PKG_VERSION_PRE").unwrap().parse().unwrap_or(0);
ver.insert(VersionInfo::FILEVERSION, version);
ver.insert(VersionInfo::PRODUCTVERSION, version);
ver.insert(VersionInfo::FILEOS, 0x00040004);
ver.insert(VersionInfo::FILETYPE, 1);
ver.insert(VersionInfo::FILESUBTYPE, 0);
ver.insert(VersionInfo::FILEFLAGSMASK, 0x3F);
ver.insert(VersionInfo::FILEFLAGS, 0);
let sdk = if cfg!(target_env = "msvc") {
match get_sdk() {
Ok(mut v) => v.pop().unwrap(),
Err(_) => PathBuf::new(),
}
} else {
PathBuf::from("\\")
};
WindowsResource {
toolkit_path: sdk,
properties: props,
version_info: ver,
rc_file: None,
icon_id: None,
icon: None,
language: 0,
manifest: None,
manifest_file: None,
output_directory: env::var("OUT_DIR").unwrap_or(".".to_string()),
}
}
/// Set string properties of the version info struct.
///
/// Possible field names are:
///
/// - `"FileVersion"`
/// - `"FileDescription"`
/// - `"ProductVersion"`
/// - `"ProductName"`
/// - `"OriginalFilename"`
/// - `"LegalCopyright"`
/// - `"LegalTrademark"`
/// - `"CompanyName"`
/// - `"Comments"`
/// - `"InternalName"`
///
/// Additionally there exists
/// `"PrivateBuild"`, `"SpecialBuild"`
/// which should only be set, when the `FILEFLAGS` property is set to
/// `VS_FF_PRIVATEBUILD(0x08)` or `VS_FF_SPECIALBUILD(0x20)`
///
/// It is possible to use arbirtrary field names but Windows Explorer and other
/// tools might not show them.
pub fn set<'a>(&mut self, name: &'a str, value: &'a str) -> &mut Self {
self.properties.insert(name.to_string(), value.to_string());
self
}
/// Set the correct path for the toolkit.
///
/// For the GNU toolkit this has to be the path where MinGW
/// put `windres.exe` and `ar.exe`. This could be something like:
/// `"C:\Program Files\mingw-w64\x86_64-5.3.0-win32-seh-rt_v4-rev0\mingw64\bin"`
///
/// For MSVC the Windows SDK has to be installed. It comes with the resource compiler
/// `rc.exe`. This should be set to the root directory of the Windows SDK, e.g.,
/// `"C:\Program Files (x86)\Windows Kits\10"`
/// or, if multiple 10 versions are installed,
/// set it directly to the corret bin directory
/// `"C:\Program Files (x86)\Windows Kits\10\bin\10.0.14393.0\x64"`
///
/// If it is left unset, it will look up a path in the registry,
/// i.e. `HKLM\SOFTWARE\Microsoft\Windows Kits\Installed Roots`
pub fn set_toolkit_path<'a>(&mut self, path: &'a str) -> &mut Self {
self.toolkit_path = PathBuf::from(path);
self
}
/// Set the user interface language of the file
///
/// # Example
///
/// ```
/// extern crate winapi;
/// extern crate winres;
/// # use std::io;
/// fn main() {
/// if cfg!(target_os = "windows") {
/// let mut res = winres::WindowsResource::new();
/// # res.set_output_directory(".");
/// res.set_language(winapi::um::winnt::MAKELANGID(
/// winapi::um::winnt::LANG_ENGLISH,
/// winapi::um::winnt::SUBLANG_ENGLISH_US
/// ));
/// res.compile().unwrap();
/// }
/// }
/// ```
/// For possible values look at the `winapi::um::winnt` constants, specifically those
/// starting with `LANG_` and `SUBLANG_`.
///
/// [`MAKELANGID`]: https://docs.rs/winapi/0.3/x86_64-pc-windows-msvc/winapi/um/winnt/fn.MAKELANGID.html
/// [`winapi::um::winnt`]: https://docs.rs/winapi/0.3/x86_64-pc-windows-msvc/winapi/um/winnt/index.html#constants
///
/// # Table
/// Sometimes it is just simpler to specify the numeric constant directly
/// (That is what most `.rc` files do).
/// For possible values take a look at the MSDN page for resource files;
/// we only listed some values here.
///
/// | Language | Value |
/// |---------------------|----------|
/// | Neutral | `0x0000` |
/// | English | `0x0009` |
/// | English (US) | `0x0409` |
/// | English (GB) | `0x0809` |
/// | German | `0x0407` |
/// | German (AT) | `0x0c07` |
/// | French | `0x000c` |
/// | French (FR) | `0x040c` |
/// | Catalan | `0x0003` |
/// | Basque | `0x042d` |
/// | Breton | `0x007e` |
/// | Scottish Gaelic | `0x0091` |
/// | Romansch | `0x0017` |
pub fn set_language(&mut self, language: u16) -> &mut Self {
self.language = language;
self
}
/// Set an icon filename
///
/// This icon need to be in `ico` format. The filename can be absolute
/// or relative to the projects root.
pub fn set_icon<'a>(&mut self, path: &'a str) -> &mut Self {
self.icon = Some(path.to_string());
self
}
/// Set an icon filename and icon id
///
/// This icon need to be in `ico` format. The filename can be absolute
/// or relative to the projects root.
pub fn set_icon_with_id<'a>(&mut self, path: &'a str, icon_id: &'a str) -> &mut Self {
self.icon = Some(path.to_string());
self.icon_id = Some(icon_id.to_string());
self
}
/// Set a version info struct property
/// Currently we only support numeric values; you have to look them up.
pub fn set_version_info(&mut self, field: VersionInfo, value: u64) -> &mut Self {
self.version_info.insert(field, value);
self
}
/// Set the embedded manifest file
///
/// # Example
///
/// The following manifest will brand the exe as requesting administrator privileges.
/// Thus, everytime it is executed, a Windows UAC dialog will appear.
///
/// ```rust
/// let mut res = winres::WindowsResource::new();
/// res.set_manifest(r#"
/// <assembly xmlns="urn:schemas-microsoft-com:asm.v1" manifestVersion="1.0">
/// <trustInfo xmlns="urn:schemas-microsoft-com:asm.v3">
/// <security>
/// <requestedPrivileges>
/// <requestedExecutionLevel level="requireAdministrator" uiAccess="false" />
/// </requestedPrivileges>
/// </security>
/// </trustInfo>
/// </assembly>
/// "#);
/// ```
pub fn set_manifest<'a>(&mut self, manifest: &'a str) -> &mut Self {
self.manifest_file = None;
self.manifest = Some(manifest.to_string());
self
}
/// Some as [`set_manifest()`] but a filename can be provided and
/// file is included by the resource compieler itself.
/// This method works the same way as [`set_icon()`]
///
/// [`set_manifest()`]: #method.set_manifest
/// [`set_icon()`]: #method.set_icon
pub fn set_manifest_file<'a>(&mut self, file: &'a str) -> &mut Self {
self.manifest_file = Some(file.to_string());
self.manifest = None;
self
}
/// Write a resource file with the set values
pub fn write_resource_file<P: AsRef<Path>>(&self, path: P) -> io::Result<()> {
let mut f = try!(fs::File::create(path));
// we don't need to include this, we use constants instead of macro names
// try!(write!(f, "#include <winver.h>\n"));
// use UTF8 as an encoding
// this makes it easier since in rust all string are UTF8
writeln!(f, "#pragma code_page(65001)")?;
writeln!(f, "1 VERSIONINFO")?;
for (k, v) in self.version_info.iter() {
match *k {
VersionInfo::FILEVERSION |
VersionInfo::PRODUCTVERSION => {
writeln!(f,
"{:?} {}, {}, {}, {}",
k,
(*v >> 48) as u16,
(*v >> 32) as u16,
(*v >> 16) as u16,
*v as u16)?
}
_ => writeln!(f, "{:?} {:#x}", k, v)?,
};
}
writeln!(f, "{{\nBLOCK \"StringFileInfo\"")?;
writeln!(f, "{{\nBLOCK \"{:04x}04b0\"\n{{", self.language)?;
for (k, v) in self.properties.iter() {
if !v.is_empty() {
writeln!(f, "VALUE \"{}\", \"{}\"",
escape_string(k), escape_string(v))?;
}
}
writeln!(f, "}}\n}}")?;
writeln!(f, "BLOCK \"VarFileInfo\" {{")?;
writeln!(f, "VALUE \"Translation\", {:#x}, 0x04b0", self.language)?;
writeln!(f, "}}\n}}")?;
if let Some(ref icon) = self.icon {
let name_id = self.icon_id.as_ref().map(String::as_str).unwrap_or("1");
writeln!(f, "{} ICON \"{}\"", escape_string(name_id), escape_string(icon))?;
}
if let Some(e) = self.version_info.get(&VersionInfo::FILETYPE) {
if let Some(manf) = self.manifest.as_ref() {
writeln!(f, "{} 24", e)?;
writeln!(f, "{{")?;
for line in manf.lines() {
writeln!(f, "\"{}\"", escape_string(line.trim()))?;
}
writeln!(f, "}}")?;
} else if let Some(manf) = self.manifest_file.as_ref() {
writeln!(f, "{} 24 \"{}\"", e, escape_string(manf))?;
}
}
Ok(())
}
/// Set a path to an already existing resource file.
///
/// We will neither modify this file nor parse its contents. This function
/// simply replaces the internaly generated resource file that is passed to
/// the compiler. You can use this function to write a resource file yourself.
pub fn set_resource_file<'a>(&mut self, path: &'a str) -> &mut Self {
self.rc_file = Some(path.to_string());
self
}
/// Override the output directoy.
///
/// As a default, we use `%OUT_DIR%` set by cargo, but it may be necessary to override the
/// the setting.
pub fn set_output_directory<'a>(&mut self, path: &'a str) -> &mut Self {
self.output_directory = path.to_string();
self
}
#[cfg(target_env = "gnu")]
fn compile_with_toolkit<'a>(&self, input: &'a str, output_dir: &'a str) -> io::Result<()> {
let output = PathBuf::from(output_dir).join("resource.o");
let input = PathBuf::from(input);
let status = process::Command::new("windres.exe")
.current_dir(&self.toolkit_path)
.arg(format!("-I{}", env::var("CARGO_MANIFEST_DIR").unwrap()))
.arg(format!("{}", input.display()))
.arg(format!("{}", output.display()))
.status()?;
if !status.success() {
return Err(io::Error::new(io::ErrorKind::Other, "Could not compile resource file"));
}
let libname = PathBuf::from(output_dir).join("libresource.a");
let status = process::Command::new("ar.exe")
.current_dir(&self.toolkit_path)
.arg("rsc")
.arg(format!("{}", libname.display()))
.arg(format!("{}", output.display()))
.status()?;
if !status.success() {
return Err(io::Error::new(io::ErrorKind::Other,
"Could not create static library for resource file"));
}
println!("cargo:rustc-link-search=native={}", output_dir);
println!("cargo:rustc-link-lib=static={}", "resource");
Ok(())
}
/// Run the resource compiler
///
/// This function generates a resource file from the settings or
/// uses an existing resource file and passes it to the resource compiler
/// of your toolkit.
///
/// Further more we will print the correct statements for
/// `cargo:rustc-link-lib=` and `cargo:rustc-link-search` on the console,
/// so that the cargo build script can link the compiled resource file.
pub fn compile(&self) -> io::Result<()> {
let output = PathBuf::from(&self.output_directory);
let rc = output.join("resource.rc");
if self.rc_file.is_none() {
self.write_resource_file(&rc)?;
}
let rc = if let Some(s) = self.rc_file.as_ref() {
s.clone()
} else {
rc.to_str().unwrap().to_string()
};
self.compile_with_toolkit(rc.as_str(), &self.output_directory)?;
Ok(())
}
#[cfg(target_env = "msvc")]
fn compile_with_toolkit<'a>(&self, input: &'a str, output_dir: &'a str) -> io::Result<()> {
let rc_exe = PathBuf::from(&self.toolkit_path).join("rc.exe");
let rc_exe = if !rc_exe.exists() {
if cfg!(target_arch = "x86_64") {
PathBuf::from(&self.toolkit_path).join(r"bin\x64\rc.exe")
} else {
PathBuf::from(&self.toolkit_path).join(r"bin\x86\rc.exe")
}
} else {
rc_exe
};
// let inc_win = PathBuf::from(&self.toolkit_path).join("Include\\10.0.10586.0\\um");
// let inc_shared = PathBuf::from(&self.toolkit_path).join("Include\\10.0.10586.0\\shared");
let output = PathBuf::from(output_dir).join("resource.lib");
let input = PathBuf::from(input);
let status = process::Command::new(rc_exe)
.arg(format!("/I{}", env::var("CARGO_MANIFEST_DIR").unwrap()))
//.arg(format!("/I{}", inc_shared.display()))
//.arg(format!("/I{}", inc_win.display()))
//.arg("/nologo")
.arg(format!("/fo{}", output.display()))
.arg(format!("{}", input.display()))
.output()?;
println!("RC Output:\n{}\n------", String::from_utf8_lossy(&status.stdout));
println!("RC Error:\n{}\n------", String::from_utf8_lossy(&status.stderr));
if !status.status.success() {
return Err(io::Error::new(io::ErrorKind::Other, "Could not compile resource file"));
}
println!("cargo:rustc-link-search=native={}", output_dir);
println!("cargo:rustc-link-lib=dylib={}", "resource");
Ok(())
}
#[cfg(not(any(target_env = "gnu", target_env = "msvc")))]
fn compile_with_toolkit<'a>(&self, _input: &'a str, _output_dir: &'a str) -> io::Result<()> {
Err(io::Error::new(io::ErrorKind::Other, "Can only compile resource file when target_env is \"gnu\" or \"msvc\""))
}
}
/// Find a Windows SDK
fn get_sdk() -> io::Result<Vec<PathBuf>> {
// use the reg command, so we don't need a winapi dependency
let output = process::Command::new("reg")
.arg("query")
.arg(r"HKLM\SOFTWARE\Microsoft\Windows Kits\Installed Roots")
.arg("/reg:32")
.output()?;
let lines = String::from_utf8(output.stdout)
.or_else(|e| Err(io::Error::new(io::ErrorKind::Other, e.description())))?;
let mut kits: Vec<PathBuf> = Vec::new();
let mut lines: Vec<&str> = lines.lines().collect();
lines.reverse();
for line in lines {
if line.trim().starts_with("KitsRoot") {
let kit: String = line.chars()
.skip(line.find("REG_SZ").unwrap() + 6)
.skip_while(|c| c.is_whitespace())
.collect();
let p = PathBuf::from(&kit);
let rc = if cfg!(target_arch = "x86_64") {
p.join(r"bin\x64\rc.exe")
} else {
p.join(r"bin\x86\rc.exe")
};
if rc.exists() {
println!("{:?}", rc);
kits.push(rc.parent().unwrap().to_owned());
}
if let Ok(bin) = p.join("bin").read_dir() {
for e in bin.filter_map(|e| e.ok()) {
let p = if cfg!(target_arch = "x86_64") {
e.path().join(r"x64\rc.exe")
} else {
e.path().join(r"x86\rc.exe")
};
if p.exists() {
println!("{:?}", p);
kits.push(p.parent().unwrap().to_owned());
}
}
}
}
}
Ok(kits)
}
fn parse_cargo_toml(props: &mut HashMap<String, String>) -> io::Result<()> {
let cargo = Path::new(&env::var("CARGO_MANIFEST_DIR").unwrap()).join("Cargo.toml");
let mut f = fs::File::open(cargo)?;
let mut cargo_toml = String::new();
f.read_to_string(&mut cargo_toml)?;
if let Ok(ml) = cargo_toml.parse::<toml::Value>() {
if let Some(pkg) = ml.get("package") {
if let Some(pkg) = pkg.get("metadata") {
if let Some(pkg) = pkg.get("winres") {
if let Some(pkg) = pkg.as_table() {
for (k, v) in pkg {
// println!("{} {}", k ,v);
if let Some(v) = v.as_str() {
props.insert(k.clone(), v.to_string());
} else {
println!("package.metadata.winres.{} is not a string", k);
}
}
} else {
println!("package.metadata.winres is not a table");
}
} else {
println!("package.metadata.winres does not exist");
}
} else {
println!("package.metadata does not exist");
}
} else {
println!("package does not exist");
}
} else {
println!("TOML parsing error")
}
Ok(())
}
fn escape_string(string: &str) -> String {
let mut escaped = String::new();
for chr in string.chars() {
// In quoted RC strings, double-quotes are escaped by using two
// consecutive double-quotes. Other characters are escaped in the
// usual C way using backslashes.
if chr == '"' {
escaped.push_str("\"\"");
} else {
escaped.extend(chr.escape_default());
}
}
escaped
}
#[cfg(test)]
mod tests {
use super::escape_string;
#[test]
fn string_escaping() {
assert_eq!(&escape_string(""), "");
assert_eq!(&escape_string("foo"), "foo");
assert_eq!(&escape_string("\"Hello\""), "\"\"Hello\"\"");
assert_eq!(&escape_string("C:\\Program Files\\Foobar"),
"C:\\\\Program Files\\\\Foobar");
}
}