mirror of
https://github.com/gohugoio/hugo.git
synced 2024-07-05 00:32:03 +00:00
81c13171a9
As pointed out by the linter, some exported functions and types are missing doc comments. The linter warnings have been reduced from 194 to 116. Not all missing comments have been added in this commit though.
114 lines
2.8 KiB
Go
114 lines
2.8 KiB
Go
// Copyright 2017-present 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 tpl
|
|
|
|
import (
|
|
"io"
|
|
|
|
"text/template/parse"
|
|
|
|
"html/template"
|
|
texttemplate "text/template"
|
|
|
|
bp "github.com/gohugoio/hugo/bufferpool"
|
|
)
|
|
|
|
var (
|
|
_ TemplateExecutor = (*TemplateAdapter)(nil)
|
|
)
|
|
|
|
// TemplateHandler manages the collection of templates.
|
|
type TemplateHandler interface {
|
|
TemplateFinder
|
|
AddTemplate(name, tpl string) error
|
|
AddLateTemplate(name, tpl string) error
|
|
LoadTemplates(absPath, prefix string)
|
|
PrintErrors()
|
|
|
|
MarkReady()
|
|
RebuildClone()
|
|
}
|
|
|
|
// TemplateFinder finds templates.
|
|
type TemplateFinder interface {
|
|
Lookup(name string) *TemplateAdapter
|
|
}
|
|
|
|
// Template is the common interface between text/template and html/template.
|
|
type Template interface {
|
|
Execute(wr io.Writer, data interface{}) error
|
|
Name() string
|
|
}
|
|
|
|
// TemplateExecutor adds some extras to Template.
|
|
type TemplateExecutor interface {
|
|
Template
|
|
ExecuteToString(data interface{}) (string, error)
|
|
Tree() string
|
|
}
|
|
|
|
// TemplateDebugger prints some debug info to stdoud.
|
|
type TemplateDebugger interface {
|
|
Debug()
|
|
}
|
|
|
|
// TemplateAdapter implements the TemplateExecutor interface.
|
|
type TemplateAdapter struct {
|
|
Template
|
|
}
|
|
|
|
// ExecuteToString executes the current template and returns the result as a
|
|
// string.
|
|
func (t *TemplateAdapter) ExecuteToString(data interface{}) (string, error) {
|
|
b := bp.GetBuffer()
|
|
defer bp.PutBuffer(b)
|
|
if err := t.Execute(b, data); err != nil {
|
|
return "", err
|
|
}
|
|
return b.String(), nil
|
|
}
|
|
|
|
// Tree returns the template Parse tree as a string.
|
|
// Note: this isn't safe for parallel execution on the same template
|
|
// vs Lookup and Execute.
|
|
func (t *TemplateAdapter) Tree() string {
|
|
var tree *parse.Tree
|
|
switch tt := t.Template.(type) {
|
|
case *template.Template:
|
|
tree = tt.Tree
|
|
case *texttemplate.Template:
|
|
tree = tt.Tree
|
|
default:
|
|
panic("Unknown template")
|
|
}
|
|
|
|
if tree == nil || tree.Root == nil {
|
|
return ""
|
|
}
|
|
s := tree.Root.String()
|
|
|
|
return s
|
|
}
|
|
|
|
// TemplateFuncsGetter allows to get a map of functions.
|
|
type TemplateFuncsGetter interface {
|
|
GetFuncs() map[string]interface{}
|
|
}
|
|
|
|
// TemplateTestMocker adds a way to override some template funcs during tests.
|
|
// The interface is named so it's not used in regular application code.
|
|
type TemplateTestMocker interface {
|
|
SetFuncs(funcMap map[string]interface{})
|
|
}
|