1. 1//! Vakyartha's built-in blank packages, where a file created from scratch
2. 2//! starts (docs/design/72-openxml-documents.md, "Creating from scratch").
3. 3//!
4. 4//! They are written for Vakyartha, not copied from any application, and
5. 5//! zipped with fixed timestamps, so one version always yields the same
6. 6//! bytes. The parts are plain XML under `blank/` beside this crate. A blank
7. 7//! has no content: a new file's content comes only from ops, which the edit
8. 8//! engine checks by a re-read like any other edit.
9. 9
10. 10use std::io::{Cursor, Write};
11. 11
12. 12use crate::{Format, FormatKind, Vocabulary};
13. 13
14. 14const THEME: &str = include_str!("../blank/shared/theme.xml");
15. 15const PACKAGE_RELS: &str = include_str!("../blank/shared/package.rels");
16. 16const CORE: &str = include_str!("../blank/shared/core.xml");
17. 17const APP: &str = include_str!("../blank/shared/app.xml");
18. 18
19. 19const WORD: &[(&str, &str)] = &[
20. 20 (
21. 21 "[Content_Types].xml",
22. 22 include_str!("../blank/word/content-types.xml"),
23. 23 ),
24. 24 (
25. 25 "word/document.xml",
26. 26 include_str!("../blank/word/document.xml"),
27. 27 ),
28. 28 (
29. 29 "word/_rels/document.xml.rels",
30. 30 include_str!("../blank/word/document.xml.rels"),
31. 31 ),
32. 32 ("word/styles.xml", include_str!("../blank/word/styles.xml")),
33. 33 (
34. 34 "word/numbering.xml",
35. 35 include_str!("../blank/word/numbering.xml"),
36. 36 ),
37. 37 (
38. 38 "word/settings.xml",
39. 39 include_str!("../blank/word/settings.xml"),
40. 40 ),
41. 41 (
42. 42 "word/fontTable.xml",
43. 43 include_str!("../blank/word/fontTable.xml"),
44. 44 ),
45. 45];
46. 46
47. 47const EXCEL: &[(&str, &str)] = &[
48. 48 (
49. 49 "[Content_Types].xml",
50. 50 include_str!("../blank/excel/content-types.xml"),
51. 51 ),
52. 52 (
53. 53 "xl/workbook.xml",
54. 54 include_str!("../blank/excel/workbook.xml"),
55. 55 ),
56. 56 (
57. 57 "xl/_rels/workbook.xml.rels",
58. 58 include_str!("../blank/excel/workbook.xml.rels"),
59. 59 ),
60. 60 (
61. 61 "xl/worksheets/sheet1.xml",
62. 62 include_str!("../blank/excel/sheet1.xml"),
63. 63 ),
64. 64 ("xl/styles.xml", include_str!("../blank/excel/styles.xml")),
65. 65];
66. 66
67. 67const POWERPOINT: &[(&str, &str)] = &[
68. 68 (
69. 69 "[Content_Types].xml",
70. 70 include_str!("../blank/powerpoint/content-types.xml"),
71. 71 ),
72. 72 (
73. 73 "ppt/presentation.xml",
74. 74 include_str!("../blank/powerpoint/presentation.xml"),
75. 75 ),
76. 76 (
77. 77 "ppt/_rels/presentation.xml.rels",
78. 78 include_str!("../blank/powerpoint/presentation.xml.rels"),
79. 79 ),
80. 80 (
81. 81 "ppt/slideMasters/slideMaster1.xml",
82. 82 include_str!("../blank/powerpoint/slideMaster1.xml"),
83. 83 ),
84. 84 (
85. 85 "ppt/slideMasters/_rels/slideMaster1.xml.rels",
86. 86 include_str!("../blank/powerpoint/slideMaster1.xml.rels"),
87. 87 ),
88. 88 (
89. 89 "ppt/slideLayouts/slideLayout1.xml",
90. 90 include_str!("../blank/powerpoint/slideLayout1.xml"),
91. 91 ),
92. 92 (
93. 93 "ppt/slideLayouts/_rels/slideLayout1.xml.rels",
94. 94 include_str!("../blank/powerpoint/slideLayout1.xml.rels"),
95. 95 ),
96. 96 (
97. 97 "ppt/slideLayouts/slideLayout2.xml",
98. 98 include_str!("../blank/powerpoint/slideLayout2.xml"),
99. 99 ),
100. 100 (
101. 101 "ppt/slideLayouts/_rels/slideLayout2.xml.rels",
102. 102 include_str!("../blank/powerpoint/slideLayout2.xml.rels"),
103. 103 ),
104. 104 (
105. 105 "ppt/slideLayouts/slideLayout3.xml",
106. 106 include_str!("../blank/powerpoint/slideLayout3.xml"),
107. 107 ),
108. 108 (
109. 109 "ppt/slideLayouts/_rels/slideLayout3.xml.rels",
110. 110 include_str!("../blank/powerpoint/slideLayout3.xml.rels"),
111. 111 ),
112. 112 (
113. 113 "ppt/slideLayouts/slideLayout4.xml",
114. 114 include_str!("../blank/powerpoint/slideLayout4.xml"),
115. 115 ),
116. 116 (
117. 117 "ppt/slideLayouts/_rels/slideLayout4.xml.rels",
118. 118 include_str!("../blank/powerpoint/slideLayout4.xml.rels"),
119. 119 ),
120. 120 (
121. 121 "ppt/slideLayouts/slideLayout5.xml",
122. 122 include_str!("../blank/powerpoint/slideLayout5.xml"),
123. 123 ),
124. 124 (
125. 125 "ppt/slideLayouts/_rels/slideLayout5.xml.rels",
126. 126 include_str!("../blank/powerpoint/slideLayout5.xml.rels"),
127. 127 ),
128. 128 (
129. 129 "ppt/slideLayouts/slideLayout6.xml",
130. 130 include_str!("../blank/powerpoint/slideLayout6.xml"),
131. 131 ),
132. 132 (
133. 133 "ppt/slideLayouts/_rels/slideLayout6.xml.rels",
134. 134 include_str!("../blank/powerpoint/slideLayout6.xml.rels"),
135. 135 ),
136. 136 (
137. 137 "ppt/notesMasters/notesMaster1.xml",
138. 138 include_str!("../blank/powerpoint/notesMaster1.xml"),
139. 139 ),
140. 140 (
141. 141 "ppt/notesMasters/_rels/notesMaster1.xml.rels",
142. 142 include_str!("../blank/powerpoint/notesMaster1.xml.rels"),
143. 143 ),
144. 144 (
145. 145 "ppt/presProps.xml",
146. 146 include_str!("../blank/powerpoint/presProps.xml"),
147. 147 ),
148. 148 (
149. 149 "ppt/viewProps.xml",
150. 150 include_str!("../blank/powerpoint/viewProps.xml"),
151. 151 ),
152. 152 (
153. 153 "ppt/tableStyles.xml",
154. 154 include_str!("../blank/powerpoint/tableStyles.xml"),
155. 155 ),
156. 156];
157. 157
158. 158/// The layouts a blank deck offers, by the names `add_slide_from_layout`
159. 159/// takes, each with the placeholder keys its slides fill.
160. 160pub const DECK_LAYOUTS: &[(&str, &str)] = &[
161. 161 ("Title Slide", "title, subtitle"),
162. 162 ("Title and Content", "title, body"),
163. 163 ("Section Header", "title, body"),
164. 164 ("Two Content", "title, idx:1, idx:2"),
165. 165 ("Title Only", "title"),
166. 166 ("Blank", "no placeholders"),
167. 167];
168. 168
169. 169/// The paragraph styles a blank Word document offers, by name.
170. 170pub const DOCUMENT_STYLES: &[&str] = &[
171. 171 "Normal",
172. 172 "Title",
173. 173 "Subtitle",
174. 174 "Heading 1",
175. 175 "Heading 2",
176. 176 "Heading 3",
177. 177 "List Bullet",
178. 178 "List Number",
179. 179 "Quote",
180. 180];
181. 181
182. 182/// The one sheet a blank workbook has.
183. 183pub const WORKBOOK_SHEET: &str = "Sheet1";
184. 184
185. 185/// The blank package a new file named as `format` starts from. It is the
186. 186/// document form of the vocabulary; a template name (`.dotx`, `.xltx`,
187. 187/// `.potx`) is made by the edit engine changing the main part's content
188. 188/// type, exactly as it does when a template is the source. Refuses a
189. 189/// macro-enabled format (O10) and Visio, which has no editing engine yet.
190. 190pub fn blank(format: Format) -> Result<Vec<u8>, String> {
191. 191 if format.macro_enabled || format.kind == FormatKind::AddIn {
192. 192 return Err(format!(
193. 193 "Vakyartha never makes a macro-enabled file, so a .{} cannot be created; name it .{} instead",
194. 194 format.extension(),
195. 195 Format {
196. 196 macro_enabled: false,
197. 197 kind: if format.kind == FormatKind::AddIn {
198. 198 FormatKind::Document
199. 199 } else {
200. 200 format.kind
201. 201 },
202. 202 ..format
203. 203 }
204. 204 .extension()
205. 205 ));
206. 206 }
207. 207 let (main, parts, major, minor, theme) = match format.vocabulary {
208. 208 Vocabulary::Word => (
209. 209 "word/document.xml",
210. 210 WORD,
211. 211 "Aptos Display",
212. 212 "Aptos",
213. 213 &["word/theme/theme1.xml"][..],
214. 214 ),
215. 215 Vocabulary::Excel => (
216. 216 "xl/workbook.xml",
217. 217 EXCEL,
218. 218 "Aptos Display",
219. 219 "Aptos Narrow",
220. 220 &["xl/theme/theme1.xml"][..],
221. 221 ),
222. 222 Vocabulary::PowerPoint => (
223. 223 "ppt/presentation.xml",
224. 224 POWERPOINT,
225. 225 "Aptos Display",
226. 226 "Aptos",
227. 227 &["ppt/theme/theme1.xml", "ppt/theme/theme2.xml"][..],
228. 228 ),
229. 229 Vocabulary::Visio => {
230. 230 return Err(
231. 231 "a Visio drawing cannot be created from scratch yet; Vakyartha reads Visio files but has no Visio editing yet. Tell the person so, and do not build one with a command or script".into(),
232. 232 );
233. 233 }
234. 234 };
235. 235 let theme_xml = THEME
236. 236 .replace("{{MAJOR}}", major)
237. 237 .replace("{{MINOR}}", minor);
238. 238 let package_rels = PACKAGE_RELS.replace("{{MAIN}}", main);
239. 239 let mut entries: Vec<(&str, &str)> = Vec::with_capacity(parts.len() + 6);
240. 240 entries.push(parts[0]);
241. 241 entries.push(("_rels/.rels", &package_rels));
242. 242 entries.push(("docProps/core.xml", CORE));
243. 243 entries.push(("docProps/app.xml", APP));
244. 244 entries.extend_from_slice(&parts[1..]);
245. 245 for name in theme {
246. 246 entries.push((name, &theme_xml));
247. 247 }
248. 248 zip(&entries)
249. 249}
250. 250
251. 251/// Zips the parts in order with Deflate and a fixed timestamp.
252. 252fn zip(entries: &[(&str, &str)]) -> Result<Vec<u8>, String> {
253. 253 let mut writer = zip::ZipWriter::new(Cursor::new(Vec::new()));
254. 254 let options = zip::write::SimpleFileOptions::default()
255. 255 .compression_method(zip::CompressionMethod::Deflated)
256. 256 .last_modified_time(zip::DateTime::default());
257. 257 for (name, text) in entries {
258. 258 writer
259. 259 .start_file(*name, options)
260. 260 .and_then(|()| writer.write_all(text.as_bytes()).map_err(Into::into))
261. 261 .map_err(|error| format!("could not build the blank package: {error}"))?;
262. 262 }
263. 263 writer
264. 264 .finish()
265. 265 .map(Cursor::into_inner)
266. 266 .map_err(|error| format!("could not build the blank package: {error}"))
267. 267}
268. 268