Code:
/ FX-1434 / FX-1434 / 1.0 / untmp / whidbey / REDBITS / ndp / fx / src / Misc / DbgUtil.cs / 1 / DbgUtil.cs
//------------------------------------------------------------------------------ //// Copyright (c) Microsoft Corporation. All rights reserved. // //----------------------------------------------------------------------------- // SECREVIEW: This is a debug-only library that won't ship with retail builds. // [assembly: System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Performance", "CA1801:AvoidUnusedParameters", Scope="member", Target="System.Windows.Forms.Internal.DbgUtil.AssertFinalization(System.Object,System.Boolean):System.Void")] [assembly: System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Security", "CA2106:SecureAsserts", Scope="member", Target="System.Windows.Forms.Internal.DbgUtil.AssertFinalization(System.Object,System.Boolean):System.Void")] [assembly: System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Security", "CA2106:SecureAsserts", Scope="member", Target="System.Windows.Forms.Internal.DbgUtil.FormatMessage(System.Int32,System.Runtime.InteropServices.HandleRef,System.Int32,System.Int32,System.Text.StringBuilder,System.Int32,System.Runtime.InteropServices.HandleRef):System.Int32")] [assembly: System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Design", "CA902:MovePInvokesToNativeMethodsClass", Scope="member", Target="System.Windows.Forms.Internal.DbgUtil.FormatMessage(System.Int32,System.Runtime.InteropServices.HandleRef,System.Int32,System.Int32,System.Text.StringBuilder,System.Int32,System.Runtime.InteropServices.HandleRef):System.Int32")] [assembly: System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Security", "CA2101:SpecifyMarshalingForPInvokeStringArguments", Scope="member", Target="System.Windows.Forms.Internal.DbgUtil.FormatMessage(System.Int32,System.Runtime.InteropServices.HandleRef,System.Int32,System.Int32,System.Text.StringBuilder,System.Int32,System.Runtime.InteropServices.HandleRef):System.Int32")] [assembly: System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Security", "CA2106:SecureAsserts", Scope="member", Target="System.Windows.Forms.Internal.DbgUtil.GetLastErrorStr():System.String")] [assembly: System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Design", "CA1031:DoNotCatchGeneralExceptionTypes", Scope="member", Target="System.Windows.Forms.Internal.DbgUtil.GetLastErrorStr():System.String")] [assembly: System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Security", "CA2106:SecureAsserts", Scope="member", Target="System.Windows.Forms.Internal.DbgUtil.GetUserDefaultLCID():System.Int32")] [assembly: System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Design", "CA902:MovePInvokesToNativeMethodsClass", Scope="member", Target="System.Windows.Forms.Internal.DbgUtil.GetUserDefaultLCID():System.Int32")] [assembly: System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Usage", "CA2205:UseManagedEquivalentsOfWin32Api", Scope="member", Target="System.Windows.Forms.Internal.DbgUtil.GetUserDefaultLCID():System.Int32")] [assembly: System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Security", "CA2106:SecureAsserts", Scope="member", Target="System.Windows.Forms.Internal.DbgUtil.IsCriticalException(System.Exception):System.Boolean")] [assembly: System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Design", "CA1031:DoNotCatchGeneralExceptionTypes", Scope="member", Target="System.Windows.Forms.Internal.DbgUtil.StackFramesToStr(System.Int32):System.String")] [assembly: System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Performance", "CA1818:DoNotConcatenateStringsInsideLoops", Scope="member", Target="System.Windows.Forms.Internal.DbgUtil.StackFramesToStr(System.Int32):System.String")] [assembly: System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Interoperability", "CA1404:CallGetLastErrorImmediatelyAfterPInvoke", Scope="member", Target="System.Windows.Forms.Internal.DbgUtil.GetLastErrorStr():System.String")] #if WINFORMS_NAMESPACE namespace System.Windows.Forms.Internal #elif DRAWING_NAMESPACE namespace System.Drawing.Internal #else namespace System.Internal #endif { using System; using System.Drawing; using System.Diagnostics; using System.Diagnostics.CodeAnalysis; using System.Reflection; using System.Text; using System.Runtime.InteropServices; using System.Security.Permissions; using System.Globalization; ////// /// Debug help utility. /// [ ReflectionPermission(SecurityAction.Assert, TypeInformation=true, MemberAccess=true), EnvironmentPermission(SecurityAction.Assert, Unrestricted=true), FileIOPermission(SecurityAction.Assert, Unrestricted=true), SecurityPermission(SecurityAction.Assert, Flags=SecurityPermissionFlag.UnmanagedCode), UIPermission(SecurityAction.Assert, Unrestricted=true) ] internal sealed class DbgUtil { public const int FORMAT_MESSAGE_ALLOCATE_BUFFER = 0x00000100, FORMAT_MESSAGE_IGNORE_INSERTS = 0x00000200, FORMAT_MESSAGE_FROM_SYSTEM = 0x00001000, FORMAT_MESSAGE_DEFAULT = FORMAT_MESSAGE_IGNORE_INSERTS | FORMAT_MESSAGE_FROM_SYSTEM; [DllImport(ExternDll.Kernel32, SetLastError=true, CharSet=System.Runtime.InteropServices.CharSet.Auto)] public static extern int GetUserDefaultLCID(); [DllImport(ExternDll.Kernel32, SetLastError=true, CharSet=System.Runtime.InteropServices.CharSet.Auto)] public static extern int FormatMessage(int dwFlags, HandleRef lpSource, int dwMessageId, int dwLanguageId, StringBuilder lpBuffer, int nSize, HandleRef arguments); public static int gdipInitMaxFrameCount = 8; public static int gdiUseMaxFrameCount = 8; public static int finalizeMaxFrameCount = 5; // Methods ////// Call this method from your Dispose(bool) to assert that unmanaged resources has been explicitly disposed. /// [Conditional("DEBUG")] // This code will be compiled into the assembly anyways, it is up to the compiler to ignore the call. public static void AssertFinalization(object obj, bool disposing) { #if GDI_FINALIZATION_WATCH if( disposing || AppDomain.CurrentDomain.IsFinalizingForUnload() ) { return; } try { BindingFlags bindingFlags = BindingFlags.NonPublic | BindingFlags.GetField | BindingFlags.Static | BindingFlags.Instance; FieldInfo allocSiteFld = obj.GetType().GetField("AllocationSite", bindingFlags); string allocationSite = allocSiteFld != null ? allocSiteFld.GetValue( obj ).ToString() : ""; // ignore ojects created by WindowsGraphicsCacheManager. if( allocationSite.Contains("WindowsGraphicsCacheManager") ) { return; } Debug.Fail("Object Disposed through finalization - it should be explicitly disposed."); Debug.WriteLine("Allocation stack:\r\n" + allocationSite); } catch(Exception ex) { try { Debug.WriteLine("Exception thrown while trying to get allocation stack: " + ex); } catch { } } #endif } /// /// [Conditional("DEBUG")] public static void AssertWin32(bool expression, string message) { #if DEBUG if( !expression ) { Debug.Fail(message + "\r\nError: " + DbgUtil.GetLastErrorStr()); } #endif } ////// [Conditional("DEBUG")] public static void AssertWin32(bool expression, string format, object arg1) { #if DEBUG if( !expression ) { object[] args = new object[]{ arg1 }; AssertWin32Impl( expression, format, args ); } #endif } ////// [Conditional("DEBUG")] public static void AssertWin32(bool expression, string format, object arg1, object arg2) { #if DEBUG if( !expression ) { object[] args = new object[]{ arg1, arg2 }; AssertWin32Impl( expression, format, args ); } #endif } ////// [Conditional("DEBUG")] public static void AssertWin32(bool expression, string format, object arg1, object arg2, object arg3) { #if DEBUG if( !expression ) { object[] args = new object[]{ arg1, arg2, arg3 }; AssertWin32Impl( expression, format, args ); } #endif } ////// [Conditional("DEBUG")] public static void AssertWin32(bool expression, string format, object arg1, object arg2, object arg3, object arg4) { #if DEBUG if( !expression ) { object[] args = new object[]{ arg1, arg2, arg3, arg4 }; AssertWin32Impl( expression, format, args ); } #endif } ////// [Conditional("DEBUG")] public static void AssertWin32(bool expression, string format, object arg1, object arg2, object arg3, object arg4, object arg5) { #if DEBUG if( !expression ) { object[] args = new object[]{ arg1, arg2, arg3, arg4, arg5 }; AssertWin32Impl( expression, format, args ); } #endif } ////// [Conditional("DEBUG")] // This code will be compiled into the assembly anyways, it is up to the compiler to ignore the call. private static void AssertWin32Impl(bool expression, string format, object[] args) { #if DEBUG if( !expression ) { string message = string.Format(CultureInfo.CurrentCulture, format, args); Debug.Fail(message + "\r\nError: " + DbgUtil.GetLastErrorStr()); } #endif } // // WARNING: Your PInvoke function needs to have the DllImport.SetLastError=true for this method // to work properly. From the MSDN: // GetLastWin32Error exposes the Win32 GetLastError API method from Kernel32.DLL. This method exists // because it is not safe to make a direct platform invoke call to GetLastError to obtain this information. // If you want to access this error code, you must call GetLastWin32Error rather than writing your own // platform invoke definition for GetLastError and calling it. The common language runtime can make // internal calls to APIs that overwrite the operating system maintained GetLastError. // // You can only use this method to obtain error codes if you apply the System.Runtime.InteropServices.DllImportAttribute // to the method signature and set the SetLastError field to true. // [SuppressMessage("Microsoft.Interoperability", "CA1404:CallGetLastErrorImmediatelyAfterPInvoke")] public static string GetLastErrorStr() { int MAX_SIZE = 255; StringBuilder buffer = new StringBuilder(MAX_SIZE); string message = String.Empty; int err = 0; try { err = Marshal.GetLastWin32Error(); int retVal = FormatMessage( FORMAT_MESSAGE_DEFAULT, new HandleRef(null, IntPtr.Zero), err, GetUserDefaultLCID(), buffer, MAX_SIZE, new HandleRef(null, IntPtr.Zero) ); message = retVal != 0 ? buffer.ToString() : ""; } catch( Exception ex) { if( DbgUtil.IsCriticalException(ex) ) { throw; //rethrow critical exception. } message = ex.ToString(); } return String.Format( CultureInfo.CurrentCulture, "0x{0:x8} - {1}", err, message); } /// /// Duplicated here from ClientUtils not to depend on that code because this class is to be /// compiled into System.Drawing and System.Windows.Forms. /// private static bool IsCriticalException( Exception ex ) { return //ex is NullReferenceException || ex is StackOverflowException || ex is OutOfMemoryException || ex is System.Threading.ThreadAbortException; } ////// public static string StackTrace { get { return Environment.StackTrace; } } ////// Returns information about the top stack frames in a string format. The input param determines the number of /// frames to include. /// public static string StackFramesToStr( int maxFrameCount ) { string trace = String.Empty; try { StackTrace st = new StackTrace( true ); int dbgUtilFrameCount = 0; // // Ignore frames for methods on this library. // Note: The stack frame holds the latest frame at index 0. // while( dbgUtilFrameCount < st.FrameCount ) { StackFrame sf = st.GetFrame(dbgUtilFrameCount); if( sf == null || sf.GetMethod().DeclaringType != typeof(DbgUtil) ) { break; } dbgUtilFrameCount++; } maxFrameCount += dbgUtilFrameCount; // add ignored frames. if( maxFrameCount > st.FrameCount ) { maxFrameCount = st.FrameCount; } for(int i = dbgUtilFrameCount; i < maxFrameCount; i++ ) { StackFrame sf = st.GetFrame(i); if( sf == null ) { continue; } MethodBase mi = sf.GetMethod(); if( mi == null ) { continue; } string args = String.Empty; string fileName = sf.GetFileName(); int backSlashIndex = fileName == null ? -1 : fileName.LastIndexOf( '\\' ); if( backSlashIndex != -1 ) { fileName = fileName.Substring( backSlashIndex + 1, fileName.Length - backSlashIndex - 1); } foreach( ParameterInfo pi in mi.GetParameters() ) { args += pi.ParameterType.Name + ", "; } if( args.Length > 0 ) // remove last comma. { args = args.Substring(0, args.Length - 2); } trace += String.Format(CultureInfo.CurrentCulture, "at {0}:{1} {2}.{3}({4})\r\n", fileName, sf.GetFileLineNumber(), mi.DeclaringType, mi.Name, args ); } } catch( Exception ex ) { if( DbgUtil.IsCriticalException(ex) ) { throw; //rethrow critical exception. } trace += ex.ToString(); } return trace.ToString(); } ////// Returns information about the top stack frames in a string format. /// public static string StackFramesToStr() { return StackFramesToStr( DbgUtil.gdipInitMaxFrameCount ); } ////// Returns information about the top stack frames in a string format. The input param determines the number of /// frames to include. The 'message' parameter is used as the header of the returned string. /// public static string StackTraceToStr( string message, int frameCount ) { return String.Format( CultureInfo.CurrentCulture, "{0}\r\nTop Stack Trace:\r\n{1}", message, DbgUtil.StackFramesToStr(frameCount)); } ////// Returns information about the top stack frames in a string format. The 'message' parameter is used as the header of the returned string. /// public static string StackTraceToStr( string message ) { return StackTraceToStr(message, DbgUtil.gdipInitMaxFrameCount ); } } } // File provided for Reference Use Only by Microsoft Corporation (c) 2007. // Copyright (c) Microsoft Corporation. All rights reserved.
Link Menu
This book is available now!
Buy at Amazon US or
Buy at Amazon UK
- SQLDoubleStorage.cs
- ColorKeyFrameCollection.cs
- CollectionConverter.cs
- QueryReaderSettings.cs
- TraceSource.cs
- X509Certificate.cs
- QuerySafeNavigator.cs
- NotCondition.cs
- WorkflowServiceBuildProvider.cs
- DataGridViewColumnHeaderCell.cs
- DiscoveryOperationContext.cs
- EntityContainerEmitter.cs
- ProcessProtocolHandler.cs
- DefaultClaimSet.cs
- XPathNodeHelper.cs
- safemediahandle.cs
- AssemblyBuilder.cs
- EntitySetRetriever.cs
- TextFormatterHost.cs
- WaitingCursor.cs
- RowsCopiedEventArgs.cs
- Renderer.cs
- FactoryGenerator.cs
- XmlSchemaResource.cs
- CompositionDesigner.cs
- ScaleTransform.cs
- ClientConfigurationSystem.cs
- DecoderNLS.cs
- KnownBoxes.cs
- TableHeaderCell.cs
- KnownColorTable.cs
- TableStyle.cs
- DataGridCommandEventArgs.cs
- EntityDataSourceWrapper.cs
- DesignTimeType.cs
- ProtectedConfigurationProviderCollection.cs
- Size3D.cs
- ItemAutomationPeer.cs
- BoundField.cs
- DbProviderFactory.cs
- MemberAccessException.cs
- filewebrequest.cs
- ResourceAttributes.cs
- StateBag.cs
- GroupBox.cs
- ConnectivityStatus.cs
- OutputCacheSettingsSection.cs
- Accessors.cs
- TreeBuilderXamlTranslator.cs
- GridViewRowCollection.cs
- OrthographicCamera.cs
- FastEncoder.cs
- PersonalizationProvider.cs
- XXXOnTypeBuilderInstantiation.cs
- DataBoundControlActionList.cs
- NativeWindow.cs
- PrintDialog.cs
- FixedSOMPageElement.cs
- UriParserTemplates.cs
- Literal.cs
- ProfileSection.cs
- Int32AnimationUsingKeyFrames.cs
- bindurihelper.cs
- DataBinding.cs
- SafeNativeMethods.cs
- Internal.cs
- DependencyPropertyDescriptor.cs
- AssemblyAttributesGoHere.cs
- OutOfProcStateClientManager.cs
- LZCodec.cs
- KeyInstance.cs
- __Filters.cs
- ConfigurationManagerHelper.cs
- DelegatedStream.cs
- TypeGeneratedEventArgs.cs
- XmlHierarchicalEnumerable.cs
- FileNameEditor.cs
- FixedSOMElement.cs
- FileEnumerator.cs
- OpCopier.cs
- ImageClickEventArgs.cs
- SqlWebEventProvider.cs
- XamlPathDataSerializer.cs
- UserNamePasswordServiceCredential.cs
- sqlstateclientmanager.cs
- WaitHandle.cs
- EntityDataSourceStatementEditorForm.cs
- PrivilegeNotHeldException.cs
- KoreanLunisolarCalendar.cs
- PrimitiveSchema.cs
- DynamicRenderer.cs
- HttpPostedFile.cs
- AuthenticationConfig.cs
- DataGridViewColumnTypeEditor.cs
- BindingCompleteEventArgs.cs
- PolicyStatement.cs
- Grant.cs
- XPathScanner.cs
- EventSinkHelperWriter.cs
- FrameworkContentElement.cs