1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
use std::{
	fmt::Debug,
	fs::{self, File, OpenOptions},
	io::{BufReader, ErrorKind, Write},
	path::{Path, PathBuf},
};

use dunce::canonicalize;
use maplit::hashmap;
use once_cell::sync::Lazy;

use crate::{
	Class,
	comment,
	CompiledInterpolation,
	Const,
	Element,
	Enum,
	Func,
	GeneratedElement,
	GeneratorVisitor,
	IteratorExt,
	line_reader,
	main_module_from_path,
	module_from_path,
	settings,
	StrExt,
	Typedef,
};

type Entries = Vec<(String, String)>;

#[derive(Clone, Debug)]
pub struct RustBindingWriter<'s> {
	debug: bool,
	opencv_header_dir: PathBuf,
	src_cpp_dir: PathBuf,
	module: &'s str,
	opencv_version: &'s str,
	debug_path: PathBuf,
	rust_path: PathBuf,
	types_dir: PathBuf,
	exports_path: PathBuf,
	cpp_path: PathBuf,
	comment: String,
	found_traits: Vec<String>,
	consts: Entries,
	enums: Entries,
	rust_funcs: Entries,
	rust_typedefs: Entries,
	rust_classes: Entries,
	export_funcs: Entries,
	export_classes: Entries,
	cpp_funcs: Entries,
	cpp_classes: Entries,
}

impl<'s> RustBindingWriter<'s> {
	pub fn new(opencv_header_dir: impl Into<PathBuf>, src_cpp_dir: &Path, out_dir: impl Into<PathBuf>, module: &'s str, opencv_version: &'s str, debug: bool) -> Self {
		let out_dir = out_dir.into();
		let debug_path = out_dir.join(format!("{}.log", module));
		if debug {
			if false {
				File::create(&debug_path).expect("Can't create debug log");
			}
			for entry in out_dir.read_dir().expect("Can't read out_dir") {
				let entry = entry.expect("Can't read directory entry");
				let path = entry.path();
				if entry.file_type().map(|f| f.is_file()).unwrap_or(false)
					&& path.extension().map_or(false, |e| e == "rs" || e == "cpp")
				{
					let _ = fs::remove_file(path);
				}
			}
		}
		Self {
			debug,
			opencv_header_dir: opencv_header_dir.into(),
			src_cpp_dir: canonicalize(src_cpp_dir).expect("Can't canonicalize src_cpp_dir"),
			module,
			opencv_version,
			debug_path,
			rust_path: out_dir.join(format!("{}.rs", module)),
			exports_path: out_dir.join(format!("{}.externs.rs", module)),
			cpp_path: out_dir.join(format!("{}.cpp", module)),
			types_dir: out_dir,
			comment: String::new(),
			found_traits: vec![],
			consts: vec![],
			enums: vec![],
			rust_funcs: vec![],
			rust_typedefs: vec![],
			rust_classes: vec![],
			export_funcs: vec![],
			export_classes: vec![],
			cpp_funcs: vec![],
			cpp_classes: vec![],
		}
	}

	fn emit_debug_log(&mut self, obj: &impl Debug) {
		if self.debug && false {
			let mut f = OpenOptions::new().append(true).open(&self.debug_path).expect("Can't open debug file");
			writeln!(f, "{:#?}", obj).expect("Can't write debug info");
		}
	}
}

impl GeneratorVisitor for RustBindingWriter<'_> {
	fn wants_file(&mut self, path: &Path) -> bool {
		module_from_path(path).map_or(false, |m| m == self.module)
			|| main_module_from_path(path).map_or(false, |m| m == self.module)
	}

	fn visit_module_comment(&mut self, comment: String) {
		self.comment = comment;
	}

	fn visit_const(&mut self, cnst: Const) {
		self.emit_debug_log(&cnst);
		self.consts.push((cnst.rust_localname().into_owned(), cnst.gen_rust(self.opencv_version)));
	}

	fn visit_enum(&mut self, enm: Enum) {
		self.emit_debug_log(&enm);
		self.enums.push((enm.rust_localname().into_owned(), enm.gen_rust(self.opencv_version)));
	}

	fn visit_func(&mut self, func: Func) {
		self.emit_debug_log(&func);
		let name: String = func.identifier().into_owned();
		self.rust_funcs.push((name.clone(), func.gen_rust(self.opencv_version)));
		self.export_funcs.push((name.clone(), func.gen_rust_exports()));
		self.cpp_funcs.push((name, func.gen_cpp()));
	}

	fn visit_typedef(&mut self, typedef: Typedef) {
		self.emit_debug_log(&typedef);
		self.rust_typedefs.push((typedef.cpp_fullname().into_owned(), typedef.gen_rust(self.opencv_version)))
	}

	fn visit_class(&mut self, class: Class) {
		self.emit_debug_log(&class);
		if class.is_trait() {
			self.found_traits.push(format!("super::{}", class.rust_trait_localname().into_owned()));
		}
		let name: String = class.cpp_fullname().into_owned();
		self.rust_classes.push((name.clone(), class.gen_rust(self.opencv_version)));
		self.export_classes.push((name.clone(), class.gen_rust_exports()));
		self.cpp_classes.push((name, class.gen_cpp()));
	}

	fn visit_dependent_type(&mut self, typ: &dyn GeneratedElement) {
		let prio = typ.element_priority();
		let safe_id = typ.element_safe_id();
		let rust_path = self.types_dir.join(format!("{:03}-{}.type.rs", prio, safe_id));
		let cpp_path = self.types_dir.join(format!("{:03}-{}.type.cpp", prio, safe_id));
		let files = if self.debug {
			(
				OpenOptions::new().create(true).write(true).truncate(true).open(&rust_path),
				OpenOptions::new().create(true).write(true).truncate(true).open(&cpp_path),
			)
		} else {
			(
				OpenOptions::new().create_new(true).write(true).open(&rust_path),
				OpenOptions::new().create_new(true).write(true).open(&cpp_path),
			)
		};
		match files {
			(Ok(mut rust), Ok(mut cpp)) => {
				rust.write_all(typ.gen_rust(self.opencv_version).as_bytes()).expect("Can't write to rust file");
				cpp.write_all(typ.gen_cpp().as_bytes()).expect("Can't write to cpp file");
			}
			(Err(e), _) | (_, Err(e)) => {
				match e.kind() {
					ErrorKind::AlreadyExists => {} // expected, we need to exclusively create file
					_ => {
						panic!("Error while creating file for dependent type: {}", e)
					}
				}
			}
		}
	}
}

fn join<T: AsRef<str>>(v: &mut Vec<(String, T)>) -> String {
	v.sort_unstable_by(|(name_left, _), (name_right, _)| name_left.cmp(name_right));
	v.drain(..)
		.map(|(_, gen)| gen)
		.join("")
}

impl Drop for RustBindingWriter<'_> {
	fn drop(&mut self) {
		static RUST: Lazy<CompiledInterpolation> = Lazy::new(||
			include_str!("../../tpl/module/rust.tpl.rs").compile_interpolation()
		);

		static RUST_PRELUDE: Lazy<CompiledInterpolation> = Lazy::new(||
			include_str!("../../tpl/module/prelude.tpl.rs").compile_interpolation()
		);

		static RUST_EXTERNS_TPL: Lazy<CompiledInterpolation> = Lazy::new(||
			include_str!("../../tpl/module/externs.tpl.rs").compile_interpolation()
		);

		static CPP: Lazy<CompiledInterpolation> = Lazy::new( ||
			include_str!("../../tpl/module/cpp.tpl.cpp").compile_interpolation()
		);

		let mut rust = join(&mut self.consts);
		rust += &join(&mut self.enums);
		rust += &join(&mut self.rust_typedefs);
		rust += &join(&mut self.rust_funcs);
		rust += &join(&mut self.rust_classes);
		// fixme, this should logically be in Generator because it's not Rust-specific
		if self.comment.is_empty() {
			// some module level comments like "bioinspired" are not attached to anything and libclang
			// doesn't seem to offer a way to extract them, do it the hard way then
			let mut module_path = self.opencv_header_dir.join("opencv2");
			module_path.push(self.module);
			module_path.set_extension("hpp");
			self.comment.reserve(2048);
			let f = BufReader::new(File::open(module_path).expect("Can't open main module file"));
			let mut found_module_comment = false;
			let mut defgroup_found = false;
			line_reader(f, |line| {
				if !found_module_comment {
					if line.trim_start().starts_with("/**") {
						found_module_comment = true;
						defgroup_found = false;
					}
				}
				if found_module_comment {
					if self.comment.contains("@defgroup") {
						defgroup_found = true;
					}
					self.comment.push_str(&line);
					if line.trim_end().ends_with("*/") {
						if defgroup_found {
							return false;
						} else {
							self.comment.clear();
							found_module_comment = false;
						}
					}
				}
				true
			});
			if !defgroup_found {
				self.comment.clear();
			}
		}
		let prelude = RUST_PRELUDE.interpolate(&hashmap! {
			"traits" => self.found_traits.join(", "),
		});
		File::create(&self.rust_path).expect("Can't create rust file")
			.write_all(RUST.interpolate(&hashmap! {
				"static_modules" => settings::STATIC_MODULES.iter().join(", "),
				"comment" => comment::render_doc_comment(&self.comment, "//!", self.opencv_version),
				"prelude" => prelude,
				"code" => rust,
			}).as_bytes()).expect("Can't write rust file");

		let mut cpp = join(&mut self.cpp_funcs);
		cpp += &join(&mut self.cpp_classes);
		let includes = if self.src_cpp_dir.join(format!("{}.hpp", self.module)).exists() {
			format!("#include \"{module}.hpp\"\n", module=self.module)
		} else {
			format!("#include \"common.hpp\"\n#include <opencv2/{module}.hpp>", module=self.module)
		};
		File::create(&self.cpp_path).expect("Can't create cpp file")
			.write_all(CPP.interpolate(&hashmap! {
				"module" => self.module,
				"includes" => includes.as_str(),
				"code" => cpp.as_str(),
			}).as_bytes()).expect("Can't write cpp file");

		let mut exports = join(&mut self.export_funcs);
		exports += &join(&mut self.export_classes);
		File::create(&self.exports_path).expect("Can't create rust exports file")
			.write_all(RUST_EXTERNS_TPL.interpolate(&hashmap! {
				"code" => exports,
			}).as_bytes()).expect("Can't write rust exports file");
	}
}