snapshot of https://github.com/blevesearch/bleve.git (master, 2026-09-15; blobs > 131072B omitted)

registry/highlighter.go

@@ -0,0 +1,90 @@
+//  Copyright (c) 2014 Couchbase, Inc.
+//
+// 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 registry
+
+import (
+	"fmt"
+
+	"github.com/blevesearch/bleve/v2/search/highlight"
+)
+
+func RegisterHighlighter(name string, constructor HighlighterConstructor) error {
+	_, exists := highlighters[name]
+	if exists {
+		return fmt.Errorf("attempted to register duplicate highlighter named '%s'", name)
+	}
+	highlighters[name] = constructor
+	return nil
+}
+
+type HighlighterConstructor func(config map[string]interface{}, cache *Cache) (highlight.Highlighter, error)
+type HighlighterRegistry map[string]HighlighterConstructor
+
+type HighlighterCache struct {
+	*ConcurrentCache
+}
+
+func NewHighlighterCache() *HighlighterCache {
+	return &HighlighterCache{
+		NewConcurrentCache(),
+	}
+}
+
+func HighlighterBuild(name string, config map[string]interface{}, cache *Cache) (interface{}, error) {
+	cons, registered := highlighters[name]
+	if !registered {
+		return nil, fmt.Errorf("no highlighter with name or type '%s' registered", name)
+	}
+	highlighter, err := cons(config, cache)
+	if err != nil {
+		return nil, fmt.Errorf("error building highlighter: %v", err)
+	}
+	return highlighter, nil
+}
+
+func (c *HighlighterCache) HighlighterNamed(name string, cache *Cache) (highlight.Highlighter, error) {
+	item, err := c.ItemNamed(name, cache, HighlighterBuild)
+	if err != nil {
+		return nil, err
+	}
+	return item.(highlight.Highlighter), nil
+}
+
+func (c *HighlighterCache) DefineHighlighter(name string, typ string, config map[string]interface{}, cache *Cache) (highlight.Highlighter, error) {
+	item, err := c.DefineItem(name, typ, config, cache, HighlighterBuild)
+	if err != nil {
+		if err == ErrAlreadyDefined {
+			return nil, fmt.Errorf("highlighter named '%s' already defined", name)
+		}
+		return nil, err
+	}
+	return item.(highlight.Highlighter), nil
+}
+
+func HighlighterTypesAndInstances() ([]string, []string) {
+	emptyConfig := map[string]interface{}{}
+	emptyCache := NewCache()
+	var types []string
+	var instances []string
+	for name, cons := range highlighters {
+		_, err := cons(emptyConfig, emptyCache)
+		if err == nil {
+			instances = append(instances, name)
+		} else {
+			types = append(types, name)
+		}
+	}
+	return types, instances
+}