mk/ruleset.go

// Mkfiles are parsed into ruleSets, which as the name suggests, are sets of
// rules with accompanying recipes, as well as assigned variables which are
// expanding when evaluating rules and recipes.

package main

import (
	"fmt"
	"strings"
	"unicode/utf8"
)

type attribSet struct {
	delFailed       bool // delete targets when the recipe fails
	nonstop         bool // don't stop if the recipe fails
	forcedTimestamp bool // update timestamp whether the recipe does or not
	nonvirtual      bool // a meta-rule that will only match files
	quiet           bool // don't print the recipe
	regex           bool // regular expression meta-rule
	update          bool // treat the targets as if they were updated
	virtual         bool // rule is virtual (does not match files)
}

// Error parsing an attribute
type attribError struct {
	found rune
}

type rule struct {
	targets    []string  // non-empty array of targets
	attributes attribSet // rule attributes
	prereqs    []string  // possibly empty prerequesites
	shell      []string  // command used to execute the recipe
	recipe     string    // recipe source
	command    []string  // command attribute
}

// Read attributes for an array of strings, updating the rule.
func (r *rule) parseAttribs(inputs []string) *attribError {
	for i := 0; i < len(inputs); i++ {
		input := inputs[i]
		pos := 0
		for pos < len(input) {
			c, w := utf8.DecodeRuneInString(input[pos:])
			switch c {
			case 'D':
				r.attributes.delFailed = true
			case 'E':
				r.attributes.nonstop = true
			case 'N':
				r.attributes.forcedTimestamp = true
			case 'n':
				r.attributes.nonvirtual = true
			case 'Q':
				r.attributes.quiet = true
			case 'R':
				r.attributes.regex = true
			case 'U':
				r.attributes.update = true
			case 'V':
				r.attributes.virtual = true
			case 'P':
				if pos+w < len(input) {
					r.command = append(r.command, input[pos+w:])
				}
				r.command = append(r.command, inputs[i+1:]...)
				return nil

			case 'S':
				if pos+w < len(input) {
					r.shell = append(r.shell, input[pos+w:])
				}
				r.shell = append(r.shell, inputs[i+1:]...)
				return nil

			default:
				return &attribError{c}
			}

			pos += w
		}
	}

	return nil
}

type ruleSet struct {
	vars  map[string][]string
	rules []rule
}

// Add a rule to the rule set.
func (rs *ruleSet) push(r rule) {
	rs.rules = append(rs.rules, r)
}

// Expand a word. This includes substituting variables and handling quotes.
func (rs *ruleSet) expand(input string, expandBackticks bool) string {
	expanded := make([]byte, 0)
	var i, j int
	for i = 0; i < len(input); {
		j = i + strings.IndexAny(input[i:], "\"'`$\\")

		if j < 0 {
			expanded = append(expanded, []byte(input[i:])...)
			break
		}

		expanded = append(expanded, []byte(input[i:j])...)
		c, w := utf8.DecodeRuneInString(input[j:])
		i = j + w

		var off int
		var out string
		switch c {
		case '\\':
			out, off = rs.expandEscape(input[i:])

		case '"':
			out, off = rs.expandDoubleQuoted(input[i:], expandBackticks)

		case '\'':
			out, off = rs.expandSingleQuoted(input[i:])

		case '`':
            if expandBackticks {
                out, off = rs.expandBackQuoted(input[i:])
            } else {
                out = input
                off = len(input)
            }

		case '$':
            out, off = rs.expandSigil(input[i:])
		}

		expanded = append(expanded, []byte(out)...)
		i += off
	}

	return string(expanded)
}

// Expand following a '\\'
func (rs *ruleSet) expandEscape(input string) (string, int) {
	c, w := utf8.DecodeRuneInString(input)
	return string(c), w
}

// Expand a double quoted string starting after a '\"'
func (rs *ruleSet) expandDoubleQuoted(input string, expandBackticks bool) (string, int) {
	// find the first non-escaped "
	j := 0
	for {
		j = strings.IndexAny(input[j:], "\"\\")
		if j < 0 {
			break
		}

		_, w := utf8.DecodeRuneInString(input[j:])
		j += w

		c, w := utf8.DecodeRuneInString(input[j:])
		j += w

		if c == '"' {
			return rs.expand(input[:j], expandBackticks), (j + w)
		}

		if c == '\\' {
			if j+w < len(input) {
				j += w
				_, w := utf8.DecodeRuneInString(input[j:])
				j += w
			} else {
				break
			}
		}
	}

	return input, len(input)
}

// Expand a single quoted string starting after a '\''
func (rs *ruleSet) expandSingleQuoted(input string) (string, int) {
	j := strings.Index(input, "'")
	if j < 0 {
		return input, len(input)
	}
	return input[:j], (j + 1)
}

// Expand something starting with at '$'.
func (rs *ruleSet) expandSigil(input string) (string, int) {
    c, w := utf8.DecodeRuneInString(input)
    var offset int
    var varname string
    if c == '{' {
        j := strings.Index(input[w:], "}")
        if j < 0 {
            return input, len(input)
        }

        varname = input[w:j]
        offset = j + 1
    } else {
        // try to match a variable name
        i := w
        j := i
        for j < len(input) {
            c, w = utf8.DecodeRuneInString(input)
            if !(isalpha(c) || c == '_' || (j > i && isdigit(c))) {
                break
            }
            j += w
        }

        if j > i {
            varname = input[i:j]
        } else {
            return input, len(input)
        }
    }

    if isValidVarName(varname) {
        varvals, ok := rs.vars[varname]
        if ok {
            return strings.Join(varvals, " "), offset
        }
    }

    return input, len(input)
}

// Expand a backtick quoted string, by executing the contents.
func (rs *ruleSet) expandBackQuoted(input string) (string, int) {
	j := strings.Index(input, "`")
	if j < 0 {
		return input, len(input)
	}

	output := executeRecipe("sh", nil, input[:j], false, false, true)
	return output, (j + 1)
}

func isValidVarName(v string) bool {
	for i := 0; i < len(v); {
		c, w := utf8.DecodeRuneInString(v[i:])
		if i == 0 && !(isalpha(c) || c == '_') {
			return false
		} else if !(isalnum(c) || c == '_') {
			return false
		}
		i += w
	}
	return true
}

func isdigit(c rune) bool {
    return '0' <= c && c <= '9'
}


func isalpha(c rune) bool {
	return ('a' <= c && c <= 'z') || ('A' <= c && c <= 'Z')
}

func isalnum(c rune) bool {
    return isalpha(c) || isdigit(c)
}

type assignmentError struct {
	what  string
	where token
}

// Parse and execute assignment operation.
func (rs *ruleSet) executeAssignment(ts []token) *assignmentError {
	assignee := ts[0].val
	if !isValidVarName(assignee) {
		return &assignmentError{
			fmt.Sprintf("target of assignment is not a valid variable name: \"%s\"", assignee),
			ts[0]}
	}

	// expanded variables
	vals := make([]string, len(ts)-1)
	for i := 0; i < len(vals); i++ {
		vals[i] = rs.expand(ts[i+1].val, true)
	}

	rs.vars[assignee] = vals
	return nil
}