Branch data    TLA  Line data    Source code

       1                 :                : // Copyright (c) 2014-2022 Thomas Fussell
       2                 :                : // Copyright (c) 2024-2025 xlnt-community
       3                 :                : //
       4                 :                : // Permission is hereby granted, free of charge, to any person obtaining a copy
       5                 :                : // of this software and associated documentation files (the "Software"), to deal
       6                 :                : // in the Software without restriction, including without limitation the rights
       7                 :                : // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
       8                 :                : // copies of the Software, and to permit persons to whom the Software is
       9                 :                : // furnished to do so, subject to the following conditions:
      10                 :                : //
      11                 :                : // The above copyright notice and this permission notice shall be included in
      12                 :                : // all copies or substantial portions of the Software.
      13                 :                : //
      14                 :                : // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
      15                 :                : // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
      16                 :                : // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
      17                 :                : // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
      18                 :                : // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
      19                 :                : // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
      20                 :                : // THE SOFTWARE
      21                 :                : //
      22                 :                : // @license: http://www.opensource.org/licenses/mit-license.php
      23                 :                : // @author: see AUTHORS file
      24                 :                : 
      25                 :                : #pragma once
      26                 :                : 
      27                 :                : #include "constants.hpp"
      28                 :                : 
      29                 :                : namespace xlnt {
      30                 :                : namespace detail {
      31                 :                : 
      32                 :                : /// <summary>
      33                 :                : /// Clips the maximum number of reserved elements to a certain upper limit.
      34                 :                : /// Information like a "count" is often saved in XLSX files and can be used by std::vector::reserve (or other containers)
      35                 :                : /// to allocate the memory right away and thus improve performance. However, malicious or broken files
      36                 :                : /// might then cause XLNT to allocate extreme amounts of memory. This function clips the number of elements
      37                 :                : /// to an upper limit to protect against such issues, but still allow the caller to pre-allocate memory.
      38                 :                : /// </summary>
      39                 :CBC         529 : inline size_t clip_reserve_elements(size_t num_elements)
      40                 :                : {
      41            [ + ]:            529 :     return std::min(num_elements, xlnt::constants::max_elements_for_reserve());
      42                 :                : }
      43                 :                : 
      44                 :                : } // namespace detail
      45                 :                : } // namespace xlnt