-
-
Notifications
You must be signed in to change notification settings - Fork 22
/
IUserVariable.cs
146 lines (129 loc) · 5.64 KB
/
IUserVariable.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
/*
* Copyright (c) 2013-2016 Denis Kuzmin (reg) <entry.reg@gmail.com>
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
using System.Collections.Generic;
namespace net.r_eg.vsSBE.Scripts
{
public interface IUserVariable
{
/// <summary>
/// Exposes the enumerable for defined names of user-variables
/// </summary>
IEnumerable<string> Definitions { get; }
/// <summary>
/// Exposes the enumerable for defined user-variables
/// </summary>
IEnumerable<TUserVariable> Variables { get; }
/// <summary>
/// Getting value of user-variable by using scope of project
/// </summary>
/// <param name="name">variable name</param>
/// <param name="project">project name</param>
/// <returns>evaluated value of variable</returns>
string get(string name, string project);
/// <summary>
/// Getting value of user-variable by using unique identification
/// </summary>
/// <param name="ident">Unique identificator</param>
/// <returns>Evaluated value of variable</returns>
string get(string ident);
/// <summary>
/// Get user-variable struct by using scope of project
/// </summary>
/// <param name="name">variable name</param>
/// <param name="project">project name</param>
/// <returns>Struct of user-variable</returns>
TUserVariable getVariable(string name, string project);
/// <summary>
/// Get user-variable struct by using unique identification
/// </summary>
/// <param name="ident">Unique identificator</param>
/// <returns>Struct of user-variable</returns>
TUserVariable getVariable(string ident);
/// <summary>
/// Defines user-variable
/// Value setted as unevaluated
/// </summary>
/// <param name="name">variable name</param>
/// <param name="project">project name</param>
/// <param name="unevaluated">mixed string with unevaluated data</param>
void set(string name, string project, string unevaluated);
/// <summary>
/// Evaluation user-variable with IEvaluator by using scope of project
/// Evaluated value should be updated for variable.
/// </summary>
/// <param name="name">Variable name for evaluating</param>
/// <param name="project">Project name</param>
/// <param name="evaluator">IEvaluator objects for evaluating</param>
/// <param name="resetting">Evaluation can be in the chain of others IEvaluator's, this flag should reset this to initial state</param>
void evaluate(string name, string project, IEvaluator evaluator, bool resetting);
/// <summary>
/// Evaluation user-variable with IEvaluator by using unique identification
/// Evaluated value should be updated for variable.
/// </summary>
/// <param name="ident">Unique identificator</param>
/// <param name="evaluator">IEvaluator objects for evaluating</param>
/// <param name="resetting">Evaluation can be in the chain of others IEvaluator's, this flag should reset this to initial state</param>
void evaluate(string ident, IEvaluator evaluator, bool resetting);
/// <summary>
/// Checking for variable - completed evaluation or not
/// by using scope of project
/// </summary>
/// <param name="name">Variable name</param>
/// <param name="project">Project name</param>
/// <returns></returns>
bool isUnevaluated(string name, string project);
/// <summary>
/// Checking for variable - completed evaluation or not
/// by using unique identification
/// </summary>
/// <param name="ident">Unique identificator</param>
/// <returns></returns>
bool isUnevaluated(string ident);
/// <summary>
/// Checking existence of variable
/// by using scope of project
/// </summary>
/// <param name="name">Variable name</param>
/// <param name="project">Project name</param>
/// <returns></returns>
bool isExist(string name, string project);
/// <summary>
/// Checking existence of variable
/// by using unique identification
/// </summary>
/// <param name="ident">Unique identificator</param>
/// <returns></returns>
bool isExist(string ident);
/// <summary>
/// Removes user-variable
/// by using scope of project
/// </summary>
/// <param name="name">variable name</param>
/// <param name="project">project name</param>
void unset(string name, string project);
/// <summary>
/// Removes user-variable
/// by using unique identification
/// </summary>
/// <param name="ident">Unique identificator</param>
void unset(string ident);
/// <summary>
/// Removes all user-variables
/// </summary>
void unsetAll();
}
}