id

Documentation

Overview

Package id List is responsible for id List managing

Package id List is responsible for id List managing

Package id List is responsible for id List managing

Index

• Variables
• func SubCmdIdClean(w io.Writer, fSys *afero.Afero) error
• func SubCmdIdInsert(w io.Writer, fSys *afero.Afero) error
• func SubCmdIdZero(w io.Writer, fSys *afero.Afero) error
• func SubCmdReNewList(w io.Writer, fSys *afero.Afero) (err error)
• func SubCmdRefreshList(w io.Writer, fSys *afero.Afero) (err error)
• func SubCmdUpdate(w io.Writer, fSys *afero.Afero) error
• type TriceFmt
• type TriceID
  • func (id *TriceID) Set(value string) error
  • func (id *TriceID) String() string
• type TriceIDLookUp
  • func NewLut(w io.Writer, fSys *afero.Afero, fn string) TriceIDLookUp
  • func (ilu TriceIDLookUp) AddFmtCount(w io.Writer)
  • func (lu TriceIDLookUp) FileWatcher(w io.Writer, fSys *afero.Afero, m *sync.RWMutex)
  • func (ilu TriceIDLookUp) FromJSON(b []byte) (err error)
• type TriceIDLookUpLI
  • func NewLutLI(w io.Writer, fSys *afero.Afero, fn string) TriceIDLookUpLI
  • func (li TriceIDLookUpLI) FileWatcher(w io.Writer, fSys *afero.Afero)
  • func (li TriceIDLookUpLI) FromJSON(b []byte) (err error)
• type TriceIDs
• type TriceLI

Variables

var (
	ExtendMacrosWithParamCount bool

	// DefaultTriceBitWidth tells the bit width of TRICE macros having no bit width in their names, like TRICE32 or TRICE8.
	//
	// One target can use only one bith width for bare TRICE macros and the setting inside the target code must match DefaultTriceBitWidth.
	DefaultTriceBitWidth = "32" // todo: create compiler switch for other options "8", "16", "32", "64"
	DefaultStampSize     = 32
	StampSizeId          string
)

var (
	// Verbose gives more information on output if set. The value is injected from main packages.
	Verbose bool

	// DryRun if set, inhibits real changes
	DryRun bool

	// FnJSON is the filename for the JSON formatted ID list.
	FnJSON = "til.json"

	// LIFnJSON is the filename for the JSON formatted location information list.
	LIFnJSON string

	// Min is the smallest allowed ID for normal trices.
	Min = TriceID(1000)

	// Max is the biggest allowed ID for normal trices.
	Max = TriceID(7999)

	// SearchMethod is the next ID search method.
	SearchMethod = "random"

	// LiPathIsRelative causes to store relative paths instead of base names only inside li.json.
	LiPathIsRelative bool
)

var Logging bool // Logging is true, when sub command log is active.

var (
	// Srcs gets multiple files or directories.
	Srcs arrayFlag
)

Functions

func SubCmdIdClean

func SubCmdIdClean(w io.Writer, fSys *afero.Afero) error

SubCmdIdClean performs sub-command clean, zeroing or removing trice IDs from source tree.

func SubCmdIdInsert

func SubCmdIdInsert(w io.Writer, fSys *afero.Afero) error

SubCmdIdInsert performs sub-command insert, adding trice IDs to source tree.

func SubCmdIdZero

func SubCmdIdZero(w io.Writer, fSys *afero.Afero) error

SubCmdIdZero performs sub-command zero, setting trice IDs in source tree to 0.

func SubCmdReNewList

func SubCmdReNewList(w io.Writer, fSys *afero.Afero) (err error)

SubCmdReNewList renews the trice id list parsing the source tree without changing any source file. It creates a new FnJSON and tries to add id:tf pairs from the source tree. If equal tf are found with different ids they are all added. If the same id is found with different tf only one is added. The others are reported as warning. If any TRICE* is found without Id(n) or with Id(0), it is ignored. SubCmdUpdate needs to know which IDs are used in the source tree, to reliably add new IDs.

func SubCmdRefreshList

func SubCmdRefreshList(w io.Writer, fSys *afero.Afero) (err error)

SubCmdRefreshList refreshes the trice id list parsing the source tree without changing any source file. It only reads FnJSON and tries to add id:tf pairs from the source tree. If equal tf are found with different ids they are all added. If the same id is found with different tf only one is added. The others are reported as warning. If any TRICE* is found without Id(n) or with Id(0), it is ignored. SubCmdUpdate needs to know which IDs are used in the source tree, to reliably add new IDs.

func SubCmdUpdate

func SubCmdUpdate(w io.Writer, fSys *afero.Afero) error

SubCmdUpdate is sub-command update

Types

type TriceFmt

type TriceFmt struct {
	Type string `json:"Type"` // format type (bit-size and number of fmt string parameters)
	Strg string `json:"Strg"` // format string
}

TriceFmt is the trice format information assigned to a trice ID.

type TriceID

type TriceID int

TriceID is the trice ID referencing to Fmt.

func (*TriceID) Set

func (id *TriceID) Set(value string) error

Set implements part of flag.Value interface. It initializes id from the partial command line string

func (*TriceID) String

func (id *TriceID) String() string

String implements part of flag.Value interface. It returns id as string.

type TriceIDLookUp

type TriceIDLookUp map[TriceID]TriceFmt

TriceIDLookUp is the ID-to-TriceFmt info translation map. Different IDs can refer to equal TriceFmt's. It is used during logging. Example: 1:A, 5:C, 7:C An ID can point to one and only format string.

func NewLut

func NewLut(w io.Writer, fSys *afero.Afero, fn string) TriceIDLookUp

NewLut returns a look-up map generated from JSON map file named fn.

func (TriceIDLookUp) AddFmtCount

func (ilu TriceIDLookUp) AddFmtCount(w io.Writer)

AddFmtCount adds inside ilu to all trice type names without format specifier count the appropriate count. example change: `map[10000:{Trice8_2 hi %03u, %5x} 10001:{TRICE16 hi %03u, %5x}] `map[10000:{Trice8_2 hi %03u, %5x} 10001:{TRICE16_2 hi %03u, %5x}]

func (TriceIDLookUp) FileWatcher

func (lu TriceIDLookUp) FileWatcher(w io.Writer, fSys *afero.Afero, m *sync.RWMutex)

FileWatcher checks the id list file for changes. taken from https://medium.com/@skdomino/watch-this-file-watching-in-go-5b5a247cf71f

func (TriceIDLookUp) FromJSON

func (ilu TriceIDLookUp) FromJSON(b []byte) (err error)

FromJSON converts JSON byte slice to ilu.

type TriceIDLookUpLI

type TriceIDLookUpLI map[TriceID]TriceLI

func NewLutLI

func NewLutLI(w io.Writer, fSys *afero.Afero, fn string) TriceIDLookUpLI

NewLutLI returns a look-up map generated from JSON map file named fn.

func (TriceIDLookUpLI) FileWatcher

func (li TriceIDLookUpLI) FileWatcher(w io.Writer, fSys *afero.Afero)

FileWatcher checks the id location information file for changes. taken from https://medium.com/@skdomino/watch-this-file-watching-in-go-5b5a247cf71f

func (TriceIDLookUpLI) FromJSON

func (li TriceIDLookUpLI) FromJSON(b []byte) (err error)

FromJSON converts JSON byte slice to li.

type TriceIDs

type TriceIDs []TriceID

TriceIDs is a slice of trice IDs.

type TriceLI

type TriceLI struct {
	File string `json:"File"` // source file name of trice id
	Line int    `json:"Line"` // source file line of trice id
}

TriceLI is the trice location information assigned to a trice ID.