aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/Prebuild/src/Core/Utilities/Helper.cs
blob: a440e581df03b2b8cfd3de4c8ddc0de78e4e3f14 (plain)
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
#region BSD License
/*
Copyright (c) 2004-2005 Matthew Holmes (matthew@wildfiregames.com), Dan Moorehead (dan05a@gmail.com)

Redistribution and use in source and binary forms, with or without modification, are permitted
provided that the following conditions are met:

* Redistributions of source code must retain the above copyright notice, this list of conditions
  and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice, this list of conditions
  and the following disclaimer in the documentation and/or other materials provided with the
  distribution.
* The name of the author may not be used to endorse or promote products derived from this software
  without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING,
BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#endregion

using System;
using System.Collections.Generic;
using System.Diagnostics;
using System.IO;
using System.Runtime.InteropServices;
using System.Text.RegularExpressions;
using System.Collections.Specialized;
using System.Xml;
using Prebuild.Core.Nodes;

namespace Prebuild.Core.Utilities
{
    /// <summary>
    ///
    /// </summary>
    public class Helper
    {
        #region Fields

        static bool checkForOSVariables;

        /// <summary>
        ///
        /// </summary>
        public static bool CheckForOSVariables
        {
            get
            {
                return checkForOSVariables;
            }
            set
            {
                checkForOSVariables = value;
            }
        }

        #endregion

        #region Public Methods

        #region String Parsing

        public delegate string StringLookup(string key);

        /// <summary>
        /// Gets a collection of StringLocationPair objects that represent the matches
        /// </summary>
        /// <param name="target">The target.</param>
        /// <param name="beforeGroup">The before group.</param>
        /// <param name="afterGroup">The after group.</param>
        /// <param name="includeDelimitersInSubstrings">if set to <c>true</c> [include delimiters in substrings].</param>
        /// <returns></returns>
        public static StringCollection FindGroups(string target, string beforeGroup, string afterGroup, bool includeDelimitersInSubstrings)
        {
            if( beforeGroup == null )
            {
                throw new ArgumentNullException("beforeGroup");
            }
            if( afterGroup == null )
            {
                throw new ArgumentNullException("afterGroup");
            }
            StringCollection results = new StringCollection();
            if(target == null || target.Length == 0)
            {
                return results;
            }

            int beforeMod = 0;
            int afterMod = 0;
            if(includeDelimitersInSubstrings)
            {
                //be sure to not exlude the delims
                beforeMod = beforeGroup.Length;
                afterMod = afterGroup.Length;
            }
            int startIndex = 0;
            while((startIndex = target.IndexOf(beforeGroup,startIndex)) != -1) {
                int endIndex = target.IndexOf(afterGroup,startIndex);//the index of the char after it
                if(endIndex == -1)
                {
                    break;
                }
                int length = endIndex - startIndex - beforeGroup.Length;//move to the first char in the string
                string substring = substring = target.Substring(startIndex + beforeGroup.Length - beforeMod,
                    length - afterMod);

                results.Add(substring);
                //results.Add(new StringLocationPair(substring,startIndex));
                startIndex = endIndex + 1;
                //the Interpolate*() methods will not work if expressions are expandded inside expression due to an optimization
                //so start after endIndex

            }
            return results;
        }

        /// <summary>
        /// Replaces the groups.
        /// </summary>
        /// <param name="target">The target.</param>
        /// <param name="beforeGroup">The before group.</param>
        /// <param name="afterGroup">The after group.</param>
        /// <param name="lookup">The lookup.</param>
        /// <returns></returns>
        public static string ReplaceGroups(string target, string beforeGroup, string afterGroup, StringLookup lookup) {
            if( target == null )
            {
                throw new ArgumentNullException("target");
            }
            //int targetLength = target.Length;
            StringCollection strings = FindGroups(target,beforeGroup,afterGroup,false);
            if( lookup == null )
            {
                throw new ArgumentNullException("lookup");
            }
            foreach(string substring in strings)
            {
                target = target.Replace(beforeGroup + substring + afterGroup, lookup(substring) );
            }
            return target;
        }

        /// <summary>
        /// Replaces ${var} statements in a string with the corresonding values as detirmined by the lookup delegate
        /// </summary>
        /// <param name="target">The target.</param>
        /// <param name="lookup">The lookup.</param>
        /// <returns></returns>
        public static string InterpolateForVariables(string target, StringLookup lookup)
        {
            return ReplaceGroups(target, "${" , "}" , lookup);
        }

        /// <summary>
        /// Replaces ${var} statements in a string with the corresonding environment variable with name var
        /// </summary>
        /// <param name="target"></param>
        /// <returns></returns>
        public static string InterpolateForEnvironmentVariables(string target)
        {
            return InterpolateForVariables(target, new StringLookup(Environment.GetEnvironmentVariable));
        }

        #endregion

        /// <summary>
        /// Translates the value.
        /// </summary>
        /// <param name="translateType">Type of the translate.</param>
        /// <param name="translationItem">The translation item.</param>
        /// <returns></returns>
        public static object TranslateValue(Type translateType, string translationItem)
        {
            if(translationItem == null)
            {
                return null;
            }

            try
            {
                string lowerVal = translationItem.ToLower();
                if(translateType == typeof(bool))
                {
                    return (lowerVal == "true" || lowerVal == "1" || lowerVal == "y" || lowerVal == "yes" || lowerVal == "on");
                }
                else if(translateType == typeof(int))
                {
                    return (Int32.Parse(translationItem));
                }
                else
                {
                    return translationItem;
                }
            }
            catch(FormatException)
            {
                return null;
            }
        }

        /// <summary>
        /// Deletes if exists.
        /// </summary>
        /// <param name="file">The file.</param>
        /// <returns></returns>
        public static bool DeleteIfExists(string file)
        {
            string resFile = null;
            try
            {
                resFile = ResolvePath(file);
            }
            catch(ArgumentException)
            {
                return false;
            }

            if(!File.Exists(resFile))
            {
                return false;
            }

            File.Delete(resFile);
            return true;
        }

        static readonly char seperator = Path.DirectorySeparatorChar;

        // This little gem was taken from the NeL source, thanks guys!
        /// <summary>
        /// Makes a relative path
        /// </summary>
        /// <param name="startPath">Path to start from</param>
        /// <param name="endPath">Path to end at</param>
        /// <returns>Path that will get from startPath to endPath</returns>
        public static string MakePathRelativeTo(string startPath, string endPath)
        {
            string tmp = NormalizePath(startPath, seperator);
            string src = NormalizePath(endPath, seperator);
            string prefix = "";

            while(true)
            {
                if((String.Compare(tmp, 0, src, 0, tmp.Length) == 0))
                {
                    string ret;
                    int size = tmp.Length;
                    if(size == src.Length)
                    {
                        return "./";
                    }
                    if((src.Length > tmp.Length) && src[tmp.Length - 1] != seperator)
                    {
                    }
                    else
                    {
                        ret = prefix + endPath.Substring(size, endPath.Length - size);
                        ret = ret.Trim();
                        if(ret[0] == seperator)
                        {
                            ret = "." + ret;
                        }

                        return NormalizePath(ret);
                    }

                }

                if(tmp.Length < 2)
                {
                    break;
                }

                int lastPos = tmp.LastIndexOf(seperator, tmp.Length - 2);
                int prevPos = tmp.IndexOf(seperator);

                if((lastPos == prevPos) || (lastPos == -1))
                {
                    break;
                }

                tmp = tmp.Substring(0, lastPos + 1);
                prefix += ".." + seperator.ToString();
            }

            return endPath;
        }

        /// <summary>
        /// Resolves the path.
        /// </summary>
        /// <param name="path">The path.</param>
        /// <returns></returns>
        public static string ResolvePath(string path)
        {
            string tmpPath = NormalizePath(path);
            if(tmpPath.Length < 1)
            {
                tmpPath = ".";
            }

            tmpPath = Path.GetFullPath(tmpPath);
            if(!File.Exists(tmpPath) && !Directory.Exists(tmpPath))
            {
                throw new ArgumentException("Path could not be resolved: " + tmpPath);
            }

            return tmpPath;
        }

        /// <summary>
        /// Normalizes the path.
        /// </summary>
        /// <param name="path">The path.</param>
        /// <param name="separatorCharacter">The separator character.</param>
        /// <returns></returns>
        public static string NormalizePath(string path, char separatorCharacter)
        {
            if(path == null || path == "" || path.Length < 1)
            {
                return "";
            }

            string tmpPath = path.Replace('\\', '/');
            tmpPath = tmpPath.Replace('/', separatorCharacter);
            return tmpPath;
        }

        /// <summary>
        /// Normalizes the path.
        /// </summary>
        /// <param name="path">The path.</param>
        /// <returns></returns>
        public static string NormalizePath(string path)
        {
            return NormalizePath(path, Path.DirectorySeparatorChar);
        }

        /// <summary>
        /// Ends the path.
        /// </summary>
        /// <param name="path">The path.</param>
        /// <param name="separatorCharacter">The separator character.</param>
        /// <returns></returns>
        public static string EndPath(string path, char separatorCharacter)
        {
            if(path == null || path == "" || path.Length < 1)
            {
                return "";
            }

            if(!path.EndsWith(separatorCharacter.ToString()))
            {
                return (path + separatorCharacter);
            }

            return path;
        }

        /// <summary>
        /// Ends the path.
        /// </summary>
        /// <param name="path">The path.</param>
        /// <returns></returns>
        public static string EndPath(string path)
        {
            return EndPath(path, Path.DirectorySeparatorChar);
        }

        /// <summary>
        /// Makes the file path.
        /// </summary>
        /// <param name="path">The path.</param>
        /// <param name="name">The name.</param>
        /// <param name="ext">The ext.</param>
        /// <returns></returns>
        public static string MakeFilePath(string path, string name, string ext)
        {
            string ret = EndPath(NormalizePath(path));

            if( name == null )
            {
                throw new ArgumentNullException("name");
            }

            ret += name;
            if(!name.EndsWith("." + ext))
            {
                ret += "." + ext;
            }

            //foreach(char c in Path.GetInvalidPathChars())
            //{
            //    ret = ret.Replace(c, '_');
            //}

            return ret;
        }

        /// <summary>
        /// Makes the file path.
        /// </summary>
        /// <param name="path">The path.</param>
        /// <param name="name">The name.</param>
        /// <returns></returns>
        public static string MakeFilePath(string path, string name)
        {
            string ret = EndPath(NormalizePath(path));

            if( name == null )
            {
                throw new ArgumentNullException("name");
            }

            ret += name;

            //foreach (char c in Path.GetInvalidPathChars())
            //{
            //    ret = ret.Replace(c, '_');
            //}

            return ret;
        }

        /// <summary>
        ///
        /// </summary>
        /// <param name="path"></param>
        /// <returns></returns>
        public static string MakeReferencePath(string path)
        {
            string ret = EndPath(NormalizePath(path));

            //foreach (char c in Path.GetInvalidPathChars())
            //{
            //    ret = ret.Replace(c, '_');
            //}

            return ret;
        }

        /// <summary>
        /// Sets the current dir.
        /// </summary>
        /// <param name="path">The path.</param>
        public static void SetCurrentDir(string path)
        {
            if( path == null )
            {
                throw new ArgumentNullException("path");
            }
            if(path.Length < 1)
            {
                return;
            }

            Environment.CurrentDirectory = path;
        }

        /// <summary>
        /// Checks the type.
        /// </summary>
        /// <param name="typeToCheck">The type to check.</param>
        /// <param name="attr">The attr.</param>
        /// <param name="inter">The inter.</param>
        /// <returns></returns>
        public static object CheckType(Type typeToCheck, Type attr, Type inter)
        {
            if(typeToCheck == null || attr == null)
            {
                return null;
            }

            object[] attrs = typeToCheck.GetCustomAttributes(attr, false);
            if(attrs == null || attrs.Length < 1)
            {
                return null;
            }
            if( inter == null )
            {
                throw new ArgumentNullException("inter");
            }

            if(typeToCheck.GetInterface(inter.FullName) == null)
            {
                return null;
            }

            return attrs[0];
        }

        /// <summary>
        /// Attributes the value.
        /// </summary>
        /// <param name="node">The node.</param>
        /// <param name="attr">The attr.</param>
        /// <param name="def">The def.</param>
        /// <returns></returns>
        public static string AttributeValue(XmlNode node, string attr, string def)
        {
            if( node == null )
            {
                throw new ArgumentNullException("node");
            }
            if(node.Attributes[attr] == null)
            {
                return def;
            }
            string val = node.Attributes[attr].Value;
            if(!CheckForOSVariables)
            {
                return val;
            }

            return InterpolateForEnvironmentVariables(val);
        }

        /// <summary>
        /// Parses the boolean.
        /// </summary>
        /// <param name="node">The node.</param>
        /// <param name="attr">The attr.</param>
        /// <param name="defaultValue">if set to <c>true</c> [default value].</param>
        /// <returns></returns>
        public static bool ParseBoolean(XmlNode node, string attr, bool defaultValue)
        {
            if( node == null )
            {
                throw new ArgumentNullException("node");
            }
            if(node.Attributes[attr] == null)
            {
                return defaultValue;
            }
            return bool.Parse(node.Attributes[attr].Value);
        }

        /// <summary>
        /// Enums the attribute value.
        /// </summary>
        /// <param name="node">The node.</param>
        /// <param name="attr">The attr.</param>
        /// <param name="enumType">Type of the enum.</param>
        /// <param name="def">The def.</param>
        /// <returns></returns>
        public static object EnumAttributeValue(XmlNode node, string attr, Type enumType, object def)
        {
            if( def == null )
            {
                throw new ArgumentNullException("def");
            }
            string val = AttributeValue(node, attr, def.ToString());
            return Enum.Parse(enumType, val, true);
        }

        /// <summary>
        ///
        /// </summary>
        /// <param name="assemblyName"></param>
        /// <param name="projectType"></param>
        /// <returns></returns>
        public static string AssemblyFullName(string assemblyName, ProjectType projectType)
        {
            return assemblyName + (projectType == ProjectType.Library ? ".dll" : ".exe");
        }

        #endregion
    }
}