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
|
// Copyright 2019 The Hugo Authors. All rights reserved.
//
// 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 hugolib
import (
"context"
"html/template"
"github.com/gohugoio/hugo/common/types"
"github.com/gohugoio/hugo/resources/page"
)
// A placeholder for the TableOfContents markup. This is what we pass to the Goldmark etc. renderers.
var tocShortcodePlaceholder = createShortcodePlaceholder("TOC", 0, 0)
// shortcodeRenderer is typically used to delay rendering of inner shortcodes
// marked with placeholders in the content.
type shortcodeRenderer interface {
renderShortcode(context.Context) ([]byte, bool, error)
renderShortcodeString(context.Context) (string, bool, error)
}
type shortcodeRenderFunc func(context.Context) ([]byte, bool, error)
func (f shortcodeRenderFunc) renderShortcode(ctx context.Context) ([]byte, bool, error) {
return f(ctx)
}
func (f shortcodeRenderFunc) renderShortcodeString(ctx context.Context) (string, bool, error) {
b, has, err := f(ctx)
return string(b), has, err
}
type prerenderedShortcode struct {
s string
hasVariants bool
}
func (p prerenderedShortcode) renderShortcode(context.Context) ([]byte, bool, error) {
return []byte(p.s), p.hasVariants, nil
}
func (p prerenderedShortcode) renderShortcodeString(context.Context) (string, bool, error) {
return p.s, p.hasVariants, nil
}
var zeroShortcode = prerenderedShortcode{}
// This is sent to the shortcodes. They cannot access the content
// they're a part of. It would cause an infinite regress.
//
// Go doesn't support virtual methods, so this careful dance is currently (I think)
// the best we can do.
type pageForShortcode struct {
page.PageWithoutContent
page.TableOfContentsProvider
page.ContentProvider
// We need to replace it after we have rendered it, so provide a
// temporary placeholder.
toc template.HTML
p *pageState
}
var _ types.Unwrapper = (*pageForShortcode)(nil)
func newPageForShortcode(p *pageState) page.Page {
return &pageForShortcode{
PageWithoutContent: p,
TableOfContentsProvider: p,
ContentProvider: page.NopPage,
toc: template.HTML(tocShortcodePlaceholder),
p: p,
}
}
// For internal use.
func (p *pageForShortcode) Unwrapv() any {
return p.PageWithoutContent.(page.Page)
}
func (p *pageForShortcode) String() string {
return p.p.String()
}
func (p *pageForShortcode) TableOfContents(context.Context) template.HTML {
return p.toc
}
var _ types.Unwrapper = (*pageForRenderHooks)(nil)
// This is what is sent into the content render hooks (link, image).
type pageForRenderHooks struct {
page.PageWithoutContent
page.TableOfContentsProvider
page.ContentProvider
p *pageState
}
func newPageForRenderHook(p *pageState) page.Page {
return &pageForRenderHooks{
PageWithoutContent: p,
ContentProvider: page.NopPage,
TableOfContentsProvider: p,
p: p,
}
}
func (p *pageForRenderHooks) Unwrapv() any {
return p.p
}
|
