/* ****************************************************************************

*

* Copyright (c) Microsoft Corporation.

*

* This source code is subject to terms and conditions of the Apache License, Version 2.0. A

* copy of the license can be found in the License.html file at the root of this distribution. If

* you cannot locate the Apache License, Version 2.0, please send an email to

* vspython@microsoft.com. By using this source code in any fashion, you are agreeing to be bound

* by the terms of the Apache License, Version 2.0.

*

* You must not remove this notice, or any other, from this software.

*

* ***************************************************************************/

using System;

using System.Diagnostics;

namespace Microsoft.VisualStudioTools {

struct DebugTimer : IDisposable {

#if DEBUG

internal static Stopwatch _timer = MakeStopwatch();

private readonly long _start, _minReportTime;

private readonly string _description;

private static Stopwatch MakeStopwatch() {

var res = new Stopwatch();

res.Start();

return res;

}

#endif

/// <summary>

/// Creates a new DebugTimer which logs timing information from when it's created

/// to when it's disposed.

/// </summary>

/// <param name="description">The message which is logged in addition to the timing information</param>

/// <param name="minReportTime">The minimum amount of time (in milliseconds) which needs to elapse for a message to be logged</param>

public DebugTimer(string description, long minReportTime = 0) {

#if DEBUG

_start = _timer.ElapsedMilliseconds;

_description = description;

_minReportTime = minReportTime;

#endif

}

#region IDisposable Members

public void Dispose() {

#if DEBUG

var elapsed = _timer.ElapsedMilliseconds - _start;

if (elapsed >= _minReportTime) {

Debug.WriteLine(String.Format("{0}: {1}ms elapsed", _description, elapsed));

}

#endif

}

#endregion

}

}