cue/ast/ident.go

// Copyright 2019 CUE Authors
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package ast

import (
	"strconv"
	"unicode"
	"unicode/utf8"

	"cuelang.org/go/cue/errors"
	"cuelang.org/go/cue/token"
	"cuelang.org/go/pkg/strings"
)

func isLetter(ch rune) bool {
	return 'a' <= ch && ch <= 'z' || 'A' <= ch && ch <= 'Z' || ch >= utf8.RuneSelf && unicode.IsLetter(ch)
}

func isDigit(ch rune) bool {
	// TODO(mpvl): Is this correct?
	return '0' <= ch && ch <= '9' || ch >= utf8.RuneSelf && unicode.IsDigit(ch)
}

// IsValidIdent reports whether str is a valid identifier.
func IsValidIdent(ident string) bool {
	if ident == "" {
		return false
	}

	// TODO: use consumed again to allow #0.
	// consumed := false
	if strings.HasPrefix(ident, "_") {
		ident = ident[1:]
		// consumed = true
		if len(ident) == 0 {
			return true
		}
	}
	if strings.HasPrefix(ident, "#") {
		ident = ident[1:]
		// consumed = true
	}

	// if !consumed {
	if r, _ := utf8.DecodeRuneInString(ident); isDigit(r) {
		return false
	}
	// }

	for _, r := range ident {
		if isLetter(r) || isDigit(r) || r == '_' || r == '$' {
			continue
		}
		return false
	}
	return true
}

// QuoteIdent quotes an identifier, if needed, and reports
// an error if the identifier is invalid.
//
// Deprecated: quoted identifiers are deprecated. Use aliases.
func QuoteIdent(ident string) (string, error) {
	if ident != "" && ident[0] == '`' {
		if _, err := strconv.Unquote(ident); err != nil {
			return "", errors.Newf(token.NoPos, "invalid quoted identifier %q", ident)
		}
		return ident, nil
	}

	// TODO: consider quoting keywords
	// switch ident {
	// case "for", "in", "if", "let", "true", "false", "null":
	// 	goto escape
	// }

	for _, r := range ident {
		if isLetter(r) || isDigit(r) || r == '_' || r == '$' {
			continue
		}
		if r == '-' {
			return "`" + ident + "`", nil
		}
		return "", errors.Newf(token.NoPos, "invalid character '%s' in identifier", string(r))
	}

	_, err := parseIdent(token.NoPos, ident)
	return ident, err
}

// ParseIdent unquotes a possibly quoted identifier and validates
// if the result is valid.
//
// Deprecated: quoted identifiers are deprecated. Use aliases.
func ParseIdent(n *Ident) (string, error) {
	return parseIdent(n.NamePos, n.Name)
}

func parseIdent(pos token.Pos, ident string) (string, error) {
	if ident == "" {
		return "", errors.Newf(pos, "empty identifier")
	}
	quoted := false
	if ident[0] == '`' {
		u, err := strconv.Unquote(ident)
		if err != nil {
			return "", errors.Newf(pos, "invalid quoted identifier")
		}
		ident = u
		quoted = true
	}

	p := 0
	if strings.HasPrefix(ident, "_") {
		p++
		if len(ident) == 1 {
			return ident, nil
		}
	}
	if strings.HasPrefix(ident[p:], "#") {
		p++
		// if len(ident) == p {
		// 	return "", errors.Newf(pos, "invalid identifier '_#'")
		// }
	}

	if p == 0 || ident[p-1] == '#' {
		if r, _ := utf8.DecodeRuneInString(ident[p:]); isDigit(r) {
			return "", errors.Newf(pos, "invalid character '%s' in identifier", string(r))
		}
	}

	for _, r := range ident[p:] {
		if isLetter(r) || isDigit(r) || r == '_' || r == '$' {
			continue
		}
		if r == '-' && quoted {
			continue
		}
		return "", errors.Newf(pos, "invalid character '%s' in identifier", string(r))
	}

	return ident, nil
}

// LabelName reports the name of a label, whether it is an identifier
// (it binds a value to a scope), and whether it is valid.
// Keywords that are allowed in label positions are interpreted accordingly.
//
// Examples:
//
//     Label   Result
//     foo     "foo"  true   nil
//     true    "true" true   nil
//     "foo"   "foo"  false  nil
//     "x-y"   "x-y"  false  nil
//     "foo    ""     false  invalid string
//     "\(x)"  ""     false  errors.Is(err, ErrIsExpression)
//     X=foo   "foo"  true   nil
//
func LabelName(l Label) (name string, isIdent bool, err error) {
	if a, ok := l.(*Alias); ok {
		l, _ = a.Expr.(Label)
	}
	switch n := l.(type) {
	case *ListLit:
		// An expression, but not one that can evaluated.
		return "", false, errors.Newf(l.Pos(),
			"cannot reference fields with square brackets labels outside the field value")

	case *Ident:
		// TODO(legacy): use name = n.Name
		name, err = ParseIdent(n)
		if err != nil {
			return "", false, err
		}
		isIdent = true
		// TODO(legacy): remove this return once quoted identifiers are removed.
		return name, isIdent, err

	case *BasicLit:
		switch n.Kind {
		case token.STRING:
			// Use strconv to only allow double-quoted, single-line strings.
			name, err = strconv.Unquote(n.Value)
			if err != nil {
				err = errors.Newf(l.Pos(), "invalid")
			}

		case token.NULL, token.TRUE, token.FALSE:
			name = n.Value
			isIdent = true

		default:
			// TODO: allow numbers to be fields
			// This includes interpolation and template labels.
			return "", false, errors.Wrapf(ErrIsExpression, l.Pos(),
				"cannot use numbers as fields")
		}

	default:
		// This includes interpolation and template labels.
		return "", false, errors.Wrapf(ErrIsExpression, l.Pos(),
			"label is an expression")
	}
	if !IsValidIdent(name) {
		isIdent = false
	}
	return name, isIdent, err

}

// ErrIsExpression reports whether a label is an expression.
// This error is never returned directly. Use errors.Is or xerrors.Is.
var ErrIsExpression = errors.New("not a concrete label")