Enumerations | Functions | Variables

addon/validation.hpp File Reference

#include <vector>
#include <string>
Include dependency graph for validation.hpp:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Enumerations

enum  ADDON_TYPE {
  ADDON_UNKNOWN, ADDON_SP_CAMPAIGN, ADDON_SP_SCENARIO, ADDON_MP_CAMPAIGN,
  ADDON_MP_SCENARIO, ADDON_MP_MAPS, ADDON_MP_ERA, ADDON_MP_FACTION,
  ADDON_MEDIA, ADDON_OTHER, ADDON_TYPES_COUNT
}
 

Values used for add-on classification; UI-only at the moment, in the future it could be used for directory allocation too, removing the need for the ADDON_GROUP constants (TODO).

More...

Functions

ADDON_TYPE get_addon_type (const std::string &str)
std::string get_addon_type_string (ADDON_TYPE type)
bool addon_name_legal (const std::string &name)
 Checks whether an add-on name is legal or not.
bool check_names_legal (const config &dir)
 Probes an add-on archive for illegal names.
std::string encode_binary (const std::string &str)
std::string unencode_binary (const std::string &str)
bool needs_escaping (char c)

Variables

const unsigned short default_campaignd_port
 Default port number for the addon server.

Enumeration Type Documentation

enum ADDON_TYPE

Values used for add-on classification; UI-only at the moment, in the future it could be used for directory allocation too, removing the need for the ADDON_GROUP constants (TODO).

Note:
If you change the order or content of these, you'll also need to update the addon_type_strings table found in validation.cpp.
Enumerator:
ADDON_UNKNOWN 

a.k.a.

anything.

ADDON_SP_CAMPAIGN 

Single-player campaign.

ADDON_SP_SCENARIO 

Single-player scenario.

ADDON_MP_CAMPAIGN 

Multiplayer campaign.

ADDON_MP_SCENARIO 

Multiplayer scenario.

ADDON_MP_MAPS 

Multiplayer plain (no WML) map pack.

ADDON_MP_ERA 

Multiplayer era.

ADDON_MP_FACTION 

Multiplayer faction.

ADDON_MEDIA 

Miscellaneous content/media (unit packs, terrain packs, music packs, etc.

).

ADDON_OTHER 

an add-on that fits in no other category

ADDON_TYPES_COUNT 

Definition at line 42 of file validation.hpp.


Function Documentation

bool addon_name_legal ( const std::string &  name  ) 

Checks whether an add-on name is legal or not.

Definition at line 32 of file validation.cpp.

Referenced by BOOST_AUTO_TEST_CASE(), and check_names_legal().

Here is the caller graph for this function:

bool check_names_legal ( const config dir  ) 

Probes an add-on archive for illegal names.

Definition at line 43 of file validation.cpp.

References addon_name_legal(), check_names_legal(), config::child_range(), and game_config::path.

Referenced by check_names_legal(), and addons_client::install_addon().

Here is the call graph for this function:

Here is the caller graph for this function:

std::string encode_binary ( const std::string &  str  ) 

Definition at line 93 of file validation.cpp.

References needs_escaping().

Referenced by archive_file().

Here is the call graph for this function:

Here is the caller graph for this function:

ADDON_TYPE get_addon_type ( const std::string &  str  ) 

Definition at line 55 of file validation.cpp.

References ADDON_TYPES_COUNT, and ADDON_UNKNOWN.

Referenced by addon_info::read().

Here is the caller graph for this function:

std::string get_addon_type_string ( ADDON_TYPE  type  ) 

Definition at line 71 of file validation.cpp.

References ADDON_TYPES_COUNT.

Referenced by addon_info::write(), and addon_info::write_minimal().

Here is the caller graph for this function:

bool needs_escaping ( char  c  ) 

Definition at line 81 of file validation.cpp.

Referenced by encode_binary().

Here is the caller graph for this function:

std::string unencode_binary ( const std::string &  str  ) 

Definition at line 111 of file validation.cpp.

Referenced by unarchive_file().

Here is the caller graph for this function:


Variable Documentation

const unsigned short default_campaignd_port

Default port number for the addon server.

Note:
This might not be the best place to declare the variable, but it's one of the few files shared by the server and the game.

Definition at line 22 of file validation.cpp.

Referenced by addons_client::addons_client().

 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines

Generated by doxygen 1.7.1 on Fri May 25 2012 01:03:36 for The Battle for Wesnoth
Gna! | Forum | Wiki | CIA | devdocs