SwiftGit2/SwiftGit2/CheckoutStrategy.swift

//
//  CheckoutStrategy.swift
//  SwiftGit2
//
//  Created by Matt Diephouse on 4/1/15.
//  Copyright (c) 2015 GitHub, Inc. All rights reserved.
//

import Clibgit2

/// The flags defining how a checkout should be performed.
/// More detail is available in the libgit2 documentation for `git_checkout_strategy_t`.
public struct CheckoutStrategy: OptionSet {
	private let value: UInt

	// MARK: - Initialization

	/// Create an instance initialized with `nil`.
	public init(nilLiteral: ()) {
		self.value = 0
	}

	public init(rawValue value: UInt) {
		self.value = value
	}

	public init(_ strategy: git_checkout_strategy_t) {
		self.value = UInt(strategy.rawValue)
	}

	public static var allZeros: CheckoutStrategy {
		return self.init(rawValue: 0)
	}

	// MARK: - Properties

	public var rawValue: UInt {
		return value
	}

	public var gitCheckoutStrategy: git_checkout_strategy_t {
		return git_checkout_strategy_t(UInt32(self.value))
	}

	// MARK: - Values

	/// Default is a dry run, no actual updates.
	public static let None = CheckoutStrategy(GIT_CHECKOUT_NONE)

	/// Allow safe updates that cannot overwrite uncommitted data.
	public static let Safe = CheckoutStrategy(GIT_CHECKOUT_SAFE)

	/// Allow all updates to force working directory to look like index
	public static let Force = CheckoutStrategy(GIT_CHECKOUT_FORCE)

	/// Allow checkout to recreate missing files.
	public static let RecreateMissing = CheckoutStrategy(GIT_CHECKOUT_RECREATE_MISSING)

	/// Allow checkout to make safe updates even if conflicts are found.
	public static let AllowConflicts = CheckoutStrategy(GIT_CHECKOUT_ALLOW_CONFLICTS)

	/// Remove untracked files not in index (that are not ignored).
	public static let RemoveUntracked = CheckoutStrategy(GIT_CHECKOUT_REMOVE_UNTRACKED)

	/// Remove ignored files not in index.
	public static let RemoveIgnored = CheckoutStrategy(GIT_CHECKOUT_REMOVE_IGNORED)

	/// Only update existing files, don't create new ones.
	public static let UpdateOnly = CheckoutStrategy(GIT_CHECKOUT_UPDATE_ONLY)

	/// Normally checkout updates index entries as it goes; this stops that.
	/// Implies `DontWriteIndex`.
	public static let DontUpdateIndex = CheckoutStrategy(GIT_CHECKOUT_DONT_UPDATE_INDEX)

	/// Don't refresh index/config/etc before doing checkout
	public static let NoRefresh = CheckoutStrategy(GIT_CHECKOUT_NO_REFRESH)

	/// Allow checkout to skip unmerged files
	public static let SkipUnmerged = CheckoutStrategy(GIT_CHECKOUT_SKIP_UNMERGED)

	/// For unmerged files, checkout stage 2 from index
	public static let UseOurs = CheckoutStrategy(GIT_CHECKOUT_USE_OURS)

	/// For unmerged files, checkout stage 3 from index
	public static let UseTheirs = CheckoutStrategy(GIT_CHECKOUT_USE_THEIRS)

	/// Treat pathspec as simple list of exact match file paths
	public static let DisablePathspecMatch = CheckoutStrategy(GIT_CHECKOUT_DISABLE_PATHSPEC_MATCH)

	/// Ignore directories in use, they will be left empty
	public static let SkipLockedDirectories = CheckoutStrategy(GIT_CHECKOUT_SKIP_LOCKED_DIRECTORIES)

	/// Don't overwrite ignored files that exist in the checkout target
	public static let DontOverwriteIgnored = CheckoutStrategy(GIT_CHECKOUT_DONT_OVERWRITE_IGNORED)

	/// Write normal merge files for conflicts
	public static let ConflictStyleMerge = CheckoutStrategy(GIT_CHECKOUT_CONFLICT_STYLE_MERGE)

	/// Include common ancestor data in diff3 format files for conflicts
	public static let ConflictStyleDiff3 = CheckoutStrategy(GIT_CHECKOUT_CONFLICT_STYLE_DIFF3)

	/// Don't overwrite existing files or folders
	public static let DontRemoveExisting = CheckoutStrategy(GIT_CHECKOUT_DONT_REMOVE_EXISTING)

	/// Normally checkout writes the index upon completion; this prevents that.
	public static let DontWriteIndex = CheckoutStrategy(GIT_CHECKOUT_DONT_WRITE_INDEX)
}