macros.h File Reference

Go to the source code of this file.

## Macros

#define | __glibcxx_check_bucket_index(_N)
#define | __glibcxx_check_equal_allocs(_Other)
#define | __glibcxx_check_erase(_Position)
#define | __glibcxx_check_erase_after(_Position)
#define | __glibcxx_check_erase_range(_First, _Last)
#define | __glibcxx_check_erase_range_after(_First, _Last)
#define | __glibcxx_check_heap(_First, _Last)
#define | __glibcxx_check_heap_pred(_First, _Last, _Pred)
#define | __glibcxx_check_insert(_Position)
#define | __glibcxx_check_insert_after(_Position)
#define | __glibcxx_check_insert_range(_Position, _First, _Last)
#define | __glibcxx_check_insert_range_after(_Position, _First, _Last)
#define | __glibcxx_check_max_load_factor(_F)
#define | __glibcxx_check_non_empty_range(_First, _Last)
#define | __glibcxx_check_nonempty()
#define | __glibcxx_check_partitioned_lower(_First, _Last, _Value)
#define | __glibcxx_check_partitioned_lower_pred(_First, _Last, _Value, _Pred)
#define | __glibcxx_check_partitioned_upper(_First, _Last, _Value)
#define | __glibcxx_check_partitioned_upper_pred(_First, _Last, _Value, _Pred)
#define | __glibcxx_check_self_move_assign(_Other)
#define | __glibcxx_check_sorted(_First, _Last)
#define | __glibcxx_check_sorted_pred(_First, _Last, _Pred)
#define | __glibcxx_check_sorted_set(_First1, _Last1, _First2)
#define | __glibcxx_check_sorted_set_pred(_First1, _Last1, _First2, _Pred)
#define | __glibcxx_check_string(_String)
#define | __glibcxx_check_string_len(_String, _Len)
#define | __glibcxx_check_subscript(_N)
#define | __glibcxx_check_valid_range(_First, _Last)
#define | _GLIBCXX_DEBUG_VERIFY(_Condition, _ErrorMessage)
#define | _GLIBCXX_DEBUG_VERIFY_AT(_Condition, _ErrorMessage, _File, _Line)

## Detailed Description

This file is a GNU debug extension to the Standard C++ Library.

Definition in file macros.h.

## Macro Definition Documentation

#define __glibcxx_check_erase | ( |  | _Position | ) |

Verify that we can erase the element referenced by the iterator _Position. We can erase the element if the _Position iterator is dereferenceable and references this sequence.

Definition at line 141 of file macros.h.

#define __glibcxx_check_erase_after | ( |  | _Position | ) |

Verify that we can erase the element after the iterator _Position. We can erase the element if the _Position iterator is before a dereferenceable one and references this sequence.

Definition at line 155 of file macros.h.

#define __glibcxx_check_erase_range | ( |  | _First,
|  |  | _Last
| ) |  |

Verify that we can erase the elements in the iterator range [_First, _Last). We can erase the elements if [_First, _Last) is a valid iterator range within this sequence.

Definition at line 169 of file macros.h.

#define __glibcxx_check_erase_range_after | ( |  | _First,
|  |  | _Last
| ) |  |

Verify that we can erase the elements in the iterator range (_First, _Last). We can erase the elements if (_First, _Last) is a valid iterator range within this sequence.

Definition at line 181 of file macros.h.

#define __glibcxx_check_heap_pred | ( |  | _First,
|  |  | _Last,
|  |  | _Pred
| ) |  |

Verify that the iterator range [_First, _Last) is a heap w.r.t. the predicate _Pred.

Definition at line 331 of file macros.h.

#define __glibcxx_check_insert | ( |  | _Position | ) |

Verify that we can insert into *this with the iterator _Position. Insertion into a container at a specific position requires that the iterator be nonsingular, either dereferenceable or past-the-end, and that it reference the sequence we are inserting into. Note that this macro is only valid when the container is a_Safe_sequence and the iterator is a _Safe_iterator.

Definition at line 73 of file macros.h.

#define __glibcxx_check_insert_after | ( |  | _Position | ) |

Verify that we can insert into *this after the iterator _Position. Insertion into a container after a specific position requires that the iterator be nonsingular, either dereferenceable or before-begin, and that it reference the sequence we are inserting into. Note that this macro is only valid when the container is a_Safe_sequence and the iterator is a _Safe_iterator.

Definition at line 90 of file macros.h.

#define __glibcxx_check_insert_range | ( |  | _Position,
|  |  | _First,
|  |  | _Last
| ) |  |

Verify that we can insert the values in the iterator range [_First, _Last) into *this with the iterator _Position. Insertion into a container at a specific position requires that the iterator be nonsingular (i.e., either dereferenceable or past-the-end), that it reference the sequence we are inserting into, and that the iterator range [_First, Last) is a valid (possibly empty) range. Note that this macro is only valid when the container is a _Safe_sequence and the _Position iterator is a _Safe_iterator.

Definition at line 106 of file macros.h.

#define __glibcxx_check_insert_range_after | ( |  | _Position,
|  |  | _First,
|  |  | _Last
| ) |  |

Verify that we can insert the values in the iterator range [_First, _Last) into *this after the iterator _Position. Insertion into a container after a specific position requires that the iterator be nonsingular (i.e., either dereferenceable or past-the-end), that it reference the sequence we are inserting into, and that the iterator range [_First, Last) is a valid (possibly empty) range. Note that this macro is only valid when the container is a _Safe_sequence and the iterator is a _Safe_iterator.

Todo:
  We would like to be able to check for noninterference of _Position and the range [_First, _Last), but that can't (in general) be done.

Definition at line 128 of file macros.h.

#define __glibcxx_check_partitioned_lower | ( |  | _First,
|  |  | _Last,
|  |  | _Value
| ) |  |

Verify that the iterator range [_First, _Last) is partitioned w.r.t. the value _Value.

Definition at line 275 of file macros.h.

#define __glibcxx_check_partitioned_lower_pred | ( |  | _First,
|  |  | _Last,
|  |  | _Value,
|  |  | _Pred
| ) |  |

Verify that the iterator range [_First, _Last) is partitioned w.r.t. the value _Value and predicate _Pred.

Definition at line 297 of file macros.h.

#define __glibcxx_check_partitioned_upper_pred | ( |  | _First,
|  |  | _Last,
|  |  | _Value,
|  |  | _Pred
| ) |  |

Verify that the iterator range [_First, _Last) is partitioned w.r.t. the value _Value and predicate _Pred.

Definition at line 310 of file macros.h.

#define __glibcxx_check_sorted_pred | ( |  | _First,
|  |  | _Last,
|  |  | _Pred
| ) |  |

Verify that the iterator range [_First, _Last) is sorted by the predicate _Pred.

Definition at line 241 of file macros.h.

#define _GLIBCXX_DEBUG_VERIFY_AT | ( |  | _Condition,
|  |  | _ErrorMessage,
|  |  | _File,
|  |  | _Line
| ) |  |

Macros used by the implementation to verify certain properties. These macros may only be used directly by the debug wrappers. Note that these are macros (instead of the more obviously correct choice of making them functions) because we need line and file information at the call site, to minimize the distance between the user error and where the error is reported.

Definition at line 41 of file macros.h.