mirror of
https://github.com/gohugoio/hugo.git
synced 2026-08-24 15:28:54 +00:00
Bjørn Erik Pedersen
139 lines
4.8 KiB
Go
139 lines
4.8 KiB
Go
// 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/common/hsync"
|
|
"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 {
|
|
MarkupProvider
|
|
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 hsync.ValueResetter[OutputFormatContentProvider]
|
|
}
|
|
|
|
// NewLazyContentProvider returns a LazyContentProvider initialized with
|
|
// function f. The resulting LazyContentProvider calls f in order to
|
|
// retrieve a ContentProvider
|
|
func NewLazyContentProvider(f func(ctx context.Context) OutputFormatContentProvider) *LazyContentProvider {
|
|
lcp := LazyContentProvider{
|
|
init: hsync.OnceMoreValue(f),
|
|
}
|
|
return &lcp
|
|
}
|
|
|
|
func (lcp *LazyContentProvider) Reset() {
|
|
lcp.init.Reset()
|
|
}
|
|
|
|
func (lcp *LazyContentProvider) Markup(opts ...any) Markup {
|
|
return lcp.init.Value(context.Background()).Markup(opts...)
|
|
}
|
|
|
|
func (lcp *LazyContentProvider) TableOfContents(ctx context.Context) template.HTML {
|
|
return lcp.init.Value(ctx).TableOfContents(ctx)
|
|
}
|
|
|
|
func (lcp *LazyContentProvider) Fragments(ctx context.Context) *tableofcontents.Fragments {
|
|
return lcp.init.Value(ctx).Fragments(ctx)
|
|
}
|
|
|
|
func (lcp *LazyContentProvider) Content(ctx context.Context) (any, error) {
|
|
return lcp.init.Value(ctx).Content(ctx)
|
|
}
|
|
|
|
func (lcp *LazyContentProvider) ContentWithoutSummary(ctx context.Context) (template.HTML, error) {
|
|
return lcp.init.Value(ctx).ContentWithoutSummary(ctx)
|
|
}
|
|
|
|
func (lcp *LazyContentProvider) Plain(ctx context.Context) string {
|
|
return lcp.init.Value(ctx).Plain(ctx)
|
|
}
|
|
|
|
func (lcp *LazyContentProvider) PlainWords(ctx context.Context) []string {
|
|
return lcp.init.Value(ctx).PlainWords(ctx)
|
|
}
|
|
|
|
func (lcp *LazyContentProvider) Summary(ctx context.Context) template.HTML {
|
|
return lcp.init.Value(ctx).Summary(ctx)
|
|
}
|
|
|
|
func (lcp *LazyContentProvider) Truncated(ctx context.Context) bool {
|
|
return lcp.init.Value(ctx).Truncated(ctx)
|
|
}
|
|
|
|
func (lcp *LazyContentProvider) FuzzyWordCount(ctx context.Context) int {
|
|
return lcp.init.Value(ctx).FuzzyWordCount(ctx)
|
|
}
|
|
|
|
func (lcp *LazyContentProvider) WordCount(ctx context.Context) int {
|
|
return lcp.init.Value(ctx).WordCount(ctx)
|
|
}
|
|
|
|
func (lcp *LazyContentProvider) ReadingTime(ctx context.Context) int {
|
|
return lcp.init.Value(ctx).ReadingTime(ctx)
|
|
}
|
|
|
|
func (lcp *LazyContentProvider) Len(ctx context.Context) int {
|
|
return lcp.init.Value(ctx).Len(ctx)
|
|
}
|
|
|
|
func (lcp *LazyContentProvider) Render(ctx context.Context, layout ...string) (template.HTML, error) {
|
|
return lcp.init.Value(ctx).Render(ctx, layout...)
|
|
}
|
|
|
|
func (lcp *LazyContentProvider) RenderString(ctx context.Context, args ...any) (template.HTML, error) {
|
|
return lcp.init.Value(ctx).RenderString(ctx, args...)
|
|
}
|
|
|
|
func (lcp *LazyContentProvider) ParseAndRenderContent(ctx context.Context, content []byte, renderTOC bool) (converter.ResultRender, error) {
|
|
return lcp.init.Value(ctx).ParseAndRenderContent(ctx, content, renderTOC)
|
|
}
|
|
|
|
func (lcp *LazyContentProvider) ParseContent(ctx context.Context, content []byte) (converter.ResultParse, bool, error) {
|
|
return lcp.init.Value(ctx).ParseContent(ctx, content)
|
|
}
|
|
|
|
func (lcp *LazyContentProvider) RenderContent(ctx context.Context, content []byte, sourceInfo, doc any) (converter.ResultRender, bool, error) {
|
|
return lcp.init.Value(ctx).RenderContent(ctx, content, sourceInfo, doc)
|
|
}
|