mirror of
https://github.com/open-goal/jak-project
synced 2026-05-23 15:02:01 -04:00
Tyler Wilding
39658dfd71
This automatically generates documentation from goal_src docstrings, think doxygen/java-docs/rust docs/etc. It mostly supports everything already, but here are the following things that aren't yet complete: - file descriptions - high-level documentation to go along with this (think pure markdown docs describing overall systems that would be co-located in goal_src for organizational purposes) - enums - states - std-lib functions (all have empty strings right now for docs anyway) The job of the new `gen-docs` function is solely to generate a bunch of JSON data which should give you everything you need to generate some decent documentation (outputting markdown/html/pdf/etc). It is not it's responsibility to do that nice formatting -- this is by design to intentionally delegate that responsibility elsewhere. Side-note, this is about 12-15MB of minified json for jak 2 so far :) In our normal "goal_src has changed" action -- we will generate this data, and the website can download it -- use the information to generate the documentation at build time -- and it will be included in the site. Likewise, if we wanted to include docs along with releases for offline viewing, we could do so in a similar fashion (just write a formatting script to generate said documentation). Lastly this work somewhat paves the way for doing more interesting things in the LSP like: - whats the docstring for this symbol? - autocompleting function arguments - type checking function arguments - where is this symbol defined? - etc Fixes #2215
97 lines
2.5 KiB
C++
97 lines
2.5 KiB
C++
#include "string_util.h"
|
|
|
|
#include <regex>
|
|
|
|
#include "common/util/diff.h"
|
|
|
|
namespace str_util {
|
|
|
|
const std::string WHITESPACE = " \n\r\t\f\v";
|
|
|
|
bool contains(const std::string& s, const std::string& substr) {
|
|
return s.find(substr) != std::string::npos;
|
|
}
|
|
|
|
bool starts_with(const std::string& s, const std::string& prefix) {
|
|
return s.size() >= prefix.size() && 0 == s.compare(0, prefix.size(), prefix);
|
|
}
|
|
|
|
bool ends_with(const std::string& s, const std::string& suffix) {
|
|
return s.size() >= suffix.size() &&
|
|
0 == s.compare(s.size() - suffix.size(), suffix.size(), suffix);
|
|
}
|
|
|
|
std::string ltrim(const std::string& s) {
|
|
size_t start = s.find_first_not_of(WHITESPACE);
|
|
return (start == std::string::npos) ? "" : s.substr(start);
|
|
}
|
|
|
|
std::string rtrim(const std::string& s) {
|
|
size_t end = s.find_last_not_of(WHITESPACE);
|
|
return (end == std::string::npos) ? "" : s.substr(0, end + 1);
|
|
}
|
|
|
|
std::string trim(const std::string& s) {
|
|
return rtrim(ltrim(s));
|
|
}
|
|
|
|
std::string trim_newline_indents(const std::string& s) {
|
|
auto lines = split(s, '\n');
|
|
std::vector<std::string> trimmed_lines;
|
|
std::transform(lines.begin(), lines.end(), std::back_inserter(trimmed_lines),
|
|
[](const std::string& line) { return ltrim(line); });
|
|
return join(trimmed_lines, "\n");
|
|
}
|
|
|
|
std::string join(const std::vector<std::string>& strs, const std::string& join_with) {
|
|
std::string out;
|
|
for (size_t i = 0; i < strs.size(); i++) {
|
|
out += strs.at(i);
|
|
if (i < strs.size() - 1) {
|
|
out += join_with;
|
|
}
|
|
}
|
|
return out;
|
|
}
|
|
|
|
int line_count(const std::string& str) {
|
|
int result = 0;
|
|
for (auto& c : str) {
|
|
if (c == '\n') {
|
|
result++;
|
|
}
|
|
}
|
|
return result;
|
|
}
|
|
|
|
// NOTE - this won't work running within gk.exe!
|
|
bool valid_regex(const std::string& regex) {
|
|
try {
|
|
std::regex re(regex);
|
|
} catch (const std::regex_error& e) {
|
|
return false;
|
|
}
|
|
return true;
|
|
}
|
|
|
|
std::string diff(const std::string& lhs, const std::string& rhs) {
|
|
return google_diff::diff_strings(lhs, rhs);
|
|
}
|
|
/// Default splits on \n characters
|
|
std::vector<std::string> split(const ::std::string& str, char delimiter) {
|
|
return google_diff::split_string(str, delimiter);
|
|
}
|
|
|
|
std::vector<std::string> regex_get_capture_groups(const std::string& str,
|
|
const std::string& regex) {
|
|
std::vector<std::string> groups;
|
|
std::smatch matches;
|
|
if (std::regex_search(str, matches, std::regex(regex))) {
|
|
for (size_t i = 1; i < matches.size(); i++) {
|
|
groups.push_back(matches[i].str());
|
|
}
|
|
}
|
|
return groups;
|
|
}
|
|
} // namespace str_util
|