annotate modules/executable/executable.hpp @ 616:47f003c55e1e

Executable: dedicate new module directory, closes #684
author David Demelier <markand@malikania.fr>
date Mon, 21 Aug 2017 11:40:55 +0200
parents
children 266f32919d0a
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
616
47f003c55e1e Executable: dedicate new module directory, closes #684
David Demelier <markand@malikania.fr>
parents:
diff changeset
1 /*
47f003c55e1e Executable: dedicate new module directory, closes #684
David Demelier <markand@malikania.fr>
parents:
diff changeset
2 * executable.hpp -- get executable path
47f003c55e1e Executable: dedicate new module directory, closes #684
David Demelier <markand@malikania.fr>
parents:
diff changeset
3 *
47f003c55e1e Executable: dedicate new module directory, closes #684
David Demelier <markand@malikania.fr>
parents:
diff changeset
4 * Copyright (c) 2016 David Demelier <markand@malikania.fr>
47f003c55e1e Executable: dedicate new module directory, closes #684
David Demelier <markand@malikania.fr>
parents:
diff changeset
5 *
47f003c55e1e Executable: dedicate new module directory, closes #684
David Demelier <markand@malikania.fr>
parents:
diff changeset
6 * Permission to use, copy, modify, and/or distribute this software for any
47f003c55e1e Executable: dedicate new module directory, closes #684
David Demelier <markand@malikania.fr>
parents:
diff changeset
7 * purpose with or without fee is hereby granted, provided that the above
47f003c55e1e Executable: dedicate new module directory, closes #684
David Demelier <markand@malikania.fr>
parents:
diff changeset
8 * copyright notice and this permission notice appear in all copies.
47f003c55e1e Executable: dedicate new module directory, closes #684
David Demelier <markand@malikania.fr>
parents:
diff changeset
9 *
47f003c55e1e Executable: dedicate new module directory, closes #684
David Demelier <markand@malikania.fr>
parents:
diff changeset
10 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
47f003c55e1e Executable: dedicate new module directory, closes #684
David Demelier <markand@malikania.fr>
parents:
diff changeset
11 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
47f003c55e1e Executable: dedicate new module directory, closes #684
David Demelier <markand@malikania.fr>
parents:
diff changeset
12 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
47f003c55e1e Executable: dedicate new module directory, closes #684
David Demelier <markand@malikania.fr>
parents:
diff changeset
13 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
47f003c55e1e Executable: dedicate new module directory, closes #684
David Demelier <markand@malikania.fr>
parents:
diff changeset
14 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
47f003c55e1e Executable: dedicate new module directory, closes #684
David Demelier <markand@malikania.fr>
parents:
diff changeset
15 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
47f003c55e1e Executable: dedicate new module directory, closes #684
David Demelier <markand@malikania.fr>
parents:
diff changeset
16 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
47f003c55e1e Executable: dedicate new module directory, closes #684
David Demelier <markand@malikania.fr>
parents:
diff changeset
17 */
47f003c55e1e Executable: dedicate new module directory, closes #684
David Demelier <markand@malikania.fr>
parents:
diff changeset
18
47f003c55e1e Executable: dedicate new module directory, closes #684
David Demelier <markand@malikania.fr>
parents:
diff changeset
19 #ifndef EXECUTABLE_HPP
47f003c55e1e Executable: dedicate new module directory, closes #684
David Demelier <markand@malikania.fr>
parents:
diff changeset
20 #define EXECUTABLE_HPP
47f003c55e1e Executable: dedicate new module directory, closes #684
David Demelier <markand@malikania.fr>
parents:
diff changeset
21
47f003c55e1e Executable: dedicate new module directory, closes #684
David Demelier <markand@malikania.fr>
parents:
diff changeset
22 #include <string>
47f003c55e1e Executable: dedicate new module directory, closes #684
David Demelier <markand@malikania.fr>
parents:
diff changeset
23
47f003c55e1e Executable: dedicate new module directory, closes #684
David Demelier <markand@malikania.fr>
parents:
diff changeset
24 /**
47f003c55e1e Executable: dedicate new module directory, closes #684
David Demelier <markand@malikania.fr>
parents:
diff changeset
25 * Get executable path.
47f003c55e1e Executable: dedicate new module directory, closes #684
David Demelier <markand@malikania.fr>
parents:
diff changeset
26 *
47f003c55e1e Executable: dedicate new module directory, closes #684
David Demelier <markand@malikania.fr>
parents:
diff changeset
27 * \return the string to the executable path
47f003c55e1e Executable: dedicate new module directory, closes #684
David Demelier <markand@malikania.fr>
parents:
diff changeset
28 * \throw std::exception on any system error
47f003c55e1e Executable: dedicate new module directory, closes #684
David Demelier <markand@malikania.fr>
parents:
diff changeset
29 */
47f003c55e1e Executable: dedicate new module directory, closes #684
David Demelier <markand@malikania.fr>
parents:
diff changeset
30 std::string executable_path();
47f003c55e1e Executable: dedicate new module directory, closes #684
David Demelier <markand@malikania.fr>
parents:
diff changeset
31
47f003c55e1e Executable: dedicate new module directory, closes #684
David Demelier <markand@malikania.fr>
parents:
diff changeset
32 #endif // !EXECUTABLE_HPP