visitors

type Assemble struct {
	// contains filtered or unexported fields
}

type Cat struct {
	// Input
	Predicate func(f uefi.Firmware) bool

	// Output
	io.Writer
	Matches []uefi.Firmware
}

type Comment struct {
	W io.Writer
	// contains filtered or unexported fields
}

type Count struct {
	// Optionally write result as JSON.
	W io.Writer `json:"-"`

	// Output
	FirmwareTypeCount map[string]int
	FileTypeCount     map[string]int
	SectionTypeCount  map[string]int
}

type CreateFV struct {
	AbsOffset uint64
	Size      uint64
	Name      guid.GUID
	// contains filtered or unexported fields
}

type DXECleaner struct {
	// This function tests whether the firmware boots. The return values can be:
	//
	//     - (false, nil): The firmware was tested and failed to boot.
	//     - (false, err): The firmware was tested and failed to boot due to err.
	//     - (true, nil):  The firmware was tested and booted.
	//     - (true, err):  Failed to test the firmware due to err.
	Test func(f uefi.Firmware) (bool, error)

	// Predicate to determine whether a DXE can be removed.
	Predicate FindPredicate

	// List of GUIDs which were removed.
	Removals []guid.GUID

	// Logs are written to this writer.
	W io.Writer
}

type Dump struct {
	// Input
	Predicate func(f uefi.Firmware) bool

	// Output
	// The file is written to this writer.
	W io.Writer
}

type Extract struct {
	BasePath string
	DirPath  string
	Index    *uint64
}

type Find struct {
	// Input
	// Only when this functions returns true will the file appear in the
	// `Matches` slice.
	Predicate FindPredicate

	// Output
	Matches []uefi.Firmware

	// JSON is written to this writer.
	W io.Writer
	// contains filtered or unexported fields
}

type FindPredicate = func(f uefi.Firmware) bool

type Flatten struct {
	// Optionally write result as JSON.
	W io.Writer

	// Outputted flattened tree.
	List []FlattenedFirmware
	// contains filtered or unexported fields
}

type FlattenedFirmware struct {
	Parent int
	Type   string
	Value  uefi.Firmware
}

type Insert struct {

	// Input
	Predicate func(f uefi.Firmware) bool
	NewFile   *uefi.File
	InsertType

	// Matched File
	FileMatch uefi.Firmware
}

type InsertType int

type InsertWhatType int

type InsertWherePreposition int

type JSON struct {
	// JSON is written to this writer.
	W io.Writer
}

type NVRamCompact struct {
}

type NVarInvalidate struct {
	// Input
	Predicate func(f uefi.Firmware) bool

	// Output
	Matches []uefi.Firmware
	// logs are written to this writer.
	W io.Writer
}

type ParseDir struct {
	BasePath string
}

type Remove struct {
	// Input
	Predicate  func(f uefi.Firmware) bool
	Pad        bool
	RemoveDxes bool // I hate this, but there's no good way to work around our current structure

	// Output
	Matches []uefi.Firmware
	// Calling this function undoes the removals performed by this visitor.
	Undo func()
	// logs are written to this writer.
	W io.Writer
}

type Repack struct {
	// Input
	Predicate func(f uefi.Firmware) bool

	// Matched File
	FileMatch *uefi.File
}

type ReplacePE32 struct {
	// Input
	Predicate func(f uefi.Firmware) bool
	NewPE32   []byte

	// Output
	Matches []uefi.Firmware
}

type Save struct {
	DirPath string
}

type Table struct {
	W      *tabwriter.Writer
	Scan   bool
	Layout bool
	Depth  int
	// contains filtered or unexported fields
}

type TightenME struct {
	// contains filtered or unexported fields
}

type Validate struct {
	// An optional Writer for writing errors when validation is complete.
	// When the writer it set, Run will also call os.Exit(1) upon finding
	// an error.
	W io.Writer

	// List of validation errors.
	Errors []error
}