Constants.h

// Copyright 2023 - 2025, University of Freiburg,
// Chair of Algorithms and Data Structures.
// Authors: Björn Buchhold <buchhold@gmail.com> [2014 - 2017]
//          Johannes Kalmbach <kalmbach@cs.uni-freiburg.de>
//          Hannah Bast <bast@cs.uni-freiburg.de>

#pragma once

#include <chrono>
#include <stdexcept>
#include <string>
#include <string_view>

#include "util/MemorySize/MemorySize.h"
#include "util/StringUtils.h"

// For access to `memorySize` literals.
using namespace ad_utility::memory_literals;

constexpr inline ad_utility::MemorySize DEFAULT_MEMORY_LIMIT_INDEX_BUILDING =
    5_GB;
constexpr inline ad_utility::MemorySize STXXL_DISK_SIZE_INDEX_BUILDER = 1_GB;
constexpr inline ad_utility::MemorySize DEFAULT_PARSER_BUFFER_SIZE = 10_MB;

constexpr inline ad_utility::MemorySize DEFAULT_MEM_FOR_QUERIES = 4_GB;

constexpr inline uint64_t MAX_NOF_ROWS_IN_RESULT = 1'000'000;
constexpr inline size_t MIN_WORD_PREFIX_SIZE = 4;
constexpr inline char PREFIX_CHAR = '*';

constexpr inline size_t BUFFER_SIZE_DOCSFILE_LINE = 100'000'000;

constexpr inline size_t TEXT_PREDICATE_CARDINALITY_ESTIMATE = 1'000'000'000;

constexpr inline size_t GALLOP_THRESHOLD = 1000;

constexpr inline char QLEVER_INTERNAL_PREFIX_NAME[] = "ql";
constexpr inline char QLEVER_INTERNAL_PREFIX_URL[] =
    "http://qlever.cs.uni-freiburg.de/builtin-functions/";

// Make a QLever-internal IRI from `QL_INTERNAL_PREFIX_URL` by appending the
// concatenation of the given `suffixes` and enclosing the result in angle
// brackets (const and non-const version).
template <
    ad_utility::detail::constexpr_str_cat_impl::ConstexprString... suffixes>
constexpr std::string_view makeQleverInternalIriConst() {
  return ad_utility::constexprStrCat<"<", QLEVER_INTERNAL_PREFIX_URL,
                                     suffixes..., ">">();
}
inline std::string makeQleverInternalIri(const auto&... suffixes) {
  return absl::StrCat("<", std::string_view{QLEVER_INTERNAL_PREFIX_URL},
                      suffixes..., ">");
}

constexpr inline std::string_view QLEVER_INTERNAL_PREFIX_IRI =
    makeQleverInternalIriConst<"">();
constexpr inline std::string_view
    QLEVER_INTERNAL_PREFIX_IRI_WITHOUT_CLOSING_BRACKET =
        ad_utility::constexprStrCat<"<", QLEVER_INTERNAL_PREFIX_URL>();
constexpr inline std::string_view CONTAINS_ENTITY_PREDICATE =
    makeQleverInternalIriConst<"contains-entity">();
constexpr inline std::string_view CONTAINS_WORD_PREDICATE =
    makeQleverInternalIriConst<"contains-word">();

constexpr inline std::string_view QLEVER_INTERNAL_TEXT_MATCH_PREDICATE =
    makeQleverInternalIriConst<"text">();
constexpr inline std::string_view HAS_PREDICATE_PREDICATE =
    makeQleverInternalIriConst<"has-predicate">();
constexpr inline std::string_view HAS_PATTERN_PREDICATE =
    makeQleverInternalIriConst<"has-pattern">();
constexpr inline std::string_view DEFAULT_GRAPH_IRI =
    makeQleverInternalIriConst<"default-graph">();
constexpr inline std::string_view QLEVER_INTERNAL_GRAPH_IRI =
    makeQleverInternalIriConst<"internal-graph">();

constexpr inline std::pair<std::string_view, std::string_view> GEOF_PREFIX = {
    "geof:", "http://www.opengis.net/def/function/geosparql/"};
constexpr inline std::pair<std::string_view, std::string_view> MATH_PREFIX = {
    "math:", "http://www.w3.org/2005/xpath-functions/math#"};
constexpr inline std::pair<std::string_view, std::string_view> XSD_PREFIX = {
    "xsd", "http://www.w3.org/2001/XMLSchema#"};
constexpr inline std::pair<std::string_view, std::string_view> QL_PREFIX = {
    QLEVER_INTERNAL_PREFIX_NAME, QLEVER_INTERNAL_PREFIX_URL};

constexpr inline std::string_view QLEVER_INTERNAL_VARIABLE_PREFIX =
    "?_QLever_internal_variable_";

constexpr inline std::string_view QLEVER_INTERNAL_BLANKNODE_VARIABLE_PREFIX =
    "?_QLever_internal_variable_bn_";

constexpr inline std::string_view
    QLEVER_INTERNAL_VARIABLE_QUERY_PLANNER_PREFIX =
        "?_QLever_internal_variable_qp_";

constexpr inline std::string_view SCORE_VARIABLE_PREFIX = "?ql_score_";
constexpr inline std::string_view MATCHINGWORD_VARIABLE_PREFIX =
    "?ql_matchingword_";

constexpr inline std::string_view LANGUAGE_PREDICATE =
    makeQleverInternalIriConst<"langtag">();

// TODO<joka921> Move them to their own file, make them strings, remove
// duplications, etc.
constexpr inline char XSD_STRING[] = "http://www.w3.org/2001/XMLSchema#string";
constexpr inline char XSD_DATETIME_TYPE[] =
    "http://www.w3.org/2001/XMLSchema#dateTime";
constexpr inline char XSD_DATE_TYPE[] = "http://www.w3.org/2001/XMLSchema#date";
constexpr inline char XSD_GYEAR_TYPE[] =
    "http://www.w3.org/2001/XMLSchema#gYear";
constexpr inline char XSD_GYEARMONTH_TYPE[] =
    "http://www.w3.org/2001/XMLSchema#gYearMonth";
constexpr inline char XSD_DAYTIME_DURATION_TYPE[] =
    "http://www.w3.org/2001/XMLSchema#dayTimeDuration";

constexpr inline char XSD_INT_TYPE[] = "http://www.w3.org/2001/XMLSchema#int";
constexpr inline char XSD_INTEGER_TYPE[] =
    "http://www.w3.org/2001/XMLSchema#integer";
constexpr inline char XSD_FLOAT_TYPE[] =
    "http://www.w3.org/2001/XMLSchema#float";
constexpr inline char XSD_DOUBLE_TYPE[] =
    "http://www.w3.org/2001/XMLSchema#double";
constexpr inline char XSD_DECIMAL_TYPE[] =
    "http://www.w3.org/2001/XMLSchema#decimal";

constexpr inline char XSD_NON_POSITIVE_INTEGER_TYPE[] =
    "http://www.w3.org/2001/XMLSchema#nonPositiveInteger";
constexpr inline char XSD_NEGATIVE_INTEGER_TYPE[] =
    "http://www.w3.org/2001/XMLSchema#negativeInteger";
constexpr inline char XSD_LONG_TYPE[] = "http://www.w3.org/2001/XMLSchema#long";
constexpr inline char XSD_SHORT_TYPE[] =
    "http://www.w3.org/2001/XMLSchema#short";
constexpr inline char XSD_BYTE_TYPE[] = "http://www.w3.org/2001/XMLSchema#byte";
constexpr inline char XSD_NON_NEGATIVE_INTEGER_TYPE[] =
    "http://www.w3.org/2001/XMLSchema#nonNegativeInteger";
constexpr inline char XSD_UNSIGNED_LONG_TYPE[] =
    "http://www.w3.org/2001/XMLSchema#unsignedLong";
constexpr inline char XSD_UNSIGNED_INT_TYPE[] =
    "http://www.w3.org/2001/XMLSchema#unsignedInt";
constexpr inline char XSD_UNSIGNED_SHORT_TYPE[] =
    "http://www.w3.org/2001/XMLSchema#unsignedShort";
constexpr inline char XSD_POSITIVE_INTEGER_TYPE[] =
    "http://www.w3.org/2001/XMLSchema#positiveInteger";
constexpr inline char XSD_BOOLEAN_TYPE[] =
    "http://www.w3.org/2001/XMLSchema#boolean";
constexpr inline char RDF_PREFIX[] =
    "http://www.w3.org/1999/02/22-rdf-syntax-ns#";
constexpr inline char RDF_LANGTAG_STRING[] =
    "http://www.w3.org/1999/02/22-rdf-syntax-ns#langString";

constexpr inline char GEO_WKT_LITERAL[] =
    "http://www.opengis.net/ont/geosparql#wktLiteral";

constexpr inline std::string_view VOCAB_SUFFIX = ".vocabulary";
constexpr inline std::string_view MMAP_FILE_SUFFIX = ".meta";
constexpr inline std::string_view CONFIGURATION_FILE = ".meta-data.json";

constexpr inline std::string_view ERROR_IGNORE_CASE_UNSUPPORTED =
    "Key \"ignore-case\" is no longer supported. Please remove this key from "
    "your settings.json and rebuild your index. You can optionally specify the "
    "\"locale\" key, otherwise \"en.US\" will be used as default";
constexpr inline std::string_view WARNING_ASCII_ONLY_PREFIXES =
    "You specified \"ascii-prefixes-only = true\", which enables faster "
    "parsing for well-behaved TTL files";
// " but only works correctly if there are no escape sequences in "
// "prefixed names (e.g., rdfs:label\\,el is not allowed), no multiline "
// "literals, and the regex \". *\\n\" only matches at the end of a triple. "
// "Most Turtle files fulfill these properties (e.g. that from Wikidata), "
// "but not all";

constexpr inline std::string_view WARNING_PARALLEL_PARSING =
    "You specified \"parallel-parsing = true\", which enables faster parsing "
    "for TTL files with a well-behaved use of newlines";
constexpr inline std::string_view LOCALE_DEFAULT_LANG = "en";
constexpr inline std::string_view LOCALE_DEFAULT_COUNTRY = "US";
constexpr inline bool LOCALE_DEFAULT_IGNORE_PUNCTUATION = false;

// Constants for the range of valid compression prefixes
// all ASCII- printable characters are left out.
// when adding more special characters to the vocabulary make sure to leave out
// \n since the vocabulary is stored in a text file line by line.
// All prefix codes have a most significant bit of 1. This means the prefix
// codes are never valid UTF-8 and thus it is always able to determine, whether
// this vocabulary was compressed or not.
constexpr inline uint8_t MIN_COMPRESSION_PREFIX = 129;
constexpr inline uint8_t NUM_COMPRESSION_PREFIXES = 126;
// if this is the first character of a compressed string, this means that no
// compression has been applied to  a word
constexpr inline uint8_t NO_PREFIX_CHAR =
    MIN_COMPRESSION_PREFIX + NUM_COMPRESSION_PREFIXES;

// When initializing a sort performance estimator, at most this percentage of
// the number of triples in the index is being sorted at once.
constexpr inline size_t PERCENTAGE_OF_TRIPLES_FOR_SORT_ESTIMATE = 5;

// When asked to make room for X ids in the cache, actually make room for X
// times this factor.
constexpr inline size_t MAKE_ROOM_SLACK_FACTOR = 2;

// The maximal number of columns an `IdTable` (an intermediate result of
// query evaluation) may have to be able to use the more efficient `static`
// implementation (For details see `IdTable.h`, `CallFixedSize.h` and the
// usage of `CALL_FIXED_SIZE` in the various subclasses of `Operation`.
// Increasing this number improves the runtime for operations on tables with
// more columns, but also increases compile times because more templates
// have to be instantiated. It might also be necessary to increase some internal
// compiler limits for the evaluation of constexpr functions and templates.
constexpr inline int DEFAULT_MAX_NUM_COLUMNS_STATIC_ID_TABLE = 5;

// Interval in which an enabled watchdog would check if
// `CancellationHandle::throwIfCancelled` is called regularly.
constexpr inline std::chrono::milliseconds DESIRED_CANCELLATION_CHECK_INTERVAL{
    50};

// In all permutations, the graph ID of the triple is stored as the fourth
// entry. During the index building it is important that this is the first
// column after the "actual" triple.
constexpr inline size_t ADDITIONAL_COLUMN_GRAPH_ID = 3;

// In the PSO and PSO permutations the patterns of the subject and object are
// stored at the following indices. Note that the col0 (the P) is not part of
// the result, so the column order for PSO is S O PatternS PatternO.
constexpr inline size_t ADDITIONAL_COLUMN_INDEX_SUBJECT_PATTERN = 4;
constexpr inline size_t ADDITIONAL_COLUMN_INDEX_OBJECT_PATTERN = 5;

#ifdef _PARALLEL_SORT
constexpr inline bool USE_PARALLEL_SORT = true;
#include <parallel/algorithm>
namespace ad_utility {
template <typename... Args>
auto parallel_sort(Args&&... args) {
  return __gnu_parallel::sort(std::forward<Args>(args)...);
}
using parallel_tag = __gnu_parallel::parallel_tag;

}  // namespace ad_utility

#else
constexpr inline bool USE_PARALLEL_SORT = false;
namespace ad_utility {
template <typename... Args>
auto parallel_sort([[maybe_unused]] Args&&... args) {
  throw std::runtime_error(
      "Triggered the parallel sort although it was disabled. Please report to "
      "the developers!");
}
using parallel_tag = int;
}  // namespace ad_utility
#endif
constexpr inline size_t NUM_SORT_THREADS = 4;
/// ANSI escape sequence for bold text in the console
constexpr inline std::string_view EMPH_ON = "\033[1m";
/// ANSI escape sequence to print "normal" text again in the console.
constexpr inline std::string_view EMPH_OFF = "\033[22m";

// Allowed range for geographical coordinates from WTK Text
constexpr inline double COORDINATE_LAT_MAX = 90.0;
constexpr inline double COORDINATE_LNG_MAX = 180.0;