Changeset 74 for trunk/SRC/Utilities/createfunc.pro

Timestamp:

05/23/06 15:45:47 (18 years ago)

Author:

smasson

Message:

debug xxx and cie + clean data file + rm perldoc_idl

File:

• trunk/SRC/Utilities/createfunc.pro (modified) (4 diffs)

trunk/SRC/Utilities/createfunc.pro

@@ -3 +3 @@
 ;------------------------------------------------------------
 ;+
-; NAME:createpro
+; NAME:createfunc
 ;
-; PURPOSE: write an idl procedure, compile it and execute it.
+; PURPOSE: write an idl function, compile it and execute it.
+;          usefull to avoid the use of execute
 ;
 ; CATEGORY:
 ;
-; CALLING SEQUENCE:createpro, command
+; CALLING SEQUENCE:res = createfunc(command)
 ; 
 ; INPUTS:
-;      command: a string array defining the procedure to be created.
-;      each element will be a line of the created procedure. 
+;      command: a scalar string defining the result to be byven back by the
+;               function. (see examples)
 ;
 ; KEYWORD PARAMETERS:
 ;
-;      FILENAMEIN: name of the procedure to be created.
-;      'for_createpro.pro' by default
+;      FILENAMEIN: name of the funccedure to be created.
+;      'for_createfunc.pro' by default
 ;
 ;      KWDLIST: a vector string. to specify a list of keywords that
-;      must be included in the procedure definition. Warning: the string
+;      must be included in the function definition. Warning: the string
 ;      must start with a ',' for example: KWDLIST = ', TOTO = toto'
 ;
-;      _EXTRA: used to pass your keywords to the created procedure.
+;      _EXTRA: used to pass your keywords to the created function.
 ;
 ; OUTPUTS: none 
@@ -30 +31 @@
 ; COMMON BLOCKS: none
 ;
-; SIDE EFFECTS: ends teh procedure name with '.pro' if needed
+; SIDE EFFECTS: ends the function name with '.pro' if needed
 ;
-; RESTRICTIONS:de marche pas pour les fonctions
+; RESTRICTIONS:arguments can be given only through keywords
 ;
 ; EXAMPLE:
-;      IDL> createpro, ['print,''OK'''], filename='test'
-;      IDL> createpro, ['if keyword_set(ok) then print,''OK'' else print, ''No'''] $
-;      IDL>   , filename = 'test', kwdlist =', ok = ok' 
-;      IDL> createpro, ['if keyword_set(ok) then print,''OK'' else print, ''No'''] $
-;      IDL>   , filename = 'test', kwdlist = ', ok = ok', /ok 
-;
+;      IDL> print, createfunc('3*2', filename='test')
+;      IDL> print, createfunc('3*two', filename = 'test' $
+;                                    , kwdlist ='two = two', two = 2)
 ;
 ; MODIFICATION HISTORY:Sebastien Masson (smasson@lodyc.jussieu.fr)
-; cleaning + new keywords: October 2005
-; Feb. 2006: supress keyword "kwdused" and use call_procedure instead of execute
+;                      May 2005
 ;-
 ;------------------------------------------------------------
@@ -54 +51 @@
   compile_opt idl2, hidden, strictarrsubs
 ;
+  IF n_elements(command) NE 1 THEN stop
 ; define filename if needed
   if NOT keyword_set(filenamein) then filename = 'for_createfunc.pro' $
@@ -68 +66 @@
    if NOT keyword_set(kwdlist) then kwdlist = ''
    kwdlist = kwdlist + ', _extra = ex'
+   IF strmid(kwdlist, 0, 1) NE ',' THEN kwdlist = ', ' +  kwdlist
    putfile, filename, ['function ' + shortfilename + kwdlist $
                        , 'compile_opt idl2, hidden, strictarrsubs' $