]> git.armaanb.net Git - gen-shell.git/blob - src/libshared/src/shared.h
added install instructions
[gen-shell.git] / src / libshared / src / shared.h
1 ////////////////////////////////////////////////////////////////////////////////
2 //
3 // Copyright 2006 - 2017, Paul Beckingham, Federico Hernandez.
4 //
5 // Permission is hereby granted, free of charge, to any person obtaining a copy
6 // of this software and associated documentation files (the "Software"), to deal
7 // in the Software without restriction, including without limitation the rights
8 // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9 // copies of the Software, and to permit persons to whom the Software is
10 // furnished to do so, subject to the following conditions:
11 //
12 // The above copyright notice and this permission notice shall be included
13 // in all copies or substantial portions of the Software.
14 //
15 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
16 // OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
18 // THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 // SOFTWARE.
22 //
23 // http://www.opensource.org/licenses/mit-license.php
24 //
25 ////////////////////////////////////////////////////////////////////////////////
26
27 #ifndef INCLUDED_SHARED
28 #define INCLUDED_SHARED
29
30 #include <sstream>
31 #include <algorithm>
32 #include <string>
33 #include <vector>
34
35 // shared.cpp, Non-UTF-8 aware.
36 void wrapText (std::vector <std::string>&, const std::string&, const int, bool);
37 int longestWord (const std::string&);
38 int longestLine (const std::string&);
39 bool extractLine (std::string&, const std::string&, int, bool, unsigned int&);
40 std::vector <std::string> split (const std::string&, const char);
41 std::vector <std::string> split (const std::string&);
42 std::string join (const std::string&, const std::vector<int>&);
43 std::string join (const std::string&, const std::vector<std::string>&);
44 std::string str_replace (const std::string&, const std::string&, const std::string&);
45 std::string trim (const std::string&, const std::string& edible = " \t\n\f\r");
46 std::string ltrim (const std::string&, const std::string& edible = " \t\n\f\r");
47 std::string rtrim (const std::string&, const std::string& edible = " \t\n\f\r");
48 bool compare (const std::string&, const std::string&, bool sensitive = true);
49 bool closeEnough (const std::string&, const std::string&, unsigned int minLength = 0);
50 int matchLength (const std::string&, const std::string&);
51 std::string::size_type find (const std::string&, const std::string&, bool sensitive = true);
52 std::string::size_type find (const std::string&, const std::string&, std::string::size_type, bool sensitive = true);
53
54 // List operations.
55 template <class T> void listDiff (
56   const T& left, const T& right, T& leftOnly, T& rightOnly)
57 {
58   leftOnly.clear ();
59   for (auto& l : left)
60     if (std::find (right.begin (), right.end (), l) == right.end ())
61       leftOnly.push_back (l);
62
63   rightOnly.clear ();
64   for (auto& r : right)
65     if (std::find (left.begin (), left.end (), r) == left.end ())
66       rightOnly.push_back (r);
67 }
68
69 template <class T> T listIntersect (
70   const T& left, const T& right)
71 {
72   T intersection;
73   for (auto& l : left)
74     if (std::find (right.begin (), right.end (), l) != right.end ())
75       intersection.push_back (l);
76
77   return intersection;
78 }
79
80 std::string lowerCase (const std::string&);
81 std::string upperCase (const std::string&);
82 std::string upperCaseFirst (const std::string&);
83
84 int autoComplete (const std::string&, const std::vector<std::string>&, std::vector<std::string>&, int minimum = 1);
85 bool confirm (const std::string&);
86
87 int execute (const std::string&, const std::vector <std::string>&, const std::string&, std::string&);
88 std::string osName ();
89 std::string cppCompliance ();
90
91 // ip.cpp
92 bool isIPv4Address (const std::string&, std::string&, int&);
93 bool isIPv6Address (const std::string&, std::string&, int&);
94
95 #endif