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
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
pub use crate::prelude::*;
pub use crate::shapelib_toml::*;
use parking_lot::{const_rwlock, RwLock};
use parking_lot::RwLockReadGuard;
static GLOBAL_SHAPELIBS: RwLock<Option<Registry>> = const_rwlock(None);
#[derive(Default)]
pub struct Registry {
libs: HashMap<String, Vec<shapelib::Contents>>,
}
#[derive(Debug)]
pub struct GroupData {
pub groupname: String,
pub d: GroupDetails,
}
#[typetag::deserialize(tag="outline")]
pub trait OutlineDefn: Debug + Sync + Send + 'static {
fn check(&self, lgi: &GroupData) -> Result<(),LLE>;
fn load(&self, lgi: &GroupData) -> Result<Outline,IE>;
}
#[derive(Debug)]
pub struct Contents {
libname: String,
dirname: String,
bundle: Option<bundles::Id>,
items: HashMap<SvgBaseName<GoodItemName>, ItemData>,
}
#[derive(Debug,Clone)]
#[derive(Serialize,Deserialize)]
struct ItemDetails {
desc: Html,
}
#[derive(Debug,Clone)]
struct ItemData {
d: Arc<ItemDetails>,
sort: Option<String>,
group: Arc<GroupData>,
outline: Outline,
occ: OccData,
}
#[derive(Debug,Clone)]
enum OccData {
None,
Internal(Arc<OccData_Internal>),
Back(OccultIlkName),
}
#[allow(non_camel_case_types)]
#[derive(Debug)]
struct OccData_Internal {
item_name: SvgBaseName<Arc<GoodItemName>>,
outline: Outline,
desc: Html,
xform: FaceTransform,
svgd: parking_lot::Mutex<Option<Arc<Html>>>,
}
#[derive(Error,Debug)]
pub enum LibraryLoadError {
#[error(transparent)]
TomlParseError(#[from] toml::de::Error),
#[error("error reading/opening library file: {0}: {1}")]
FileError(String, io::Error),
#[error("OS error globbing for files: {0}")]
GlobFileError(#[from] glob::GlobError),
#[error("internal error: {0}")] InternalError(#[from] InternalError),
#[error("bad glob pattern: {pat:?} (near char {pos}): {msg}")]
BadGlobPattern { pat: String, msg: &'static str, pos: usize },
#[error("glob pattern {pat:?} matched non-utf-8 filename {actual:?}")]
GlobNonUTF8 { pat: String, actual: PathBuf },
#[error("glob pattern {pat:?} matched filename with no extension {path:?}")]
GlobNoExtension { pat: String, path: String },
#[error("occultation colour missing: {0:?}")]
OccultationColourMissing(String),
#[error("back missing for occultation")] BackMissingForOccultation,
#[error("expected TOML table: {0:?}")] ExpectedTable(String),
#[error("expected TOML string: {0:?}")] ExpectedString(String),
#[error("wrong number of size dimensions {got}, expected {expected:?}")]
WrongNumberOfSizeDimensions { got: usize, expected: [usize;2] },
#[error("group {0:?} inherits from nonexistent parent {1:?}")]
InheritMissingParent(String, String),
#[error("inheritance depth limit exceeded: {0:?}")]
InheritDepthLimitExceeded(String),
#[error("duplicate item {item:?} in groups {group1:?} and {group2:?}")]
DuplicateItem { item: String, group1: String, group2: String },
#[error("files list line {0} missing whitespace")]
FilesListLineMissingWhitespace(usize),
#[error("files list line {0}, field must be at start")]
FilesListFieldsMustBeAtStart(usize),
#[error("piece defines multiple faces in multiple ways")]
MultipleMultipleFaceDefinitions,
#[error("{0}")] BadSubstitution(#[from] SubstError),
#[error("{0}")] UnsupportedColourSpec(#[from] UnsupportedColourSpec),
#[error("bad item name (invalid characters) in {0:?}")] BadItemName(String),
}
impl LibraryLoadError {
fn ought(&self) -> InternalError {
internal_error_bydebug(self)
}
}
#[derive(Error,Copy,Clone,Debug)]
pub enum SubstErrorKind {
#[error("missing or unrecognised token {0}")] MissingToken (&'static str),
#[error("repeated token {0}")] RepeatedToken(&'static str),
}
#[derive(Error,Clone,Debug)]
#[error("bad substitution: {input:?} {kind}")]
pub struct SubstError {
pub kind: SubstErrorKind,
pub input: String,
}
const INHERIT_DEPTH_LIMIT: u8 = 20;
type TV = toml::Value;
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct MultiSpec {
pub lib: String,
#[serde(default)]
pub prefix: String,
#[serde(default)]
pub suffix: String,
pub items: Vec<String>,
}
define_index_type! { pub struct DescId = u8; }
define_index_type! { pub struct SvgId = u8; }
#[derive(Copy,Clone,Debug,Serialize,Deserialize)]
struct ItemFace {
svg: SvgId,
desc: DescId,
#[serde(flatten)]
xform: FaceTransform,
}
#[derive(Copy,Clone,Debug,Serialize,Deserialize)]
struct FaceTransform {
centre: [f64; 2],
scale: [f64; 2],
}
#[derive(Debug,Serialize,Deserialize)]
pub struct Item {
itemname: String,
sort: Option<String>,
faces: IndexVec<FaceId, ItemFace>,
svgs: IndexVec<SvgId, Html>,
descs: IndexVec<DescId, Html>,
outline: Outline,
#[serde(default)]
back: Option<Arc<dyn OccultedPieceTrait>>,
}
#[derive(Debug,Serialize,Deserialize)]
struct ItemOccultable {
desc: Html,
svgd: Arc<Html>,
xform: FaceTransform,
outline: Outline,
}
#[derive(Debug,Copy,Clone,Hash,Eq,PartialEq,Ord,PartialOrd)]
#[repr(transparent)]
struct SvgBaseName<T:?Sized>(T);
impl<T> Display for SvgBaseName<T> where T: Display + ?Sized {
#[throws(fmt::Error)]
fn fmt(&self, f: &mut fmt::Formatter) { write!(f, "{}", &self.0)? }
}
impl<T> Borrow<str> for SvgBaseName<T> where T: Borrow<str> {
fn borrow(&self) -> &str { self.0.borrow() }
}
impl<T> SvgBaseName<T> {
fn into_inner(self) -> T { self.0 }
}
impl<T> SvgBaseName<T> where T: ?Sized {
fn as_str(&self) -> &str where T: Borrow<str> { self.0.borrow() }
fn unnest<'l,U>(&'l self) -> &SvgBaseName<U> where U: ?Sized, T: Borrow<U> {
let s: &'l U = self.0.borrow();
let u: &'l SvgBaseName<U> = unsafe { mem::transmute(s) };
u
}
}
deref_to_field!{{ T: ?Sized } SvgBaseName<T>, T, 0 }
impl<T> SvgBaseName<T> where T: Borrow<GoodItemName> {
#[throws(SubstError)]
fn note(src: &mut dyn LibrarySource, i: T,
src_name: Result<&str, &SubstError>) -> Self {
src.note_svg(i.borrow(), src_name)?;
SvgBaseName(i)
}
}
#[dyn_upcast]
impl OutlineTrait for ItemOccultable { delegate! { to self.outline {
fn outline_path(&self, scale: f64) -> Result<Html, IE>;
fn thresh_dragraise(&self) -> Result<Option<Coord>, IE>;
fn bbox_approx(&self) -> Result<Rect, IE>;
}}}
#[typetag::serde(name="Lib")]
impl OccultedPieceTrait for ItemOccultable {
#[throws(IE)]
fn svg(&self, f: &mut Html, _: VisiblePieceId) {
self.xform.write_svgd(f, &self.svgd)?;
}
#[throws(IE)]
fn describe_html(&self) -> Html { self.desc.clone() }
}
#[derive(Debug,Clone,Serialize,Deserialize,Eq,PartialEq,Ord,PartialOrd)]
pub struct ItemEnquiryData {
pub lib: LibraryEnquiryData,
pub itemname: GoodItemName,
pub sortkey: Option<String>,
pub f0desc: Html,
pub f0bbox: Rect,
}
impl From<&ItemEnquiryData> for ItemSpec {
fn from(it: &ItemEnquiryData) -> ItemSpec {
ItemSpec {
lib: it.lib.libname.clone(),
item: it.itemname.as_str().to_owned(),
}
}
}
impl Display for ItemEnquiryData {
#[throws(fmt::Error)]
fn fmt(&self, f: &mut Formatter) {
write!(f, "{:<10} {:20} {}", &self.lib, &self.itemname,
self.f0desc.as_html_str())?;
}
}
#[derive(Debug,Clone,Serialize,Deserialize,Eq,PartialEq,Ord,PartialOrd)]
pub struct LibraryEnquiryData {
pub bundle: Option<bundles::Id>,
pub libname: String,
}
impl Display for LibraryEnquiryData {
#[throws(fmt::Error)]
fn fmt(&self, f: &mut Formatter) {
if let Some(id) = self.bundle.as_ref() {
write!(f, "[{}] ", id)?;
}
if self.libname.chars().all(|c| {
c.is_alphanumeric() || c=='-' || c=='_' || c=='.'
}) {
Display::fmt(&self.libname, f)?;
} else {
Debug::fmt(&self.libname, f)?;
}
}
}
#[dyn_upcast]
impl OutlineTrait for Item { delegate! { to self.outline {
fn outline_path(&self, scale: f64) -> Result<Html, IE>;
fn thresh_dragraise(&self) -> Result<Option<Coord>, IE>;
fn bbox_approx(&self) -> Result<Rect, IE>;
}}}
impl FaceTransform {
#[throws(LLE)]
fn from_group(d: &GroupDetails) -> Self {
let scale = if ! d.orig_size.is_empty() && ! d.size.is_empty() {
izip!(&d.orig_size, &d.size)
.map(|(&orig_size, &target_size)| {
target_size / orig_size
})
.cycle()
.take(2)
.collect::<ArrayVec<_,2>>()
.into_inner()
.unwrap()
} else {
let s = d.scale;
[s,s]
};
let centre = d.centre.map(Ok).unwrap_or_else(|| Ok::<_,LLE>({
match d.size.as_slice() {
[a] => [a,a],
[a,b] => [a,b],
x => throw!(LLE::WrongNumberOfSizeDimensions {
got: x.len(),
expected: [1,2],
}),
}.iter().cloned().zip(&scale).map(|(size,scale)| {
size * 0.5 / scale
})
.collect::<ArrayVec<_,2>>()
.into_inner()
.unwrap()
}))?;
FaceTransform { centre, scale }
}
#[throws(IE)]
fn write_svgd(&self, f: &mut Html, svgd: &Html) {
hwrite!(f,
r##"<g transform="scale({} {}) translate({} {})">{}</g>"##,
self.scale[0], self.scale[1], -self.centre[0], -self.centre[1],
svgd)?;
}
}
impl Item {
#[throws(IE)]
fn svg_face(&self, f: &mut Html, face: FaceId, vpid: VisiblePieceId) {
if let Some(face) = self.faces.get(face) {
let svgd = &self.svgs[face.svg];
face.xform.write_svgd(f, svgd)?;
} else if let Some(back) = &self.back {
back.svg(f, vpid)?;
} else {
throw!(internal_error_bydebug(&(self, face)))
}
}
#[throws(IE)]
fn describe_face(&self, face: FaceId) -> Html {
let face = self.faces.get(face).unwrap_or(&self.faces[0]);
self.descs[ face.desc ].clone()
}
}
#[typetag::serde(name="Lib")]
impl PieceTrait for Item {
fn nfaces(&self) -> RawFaceId {
(self.faces.len()
+ self.back.iter().count())
.try_into().unwrap()
}
#[throws(IE)]
fn svg_piece(&self, f: &mut Html, gpc: &GPiece,
_gs: &GameState, vpid: VisiblePieceId) {
self.svg_face(f, gpc.face, vpid)?;
}
#[throws(IE)]
fn describe_html(&self, gpc: &GPiece, _goccults: &GameOccults) -> Html {
self.describe_face(gpc.face)?
}
fn itemname(&self) -> &str { &self.itemname }
fn sortkey(&self) -> Option<&str> { self.sort.as_ref().map(AsRef::as_ref) }
}
#[typetag::serde(name="LibItem")]
impl OccultedPieceTrait for Item {
#[throws(IE)]
fn svg(&self, f: &mut Html, id: VisiblePieceId) {
self.svg_face(f, default(), id)?;
}
#[throws(IE)]
fn describe_html(&self) -> Html {
self.describe_face(default())?
}
}
impl Registry {
pub fn add(&mut self, data: Contents) {
self.libs
.entry(data.libname.clone()).or_default()
.push(data);
}
pub fn clear(&mut self) {
self.libs.clear()
}
pub fn iter(&self) -> impl Iterator<Item=&[Contents]> {
self.libs.values().map(|v| v.as_slice())
}
}
pub struct AllRegistries<'ig> {
global: RwLockReadGuard<'static, Option<Registry>>,
ig: &'ig Instance,
}
pub struct AllRegistriesIterator<'i> {
regs: &'i AllRegistries<'i>,
count: u8,
}
impl<'i> Iterator for AllRegistriesIterator<'i> {
type Item = &'i Registry;
fn next(&mut self) -> Option<&'i Registry> {
loop {
let r = match self.count {
0 => self.regs.global.as_ref(),
1 => Some(&self.regs.ig.local_libs),
_ => return None,
};
self.count += 1;
if r.is_some() { return r }
}
}
}
impl Instance {
pub fn all_shapelibs(&self) -> AllRegistries<'_> {
AllRegistries {
global: GLOBAL_SHAPELIBS.read(),
ig: self,
}
}
}
impl<'ig> AllRegistries<'ig> {
pub fn iter(&'ig self) -> AllRegistriesIterator<'ig> {
AllRegistriesIterator {
regs: self,
count: 0,
}
}
}
pub fn lib_name_list(ig: &Instance) -> Vec<String> {
ig.all_shapelibs().iter().map(
|reg| reg.libs.keys().cloned()
).flatten().collect()
}
impl<'ig> AllRegistries<'ig> {
pub fn all_libs(&self) -> impl Iterator<Item=&[Contents]> {
self.iter().map(|reg| ®.libs).flatten().map(
|(_libname, lib)| lib.as_slice()
)
}
pub fn lib_name_lookup(&self, libname: &str) -> Result<&[Contents], SpE> {
for reg in self.iter() {
if let Some(r) = reg.libs.get(libname) { return Ok(r) }
}
return Err(SpE::LibraryNotFound);
}
}
pub type ItemSpecLoaded = (Box<Item>, PieceSpecLoadedOccultable);
impl From<ItemSpecLoaded> for PieceSpecLoaded {
fn from((p, occultable): ItemSpecLoaded) -> PieceSpecLoaded {
PieceSpecLoaded {
p,
occultable,
loaded_via_alias: None,
}
}
}
impl ItemSpec {
#[throws(SpecError)]
pub fn find_load(&self, ig: &Instance, depth: SpecDepth) -> ItemSpecLoaded {
let regs = ig.all_shapelibs();
let libs = regs.lib_name_lookup(&self.lib)?;
let (lib, (item, idata)) = libs.iter().rev().find_map(
|lib| Some((lib, lib.items.get_key_value(self.item.as_str())?))
)
.ok_or(SpE::LibraryItemNotFound(self.clone()))?;
lib.load1(idata, &self.lib, item.unnest::<str>(), ig, depth)?
}
fn from_strs<L,I>(lib: &L, item: &I) -> Self
where L: ToOwned<Owned=String> + ?Sized,
I: ToOwned<Owned=String> + ?Sized,
{
let lib = lib .to_owned();
let item = item.to_owned();
ItemSpec{ lib, item }
}
}
impl Contents {
#[throws(SpecError)]
fn load_svg(&self, item_name: &SvgBaseName<str>,
lib_name_for: &str, item_for: &str)
-> Html {
let svg_path = format!("{}/{}.usvg", self.dirname, item_name);
let svg_data = fs::read_to_string(&svg_path)
.map_err(|e| if e.kind() == ErrorKind::NotFound {
warn!("library item lib={} itme={} for={:?} data file {:?} not found",
&self.libname, item_name, item_for, &svg_path);
let spec_for = ItemSpec::from_strs(lib_name_for, item_for);
SpE::LibraryItemNotFound(spec_for)
} else {
let m = "error accessing/reading library item data file";
error!("{}: {} {:?}: {}", &m, &svg_path, item_for, &e);
SpE::InternalError(m.to_string())
})?;
Html::from_html_string(svg_data)
}
#[throws(SpecError)]
fn load1(&self, idata: &ItemData, lib_name: &str,
name: &SvgBaseName<str>,
ig: &Instance, depth:SpecDepth)
-> ItemSpecLoaded {
let svg_data = self.load_svg(name, lib_name, &**name)?;
idata.group.d.outline.check(&idata.group)
.map_err(|e| SpE::InternalError(format!("rechecking outline: {}",&e)))?;
let outline = idata.outline.clone();
let mut svgs = IndexVec::with_capacity(1);
let svg = svgs.push(svg_data);
let mut descs = index_vec![ ];
let desc = descs.push(idata.d.desc.clone());
descs.shrink_to_fit();
let xform = FaceTransform::from_group(&idata.group.d)
.map_err(|e| SpE::InternalError(format!("reckoning transform: {}",&e)))?;
let mut face = ItemFace { svg, desc, xform };
let mut faces = index_vec![ face ];
let mut back = None::<Arc<dyn OccultedPieceTrait>>;
if idata.group.d.flip {
face.xform.scale[0] *= -1.;
faces.push(face);
} else if let Some(back_spec) = &idata.group.d.back {
match back_spec.load_occult(ig, depth) {
Err(SpecError::AliasNotFound) => { },
Err(e) => throw!(e),
Ok(p) => {
let p = p.into();
back = Some(p);
}
}
}
faces.shrink_to_fit();
let occultable = match &idata.occ {
OccData::None => None,
OccData::Back(ilk) => {
if let Some(back) = &back {
let back = back.clone();
Some((ilk.clone(), back))
} else {
None
}
},
OccData::Internal(occ) => {
let occ_name = occ.item_name.clone();
let svgd = {
let mut svgd = occ.svgd.lock();
let svgd = &mut *svgd;
let svgd = match svgd {
Some(svgd) => svgd.clone(),
None => {
let occ_data = self.load_svg(
occ.item_name.unnest::<GoodItemName>().unnest(),
lib_name, name.as_str()
)?;
let occ_data = Arc::new(occ_data);
*svgd = Some(occ_data.clone());
occ_data
},
};
svgd
};
let it = Arc::new(ItemOccultable {
svgd,
xform: occ.xform.clone(),
desc: occ.desc.clone(),
outline: occ.outline.clone(),
}) as Arc<dyn OccultedPieceTrait>;
Some((OccultIlkName(occ_name.into_inner()), it))
},
};
let sort = idata.sort.clone();
let it = Item { faces, sort, descs, svgs, outline, back,
itemname: name.to_string() };
(Box::new(it), occultable)
}
pub fn enquiry(&self) -> LibraryEnquiryData {
LibraryEnquiryData {
libname: self.libname.clone(),
bundle: self.bundle,
}
}
#[throws(MgmtError)]
pub fn list_glob(&self, pat: &str) -> Vec<ItemEnquiryData> {
let pat = glob::Pattern::new(pat).map_err(|pe| ME::BadGlob {
pat: pat.to_string(), msg: pe.msg.to_string() })?;
let mut out = vec![];
for (k,v) in &self.items {
if !pat.matches(k.as_str()) { continue }
let (loaded, _) = match
self.load1(v, &self.libname, k.unnest(),
&Instance::dummy(), SpecDepth::zero())
{
Err(SpecError::LibraryItemNotFound(_)) => continue,
e@ Err(_) => e?,
Ok(r) => r,
};
let f0bbox = loaded.bbox_approx()?;
let ier = ItemEnquiryData {
lib: self.enquiry(),
itemname: (**k).to_owned(),
sortkey: v.sort.to_owned(),
f0bbox,
f0desc: loaded.describe_face(default())?,
};
out.push(ier);
}
out
}
}
#[typetag::serde(name="Lib")]
impl PieceSpec for ItemSpec {
#[throws(SpecError)]
fn load(&self, _: usize, _: &mut GPiece, ig: &Instance, depth: SpecDepth)
-> PieceSpecLoaded {
self.find_load(ig,depth)?.into()
}
#[throws(SpecError)]
fn load_occult(&self, ig: &Instance, depth: SpecDepth)
-> Box<dyn OccultedPieceTrait> {
self.find_load(ig,depth)?.0 as Box<dyn OccultedPieceTrait>
}
}
#[typetag::serde(name="LibList")]
impl PieceSpec for MultiSpec {
#[throws(SpecError)]
fn count(&self, _pcaliases: &PieceAliases) -> usize { self.items.len() }
#[throws(SpecError)]
fn load(&self, i: usize, _: &mut GPiece, ig: &Instance, depth:SpecDepth)
-> PieceSpecLoaded
{
let item = self.items.get(i).ok_or_else(
|| SpE::InternalError(format!("item {:?} from {:?}", i, &self))
)?;
let item = format!("{}{}{}", &self.prefix, item, &self.suffix);
let lib = self.lib.clone();
ItemSpec { lib, item }.find_load(ig,depth)?.into()
}
}
#[throws(LibraryLoadError)]
fn resolve_inherit<'r>(depth: u8, groups: &toml::value::Table,
group_name: &str, group: &'r toml::Value)
-> Cow<'r, toml::value::Table> {
let gn = || format!("{}", group_name);
let gp = || format!("group.{}", group_name);
let group = group.as_table().ok_or_else(|| LLE::ExpectedTable(gp()))?;
let parent_name = match group.get("inherit") {
None => { return Cow::Borrowed(group) }
Some(p) => p,
};
let parent_name = parent_name
.as_str().ok_or_else(|| LLE::ExpectedString(format!("group.{}.inherit",
group_name)))?;
let parent = groups.get(parent_name)
.ok_or_else(|| LLE::InheritMissingParent(gn(), parent_name.to_string()))?;
let mut build = resolve_inherit(
depth.checked_sub(1).ok_or_else(|| LLE::InheritDepthLimitExceeded(gn()))?,
groups, parent_name, parent
)?.into_owned();
build.extend(group.iter().map(|(k,v)| (k.clone(), v.clone())));
Cow::Owned(build)
}
pub trait LibrarySource {
fn catalogue_data(&self) -> &str;
fn svg_dir(&self) -> String;
#[throws(SubstError)]
fn note_svg(&mut self, _basename: &GoodItemName,
_src_name: Result<&str, &SubstError>) { }
fn bundle(&self) -> Option<bundles::Id>;
}
struct BuiltinLibrary<'l> {
catalogue_data: &'l str,
dirname: &'l str,
}
impl LibrarySource for BuiltinLibrary<'_> {
fn catalogue_data(&self) -> &str { self.catalogue_data }
fn svg_dir(&self) -> String { self.dirname.to_string() }
fn bundle(&self) -> Option<bundles::Id> { None }
}
#[throws(LibraryLoadError)]
pub fn load_catalogue(libname: &str, src: &mut dyn LibrarySource) -> Contents {
let toplevel: toml::Value = src.catalogue_data().parse()?;
let mut l = Contents {
bundle: src.bundle(),
libname: libname.to_string(),
items: HashMap::new(),
dirname: src.svg_dir(),
};
let empty_table = toml::value::Value::Table(default());
let groups =
toplevel
.as_table().ok_or_else(|| LLE::ExpectedTable(format!("toplevel")))?
.get("group").unwrap_or(&empty_table)
.as_table().ok_or_else(|| LLE::ExpectedTable(format!("group")))?;
for (groupname, gdefn) in groups {
let gdefn = resolve_inherit(INHERIT_DEPTH_LIMIT,
&groups, groupname, gdefn)?;
let gdefn: GroupDefn = TV::Table(gdefn.into_owned()).try_into()?;
let d = GroupDetails {
size: gdefn.d.size.iter().map(|s| s * gdefn.d.scale).collect(),
..gdefn.d
};
let group = Arc::new(GroupData {
groupname: groupname.clone(),
d,
});
group.d.outline.check(&group)?;
if [
group.d.flip,
group.d.back.is_some(),
].iter().filter(|x|**x).count() > 1 {
throw!(LLE::MultipleMultipleFaceDefinitions)
}
for fe in gdefn.files.0 {
#[throws(SubstError)]
fn subst(before: &str, needle: &'static str, replacement: &str)
-> String {
use SubstErrorKind as SEK;
let err = |kind| SubstError { kind, input: before.to_string() };
let mut matches = before.match_indices(needle);
let m1 = matches.next().ok_or(err(SEK::MissingToken(needle)))?;
if matches.next().is_some() { Err(err(SEK::RepeatedToken(needle)))?; }
let mut lhs = &before[0.. m1.0];
let mut rhs = &before[m1.0 + m1.1.len() ..];
if replacement.is_empty() {
let lhs_trimmed = lhs.trim_end();
if lhs_trimmed.len() != lhs.len() {
lhs = lhs_trimmed;
} else {
rhs = rhs.trim_start();
}
}
lhs
.to_owned()
+ replacement
+ rhs
}
let outline = group.d.outline.load(&group)?;
let item_name = format!("{}{}{}", gdefn.item_prefix,
fe.item_spec, gdefn.item_suffix);
let item_name: GoodItemName = item_name.try_into()?;
let sort = match (gdefn.sort.as_str(), fe.extra_fields.get("sort")) {
("", None) => None,
(gd, None) => Some(gd.to_string()),
("", Some(ef)) => Some(ef.to_string()),
(gd, Some(ef)) => Some(subst(gd, "_s", ef)?),
};
let occ = match &group.d.occulted {
None => OccData::None,
Some(OccultationMethod::ByColour { colour }) => {
if ! group.d.colours.contains_key(colour.0.as_str()) {
throw!(LLE::OccultationColourMissing(colour.0.clone()));
}
let item_name = subst(item_name.as_str(), "_c", &colour.0)?;
let src_name = subst(&fe.src_file_spec, "_c", &colour.0);
let item_name: GoodItemName = item_name.try_into()?;
let item_name = SvgBaseName::note(
src, Arc::new(item_name), src_name.as_ref().map(|s| s.as_str()),
)?;
let desc = subst(&fe.desc, "_colour", "")?.to_html();
OccData::Internal(Arc::new(OccData_Internal {
item_name,
outline: outline.clone(),
xform: FaceTransform::from_group(&group.d)?,
svgd: default(),
desc,
}))
},
Some(OccultationMethod::ByBack { ilk }) => {
if group.d.back.is_none() {
throw!(LLE::BackMissingForOccultation)
}
OccData::Back(ilk.clone())
},
};
let mut add1 = |
item_name: &GoodItemName,
src_name: Result<&str,&SubstError>,
sort,
desc: &str
| {
let desc = if let Some(desc_template) = &group.d.desc_template {
subst(desc_template, "_desc", &desc)?.to_html()
} else {
desc.to_html()
};
let idata = ItemData {
group: group.clone(),
occ: occ.clone(),
outline: outline.clone(),
sort,
d: Arc::new(ItemDetails { desc }),
};
type H<'e,X,Y> = hash_map::Entry<'e,X,Y>;
let new_item = SvgBaseName::note(
src, item_name.clone(), src_name.clone()
)?;
match l.items.entry(new_item) {
H::Occupied(oe) => throw!(LLE::DuplicateItem {
item: item_name.as_str().to_owned(),
group1: oe.get().group.groupname.clone(),
group2: groupname.clone(),
}),
H::Vacant(ve) => {
debug!("loaded shape {} {}", libname, item_name.as_str());
ve.insert(idata);
}
};
Ok::<_,LLE>(())
};
if group.d.colours.is_empty() {
add1(&item_name, Ok(fe.src_file_spec.as_str()),
sort, &fe.desc.clone())?;
} else {
for (colour, recolourdata) in &group.d.colours {
let t_sort = sort.as_ref().map(
|s| subst(&s, "_c", colour)).transpose()?;
let c_abbrev = &recolourdata.abbrev;
let t_item_name = subst(item_name.as_str(), "_c", c_abbrev)?;
let t_src_name = subst(&fe.src_file_spec, "_c", c_abbrev);
let t_src_name = t_src_name.as_ref().map(|s| s.as_str());
let t_desc = subst(&fe.desc, "_colour", colour)?;
add1(&t_item_name.try_into()?, t_src_name, t_sort, &t_desc)?;
}
}
}
}
l
}
#[derive(Deserialize,Debug,Clone)]
#[serde(untagged)]
pub enum Config1 {
PathGlob(String),
Explicit(Explicit1),
}
#[derive(Deserialize,Debug,Clone)]
pub struct Explicit1 {
pub name: String,
pub catalogue: String,
pub dirname: String,
}
#[throws(LibraryLoadError)]
pub fn load_1_global_library(l: &Explicit1) {
let toml_path = &l.catalogue;
let catalogue_data = {
let ioe = |io| LLE::FileError(toml_path.to_string(), io);
let f = File::open(toml_path).map_err(ioe)?;
let mut f = BufReader::new(f);
let mut s = String::new();
f.read_to_string(&mut s).map_err(ioe)?;
s
};
let catalogue_data = catalogue_data.as_str();
let mut src = BuiltinLibrary { dirname: &l.dirname, catalogue_data };
let data = load_catalogue(&l.name, &mut src)?;
let count = data.items.len();
GLOBAL_SHAPELIBS.write()
.get_or_insert_with(default)
.add(data);
info!("loaded {} shapes in library {:?} from {:?} and {:?}",
count, &l.name, &l.catalogue, &l.dirname);
}
impl Config1 {
fn resolve(&self) -> Result<Box<dyn ExactSizeIterator<Item=Explicit1>>, LibraryLoadError> {
use Config1::*;
Ok(match self {
Explicit(e) => Box::new(iter::once(e.clone())),
PathGlob(pat) => {
#[throws(LLE)]
fn resolve_globresult(pat: &str, globresult: glob::GlobResult)
-> Explicit1 {
let path = globresult?;
let path = path.to_str().ok_or_else(
|| LLE::GlobNonUTF8
{ pat: pat.to_string(), actual: path.clone() })?
.to_string();
let dirname = path.rsplitn(2,'.').nth(1).ok_or_else(
|| LLE::GlobNoExtension
{ pat: pat.to_string(), path: path.clone() })?;
let base = dirname.rsplit('/').next().unwrap();
Explicit1 {
name: base.to_string(),
dirname: dirname.to_string(),
catalogue: path,
}
}
let results = glob::glob_with(pat, glob::MatchOptions {
require_literal_separator: true,
require_literal_leading_dot: true,
..default()
})
.map_err(
|glob::PatternError { pos, msg, .. }|
LLE::BadGlobPattern { pat: pat.clone(), pos, msg }
)?
.map(|globresult| resolve_globresult(pat, globresult))
.collect::<Result<Vec<_>, LLE>>()?;
Box::new(results.into_iter())
}
})
}
}
#[throws(LibraryLoadError)]
pub fn load_global_libs(libs: &Vec<Config1>) {
for l in libs {
let libs = l.resolve()?;
let n = libs.len();
for e in libs {
load_1_global_library(&e)?;
}
info!("loaded {} shape libraries from {:?}", n, &l);
}
}
#[derive(Clone,Copy,Debug,Serialize,Deserialize)]
pub struct CircleShape { pub diam: f64 }
#[dyn_upcast]
impl OutlineTrait for CircleShape {
#[throws(IE)]
fn outline_path(&self, scale: f64) -> Html {
svg_circle_path(self.diam * scale)?
}
#[throws(IE)]
fn thresh_dragraise(&self) -> Option<Coord> {
Some((self.diam * 0.5) as Coord)
}
#[throws(IE)]
fn bbox_approx(&self) -> Rect {
let d = (self.diam * 0.5).round() as Coord;
Rect{ corners: [PosC::new(-d,-d), PosC::new(d, d)]}
}
}
#[derive(Deserialize,Debug)]
struct CircleDefn { }
#[typetag::deserialize(name="Circle")]
impl OutlineDefn for CircleDefn {
#[throws(LibraryLoadError)]
fn check(&self, lgd: &GroupData) { Self::get_size(lgd)?; }
fn load(&self, lgd: &GroupData) -> Result<Outline,IE> {
Ok(CircleShape {
diam: Self::get_size(lgd).map_err(|e| e.ought())?,
}.into())
}
}
impl CircleDefn {
#[throws(LibraryLoadError)]
fn get_size(group: &GroupData) -> f64 {
match group.d.size.as_slice() {
&[c] => c,
size => throw!(LLE::WrongNumberOfSizeDimensions
{ got: size.len(), expected: [1,1] }),
}
}
}
#[derive(Clone,Copy,Debug,Serialize,Deserialize)]
pub struct RectShape { pub xy: PosC<f64> }
impl RectShape {
#[throws(CoordinateOverflow)]
pub fn rect(&self, centre: Pos) -> RectC<Coord> {
let offset = (self.xy * 0.5)?;
let offset = offset.try_map(
|c| c.floor().to_i32().ok_or(CoordinateOverflow)
)?;
let rect = RectC{ corners:
[-1,1].iter().map(|&signum| Ok::<_,CoordinateOverflow>({
(centre + (offset * signum)?)?
}))
.collect::<Result<ArrayVec<_,2>,_>>()?
.into_inner().unwrap()
};
rect
}
#[throws(CoordinateOverflow)]
pub fn region(&self, centre: Pos) -> Region {
Region::Rect(self.rect(centre)?)
}
}
#[dyn_upcast]
impl OutlineTrait for RectShape {
#[throws(IE)]
fn outline_path(&self, scale: f64) -> Html {
let xy = (self.xy * scale)?;
svg_rectangle_path(xy)?
}
#[throws(IE)]
fn thresh_dragraise(&self) -> Option<Coord> {
let smallest: f64 = self.xy.coords.iter().cloned()
.map(OrderedFloat::from).min().unwrap().into();
Some((smallest * 0.5) as Coord)
}
#[throws(IE)]
fn bbox_approx(&self) -> Rect {
let pos: Pos = self.xy.map(
|v| ((v * 0.5).round()) as Coord
);
let neg = (-pos)?;
Rect{ corners: [ neg, pos ] }
}
}
#[derive(Deserialize,Debug)]
struct RectDefn { }
#[typetag::deserialize(name="Rect")]
impl OutlineDefn for RectDefn {
#[throws(LibraryLoadError)]
fn check(&self, lgd: &GroupData) { Self::get(lgd)?; }
fn load(&self, lgd: &GroupData) -> Result<Outline,IE> {
Ok(
Self::get(lgd).map_err(|e| e.ought())?.into()
)
}
}
impl RectDefn {
#[throws(LibraryLoadError)]
fn get(group: &GroupData) -> RectShape {
RectShape { xy: PosC{ coords:
match group.d.size.as_slice() {
&[s] => [s,s],
s if s.len() == 2 => s.try_into().unwrap(),
size => throw!(LLE::WrongNumberOfSizeDimensions
{ got: size.len(), expected: [1,2]}),
}
}}
}
}
impl TryFrom<String> for FileList {
type Error = LLE;
fn try_from(s: String) -> Result<FileList,LLE> {
let mut o = Vec::new();
let mut xfields = Vec::new();
for (lno,l) in s.lines().enumerate() {
let l = l.trim();
if l=="" || l.starts_with("#") { continue }
if let Some(xfields_spec) = l.strip_prefix(':') {
if ! (o.is_empty() && xfields.is_empty()) {
throw!(LLE::FilesListFieldsMustBeAtStart(lno));
}
xfields = xfields_spec.split_ascii_whitespace()
.filter(|s| !s.is_empty())
.map(|s| s.to_owned())
.collect::<Vec<_>>();
continue;
}
let mut remain = &*l;
let mut n = ||{
let ws = remain.find(char::is_whitespace)
.ok_or(LLE::FilesListLineMissingWhitespace(lno))?;
let (l, r) = remain.split_at(ws);
remain = r.trim_start();
Ok::<_,LLE>(l.to_owned())
};
let item_spec = n()?;
let src_file_spec = n()?;
let extra_fields = xfields.iter()
.map(|field| Ok::<_,LLE>((field.to_owned(), n()?.to_owned())))
.collect::<Result<_,_>>()?;
let desc = remain.to_owned();
o.push(FileData{ item_spec, src_file_spec, extra_fields, desc });
}
Ok(FileList(o))
}
}