type.go

// -----------------------------------------------------------------------------
// CMDX Utilities Suite                                           cmdx/[type.go]
// (c) balarabe@protonmail.com                                    License: GPLv3
// -----------------------------------------------------------------------------

package main

import (
	"time"

	"github.com/balacode/zr"
)

// -----------------------------------------------------------------------------
// # Types

// BuildIssue stores the message and location of each build issue/error
type BuildIssue struct {
	File string // file name (may be with or without a path)
	Line int    // line number
	Col  int    // column number
	Msg  string // message (usually a build error message)
}

// FilesMap groups files by their file sizes.
// (If two files have different sizes, they're definitely
// different, so there's no need to open and compare them.)
type FilesMap map[int64][]*PathAndSize

// FindReplLinesBatch holds groups of searches
// and corresponding replacements.
type FindReplLinesBatch struct {
	FindLines []Lines
	ReplLines []Lines
}

// FindReplLines _ _
type FindReplLines struct {
	Path      string
	Exts      []string
	FindLines []string
	ReplLines []string
	CaseMode  zr.CaseMode
}

// FindReplLinesTree _ _
type FindReplLinesTree struct {
	FindLines Lines                         // what to find
	ReplLines Lines                         // what to replace with
	Sub       map[string]*FindReplLinesTree // a 'branch' of the tree
}

// Lines _ _
type Lines []string

// PathAndSize stores a fully-qualified file name and the file's size.
type PathAndSize struct {
	Path string
	Size int64
}

// ReplCmd _ _
type ReplCmd struct {
	Path  string
	Exts  []string
	Mark  string
	Items []ReplItem
}

// ReplItem _ _
type ReplItem struct {
	Find     string
	Repl     string
	CaseMode zr.CaseMode
	WordMode zr.WordMode
}

// TextFile holds file details and content of a text file.
type TextFile struct {
	Path    string
	ModTime time.Time
	Size    int64
	Lines   []string
}

// end