Add atsign-profview

Closes #106

Author: timholy

Project.toml

@@ -1,7 +1,7 @@
 name = "ProfileView"
 uuid = "c46f51b8-102a-5cf2-8d2c-8597cb0e0da7"
 author = ["Tim Holy <[email protected]>"]
-version = "0.4.1"
+version = "0.5"
 
 [deps]
 Cairo = "159f3aea-2a34-519c-b102-8c37f9878175"

README.md

@@ -42,17 +42,13 @@ function profile_test(n)
     end
 end
 
-profile_test(1)  # run once to trigger compilation
-using Profile
-Profile.clear()  # in case we have any previous profiling data
-@profile profile_test(10)
+using ProfileView
+@profview profile_test(1)  # run once to trigger compilation (ignore this one)
+@profview profile_test(10)
 ```
-Now that we have profiling data, visualizing it is a simple matter:
-```
-julia> using ProfileView
 
-julia> ProfileView.view()
-```
+`@profview f(args...)` is just shorthand for `Profile.clear(); @profile f(args...); ProfileView.view()`.
+
 If you're following along, you should see something like this:
 
 ![ProfileView](readme_images/pv1.jpg)

src/ProfileView.jl

@@ -5,6 +5,21 @@ using Colors
 
 import Base: isequal, show
 
+export @profview
+
+"""
+    @profview f(args...)
+
+Clear the Profile buffer, profile `f(args...)`, and view the result graphically.
+"""
+macro profview(ex)
+    return quote
+        Profile.clear()
+        @profile $(esc(ex))
+        view()
+    end
+end
+
 include("tree.jl")
 include("pvtree.jl")
 

test/test.jl

@@ -1,4 +1,3 @@
-using Profile
 using ProfileView
 
 function profile_test(n)
@@ -35,6 +34,10 @@ function profile_unstable_test(m, n)
 end
 
 profile_test(1)
+@profview profile_test(10)
+
+using Profile
+
 Profile.clear()
 @profile profile_test(10)
 ProfileView.view()