/**
 * Identifies a particular subset of progress events from Git by
 * title.
 */
export interface IProgressStep {
    /**
     * The title of the git progress event. By title we refer to the
     * exact value of the title field in the Git progress struct:
     *
     * https://github.com/git/git/blob/6a2c2f8d34fa1e8f3bb85d159d354810ed63692e/progress.c#L31-L39
     *
     * In essence this means anything up to (but not including) the last colon (:)
     * in a single progress line. Take this example progress line
     *
     *    remote: Compressing objects:  14% (159/1133)
     *
     * In this case the title would be 'remote: Compressing objects'.
     */
    readonly title: string;
    /**
     * The weight of this step in relation to others for a particular
     * Git operation. This value can be any number as long as it's
     * proportional to others in the same parser, it will all be scaled
     * to a decimal value between 0 and 1 before being used to calculate
     * overall progress.
     */
    readonly weight: number;
}
/**
 * The overall progress of one or more steps in a Git operation.
 */
export interface IGitProgress {
    readonly kind: 'progress';
    /**
     * The overall percent of the operation
     */
    readonly percent: number;
    /**
     * The underlying progress line that this progress instance was
     * constructed from. Note that the percent value in details
     * doesn't correspond to that of percent in this instance for
     * two reasons. Fist, we calculate percent by dividing value with total
     * to produce a high precision decimal value between 0 and 1 while
     * details.percent is a rounded integer between 0 and 100.
     *
     * Second, the percent in this instance is scaled in relation to any
     * other steps included in the progress parser.
     */
    readonly details: IGitProgressInfo;
}
export interface IGitOutput {
    readonly kind: 'context';
    readonly percent: number;
    readonly text: string;
}
/**
 * A well-structured representation of a Git progress line.
 */
export interface IGitProgressInfo {
    /**
     * The title of the git progress event. By title we refer to the
     * exact value of the title field in Git's progress struct:
     *
     * https://github.com/git/git/blob/6a2c2f8d34fa1e8f3bb85d159d354810ed63692e/progress.c#L31-L39
     *
     * In essence this means anything up to (but not including) the last colon (:)
     * in a single progress line. Take this example progress line
     *
     *    remote: Compressing objects:  14% (159/1133)
     *
     * In this case the title would be 'remote: Compressing objects'.
     */
    readonly title: string;
    /**
     * The progress value as parsed from the Git progress line.
     *
     * We define value to mean the same as it does in the Git progress struct, i.e
     * it's the number of processed units.
     *
     * In the progress line 'remote: Compressing objects:  14% (159/1133)' the
     * value is 159.
     *
     * In the progress line 'remote: Counting objects: 123' the value is 123.
     *
     */
    readonly value: number;
    /**
     * The progress total as parsed from the git progress line.
     *
     * We define total to mean the same as it does in the Git progress struct, i.e
     * it's the total number of units in a given process.
     *
     * In the progress line 'remote: Compressing objects:  14% (159/1133)' the
     * total is 1133.
     *
     * In the progress line 'remote: Counting objects: 123' the total is undefined.
     *
     */
    readonly total?: number;
    /**
     * The progress percent as parsed from the git progress line represented as
     * an integer between 0 and 100.
     *
     * We define percent to mean the same as it does in the Git progress struct, i.e
     * it's the value divided by total.
     *
     * In the progress line 'remote: Compressing objects:  14% (159/1133)' the
     * percent is 14.
     *
     * In the progress line 'remote: Counting objects: 123' the percent is undefined.
     *
     */
    readonly percent?: number;
    /**
     * Whether or not the parsed git progress line indicates that the operation
     * is done.
     *
     * This is denoted by a trailing ", done" string in the progress line.
     * Example: Checking out files:  100% (728/728), done
     */
    readonly done: boolean;
    /**
     * The untouched raw text line that this instance was parsed from. Useful
     * for presenting the actual output from Git to the user.
     */
    readonly text: string;
}
/**
 * A utility class for interpreting progress output from `git`
 * and turning that into a percentage value estimating the overall progress
 * of the an operation. An operation could be something like `git fetch`
 * which contains multiple steps, each individually reported by Git as
 * progress events between 0 and 100%.
 *
 * A parser cannot be reused, it's mean to parse a single stderr stream
 * for Git.
 */
export declare class GitProgressParser {
    private readonly steps;
    private stepIndex;
    private lastPercent;
    /**
     * Initialize a new instance of a Git progress parser.
     *
     * @param steps - A series of steps that could be present in the git
     *                output with relative weight between these steps. Note
     *                that order is significant here as once the parser sees
     *                a progress line that matches a step all previous steps
     *                are considered completed and overall progress is adjusted
     *                accordingly.
     */
    constructor(steps: ReadonlyArray<IProgressStep>);
    /**
     * Parse the given line of output from Git, returns either an IGitProgress
     * instance if the line could successfully be parsed as a Git progress
     * event whose title was registered with this parser or an IGitOutput
     * instance if the line couldn't be parsed or if the title wasn't
     * registered with the parser.
     */
    parse(line: string): IGitProgress | IGitOutput;
}
/**
 * Attempts to parse a single line of progress output from Git.
 *
 * For details about how Git formats progress see
 *
 *   https://github.com/git/git/blob/6a2c2f8d34fa1e8f3bb85d159d354810ed63692e/progress.c
 *
 * Some examples:
 *  remote: Counting objects: 123
 *  remote: Counting objects: 167587, done.
 *  Receiving objects:  99% (166741/167587), 272.10 MiB | 2.39 MiB/s
 *  Checking out files:  100% (728/728)
 *  Checking out files:  100% (728/728), done
 *
 * @returns An object containing well-structured information about the progress
 *          or null if the line could not be parsed as a Git progress line.
 */
export declare function parse(line: string): IGitProgressInfo | null;