ORE Studio 0.0.4
Loading...
Searching...
No Matches
short_code_generator.hpp
1/* -*- mode: c++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
2 *
3 * Copyright (C) 2026 Marco Craveiro <marco.craveiro@gmail.com>
4 *
5 * This program is free software; you can redistribute it and/or modify it under
6 * the terms of the GNU General Public License as published by the Free Software
7 * Foundation; either version 3 of the License, or (at your option) any later
8 * version.
9 *
10 * This program is distributed in the hope that it will be useful, but WITHOUT
11 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
12 * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
13 * details.
14 *
15 * You should have received a copy of the GNU General Public License along with
16 * this program; if not, write to the Free Software Foundation, Inc., 51
17 * Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 *
19 */
20#ifndef ORES_UTILITY_STRING_SHORT_CODE_GENERATOR_HPP
21#define ORES_UTILITY_STRING_SHORT_CODE_GENERATOR_HPP
22
23#include <string>
24#include <unordered_set>
25
26namespace ores::utility::string {
27
35std::string strip_corporate_suffixes(const std::string& name);
36
48std::string generate_short_code(const std::string& name);
49
57std::string generate_unique_short_code(const std::string& name,
58 std::unordered_set<std::string>& used_codes);
59
60}
61
62#endif
String manipulation utilities.
Definition conversion_error.hpp:26
std::string generate_unique_short_code(const std::string &name, std::unordered_set< std::string > &used_codes)
Generates a unique short code, appending numeric suffixes on collision.
Definition short_code_generator.cpp:145
std::string strip_corporate_suffixes(const std::string &name)
Strips corporate/legal suffixes from an entity name.
Definition short_code_generator.cpp:52
std::string generate_short_code(const std::string &name)
Generates a 3-6 character mnemonic short code from an entity name.
Definition short_code_generator.cpp:75