Checked – iterátory

  • Článek

Kontrolované iterátory zajistí, že hranice vašeho kontejneru nebudou přepsány. Zaškrtnuté iterátory platí pro sestavení vydaných verzí i pro sestavení ladění. Další informace o tom, jak používat ladicí iterátory při kompilaci v režimu ladění, naleznete v tématu Podpora ladicí iterátoru.

Poznámky

Informace o tom, jak zakázat upozornění generovaná kontrolovanými iterátory, najdete v tématu _SCL_SECURE_NO_WARNINGS.

Pomocí makra _ITERATOR_DEBUG_LEVEL preprocesoru můžete povolit nebo zakázat funkci kontrolovaných iterátorů. Pokud je _ITERATOR_DEBUG_LEVEL definována jako 1 nebo 2, nebezpečné použití iterátorů způsobí chybu za běhu a program se ukončí. Pokud je definováno jako 0, jsou kontrolované iterátory zakázány. Ve výchozím nastavení je hodnota _ITERATOR_DEBUG_LEVEL 0 pro buildy vydané verze a 2 pro sestavení ladění.

Důležité

Starší dokumentace a zdrojový kód můžou odkazovat na _SECURE_SCL makro. K řízení _SECURE_SCL použijte _ITERATOR_DEBUG_LEVEL. Další informace najdete v tématu _ITERATOR_DEBUG_LEVEL.

Pokud je _ITERATOR_DEBUG_LEVEL definována jako 1 nebo 2, provádějí se tyto kontroly iterátoru:

  • Zkontrolují se všechny standardní iterátory (například vector::iterator).

  • Pokud je výstupní iterátor kontrolovaný iterátor, volání standardních funkcí knihovny, jako je std::copy , se kontroluje chování.

  • Pokud je výstupní iterátor nezaškrtnutým iterátorem, volání standardních funkcí knihovny způsobí upozornění kompilátoru.

  • Následující funkce generují chybu za běhu, pokud je přístup mimo hranice kontejneru:

  basic_string::operator[]
  bitset::operator[]
  deque::back
  deque::front

deque::operator[]
list::back
list::front
queue::back

queue::front
vector::back
vector::front
vector::operator[]

Pokud je _ITERATOR_DEBUG_LEVEL definován jako 0:

  • Všechny standardní iterátory jsou nezaškrtnuté. Iterátory se můžou pohybovat nad hranicemi kontejneru, což vede k nedefinovaným chováním.

  • Pokud je výstupní iterátor kontrolovaná iterátor, volání standardních funkcí knihovny, jako std::copy je například chování kontroly.

  • Pokud je výstupní iterátor nezaškrtnutým iterátorem, volání standardních funkcí knihovny se nezaškrtnou.

Kontrolovaná iterátor odkazuje na iterátor, který volá invalid_parameter_handler , pokud se pokusíte přesunout přes hranice kontejneru. Další informace naleznete v invalid_parameter_handlertématu Ověření parametru.

Adaptéry iterátoru, které podporují kontrolované iterátory, jsou checked_array_iterator třídy a třídy unchecked_array_iterator.

Příklady

Při kompilaci pomocí _ITERATOR_DEBUG_LEVEL nastavena na hodnotu 1 nebo 2 dojde k chybě za běhu, pokud se pokusíte získat přístup k prvku, který je mimo hranice kontejneru pomocí indexovací operátor určité třídy.

// checked_iterators_1.cpp
// cl.exe /Zi /MDd /EHsc /W4

#define _ITERATOR_DEBUG_LEVEL 1

#include <vector>
#include <iostream>

using namespace std;

int main()
{
   vector<int> v;
   v.push_back(67);

   int i = v[0];
   cout << i << endl;

   i = v[1]; //triggers invalid parameter handler
}

Tento program vytiskne "67" a zobrazí dialogové okno selhání kontrolního výrazu s dalšími informacemi o selhání.

Podobně při kompilaci pomocí _ITERATOR_DEBUG_LEVEL nastavena na hodnotu 1 nebo 2 dojde k chybě za běhu, pokud se pokusíte získat přístup k prvku pomocí front nebo back v třídách kontejneru, pokud je kontejner prázdný.

// checked_iterators_2.cpp
// cl.exe /Zi /MDd /EHsc /W4
#define _ITERATOR_DEBUG_LEVEL 1

#include <vector>
#include <iostream>

using namespace std;

int main()
{
   vector<int> v;

   int& i = v.front(); // triggers invalid parameter handler
}

Tento program zobrazí dialogové okno selhání kontrolního výrazu s dalšími informacemi o selhání.

Následující kód ukazuje různé scénáře použití iterátoru s komentáři. Ve výchozím nastavení je _ITERATOR_DEBUG_LEVEL v buildech ladění nastavena na hodnotu 2 a na hodnotu 0 v maloobchodních buildech.

// checked_iterators_3.cpp
// cl.exe /MTd /EHsc /W4

#include <algorithm>
#include <array>
#include <iostream>
#include <iterator>
#include <numeric>
#include <string>
#include <vector>

using namespace std;

template <typename C>
void print(const string& s, const C& c)
{
    cout << s;

    for (const auto& e : c) {
        cout << e << " ";
    }

    cout << endl;
}

int main()
{
    vector<int> v(16);
    iota(v.begin(), v.end(), 0);
    print("v: ", v);

    // OK: vector::iterator is checked in debug mode
    // (i.e. an overrun causes a debug assertion)
    vector<int> v2(16);
    transform(v.begin(), v.end(), v2.begin(), [](int n) { return n * 2; });
    print("v2: ", v2);

    // OK: back_insert_iterator is marked as checked in debug mode
    // (i.e. an overrun is impossible)
    vector<int> v3;
    transform(v.begin(), v.end(), back_inserter(v3), [](int n) { return n * 3; });
    print("v3: ", v3);

    // OK: array::iterator is checked in debug mode
    // (i.e. an overrun causes a debug assertion)
    array<int, 16> a4;
    transform(v.begin(), v.end(), a4.begin(), [](int n) { return n * 4; });
    print("a4: ", a4);

    // OK: Raw arrays are checked in debug mode
    // (an overrun causes a debug assertion)
    // NOTE: This applies only when raw arrays are given to C++ Standard Library algorithms!
    int a5[16];
    transform(v.begin(), v.end(), a5, [](int n) { return n * 5; });
    print("a5: ", a5);

    // WARNING C4996: Pointers cannot be checked in debug mode
    // (an overrun causes undefined behavior)
    int a6[16];
    int * p6 = a6;
    transform(v.begin(), v.end(), p6, [](int n) { return n * 6; });
    print("a6: ", a6);

    // OK: stdext::checked_array_iterator is checked in debug mode
    // (an overrun causes a debug assertion)
    int a7[16];
    int * p7 = a7;
    transform(v.begin(), v.end(), stdext::make_checked_array_iterator(p7, 16), [](int n) { return n * 7; });
    print("a7: ", a7);

    // WARNING SILENCED: stdext::unchecked_array_iterator is marked as checked in debug mode
    // (it performs no checking, so an overrun causes undefined behavior)
    int a8[16];
    int * p8 = a8;
    transform(v.begin(), v.end(), stdext::make_unchecked_array_iterator(p8), [](int n) { return n * 8; });
    print("a8: ", a8);
}

Když tento kód zkompilujete pomocí cl.exe /EHsc /W4 /MTd checked_iterators_3.cpp kompilátoru, vygeneruje upozornění, ale zkompiluje se bez chyby do spustitelného souboru:

algorithm(1026) : warning C4996: 'std::_Transform1': Function call with parameters
that may be unsafe - this call relies on the caller to check that the passed values
are correct. To disable this warning, use -D_SCL_SECURE_NO_WARNINGS. See documentation
on how to use Visual C++ 'Checked Iterators'

Při spuštění na příkazovém řádku generuje spustitelný soubor tento výstup:

v: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15
v2: 0 2 4 6 8 10 12 14 16 18 20 22 24 26 28 30
v3: 0 3 6 9 12 15 18 21 24 27 30 33 36 39 42 45
a4: 0 4 8 12 16 20 24 28 32 36 40 44 48 52 56 60
a5: 0 5 10 15 20 25 30 35 40 45 50 55 60 65 70 75
a6: 0 6 12 18 24 30 36 42 48 54 60 66 72 78 84 90
a7: 0 7 14 21 28 35 42 49 56 63 70 77 84 91 98 105
a8: 0 8 16 24 32 40 48 56 64 72 80 88 96 104 112 120

Viz také

Standardní knihovna C++ – přehled
Podpora ladění iterátorů