-
Notifications
You must be signed in to change notification settings - Fork 44
/
Transformer.scala
102 lines (89 loc) · 3.71 KB
/
Transformer.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
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
/*
* 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
import laika.api.builder.{ OperationConfig, TransformerBuilder, TwoPhaseTransformerBuilder }
import laika.api.errors.TransformationError
import laika.api.format.{ MarkupFormat, RenderFormat, TwoPhaseRenderFormat }
import laika.ast.Path
import laika.ast.Path.Root
/** Performs a transformation from text markup like Markdown or reStructuredText
* to a target format like HTML as a String.
*
* Example for transforming from Markdown to HTML:
*
* {{{
* val res: Either[ParserError, String] = Transformer
* .from(Markdown)
* .to(HTML)
* .using(GitHubFlavor)
* .build
* .transform("hello *there*)
* }}}
*
* This is a pure API that does not perform any side-effects.
* For additional options like File and Stream I/O, templating
* or parallel processing, use the corresponding builders in
* the laika-io module.
*
* @author Jens Halm
*/
class Transformer private[laika] (val parser: MarkupParser, val renderer: Renderer) {
def transform(input: String): Either[TransformationError, String] = transform(input, Root)
def transform(input: String, path: Path): Either[TransformationError, String] =
parser.parse(input, path).flatMap(renderer.render)
}
/** Entry point for building a Transformer instance.
*
* @author Jens Halm
*/
object Transformer {
/** Step in the setup for a transform operation where the
* renderer must be specified.
*/
class Builder private[Transformer] (parser: MarkupFormat, config: OperationConfig) {
/** Creates and returns a new builder instance for the specified renderer and the
* previously specified parser.
*
* @param format the render format to use for the transformation
* @return a new builder instance for a Transformer
*/
def to[FMT](format: RenderFormat[FMT]): TransformerBuilder[FMT] =
new TransformerBuilder(parser, format, config)
/** Returns a new builder instance for the specified two-phase render format and the
* previously specified parser.
*
* The format is usually an object provided by the library
* or a plugin that is capable of producing a specific output format like EPUB or PDF.
*
* While the builder API for two-phase renderers is defined as part of the laika-core module, the concrete
* implementations of this renderer type that this library provides (EPUB and PDF)
* reside in sub-modules as they require the functionality of the laika-io module.
*/
def to[FMT, PP](format: TwoPhaseRenderFormat[FMT, PP]): TwoPhaseTransformerBuilder[FMT, PP] =
new TwoPhaseTransformerBuilder[FMT, PP](parser, format, config)
}
/** Returns a new Builder instance for the specified markup format.
*
* This format is usually an object provided by the library
* or a plugin that is capable of parsing a specific markup
* format like Markdown or reStructuredText.
*
* @param format the markup format to use
* @return a new Builder instance for specifying the render format
*/
def from(format: MarkupFormat): Builder =
new Builder(format, OperationConfig.default.withBundlesFor(format))
}