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
|
////
/// Context handling.
///
/// Contexts allow you to pass data between mixins and let you enforce a certain nesting order.
/// It's an essential part for the BEM-related mixins.
///
/// If you want to create a new context, the easiest pattern is to create a new mixin and wrap
/// the @content between a pair of iro-context-push and iro-context-pop.
/// From within the @content, you can access the context's data with iro-context-get.
/// To make the compilation fail if a certain nesting order is violated, use
/// iro-context-assert-stack-must-contain and iro-context-assert-stack-must-not-contain.
///
/// @group Contexts
///
/// @access public
////
///
/// Map of all context stacks.
///
/// @type map
///
/// @access private
///
$iro-context-stacks: ();
///
/// Create a new context stack.
///
/// @param {string} $stack-id - ID of context stack
///
/// @throw If context stack already exists
///
@mixin iro-context-stack-create($stack-id) {
$noop: iro-context-stack-create($stack-id);
}
///
/// Create a new context stack.
///
/// @param {string} $stack-id - ID of context stack
///
@function iro-context-stack-create($stack-id) {
@if map-has-key($iro-context-stacks, $stack-id) {
@error 'Context stack "#{inspect($stack-id)}" does not exist.';
}
$iro-context-stacks: map-merge($iro-context-stacks, ($stack-id: ())) !global;
@return null;
}
///
/// Clear a context stack.
///
/// @param {string} $stack-id - ID of context stack
///
@mixin iro-context-stack-clear($stack-id) {
$noop: iro-context-stack-clear($stack-id);
}
///
/// Clear a context stack.
///
/// @param {string} $stack-id - ID of context stack
///
@function iro-context-stack-clear($stack-id) {
@if not map-has-key($iro-context-stacks, $stack-id) {
@error 'Context stack "#{inspect($stack-id)}" does not exist.';
}
$context-stack: ();
$iro-context-stacks: map-merge($iro-context-stacks, ($stack-id: $context-stack)) !global;
@return null;
}
///
/// Delete a context stack.
///
/// @param {string} $stack-id - ID of context stack
///
@mixin iro-context-stack-delete($stack-id) {
$noop: iro-context-stack-delete($stack-id);
}
///
/// Delete a context stack.
///
/// @param {string} $stack-id - ID of context stack
///
@function iro-context-stack-delete($stack-id) {
@if not map-has-key($iro-context-stacks, $stack-id) {
@error 'Context stack "#{inspect($stack-id)}" does not exist.';
}
$iro-context-stacks: map-remove($iro-context-stacks, $stack-id) !global;
@return null;
}
///
/// Push a new context to a context stack.
///
/// @param {string} $stack-id - ID of context stack to use
/// @param {string} $id - ID of new context
/// @param {any} $data [()] - Data that belongs to the context
///
@mixin iro-context-push($stack-id, $id, $data: ()) {
$noop: iro-context-push($stack-id, $id, $data);
}
///
/// Push a new context to a context stack.
///
/// @param {string} $stack-id - ID of context stack to use
/// @param {string} $id - ID of new context
/// @param {any} $data [()] - Data that belongs to the context
///
/// @return {list} A list with two items: 1 = context id, 2 = context data
///
@function iro-context-push($stack-id, $id, $data: ()) {
@if not map-has-key($iro-context-stacks, $stack-id) {
@error 'Context stack "#{inspect($stack-id)}" does not exist.';
}
$context: $id $data;
$context-stack: map-get($iro-context-stacks, $stack-id);
$context-stack: append($context-stack, $context);
$iro-context-stacks: map-merge($iro-context-stacks, ($stack-id: $context-stack)) !global;
@return $context;
}
///
/// Pop the latest context from a context stack.
///
/// @param {string} $stack-id - ID of context stack to use
///
/// @throw If context stack doesn't exist
///
@mixin iro-context-pop($stack-id) {
$noop: iro-context-pop($stack-id);
}
///
/// Pop the latest context from a context stack.
///
/// @param {string} $stack-id - ID of context stack to use
///
/// @return {list} A list with two items: 1 = context id, 2 = context data
///
@function iro-context-pop($stack-id) {
@if not map-has-key($iro-context-stacks, $stack-id) {
@error 'Context stack "#{inspect($stack-id)}" does not exist.';
}
$context-stack: map-get($iro-context-stacks, $stack-id);
@if length($context-stack) == 0 {
@error 'Context stack "#{inspect($stack-id)}" is already empty.';
}
$popped-context: nth($context-stack, -1);
@if length($context-stack) == 1 {
$context-stack: ();
} @else {
$context-stack: iro-list-slice($context-stack, 1, length($context-stack) - 1);
}
$iro-context-stacks: map-merge($iro-context-stacks, ($stack-id: $context-stack)) !global;
@return $popped-context;
}
///
/// Assert that a context stack must contain one of the given context IDs.
///
/// @param {string} $stack-id - ID of context stack to use
/// @param {list} $context-ids - Context IDs
/// @param {bool} $check-head-only [false] - If false, all items will be checked. If true, only the head will be checked.
///
/// @throw If assertion fails
///
@mixin iro-context-assert-stack-must-contain($stack-id, $context-ids, $check-head-only: false) {
@if not iro-context-stack-contains($stack-id, $context-ids, $check-head-only) {
@error 'Must be called inside of contexts "#{inspect($context-ids)}".';
}
}
///
/// Assert that a context stack must not contain any of the given context IDs.
///
/// @param {string} $stack-id - ID of context stack to use
/// @param {list} $context-ids - Context IDs
/// @param {bool} $check-head-only [false] - If false, all items will be checked. If true, only the head will be checked.
///
/// @throw If assertion fails
///
@mixin iro-context-assert-stack-must-not-contain($stack-id, $context-ids, $check-head-only: false) {
@if iro-context-stack-contains($stack-id, $context-ids, $check-head-only) {
@error 'Must not be called inside of contexts "#{inspect($context-ids)}".';
}
}
///
/// Check if a context stack contains one of the given context IDs.
///
/// @param {string} $stack-id - ID of context stack to use
/// @param {list} $context-ids - Context IDs
/// @param {bool} $check-head-only [false] - If false, all items will be checked. If true, only the head will be checked.
///
/// @return {bool} `true` if the context stack contains one of the context IDs, otherwise `false`
///
@function iro-context-stack-contains($stack-id, $context-ids, $check-head-only: false) {
@if not map-has-key($iro-context-stacks, $stack-id) {
@error 'Context stack "#{inspect($stack-id)}" does not exist.';
}
$context-stack: map-get($iro-context-stacks, $stack-id);
@if length($context-stack) == 0 {
@return false;
}
$end-idx: if($check-head-only, length($context-stack), 1);
@for $i from length($context-stack) through $end-idx {
$context: nth($context-stack, $i);
@each $chk-context in $context-ids {
@if nth($context, 1) == $chk-context {
@return true;
}
}
}
@return false;
}
///
/// Assert that a context stack must contain a number of contexts smaller than $max-count.
///
/// @param {string} $stack-id - ID of context stack to use
/// @param {number} $max-count - Maximum number ofg contexts in context stack
///
/// @throw If assertion fails
///
@mixin iro-context-assert-stack-count($stack-id, $max-count) {
@if iro-context-stack-count($stack-id) > $max-count {
@error 'Maximum context count "#{inspect($max-count)}" exceeded.';
}
}
///
/// Get the number of contexts from a context stack.
///
/// @param {string} $stack-id - ID of context stack to use
///
/// @return {number} The number of contexts
///
@function iro-context-stack-count($stack-id) {
@if not map-has-key($iro-context-stacks, $stack-id) {
@error 'Context stack "#{inspect($stack-id)}" does not exist.';
}
$context-stack: map-get($iro-context-stacks, $stack-id);
@return length($context-stack);
}
///
/// Get a specific context from the stack.
///
/// @param {string} $stack-id - ID of context stack to use
/// @param {number | string | list} $type-or-level - If this is a number (!= 0), the nth context from the head will be returned. If it is a string, the first context with a matching ID will be returned. If it is a list, the first context that matches one of the IDs in the list will be returned.
///
/// @return {list} Null if no match was found, otherwise a list with two items: 1. context ID, 2. context data.
///
@function iro-context-get($stack-id, $type-or-level: null) {
@if not map-has-key($iro-context-stacks, $stack-id) {
@error 'Context stack "#{inspect($stack-id)}" does not exist.';
}
$context-stack: map-get($iro-context-stacks, $stack-id);
@if length($context-stack) == 0 {
@return null;
}
@if type-of($type-or-level) == number {
$context: nth($context-stack, -$type-or-level);
@return $context;
} @else {
@for $i from -1 through -(length($context-stack)) {
$context: nth($context-stack, $i);
@if type-of($type-or-level) == list {
@for $j from 1 through length($type-or-level) {
$ctx: nth($type-or-level, $j);
@if nth($context, 1) == $ctx {
@return $context;
}
}
} @else if nth($context, 1) == $type-or-level {
@return $context;
}
}
}
@return null;
}
|
