ApplicationInfo.h

// -*- tab-width: 2; indent-tabs-mode: nil; coding: utf-8-with-signature -*-
//-----------------------------------------------------------------------------
// Copyright 2000-2026 CEA (www.cea.fr) IFPEN (www.ifpenergiesnouvelles.com)
// See the top-level COPYRIGHT file for details.
// SPDX-License-Identifier: Apache-2.0
//-----------------------------------------------------------------------------
/*---------------------------------------------------------------------------*/
/* ApplicationInfo.h                                           (C) 2000-2024 */
/*                                                                           */
/* Application information.                                                  */
/*---------------------------------------------------------------------------*/
#ifndef ARCANE_UTILS_APPLICATIONINFO_H
#define ARCANE_UTILS_APPLICATIONINFO_H
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#include "arcane/utils/VersionInfo.h"
#include "arcane/utils/String.h"
#include "arcane/utils/UtilsTypes.h"
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
namespace Arcane
{
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
class ApplicationInfoPrivate;
class CommandLineArguments;
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/

class ARCANE_UTILS_EXPORT ApplicationInfo
{
 public:
 
  ApplicationInfo();
  ApplicationInfo(int* argc, char*** argv, const String& name, const VersionInfo& version);
  ApplicationInfo(const StringList& args, const String& name, const VersionInfo& version);
  ApplicationInfo(const CommandLineArguments& args, const String& name, const VersionInfo& version);
  ApplicationInfo(const ApplicationInfo& rhs);
  ~ApplicationInfo();
  ApplicationInfo& operator=(const ApplicationInfo& rhs);
 
 public:

  const String& applicationName() const;
  ARCCORE_DEPRECATED_2020("use codeVersion() instead")
  const VersionInfo& version() const { return codeVersion(); }
  const VersionInfo& codeVersion() const;
  const String& dataOsDir() const;
  const String& dataDir() const;

  ARCCORE_DEPRECATED_2020("use codeVersion().versionMajor() instead")
  int versionMajor() const;
  ARCCORE_DEPRECATED_2020("use codeVersion().versionMinor() instead")
  int versionMinor() const;
  ARCCORE_DEPRECATED_2020("use codeVersion().versionPatch() instead")
  int versionPatch() const;

  bool isDebug() const;

  const String& codeName() const;
  const String& targetFullName() const;
 
  ARCCORE_DEPRECATED_2019("Use commandLineArguments().commandLineArgc() instead")
  int* commandLineArgc() const;
  ARCCORE_DEPRECATED_2019("Use commandLineArguments().commandLineArgv() instead")
  char*** commandLineArgv() const;

  void args(StringList& args) const;

  const CommandLineArguments& commandLineArguments() const;
 
 public:

  void addDynamicLibrary(const String& lib_name);

  StringCollection dynamicLibrariesName() const;
 
 public:

  void setDataOsDir(const String& v);
  void setDataDir(const String& v);
  ARCCORE_DEPRECATED_2020("use setCodeVersion() instead")
  void setVersionInfo(const VersionInfo& version_info)
  {
    setCodeVersion(version_info);
  }

  void setApplicationName(const String& v);
  void setCodeVersion(const VersionInfo& version_info);
  void setCodeName(const String& code_name);
  void setCommandLineArguments(const CommandLineArguments& args);
  void setIsDebug(bool v);
 
 public:

  void setRuntimeConfigFileContent(ByteConstSpan content);
  ByteConstSpan runtimeConfigFileContent() const;
 
 public:

  void addParameterLine(const String& line);
 
 public:
 
  ARCCORE_DEPRECATED_2019("Use commandLineArguments().commandLineArgc() instead")
  int* m_argc; 
  ARCCORE_DEPRECATED_2019("Use commandLineArguments().commandLineArgv() instead")
  char*** m_argv; 
 
 private:
 
  ApplicationInfoPrivate* m_p;
 
 private:
 
  void _init(const String& name);
  void _setArgs();
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
} // End namespace Arcane
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#endif