mirror of
https://github.com/gohugoio/hugo.git
synced 2024-11-07 20:30:36 -05:00
37609262dc
Note that this also adds a new `.ContentWithoutSummary` method, and to do that we had to unify the different summary types:
Both `auto` and `manual` now returns HTML. Before this commit, `auto` would return plain text. This could be considered to be a slightly breaking change, but for the better: Now you can treat the `.Summary` the same without thinking about where it comes from, and if you want plain text, pipe it into `{{ .Summary | plainify }}`.
Fixes #8680
Fixes #12761
Fixes #12778
Fixes #716
127 lines
3.5 KiB
Go
127 lines
3.5 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 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.MarkupProvider
|
|
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,
|
|
MarkupProvider: page.NopPage,
|
|
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.MarkupProvider
|
|
page.ContentProvider
|
|
p *pageState
|
|
}
|
|
|
|
func newPageForRenderHook(p *pageState) page.Page {
|
|
return &pageForRenderHooks{
|
|
PageWithoutContent: p,
|
|
MarkupProvider: page.NopPage,
|
|
ContentProvider: page.NopPage,
|
|
TableOfContentsProvider: p,
|
|
p: p,
|
|
}
|
|
}
|
|
|
|
func (p *pageForRenderHooks) Unwrapv() any {
|
|
return p.p
|
|
}
|