addon_utils.hpp

Go to the documentation of this file.

/*
   Copyright (C) 2003 - 2016 by David White <[email protected]>
                 2013 - 2015 by Ignacio Riquelme Morelle <[email protected]>
   Part of the Battle for Wesnoth Project http://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.
*/

#ifndef CAMPAIGN_SERVER_ADDON_UTILS_HPP_INCLUDED
#define CAMPAIGN_SERVER_ADDON_UTILS_HPP_INCLUDED

#include <string>

class config;

namespace campaignd {

/**
 * Markup characters recognized by GUI1 code.
 *
 * These must be the same as the constants defined in marked-up_text.cpp.
 */
extern const std::string illegal_markup_chars;

inline bool is_text_markup_char(char c)
{
    return illegal_markup_chars.find(c) != std::string::npos;
}

/**
 * Format a feedback URL for an add-on.
 *
 * @param format        The format string for the URL, presumably obtained
 *                      from the add-ons server identification.
 *
 * @param params        The URL format parameters table.
 *
 * @return A string containing a feedback URL or an empty string if that
 *         is not possible (e.g. empty or invalid @a format, empty
 *         @a params table, or a result that is identical in content to
 *         the @a format suggesting that the @a params table contains
 *         incorrect data).
 */
std::string format_addon_feedback_url(const std::string& format, const config& params);


/**
 * Scans an add-on archive directory for translations.
 *
 * Any subdirectories of @a base_dir containing a subdirectory named
 * 'LC_MESSAGES' are assumed to be translation dirs. The names of the
 * subdirectories thus located are recorded into the @a addon WML node in
 * [translation] children nodes like the following (comments included for
 * documentation purposes):
 *
 * @verbatim
 *     [translation]
 *         language="es" # translations/es/LC_MESSAGES/
 *     [/translation]
 *     [translation]
 *         language="ja" # translations/ja/LC_MESSAGES/
 *     [/translation]
 * @endverbatim
 */
void find_translations(const config& base_dir, config& addon);

/**
 * Adds a COPYING.txt file with the full text of the GNU GPL to an add-on.
 *
 * This only has an effect if the add-on archive @a cfg does not already
 * contain an equivalent file ('copying.txt', 'COPYING', etc.).
 */
void add_license(config& cfg);

}

#endif