Démarrer

01Prérequis

02Obtenir le SDK

Le SDK est une archive .zip par plateforme, déjà compilée. Il n'y a rien à compiler ni à installer : vous la décompressez et vous y faites pointer votre projet. La même archive fait tourner l'évaluation et, une fois que vous avez une clé de série, l'édition sous licence.

03Contenu du SDK

Les headers, la bibliothèque statique en Release et en Debug (celle de Debug porte le suffixe d), les fichiers qui font fonctionner find_package et les outils en ligne de commande. Tous les modules y sont compilés, y compris les modules spécialisés (voir modules inclus).

ethereal-win-x64/
  include/ethereal/         # C++ and C headers
  lib/Ethereal.lib          # Release
  lib/Ethereald.lib         # Debug
  lib/cmake/Ethereal/       # find_package( Ethereal )
  bin/                      # etl-bench, etl-i18n, etl-trees, etl-neural, etl-modelguard, etl-update

ethereal-linux-x64/
  include/ethereal/         # C++ and C headers
  lib64/libEthereal.a       # Release
  lib64/libEthereald.a      # Debug
  lib64/cmake/Ethereal/     # find_package( Ethereal )
  lib64/pkgconfig/          # ethereal.pc
  bin/                      # etl-bench, etl-i18n, etl-trees, etl-neural, etl-modelguard, etl-update

La bibliothèque a aussi besoin de quelques petites bibliothèques auxiliaires et de définitions de compilation. find_package et pkg-config les ajoutent, donc utilisez l'un des deux au lieu de lister les fichiers à la main.

04Lier votre projet

Faites pointer CMAKE_PREFIX_PATH vers le dossier décompressé du SDK et demandez les modules que vous utilisez. Les composants ne vérifient que les noms : il n'y a qu'une seule bibliothèque, Ethereal::Ethereal, et CMake choisit le fichier Release ou Debug pour chaque configuration.

cmake_minimum_required( VERSION 3.21 )
project( app CXX )

find_package( Ethereal 0.1 REQUIRED COMPONENTS Regex I18n )

add_executable( app main.cpp )
target_link_libraries( app PRIVATE Ethereal::Ethereal )

# Windows
cmake -S . -B build -A x64 -DCMAKE_PREFIX_PATH=C:\sdk\ethereal-win-x64
cmake --build build --config Release

# Linux
cmake -S . -B build -DCMAKE_BUILD_TYPE=Release -DCMAKE_PREFIX_PATH=/opt/ethereal-linux-x64
cmake --build build

# Linux. The ethereal.pc file is relocatable.
export PKG_CONFIG_PATH=/opt/ethereal-linux-x64/lib64/pkgconfig
g++ -std=c++20 main.cpp $(pkg-config --cflags --libs ethereal)

05Débloquer et lancer

Appelez Bundle::UnlockBundle une fois par application, avant d'utiliser le moindre module, avec votre clé de série. Pendant l'évaluation, passez une chaîne vide. Une clé refusée renvoie un statut qui dit pourquoi : signature, format, produit, validité ou clé manquante. La vérification se fait uniquement hors ligne, avec une clé publique compilée dans la bibliothèque. Rien n'est envoyé sur le réseau.

#include <ethereal/cpp/pch/pch_ethereal.h>

int main( int argc, char ** argv )
{
    using namespace Ethereal;

    // once per application, before anything else
    const char * pSerial = ( argc > 1 ) ? argv[ 1 ] : "";

    const Bundle::EBundleUnlockStatus eStatus = Bundle::UnlockBundle( pSerial );

    if( eStatus != Bundle::eOk )
    {
        std::printf( "license refused, code %d\n", static_cast< int >( eStatus ) );
        return 1;
    }

    std::string sDigest;
    Crypto::SHA256::GetAs_String( "ethereal", sDigest );

    const UID::CUuid Id = UID::CUuid::Generate();

    std::printf( "%s\n%s\n", sDigest.c_str(), Id.ToString().c_str() );
}

pch_ethereal.h inclut toute la bibliothèque. Chaque header public compile aussi seul, vous pouvez donc n'inclure que ce que vous utilisez, comme <ethereal/cpp/regex/regex_inc.hpp>.

06Modules inclus

Tous les modules sont déjà compilés dans le SDK, y compris les modules spécialisés ci-dessous. C'est une bibliothèque statique, donc l'éditeur de liens ne prend que le code que votre programme appelle : un module que vous n'utilisez jamais n'atteint pas votre binaire.

07Étapes suivantes