-
Notifications
You must be signed in to change notification settings - Fork 6
/
Copy pathProcessInclude.cs
1972 lines (1868 loc) · 98.7 KB
/
ProcessInclude.cs
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
using System.Xml;
using System.Text.RegularExpressions;
using System.Text;
using System.Data.Common;
using System.Diagnostics.CodeAnalysis;
using System.Xml.Serialization;
using System.Globalization;
using System.Diagnostics;
using System.Security.Principal;
using System.Collections.Specialized;
using System.Runtime.InteropServices;
using System.Collections;
namespace OpenKNXproducer
{
public partial class ProcessInclude
{
public const string cOwnNamespace = "http://github.com/OpenKNX/OpenKNXproducer";
public class ConfigEntry
{
public string ConfigValue;
public bool WasReplaced;
}
public static readonly Dictionary<string, ConfigEntry> Config = new();
private XmlNamespaceManager nsmgr;
private readonly XmlDocument mDocument = new();
private bool mLoaded = false;
readonly StringBuilder mHeaderGenerated = new();
private static readonly Dictionary<string, XmlNode> sParameterTypes = new();
private bool mParameterTypesFetched;
private static readonly Dictionary<string, ProcessInclude> gIncludes = new();
private static int sMaxKoNumber = 0;
private readonly string mXmlFileName;
public string XmlFileName { get { return mXmlFileName; } }
private readonly string mHeaderPrefixName;
private bool mHeaderParameterStartGenerated;
private bool mHeaderParameterBlockGenerated;
private bool mHeaderKoStartGenerated;
private bool mHeaderKoBlockGenerated;
private int mChannelCount = 1;
public int OriginalChannelCount = -1;
public int ParameterBlockOffset = 0;
public int ParameterBlockSize = -1;
public int KoOffset = 0;
public int KoSingleOffset = 0;
public int ModuleType = 1;
public bool IsScript = false;
public string[] ReplaceKeys = { };
public string[] ReplaceValues = { };
private int mKoBlockSize = 0;
public static bool Renumber = false;
public static bool AbsoluteSingleParameters = false;
public bool IsInnerInclude = false;
public bool IsPart = false;
public int ChannelCount
{
get { return mChannelCount; }
set
{
Program.MaxNumChannels = mChannelCount;
mChannelCount = value;
OriginalChannelCount = value;
}
}
private void FetchParameterTypes()
{
if (!mParameterTypesFetched)
{
// before we start with template processing, we calculate all Parameter relevant info
XmlNode lParameterTypes = mDocument.SelectSingleNode("//ApplicationProgram/Static/ParameterTypes");
if (lParameterTypes != null)
{
foreach (XmlNode lChild in lParameterTypes.ChildNodes)
if (lChild.NodeType == XmlNodeType.Element)
{
string lParameterTypeId = lChild.SubId("Id", "_PT-");
if (lParameterTypeId != "" && !sParameterTypes.ContainsKey(lParameterTypeId))
{
// Speed: we don't add the full type node, just the type definition itself
XmlNode lTypeChild = lChild.FirstChild;
while (lTypeChild != null && lTypeChild.NodeType == XmlNodeType.Comment) lTypeChild = lTypeChild.NextSibling;
sParameterTypes.Add(lParameterTypeId, lTypeChild);
}
}
}
mParameterTypesFetched = true;
}
}
public static XmlNode ParameterType(string iId, bool iError = true)
{
string lId = "_PT-";
if (iId.Contains(lId)) lId = iId;
lId = lId.Split("_PT-")[1];
if (sParameterTypes.ContainsKey(lId))
return sParameterTypes[lId];
else if (iError)
Program.Message(true, "ParameterType {0} was not declared, before it was used. Usually the declaration is missing or the include order of you used modules is wrong!", iId);
return null;
}
public static int GetIdOfProjectNamespace(XmlDocument iDocument)
{
string lProject = iDocument.DocumentElement.NodeAttr("oldxmlns");
lProject = lProject.Replace("http://knx.org/xml/project/", "");
int.TryParse(lProject, out int lResult);
return lResult;
}
private bool mSingletonDefinesAdded = false;
public string HeaderGenerated
{
get
{
if (!mSingletonDefinesAdded)
{
mHeaderGenerated.Insert(0, @"
#define paramDelay(time) (uint32_t)( \
(time & 0xC000) == 0xC000 ? (time & 0x3FFF) * 100 : \
(time & 0xC000) == 0x0000 ? (time & 0x3FFF) * 1000 : \
(time & 0xC000) == 0x4000 ? (time & 0x3FFF) * 60000 : \
(time & 0xC000) == 0x8000 ? ((time & 0x3FFF) > 1000 ? 3600000 : \
(time & 0x3FFF) * 3600000 ) : 0 )
");
mHeaderGenerated.Insert(0, "#pragma once\n\n");
mSingletonDefinesAdded = true;
}
return mHeaderGenerated.ToString();
}
}
public static ProcessInclude Factory(string iXmlFileName, string iHeaderPrefixName)
{
ProcessInclude lInclude = null;
string lXmlFileName = Path.GetFileName(iXmlFileName);
if (gIncludes.ContainsKey(lXmlFileName))
{
// Console.WriteLine("Reusing existing include {0}", iXmlFileName);
lInclude = gIncludes[lXmlFileName];
}
else
{
Console.WriteLine("Processing include {0}", iXmlFileName);
lInclude = new ProcessInclude(iXmlFileName, iHeaderPrefixName);
gIncludes.Add(lXmlFileName, lInclude);
}
return lInclude;
}
private ProcessInclude(string iXmlFileName, string iHeaderPrefixName)
{
mXmlFileName = iXmlFileName;
mBaggagesName = Path.GetFileName(iXmlFileName).Replace(".xml", ".baggages");
if (iHeaderPrefixName != "" && !iHeaderPrefixName.EndsWith('_')) iHeaderPrefixName += "_";
mHeaderPrefixName = iHeaderPrefixName;
}
static int GetHeaderParameter(string iHeaderFileContent, string iDefineName)
{
string lPattern = "#define.*" + iDefineName + @"\s*(\d{1,4})";
Match m = Regex.Match(iHeaderFileContent, lPattern, RegexOptions.None);
int lResult = -1;
if (m.Groups.Count > 1)
{
int.TryParse(m.Groups[1].Value, out lResult);
}
return lResult;
}
public XmlNodeList SelectNodes(string iXPath)
{
return mDocument.SelectNodes(iXPath, nsmgr);
}
public XmlNode SelectSingleNode(string iXPath)
{
return mDocument.SelectSingleNode(iXPath, nsmgr);
}
static string CalculateId(int iApplicationNumber, int iApplicationVersion)
{
return string.Format("-{0:X4}-{1:X2}-0000", iApplicationNumber, iApplicationVersion);
}
public XmlDocument GetDocument()
{
return mDocument;
}
public void ResetXsd()
{
XmlNode lXmlModel = mDocument.FirstChild?.NextSibling;
// the following if has to be very specific, because an assignment to InnerText of an XmlElement might delete all inner tags!!!
if (lXmlModel != null && lXmlModel.NodeType == XmlNodeType.ProcessingInstruction && lXmlModel.InnerText.Contains("-editor.xsd"))
lXmlModel.InnerText = lXmlModel.InnerText.Replace("-editor.xsd", ".xsd");
}
public void DocumentDebugOutput()
{
mDocument.Save(Path.ChangeExtension(mXmlFileName, "out.xml"));
}
public void SetToolAndVersion()
{
mDocument.DocumentElement.RemoveAttribute("CreatedBy");
mDocument.DocumentElement.SetAttribute("CreatedBy", typeof(Program).Assembly.GetName().Name);
mDocument.DocumentElement.RemoveAttribute("ToolVersion");
// alternative version in case ETS does not accept our tool versions anymore
// System.Diagnostics.FileVersionInfo info = FileVersionInfo.GetVersionInfo(Path.Combine(iETSPath, "Knx.Ets.XmlSigning.dll"));
// toolVersion = $"{info.FileVersion}.{info.FilePrivatePart}";
mDocument.DocumentElement.SetAttribute("ToolVersion", typeof(Program).Assembly.GetName().Version.ToString());
}
public void SetNamespace()
{
// we restore the original namespace, if necessary
if (mDocument.DocumentElement.GetAttribute("xmlns") == "")
{
string lXmlns = mDocument.DocumentElement.GetAttribute("oldxmlns");
if (lXmlns != "")
{
mDocument.DocumentElement.SetAttribute("xmlns", lXmlns);
mDocument.DocumentElement.RemoveAttribute("oldxmlns");
}
}
}
public string GetNamespace()
{
return mDocument.DocumentElement.GetAttribute("xmlns");
}
public bool Expand()
{
// here we recursively process all includes and all channel repetitions
LoadAdvanced(mXmlFileName);
// we use here an empty DefineContent, just for startup
ExportHeader(DefineContent.Empty, mHeaderPrefixName, this);
ProcessModule.ExportHeaderParameterAll(this, mHeaderGenerated);
// finally we do all processing necessary for the whole (resolved) document
// mDocument.Save("TemplateApplication.expanded.xml");
bool lWithVersions = ProcessFinish(mDocument);
// DocumentDebugOutput();
return lWithVersions;
}
private static int ChannelCalculationHelper(int iChannel, string iExpression)
{
char lOperator = iExpression[0];
if (int.TryParse(iExpression[1..], out int lOperand))
switch (lOperator)
{
case '*':
iChannel *= lOperand;
break;
case '-':
iChannel -= lOperand;
break;
default:
iChannel += lOperand;
break;
}
return iChannel;
}
static string ReplaceChannelTemplate(string iValue, int iChannel)
{
string lResult = iValue;
bool lReplaced = false;
Match lMatch;
// support multiple occurrences
if (iValue.Contains('%'))
{
do
{
lMatch = Regex.Match(lResult, @"%(C{1,4})(\*\d{1,3})?([\+\-]\d{1,4})?%");
lReplaced = false;
if (lMatch.Captures.Count > 0)
{
int lLen = lMatch.Groups[1].Value.Length;
string lFormat = string.Format("D{0}", lLen);
for (int lGroup = 2; lGroup < lMatch.Groups.Count; lGroup++)
if (lMatch.Groups[lGroup].Success)
iChannel = ChannelCalculationHelper(iChannel, lMatch.Groups[lGroup].Value);
lResult = lResult.Replace(lMatch.Value, iChannel.ToString(lFormat));
lReplaced = true;
}
} while (lReplaced);
do
{
lMatch = Regex.Match(lResult, @"%(Z{1,4})%");
lReplaced = false;
if (lMatch.Captures.Count > 0)
{
int lLen = lMatch.Groups[1].Value.Length;
string channelName = "";
int temp_Channel = iChannel - 1;
for (int i = 0; i < lLen; i++)
{
if (temp_Channel >= 0) channelName = Convert.ToChar((temp_Channel) % 26 + 65) + channelName;
temp_Channel /= 26;
temp_Channel--;
}
lResult = lResult.Replace(lMatch.Value, channelName);
lReplaced = true;
}
} while (lReplaced);
}
return lResult;
}
static void ReplaceKoTemplateFinal(XmlNode iTargetNode)
{
Regex lRegex = new(@"%!K(\d{1,3})!C(\d{1,4})!(\w*)!%");
XmlNodeList lNodes = iTargetNode.SelectNodes("//*/@*[contains(.,'%!K')]");
foreach (XmlAttribute lNode in lNodes)
{
string lValue = lNode.Value;
Match lMatch = lRegex.Match(lValue);
if (lMatch.Captures.Count > 0)
{
string lPrefix = lMatch.Groups[3].Value;
DefineContent lDefine = DefineContent.GetDefineContent(lPrefix);
if (lDefine != null)
{
int lBlockSize = lDefine.KoBlockSize;
// if (lBlockSize == 0) return;
int lOffset = lDefine.KoOffset;
_ = int.TryParse(lMatch.Groups[2].Value, out int lChannel);
if (int.TryParse(lMatch.Groups[1].Value, out int lShift))
{
int lKoNumber = (lChannel - 1) * lBlockSize + lOffset + lShift;
// we replace just in case it is numeric, otherwise an error message will appear during final document check
lNode.Value = lValue.Replace(lMatch.Value, lKoNumber.ToString());
// remember the max replaced number
sMaxKoNumber = (lKoNumber > sMaxKoNumber) ? lKoNumber : sMaxKoNumber;
}
}
}
}
// sKoTemplateFinalList.Clear();
}
static string ReplaceKoTemplate(DefineContent iDefine, string iValue, int iChannel, ProcessInclude iInclude, bool iIsName, XmlAttribute iAttr = null)
{
string lResult = iValue;
int lBlockSize = 0;
int lOffset = 0;
if (iDefine.IsTemplate)
{
if (iValue.Contains("%K"))
{
if (iInclude != null)
{
lBlockSize = iInclude.mKoBlockSize;
lOffset = iInclude.KoOffset;
}
// too slow!!!
// MatchCollection lMatches = Regex.Matches(iValue, @"%K(\d{1,3})%");
Match lMatch = Regex.Match(iValue, @"%K(\d{1,3})%");
if (lMatch.Captures.Count > 0)
{
if (iInclude != null && !iInclude.mHeaderKoBlockGenerated)
{
lResult = iValue.Replace(lMatch.Value, string.Format("%!K{0}!C{1:D04}!{2}!%", lMatch.Groups[1].Value, iChannel, iDefine.prefix));
}
else if (int.TryParse(lMatch.Groups[1].Value, out int lShift))
{
int lKoNumber = (iChannel - 1) * lBlockSize + lOffset + lShift;
// we replace just in case it is numeric, otherwise an error message will appear during final document check
lResult = iValue.Replace(lMatch.Value, lKoNumber.ToString());
// remember the max replaced number
sMaxKoNumber = (lKoNumber > sMaxKoNumber) ? lKoNumber : sMaxKoNumber;
// we want to replace all occurrences, but a match collection is to slow, so we call recursively just if
// a replacement happened
lResult = ReplaceKoTemplate(iDefine, lResult, iChannel, iInclude, iIsName, iAttr);
}
}
}
}
else if (iIsName)
{
// iChannel is in this case KoSingleOffset
if (int.TryParse(iValue, out int lValue))
{
// we replace just in case it is numeric, otherwise an error message will appear during final document check
lResult = (lValue + iDefine.KoSingleOffset).ToString();
}
}
return lResult;
}
static void ProcessAttribute(DefineContent iDefine, int iChannel, XmlAttribute iAttr, XmlNode iTargetNode, ProcessInclude iInclude)
{
// we have to mark ParameterBlock and ParameterSeparator for renumber processing
string lValue = iAttr.Value;
if ((lValue.Contains("%T%") || lValue.Contains("%TT%")))
{
// if (!lAttr.Value.Contains("_MD-"))
// {
// lValue = lValue.Replace("_PS-", "_PST-");
// lValue = lValue.Replace("_PB-", "_PBT-");
// }
string lModuleType = iInclude.ModuleType.ToString();
if (lValue.Contains("%TT%"))
{
if (lModuleType.Length == 2)
lValue = lValue.Replace("%TT%", lModuleType);
else if (lModuleType.Length == 1)
lValue = lValue.Replace("%TT%", lModuleType + "0");
}
else if (lModuleType.Length == 1)
lValue = lValue.Replace("%T%", lModuleType);
}
lValue = ReplaceChannelTemplate(lValue, iChannel);
lValue = ReplaceKoTemplate(iDefine, lValue, iChannel, iInclude, iAttr.Name == "Number", iAttr);
// lAttr.Value = lAttr.Value.Replace("%N%", mChannelCount.ToString());
if (iAttr.Name == "Name" && iAttr.OwnerElement.Name != "ParameterType" && iTargetNode.Name != "Argument" && !iInclude.IsInnerInclude)
if (!lValue.StartsWith(iInclude.mHeaderPrefixName))
lValue = iInclude.mHeaderPrefixName + lValue;
iAttr.Value = lValue;
}
static void ProcessAttributes(DefineContent iDefine, int iChannel, XmlNode iTargetNode, ProcessInclude iInclude)
{
foreach (XmlAttribute lAttr in iTargetNode.Attributes)
{
ProcessAttribute(iDefine, iChannel, lAttr, iTargetNode, iInclude);
}
}
static void ProcessHelpContext(DefineContent iDefine, XmlNode iTargetNode, ProcessInclude iInclude)
{
XmlNodeList lNodes = iTargetNode.SelectNodes(@"//ParameterRefRef[@HelpContext]");
XmlNodeList lParameters = iTargetNode.SelectNodes(@"//Parameter[@Id]");
Dictionary<string, XmlNode> lParameterLookup = new();
// create lookup first (performance optimization)
foreach (XmlNode lNode in lParameters)
{
string lId = lNode.NodeAttr("Id");
if (!lParameterLookup.ContainsKey(lId))
lParameterLookup.Add(lId, lNode);
}
foreach (XmlNode lNode in lNodes)
{
XmlNode lAttribute = lNode.Attributes.GetNamedItem("HelpContext");
if (lAttribute.Value == "%DOC%")
{
string lId = lNode.NodeAttr("RefId").Split("_R-")[0];
if (lParameterLookup.ContainsKey(lId))
{
XmlNode lParameter = lParameterLookup[lId];
string lText = lParameter.NodeAttr("Text");
lText = ParseDocumentation.GetChapterId(lText, iDefine.prefixDoc);
// Console.WriteLine(lText);
lAttribute.Value = lText;
}
}
}
}
static void ProcessParameter(DefineContent iDefine, int iChannel, XmlNode iTargetNode, ProcessInclude iInclude)
{
// ensure property parameters are correctly replaced
XmlNode lProperty = iTargetNode.SelectSingleNode("Property");
if (lProperty != null)
{
ProcessAttributes(iDefine, iChannel, lProperty, iInclude);
}
//calculate new offset
XmlNode lMemory = iTargetNode.SelectSingleNode("Memory");
if (lMemory != null)
{
XmlNode lAttr = lMemory.Attributes.GetNamedItem("Offset");
int lOffset = int.Parse(lAttr.Value);
// if (iInclude.ChannelCount > (AbsoluteSingleParameters ? 1 : 0))
if (iInclude.ChannelCount > (AbsoluteSingleParameters ? 1 : 0))
lOffset += iInclude.ParameterBlockOffset + (iChannel - 1) * iInclude.ParameterBlockSize;
lAttr.Value = lOffset.ToString();
}
}
static void ProcessUnion(DefineContent iDefine, int iChannel, XmlNode iTargetNode, ProcessInclude iInclude)
{
//calculate new offset
ProcessParameter(iDefine, iChannel, iTargetNode, iInclude);
XmlNodeList lChildren = iTargetNode.ChildNodes;
foreach (XmlNode lChild in lChildren)
{
if (lChild.Name == "Parameter")
ProcessAttributes(iDefine, iChannel, lChild, iInclude);
}
}
static void ProcessChannel(DefineContent iDefine, int iChannel, XmlNode iTargetNode, ProcessInclude iInclude)
{
//attributes of the node
if (iTargetNode.Attributes != null)
{
ProcessAttributes(iDefine, iChannel, iTargetNode, iInclude);
}
if (iTargetNode.Name == "ModuleDef")
ProcessModule.ProcessModuleFactory(iDefine, iChannel, iTargetNode, iInclude);
if (iTargetNode.Name == "Module")
ProcessModule.ProcessModuleInstance(iDefine, iChannel, iTargetNode, iInclude);
//Print individual children of the node, gets only direct children of the node
XmlNodeList lChildren = iTargetNode.ChildNodes;
foreach (XmlNode lChild in lChildren)
{
ProcessChannel(iDefine, iChannel, lChild, iInclude);
}
}
// static void ProcessChannel(DefineContent iDefine, int iChannel, XmlNode iTargetNode, ProcessInclude iInclude)
// {
// XmlNodeList lAttrs = iTargetNode.SelectNodes("*/@*");
// foreach (XmlAttribute lAttr in lAttrs)
// {
// ProcessAttribute(iDefine, iChannel, lAttr, iInclude);
// }
// }
void ProcessBaggage(DefineContent iDefine, int iChannel, XmlNode iTargetNode, ProcessInclude iInclude)
{
// Baggage-node
// Console.WriteLine($"Processing baggages of {iInclude.mXmlFileName}");
XmlNode lBaggageIdAttr = iTargetNode.Attributes.GetNamedItem("Id");
if (lBaggageIdAttr != null)
{
// we have a real Baggage definition, not just an extension reference
// we copy all baggage files to our working dir
string lBaggageId = lBaggageIdAttr.Value;
XmlNode lFileNameAttr = iTargetNode.Attributes.GetNamedItem("Name");
string lFileName = lFileNameAttr.Value;
XmlNode lPathAttr = iTargetNode.Attributes.GetNamedItem("TargetPath");
string lTargetPath = lPathAttr.Value;
string lSourceDirName = "";
if (lFileName.StartsWith("..\\"))
lSourceDirName = iInclude.mCurrentDir;
else
lSourceDirName = Path.Combine(iInclude.mCurrentDir, "Baggages", lTargetPath);
string lTargetDirRoot = Path.Combine(mCurrentDir, mBaggagesName);
lPathAttr.Value = Path.Combine(BaggagesBaseDir, lTargetPath);
if (lBaggageId.StartsWith("%FILE-HELP") || lBaggageId.StartsWith("%FILE-ICONS"))
{
// context sensitive help and icons have to be merged
// we expect a directory, even if the file notation says ".zip"
lFileName = lFileName.Replace(".zip", "");
// for ETS, we need a zip and ensure, that it is generated
lFileNameAttr.Value = lFileName + ".zip";
// the path has to go to the specific application folder of the root application
// lPath = DetermineBaggagePath(lPath);
if (mCurrentDir == iInclude.mCurrentDir)
{
// BaggagesBaseDir = lPath;
if (!mBaggageTargetZipDirName.ContainsKey(lBaggageId))
{
mBaggageTargetZipDirName.Add(lBaggageId, lFileName);
}
}
// now we copy all files to target
lSourceDirName = Path.Combine(lSourceDirName, lFileName);
if (Directory.Exists(lSourceDirName))
{
if (!mBaggageTargetZipDirName.ContainsKey(lBaggageId))
{
// this is the case where an include provides a .zip-File, but the application doesn't.
// i.e. logic has an Icons.zip, but vpm has not. We generate an according file name
mBaggageTargetZipDirName.Add(lBaggageId, lFileName);
}
var lSourceDir = new DirectoryInfo(lSourceDirName);
lSourceDir.DeepCopy(Path.Combine(lTargetDirRoot, BaggagesBaseDir, mBaggageTargetZipDirName[lBaggageId]));
}
}
else
{
// we copy single files without any merge process
string lSourceFileName = Path.Combine(lSourceDirName, lFileName);
string lTargetDirName = Path.Combine(lTargetDirRoot, BaggagesBaseDir, lTargetPath);
string lTargetFileName = Path.Combine(lTargetDirName, Path.GetFileName(lFileName));
if (File.Exists(lSourceFileName))
{
Directory.CreateDirectory(lTargetDirName);
File.Copy(lSourceFileName, lTargetFileName, true);
File.SetLastWriteTimeUtc(lTargetFileName, DateTime.Now);
lFileNameAttr.Value = Path.GetFileName(lFileName);
}
}
}
}
private string DetermineBaggagePath(string iPath)
{
var lDirInfo = new DirectoryInfo(Path.Combine(mCurrentDir, "Baggages"));
if (lDirInfo.Exists)
{
var lSubDirInfos = lDirInfo.EnumerateDirectories("??");
if (lSubDirInfos != null && lSubDirInfos.Any())
{
var lSubSubDirInfos = lSubDirInfos.First().EnumerateDirectories("??");
if (lSubSubDirInfos != null && lSubSubDirInfos.Any())
iPath = Path.Combine(lSubDirInfos.First().Name, lSubSubDirInfos.First().Name);
}
}
return iPath;
}
void ProcessTemplate(DefineContent iDefine, int iChannel, XmlNode iTargetNode, ProcessInclude iInclude)
{
if (iTargetNode.Name == "Baggage")
{
ProcessBaggage(iDefine, iChannel, iTargetNode, iInclude);
}
else
{
ProcessAttributes(iDefine, iChannel, iTargetNode, iInclude);
if (iTargetNode.Name == "Parameter")
{
ProcessParameter(iDefine, iChannel, iTargetNode, iInclude);
}
else
if (iTargetNode.Name == "Union")
{
ProcessUnion(iDefine, iChannel, iTargetNode, iInclude);
}
else
if ("Channel,ChannelIndependentBlock,ParameterBlock,choose,ParameterCalculations,ParameterValidations,ModuleDef".Contains(iTargetNode.Name))
{
ProcessChannel(iDefine, iChannel, iTargetNode, iInclude);
}
}
}
static void ReplaceDocumentStrings(XmlNode iNode, string iSourceText, string iTargetText)
{
// fastest method
XmlNodeList lAttributes = iNode.SelectNodes($"//*/@*[contains(., '{iSourceText}')]");
foreach (XmlAttribute lAttribute in lAttributes)
{
lAttribute.Value = lAttribute.Value.Replace(iSourceText, iTargetText);
}
}
bool ProcessFinish(XmlNode iTargetNode)
{
Console.WriteLine("Processing merged file...");
ProcessConfig(iTargetNode);
ReplaceKoTemplateFinal(iTargetNode);
bool lWithVersions = false;
XmlNode lApplicationProgramNode = iTargetNode.SelectSingleNode("/KNX/ManufacturerData/Manufacturer/ApplicationPrograms/ApplicationProgram");
// evaluate oknxp:version, if available
XmlNode lMcVersionNode = iTargetNode.SelectSingleNode("//oknxp:version", nsmgr);
string lInlineData = "";
string lVersionMessage = "";
StringBuilder lVersionInformation = new StringBuilder();
if (lMcVersionNode != null)
{
// found oknxp:version, we apply its attributes to knxprod-xml
int lOpenKnxId = 175;
string lValue = lMcVersionNode.Attributes.GetNamedItem("OpenKnxId").Value;
lValue = lValue.Replace("0x", "");
if (!int.TryParse(lValue, System.Globalization.NumberStyles.HexNumber, CultureInfo.InvariantCulture, out lOpenKnxId))
Program.Message(true, "OpenKnxId could not be parsed, given value was {0}", lMcVersionNode.Attributes.GetNamedItem("OpenKnxId").Value);
int lAppNumber = 0;
if (!int.TryParse(lMcVersionNode.Attributes.GetNamedItem("ApplicationNumber").Value, out lAppNumber))
Program.Message(true, "ApplicationNumber could not be parsed, given value was {0}", lMcVersionNode.Attributes.GetNamedItem("ApplicationNumber").Value);
int lCalcAppNumber = lAppNumber + (lOpenKnxId << 8);
lApplicationProgramNode.Attributes.GetNamedItem("ApplicationNumber").Value = lCalcAppNumber.ToString();
int lAppVersion = 1;
if (!int.TryParse(lMcVersionNode.Attributes.GetNamedItem("ApplicationVersion").Value, out lAppVersion))
Program.Message(true, "ApplicationVersion could not be parsed, given value was {0}", lMcVersionNode.Attributes.GetNamedItem("ApplicationVersion").Value);
lApplicationProgramNode.Attributes.GetNamedItem("ApplicationVersion").Value = lAppVersion.ToString();
string lReplVersions = lMcVersionNode.Attributes.GetNamedItem("ReplacesVersions").Value;
if (lReplVersions == "") lReplVersions = "0";
lApplicationProgramNode.Attributes.GetNamedItem("ReplacesVersions").Value = lReplVersions;
int lAppRevision = 0;
if (!int.TryParse(lMcVersionNode.Attributes.GetNamedItem("ApplicationRevision").Value, out lAppRevision))
Program.Message(true, "ApplicationRevision could not be parsed, given value was {0}", lMcVersionNode.Attributes.GetNamedItem("ApplicationRevision").Value);
// now we calculate according versioning verification string
int lDerivedVersion = lAppVersion - lAppRevision;
lInlineData = string.Format("0000{0:X4}{1:X2}00", lCalcAppNumber, lDerivedVersion);
lVersionMessage = string.Format("{0}.{1}", (lDerivedVersion >> 4), (lDerivedVersion & 0x0F));
// XmlNode lLdCtrlCompareProp = iTargetNode.SelectSingleNode("//LdCtrlCompareProp");
// if (lLdCtrlCompareProp != null) {
// lLdCtrlCompareProp.Attributes.GetNamedItem("InlineData").Value = lInlineData;
// }
// we create a comment from version node
string lVersion = " " + string.Join(" ", lMcVersionNode.OuterXml.Split().Skip(1).SkipLast(2)) + " ";
XmlNode lVersionComment = ((XmlDocument)iTargetNode).CreateComment(lVersion);
lMcVersionNode.ParentNode.ReplaceChild(lVersionComment, lMcVersionNode);
lWithVersions = true; // we have to deal with versions
// finally, we make some version info available in header file
lVersionInformation.AppendFormat("#define MAIN_OpenKnxId 0x{0:X2}", lOpenKnxId);
lVersionInformation.AppendLine();
lVersionInformation.AppendFormat("#define MAIN_ApplicationNumber {0}", lAppNumber);
lVersionInformation.AppendLine();
lVersionInformation.AppendFormat("#define MAIN_ApplicationVersion {0}", lAppVersion - lAppRevision);
lVersionInformation.AppendLine();
}
// change all Id-Attributes / renumber ParameterSeparator and ParameterBlock
string lApplicationId = lApplicationProgramNode.Attributes.GetNamedItem("Id").Value;
int lApplicationNumber = -1;
bool lIsInt = int.TryParse(lApplicationProgramNode.Attributes.GetNamedItem("ApplicationNumber").Value, out lApplicationNumber);
int lApplicationVersion = -1;
lIsInt = int.TryParse(lApplicationProgramNode.Attributes.GetNamedItem("ApplicationVersion").Value, out lApplicationVersion);
XmlNode lReplacesVersionsAttribute = lApplicationProgramNode.Attributes.GetNamedItem("ReplacesVersions");
string lOldId = lApplicationId;//.Replace("M-00FA_A", ""); // CalculateId(1, 1);
if (lOldId.StartsWith("M-")) lOldId = lOldId.Substring(8);
string lNewId = CalculateId(lApplicationNumber, lApplicationVersion);
if (lOldId == "%AID%") lNewId = "M-00FA_A" + lNewId;
// support ModuleCopy
ExtendedEtsSupport.AddEtsExtensions(this, lApplicationVersion, lApplicationNumber);
int lParameterSeparatorCount = 1;
int lParameterBlockCount = 1;
// Baggages handling
PreprocessBaggages(iTargetNode);
ReplaceBaggages(iTargetNode);
ReplaceExtensions(iTargetNode);
XmlNodeList lAttrs;
lAttrs = iTargetNode.SelectNodes("//*/@*[contains(.,'%AID%')]");
if (lAttrs.Count == 0)
lAttrs = iTargetNode.SelectNodes("//*/@*[string-length() > '13']");
foreach (XmlNode lAttr in lAttrs)
{
if (lAttr.Value != null)
{
lAttr.Value = lAttr.Value.Replace(lOldId, lNewId);
if (ProcessInclude.Renumber)
{
// ParameterSeparator is renumbered
if (lAttr.Value.Contains("_PS-"))
{
lAttr.Value = string.Format("{0}-{1}", lAttr.Value.Substring(0, lAttr.Value.LastIndexOf('-')), lParameterSeparatorCount);
lParameterSeparatorCount += 1;
}
// ParameterBlock is renumbered
if (lAttr.Value.Contains("_PB-"))
{
lParameterBlockCount = RenumberParameterBlock(lParameterBlockCount, lAttr);
}
}
// lAttr.Value = lAttr.Value.Replace("_PST-", "_PS-");
// lAttr.Value = lAttr.Value.Replace("_PBT-", "_PB-");
}
}
// remove empty elements (without attributes and without children)
XmlNodeList lEmptyElements = iTargetNode.SelectNodes("//*[not(node()) and not(@*)]");
foreach (XmlNode lEmptyElement in lEmptyElements)
lEmptyElement.ParentNode.RemoveChild(lEmptyElement);
// process Enumeration-IDs (%ENID%)
XmlNodeList lEnumerations = iTargetNode.SelectNodes("//ParameterType//*[@Id='%ENID%']");
foreach (XmlNode lEnumeration in lEnumerations)
{
XmlNode lIdNode = lEnumeration.Attributes.GetNamedItem("Id");
XmlNode lParameterType = lEnumeration.ParentNode.ParentNode;
lIdNode.Value = lParameterType.NodeAttr("Id") + "_EN-" + lEnumeration.NodeAttr("Value");
}
Console.WriteLine("- ApplicationNumber: {0:X4} ({0}), ApplicationVersion: {1}, old ID is: {3}, new (calculated) ID is: {2}", lApplicationNumber, lApplicationVersion, lNewId, lOldId);
if (lInlineData != "") Console.WriteLine("- Calculated InlineData for Versioning: {0}", lInlineData);
// create registration entry
XmlNode lHardwareNode = iTargetNode.SelectSingleNode("/KNX/ManufacturerData/Manufacturer/Hardware/Hardware");
int lHardwareVersion = 1;
int.TryParse(lHardwareNode.Attributes.GetNamedItem("VersionNumber").Value, out lHardwareVersion);
string lSerialNumber = lHardwareNode.Attributes.GetNamedItem("SerialNumber").Value;
XmlNode lRegistrationNumber = iTargetNode.SelectSingleNode("/KNX/ManufacturerData/Manufacturer/Hardware/Hardware/Hardware2Programs/Hardware2Program/RegistrationInfo/@RegistrationNumber");
if (lRegistrationNumber == null)
{
Console.WriteLine("- Missing 'RegistrationVersion', no updates via 'ReplacesVersion' in ETS possible!");
}
else
{
lRegistrationNumber.Value = string.Format("0001/{0}{1}", lHardwareVersion, lApplicationVersion);
Console.WriteLine("- RegistrationVersion is: {0}", lRegistrationNumber.Value);
}
// Add ReplacesVersions
if (lReplacesVersionsAttribute != null)
{
string lReplacesVersions = lReplacesVersionsAttribute.Value;
Console.WriteLine("- ReplacesVersions entry is: {0}", lReplacesVersions);
// string lOldVersion = string.Format(" {0}", lApplicationVersion - 1);
// if (!lReplacesVersions.Contains(lOldVersion) && lReplacesVersions != (lApplicationVersion - 1).ToString()) lReplacesVersionsAttribute.Value += lOldVersion;
}
// set the right Size attributes
// XmlNodeList lNodes = iTargetNode.SelectNodes("(//RelativeSegment | //LdCtrlRelSegment | //LdCtrlWriteRelMem)[@Size]");
string lSize = ParameterBlockSize.ToString();
// foreach (XmlNode lNode in lNodes) {
// lNode.Attributes.GetNamedItem("Size").Value = lSize;
// }
// Console.WriteLine("- Final parameter size is {0}", lSize);
string lPartId = CalculateId(lApplicationNumber, lApplicationVersion);
string lHardwareId = "M-00FA_H-%SerialNumberEncoded%-%HardwareVersionEncoded%";
string lHardware2ProgramId = lHardwareId + "_HP" + lPartId;
string lCatalogItemId = lHardware2ProgramId + "_CI-%OrderNumberEncoded%-1";
string lProductId = lHardwareId + "_P-%OrderNumberEncoded%";
string lHardwareVersionEncoded = Program.GetEncoded(lHardwareVersion.ToString());
string lSerialNumberEncoded = Program.GetEncoded(lSerialNumber);
XmlNode lOrderNumberAttribute = iTargetNode.SelectSingleNode("/KNX/ManufacturerData/Manufacturer/Hardware/Hardware/Products/Product/@OrderNumber");
string lOrderNumberEncoded = Program.GetEncoded(lOrderNumberAttribute.Value);
if (lMcVersionNode != null)
{
lVersionInformation.AppendFormat("#define MAIN_ParameterSize {0}", lSize);
lVersionInformation.AppendLine();
lVersionInformation.AppendFormat("#define MAIN_MaxKoNumber {0}", sMaxKoNumber);
lVersionInformation.AppendLine();
lVersionInformation.AppendFormat("#define MAIN_OrderNumber \"{0}\"", lOrderNumberAttribute.Value);
lVersionInformation.AppendLine();
mHeaderGenerated.Insert(0, lVersionInformation);
}
// XmlNodeList lCatalog = iTargetNode.SelectNodes("/KNX/ManufacturerData/Manufacturer/Catalog/descendant::*/@*");
// XmlNodeList lHardware = iTargetNode.SelectNodes("/KNX/ManufacturerData/Manufacturer/Hardware/descendant::*/@*");
// XmlNodeList lStatic = iTargetNode.SelectNodes("/KNX/ManufacturerData/Manufacturer/ApplicationPrograms/ApplicationProgram/Static/descendant::*/@*");
// var lNodes = lCatalog.Cast<XmlNode>().Concat(lHardware.Cast<XmlNode>().Concat<XmlNode>(lStatic.Cast<XmlNode>())).ToList();
var lNodes = iTargetNode.SelectNodes("/KNX/ManufacturerData/Manufacturer/*[self::Catalog or self::Hardware or self::Languages or self::ApplicationPrograms/ApplicationProgram/Static]/descendant::*/@*[contains(.,'%')]");
foreach (XmlNode lNode in lNodes)
{
if (lNode.Value != null)
{
string lValue = lNode.Value;
// these need to be replaced first
lValue = lValue.Replace("%CatalogItemId%", lCatalogItemId);
lValue = lValue.Replace("%ProductId%", lProductId);
lValue = lValue.Replace("%HardwareId%", lHardwareId);
lValue = lValue.Replace("%Hardware2ProgramId%", lHardware2ProgramId);
lValue = lValue.Replace("%MemorySize%", lSize);
// now we replace encoded values
lValue = lValue.Replace("%HardwareVersionEncoded%", lHardwareVersionEncoded);
lValue = lValue.Replace("%OrderNumberEncoded%", lOrderNumberEncoded);
lValue = lValue.Replace("%SerialNumberEncoded%", lSerialNumberEncoded);
lValue = lValue.Replace("%VersionCheck%", lInlineData);
lValue = lValue.Replace("%VersionMessage%", lVersionMessage);
// TODO: solve this in a more generic way
lValue = lValue.Replace("%MaxKoNumber%", sMaxKoNumber.ToString());
lValue = lValue.Replace("-%MaxKoNumber%", (-sMaxKoNumber).ToString());
lValue = lValue.Replace("%MaxKoNumber-1%", (sMaxKoNumber - 1).ToString());
// lValue = lValue.Replace("-%MaxKoNumber-1%", (-sMaxKoNumber + 1).ToString());
lNode.Value = lValue;
}
}
return lWithVersions;
}
Dictionary<string, string> mBaggageId = new Dictionary<string, string>();
private void PreprocessBaggages(XmlNode iTargetNode)
{
XmlNode lBaggages = iTargetNode.SelectSingleNode(@"//Baggages", nsmgr);
bool lWithHelp = false;
bool lWithIcons = false;
string lPath = "";
string lFileName = "";
XmlNode lIdNode = null;
bool HandleZipFile(string iZipPattern, ref bool eZipType)
{
if (lIdNode.Value.StartsWith(iZipPattern))
{
if (eZipType)
{
// mark for removal
lIdNode.Value = "!!DELETE!!";
return true;
}
// the following happens just once
eZipType = true;
string lSourceDirName = Path.Combine(mCurrentDir, mBaggagesName, lPath, lFileName.Replace(".zip", ""));
string lTargetName = Path.Combine(mCurrentDir, mBaggagesName, lPath, lFileName);
// TODO: check if skip is ok
if (Directory.Exists(lSourceDirName))
{
System.IO.Compression.ZipFile.CreateFromDirectory(lSourceDirName, lTargetName);
// before we delete the underlying directories, we store some information
HashSet<string> lHashId = new();
var lFiles = Directory.EnumerateFiles(lSourceDirName);
foreach (var lFile in lFiles)
{
lHashId.Add(Path.GetFileNameWithoutExtension(lFile));
}
if (iZipPattern == "%FILE-HELP")
{
mBaggageHelpFileName = Path.Combine(lPath, lFileName);
mBaggageHelpId = lHashId;
ParseHelpFiles(lFiles);
}
else if (iZipPattern == "%FILE-ICONS")
{
mBaggageIconFileName = Path.Combine(lPath, lFileName);
mBaggageIconId = lHashId;
}
Directory.Delete(lSourceDirName, true);
}
}
return false;
}
if (lBaggages != null)
{
foreach (XmlNode lBaggage in lBaggages.ChildNodes)
{
if (lBaggage.NodeType != XmlNodeType.Comment)
{
// We need to create according Id from Baggage filename
lPath = lBaggage.NodeAttr("TargetPath");
lFileName = lBaggage.NodeAttr("Name");
lIdNode = lBaggage.Attributes.GetNamedItem("Id");
if (HandleZipFile("%FILE-HELP", ref lWithHelp)) continue;
if (HandleZipFile("%FILE-ICONS", ref lWithIcons)) continue;
string lBaggageId = string.Format("M-00FA_BG-{0}-{1}", Program.GetEncoded(lPath), Program.GetEncoded(lFileName));
if (!mBaggageId.ContainsKey(lIdNode.Value))
mBaggageId.Add(lIdNode.Value, lBaggageId);
lIdNode.Value = lBaggageId;
DateTime lFileLastWrite = File.GetLastWriteTimeUtc(Path.Combine(mCurrentDir, mBaggagesName, lPath, lFileName));
string lIsoDateTime = lFileLastWrite.ToString("o", CultureInfo.InvariantCulture);
XmlNode lTimeInfo = lBaggage.SelectSingleNode("FileInfo/@TimeInfo", nsmgr);
if (lTimeInfo != null && lTimeInfo.Value == "%DATETIME%")
lTimeInfo.Value = lIsoDateTime;
}
}
// duplicate zip-baggages are deleted
XmlNodeList lDeletes = lBaggages.SelectNodes(@"Baggage[@Id ='!!DELETE!!']", nsmgr);
foreach (XmlNode lDelete in lDeletes)
{
lDelete.ParentNode.RemoveChild(lDelete);
}
}
}
/// <summary>
/// Check if any of provided help files contains foreign links, this is forbidden in ETS
/// </summary>
/// <param name="lFiles">List of files to check</param>
private static void ParseHelpFiles(IEnumerable<string> lFiles)
{
if (lFiles != null)
{
Regex lLinkPattern = new(@"!?\[.*\]\(.*\)");
foreach (var lFileName in lFiles)
{
using var lFile = File.OpenText(lFileName);
string lContent = lFile.ReadToEnd();
Match lMatch = lLinkPattern.Match(lContent);
if (lMatch.Success)
{
string lName = Path.GetFileNameWithoutExtension(lFileName);
if (lMatch.Value.StartsWith("!"))
Program.Message(true, "Baggage file {0} contains a file link '{1}', this ist not allowed in ETS!", lName, lMatch.Value);
else
Program.Message(false, "Baggage file {0} contains a link '{1}', this will not work in ETS!", lName, lMatch.Value);
}
}
}
}
private void ReplaceBaggages(XmlNode iTargetNode)
{
XmlNodeList lRefIds = iTargetNode.SelectNodes(@"//./@*[starts-with(.,'%FILE-')]", nsmgr);
int lProjectNamespace = GetIdOfProjectNamespace((XmlDocument)iTargetNode);
if (lRefIds != null)
{
foreach (XmlNode lRefId in lRefIds)
{
if (mBaggageId.ContainsKey(lRefId.Value))
{
lRefId.Value = mBaggageId[lRefId.Value];
}
if (lProjectNamespace == 14)
{
if (lRefId.Name == "ContextHelpFile")
{
lRefId.Value = mBaggageHelpFileName;
}
else
if (lRefId.Name == "IconFile")
{
lRefId.Value = mBaggageIconFileName;
}
}
}
}
}
private void ReplaceExtensions(XmlNode iTargetNode)
{
XmlNode lExtensions = iTargetNode.SelectSingleNode(@"//Extension", nsmgr);
if (lExtensions != null)
{
lExtensions.RemoveAll();