-
Notifications
You must be signed in to change notification settings - Fork 44
/
BundleOrigin.scala
69 lines (60 loc) · 2.68 KB
/
BundleOrigin.scala
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
/*
* Copyright 2012-2020 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package laika.api.bundle
/** Indicates whether an extension bundle is a built-in default provided by the library,
* a collection of extensions installed by a markup format or user-defined.
*
* This is relevant for determining the precedence of installed bundles when merging
* them, as user-supplied functionality always overrides library defaults.
*
* @author Jens Halm
*/
sealed trait BundleOrigin
object BundleOrigin {
/** Indicates that the extension bundle is a built-in extension provided by Laika.
*
* Internally Laika uses its own extension hooks to provide non-standard
* functionality like its directive syntax. Keeping it in extensions
* means these features can be disabled when run in strict mode.
*/
case object Library extends BundleOrigin
/** Indicates that the extension bundle is provided by a parser for markup format.
*
* A parser may either provide a feature as a bundle to allow the user to disable
* it, e.g. support for raw content in the output format which might be security risk
* when entered by the user.
*
* Another scenario is a parser that needs to supply custom renderers as its
* parsers produce AST nodes which are not known by the built-in renderers.
*/
case object Parser extends BundleOrigin
/** Indicates that the extension bundle is provided by a theme.
*
* A theme usually focuses on pre-populating the input tree with templates,
* styles and configuration, but may in addition also decide to offer lower-level extensions
* such as custom directives or extensions to markup syntax.
*/
case object Theme extends BundleOrigin
/** Indicates that the extension bundle has been provided by the user.
*/
case object User extends BundleOrigin
/** Indicates that a bundle has been merged from multiple individual bundles
* with different origins. This would normally not occur before the final
* step in a parse or transform operation when the final bundle is merged
* internally from all the individual bundles.
*/
case object Mixed extends BundleOrigin
}