plantuml.h

Go to the documentation of this file.

// === plantuml.h ======================================================================================================
//                                               Sen Infrastructure
//                   Released under the Apache License v2.0 (SPDX-License-Identifier Apache-2.0).
//                                    See the LICENSE.txt file for more information.
//                   © Airbus SAS, Airbus Helicopters, and Airbus Defence and Space SAU/GmbH/SAS.
// =====================================================================================================================
 
#ifndef SEN_LIBS_GEN_INCLUDE_SEN_GEN_PLANTUML_H
#define SEN_LIBS_GEN_INCLUDE_SEN_GEN_PLANTUML_H
 
#include "sen/core/base/compiler_macros.h"
#include "sen/core/lang/stl_resolver.h"
 
#include <memory>
#include <string>
 
namespace sen::gen
{

enum class PlantUMLGenerationMode
{
  all,
  onlyClasses,
  onlyBasicTypes
};

enum class PlantUMLEnumMode
{
  all,
  noEnumerators
};

class PlantUMLGenerator
{
  SEN_NOCOPY_NOMOVE(PlantUMLGenerator)
 
public:
  PlantUMLGenerator();
  ~PlantUMLGenerator();

  [[nodiscard]] std::string generate(const sen::lang::TypeSetContext& typeSets,
                                     PlantUMLGenerationMode generationMode,
                                     PlantUMLEnumMode enumMode);
 
private:
  class Impl;
  std::unique_ptr<Impl> pimpl_;
};
 
}  // namespace sen::gen
 
#endif  // SEN_LIBS_GEN_INCLUDE_SEN_GEN_PLANTUML_H