constraint

Documentation

Overview

Package constraintはビルド制約行の解析と評価を実装しています。 ビルド制約自体のドキュメントについては、https://golang.org/cmd/go/#hdr-Build_constraintsを参照してください。

このパッケージは、オリジナルの「// +build」構文と、Go 1.17で追加された「//go:build」構文の両方を解析します。 「//go:build」構文の詳細については、https://golang.org/design/draft-gobuildを参照してください。

Index

• func GoVersion(x Expr) string
• func IsGoBuild(line string) bool
• func IsPlusBuild(line string) bool
• func PlusBuildLines(x Expr) ([]string, error)
• type AndExpr
  • func (x *AndExpr) Eval(ok func(tag string) bool) bool
  • func (x *AndExpr) String() string
• type Expr
  • func Parse(line string) (Expr, error)
• type NotExpr
  • func (x *NotExpr) Eval(ok func(tag string) bool) bool
  • func (x *NotExpr) String() string
• type OrExpr
  • func (x *OrExpr) Eval(ok func(tag string) bool) bool
  • func (x *OrExpr) String() string
• type SyntaxError
  • func (e *SyntaxError) Error() string
• type TagExpr
  • func (x *TagExpr) Eval(ok func(tag string) bool) bool
  • func (x *TagExpr) String() string

Functions

func GoVersion

func GoVersion(x Expr) string

GoVersionは与えられたビルド条件によって暗黙的に指定される最小のGoバージョンを返します。 条件式にGoバージョンタグがない場合、GoVersionは空の文字列を返します。

例:

GoVersion(linux && go1.22) = "go1.22"
GoVersion((linux && go1.22) || (windows && go1.20)) = "go1.20" => go1.20
GoVersion(linux) = ""
GoVersion(linux || (windows && go1.22)) = ""
GoVersion(!go1.22) = ""

GoVersionは、任意のタグまたは否定されたタグが独立してtrueである可能性があると仮定しています。 そのため、解析はSATソルバーなしで純粋に構造的に行われます。 「不可能」とされる部分式は結果に影響する可能性があるためです。

例:

GoVersion((linux && !linux && go1.20) || go1.21) = "go1.20"

func IsGoBuild

func IsGoBuild(line string) bool

IsGoBuildは、テキストの行が「//go:build」の制約であるかどうかを報告します。 これは、テキストのプレフィックスのみをチェックし、式自体の解析は行いません。

func IsPlusBuild

func IsPlusBuild(line string) bool

IsPlusBuildはテキストの行が "// +build" 制約であるかどうかを報告します。 これはテキストの接頭辞のみをチェックし、式そのものの解析は行いません。

func PlusBuildLines

func PlusBuildLines(x Expr) ([]string, error)

PlusBuildLinesはビルド式xに評価される「// +build」の行のシーケンスを返します。 式が直接「// +build」の行に変換できるほど複雑でない場合、PlusBuildLinesはエラーを返します。

Types

type AndExpr

type AndExpr struct {
	X, Y Expr
}

AndExprは式X && Yを表します。

func (*AndExpr) Eval

func (x *AndExpr) Eval(ok func(tag string) bool) bool

func (*AndExpr) String

func (x *AndExpr) String() string

type Expr

type Expr interface {
	String() string

	Eval(ok func(tag string) bool) bool
	// contains filtered or unexported methods
}

Exprはビルドタグの制約式です。 内部の具体的な型は*AndExpr、*OrExpr、*NotExpr、または*TagExpr です。

func Parse

func Parse(line string) (Expr, error)

Parseは、形式「//go:build ...」または「// +build ...」の単一のビルド制約行を解析し、対応するブール式を返します。

type NotExpr

type NotExpr struct {
	X Expr
}

NotExprは式!X（Xの否定）を表します。

func (*NotExpr) Eval

func (x *NotExpr) Eval(ok func(tag string) bool) bool

func (*NotExpr) String

func (x *NotExpr) String() string

type OrExpr

type OrExpr struct {
	X, Y Expr
}

OrExprはX || Yを表します。

func (*OrExpr) Eval

func (x *OrExpr) Eval(ok func(tag string) bool) bool

func (*OrExpr) String

func (x *OrExpr) String() string

type SyntaxError

type SyntaxError struct {
	Offset int
	Err    string
}

SyntaxErrorは解析されたビルド式の構文エラーを報告します。

func (*SyntaxError) Error

func (e *SyntaxError) Error() string

type TagExpr

type TagExpr struct {
	Tag string
}

TagExprは、単一のタグTagのための Expr です。

func (*TagExpr) Eval

func (x *TagExpr) Eval(ok func(tag string) bool) bool

func (*TagExpr) String

func (x *TagExpr) String() string