[Scummvm-git-logs] scummvm master -> 8e66c9efea2dc7341f3539f383a3f909cb65f0db
sev-
noreply at scummvm.org
Mon Jul 8 13:47:55 UTC 2024
This automated email contains information about 1 new commit which have been
pushed to the 'scummvm' repo located at https://github.com/scummvm/scummvm .
Summary:
8e66c9efea COMMON: STD: Added displaimer explaining the purpose
Commit: 8e66c9efea2dc7341f3539f383a3f909cb65f0db
https://github.com/scummvm/scummvm/commit/8e66c9efea2dc7341f3539f383a3f909cb65f0db
Author: Eugene Sandulenko (sev at scummvm.org)
Date: 2024-07-08T15:47:47+02:00
Commit Message:
COMMON: STD: Added displaimer explaining the purpose
Changed paths:
common/algorithm.h
common/std/algorithm.h
common/std/array.h
common/std/chrono.h
common/std/functional.h
common/std/initializer_list.h
common/std/limits.h
common/std/list.h
common/std/map.h
common/std/memory.h
common/std/mutex.h
common/std/queue.h
common/std/regex.h
common/std/set.h
common/std/stack.h
common/std/thread.h
common/std/type_traits.h
common/std/unordered_set.h
common/std/utility.h
common/std/vector.h
common/std/xtr1common.h
common/std/xutility.h
diff --git a/common/algorithm.h b/common/algorithm.h
index 925e45dc12b..08dfb6efabb 100644
--- a/common/algorithm.h
+++ b/common/algorithm.h
@@ -393,7 +393,7 @@ void replace(It begin, It end, const Dat &original, const Dat &replaced) {
/**
* Removes all elements that are equal to value from the range [first, last).
* This function is the equivalent of std::remove.
- *
+ *
* @param[in] first Iterator to the first position to be examined.
* @param[in] last Iterator to the last position.
* @param[in] val Value to be removed.
diff --git a/common/std/algorithm.h b/common/std/algorithm.h
index 0720280cda8..07a3620804b 100644
--- a/common/std/algorithm.h
+++ b/common/std/algorithm.h
@@ -19,6 +19,15 @@
*
*/
+/********************************************
+ DISCLAIMER:
+
+ This is a wrapper code to mimic the relevant std:: class
+ Please use it ONLY when porting an existing code e.g. from the original sources
+
+ For all new development please use classes from Common::
+ *********************************************/
+
#ifndef COMMON_STD_ALGORITHM_H
#define COMMON_STD_ALGORITHM_H
diff --git a/common/std/array.h b/common/std/array.h
index 3dc21327a4a..8b5bc37745b 100644
--- a/common/std/array.h
+++ b/common/std/array.h
@@ -19,6 +19,15 @@
*
*/
+/********************************************
+ DISCLAIMER:
+
+ This is a wrapper code to mimic the relevant std:: class
+ Please use it ONLY when porting an existing code e.g. from the original sources
+
+ For all new development please use classes from Common::
+ *********************************************/
+
#ifndef COMMON_STD_ARRAY_H
#define COMMON_STD_ARRAY_H
diff --git a/common/std/chrono.h b/common/std/chrono.h
index d40aeb86ba7..41a4c60eb84 100644
--- a/common/std/chrono.h
+++ b/common/std/chrono.h
@@ -19,6 +19,15 @@
*
*/
+/********************************************
+ DISCLAIMER:
+
+ This is a wrapper code to mimic the relevant std:: class
+ Please use it ONLY when porting an existing code e.g. from the original sources
+
+ For all new development please use classes from Common::
+ *********************************************/
+
#ifndef COMMON_STD_CHRONO_H
#define COMMON_STD_CHRONO_H
diff --git a/common/std/functional.h b/common/std/functional.h
index 2c0539723d0..30f273a6278 100644
--- a/common/std/functional.h
+++ b/common/std/functional.h
@@ -19,6 +19,15 @@
*
*/
+/********************************************
+ DISCLAIMER:
+
+ This is a wrapper code to mimic the relevant std:: class
+ Please use it ONLY when porting an existing code e.g. from the original sources
+
+ For all new development please use classes from Common::
+ *********************************************/
+
#ifndef COMMON_STD_FUNCTIONAL_H
#define COMMON_STD_FUNCTIONAL_H
diff --git a/common/std/initializer_list.h b/common/std/initializer_list.h
index 6539b688d99..7f50cacec79 100644
--- a/common/std/initializer_list.h
+++ b/common/std/initializer_list.h
@@ -19,6 +19,15 @@
*
*/
+/********************************************
+ DISCLAIMER:
+
+ This is a wrapper code to mimic the relevant std:: class
+ Please use it ONLY when porting an existing code e.g. from the original sources
+
+ For all new development please use classes from Common::
+ *********************************************/
+
#ifndef COMMON_STD_INITIALIZER_LIST_H
#define COMMON_STD_INITIALIZER_LIST_H
diff --git a/common/std/limits.h b/common/std/limits.h
index ada45b95b97..821c5833939 100644
--- a/common/std/limits.h
+++ b/common/std/limits.h
@@ -19,6 +19,15 @@
*
*/
+/********************************************
+ DISCLAIMER:
+
+ This is a wrapper code to mimic the relevant std:: class
+ Please use it ONLY when porting an existing code e.g. from the original sources
+
+ For all new development please use classes from Common::
+ *********************************************/
+
#ifndef COMMON_STD_LIMITS_H
#define COMMON_STD_LIMITS_H
diff --git a/common/std/list.h b/common/std/list.h
index c141856256a..313ad5048f4 100644
--- a/common/std/list.h
+++ b/common/std/list.h
@@ -19,6 +19,15 @@
*
*/
+/********************************************
+ DISCLAIMER:
+
+ This is a wrapper code to mimic the relevant std:: class
+ Please use it ONLY when porting an existing code e.g. from the original sources
+
+ For all new development please use classes from Common::
+ *********************************************/
+
#ifndef COMMON_STD_LIST_H
#define COMMON_STD_LIST_H
diff --git a/common/std/map.h b/common/std/map.h
index 00b49a49c11..ca40d747c77 100644
--- a/common/std/map.h
+++ b/common/std/map.h
@@ -19,6 +19,15 @@
*
*/
+/********************************************
+ DISCLAIMER:
+
+ This is a wrapper code to mimic the relevant std:: class
+ Please use it ONLY when porting an existing code e.g. from the original sources
+
+ For all new development please use classes from Common::
+ *********************************************/
+
#ifndef COMMON_STD_MAP_H
#define COMMON_STD_MAP_H
diff --git a/common/std/memory.h b/common/std/memory.h
index a724539e95f..bf5b17cb2f2 100644
--- a/common/std/memory.h
+++ b/common/std/memory.h
@@ -19,6 +19,15 @@
*
*/
+/********************************************
+ DISCLAIMER:
+
+ This is a wrapper code to mimic the relevant std:: class
+ Please use it ONLY when porting an existing code e.g. from the original sources
+
+ For all new development please use classes from Common::
+ *********************************************/
+
#ifndef COMMON_STD_MEMORY_H
#define COMMON_STD_MEMORY_H
diff --git a/common/std/mutex.h b/common/std/mutex.h
index 26c6828af40..7f40b24b934 100644
--- a/common/std/mutex.h
+++ b/common/std/mutex.h
@@ -19,6 +19,15 @@
*
*/
+/********************************************
+ DISCLAIMER:
+
+ This is a wrapper code to mimic the relevant std:: class
+ Please use it ONLY when porting an existing code e.g. from the original sources
+
+ For all new development please use classes from Common::
+ *********************************************/
+
#ifndef COMMON_STD_MUTEX_H
#define COMMON_STD_MUTEX_H
diff --git a/common/std/queue.h b/common/std/queue.h
index 988f658b565..1e208fd1aba 100644
--- a/common/std/queue.h
+++ b/common/std/queue.h
@@ -19,6 +19,15 @@
*
*/
+/********************************************
+ DISCLAIMER:
+
+ This is a wrapper code to mimic the relevant std:: class
+ Please use it ONLY when porting an existing code e.g. from the original sources
+
+ For all new development please use classes from Common::
+ *********************************************/
+
#ifndef COMMON_STD_QUEUE_H
#define COMMON_STD_QUEUE_H
diff --git a/common/std/regex.h b/common/std/regex.h
index 34bfd57e963..995ce415315 100644
--- a/common/std/regex.h
+++ b/common/std/regex.h
@@ -19,6 +19,15 @@
*
*/
+/********************************************
+ DISCLAIMER:
+
+ This is a wrapper code to mimic the relevant std:: class
+ Please use it ONLY when porting an existing code e.g. from the original sources
+
+ For all new development please use classes from Common::
+ *********************************************/
+
#ifndef COMMON_STD_REGEX_H
#define COMMON_STD_REGEX_H
diff --git a/common/std/set.h b/common/std/set.h
index 671f703cbf6..e6474298c1e 100644
--- a/common/std/set.h
+++ b/common/std/set.h
@@ -19,6 +19,15 @@
*
*/
+/********************************************
+ DISCLAIMER:
+
+ This is a wrapper code to mimic the relevant std:: class
+ Please use it ONLY when porting an existing code e.g. from the original sources
+
+ For all new development please use classes from Common::
+ *********************************************/
+
#ifndef COMMON_STD_SET_H
#define COMMON_STD_SET_H
diff --git a/common/std/stack.h b/common/std/stack.h
index d9ff7559e85..e2d6409c6c4 100644
--- a/common/std/stack.h
+++ b/common/std/stack.h
@@ -19,6 +19,15 @@
*
*/
+/********************************************
+ DISCLAIMER:
+
+ This is a wrapper code to mimic the relevant std:: class
+ Please use it ONLY when porting an existing code e.g. from the original sources
+
+ For all new development please use classes from Common::
+ *********************************************/
+
#ifndef COMMON_STD_STACK_H
#define COMMON_STD_STACK_H
diff --git a/common/std/thread.h b/common/std/thread.h
index e851181a689..62c003f7922 100644
--- a/common/std/thread.h
+++ b/common/std/thread.h
@@ -19,6 +19,15 @@
*
*/
+/********************************************
+ DISCLAIMER:
+
+ This is a wrapper code to mimic the relevant std:: class
+ Please use it ONLY when porting an existing code e.g. from the original sources
+
+ For all new development please use classes from Common::
+ *********************************************/
+
#ifndef COMMON_STD_THREAD_H
#define COMMON_STD_THREAD_H
diff --git a/common/std/type_traits.h b/common/std/type_traits.h
index a29e78b2c98..f56da16985b 100644
--- a/common/std/type_traits.h
+++ b/common/std/type_traits.h
@@ -19,6 +19,15 @@
*
*/
+/********************************************
+ DISCLAIMER:
+
+ This is a wrapper code to mimic the relevant std:: class
+ Please use it ONLY when porting an existing code e.g. from the original sources
+
+ For all new development please use classes from Common::
+ *********************************************/
+
#ifndef COMMON_STD_TYPE_TRAITS_H
#define COMMON_STD_TYPE_TRAITS_H
diff --git a/common/std/unordered_set.h b/common/std/unordered_set.h
index 25be790145f..2082f38e2aa 100644
--- a/common/std/unordered_set.h
+++ b/common/std/unordered_set.h
@@ -19,6 +19,15 @@
*
*/
+/********************************************
+ DISCLAIMER:
+
+ This is a wrapper code to mimic the relevant std:: class
+ Please use it ONLY when porting an existing code e.g. from the original sources
+
+ For all new development please use classes from Common::
+ *********************************************/
+
#ifndef COMMON_STD_UNORDERED_SET_H
#define COMMON_STD_UNORDERED_SET_H
diff --git a/common/std/utility.h b/common/std/utility.h
index 3e01976fd5a..c44e459bad1 100644
--- a/common/std/utility.h
+++ b/common/std/utility.h
@@ -19,6 +19,15 @@
*
*/
+/********************************************
+ DISCLAIMER:
+
+ This is a wrapper code to mimic the relevant std:: class
+ Please use it ONLY when porting an existing code e.g. from the original sources
+
+ For all new development please use classes from Common::
+ *********************************************/
+
#ifndef COMMON_STD_UTILITY_H
#define COMMON_STD_UTILITY_H
diff --git a/common/std/vector.h b/common/std/vector.h
index 379f22797bf..a2c49764bc7 100644
--- a/common/std/vector.h
+++ b/common/std/vector.h
@@ -19,6 +19,15 @@
*
*/
+/********************************************
+ DISCLAIMER:
+
+ This is a wrapper code to mimic the relevant std:: class
+ Please use it ONLY when porting an existing code e.g. from the original sources
+
+ For all new development please use classes from Common::
+ *********************************************/
+
#ifndef COMMON_STD_VECTOR_H
#define COMMON_STD_VECTOR_H
diff --git a/common/std/xtr1common.h b/common/std/xtr1common.h
index e78fee5f413..00ee4e47bfb 100644
--- a/common/std/xtr1common.h
+++ b/common/std/xtr1common.h
@@ -19,6 +19,15 @@
*
*/
+/********************************************
+ DISCLAIMER:
+
+ This is a wrapper code to mimic the relevant std:: class
+ Please use it ONLY when porting an existing code e.g. from the original sources
+
+ For all new development please use classes from Common::
+ *********************************************/
+
#ifndef COMMON_STD_XTR1COMMON_H
#define COMMON_STD_XTR1COMMON_H
diff --git a/common/std/xutility.h b/common/std/xutility.h
index 3d91594ba1b..9efe1ed6c9a 100644
--- a/common/std/xutility.h
+++ b/common/std/xutility.h
@@ -19,6 +19,15 @@
*
*/
+/********************************************
+ DISCLAIMER:
+
+ This is a wrapper code to mimic the relevant std:: class
+ Please use it ONLY when porting an existing code e.g. from the original sources
+
+ For all new development please use classes from Common::
+ *********************************************/
+
#ifndef COMMON_STD_XUTILITY_H
#define COMMON_STD_XUTILITY_H
More information about the Scummvm-git-logs
mailing list