forked from GridProtectionAlliance/BroccoliSharp
/
BroTypeExtensions.cs
146 lines (136 loc) · 6.1 KB
/
BroTypeExtensions.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
//******************************************************************************************************
// BroTypeExtensions.cs - Gbtc
//
// Copyright © 2014, Grid Protection Alliance. All Rights Reserved.
//
// Licensed to the Grid Protection Alliance (GPA) under one or more contributor license agreements. See
// Redistribution and use in source and binary forms, with or without modification, are permitted
// provided that the following conditions are met:
//
// (1) Redistributions of source code must retain the above copyright notice, this list of conditions
// and the following disclaimer.
//
// (2) 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.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "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 COPYRIGHT HOLDER OR
// CONTRIBUTORS 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.
//
// Code Modification History:
// ----------------------------------------------------------------------------------------------------
// 10/14/2014 - J. Ritchie Carroll
// Generated original version of source code.
//
//******************************************************************************************************
using System;
using System.Collections;
namespace BroccoliSharp
{
/// <summary>
/// Defines extension functions for the <see cref="BroType"/> enumeration.
/// </summary>
public static class BroTypeExtensions
{
/// <summary>
/// Determines if <see cref="BroType"/> is a value-type (from perspective of BroccoliSharp library not Broccoli API).
/// </summary>
/// <param name="type">Bro type to test.</param>
/// <returns><c>true</c> if Bro <paramref name="type"/> is a value-type; otherwise, <c>false</c>.</returns>
public static bool IsValueType(this BroType type)
{
switch (type)
{
case BroType.Bool:
case BroType.Int:
case BroType.Count:
case BroType.Counter:
case BroType.Enum:
case BroType.Double:
case BroType.Time:
case BroType.Interval:
case BroType.Port: // Value-type BroPort structure wraps bro_port structure
case BroType.IpAddr: // Value-type BroAddress structure wraps bro_addr structure
case BroType.Subnet: // Value-type BroSubnet structure wraps bro_subnet structure
return true;
}
return false;
}
/// <summary>
/// Determines if <see cref="BroType"/> is a reference-type (from perspective of BroccoliSharp library not Broccoli API).
/// </summary>
/// <param name="type">Bro type to test.</param>
/// <returns><c>true</c> if Bro <paramref name="type"/> is a reference-type; otherwise, <c>false</c>.</returns>
/// <remarks>
/// Reference types in BroccoliSharp implement <see cref="IDisposable"/>.
/// </remarks>
public static bool IsReferenceType(this BroType type)
{
switch (type)
{
case BroType.String: // Reference-type BroString class wraps bro_string structure
case BroType.Table:
case BroType.List:
case BroType.Record:
case BroType.Vector:
case BroType.Packet:
case BroType.Set:
return true;
}
return false;
}
/// <summary>
/// Determines if <see cref="BroType"/> is an opaque reference-type.
/// </summary>
/// <param name="type">Bro type to test.</param>
/// <returns><c>true</c> if Bro <paramref name="type"/> is an opaque reference-type; otherwise, <c>false</c>.</returns>
public static bool IsOpaqueType(this BroType type)
{
return type != BroType.String && type.IsReferenceType();
}
/// <summary>
/// Determines if <see cref="BroType"/> is a currently unsupported type.
/// </summary>
/// <param name="type">Bro type to test.</param>
/// <returns><c>true</c> if Bro <paramref name="type"/> is an unsupported type; otherwise, <c>false</c>.</returns>
public static bool IsUnsupportedType(this BroType type)
{
switch (type)
{
case BroType.Pattern:
case BroType.Timer:
case BroType.Any:
case BroType.Union:
case BroType.Func:
case BroType.File:
case BroType.Error:
return true;
}
return false;
}
/// <summary>
/// Determines if <see cref="BroType"/> is an <see cref="IEnumerable"/> type.
/// </summary>
/// <param name="type">Bro type to test.</param>
/// <returns><c>true</c> if Bro <paramref name="type"/> is an <see cref="IEnumerable"/> type; otherwise, <c>false</c>.</returns>
public static bool IsEnumerableType(this BroType type)
{
switch (type)
{
case BroType.Table:
case BroType.List:
case BroType.Record:
case BroType.Vector:
case BroType.Set:
return true;
}
return false;
}
}
}