Arcane  v3.14.10.0
Documentation utilisateur
Chargement...
Recherche...
Aucune correspondance
ArccoreGlobal.h
1// -*- tab-width: 2; indent-tabs-mode: nil; coding: utf-8-with-signature -*-
2//-----------------------------------------------------------------------------
3// Copyright 2000-2024 CEA (www.cea.fr) IFPEN (www.ifpenergiesnouvelles.com)
4// See the top-level COPYRIGHT file for details.
5// SPDX-License-Identifier: Apache-2.0
6//-----------------------------------------------------------------------------
7/*---------------------------------------------------------------------------*/
8/* ArccoreGlobal.h (C) 2000-2024 */
9/* */
10/* Déclarations générales de Arccore. */
11/*---------------------------------------------------------------------------*/
12#ifndef ARCCORE_BASE_ARCCOREGLOBAL_H
13#define ARCCORE_BASE_ARCCOREGLOBAL_H
14/*---------------------------------------------------------------------------*/
15/*---------------------------------------------------------------------------*/
16
17#include <cstdint>
18
19#include "arccore/arccore_config.h"
20
21#ifdef ARCCORE_VALID_TARGET
22# undef ARCCORE_VALID_TARGET
23#endif
24
25// Determine le type de l'os.
26#if defined(__linux)
27# define ARCCORE_OS_LINUX
28#elif defined(__APPLE__) && defined(__MACH__)
29# define ARCCORE_OS_MACOS
30#elif defined(_AIX)
31# define ARCCORE_OS_AIX
32#elif defined(__WIN32__) || defined(__NT__) || defined(WIN32) || defined(_WIN32) || defined(WIN32) || defined(_WINDOWS)
33# define ARCCORE_OS_WIN32
34#elif defined(__CYGWIN__)
35# define ARCCORE_OS_CYGWIN
36#endif
37
38#ifdef ARCCORE_OS_WIN32
39# define ARCCORE_VALID_TARGET
40# define ARCCORE_EXPORT __declspec(dllexport)
41# define ARCCORE_IMPORT __declspec(dllimport)
42
43/* Supprime certains avertissements du compilateur Microsoft */
44# ifdef _MSC_VER
45# pragma warning(disable: 4251) // class 'A' needs to have dll interface for to be used by clients of class 'B'.
46# pragma warning(disable: 4275) // non - DLL-interface classkey 'identifier' used as base for DLL-interface classkey 'identifier'
47# pragma warning(disable: 4800) // 'type' : forcing value to bool 'true' or 'false' (performance warning)
48# pragma warning(disable: 4355) // 'this' : used in base member initializer list
49# endif
50
51#endif
52
53// Sous Unix, indique que par défaut les symboles de chaque .so sont cachés.
54// Il faut alors explicitement marquer les
55// symboles qu'on souhaite exporter, comme sous windows.
56// La seule différence est que pour gcc avec les instantiations explicites
57// de template, il faut spécifier l'export lors de l'instantiation
58// explicite alors que sous windows c'est dans la classe.
59#ifndef ARCCORE_OS_WIN32
60# define ARCCORE_EXPORT __attribute__ ((visibility("default")))
61# define ARCCORE_IMPORT __attribute__ ((visibility("default")))
62# define ARCCORE_TEMPLATE_EXPORT ARCCORE_EXPORT
63#endif
64
65#ifdef ARCCORE_OS_CYGWIN
66# define ARCCORE_VALID_TARGET
67#endif
68
69#ifdef ARCCORE_OS_LINUX
70# define ARCCORE_VALID_TARGET
71#endif
72
73#ifdef ARCCORE_OS_MACOS
74# define ARCCORE_VALID_TARGET
75#endif
76
77#ifndef ARCCORE_VALID_TARGET
78#error "This target is not supported"
79#endif
80
81#ifndef ARCCORE_EXPORT
82#define ARCCORE_EXPORT
83#endif
84
85#ifndef ARCCORE_IMPORT
86#define ARCCORE_IMPORT
87#endif
88
89#ifndef ARCCORE_TEMPLATE_EXPORT
90#define ARCCORE_TEMPLATE_EXPORT
91#endif
92
93#ifndef ARCCORE_RESTRICT
94#define ARCCORE_RESTRICT
95#endif
96
97#define ARCCORE_STD std
98
99//Tag var as a voluntary unused variable.
100//Works with any compiler but might be improved by using attribute.
101#define ARCCORE_UNUSED(var) do { (void)(var) ; } while(false)
102
103/*---------------------------------------------------------------------------*/
104/*---------------------------------------------------------------------------*/
105
106#ifdef DOXYGEN_DOC
107typedef ARCCORE_TYPE_INT16 Int16;
108typedef ARCCORE_TYPE_INT32 Int32;
109typedef ARCCORE_TYPE_INT64 Int64;
110#endif
111
112/*---------------------------------------------------------------------------*/
113/*---------------------------------------------------------------------------*/
114/*
115 * Macros pour le support de la programmation hétérogène (CPU/GPU)
116 - ARCCORE_DEVICE_CODE: indique une partie de code compilée uniquement sur le device
117 - ARCCORE_HOST_DEVICE: indique que la méthode/variable est accessible à la fois
118 sur le device et l'hôte
119 - ARCCORE_DEVICE: indique que la méthode/variable est accessible uniquement sur
120 le device.
121*/
122
123#if defined(__SYCL_DEVICE_ONLY__)
124# define ARCCORE_DEVICE_CODE
125# define ARCCORE_DEVICE_TARGET_SYCL
126#elif defined(__CUDA_ARCH__) || defined(__HIP_DEVICE_COMPILE__)
127# define ARCCORE_DEVICE_CODE
128# if defined(__HIP_DEVICE_COMPILE__)
129# define ARCCORE_DEVICE_TARGET_HIP
130# endif
131# if defined(__CUDA_ARCH__)
132# define ARCCORE_DEVICE_TARGET_CUDA
133// Nécessaire pour assert() par exemple dans arccoreCheckAt()
134// TODO: regarder si cela est aussi nécessaire pour AMD HIP.
135#include <cassert>
136# endif
137#endif
138
139#if defined(__CUDACC__) || defined(__HIP__)
140#define ARCCORE_HOST_DEVICE __host__ __device__
141#define ARCCORE_DEVICE __device__
142#endif
143
144
145#ifndef ARCCORE_HOST_DEVICE
146#define ARCCORE_HOST_DEVICE
147#endif
148
149#ifndef ARCCORE_DEVICE
150#define ARCCORE_DEVICE
151#endif
152
153/*---------------------------------------------------------------------------*/
154/*---------------------------------------------------------------------------*/
155
156#if defined(ARCCORE_COMPONENT_arccore_base)
157#define ARCCORE_BASE_EXPORT ARCCORE_EXPORT
158#define ARCCORE_BASE_EXTERN_TPL
159#else
160#define ARCCORE_BASE_EXPORT ARCCORE_IMPORT
161#define ARCCORE_BASE_EXTERN_TPL extern
162#endif
163
164#ifdef ARCCORE_REAL_USE_APFLOAT
165# include <apfloat.h>
166#endif
167
168/*---------------------------------------------------------------------------*/
169/*---------------------------------------------------------------------------*/
170
171namespace Arccore
172{
173
174/*---------------------------------------------------------------------------*/
175/*---------------------------------------------------------------------------*/
176/*
177 * Définition des types Arccore Int16, Int32 et Int64.
178 */
179//! Type entier signé sur 8 bits
180using Int8 = std::int8_t;
181//! Type entier signé sur 16 bits
182using Int16 = std::int16_t;
183//! Type entier signé sur 32 bits
184using Int32 = std::int32_t;
185//! Type entier signé sur 64 bits
186using Int64 = std::int64_t;
187//! Type entier non signé sur 32 bits
188using UInt32 = std::uint32_t;
189//! Type entier non signé sur 64 bits
190using UInt64 = std::uint64_t;
191
192/*---------------------------------------------------------------------------*/
193/*---------------------------------------------------------------------------*/
194/*!
195 * \brief Type représentant un pointeur.
196 *
197 * Il doit être utilisé partout ou un objet de type pointeur quelconque est attendu.
198 */
199using Pointer = void*;
200
201#ifdef ARCCORE_REAL_USE_APFLOAT
202# define ARCCORE_REAL(val) (Real(#val,1000))
203# define ARCCORE_REAL_NOT_BUILTIN
204using Real = apfloat;
205using APReal = apfloat;
206#else
207# ifdef ARCCORE_REAL_LONG
208# define ARCCORE_REAL(val) val##L
209/*!
210 * \brief Type représentant un réel.
211 *
212 * Il doit être utilisé partout ou un objet de type réel est attendu.
213 */
214using long double Real;
215# else
216# define ARCCORE_REAL(val) val
217# define ARCCORE_REAL_IS_DOUBLE
218/*!
219 * \brief Type représentant un réel.
220 *
221 * Il doit être utilisé partout ou un objet de type réel est attendu.
222 */
223using Real = double;
224# endif
225//! Emulation de réel en précision arbitraire.
227{
228 public:
229 Real v[4];
230};
231#endif
232
233#ifdef ARCCORE_64BIT
234# define ARCCORE_INTEGER_MAX ARCCORE_INT64_MAX
235using Short = Int32;
236using Integer = Int64;
237#else
238# define ARCCORE_INTEGER_MAX ARCCORE_INT32_MAX
239using Short = Int32;
241#endif
242
243/*!
244 * \def ARCCORE_INTEGER_MAX
245 * \brief Macro indiquant la valeur maximal que peut prendre le type #Integer
246 */
247
248
249/*!
250 * \typedef Int64
251 * \brief Type entier signé sur 64 bits.
252 */
253/*!
254 * \typedef Int32
255 * \brief Type entier signé sur 32 bits.
256 */
257/*!
258 * \typedef Int16
259 * \brief Type entier signé sur 16 bits.
260 */
261/*!
262 * \typedef Integer
263 * \brief Type représentant un entier
264 *
265 * Si la macro ARCCORE_64BIT est définie, le type Integer correspond à un
266 * entier Int64, sinon à un entier Int32.
267 */
268
269/*---------------------------------------------------------------------------*/
270/*---------------------------------------------------------------------------*/
271
272//! Brain Float16
273class BFloat16;
274
275//! Float16
276class Float16;
277
278//! Type flottant IEEE-753 simple précision
279using Float32 = float;
280
281/*---------------------------------------------------------------------------*/
282/*---------------------------------------------------------------------------*/
283
284/*!
285 * \internal
286 * \brief Structure équivalente à la valeur booléenne \a vrai
287 */
288struct TrueType {};
289/*!
290 \internal
291 \brief Structure équivalente à la valeur booléenne \a vrai
292*/
293struct FalseType {};
294
295/*---------------------------------------------------------------------------*/
296/*---------------------------------------------------------------------------*/
297
298#ifdef __GNUG__
299# define ARCCORE_DEPRECATED __attribute__ ((deprecated))
300#endif
301
302#ifdef _MSC_VER
303# if _MSC_VER >= 1300
304# define ARCCORE_DEPRECATED __declspec(deprecated)
305# endif
306#endif
307
308#define ARCCORE_DEPRECATED_2017 ARCCORE_DEPRECATED
309#define ARCCORE_DEPRECATED_2018 ARCCORE_DEPRECATED
310#define ARCCORE_DEPRECATED_2019(reason) [[deprecated(reason)]]
311#define ARCCORE_DEPRECATED_2020(reason) [[deprecated(reason)]]
312#define ARCCORE_DEPRECATED_REASON(reason) [[deprecated(reason)]]
313
314// Définir cette macro si on souhaite supprimer de la compilation les
315// méthodes et types obsolètes.
316#define ARCCORE_NO_DEPRECATED
317
318#ifndef ARCCORE_DEPRECATED
319# define ARCCORE_DEPRECATED
320#endif
321
322/*---------------------------------------------------------------------------*/
323/*---------------------------------------------------------------------------*/
324
325/*---------------------------------------------------------------------------*/
326/*---------------------------------------------------------------------------*/
327// Macros de compatibilités avec les différents standards du C++.
328// Maintenant (en 2021) tous les compilateurs avec lesquels Arccore compile
329// ont le support du C++17 donc la plupart de ces macros ne sont plus utiles.
330// On les garde uniquement pour compatibilité avec le code existant.
331
332// La macro ARCCORE_NORETURN utilise l'attribut [[noreturn]] du C++11 pour
333// indiquer qu'une fonction ne retourne pas.
334#define ARCCORE_NORETURN [[noreturn]]
335
336//! Macro permettant de spécifier le mot-clé 'constexpr' du C++11
337#define ARCCORE_CONSTEXPR constexpr
338
339// Macro pour indiquer qu'on ne lance pas d'exceptions.
340#define ARCCORE_NOEXCEPT noexcept
341
342// Macros pour indiquer qu'on lance pas d'exceptions.
343#define ARCCORE_NOEXCEPT_FALSE noexcept(false)
344
345// Support pour operator[](a,b,...)
346#ifdef __cpp_multidimensional_subscript
347#define ARCCORE_HAS_MULTI_SUBSCRIPT
348#endif
349
350/*---------------------------------------------------------------------------*/
351/*---------------------------------------------------------------------------*/
352
353// Support pour l'alignement.
354// le C++11 utilise le mot clé alignas pour spécifier l'alignement.
355// Cela fonctionne avec GCC 4.9+ et Visual Studio 2015. Cela ne fonctionne
356// pas avec Visual Studio 2013. Donc pour Visual Studio on utilise dans tous
357// les cas __declspec qui fonctionne toujours. Sous Linux, __attribute__ fonctionne
358// aussi toujours donc on utilise cela. A noter que les structures Simd ont besoin
359// de l'attribut 'packed' qui n'existe que avec GCC et Intel. Il ne semble pas y avoir
360// d'équivalent avec MSVC.
361#ifdef _MSC_VER
362//! Macro pour garantir le compactage et l'alignement d'une classe sur \a value octets
363# define ARCCORE_ALIGNAS(value) __declspec(align(value))
364//! Macro pour garantir l'alignement d'une classe sur \a value octets
365# define ARCCORE_ALIGNAS_PACKED(value) __declspec(align(value))
366#else
367//! Macro pour garantir le compactage et l'alignement d'une classe sur \a value octets
368# define ARCCORE_ALIGNAS_PACKED(value) __attribute__ ((aligned (value),packed))
369//! Macro pour garantir l'alignement d'une classe sur \a value octets
370# define ARCCORE_ALIGNAS(value) __attribute__ ((aligned (value)))
371#endif
372
373/*---------------------------------------------------------------------------*/
374/*---------------------------------------------------------------------------*/
375
376#if defined(ARCCORE_CHECK) || defined(ARCCORE_DEBUG)
377# ifndef ARCCORE_DEBUG_ASSERT
378# define ARCCORE_DEBUG_ASSERT
379# endif
380#endif
381
382/*---------------------------------------------------------------------------*/
383/*---------------------------------------------------------------------------*/
384/*!
385 * \brief Vrai si on est en mode vérification.
386 *
387 * Ce mode est actif si la macro ARCCORE_CHECK est définie
388 * ou si la méthode arccoreSetCheck() a été positionnée a vrai.
389 */
390extern "C++" ARCCORE_BASE_EXPORT
391bool arccoreIsCheck();
392
393/*!
394 * \brief Active ou désactive le mode vérification.
395 *
396 * Le mode vérification est toujours actif si la macro ARCCORE_CHECK est définie.
397 * Sinon, il est possible de l'activer avec cette méthode. Cela permet
398 * d'activer certains tests même en mode optimisé.
399 */
400extern "C++" ARCCORE_BASE_EXPORT
401void arccoreSetCheck(bool v);
402
403/*!
404 * \brief Vrai si la macro ARCCORE_DEBUG est définie
405 */
406extern "C++" ARCCORE_BASE_EXPORT
408
409/*---------------------------------------------------------------------------*/
410/*---------------------------------------------------------------------------*/
411
412//! Encapsulation de la fonction C printf
413extern "C++" ARCCORE_BASE_EXPORT void
414arccorePrintf(const char*,...);
415
416/*---------------------------------------------------------------------------*/
417/*---------------------------------------------------------------------------*/
418/*!
419 * \brief Passe en mode pause ou lance une erreur fatale.
420 *
421 * Si arccoreSetPauseOnError() est appelé avec l'argument \a true,
422 * met le programme en pause
423 * pour éventuellement connecter un débugger dessus.
424 *
425 * Sinon, lance une exception FatalErrorException avec le message
426 * \a msg comme argument.
427 */
428extern "C++" ARCCORE_BASE_EXPORT void
429arccoreDebugPause(const char* msg);
430
431/*---------------------------------------------------------------------------*/
432/*---------------------------------------------------------------------------*/
433/*!
434 * \brief Indique si on l'appel à arccoreDebugPause() effectue une pause.
435 *
436 * \sa arccoreDebugPause()
437 */
438extern "C++" ARCCORE_BASE_EXPORT void
440
441/*---------------------------------------------------------------------------*/
442/*---------------------------------------------------------------------------*/
443/*!
444 * \brief Macro pour envoyer une exception avec formattage.
445 *
446 * \a exception_class est le type de l'exception. Les arguments suivants de
447 * la macro sont utilisés formatter un message d'erreur via la
448 * méthode String::format().
449 */
450#define ARCCORE_THROW(exception_class,...) \
451 throw exception_class (A_FUNCINFO,Arccore::String::format(__VA_ARGS__))
452
453/*---------------------------------------------------------------------------*/
454/*---------------------------------------------------------------------------*/
455/*!
456 * \brief Macro envoyant une exception FatalErrorException.
457 *
458 * Les arguments de la macro sont utilisés formatter un message
459 * d'erreur via la méthode String::format().
460 */
461#define ARCCORE_FATAL(...)\
462 throw Arccore::FatalErrorException(A_FUNCINFO,Arccore::String::format(__VA_ARGS__))
463
464/*---------------------------------------------------------------------------*/
465/*---------------------------------------------------------------------------*/
466/*!
467 * \brief Signalue l'utilisation d'un pointeur nul.
468 *
469 * Signale une tentative d'utilisation d'un pointeur nul.
470 * Affiche un message, appelle arccoreDebugPause() et lance une exception
471 * de type FatalErrorException.
472 */
473extern "C++" ARCCORE_BASE_EXPORT void
474arccoreNullPointerError ARCCORE_NORETURN ();
475
476/*---------------------------------------------------------------------------*/
477/*---------------------------------------------------------------------------*/
478/*!
479 * \brief Signale qu'une valeur n'est pas dans l'intervalle souhaité.
480 *
481 * Indique que l'assertion `min_value_inclusive <= i < max_value_exclusive`
482 * est fausse.
483 * Appelle arccoreDebugPause() puis lève une exception de type
484 * IndexOutOfRangeException.
485 *
486 * \param i valeur invalide.
487 * \param min_value_inclusive valeur minimale inclusive autorisée.
488 * \param max_value_exclusive valeur maximale exclusive autorisée.
489 */
490extern "C++" ARCCORE_BASE_EXPORT void
491arccoreRangeError ARCCORE_NORETURN (Int64 i,Int64 min_value_inclusive,
492 Int64 max_value_exclusive);
493
494/*---------------------------------------------------------------------------*/
495/*---------------------------------------------------------------------------*/
496/*!
497 * \brief Signale qu'une valeur n'est pas dans l'intervalle souhaité.
498 *
499 * Indique que l'assertion `0 <= i < max_value est fausse`.
500 * Lance une execption IndexOutOfRangeException.
501 *
502 * \param i indice invalide
503 * \param max_size nombre d'éléments du tableau
504 */
505extern "C++" ARCCORE_BASE_EXPORT void
506arccoreRangeError ARCCORE_NORETURN (Int64 i,Int64 max_size);
507
508/*---------------------------------------------------------------------------*/
509/*---------------------------------------------------------------------------*/
510/*!
511 * \brief Vérifie que `min_value_inclusive <= i < max_value_exclusive`.
512 *
513 * Si ce n'est pas le cas, appelle arccoreRangeError() pour lancer une
514 * exception.
515 */
516inline ARCCORE_HOST_DEVICE void
517arccoreCheckRange(Int64 i,Int64 min_value_inclusive,Int64 max_value_exclusive)
518{
519 if (i>=min_value_inclusive && i<max_value_exclusive)
520 return;
521#ifndef ARCCORE_DEVICE_CODE
522 arccoreRangeError(i,min_value_inclusive,max_value_exclusive);
523#elif defined(ARCCORE_DEVICE_TARGET_CUDA)
524 // Code pour le device.
525 // assert() est disponible pour CUDA.
526 // TODO: regarder si une fonction similaire existe pour HIP
527 assert(false);
528#endif
529}
530
531/*---------------------------------------------------------------------------*/
532/*---------------------------------------------------------------------------*/
533/*!
534 * \brief Vérifie un éventuel débordement de tableau.
535 *
536 * Appelle arccoreCheckRange(i,0,max_size).
537 */
538inline ARCCORE_HOST_DEVICE void
540{
541 arccoreCheckRange(i,0,max_size);
542}
543
544#if defined(ARCCORE_CHECK) || defined(ARCCORE_DEBUG)
545#define ARCCORE_CHECK_AT(a,b) ::Arccore::arccoreCheckAt((a),(b))
546#define ARCCORE_CHECK_RANGE(a,b,c) ::Arccore::arccoreCheckRange((a),(b),(c))
547#else
548#define ARCCORE_CHECK_AT(a,b)
549#define ARCCORE_CHECK_RANGE(a,b,c)
550#endif
551
552#define ARCCORE_CHECK_AT2(a0,a1,b0,b1) \
553 ARCCORE_CHECK_AT(a0,b0); ARCCORE_CHECK_AT(a1,b1)
554#define ARCCORE_CHECK_AT3(a0,a1,a2,b0,b1,b2) \
555 ARCCORE_CHECK_AT(a0,b0); ARCCORE_CHECK_AT(a1,b1); ARCCORE_CHECK_AT(a2,b2)
556#define ARCCORE_CHECK_AT4(a0,a1,a2,a3,b0,b1,b2,b3) \
557 ARCCORE_CHECK_AT(a0,b0); ARCCORE_CHECK_AT(a1,b1); ARCCORE_CHECK_AT(a2,b2); ARCCORE_CHECK_AT(a3,b3)
558
559/*---------------------------------------------------------------------------*/
560/*---------------------------------------------------------------------------*/
561
562#define ARCCORE_CAST_SMALL_SIZE(a) ((Integer)(a))
563
564/*---------------------------------------------------------------------------*/
565/*---------------------------------------------------------------------------*/
566
567/*
568 * Macros utilisées pour le débug.
569 */
570#ifdef ARCCORE_DEBUG_ASSERT
571extern "C++" ARCCORE_BASE_EXPORT void _doAssert(const char*,const char*,const char*,int);
572template<typename T> inline T*
573_checkPointer(T* t,const char* file,const char* func,int line)
574{
575 if (!t){
576 _doAssert("ARCCORE_ASSERT",file,func,line);
577 arccorePrintf("Bad Pointer");
578 }
579 return t;
580}
581# ifdef __GNUG__
582# define ARCCORE_D_WHERE(a) Arccore::_doAssert(a,__FILE__,__PRETTY_FUNCTION__,__LINE__)
583# define ARCCORE_DCHECK_POINTER(a) Arccore::_checkPointer((a),__FILE__,__PRETTY_FUNCTION__,__LINE__);
584# else
585# define ARCCORE_D_WHERE(a) Arccore::_doAssert(a,__FILE__,"(NoInfo)",__LINE__)
586# define ARCCORE_DCHECK_POINTER(a) Arccore::_checkPointer((a),__FILE__,"(NoInfo"),__LINE__);
587# endif
588# define ARCCORE_CHECK_PTR(a) \
589 {if (!(a)){Arccore::arccorePrintf("Null value");ARCCORE_D_WHERE("ARCCORE_ASSERT");}}
590
591# define ARCCORE_ASSERT(a,b) \
592 {if (!(a)){ Arccore::arccorePrintf("Assertion '%s' fails:",#a); Arccore::arccorePrintf b; ARCCORE_D_WHERE("ARCCORE_ASSERT");}}
593# define ARCCORE_WARNING(a) \
594 { Arccore::arccorePrintf a; ARCCORE_D_WHERE("ARCCORE_WARNING"); }
595#else
596# define ARCCORE_CHECK_PTR(a)
597# define ARCCORE_ASSERT(a,b)
598# define ARCCORE_WARNING(a)
599# define ARCCORE_DCHECK_POINTER(a) (a);
600#endif
601
602/*---------------------------------------------------------------------------*/
603/*---------------------------------------------------------------------------*/
604/*!
605 * \brief Signalee l'utilisation d'un pointeur nul en envoyant une exception
606 *
607 * Signale une tentative d'utilisation d'un pointeur nul.
608 * Lance une exception de type FatalErrorException.
609 *
610 * Dans l'exception, affiche \a text si non nul, sinon affiche \a ptr_name.
611 *
612 * Normalement cette méthode ne doit pas être appelée directement mais
613 * via la macro ARCCORE_CHECK_POINTER.
614 */
615extern "C++" ARCCORE_BASE_EXPORT void
616arccoreThrowNullPointerError [[noreturn]] (const char* ptr_name,const char* text);
617
618/*---------------------------------------------------------------------------*/
619/*---------------------------------------------------------------------------*/
620/*!
621 * \brief Vérifie qu'un pointeur n'est pas nul.
622 *
623 * Si le pointeur est nul, appelle arccoreThrowNullPointerError().
624 * Sinon, retourne le pointeur.
625 */
626inline void*
627arccoreThrowIfNull(void* ptr,const char* ptr_name,const char* text)
628{
629 if (!ptr)
630 arccoreThrowNullPointerError(ptr_name,text);
631 return ptr;
632}
633
634/*---------------------------------------------------------------------------*/
635/*---------------------------------------------------------------------------*/
636/*!
637 * \brief Macro retournant le pointeur \a ptr s'il est non nul
638 * ou lancant une exception s'il est nul.
639 *
640 * \sa arccoreThrowIfNull().
641 */
642#define ARCCORE_CHECK_POINTER(ptr) \
643 arccoreThrowIfNull(ptr,#ptr,nullptr)
644
645/*!
646 * \brief Macro retournant le pointeur \a ptr s'il est non nul
647 * ou lancant une exception s'il est nul.
648 *
649 * \sa arccoreThrowIfNull().
650 */
651#define ARCCORE_CHECK_POINTER2(ptr,text)\
652 arccoreThrowIfNull(ptr,#ptr,text)
653
654/*---------------------------------------------------------------------------*/
655/*---------------------------------------------------------------------------*/
656
657// Défitions des types de base.
658class String;
659class StringView;
660class StringFormatterArg;
661class StringBuilder;
662
663/*---------------------------------------------------------------------------*/
664/*---------------------------------------------------------------------------*/
665
666} // End namespace Arccore
667
668/*---------------------------------------------------------------------------*/
669/*---------------------------------------------------------------------------*/
670
671#endif
Emulation de réel en précision arbitraire.
Type flottant demi-précision.
Espace de nom de Arccore.
Definition ArcaneTypes.h:24
ARCCORE_BASE_EXPORT void arccoreThrowNullPointerError(const char *ptr_name, const char *text)
Signalee l'utilisation d'un pointeur nul en envoyant une exception.
double Real
Type représentant un réel.
Int32 Integer
Type représentant un entier.
ARCCORE_BASE_EXPORT void _doAssert(const char *text, const char *file, const char *func, int line)
std::uint32_t UInt32
Type entier non signé sur 32 bits.
__host__ __device__ void arccoreCheckAt(Int64 i, Int64 max_size)
Vérifie un éventuel débordement de tableau.
ARCCORE_BASE_EXPORT void arccoreSetCheck(bool v)
Active ou désactive le mode vérification.
float Float32
Type flottant IEEE-753 simple précision.
ARCCORE_BASE_EXPORT void arccoreRangeError(Int64 i, Int64 min_value_inclusive, Int64 max_value_exclusive)
Signale qu'une valeur n'est pas dans l'intervalle souhaité.
void * Pointer
Type représentant un pointeur.
ARCCORE_BASE_EXPORT void arccoreNullPointerError()
Signalue l'utilisation d'un pointeur nul.
ARCCORE_BASE_EXPORT void arccorePrintf(const char *format,...)
Encapsulation de la fonction C printf.
ARCCORE_BASE_EXPORT void arccoreDebugPause(const char *msg)
Passe en mode pause ou lance une erreur fatale.
std::int64_t Int64
Type entier signé sur 64 bits.
ARCCORE_BASE_EXPORT bool arccoreIsCheck()
Vrai si on est en mode vérification.
std::uint64_t UInt64
Type entier non signé sur 64 bits.
__host__ __device__ void arccoreCheckRange(Int64 i, Int64 min_value_inclusive, Int64 max_value_exclusive)
Vérifie que min_value_inclusive <= i < max_value_exclusive.
ARCCORE_BASE_EXPORT void arccoreSetPauseOnError(bool v)
Indique si on l'appel à arccoreDebugPause() effectue une pause.
std::int32_t Int32
Type entier signé sur 32 bits.
std::int8_t Int8
Type entier signé sur 8 bits.
void * arccoreThrowIfNull(void *ptr, const char *ptr_name, const char *text)
Vérifie qu'un pointeur n'est pas nul.
std::int16_t Int16
Type entier signé sur 16 bits.
ARCCORE_BASE_EXPORT bool arccoreIsDebug()
Vrai si la macro ARCCORE_DEBUG est définie.