summaryrefslogtreecommitdiff
path: root/support/arara/source/src/main/kotlin/org/islandoftex/arara/ruleset/Directive.kt
blob: 33f84317445b40e90b764135f3da1cb60f24ae5c (plain)
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
// SPDX-License-Identifier: BSD-3-Clause
package org.islandoftex.arara.ruleset

/**
 * Implements the directive model.
 *
 * @author Island of TeX
 * @version 5.0
 * @since 4.0
 */
data class Directive(
    /**
     * The directive identifier, it is resolved to the rule identifier
     * later on.
     */
    val identifier: String,
    /**
     * A map containing the parameters; they are validated later on in
     * order to ensure they are valid.
     */
    val parameters: Map<String, Any>,
    /**
     * A conditional containing the type and the expression to be evaluated
     * later on.
     */
    val conditional: Conditional,
    /**
     * A list contained all line numbers from the main file which built the
     * current directive.
     */
    val lineNumbers: List<Int>
)