build

type Architecture uint

type Generator interface {
	//Validate performs additional validations on the package that are specific
	//to the concrete generator. For example, if the package format imposes
	//restrictions on the format of certain fields (names, versions, etc.), they
	//should be checked here.
	//
	//If the package is valid, an empty slice is to be returned.
	Validate() []error
	//Build produces the final package (usually a compressed tar file) in the
	//return argument. The package must be built reproducibly; such that every
	//run (even across systems) produces an identical result. For example, no
	//timestamps or generator version information may be included.
	//
	//Build should call pkg.PrepareBuild() to execute some common preparation steps.
	Build() ([]byte, error)
	//Generate the recommended file name for this package. Distributions usually
	//have guidelines for this sort of thing. The string returned must be a plain
	//file name without any slashes.
	RecommendedFileName() string
}

type GeneratorFactory func(*Package) Generator

type Package struct {
	//Name is the package name.
	Name string
	//Version is the version for the package contents. This field shall contain
	//only numbered versions separated by dots (e.g. "1.0" or "0.9.184.5" or
	//"2020.10.05"). Other version strings cannot be guaranteed to generate valid
	//outputs for all package formats. To specify an alpha or beta version, set
	//the PrereleaseType and PrereleaseVersion fields. For instance,
	//"1.2.0-beta.1" shall be encoded as (.Version = "1.2.0",
	//.PrereleaseType = PrereleaseTypeBeta, .PrereleaseVersion = 1).
	Version string
	//PrereleaseType specifies whether this package is an alpha, beta or a final
	//release.
	PrereleaseType PrereleaseType
	//PrereleaseVersion is a counter of prereleases of a given type.
	//(.PrereleaseType = PrereleaseTypeAlpha, .PrereleaseVersion = 5) will append
	//"alpha.5" to the package's version (with a separator appropriate for a
	//given package format). The value in this field is ignored when
	//.PrereleaseType is PrereleaseTypeNone.
	PrereleaseVersion uint
	//Release is a counter that can be increased when the same version of one
	//package needs to be rebuilt. The default value shall be 1.
	Release uint
	//Epoch is a counter that can be increased when the version of a newer
	//package is smaller than the previous version, thus breaking normal
	//version comparison logic. This is usually only necessary when changing to
	//a different version numbering scheme. The default value is 0, which
	//usually results in the epoch not being shown in the combined version
	//string at all.
	Epoch uint
	//Description is the optional package description.
	Description string
	//Author contains the package's author's name and mail address in the form
	//"Firstname Lastname <email.address@server.tld>", if this information is
	//available.
	Author string
	//Architecture specifies the target architecture of this package.
	Architecture Architecture
	//ArchitectureInput contains the raw architecture string specified by the
	//user (used only for error messages).
	ArchitectureInput string
	//Requires contains a list of other packages that are required dependencies
	//for this package and thus must be installed together with this package.
	//This is called "Depends" by some package managers.
	Requires []PackageRelation
	//Provides contains a list of packages that this package provides features
	//of (or virtual packages whose capabilities it implements).
	Provides []PackageRelation
	//Conflicts contains a list of other packages that cannot be installed at
	//the same time as this package.
	Conflicts []PackageRelation
	//Replaces contains a list of obsolete packages that are replaced by this
	//package. Upon performing a system upgrade, the obsolete packages will be
	//automatically replaced by this package.
	Replaces []PackageRelation
	//Actions contains a list of actions that can be executed while the package
	//manager runs.
	Actions []PackageAction
	//FSRoot represents the root directory of the package's file system, and
	//contains all other files and directories recursively.
	FSRoot *filesystem.Directory
}

type PackageAction struct {
	//Type determines when this action will be run. Acceptable values include
	//`SetupAction` and `CleanupAction`.
	Type uint
	//Content is a shell script that will be executed when the action is run.
	Content string
}

type PackageRelation struct {
	RelatedPackage string
	Constraints    []VersionConstraint
}

type PrereleaseType uint

type RegexSet struct {
	PackageName    string
	PackageVersion string
	RelatedName    string
	RelatedVersion string
	FormatName     string //used for error messages only
}

type VersionConstraint struct {
	//Relation is one of "<", "<=", "=", ">=" or ">".
	Relation string
	//Version is the version on the right side of the Relation, e.g. "1.2.3-1"
	//or "2:20151024-1.1".  This field is not structured further in this level
	//since the acceptable version format may depend on the package generator
	//used.
	Version string
}