adam/bin2hpp
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

0.3.0: fix linkage in C mode

Browse Source
This commit is contained in:
Adam 2025-08-17 20:01:04 +01:00
parent 5657325d97
commit 987152f14f
7 changed files with 108 additions and 80 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
Cargo.lock generated
View File

@ -4,7 +4,7 @@ version = 4
[[package]]
name = "bin2hpp"
version = "0.2.5"
version = "0.3.0"
dependencies = [
"thiserror",
]

2
Cargo.toml
View File

@ -1,6 +1,6 @@
[package]
name = "bin2hpp"
version = "0.2.5"
version = "0.3.0"
authors = ["Adam Macdonald"]
edition = "2024"
license = "GPL-3.0-only"

23
README.md
View File

@ -17,20 +17,35 @@ The performance (but potentially not the executable size) can be further optimis
`$ bin2hpp -i my_library.dll -o c_header.h` will generate a `c_header.h` file in your current working directory containing something similar to the following:
```c
// Generated by bin2hpp 0.2.5
#ifndef C_HEADER_H
#define C_HEADER_H
// Generated by bin2hpp 0.3.0
#ifdef MY_LIBRARY_DLL_INIT
#define MY_LIBRARY_DLL_LEN 9728
const unsigned char MY_LIBRARY_DLL[MY_LIBRARY_DLL_LEN] = {77,90,144,0,3,0,0,0,4, ...};
#else
#define MY_LIBRARY_DLL_LEN 9728
extern const unsigned char MY_LIBRARY_DLL[MY_LIBRARY_DLL_LEN];
#endif
```
Note how in **C mode** one must `#define MY_LIBRARY_DLL_INIT`, or whatever the corresponding implementation macro is for your generated header file, in exactly _one_ C source file (`*.c`, not in a `*.h` file).
Example:
`main.c`
```c
// In any other C source files other than the first: do not redefine
#define MY_LIBRARY_DLL_INIT
#include "c_header.h"
int main() {
return MY_LIBRARY_DLL_LEN;
}
```
Alternatively, in **C++ mode**: `bin2hpp -i my_library.dll -o cpp_header.hpp --cpp --constexpr --stdarray --i8`
```cpp
// Generated by bin2hpp 0.2.5
// Generated by bin2hpp 0.3.0
#if !defined(CPP_HEADER_HPP)
#define CPP_HEADER_HPP
#include <cstdint>

73
src/cfg.rs
View File

@ -22,7 +22,8 @@ pub struct Config {
pub(crate) constness: Constness,
pub(crate) symbol_name: String,
pub(crate) namespace: Option<String>,
pub(crate) guard_name: String,
pub(crate) impl_macro: String,
pub(crate) header_guard: String,
pub(crate) container_type: ContainerType,
}
@ -56,18 +57,7 @@ pub fn parse_config_from_args(args: &CliArgs) -> Result<Config, ProgramConfigErr
}
};
Ok(Config {
input_file_path: args.input_file_path.clone(),
output_file_path: output_path.clone(),
overwrite: args.overwrite,
line_ending: if args.line_ending == LineEnding::Unix {
LF_LINE_ENDING.into()
} else {
CRLF_LINE_ENDING.into()
},
language: args.language,
constness: args.constness,
symbol_name: match &args.symbol_name {
let symbol_name = match &args.symbol_name {
Some(s) => {
if s.chars().all(|c| c.is_ascii_alphanumeric() || c == '_') {
s.to_string()
@ -94,7 +84,39 @@ pub fn parse_config_from_args(args: &CliArgs) -> Result<Config, ProgramConfigErr
format!("{}{}", stem.to_ascii_uppercase(), ext.to_ascii_uppercase())
}
};
let header_guard = match output_path.file_stem() {
Some(stem) => {
format!(
"{}_{}",
stem.to_string_lossy().to_uppercase(),
if let Some(ext) = output_path.extension() {
ext.to_string_lossy().to_uppercase()
} else {
"".into()
}
)
}
None => {
return Err(ProgramConfigError::InvalidPath(
output_path.to_string_lossy().to_string(),
));
}
};
Ok(Config {
input_file_path: args.input_file_path.clone(),
output_file_path: output_path.clone(),
overwrite: args.overwrite,
line_ending: if args.line_ending == LineEnding::Unix {
LF_LINE_ENDING.into()
} else {
CRLF_LINE_ENDING.into()
},
language: args.language,
constness: args.constness,
symbol_name: symbol_name.clone(),
namespace: match &args.namespace {
Some(ns) => {
if ns.chars().all(|c| c.is_ascii_alphanumeric() || c == '_') {
@ -105,7 +127,7 @@ pub fn parse_config_from_args(args: &CliArgs) -> Result<Config, ProgramConfigErr
}
_ => None,
},
guard_name: match &args.guard_name {
impl_macro: match &args.impl_macro_name {
Some(guard) => {
if guard.chars().all(|c| c.is_ascii_alphanumeric() || c == '_') {
guard.clone()
@ -114,29 +136,10 @@ pub fn parse_config_from_args(args: &CliArgs) -> Result<Config, ProgramConfigErr
}
}
_ => {
let mut stem: String = match output_path.file_stem() {
Some(s) => s.to_string_lossy().to_ascii_uppercase(),
None => {
return Err(ProgramConfigError::InvalidPath(
args.input_file_path.to_string_lossy().to_string(),
));
}
};
stem.retain(|c| c.is_ascii_alphanumeric() || c == '_');
let mut ext: String = match output_path.extension() {
Some(s) => s.to_string_lossy().to_ascii_uppercase(),
None => {
return Err(ProgramConfigError::InvalidPath(
args.input_file_path.to_string_lossy().to_string(),
));
}
};
ext.retain(|c| c.is_ascii_alphanumeric() || c == '_');
format!("{}_{}", stem, ext)
format!("{}_INIT", symbol_name.to_uppercase())
}
},
header_guard: header_guard,
container_type: args.container_type,
})
}

8
src/cli.rs
View File

@ -81,7 +81,7 @@ pub struct CliArgs {
pub(crate) constness: Constness,
pub(crate) symbol_name: Option<String>,
pub(crate) namespace: Option<String>,
pub(crate) guard_name: Option<String>,
pub(crate) impl_macro_name: Option<String>,
pub(crate) container_type: ContainerType,
}
@ -123,10 +123,10 @@ pub fn parse_cli_args(args: &[String]) -> Result<CliArgs, CliParseError> {
None => None,
};
let guard_name = match args.iter().position(|s| *s == "--guard") {
let impl_macro_name = match args.iter().position(|s| *s == "--impl") {
Some(idx) => match args.get(idx + 1) {
Some(s) => Some(s),
None => return Err(CliParseError::MissingOperand("--guard")),
None => return Err(CliParseError::MissingOperand("--impl")),
},
None => None,
};
@ -237,7 +237,7 @@ pub fn parse_cli_args(args: &[String]) -> Result<CliArgs, CliParseError> {
constness: constness,
symbol_name: symbol_name.cloned(),
namespace: namespace.cloned(),
guard_name: guard_name.cloned(),
impl_macro_name: impl_macro_name.cloned(),
container_type: container_type,
});
}

4
src/constants.rs
View File

@ -28,8 +28,8 @@ OUTPUT OPTIONS:
--symname NAME Symbol name
--namespace NAME Namespace in which the symbol will exist (C++ mode)
--guard NAME Preprocessor macro to use for the header guard (#ifndef ...)
(default: derive from output filename)
--impl NAME Preprocessor macro to use for the implementation guard
in C mode (default: derive from symbol name)
CONTAINER TYPES:

44
src/generate.rs
View File

@ -33,18 +33,17 @@ pub fn header(config: &Config, in_data: &[u8]) -> Result<String, HeaderGeneratio
write!(
buf,
"#if !defined({}){}",
config.guard_name, config.line_ending
config.header_guard, config.line_ending
)
.unwrap();
write!(buf, "#define {}{}", config.header_guard, config.line_ending).unwrap();
} else {
// C style
write!(buf, "#ifndef {}{}", config.guard_name, config.line_ending).unwrap();
write!(buf, "#ifdef {}{}", config.impl_macro, config.line_ending).unwrap();
}
write!(buf, "#define {}{}", config.guard_name, config.line_ending).unwrap();
// Includes & main content
with_includes(config, &mut buf);
with_contents(config, in_data, &mut buf)?;
// End header guard
@ -59,6 +58,21 @@ pub fn with_contents(
in_data: &[u8],
buf: &mut String,
) -> Result<(), HeaderGenerationError> {
with_includes(config, buf);
let length: usize = match config.container_type {
ContainerType::CString => in_data.len() + 1, // +1 for NUL terminator
_ => in_data.len(),
};
write!(
buf,
"{}{}",
length_define(config, length),
config.line_ending
)
.unwrap();
if config.language == Language::Cpp {
// C++ mode
@ -73,8 +87,17 @@ pub fn with_contents(
// C mode
with_definition(config, in_data, buf)?;
write!(buf, "#else{}", config.line_ending).unwrap();
with_includes(config, buf);
write!(
buf,
"{}{}",
length_define(config, length),
config.line_ending
)
.unwrap();
with_declaration(config, buf);
}
@ -154,21 +177,8 @@ pub fn with_definition(
in_data: &[u8],
buf: &mut String,
) -> Result<(), HeaderGenerationError> {
let length: usize = match config.container_type {
ContainerType::CString => in_data.len() + 1, // +1 for NUL terminator
_ => in_data.len(),
};
let modifiers = definition_modifiers(config);
write!(
buf,
"{}{}",
length_define(config, length),
config.line_ending
)
.unwrap();
write!(
buf,
"{}{} = {};{}",