MySQL 9.0.0
Source Code Documentation
default_paths.h
Go to the documentation of this file.
1/*
2 Copyright (c) 2021, 2024, 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 designed to work 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 either included with
14 the program or referenced in the documentation.
15
16 This program is distributed in the hope that it will be useful,
17 but WITHOUT ANY WARRANTY; without even the implied warranty of
18 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 GNU General Public License for more details.
20
21 You should have received a copy of the GNU General Public License
22 along with this program; if not, write to the Free Software
23 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
24*/
25
26#ifndef ROUTER_DEFAULT_PATHS_INCLUDED
27#define ROUTER_DEFAULT_PATHS_INCLUDED
28
30
31#include <map>
32#include <string>
33
34#include "mysql/harness/filesystem.h" // Path
35
36namespace mysqlrouter {
37
38/**
39 * Returns predefined (computed) default paths.
40 *
41 * Returns a map of predefined default paths, which are computed based on
42 * `origin` argument. This argument serves as base directory for any
43 * predefined relative paths. The returned map consists of absolue paths.
44 *
45 * @param origin Base directory which will be prepended to any relative
46 * predefined directories
47 *
48 * @throws std::invalid_argument (std::logic_error) if `origin` is empty
49 */
50std::map<std::string, std::string> ROUTER_UTILS_EXPORT
52
53/**
54 * Returns absolute path to mysqlrouter.exe currently running.
55 *
56 * @param argv0 1th element of `argv` array passed to `main()` (i.e.
57 * `argv[0]`)
58 *
59 * @throws std::runtime_error, ...?
60 *
61 * @note argv0 is currently ignored on Windows platforms
62 */
63std::string ROUTER_UTILS_EXPORT
64find_full_executable_path(const std::string &argv0);
65
66} // namespace mysqlrouter
67
68#endif
Class representing a path in a file system.
Definition: filesystem.h:63
Definition: dim.h:358
std::string ROUTER_UTILS_EXPORT find_full_executable_path(const std::string &argv0)
Returns absolute path to mysqlrouter.exe currently running.
Definition: default_paths.cc:111
std::map< std::string, std::string > ROUTER_UTILS_EXPORT get_default_paths(const mysql_harness::Path &origin)
Returns predefined (computed) default paths.
Definition: default_paths.cc:78
#define ROUTER_UTILS_EXPORT
Definition: router_utils_export.h:15