aboutsummaryrefslogtreecommitdiffstats
path: root/src/_props.scss
blob: 14295bdc535de755675a19511cd7d820d6df3d4a (plain) (blame)
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
////
/// Property trees.
///
/// Property trees allow you to organize properties in a tree structure (internally nested maps).
/// The intended use is to store all your properties at the beginning and for the rest of the
/// stylesheet you just get them.
///
/// @group Property trees
///
/// @access public
////

@use 'sass:map';
@use 'sass:list';
@use 'sass:string';
@use 'sass:meta';
@use './functions';
@use './contexts';

///
/// The maximum depth of resolved iro-prop-ref() references.
///
/// @type number
///
$native-assign-max-depth: 2 !default;

///
/// Indicate if property names must start with two dashes (--).
/// This is required if property trees are also used for native CSS custom properties.
///
/// @type bool
///
$enforce-double-dashes: true !default;

///
/// Default tree name to use if no name is specified.
///
/// @type string
///
$default-tree: 'default' !default;

///
/// List of all created property trees.
///
/// @type list
///
/// @access private
///
$trees: ();

///
/// Default context name used for the namespace context.
///
/// @type string
///
$namespace-context-id: 'namespace' !default;

///
/// Declare a namespace, meaning that all variables declared and accessed.
///
/// @param {string} $name - Name of the namespace
///
@mixin namespace($name) {
    $key: '--#{$name}';

    $ns-key: get-ns-key();

    @if $ns-key != null {
        $key: list.append($ns-key, $key);
    } @else {
        $key: ($key);
    }

    @include contexts.push($namespace-context-id, 'namespace', (
        'name': $name,
        'key':  $key
    ));

    @content;

    @include contexts.pop($namespace-context-id);
}

///
/// Get the current namespace name.
///
@function namespace() {
    $noop: contexts.assert-stack-must-contain($namespace-context-id, 'namespace');

    $data: list.nth(contexts.get($namespace-context-id, 'namespace'), 2);
    $name: map.get($data, 'name');

    @return $name;
}

/// 
/// Save a property tree. If a tree with the sane name already exists, the trees
/// will be merged.
///
/// @param {map}    $map                             - Map containing properties
/// @param {string} $tree  [$default-tree] - ID the map is saved as
/// @param {bool}   $merge [true]                    - If a tree named $tree already exists and this value is set to true, they will be merged. Otherwise an error will be emitted.
///
@mixin store($map, $tree: $default-tree, $merge: true, $global: false) {
    $noop: store($map, $tree, $merge, $global);
}

/// 
/// Save a property tree.
///
/// @param {map}    $map                             - Map containing properties
/// @param {string} $tree  [$default-tree] - ID the map is saved as
/// @param {bool}   $merge [true]                    - If a tree named $tree already exists and this value is set to true, they will be merged. Otherwise an error will be emitted.
///
@function store($map, $tree: $default-tree, $merge: true, $global: false) {
    $prop-map: null;

    @if $enforce-double-dashes {
        @if not validate($map) {
            @error 'Property tree keys must start with two dashes (--). If you don\'t use property trees for native CSS custom properties, set $enforce-double-dashes to false.';
        }
    }

    @if not $global {
        $ns-key: get-ns-key();

        @if $ns-key != null {
            $map: ($ns-key: $map);
        }
    }

    @if map.has-key($trees, $tree) {
        @if $merge {
            $map: map.deep-merge(map.get($trees, $tree), $map);
        } @else {
            @error 'Property tree #{inspect($tree)} does already exist.';
        }
    }

    $trees: map.merge($trees, ($tree: $map)) !global;

    @return null;
}

/// 
/// Delete a property tree.
///
/// @param {string} $tree [$default-tree] - ID of the tree to be deleted
///
@mixin clear($tree: $default-tree) {
    $noop: clear($tree);
}

/// 
/// Delete a property tree.
///
/// @param {string} $tree [$default-tree] - ID of the tree to be deleted
///
/// @throw If the property tree does not exist
///
@function clear($tree: $default-tree) {
    @if not map.has-key($trees, $tree) {
        @error 'Property tree "#{inspect($tree)}" does not exist.';
    }

    $trees: map.remove($trees, $tree) !global;

    @return null;
}

/// 
/// Access a whole property or a subsection (i.e. value) of it.
///
/// @param {string | list} $key     [null]                    - Key of the property to read. If this is a list of keys, the map will be traversed in that order.
/// @param {string}        $tree    [$default-tree] - ID of the property tree to use
/// @param {any}           $default [null]                    - Default value to return of no match was found. If null, this function will throw an error instead.
///
/// @return {any} Value assigned to property or $default
///
/// @throw If there was no match for $key and $default is null
///
@function get-static($key: (), $tree: $default-tree, $default: null, $global: false) {
    @if not map.has-key($trees, $tree) {
        @error 'Unknown tree "#{$tree}".';
    }

    $result: map.get($trees, $tree);

    @if not $global {
        $ns-key: get-ns-key();

        @if $ns-key != null {
            $orig-key: $key;
            $key:      $ns-key;

            @if meta.type-of($orig-key) == list {
                @each $subkey in $orig-key {
                    $key: list.append($key, $subkey);
                }
            } @else {
                $key: list.append($key, $orig-key);
            }
        }
    }

    @if meta.type-of($key) == list {
        $stop: false;

        @each $k in $key {
            @if not $stop and map.has-key($result, $k) {
                $result: map.get($result, $k);

                @if meta.type-of($result) == list and list.nth($result, 1) == 'iro-prop-ref' {
                    @if list.length($result) == 2 {
                        $result: get-static($tree: list.nth($result, 2), $global: true);
                    } @else {
                        $result: get-static(list.nth($result, 3), nth($result, 2), $global: true);
                    }
                }
            } @else {
                $stop: true;
            }
        }

        @if $stop {
            $result: null;
        }
    } @else {
        $result: map.get($result, $key);

        @if meta.type-of($result) == list and list.nth($result, 1) == 'iro-prop-ref' {
            @if list.length($result) == 2 {
                $result: get-static($tree: list.nth($result, 2), $global: true);
            } @else {
                $result: get-static(list.nth($result, 3), nth($result, 2), $global: true);
            }
        }
    }

    @if $result == null {
        @if $default == null {
            @error '"#{$key}" is null.';
        } @else {
            @return $default;
        }
    }

    @return $result;
}

/// 
/// Generate a var() function call to get native CSS custom property.
///
/// @param {string | list} $key            - Key of the property to read. If this is a list of keys, the map will be traversed in that order.
/// @param {string | null} $tree    [null] - Optional tree to check if the property actually exists.
/// @param {any}           $default [null] - Default value to return of no match was found.
///
/// @return {string} var()
///
@function get($key, $tree: $default-tree, $default: null, $global: false) {
    @if $tree != null {
        $value: get-static($key, $tree, $default, $global);

        @if meta.type-of($value) == map {
            $result: ();
            @each $k in map.keys($value) {
                $result: map.set($result, $k, get(list.append($key, $k), $tree, $default, $global));
            }
            @return $result;
        }
    }

    @if not $global {
        $ns-key: get-ns-key();

        @if $ns-key != null {
            $orig-key: $key;
            $key:      $ns-key;

            @if meta.type-of($orig-key) == list {
                @each $subkey in $orig-key {
                    $key: list.append($key, $subkey);
                }
            } @else {
                $key: list.append($key, $orig-key);
            }
        }
    }

    $native-var: '';

    @if meta.type-of($key) == list {
        @each $subkey in $key {
            $native-var: $native-var + $subkey;
        }
    } @else {
        $native-var: $key;
    }

    @if $default == null {
        @return var(#{$native-var});
    } @else {
        @return var(#{$native-var}, #{$default});
    }
}

/// 
/// Generate assignments for native CSS custom properties with the values from the specified tree.
///
/// @param {string} $tree [$default-tree] - ID of the property tree to use
/// @param {string} $root [()]                      - Sub-tree to use for assignment
///
@mixin assign($tree: $default-tree, $root: (), $skip: (), $prefix: $root, $global: false) {
    $map: get-static($root, $tree, $global: $global);
    $map: map.remove($map, $skip...);

    @if meta.type-of($prefix) == list {
        $prefix: functions.str-implode($prefix);
    }

    @if not $global {
        $ns-key: get-ns-key();

        @if $ns-key != null {
            $prefix: $prefix + functions.str-implode($ns-key);
        }
    }

    @include assign-internal($map, $prefix);
}

///
/// @access private
///
@mixin assign-internal($map, $prefix: '', $ref-depth: $native-assign-max-depth) {
    @each $key, $value in $map {
        $rd: $ref-depth;
        @if meta.type-of($value) == list and list.length($value) > 0 and list.nth($value, 1) == 'iro-prop-ref' {
            @if $ref-depth != 0 {
                $rd: $rd - 1;
                @if list.length($value) == 2 {
                    $value: get-static($tree: list.nth($value, 2));
                } @else {
                    $value: get-static(list.nth($value, 3), nth($value, 2));
                }
            } @else {
                $value: null;
            }
        }
        @if meta.type-of($value) != map and $value != () {
            #{$prefix + $key}: #{$value};
        } @else {
            @include assign-internal($value, $prefix + $key, $rd);
        }
    }
}

/// 
/// Validate property names.
///
/// @access private
///
@function validate($map) {
    @each $key, $value in $map {
        @if string.index($key, '--') != 1 {
            @return false;
        }

        @if meta.type-of($value) == map {
            @if not validate($value) {
                @return false;
            }
        }
    }

    @return true;
}

/// 
/// Generate a reference to another tree. Dereferencing is lazy, so you may specify a tree that hasn't been created yet.
///
/// @param {string}        $tree [$default-tree] - ID of the property tree to use
/// @param {string | list} $key                            - Key of the property to read. If this is a list of keys, the map will be traversed in that order.
///
/// @return {list} A special list that let's Ignis know that this is a lazy value.
///
/// @throw If there was no match for $key and $default is null
///
@function ref($tree: $default-tree, $key: null, $global: false) {
    @if not $global {
        $ns-key: get-ns-key();

        @if $ns-key != null {
            $orig-key: $key;
            $key:      $ns-key;

            @if $orig-key != null {
                @if meta.type-of($orig-key) == list {
                    @each $subkey in $orig-key {
                        $key: list.append($key, $subkey);
                    }
                } @else {
                    $key: list.append($key, $orig-key);
                }
            }
        }
    }

    @if $key == null {
        @return ('iro-prop-ref' $tree);
    } @else {
        @return ('iro-prop-ref' $tree $key);
    }
}

/// 
/// Get the current namespace key.
///
/// @access private
///
@function get-ns-key() {
    $ctx: contexts.get($namespace-context-id, 'namespace');

    @if $ctx == null {
        @return null;
    }

    $data: list.nth($ctx, 2);
    $key:  map.get($data, 'key');

    @return $key;
}

@include contexts.create($namespace-context-id);