hugo/hugolib/page__position.go
Joe Mooring 7f82461407 hugolib: Formally deprecate .Page.NextPage .Page.PrevPage
Use .Page.Next and .Page.Prev instead.
2024-02-03 17:28:52 +01:00

82 lines
1.9 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"
"github.com/gohugoio/hugo/common/hugo"
"github.com/gohugoio/hugo/lazy"
"github.com/gohugoio/hugo/resources/page"
)
func newPagePosition(n *nextPrev) pagePosition {
return pagePosition{nextPrev: n}
}
func newPagePositionInSection(n *nextPrev) pagePositionInSection {
return pagePositionInSection{nextPrev: n}
}
type nextPrev struct {
init *lazy.Init
prevPage page.Page
nextPage page.Page
}
func (n *nextPrev) next() page.Page {
n.init.Do(context.Background())
return n.nextPage
}
func (n *nextPrev) prev() page.Page {
n.init.Do(context.Background())
return n.prevPage
}
type pagePosition struct {
*nextPrev
}
func (p pagePosition) Next() page.Page {
return p.next()
}
// Deprecated: Use Next instead.
func (p pagePosition) NextPage() page.Page {
hugo.Deprecate(".Page.NextPage", "Use .Page.Next instead.", "v0.123.0")
return p.Next()
}
func (p pagePosition) Prev() page.Page {
return p.prev()
}
// Deprecated: Use Prev instead.
func (p pagePosition) PrevPage() page.Page {
hugo.Deprecate(".Page.PrevPage", "Use .Page.Prev instead.", "v0.123.0")
return p.Prev()
}
type pagePositionInSection struct {
*nextPrev
}
func (p pagePositionInSection) NextInSection() page.Page {
return p.next()
}
func (p pagePositionInSection) PrevInSection() page.Page {
return p.prev()
}