Fonctions membres publiques | Fonctions membres publiques statiques

# Référence de la classe USpeedGameEngine::Tools

Classe d'outils pour lire différents fichiers. Plus de détails...

Liste de tous les membres

## Fonctions membres publiques

| ~Tools ()
| Destructeur par défaut.

## Fonctions membres publiques statiques

static void | splitString (std::string const &myString, std::string const &separator, std::vector< std::string > &target)
| Découpe la chaîne spécifiée avec le séparateur fourni et retourne une liste de "string".
static void | replaceString (std::string const &myString, std::string const &from, std::string const &to, std::string &target)
| Remplace une chaîne par une autre dans la chaîne fournie vers une nouvelle chaîne.
static void | replaceString (std::string &myString, std::string const &from, std::string const &to)
| Remplace une chaîne par une autre dans la chaîne fournie.
static void | stringToLower (std::string &myString)
| Convertit la chaîne en minucules.
static void | stringToUpper (std::string &myString)
| Convertit la chaîne en majuscules.
static void | stringAlphaOnly (std::string &myString)
| Retire tous les accents des lettres (majuscules et minuscules).
static bool | toBase64 (std::string const &toEncode, std::string &target)
| Encode les données spécifiées en base 64.
static bool | toBase64 (std::string &toEncode)
| Encode les données spécifiées en base 64.
static bool | fromBase64 (std::string const &toDecode, std::string &target)
| Décode les données spécifiées en base 64 vers le tampon spécifié.
static bool | fromBase64 (std::string &toDecode)
| Décode les données spécifiées en base 64.
static void | numberToBase64 (unsigned long int number, std::string &target)
| Transforme le nombre spécifié de la base 10 à la base 64.
static unsigned long int | numberFromBase64 (std::string const &number)
| Transforme le nombre spécifié de la base 64 à la base 10.
static bool | zip (std::string const &toCompress, std::string &compressed)
| Compresser les données spécifiées vers le tampon spécifié.
static bool | zip (std::string &toCompress)
| Compresser les données spécifiées.
static bool | unzip (std::string const &toUncompress, std::string &uncompressed)
| Décompresser les données spécifiées vers le tampon spécifié avec un tampon de taille par défaut mis à 500Ko.
static bool | unzip (std::string &toUncompress)
| Décompresser les données spécifiées avec un tampon de décompression de taille par défaut mis à 500Ko.
static bool | toAES (std::string const &toCrypt, std::string const &key, std::string &target)
| Crypte les données AES spécifiées avec la clé fournie vers le tampon spécifié.
static bool | toAES (std::string &toCrypt, std::string const &key)
| Crypte les données AES spécifiées avec la clé fournie.
static bool | fromAES (std::string const &toDecrypt, std::string const &key, std::string &target)
| Décrypte les données AES spécifiées avec la clé fournie vers le tampon spécifié.
static bool | fromAES (std::string &toDecrypt, std::string const &key)
| Décrypte les données AES spécifiées avec la clé fournie.
static void | tableFromIni (std::string const &iniInfos, std::map< std::string, std::string > &target)
| Lecture du fichier INI (sous forme de chaîne) vers un tableau de données (donnees[cle] = valeur).
static void | iniFromTable (std::map< std::string, std::string > &table, std::string &target)
| Retourne une chaîne structurée comme un fichier INI depuis un tableau de données (table[cle] = valeur).
static void | stringToIniFormat (std::string const &myString, std::string &target)
| Convertie la chaîne spécifiée au format nécéssaire pour les fichiers INI du système.
static void | stringToIniFormat (std::string &myString)
| Convertie la chaîne spécifiée au format nécéssaire pour les fichiers INI du système.
static void | stringFromIniFormat (std::string const &myString, std::string &target)
| Convertie la chaîne spécifiée depuis le format nécéssaire pour les fichiers INI du système vers le format initial (de la source vers le tampon de destination fourni).
static void | stringFromIniFormat (std::string &myString)
| Convertie la chaîne spécifiée depuis le format nécéssaire pour les fichiers INI du système vers le format initial.
static bool | nextPartOfFile (FILE *file, std::string &buffer, unsigned long int &fileSize)
| Récupère la partie suivante du fichier spécifié.
static bool | md5 (std::string const &toEncode, std::string &target, bool shortMD5)
| Encode les données spécifiées en md5 vers le tampon spécifié.
static bool | md5 (std::string &toEncode, bool shortMD5)
| Encode les données spécifiées en md5.
static void | sha256 (std::string const &toHash, std::string &target)
| Calcul de la signature SHA-256 des données fournies vers le tampon spécifié.
static void | sha512 (std::string const &toHash, std::string &target)
| Calcul de la signature SHA-512 des données fournies vers le tampon spécifié.
static unsigned long int | crc32 (std::string const &data)
| Calcul de la signature CRC-32 (Cyclic Redundance Check) : Contrôle de Redondance Cyclique sur 32 bits.
static bool | toHexa (std::string const &toEncode, std::string &target)
| Convertit le tableau d'octets en hexadécimal vers le tampon spécifié.
static bool | toHexa (std::string &toEncode)
| Convertit le tableau d'octets en hexadécimal.
static unsigned long int | fromHexa (std::string const &toDecode)
| Convertit le tableau d'octets en hexadécimal en valeur numérique.

## Description détaillée

Classe d'outils pour lire différents fichiers.

Auteur:
  U.Speed

## Documentation des constructeurs et destructeur

Tools::~Tools | ( |  | ) |

Destructeur par défaut.

Auteur:
  U.Speed

## Documentation des fonctions membres

unsigned long int Tools::crc32 | ( | std::string const & | data | ) | `[static]`

Calcul de la signature CRC-32 (Cyclic Redundance Check) : Contrôle de Redondance Cyclique sur 32 bits.

Auteur:
  U.Speed

Paramètres:

  | data | std::string const& data : données à traiter pour le calcul du CRC32

Renvoie:
  unsigned long int : la signature 32 bits

bool Tools::fromAES | ( | std::string const & | toDecrypt,
|  | std::string const & | key,
|  | std::string & | target |
| ) |  |  | `[static]`

Décrypte les données AES spécifiées avec la clé fournie vers le tampon spécifié.

Auteur:
  U.Speed

Paramètres:

  | toDecrypt | std::string const& : les données à décrypter
  | key | std::string const& : la clé de décryptage
  | target | std::string& : le résultat du décryptage

Renvoie:
  bool : l'état du décryptage
  - true : décryptage réussie
  - false : échec

bool Tools::fromAES | ( | std::string & | toDecrypt,
|  | std::string const & | key |
| ) |  |  | `[static]`

Décrypte les données AES spécifiées avec la clé fournie.

Auteur:
  U.Speed

Paramètres:

  | toDecrypt | std::string& : les données à décrypter
  | key | std::string const& : la clé de décryptage

Renvoie:
  bool : l'état du décryptage
  - true : décryptage réussie
  - false : échec

bool Tools::fromBase64 | ( | std::string & | toDecode | ) | `[static]`

Décode les données spécifiées en base 64.

Auteur:
  U.Speed

Voir également:
  bool Tools::fromBase64(std::string const &toDecode, std::string &target)

Paramètres:

  | toDecode | std::string& : les données à decoder en base 64

Renvoie:
  bool : l'état de la conversion
  - true : Conversion réussie
  - false : échec

bool Tools::fromBase64 | ( | std::string const & | toDecode,
|  | std::string & | target |
| ) |  |  | `[static]`

Décode les données spécifiées en base 64 vers le tampon spécifié.

Auteur:
  U.Speed

Paramètres:

  | toDecode | std::string const& : les données à decoder en base 64
  | target | std::string& : le résultat de l'encodage en base 64

Renvoie:
  bool : l'état de la conversion
  - true : Conversion réussie
  - false : échec

unsigned long int Tools::fromHexa | ( | std::string const & | toDecode | ) | `[static]`

Convertit le tableau d'octets en hexadécimal en valeur numérique.

Cette fonction prend les 8 premiers caractères de la chaîne.

Auteur:
  U.Speed

Paramètres:

  | toDecode | std::string const& : les données à décoder depuis l'hexadécimal

Renvoie:
  unsigned long int : la valeur ou 0

void Tools::iniFromTable | ( | std::map< std::string, std::string > & | table,
|  | std::string & | target |
| ) |  |  | `[static]`

Retourne une chaîne structurée comme un fichier INI depuis un tableau de données (table[cle] = valeur).

Auteur:
  U.Speed

Paramètres:

  | table | std::map<std::string, std::string>& : le tableau de données
  | target | std::string& : les données en fichier INI

bool Tools::md5 | ( | std::string const & | toEncode,
|  | std::string & | target,
|  | bool | shortMD5 |
| ) |  |  | `[static]`

Encode les données spécifiées en md5 vers le tampon spécifié.

Auteur:
  U.Speed

Voir également:
  bool Tools::md5(std::string const &toEncode, bool shortMD5)

Paramètres:

  | toEncode | std::string const& : les données à encoder en md5
  | target | std::string& : le résultat de l'encodage en md5
  | shortMD5 | bool : calcul de la signature en 128 bits ?
  - true : signature courte en 128 bits
  - false : signature longue en 256 bits

Renvoie:
  bool : l'état de la conversion
  - true : Conversion réussie
  - false : échec

bool Tools::md5 | ( | std::string & | toEncode,
|  | bool | shortMD5 |
| ) |  |  | `[static]`

Encode les données spécifiées en md5.

Auteur:
  U.Speed

Paramètres:

  | toEncode | std::string& : les données à encoder en md5
  | shortMD5 | bool : calcul de la signature en 128 bits ?
  - true : signature courte en 128 bits
  - false : signature longue en 256 bits

Renvoie:
  bool : l'état de la conversion
  - true : Conversion réussie
  - false : échec

bool Tools::nextPartOfFile | ( | FILE * | file,
|  | std::string & | buffer,
|  | unsigned long int & | fileSize |
| ) |  |  | `[static]`

Récupère la partie suivante du fichier spécifié.

Auteur:
  U.Speed

Paramètres:

  | file | FILE* : le pointeur valide du fichier à lire
  | buffer | std::string* : le tampon de lecture de destination
  | fileSize | unsigned long int* : taille du fichier pour éviter de la calculer à chaque fois (0 pour la calculer et affecter la valeur)

Renvoie:
  bool : `true` si on a réussi à lire des données qui sont alors dans "buffer"

unsigned long int Tools::numberFromBase64 | ( | std::string const & | number | ) | `[static]`

Transforme le nombre spécifié de la base 64 à la base 10.

Auteur:
  U.Speed

Paramètres:

  | number | std::string& : le nombre en base 64 à convertir en base 10

Renvoie:
  unsigned long int : le nombre converti en base 10

void Tools::numberToBase64 | ( | unsigned long int | number,
|  | std::string & | target |
| ) |  |  | `[static]`

Transforme le nombre spécifié de la base 10 à la base 64.

Auteur:
  U.Speed

Paramètres:

  | number | unsigned long int : le nombre en base 10 à convertir en base 64
  | target | std::string& : le nombre en base 64. La chaîne fait toujours 8 caractères car on code 32 bits (4 caractères)

void Tools::replaceString | ( | std::string const & | myString,
|  | std::string const & | from,
|  | std::string const & | to,
|  | std::string & | target |
| ) |  |  | `[static]`

Remplace une chaîne par une autre dans la chaîne fournie vers une nouvelle chaîne.

Auteur:
  U.Speed

Voir également:
  void Tools::replaceString(std::string &myString, std::string const &from, std::string const &to)

Paramètres:

  | myString | std::string const& : la chaîne à modifier
  | from | std::string const& : la chaîne à trouver
  | to | std::string const& : la chaîne à substituer
  | target | std::string &target : la chaîne finale

void Tools::replaceString | ( | std::string & | myString,
|  | std::string const & | from,
|  | std::string const & | to |
| ) |  |  | `[static]`

Remplace une chaîne par une autre dans la chaîne fournie.

Auteur:
  U.Speed

Paramètres:

  | myString | std::string& : la chaîne à modifier
  | from | std::string const& : la chaîne à trouver
  | to | std::string const& : la chaîne à substituer

void Tools::sha256 | ( | std::string const & | toHash,
|  | std::string & | target |
| ) |  |  | `[static]`

Calcul de la signature SHA-256 des données fournies vers le tampon spécifié.

Auteur:
  U.Speed

Paramètres:

  | toHash | std::string const& : les données à traiter en SHA-256
  | target | std::string& : le résultat du hashage en SHA-256 (vide si erreur ou pas de données fournies)

void Tools::sha512 | ( | std::string const & | toHash,
|  | std::string & | target |
| ) |  |  | `[static]`

Calcul de la signature SHA-512 des données fournies vers le tampon spécifié.

Auteur:
  U.Speed

Paramètres:

  | toHash | std::string const& : les données à traiter en SHA-512
  | target | std::string& : le résultat du hashage en SHA-512 (vide si erreur ou pas de données fournies)

void Tools::splitString | ( | std::string const & | myString,
|  | std::string const & | separator,
|  | std::vector< std::string > & | target |
| ) |  |  | `[static]`

Découpe la chaîne spécifiée avec le séparateur fourni et retourne une liste de "string".

Auteur:
  U.Speed

Paramètres:

  | myString | std::string const& : la chaîne à découper
  | separator | std::string const& : la chaîne à trouver pour découper (vide si on découpe la chaîne en lettres)
  | target | std::vector<std::string>& : la liste des "string" générée

void Tools::stringAlphaOnly | ( | std::string & | myString | ) | `[static]`

Retire tous les accents des lettres (majuscules et minuscules).

Auteur:
  U.Speed

Paramètres:

  | myString | std::string& : la chaîne à convertir

void Tools::stringFromIniFormat | ( | std::string const & | myString,
|  | std::string & | target |
| ) |  |  | `[static]`

Convertie la chaîne spécifiée depuis le format nécéssaire pour les fichiers INI du système vers le format initial (de la source vers le tampon de destination fourni).

Annule les modifications de la conversion en INI où :

- Les retours à la ligne : "\n"
- Les barres "\" sont doublées "\\"
- Les signes égal "=" : "\equal"
- Les signes étoile "*" : "\star"
- Les signes diese "#" : "\diese"
- Les signes coma ";" : "\coma"

Auteur:
  U.Speed

Voir également:
  void Tools::stringFromIniFormat(std::string &myString)

Paramètres:

  | myString | std::string const& : la chaîne à convertir
  | target | std::string& : la chaîne convertie

void Tools::stringFromIniFormat | ( | std::string & | myString | ) | `[static]`

Convertie la chaîne spécifiée depuis le format nécéssaire pour les fichiers INI du système vers le format initial.

Annule les modifications de la conversion en INI où :

- Les retours à la ligne : "\n"
- Les barres "\" sont doublées "\\"
- Les signes égal "=" : "\equal"
- Les signes étoile "*" : "\star"
- Les signes diese "#" : "\diese"
- Les signes coma ";" : "\coma"

Auteur:
  U.Speed

Paramètres:

  | myString | std::string& : la chaîne à convertir

void Tools::stringToIniFormat | ( | std::string & | myString | ) | `[static]`

Convertie la chaîne spécifiée au format nécéssaire pour les fichiers INI du système.

- Les retours à la ligne : "\n"
- Les barres "\" sont doublées "\\"
- Les signes égal "=" : "\equal"
- Les signes étoile "*" : "\star"
- Les signes diese "#" : "\diese"
- Les signes coma ";" : "\coma"

Auteur:
  U.Speed

Paramètres:

  | myString | std::string& : la chaîne à convertir

void Tools::stringToIniFormat | ( | std::string const & | myString,
|  | std::string & | target |
| ) |  |  | `[static]`

Convertie la chaîne spécifiée au format nécéssaire pour les fichiers INI du système.

Auteur:
  U.Speed

Voir également:
  void Tools::stringToIniFormat(std::string &myString)

Paramètres:

  | myString | std::string const& : la chaîne à convertir
  | target | std::string& : la chaîne convertie

void Tools::stringToLower | ( | std::string & | myString | ) | `[static]`

Convertit la chaîne en minucules.

Auteur:
  U.Speed

Paramètres:

  | myString | std::string& : la chaîne à convertir

void Tools::stringToUpper | ( | std::string & | myString | ) | `[static]`

Convertit la chaîne en majuscules.

Auteur:
  U.Speed

Paramètres:

  | myString | std::string& : la chaîne à convertir

void Tools::tableFromIni | ( | std::string const & | iniInfos,
|  | std::map< std::string, std::string > & | target |
| ) |  |  | `[static]`

Lecture du fichier INI (sous forme de chaîne) vers un tableau de données (donnees[cle] = valeur).

Auteur:
  U.Speed

Paramètres:

  | iniInfos | std::string const& : les données INI à lire
  | target | std::map<std::string, std::string>& : liste des informations (clés => valeurs)

bool Tools::toAES | ( | std::string const & | toCrypt,
|  | std::string const & | key,
|  | std::string & | target |
| ) |  |  | `[static]`

Crypte les données AES spécifiées avec la clé fournie vers le tampon spécifié.

Auteur:
  U.Speed

Paramètres:

  | toCrypt | std::string const& : les données à crypter
  | key | std::string const& : la clé de cryptage
  | target | std::string& : le résultat du cryptage

Renvoie:
  bool : l'état du cryptage
  - true : cryptage réussie
  - false : échec

bool Tools::toAES | ( | std::string & | toCrypt,
|  | std::string const & | key |
| ) |  |  | `[static]`

Crypte les données AES spécifiées avec la clé fournie.

Auteur:
  U.Speed

Paramètres:

  | toCrypt | std::string& : les données à crypter
  | key | std::string const& : la clé de cryptage

Renvoie:
  bool : l'état du cryptage
  - true : cryptage réussie
  - false : échec

bool Tools::toBase64 | ( | std::string & | toEncode | ) | `[static]`

Encode les données spécifiées en base 64.

Auteur:
  U.Speed

Voir également:
  bool Tools::toBase64(std::string const &toEncode, std::string &target)

Paramètres:

  | toEncode | std::string& : les données à encoder en base 64

Renvoie:
  bool : l'état de la conversion
  - true : Conversion réussie
  - false : échec

bool Tools::toBase64 | ( | std::string const & | toEncode,
|  | std::string & | target |
| ) |  |  | `[static]`

Encode les données spécifiées en base 64.

Auteur:
  U.Speed

Paramètres:

  | toEncode | std::string const& : les données à encoder en base 64
  | target | std::string& : le résultat de l'encodage en base 64

Renvoie:
  bool : l'état de la conversion
  - true : Conversion réussie
  - false : échec

bool Tools::toHexa | ( | std::string const & | toEncode,
|  | std::string & | target |
| ) |  |  | `[static]`

Convertit le tableau d'octets en hexadécimal vers le tampon spécifié.

Auteur:
  U.Speed

Paramètres:

  | toEncode | std::string const& : les données à encoder en hexadécimal
  | target | std::string& : la chaîne convertie

Renvoie:
  bool : l'état de la conversion
  - true : Conversion réussie
  - false : échec

bool Tools::toHexa | ( | std::string & | toEncode | ) | `[static]`

Convertit le tableau d'octets en hexadécimal.

Auteur:
  U.Speed

Voir également:
  bool Tools::toHexa(std::string const &toEncode, std::string &target)

Paramètres:

  | toEncode | std::string const& : les données à encoder en hexadécimal

Renvoie:
  bool : l'état de la conversion
  - true : Conversion réussie
  - false : échec

bool Tools::unzip | ( | std::string & | toUncompress | ) | `[static]`

Décompresser les données spécifiées avec un tampon de décompression de taille par défaut mis à 500Ko.

Auteur:
  U.Speed

Paramètres:

  | toUncompress | std::string& : les données à décompresser

Renvoie:
  bool : l'état de la compression
  - true : échec
  - false : réussite

bool Tools::unzip | ( | std::string const & | toUncompress,
|  | std::string & | uncompressed |
| ) |  |  | `[static]`

Décompresser les données spécifiées vers le tampon spécifié avec un tampon de taille par défaut mis à 500Ko.

Auteur:
  U.Speed

Voir également:
  bool Tools::unzip(std::string const &toUncompress)

Paramètres:

  | toUncompress | std::string const& : les données à décompresser
  | uncompressed | std::string& : le tampon de destination

Renvoie:
  bool : l'état de la compression
  - true : échec
  - false : réussite

bool Tools::zip | ( | std::string const & | toCompress,
|  | std::string & | compressed |
| ) |  |  | `[static]`

Compresser les données spécifiées vers le tampon spécifié.

Auteur:
  U.Speed

Voir également:
  bool Tools::zip(std::string &toCompress)

Paramètres:

  | toCompress | std::string const& : les données à compresser
  | compressed | std::string& : le tampon de destination

Renvoie:
  bool : l'état de la compression
  - true : échec
  - false : réussite

bool Tools::zip | ( | std::string & | toCompress | ) | `[static]`

Compresser les données spécifiées.

Auteur:
  U.Speed

Paramètres:

  | toCompress | std::string& : les données à compresser

Renvoie:
  bool : l'état de la compression
  - true : échec
  - false : réussite

La documentation de cette classe a été générée à partir des fichiers suivants :

- src/Tools/Tools.hpp
- src/Tools/Tools.cpp
- src/Tools/Tools_crc32.cpp
- src/Tools/Tools_fromAES.cpp
- src/Tools/Tools_fromBase64.cpp
- src/Tools/Tools_fromHexa.cpp
- src/Tools/Tools_iniFromTable.cpp
- src/Tools/Tools_md5.cpp
- src/Tools/Tools_nextPartOfFile.cpp
- src/Tools/Tools_numberFromBase64.cpp
- src/Tools/Tools_numberToBase64.cpp
- src/Tools/Tools_replaceString.cpp
- src/Tools/Tools_sha256.cpp
- src/Tools/Tools_sha512.cpp
- src/Tools/Tools_splitString.cpp
- src/Tools/Tools_stringAlphaOnly.cpp
- src/Tools/Tools_stringFromIniFormat.cpp
- src/Tools/Tools_stringToIniFormat.cpp
- src/Tools/Tools_stringToLower.cpp
- src/Tools/Tools_stringToUpper.cpp
- src/Tools/Tools_tableFromIni.cpp
- src/Tools/Tools_toAES.cpp
- src/Tools/Tools_toBase64.cpp
- src/Tools/Tools_toHexa.cpp
- src/Tools/Tools_unzip.cpp
- src/Tools/Tools_zip.cpp