mirror of
https://github.com/libretro/scummvm.git
synced 2024-12-12 12:09:15 +00:00
ec24687ce4
Adding @defgroup and @ingroup doxygen tags into all headers in the common folder that contain doxygen blocks. This improves the structure, readability, and findability of information in the resulting output. This commit targets purely structure and does not deal with the content of the currently existing doxygen documentation.
77 lines
2.1 KiB
C++
77 lines
2.1 KiB
C++
/* ScummVM - Graphic Adventure Engine
|
|
*
|
|
* ScummVM is the legal property of its developers, whose names
|
|
* are too numerous to list here. Please refer to the COPYRIGHT
|
|
* file distributed with this source distribution.
|
|
*
|
|
* This program is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU General Public License
|
|
* as published by the Free Software Foundation; either version 2
|
|
* of the License, or (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with this program; if not, write to the Free Software
|
|
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
|
*
|
|
*/
|
|
|
|
#ifndef COMMON_MEMORY_H
|
|
#define COMMON_MEMORY_H
|
|
|
|
#include "common/scummsys.h"
|
|
|
|
namespace Common {
|
|
|
|
/**
|
|
* @defgroup common_memory Memory
|
|
* @ingroup common
|
|
*
|
|
* @brief Functions for managing the memory.
|
|
* @{
|
|
*/
|
|
|
|
/**
|
|
* Copies data from the range [first, last) to [dst, dst + (last - first)).
|
|
* It requires the range [dst, dst + (last - first)) to be valid and
|
|
* uninitialized.
|
|
*/
|
|
template<class In, class Type>
|
|
Type *uninitialized_copy(In first, In last, Type *dst) {
|
|
while (first != last)
|
|
new ((void *)dst++) Type(*first++);
|
|
return dst;
|
|
}
|
|
|
|
/**
|
|
* Initializes the memory [first, first + (last - first)) with the value x.
|
|
* It requires the range [first, first + (last - first)) to be valid and
|
|
* uninitialized.
|
|
*/
|
|
/*template<class Type, class Value>
|
|
void uninitialized_fill(Type *first, Type *last, const Value &x) {
|
|
while (first != last)
|
|
new ((void *)first++) Type(x);
|
|
}*/
|
|
|
|
/**
|
|
* Initializes the memory [dst, dst + n) with the value x.
|
|
* It requires the range [dst, dst + n) to be valid and
|
|
* uninitialized.
|
|
*/
|
|
template<class Type, class Value>
|
|
void uninitialized_fill_n(Type *dst, size_t n, const Value &x) {
|
|
while (n--)
|
|
new ((void *)dst++) Type(x);
|
|
}
|
|
|
|
/** @} */
|
|
|
|
} // End of namespace Common
|
|
|
|
#endif
|