driver

Documentation

Overview

Copyright 2016 Wenhui Shen <www.webx.top>

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.

Copyright 2016 Wenhui Shen <www.webx.top>

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.

Index

• Variables
• func CleanTemplateName(p string) string
• func RecoveryPRE(b []byte, pres [][]byte) []byte
• func RemoveMultiCRLF(b []byte) []byte
• func ReplacePRE(b []byte) ([]byte, [][]byte)
• type BaseManager
  • func (b *BaseManager) AddAllow(allows ...string)
  • func (b *BaseManager) AddCallback(rootDir string, callback func(name, typ, event string))
  • func (b *BaseManager) AddIgnore(ignores ...string)
  • func (b *BaseManager) AddWatchDir(ppath string) (err error)
  • func (b *BaseManager) CancelWatchDir(oldDir string) (err error)
  • func (b *BaseManager) ChangeWatchDir(oldDir string, newDir string) (err error)
  • func (b *BaseManager) ClearAllows()
  • func (b *BaseManager) ClearCache()
  • func (b *BaseManager) ClearCallback()
  • func (b *BaseManager) ClearIgnores()
  • func (b *BaseManager) Close()
  • func (b *BaseManager) DelAllow(allow string)
  • func (b *BaseManager) DelCallback(rootDir string)
  • func (b *BaseManager) DelIgnore(ignore string)
  • func (b *BaseManager) GetTemplate(string) ([]byte, error)
  • func (b *BaseManager) SetLogger(logger.Logger)
  • func (b *BaseManager) Start() error
• type Driver
• type Manager
• type NopRenderer
  • func (n *NopRenderer) ClearCache()
  • func (n *NopRenderer) Close()
  • func (n *NopRenderer) Debug() bool
  • func (n *NopRenderer) Fetch(_ string, _ interface{}, _ map[string]interface{}) string
  • func (n *NopRenderer) Init()
  • func (n *NopRenderer) Logger() logger.Logger
  • func (n *NopRenderer) MonitorEvent(_ func(string))
  • func (n *NopRenderer) RawContent(_ string) ([]byte, error)
  • func (n *NopRenderer) Render(w io.Writer, name string, data interface{}, c echo.Context) error
  • func (n *NopRenderer) SetContentProcessor(fn func([]byte) []byte)
  • func (n *NopRenderer) SetDebug(_ bool)
  • func (n *NopRenderer) SetFuncMap(_ func() map[string]interface{})
  • func (n *NopRenderer) SetLogger(_ logger.Logger)
  • func (n *NopRenderer) SetManager(_ Manager)
  • func (n *NopRenderer) TmplDir() string

Variables

var (
	FE    = []byte(`$1 $2`)
	First = []byte(`$1`)
)

Functions

func CleanTemplateName

func CleanTemplateName(p string) string

func RecoveryPRE

func RecoveryPRE(b []byte, pres [][]byte) []byte

func RemoveMultiCRLF

func RemoveMultiCRLF(b []byte) []byte

func ReplacePRE

func ReplacePRE(b []byte) ([]byte, [][]byte)

Types

type BaseManager

type BaseManager struct {
}

func (*BaseManager) AddAllow

func (b *BaseManager) AddAllow(allows ...string)

func (*BaseManager) AddCallback

func (b *BaseManager) AddCallback(rootDir string, callback func(name, typ, event string))

func (*BaseManager) AddIgnore

func (b *BaseManager) AddIgnore(ignores ...string)

func (*BaseManager) AddWatchDir

func (b *BaseManager) AddWatchDir(ppath string) (err error)

func (*BaseManager) CancelWatchDir

func (b *BaseManager) CancelWatchDir(oldDir string) (err error)

func (*BaseManager) ChangeWatchDir

func (b *BaseManager) ChangeWatchDir(oldDir string, newDir string) (err error)

func (*BaseManager) ClearAllows

func (b *BaseManager) ClearAllows()

func (*BaseManager) ClearCache

func (b *BaseManager) ClearCache()

func (*BaseManager) ClearCallback

func (b *BaseManager) ClearCallback()

func (*BaseManager) ClearIgnores

func (b *BaseManager) ClearIgnores()

func (*BaseManager) Close

func (b *BaseManager) Close()

func (*BaseManager) DelAllow

func (b *BaseManager) DelAllow(allow string)

func (*BaseManager) DelCallback

func (b *BaseManager) DelCallback(rootDir string)

func (*BaseManager) DelIgnore

func (b *BaseManager) DelIgnore(ignore string)

func (*BaseManager) GetTemplate

func (b *BaseManager) GetTemplate(string) ([]byte, error)

func (*BaseManager) SetLogger

func (b *BaseManager) SetLogger(logger.Logger)

func (*BaseManager) Start

func (b *BaseManager) Start() error

type Driver

type Driver interface {
	//初始化模板引擎
	Init()

	//获取模板根路径
	TmplDir() string
	Debug() bool
	SetDebug(bool)
	SetLogger(logger.Logger)
	Logger() logger.Logger

	//设置模板内容预处理器
	SetContentProcessor(fn func([]byte) []byte)
	SetManager(Manager)

	//设置模板函数
	SetFuncMap(func() map[string]interface{})

	//渲染模板
	Render(io.Writer, string, interface{}, echo.Context) error

	//获取模板渲染后的结果
	Fetch(string, interface{}, map[string]interface{}) string

	//读取模板原始内容
	RawContent(string) ([]byte, error)

	//模板目录监控事件
	MonitorEvent(func(string))

	//清除模板对象缓存
	ClearCache()

	//关闭并停用模板引擎
	Close()
}

type Manager

type Manager interface {
	Start() error
	Close()
	ClearCallback()
	AddCallback(rootDir string, callback func(name, typ, event string))
	DelCallback(rootDir string)
	ClearAllows()
	AddAllow(allows ...string)
	DelAllow(allow string)
	ClearIgnores()
	AddIgnore(ignores ...string)
	DelIgnore(ignore string)
	AddWatchDir(ppath string) (err error)
	CancelWatchDir(oldDir string) (err error)
	ChangeWatchDir(oldDir string, newDir string) (err error)
	SetLogger(logger.Logger)
	ClearCache()
	GetTemplate(string) ([]byte, error)
}

type NopRenderer

type NopRenderer struct{}

func (*NopRenderer) ClearCache

func (n *NopRenderer) ClearCache()

func (*NopRenderer) Close

func (n *NopRenderer) Close()

func (*NopRenderer) Debug

func (n *NopRenderer) Debug() bool

func (*NopRenderer) Fetch

func (n *NopRenderer) Fetch(_ string, _ interface{}, _ map[string]interface{}) string

func (*NopRenderer) Init

func (n *NopRenderer) Init()

func (*NopRenderer) Logger

func (n *NopRenderer) Logger() logger.Logger

func (*NopRenderer) MonitorEvent

func (n *NopRenderer) MonitorEvent(_ func(string))

func (*NopRenderer) RawContent

func (n *NopRenderer) RawContent(_ string) ([]byte, error)

func (*NopRenderer) Render

func (n *NopRenderer) Render(w io.Writer, name string, data interface{}, c echo.Context) error

func (*NopRenderer) SetContentProcessor

func (n *NopRenderer) SetContentProcessor(fn func([]byte) []byte)

func (*NopRenderer) SetDebug

func (n *NopRenderer) SetDebug(_ bool)

func (*NopRenderer) SetFuncMap

func (n *NopRenderer) SetFuncMap(_ func() map[string]interface{})

func (*NopRenderer) SetLogger

func (n *NopRenderer) SetLogger(_ logger.Logger)

func (*NopRenderer) SetManager

func (n *NopRenderer) SetManager(_ Manager)

func (*NopRenderer) TmplDir

func (n *NopRenderer) TmplDir() string