gettext.hpp

Go to the documentation of this file.

/*
    Copyright (C) 2003 - 2025
    by David White <dave@whitevine.net>
    Part of the Battle for Wesnoth Project https://www.wesnoth.org/
 
    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.
    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY.
 
    See the COPYING file for more details.
*/
 
#pragma once
 
/**
 * How to use gettext for wesnoth source files:
 * -# include this header file in the .cpp file
 * -# make sure, that the source file is listed in the respective POTFILES.in
 *    for the textdomain, in the case of wesnoth-lib it is this file:
 *    po/wesnoth-lib/POTFILES.in
 * -# add the following include to set the correct textdomain, in this example
 *    wesnoth-lib (not required for the domain 'wesnoth', required for all
 *    other textdomains).
 *    @code
 *    #define GETTEXT_DOMAIN "wesnoth-lib"
 *    @endcode
 *
 * This should be all that is required to have your strings that are marked
 * translatable in the po files and translated ingame. So you at least have
 * to mark the strings translatable, too. ;)
 */
 
// gettext-related declarations
#include "wesconfig.h"
#include <string>
#include <vector>
#include <ctime>
#include <boost/locale/info.hpp>
 
#include "utils/span.hpp"
 
#ifndef GETTEXT_DOMAIN
# define GETTEXT_DOMAIN PACKAGE
#endif
 
//A Hack to make the eclipse-cdt parser happy.
#ifdef __CDT_PARSER__
# define GETTEXT_DOMAIN ""
#endif
 
namespace translation
{
    std::string dgettext(const char* domain, const char* msgid);
    std::string egettext(const char*);
    std::string dsgettext(const char * domainname, const char *msgid);
    //const char* sngettext(const char *singular, const char *plural, int n);
    std::string dsngettext(const char * domainname, const char *singular, const char *plural, int n);
 
    [[maybe_unused]] inline static std::string gettext(const char* str)
    { return translation::dgettext(GETTEXT_DOMAIN, str); }
    [[maybe_unused]] inline static std::string sgettext(const char* str)
    { return translation::dsgettext(GETTEXT_DOMAIN, str); }
    [[maybe_unused]] inline static std::string sngettext(const char* str1, const char* str2, int n)
    { return translation::dsngettext(GETTEXT_DOMAIN, str1, str2 , n); }
 
 
    void bind_textdomain(const char* domain, const char* directory, const char* encoding);
    void set_default_textdomain(const char* domain);
 
    void set_language(const std::string& language, const std::vector<std::string>* alternates);
 
    /** Case-sensitive lexicographical comparison. */
    int compare(const std::string& s1,const std::string& s2);
 
    /** Case-insensitive lexicographical comparison. */
    int icompare(const std::string& s1,const std::string& s2);
 
    /** Case-insensitive search. @a s2 will be checked against @a s1. */
    bool ci_search(const std::string& s1, const std::string& s2);
 
    /** Case-insensitive search. @a s2 will be checked against any element of @a s1. */
    bool ci_search(utils::span<const std::string> s1, const std::string& s2);
 
    /**
     * A facet that holds general information about the effective locale.
     * This describes the actual translation target language,
     * unlike language_def.localename in language.hpp, where the "System
     * default language" is represented by an empty string.
     */
    const boost::locale::info& get_effective_locale_info();
 
    /** Translates the passed timestamp and returns it in the requested format. */
    std::string translate_timestamp(time_t time, std::string_view format = "%F %T");
}
 
//#define _(String) translation::dsgettext(GETTEXT_DOMAIN,String)
[[maybe_unused]] inline static std::string _(const char* str)
{ return translation::dsgettext(GETTEXT_DOMAIN, str); }
 
//#define _n(String1, String2, Int) translation::dsngettext(GETTEXT_DOMAIN, String1,String2,Int)
[[maybe_unused]] inline static std::string _n(const char* str1, const char* str2, int n)
{ return translation::dsngettext(GETTEXT_DOMAIN, str1, str2, n); }
 
#define gettext_noop(String) String
#define N_(String) gettext_noop (String)
#define N_n(String1, String2) String1, String2