Program Listing for File namegen.hpp

↰ Return to documentation for file (libtcod/namegen.hpp)

/* BSD 3-Clause License
 *
 * Copyright © 2008-2025, Jice and the libtcod contributors.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 *
 * 3. Neither the name of the copyright holder nor the names of its
 *    contributors may be used to endorse or promote products derived from
 *    this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */
// clang-format off
/*
* Mingos' NameGen
* This file was written by Dominik "Mingos" Marczuk.
*/
#pragma once
#ifndef TCOD_NAMEGEN_HPP_
#define TCOD_NAMEGEN_HPP_

#include <string>

#include "list.hpp"
#include "mersenne.hpp"
#include "namegen.h"
class TCODLIB_API TCODNamegen {
  public:
    static void parse (const char * filename, TCODRandom * random = NULL);

    static void destroy (void);

    [[deprecated("This overload is deprecated, be sure to pass in const strings.")]]
    static char * generate (char * name, bool allocate = false);
    static std::string generate (const char * name, bool allocate = false);

    [[deprecated("This overload is deprecated, be sure to pass in const strings.")]]
    static char * generateCustom (char * name, char * rule, bool allocate = false);
    static std::string generateCustom (const char * name, const char * rule, bool allocate = false);

    static TCOD_list_t getSets (void);

};

#endif // TCOD_NAMEGEN_HPP_