nestedreplacer

README

NestedReplacer

NestedReplacer is a Go package that provides functionality for performing nested replacements in text content. It allows you to replace multiple sections of text while maintaining the original structure and handling overlapping replacements.

Features

• Replace multiple sections of text in a single operation
• Handle overlapping replacements
• Support for both byte slices and strings
• Find all occurrences of a given text
• Find first or last occurrence of a given text
• Convert between rune and byte positions
• Create replacement blocks from strings or byte slices

Installation

To install NestedReplacer, use go get:

go get github.com/t34-dev/go-text-replacer

Usage

Here's a simple example of how to use NestedReplacer:

package main

import (
	"fmt"
	"log"

	nestedreplacer "github.com/t34-dev/go-text-replacer"
)

func main() {
	content := `
Chapter 1: Introduction to Programming (编程简介)

    1.1 What is Programming (什么是编程)
        Programming is the art of creating instructions for computers.
        It includes many aspects such as:
            - Algorithmic thinking (算法思维)
            - Block structures
            - Programming language syntax
`

	replacer := nestedreplacer.NewFromString(content)

	blocks := []nestedreplacer.Block{
		replacer.CreateBlockFromString("Introduction", "Getting Started with"),
		replacer.CreateBlockFromString("Programming", "Coding"),
		replacer.CreateBlockFromString("(算法思维)", "(Algorithmic Thinking)"),
	}

	result, err := replacer.Enter(blocks)
	if err != nil {
		log.Fatalln(err)
	}

	fmt.Println(string(result))
}

API Reference

Types

• Block: Represents a replacement block with Start, End, and Txt fields.
• Position: Represents the position of found text with Start and End fields.

Functions

• New(content []byte) *nestedReplacer: Creates a new instance of nestedReplacer with the given content.
• NewFromString(content string) *nestedReplacer: Creates a new instance of nestedReplacer from a string.

Methods

• Enter(blocks []Block) ([]byte, error): Applies replacement blocks to the original content.
• FindAllPositions(text []byte) []Position: Finds all positions of the given text in the content.
• FindFirstPosition(text []byte, startIndex int) *Position: Finds the first position of the given text in the content, starting from the specified index.
• FindLastPosition(text []byte, startIndex int) *Position: Finds the last position of the given text in the content, starting from the specified index from the end.
• CreateBlock(find, txt []byte) Block: Creates a block using the given find and replacement text.
• RuneToBytePosition(runeStart, runeEnd int) (byteStart, byteEnd int): Converts a position in runes to a position in bytes.
• ByteToRunePosition(byteStart, byteEnd int) (runeStart, runeEnd int): Converts a position in bytes to a position in runes.
• CreateBlockFromString(findRunes, txtRunes string) Block: Creates a block using rune positions.

License

This project is licensed under the ISC License. See the LICENSE file for details.

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

Documentation

Index

• func New(content []byte) *nestedReplacer
• func NewFromString(content string) *nestedReplacer
• type Block
• type Position

Functions

func New

func New(content []byte) *nestedReplacer

New creates a new instance of nestedReplacer with the given content.

func NewFromString

func NewFromString(content string) *nestedReplacer

NewFromString creates a new instance of nestedReplacer from a string.

Types

type Block

type Block struct {
	Start int
	End   int
	Txt   []byte
}

Block represents a structure for storing information about a replacement block.

type Position

type Position struct {
	Start int
	End   int
}

Position represents the position of found text.