;+ ; NAME: ; DXFINISH ; ; AUTHOR: ; Craig B. Markwardt, NASA/GSFC Code 662, Greenbelt, MD 20770 ; craigm@lheamail.gsfc.nasa.gov ; ; PURPOSE: ; Sets an IDL breakpoint to stop upon return of the current procedure ; ; CALLING SEQUENCE: ; DXFINISH [ , NLEVELS ] ; ; DESCRIPTION: ; ; DXFINISH is a convenience routine for setting IDL breakpoints. ; ; DXFINISH sets a breakpoint so that when the current procedure ; finishes, execution will stop. Often when debugging one wants to ; let the current procedure complete but stop at the next level. ; DXFINISH does exactly that. ; ; DXFINISH examines the state of the current IDL call stack, ; determines at what point the current procedure will return, and ; sets a breakpoint there. Note that the procedure in which the ; breakpoint is set must be compiled and on disk. ; ; By default the breakpoint is set with the ONCE keyword. ; ; INPUTS: ; ; NLEVELS - Number of call levels up to set breakpoint. Default is ; 1. ; ; KEYWORDS: ; ; ONCE - if set, then the breakpoint will only occur once. Default ; value is SET, so ONCE=0 must be passed explicitly to ; disable this function. ; ; EXAMPLE: ; ; dxfinish ; ; Set breakpoint in calling procedure. ; ; SEE ALSO: ; ; BREAKPOINT, DXBREAK, DXCLEAR ; ; MODIFICATION HISTORY: ; Written, 15 Apr 2000 ; ; $Id: dxfinish.pro,v 1.2 2001/02/09 04:57:16 craigm Exp $ ; ;- ; Copyright (C) 2000, Craig Markwardt ; This software is provided as is without any warranty whatsoever. ; Permission to use, copy, modify, and distribute modified or ; unmodified copies is granted, provided this copyright and disclaimer ; are included unchanged. ;-