42cf5bc1 |
1 | // Created on: 1991-09-05 |
2 | // Created by: J.P. TIRAUlt |
3 | // Copyright (c) 1991-1999 Matra Datavision |
4 | // Copyright (c) 1999-2014 OPEN CASCADE SAS |
5 | // |
6 | // This file is part of Open CASCADE Technology software library. |
7 | // |
8 | // This library is free software; you can redistribute it and/or modify it under |
9 | // the terms of the GNU Lesser General Public License version 2.1 as published |
10 | // by the Free Software Foundation, with special exception defined in the file |
11 | // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT |
12 | // distribution for complete text of the license and disclaimer of any warranty. |
13 | // |
14 | // Alternatively, this file may be used under the terms of Open CASCADE |
15 | // commercial license or contractual agreement. |
16 | |
17 | #ifndef _Standard_HeaderFile |
18 | #define _Standard_HeaderFile |
19 | |
42cf5bc1 |
20 | #include <Standard_DefineAlloc.hxx> |
42cf5bc1 |
21 | #include <Standard_Address.hxx> |
22 | #include <Standard_Size.hxx> |
23 | #include <Standard_Integer.hxx> |
c60ae7f6 |
24 | |
42cf5bc1 |
25 | class Standard_ErrorHandler; |
26 | class Standard_GUID; |
27 | class Standard_Persistent; |
28 | class Standard_Transient; |
29 | class Standard_Failure; |
30 | |
c60ae7f6 |
31 | //! The package Standard provides global memory allocator and other basic |
32 | //! services used by other OCCT components. |
42cf5bc1 |
33 | |
34 | class Standard |
35 | { |
36 | public: |
37 | |
38 | DEFINE_STANDARD_ALLOC |
39 | |
40 | |
41 | //! Allocates memory blocks |
42 | //! aSize - bytes to allocate |
43 | Standard_EXPORT static Standard_Address Allocate (const Standard_Size aSize); |
44 | |
45 | //! Deallocates memory blocks |
c60ae7f6 |
46 | //! @param thePtr - previously allocated memory block to be freed |
47 | Standard_EXPORT static void Free (const Standard_Address thePtr); |
5b111128 |
48 | |
c60ae7f6 |
49 | //! Template version of function Free(), nullifies the argument pointer |
50 | //! @param thePtr - previously allocated memory block to be freed |
51 | template <typename T> |
52 | static inline void Free (T*& thePtr) |
53 | { |
54 | Free ((void*)thePtr); |
55 | thePtr = 0; |
56 | } |
42cf5bc1 |
57 | |
58 | //! Reallocates memory blocks |
59 | //! aStorage - previously allocated memory block |
60 | //! aNewSize - new size in bytes |
61 | Standard_EXPORT static Standard_Address Reallocate (const Standard_Address aStorage, const Standard_Size aNewSize); |
62 | |
63 | //! Allocates aligned memory blocks. |
64 | //! Should be used with CPU instructions which require specific alignment. |
65 | //! For example: SSE requires 16 bytes, AVX requires 32 bytes. |
66 | //! @param theSize bytes to allocate |
67 | //! @param theAlign alignment in bytes |
68 | Standard_EXPORT static Standard_Address AllocateAligned (const Standard_Size theSize, const Standard_Size theAlign); |
69 | |
70 | //! Deallocates memory blocks |
71 | //! @param thePtrAligned the memory block previously allocated with AllocateAligned() |
72 | Standard_EXPORT static void FreeAligned (const Standard_Address thePtrAligned); |
5b111128 |
73 | |
c60ae7f6 |
74 | //! Template version of function FreeAligned(), nullifies the argument pointer |
75 | //! @param thePtrAligned the memory block previously allocated with AllocateAligned() |
76 | template <typename T> |
77 | static inline void FreeAligned (T*& thePtrAligned) |
78 | { |
79 | FreeAligned ((void* )thePtrAligned); |
80 | thePtrAligned = 0; |
81 | } |
42cf5bc1 |
82 | |
83 | //! Deallocates the storage retained on the free list |
84 | //! and clears the list. |
85 | //! Returns non-zero if some memory has been actually freed. |
86 | Standard_EXPORT static Standard_Integer Purge(); |
87 | |
42cf5bc1 |
88 | }; |
89 | |
d1a67b9d |
90 | // include definition of handle to make it always visible |
91 | // (put at the and of the file due to cyclic dependency between headers) |
92 | #include <Standard_Transient.hxx> |
42cf5bc1 |
93 | |
42cf5bc1 |
94 | #endif // _Standard_HeaderFile |