MySQL 8.3.0
Source Code Documentation
default_paths.h
Go to the documentation of this file.
1/*
2 Copyright (c) 2021, 2023, Oracle and/or its affiliates.
3
4 This program is free software; you can redistribute it and/or modify
5 it under the terms of the GNU General Public License, version 2.0,
6 as published by the Free Software Foundation.
7
8 This program is also distributed with certain software (including
9 but not limited to OpenSSL) that is licensed under separate terms,
10 as designated in a particular file or component or in included license
11 documentation. The authors of MySQL hereby grant you an additional
12 permission to link the program and your derivative works with the
13 separately licensed software that they have included with MySQL.
14
15 This program is distributed in the hope that it will be useful,
16 but WITHOUT ANY WARRANTY; without even the implied warranty of
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 GNU General Public License for more details.
19
20 You should have received a copy of the GNU General Public License
21 along with this program; if not, write to the Free Software
22 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
23*/
24
25#ifndef ROUTER_DEFAULT_PATHS_INCLUDED
26#define ROUTER_DEFAULT_PATHS_INCLUDED
27
28#include <map>
29#include <string>
30
31#include "mysql/harness/filesystem.h" // Path
33
34namespace mysqlrouter {
35
36/**
37 * Returns predefined (computed) default paths.
38 *
39 * Returns a map of predefined default paths, which are computed based on
40 * `origin` argument. This argument serves as base directory for any
41 * predefined relative paths. The returned map consists of absolue paths.
42 *
43 * @param origin Base directory which will be prepended to any relative
44 * predefined directories
45 *
46 * @throws std::invalid_argument (std::logic_error) if `origin` is empty
47 */
48std::map<std::string, std::string> ROUTER_LIB_EXPORT
50
51/**
52 * Returns absolute path to mysqlrouter.exe currently running.
53 *
54 * @param argv0 1th element of `argv` array passed to `main()` (i.e.
55 * `argv[0]`)
56 *
57 * @throws std::runtime_error, ...?
58 *
59 * @note argv0 is currently ignored on Windows platforms
60 */
61std::string ROUTER_LIB_EXPORT
62find_full_executable_path(const std::string &argv0);
63
64} // namespace mysqlrouter
65
66#endif
Class representing a path in a file system.
Definition: filesystem.h:62
Definition: dim.h:357
std::string ROUTER_LIB_EXPORT find_full_executable_path(const std::string &argv0)
Returns absolute path to mysqlrouter.exe currently running.
Definition: default_paths.cc:106
std::map< std::string, std::string > ROUTER_LIB_EXPORT get_default_paths(const mysql_harness::Path &origin)
Returns predefined (computed) default paths.
Definition: default_paths.cc:74
#define ROUTER_LIB_EXPORT
Definition: router_export.h:15