Blame view

src/idl_extern/Coyote_for_Dustemwrap/whoami.pro 4.53 KB
a114c166   Annie Hughes   removed redundant...
1
2
3
; docformat = 'rst'
;
; NAME:
03d91afb   Annie Hughes   Name change for e...
4
;   WhoAmI
a114c166   Annie Hughes   removed redundant...
5
6
;
; PURPOSE:
03d91afb   Annie Hughes   Name change for e...
7
8
;   This is a function that will identify the name of the procedure or function which
;   calls this function.
a114c166   Annie Hughes   removed redundant...
9
10
11
;
;******************************************************************************************;
;                                                                                          ;
03d91afb   Annie Hughes   Name change for e...
12
;  Copyright (c) 2011, by Fanning Software Consulting, Inc. All rights reserved.           ;
a114c166   Annie Hughes   removed redundant...
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
;                                                                                          ;
;  Redistribution and use in source and binary forms, with or without                      ;
;  modification, are permitted provided that the following conditions are met:             ;
;                                                                                          ;
;      * Redistributions of source code must retain the above copyright                    ;
;        notice, this list of conditions and the following disclaimer.                     ;
;      * Redistributions in binary form must reproduce the above copyright                 ;
;        notice, this list of conditions and the following disclaimer in the               ;
;        documentation and/or other materials provided with the distribution.              ;
;      * Neither the name of Fanning Software Consulting, Inc. nor the names of its        ;
;        contributors may be used to endorse or promote products derived from this         ;
;        software without specific prior written permission.                               ;
;                                                                                          ;
;  THIS SOFTWARE IS PROVIDED BY FANNING SOFTWARE CONSULTING, INC. ''AS IS'' AND ANY        ;
;  EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES    ;
;  OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT     ;
;  SHALL FANNING SOFTWARE CONSULTING, INC. BE LIABLE FOR ANY DIRECT, INDIRECT,             ;
;  INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED    ;
;  TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;         ;
;  LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND             ;
;  ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT              ;
;  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS           ;
;  SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.                            ;
;******************************************************************************************;
;
;+
; :Description:
03d91afb   Annie Hughes   Name change for e...
40
41
;   This is a function that will identify the name of the procedure or function which
;   calls this function.
a114c166   Annie Hughes   removed redundant...
42
43
;
; :Categories:
03d91afb   Annie Hughes   Name change for e...
44
;    Utilities
a114c166   Annie Hughes   removed redundant...
45
46
;    
; :Params:
03d91afb   Annie Hughes   Name change for e...
47
;    none
a114c166   Annie Hughes   removed redundant...
48
49
;       
; :Keywords:
03d91afb   Annie Hughes   Name change for e...
50
51
52
53
54
55
56
;     none
;     
; : Return Value:
;     caller:
;         A string in uppercase letters identifying the name of the program
;         module containing this function.
;         
a114c166   Annie Hughes   removed redundant...
57
; :Examples:
03d91afb   Annie Hughes   Name change for e...
58
59
;    Used to a module by name::
;       IDL> Print, WhoAmI()
a114c166   Annie Hughes   removed redundant...
60
;       
03d91afb   Annie Hughes   Name change for e...
61
62
63
64
65
;       ; Compile and run the following main level program.
;       ;***************************
;       PRO junker
;          Print, WhoAmI()
;       END
a114c166   Annie Hughes   removed redundant...
66
;       
03d91afb   Annie Hughes   Name change for e...
67
68
69
70
71
72
73
74
75
76
77
;       PRO junk
;          Print, WhoAmI()
;       END
;       
;       junk
;       END
;       ;**************************

;       IDL> .go
;            JUNK
;            JUNKER
a114c166   Annie Hughes   removed redundant...
78
79
80
81
82
83
84
85
86
87
88
89
;       
; :Author:
;       FANNING SOFTWARE CONSULTING::
;           David W. Fanning 
;           1645 Sheely Drive
;           Fort Collins, CO 80526 USA
;           Phone: 970-221-0438
;           E-mail: david@idlcoyote.com
;           Coyote's Guide to IDL Programming: http://www.idlcoyote.com
;
; :History:
;     Change History::
03d91afb   Annie Hughes   Name change for e...
90
;        Written, 28 January 2011. DWF. 
a114c166   Annie Hughes   removed redundant...
91
92
;
; :Copyright:
03d91afb   Annie Hughes   Name change for e...
93
;     Copyright (c) 2011, Fanning Software Consulting, Inc.
a114c166   Annie Hughes   removed redundant...
94
;-
03d91afb   Annie Hughes   Name change for e...
95
FUNCTION WhoAmI
a114c166   Annie Hughes   removed redundant...
96

03d91afb   Annie Hughes   Name change for e...
97
   Compile_Opt idl2
a114c166   Annie Hughes   removed redundant...
98

03d91afb   Annie Hughes   Name change for e...
99
100
   ; Return to caller on error.
   On_Error, 2
a114c166   Annie Hughes   removed redundant...
101

03d91afb   Annie Hughes   Name change for e...
102
103
104
105
106
107
108
109
110
111
112
   ; Get the call stack and the calling routine's name.
   callStack = Scope_Traceback()
   
   ; Find where I am in the call stack. The calling program is up
   ; one level from there. Unless, of course, I am close to $MAIN$.
   index = Where(StrMid(callstack, 0, 6) EQ 'WHOAMI', count)
   IF count GE 1 THEN index = (Reverse(index))[0] 
   thisRoutine = (StrSplit(StrCompress(callStack[(index-1) > 0])," ", /Extract))[0]
   
   ; Return the answer.
   RETURN, thisRoutine
a114c166   Annie Hughes   removed redundant...
113
114
   
END