[Author: oster]

subtreeDescription is a debugging tool for displaying UIView hierarchies in the Xcode Console window in DEBUG builds.
As it says in the .h file:
pause in the debugger and type something like:
(gdb) po [[[UIApplication sharedApplication] keyWindow] subtreeDescription]
and a nicely pretty printed version of the view hierarchy will be printed in the debugger console window.

DELTA=179 (179 added, 0 deleted, 0 changed)
R=dmaclach,mikemorton,thomasvl

1 files changed, 47 insertions, 0 deletions

diff --git a/iPhone/GTMUIView+SubtreeDescription.h b/iPhone/GTMUIView+SubtreeDescription.h
new file mode 100644
index 0000000..1e714ed
--- /dev/null
+++ b/iPhone/GTMUIView+SubtreeDescription.h
@@ -0,0 +1,47 @@
+//
+//  GTMUIView+SubtreeDescription.h
+//
+//  Copyright 2009 Google Inc.
+//
+//  Licensed under the Apache License, Version 2.0 (the "License"); you may not
+//  use this file except in compliance with the License.  You may obtain a copy
+//  of the License at
+//
+//  http://www.apache.org/licenses/LICENSE-2.0
+//
+//  Unless required by applicable law or agreed to in writing, software
+//  distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+//  WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
+//  License for the specific language governing permissions and limitations
+//  under the License.
+//
+#import <UIKit/UIKit.h>
+
+// This entire file, and the corresponding .m is DEBUG only.
+// But you can define INCLUDE_UIVIEW_SUBTREE_DESCRIPTION to no-zero to override.
+#if DEBUG || INCLUDE_UIVIEW_SUBTREE_DESCRIPTION
+
+// Example, in debugger, pause the program, then type:
+// po [[[UIApplication sharedApplication] keyWindow] subtreeDescription]
+
+@interface UIView (SubtreeDescription)
+
+// Returns one line, without leading indent, but with a trailing newline,
+// describing the view.
+// If you define a |myViewDescriptionLine| method in your own UIView classes,
+// this will append that result to its description.
+- (NSString *)gtm_subtreeDescriptionLine;
+
+// For debugging. Returns a nicely indented representation of this view's
+// subview hierarchy, each with frame and isHidden.
+- (NSString *)subtreeDescription;
+
+// For debugging. Returns a nicely indented representation of this view's
+// layer hierarchy, with frames and isHidden.
+// Requires QuartzCore to be useful, but your app will still link without it.
+// TODO: should there be an analog of myViewDescriptionLine for layers?
+- (NSString *)sublayersDescription;
+
+@end
+
+#endif  // DEBUG