OpenCPN Partial API docs
Loading...
Searching...
No Matches
ocpn_utils.h
Go to the documentation of this file.
1/**************************************************************************
2 * Copyright (C) 2019 Alec Leamas *
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 as published by *
6 * the Free Software Foundation; either version 2 of the License, or *
7 * (at your option) any later version. *
8 * *
9 * This program is distributed in the hope that it will be useful, *
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
12 * GNU General Public License for more details. *
13 * *
14 * You should have received a copy of the GNU General Public License *
15 * along with this program; if not, write to the *
16 * Free Software Foundation, Inc., *
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. *
18 **************************************************************************/
19
25#ifndef _OCPN_UTILS_H__
26#define _OCPN_UTILS_H__
27
28#include <string>
29#include <vector>
30
33namespace ocpn {
34
36bool endswith(const std::string& s, const std::string& suffix);
37
39bool startswith(const std::string& s, const std::string& prefix);
40
45std::string ltrim(const std::string& s);
46
51std::string rtrim(const std::string& s);
52
57std::string trim(std::string s);
58
63std::string join(std::vector<std::string> v, char c);
64
66std::string tolower(const std::string& s);
67
69std::vector<std::string> split(const char* s, const std::string& delimiter);
70
72std::vector<std::string> split(const std::string& s,
73 const std::string& delimiter);
74
76bool exists(const std::string& path);
77
79void mkdir(const std::string path);
80
85bool replace(std::string& str, const std::string& from, const std::string& to);
86
88void copy_file(const std::string& src_path, const std::string& dest_path);
89
95bool N0183CheckSumOk(const std::string& sentence);
96
98std::string printable(const std::string& str);
99
100} // namespace ocpn
101
102#endif // _OCPN_UTILS_H__
ocpn
Standard, mostly strings utilities.
Definition datetime.cpp:28
ocpn::replace
bool replace(std::string &str, const std::string &from, const std::string &to)
Perform in place substitution in str, replacing "from" with "to".
Definition ocpn_utils.cpp:136
ocpn::startswith
bool startswith(const std::string &str, const std::string &prefix)
Return true if s starts with given prefix.
Definition ocpn_utils.cpp:50
ocpn::tolower
std::string tolower(const std::string &input)
Return copy of s with all characters converted to lower case.
Definition ocpn_utils.cpp:130
ocpn::printable
std::string printable(const std::string &str)
Return copy of str with non-printable chars replaced by hex like "<0D>".
Definition ocpn_utils.cpp:170
ocpn::split
std::vector< std::string > split(const char *token_string, const std::string &delimiter)
Return vector of items in s separated by delimiter.
Definition ocpn_utils.cpp:55
ocpn::trim
std::string trim(std::string s)
Strip possibly trailing and/or leading space characters in s.
Definition ocpn_utils.cpp:113
ocpn::rtrim
std::string rtrim(const std::string &arg)
Strip possibly trailing space characters in s.
Definition ocpn_utils.cpp:103
ocpn::endswith
bool endswith(const std::string &str, const std::string &suffix)
Return true if s ends with given suffix.
Definition ocpn_utils.cpp:45
ocpn::ltrim
std::string ltrim(const std::string &arg)
Strip possibly leading space characters in s.
Definition ocpn_utils.cpp:94
ocpn::copy_file
void copy_file(const std::string &src_path, const std::string &dest_path)
Copy file contents in path src_path to dest_path.
Definition ocpn_utils.cpp:143
ocpn::exists
bool exists(const std::string &name)
Definition ocpn_utils.cpp:75
ocpn::N0183CheckSumOk
bool N0183CheckSumOk(const std::string &sentence)
Check if checksum in a NMEA0183 sentence is correct.
Definition ocpn_utils.cpp:153
ocpn::join
std::string join(std::vector< std::string > v, char c)
Return a single string being the concatenation of all elements in v with character c in between.
Definition ocpn_utils.cpp:119
ocpn::mkdir
void mkdir(const std::string path)
Definition ocpn_utils.cpp:84