HPCToolkit
executable-path.h
Go to the documentation of this file.
1 // -*-Mode: C++;-*- // technically C99
2 
3 // * BeginRiceCopyright *****************************************************
4 //
5 // $HeadURL$
6 // $Id$
7 //
8 // --------------------------------------------------------------------------
9 // Part of HPCToolkit (hpctoolkit.org)
10 //
11 // Information about sources of support for research and development of
12 // HPCToolkit is at 'hpctoolkit.org' and in 'README.Acknowledgments'.
13 // --------------------------------------------------------------------------
14 //
15 // Copyright ((c)) 2002-2019, Rice University
16 // All rights reserved.
17 //
18 // Redistribution and use in source and binary forms, with or without
19 // modification, are permitted provided that the following conditions are
20 // met:
21 //
22 // * Redistributions of source code must retain the above copyright
23 // notice, this list of conditions and the following disclaimer.
24 //
25 // * Redistributions in binary form must reproduce the above copyright
26 // notice, this list of conditions and the following disclaimer in the
27 // documentation and/or other materials provided with the distribution.
28 //
29 // * Neither the name of Rice University (RICE) nor the names of its
30 // contributors may be used to endorse or promote products derived from
31 // this software without specific prior written permission.
32 //
33 // This software is provided by RICE and contributors "as is" and any
34 // express or implied warranties, including, but not limited to, the
35 // implied warranties of merchantability and fitness for a particular
36 // purpose are disclaimed. In no event shall RICE or contributors be
37 // liable for any direct, indirect, incidental, special, exemplary, or
38 // consequential damages (including, but not limited to, procurement of
39 // substitute goods or services; loss of use, data, or profits; or
40 // business interruption) however caused and on any theory of liability,
41 // whether in contract, strict liability, or tort (including negligence
42 // or otherwise) arising in any way out of the use of this software, even
43 // if advised of the possibility of such damage.
44 //
45 // ******************************************************* EndRiceCopyright *
46 
47 #ifndef executable_path_h
48 #define executable_path_h
49 
50 /*
51  * function: executable_path
52  *
53  * purpose:
54  * search for an executable file that matches 'filename'
55  * relative to the current directory or a colon separated
56  * list of paths
57  *
58  * return value:
59  * upon success, it will return the value supplied as path_name
60  *
61  *
62  * NOTES:
63  * 1. path_list is a colon separated list of paths to search
64  * for filename.
65  * 2. path_name must point to a buffer of length PATH_MAX
66  * 2. this routine can't allocate any memory, which
67  * makes the implementation a bit more complicated.
68  */
69 char *executable_path(const char *filename, const char *path_list, char *executable_name);
70 
71 #endif
72 
executable_name
char * executable_name
executable_path
char * executable_path(const char *filename, const char *path_list, char *executable_name)
Definition: executable-path.c:82