lib

Documentation

Index

• Variables
• func AddHook(env *zygo.Zlisp, name string, args []zygo.Sexp) (zygo.Sexp, error)
• func HookExists(key string) bool
• func LoadFile(env *zygo.Zlisp, path string) error
• func PrepareColumns(c *cfg.Config, data *Tabdata) error
• func ProcessFiles(c *cfg.Config, args []string) error
• func RegisterLib(env *zygo.Zlisp)
• func RunFilterHooks(c cfg.Config, line string) (bool, error)
• func SetupLisp(c *cfg.Config) error
• func Splice2SexpList(list []string) zygo.Sexp
• func String2Int(env *zygo.Zlisp, name string, args []zygo.Sexp) (zygo.Sexp, error)
• func StringReSplit(env *zygo.Zlisp, name string, args []zygo.Sexp) (zygo.Sexp, error)
• type Tabdata
  • func Parse(c cfg.Config, input io.Reader) (Tabdata, error)
  • func RunProcessHooks(c cfg.Config, data Tabdata) (Tabdata, bool, error)

Variables

var Hooks map[string][]*zygo.SexpSymbol

needs to be global because we can't feed an cfg object to AddHook() which is being called from user lisp code

Functions

func AddHook

func AddHook(env *zygo.Zlisp, name string, args []zygo.Sexp) (zygo.Sexp, error)

AddHook() (called addhook from lisp code) can be used by the user to add a function to one of the available hooks provided by tablizer.

func HookExists

func HookExists(key string) bool

Check if a hook exists

func LoadFile

func LoadFile(env *zygo.Zlisp, path string) error

* Basic sanity checks and load lisp file

func PrepareColumns

func PrepareColumns(c *cfg.Config, data *Tabdata) error

parse columns list given with -c, modifies config.UseColumns based on eventually given regex

func ProcessFiles

func ProcessFiles(c *cfg.Config, args []string) error

func RegisterLib

func RegisterLib(env *zygo.Zlisp)

func RunFilterHooks

func RunFilterHooks(c cfg.Config, line string) (bool, error)

Execute every user lisp function registered as filter hook.

Each function is given the current line as argument and is expected to return a boolean. True indicates to keep the line, false to skip it.

If there are multiple such functions registered, then the first one returning false wins, that is if each function returns true the line will be kept, if at least one of them returns false, it will be skipped.

func SetupLisp

func SetupLisp(c *cfg.Config) error

* Setup lisp interpreter environment

func Splice2SexpList

func Splice2SexpList(list []string) zygo.Sexp

func String2Int

func String2Int(env *zygo.Zlisp, name string, args []zygo.Sexp) (zygo.Sexp, error)

func StringReSplit

func StringReSplit(env *zygo.Zlisp, name string, args []zygo.Sexp) (zygo.Sexp, error)

Types

type Tabdata

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

contains a whole parsed table

func Parse

func Parse(c cfg.Config, input io.Reader) (Tabdata, error)

Parser switch

func RunProcessHooks

func RunProcessHooks(c cfg.Config, data Tabdata) (Tabdata, bool, error)

These hooks get the data (Tabdata) readily processed by tablizer as argument. They are expected to return a SexpPair containing a boolean denoting if the data has been modified and the actual modified data. Columns must be the same, rows may differ. Cells may also have been modified.

Replaces the internal data structure Tabdata with the user supplied version.

Only one process hook function is supported.

The somewhat complicated code is being caused by the fact, that we need to convert our internal structure to a lisp variable and vice versa afterwards.