uconf

uconf

Simple linux-style configuration parser. The state of this project is very alpha. Dont expect any stability until version v1

Format / Syntax

// comment
instruction;
/*
	comment
*/
insstruction arg1;
insstruction "arg 1";
insstruction arg1 {
	insstruction arg1;
	insstruction arg2;
}

This will be be parsed into a tree representation like this:

- insstruction
- insstruction arg1
- insstruction "arg 1"
- insstruction arg1
  - insstruction arg1
  - insstruction arg2

Usage example

package main

import (
	"fmt"

	"gitlab.com/uranoxyd/uconf"
)

func main() {
	config := `
		foo 23;

		bar {
			foo 42;
		}
		
		foo 42;
	`

	if scope, err := uconf.Parse(config); err == nil {
		fmt.Println(scope.GetInstructions("foo"))
		fmt.Println(scope.GetInstructions("foo")[1].Argument(0).AsInt())
	} else {
		fmt.Println("error:", err)
	}
}

This will print:

[foo 23; foo 42;]
42

Intended way of use

This is the way uconf should be used. You parse the configuration and load the result into your objects. Have a look at this example:

package main

import (
	"fmt"

	"gitlab.com/uranoxyd/uconf"
)

type MyUser struct {
	Username string
	Name     string
}

func (u *MyUser) String() string {
	return fmt.Sprintf("<%s (%s)>", u.Username, u.Name)
}

func (u *MyUser) loadConfig(scope *uconf.Scope) error {
	for _, instruction := range scope.Values() {
		switch instruction.Name() {
		case "username":
			if instruction.Argument(0).Empty() {
				return fmt.Errorf("missing argument: username")
			}
			u.Username = instruction.Argument(0).String()

		case "name":
			if instruction.Argument(0).Empty() {
				return fmt.Errorf("missing argument: name")
			}
			u.Name = instruction.Argument(0).String()
		}
	}

	return nil
}

type MyConfig struct {
	Users []*MyUser
}

func (c *MyConfig) loadConfig(scope *uconf.Scope) error {
	for _, instruction := range scope.Values() {
		switch instruction.Name() {
		case "user":
			user := &MyUser{}
			if err := user.loadConfig(instruction.SubScope()); err != nil {
				return err
			}

			c.Users = append(c.Users, user)
		}
	}
	return nil
}

func main() {
	config := `
		user {
			username alice;
			name "Alice In Wonderland";
		}
		user {
			username bob;
			name "Bob The Builder";
		}
	`

	if scope, err := uconf.Parse(config); err == nil {
		myConf := MyConfig{}
		myConf.loadConfig(scope)

		fmt.Printf("%+v\n", myConf)
	} else {
		panic(err)
	}
}

Prints:

{Users:[<alice (Alice In Wonderland)> <bob (Bob The Builder)>]}

Licencse

GNU