summaryrefslogtreecommitdiffstats
path: root/resources/page/page_lazy_contentprovider.go
blob: 665b2d00332c067ea7e62740bcc1bef825549bfc (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
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
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
// 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 page

import (
	"context"
	"html/template"

	"github.com/gohugoio/hugo/lazy"
	"github.com/gohugoio/hugo/markup/converter"
	"github.com/gohugoio/hugo/markup/tableofcontents"
)

// OutputFormatContentProvider represents the method set that is "outputFormat aware" and that we
// provide lazy initialization for in case they get invoked outside of their normal rendering context, e.g. via .Translations.
// Note that this set is currently not complete, but should cover the most common use cases.
// For the others, the implementation will be from the page.NoopPage.
type OutputFormatContentProvider interface {
	OutputFormatPageContentProvider

	// for internal use.
	ContentRenderer
}

// OutputFormatPageContentProvider holds the exported methods from Page that are "outputFormat aware".
type OutputFormatPageContentProvider interface {
	ContentProvider
	TableOfContentsProvider
	PageRenderProvider
}

// LazyContentProvider initializes itself when read. Each method of the
// ContentProvider interface initializes a content provider and shares it
// with other methods.
//
// Used in cases where we cannot guarantee whether the content provider
// will be needed. Must create via NewLazyContentProvider.
type LazyContentProvider struct {
	init *lazy.Init
	cp   OutputFormatContentProvider
}

// NewLazyContentProvider returns a LazyContentProvider initialized with
// function f. The resulting LazyContentProvider calls f in order to
// retrieve a ContentProvider
func NewLazyContentProvider(f func() (OutputFormatContentProvider, error)) *LazyContentProvider {
	lcp := LazyContentProvider{
		init: lazy.New(),
		cp:   NopCPageContentRenderer,
	}
	lcp.init.Add(func(context.Context) (any, error) {
		cp, err := f()
		if err != nil {
			return nil, err
		}
		lcp.cp = cp
		return nil, nil
	})
	return &lcp
}

func (lcp *LazyContentProvider) Reset() {
	lcp.init.Reset()
}

func (lcp *LazyContentProvider) TableOfContents(ctx context.Context) template.HTML {
	lcp.init.Do(ctx)
	return lcp.cp.TableOfContents(ctx)
}

func (lcp *LazyContentProvider) Fragments(ctx context.Context) *tableofcontents.Fragments {
	lcp.init.Do(ctx)
	return lcp.cp.Fragments(ctx)
}

func (lcp *LazyContentProvider) Content(ctx context.Context) (any, error) {
	lcp.init.Do(ctx)
	return lcp.cp.Content(ctx)
}

func (lcp *LazyContentProvider) Plain(ctx context.Context) string {
	lcp.init.Do(ctx)
	return lcp.cp.Plain(ctx)
}

func (lcp *LazyContentProvider) PlainWords(ctx context.Context) []string {
	lcp.init.Do(ctx)
	return lcp.cp.PlainWords(ctx)
}

func (lcp *LazyContentProvider) Summary(ctx context.Context) template.HTML {
	lcp.init.Do(ctx)
	return lcp.cp.Summary(ctx)
}

func (lcp *LazyContentProvider) Truncated(ctx context.Context) bool {
	lcp.init.Do(ctx)
	return lcp.cp.Truncated(ctx)
}

func (lcp *LazyContentProvider) FuzzyWordCount(ctx context.Context) int {
	lcp.init.Do(ctx)
	return lcp.cp.FuzzyWordCount(ctx)
}

func (lcp *LazyContentProvider) WordCount(ctx context.Context) int {
	lcp.init.Do(ctx)
	return lcp.cp.WordCount(ctx)
}

func (lcp *LazyContentProvider) ReadingTime(ctx context.Context) int {
	lcp.init.Do(ctx)
	return lcp.cp.ReadingTime(ctx)
}

func (lcp *LazyContentProvider) Len(ctx context.Context) int {
	lcp.init.Do(ctx)
	return lcp.cp.Len(ctx)
}

func (lcp *LazyContentProvider) Render(ctx context.Context, layout ...string) (template.HTML, error) {
	lcp.init.Do(ctx)
	return lcp.cp.Render(ctx, layout...)
}

func (lcp *LazyContentProvider) RenderString(ctx context.Context, args ...any) (template.HTML, error) {
	lcp.init.Do(ctx)
	return lcp.cp.RenderString(ctx, args...)
}

func (lcp *LazyContentProvider) ParseAndRenderContent(ctx context.Context, content []byte, renderTOC bool) (converter.ResultRender, error) {
	lcp.init.Do(ctx)
	return lcp.cp.ParseAndRenderContent(ctx, content, renderTOC)
}

func (lcp *LazyContentProvider) ParseContent(ctx context.Context, content []byte) (converter.ResultParse, bool, error) {
	lcp.init.Do(ctx)
	return lcp.cp.ParseContent(ctx, content)
}

func (lcp *LazyContentProvider) RenderContent(ctx context.Context, content []byte, doc any) (converter.ResultRender, bool, error) {
	lcp.init.Do(ctx)
	return lcp.cp.RenderContent(ctx, content, doc)
}