aboutsummaryrefslogtreecommitdiff
path: root/plugins/templating/src/main/kotlin/templates/TemplatingPlugin.kt
blob: 8a2e5a2a4bdfce0bf4bb0bd325bf94436ef58186 (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
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
/*
 * Copyright 2014-2023 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license.
 */

package org.jetbrains.dokka.templates

import org.jetbrains.dokka.allModulesPage.templates.PackageListProcessingStrategy
import org.jetbrains.dokka.allModulesPage.templates.PagesSearchTemplateStrategy
import org.jetbrains.dokka.plugability.*
import templates.ProjectNameSubstitutor
import templates.ReplaceVersionCommandHandler
import templates.SourcesetDependencyProcessingStrategy

@Suppress("unused")
public class TemplatingPlugin : DokkaPlugin() {

    public val submoduleTemplateProcessor: ExtensionPoint<SubmoduleTemplateProcessor> by extensionPoint()
    public val multimoduleTemplateProcessor: ExtensionPoint<MultiModuleTemplateProcessor> by extensionPoint()
    public val templateProcessingStrategy: ExtensionPoint<TemplateProcessingStrategy> by extensionPoint()
    public val directiveBasedCommandHandlers: ExtensionPoint<CommandHandler> by extensionPoint()
    public val substitutor: ExtensionPoint<Substitutor> by extensionPoint()

    public val defaultSubmoduleTemplateProcessor: Extension<SubmoduleTemplateProcessor, *, *> by extending {
        submoduleTemplateProcessor providing ::DefaultSubmoduleTemplateProcessor
    }

    public val defaultMultiModuleTemplateProcessor: Extension<MultiModuleTemplateProcessor, *, *> by extending {
        multimoduleTemplateProcessor providing ::DefaultMultiModuleTemplateProcessor
    }

    public val directiveBasedHtmlTemplateProcessingStrategy: Extension<TemplateProcessingStrategy, *, *> by extending {
        templateProcessingStrategy providing ::DirectiveBasedHtmlTemplateProcessingStrategy order {
            before(fallbackProcessingStrategy)
        }
    }

    public val sourcesetDependencyProcessingStrategy: Extension<TemplateProcessingStrategy, *, *> by extending {
        templateProcessingStrategy providing ::SourcesetDependencyProcessingStrategy order {
            before(fallbackProcessingStrategy)
        }
    }

    public val pagesSearchTemplateStrategy: Extension<TemplateProcessingStrategy, *, *> by extending {
        templateProcessingStrategy providing ::PagesSearchTemplateStrategy order {
            before(fallbackProcessingStrategy)
        }
    }

    public val packageListProcessingStrategy: Extension<TemplateProcessingStrategy, *, *> by extending {
        templateProcessingStrategy providing ::PackageListProcessingStrategy order {
            before(fallbackProcessingStrategy)
        }
    }

    public val fallbackProcessingStrategy: Extension<TemplateProcessingStrategy, *, *> by extending {
        templateProcessingStrategy with FallbackTemplateProcessingStrategy()
    }

    public val pathToRootSubstitutor: Extension<Substitutor, *, *> by extending {
        substitutor providing ::PathToRootSubstitutor
    }

    public val projectNameSubstitutor: Extension<Substitutor, *, *> by extending {
        substitutor providing ::ProjectNameSubstitutor
    }

    public val addToNavigationCommandHandler: Extension<CommandHandler, *, *> by extending {
        directiveBasedCommandHandlers providing ::AddToNavigationCommandHandler
    }
    public val substitutionCommandHandler: Extension<CommandHandler, *, *> by extending {
        directiveBasedCommandHandlers providing ::SubstitutionCommandHandler
    }
    public val replaceVersionCommandHandler: Extension<CommandHandler, *, *> by extending {
        directiveBasedCommandHandlers providing ::ReplaceVersionCommandHandler
    }

    @OptIn(DokkaPluginApiPreview::class)
    override fun pluginApiPreviewAcknowledgement(): PluginApiPreviewAcknowledgement =
        PluginApiPreviewAcknowledgement
}