arb_assert.h File Reference

#include <stdarg.h>
#include <stdio.h>
#include <stdlib.h>
#include <errno.h>
#include <string.h>
#include <signal.h>
#include <arb_core.h>
#include <glib.h>
#include <cxxforward.h>

Include dependency graph for arb_assert.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros
#define	ASSERT_NONE
#define	provoke_core_dump()   do { *(int*)0 = 0; } while(0)
#define	stop_in_debugger()   G_BREAKPOINT()
#define	TRIGGER_SANITIZER()
#define	ARB_SIGSEGV(backtrace)
#define	ARB_STOP(backtrace)
#define	arb_assert_crash(cond)
#define	arb_assert_stop(cond)
#define	arb_assert_backtrace_and_crash(cond)
#define	arb_assert_backtrace_and_stop(cond)
#define	arb_assert(cond)
#define	assert_or_exit(cond)
#define	RUNNING_TEST()   false
#define	implicated(hypothesis, conclusion)   (!(hypothesis) || !!(conclusion))
#define	IF_DEBUG(x)
#define	IF_NDEBUG(x)   x
#define	IF_ASSERTION_USED(x)   x
#define	ASSERTING_CONSTEXPR_INLINE   inline
#define	ASSERTING_CONSTEXPR_INLINE_Cxx14   inline
#define	ASSERT_RESULT(Type, Expected, Expr)
#define	ASSERT_RESULT_PREDICATE(Pred, Expr)
#define	ASSERT_NULL_RESULT(ptrExpr)   ASSERT_RESULT(const void*, NULp, ptrExpr)
#define	ASSERT_NO_ERROR(errorExpr)   ASSERT_RESULT(GB_ERROR, NULp, errorExpr)
#define	ASSERT_TRUE(boolExpr)   ASSERT_RESULT(bool, true, boolExpr)
#define	ASSERT_FALSE(boolExpr)   ASSERT_RESULT(bool, false, boolExpr)
#define	UNCOVERED()

Functions
bool	knownNonNull (const void *nonnull)

Macro Definition Documentation

#define ASSERT_NONE

Definition at line 85 of file arb_assert.h.

#define provoke_core_dump

(

)

do { *(int*)0 = 0; } while(0)

Definition at line 100 of file arb_assert.h.

#define stop_in_debugger

(

)

G_BREAKPOINT()

Definition at line 154 of file arb_assert.h.

#define TRIGGER_SANITIZER

(

)

Definition at line 170 of file arb_assert.h.

#define ARB_SIGSEGV

(

backtrace

)

Value:

do {                             \
        if (backtrace) GBK_dump_backtrace(NULp, "ARB_SIGSEGV"); \
        GBK_install_SIGSEGV_handler(false);                     \
        TRIGGER_SANITIZER();                                    \
        provoke_core_dump();                                    \
    } while (0)

Definition at line 174 of file arb_assert.h.

Referenced by aw_question(), and GBK_terminate().

#define ARB_STOP

(

backtrace

)

Value:

do {                                                        \
        if (backtrace) GBK_dump_backtrace(NULp, "ARB_STOP");    \
        stop_in_debugger();                                     \
    } while(0)

Definition at line 181 of file arb_assert.h.

#define arb_assert_crash

(

cond

)

Value:

do {                                \
        if (!(cond)) ARB_SIGSEGV(0);    \
    } while (0)

Definition at line 187 of file arb_assert.h.

#define arb_assert_stop

(

cond

)

Value:

do {                                \
        if (!(cond)) ARB_STOP(0);       \
    } while (0)

Definition at line 192 of file arb_assert.h.

#define arb_assert_backtrace_and_crash

(

cond

)

Value:

do {                                                                \
        if (!(cond)) {                                                  \
            fputs(GBK_assert_msg(#cond, __FILE__, __LINE__), stderr);   \
            fflush(stderr);                                             \
            ARB_SIGSEGV(1);                                             \
        }                                                               \
    } while (0)

Definition at line 197 of file arb_assert.h.

#define arb_assert_backtrace_and_stop

(

cond

)

Value:

do {                                                                \
        if (!(cond)) {                                                  \
            fputs(GBK_assert_msg(#cond, __FILE__, __LINE__), stderr);   \
            fflush(stderr);                                             \
            ARB_STOP(1);                                                \
        }                                                               \
    } while (0)

Definition at line 206 of file arb_assert.h.

#define arb_assert

(

cond

)

Definition at line 245 of file arb_assert.h.

Referenced by RootSynchronizer::add(), TreeContainer::add(), arb_test::expectation_group::add(), CLI::add_filters_to(), PART::add_members_from(), adjustTreeRoot(), MG_remaps::alignment_name(), alloc_failure_panic(), InfoWindowRegistry::allocate_detach_id(), RootSynchronizer::allTreesDeconstructed(), ARB_date_string(), ARB_dateTime_suffix(), ARB_float_2_ascii(), ARB_inc_sleep::ARB_inc_sleep(), arb_look_and_start_ptserver(), arb_look_and_start_server(), ARB_main(), arb_open_socket(), arb_progress::arb_progress(), arb_reduce_primer_len(), ARB_sleep(), ARB_strduplen(), ARB_textfiles_have_difflines(), ARB_zfclose(), ARB_zfopen(), Validity::assert_is_valid(), FINAL_TYPE< SEQTYPE >::auto_subtitles(), AW_edit(), AWT_insert_DBcompression_selector(), BackTraceInfo::BackTraceInfo(), basic_set_gauge(), RootSynchronizer::beginDeconstructionPhase(), InfoWindow::bind_to_selected_item(), bio2info(), PART::bit_is_set(), build_consensus_tree(), PartRegistry::build_sorted_list(), Structure3D::calc_helix_count(), RootSynchronizer::calcEdgeDistance(), GBS_strstruct::cat_wrapped(), check_for_remote_command(), null_counter::child_updates_gauge(), no_counter::clone(), BasicStatus::close(), collectKeysRegisteredInDatabase(), compress_sequence_tree(), CON_calc_max_freq(), CON_calculate(), FINAL_TYPE< SEQTYPE >::concrete_counter(), Type::convert_result_for_PERL(), PosRange::copy_corresponding_part(), ArbProgress::counter::counter(), ArbProgress::nestable::create(), Location::create_GEN_position(), PartitionSize::create_root(), createCallOnSocketHost(), CreateDisplayHelices_window(), CreateRNA3DMainWindow(), dbserver_entry(), DeconstructedTree::deconstruct_weighted(), arb_test::expectation_group::dependent(), InfoWindow::display_selected_item(), Multiroot::distanceSum(), PART::distanceTo(), ModRLimit::dump_error(), PosRange::end(), arb_test::epsilon_similar::epsilon_similar(), PART::equals(), CharPtrArray::erase_elems(), ARB_ERROR::expect_no_error(), ExplicitRange::ExplicitRange(), export_nds_cb(), export_seq_data(), export_tree_node_print(), symmetric_matrix< AP_FLOAT >::fast_get(), RootSynchronizer::find_best_matching_PART_in(), RootSynchronizer::find_best_root_candidate(), RootSynchronizer::find_good_roots_for_trees(), DeconstructedTree::find_innermost_part(), RootSynchronizer::find_worst_matching_PART_in(), GB_await_error(), GB_copy_file(), GB_export_error(), GB_host_is_local(), GB_incur_error_if(), GB_internal_error(), GB_IO_error(), GB_sort(), GBK_raises_SIGSEGV(), GBK_test_address(), GBS_global_string_to_buffer(), GBS_readable_timediff(), GBS_regmatch(), GBS_regreplace(), GBS_unwrap_regexpr(), GBT_join_strings(), GBT_TREE_order(), xsubGenerator::generate_all_xsubs(), ConsensusTreeBuilder::get(), ArbProgress::weightable::get_adjusted_gauge(), ConsensusTree::get_consensus_tree(), GBT_config::get_definition(), AW_window::get_device(), RootSynchronizer::get_edge_PART(), RootSynchronizer::get_innermost_edges(), SizedCstr::get_length(), PartRegistry::get_part(), get_physical_memory(), SpeciesSpace::get_species_index(), RootSynchronizer::get_SpeciesSpace(), TreeContainer::get_tree(), TreeContainer::get_tree_count(), TreeContainer::get_tree_info(), RootSynchronizer::get_tree_PART(), TreeParts::get_tree_PART(), CLI::get_treeimport_filename(), ColumnStat::get_type_path(), ErrorOr< TYPE >::getError(), getInt(), getString(), ErrorOr< TYPE >::getValue(), no_counter::inc(), ArbProgress::nestable::inc_by(), arb_progress::inc_by(), PART::index(), info2bio(), ins_ntree(), insert_ntree(), PART::insertionOrder_cmp(), PART::invert(), PART::invertInSuperset(), SimpleLocation::isInRange(), isStartOrStopCodonNr(), PART::key(), Lazy< int,-1 >::Lazy(), LazyFloat< double >::LazyFloat(), FileContent::lines(), DI_MATRIX::load(), test_runtool::make_checked_piped_command(), FilterDefinition::make_filter(), DbScanner::Map(), ArbProbeMatchWeighting::matchWeight(), ArbProbeMatchWeighting::matchWeightResult(), MatrixOrder::MatrixOrder(), CharPtrArray::move(), Multiroot::Multiroot(), Mutex::Mutex(), ArbProbe::nameAndSequence(), ArbProgress::nestable::nestable(), no_mode_text_defined(), GBS_strstruct::npaste_at(), ntree_init(), BasicStatus::open(), SizedCstr::operator const char *(), Lazy< T, UNDEFINED >::operator T(), LazyFloat< T >::operator T(), Callback_FVF< RT, F1, F2 >::operator()(), arb_test::containing::operator()(), Lazy< int,-1 >::operator=(), LazyFloat< double >::operator=(), Validity::operator=(), CharPtrArray::operator[](), PART::overlaps_with(), NtreeCommandLine::parse(), parseCommandLine(), parseLocationList(), PART::PART(), PartitionSize::PartitionSize(), PartRegistry::PartRegistry(), PartRegistry::peek_part(), HelixAlignmentQuality::positions(), PosRange::PosRange(), FINAL_TYPE< SEQTYPE >::put(), ConstStrArray::put(), PartRegistry::put_artificial_part(), PartRegistry::put_part_from_complete_tree(), PartRegistry::put_part_from_partial_tree(), PVP_calculate(), InfoWindow::reactivate(), InfoWindowRegistry::reactivate(), reconfigure_dbserver(), InfoWindowRegistry::registerInfoWindow(), MG_remaps::remap(), remote_command_handler(), CharPtrArray::remove(), FINAL_TYPE< SEQTYPE >::replace(), ConstStrArray::replace(), Multiroot::replace_node(), HelixAlignmentQuality::results(), InfoWindow::reuse(), FileContent::save(), sec2disp(), GBT_config::set_definition(), Writer::set_error(), BasicStatus::set_gauge(), ARB_ERROR::set_handled(), PART::set_len(), ConstStrArray::set_memblock(), PART::set_origin(), FilteredExport::set_required_baseCount(), CharPtrArray::set_space(), BasicStatus::set_subtitle(), InfoWindow::set_used(), PART::setbit(), SimpleLocation::SimpleLocation(), Multiroot::singleTreeDistanceSum(), HelixAlignmentQuality::size(), SizedCstr::SizedCstr(), SPOOLER::spool(), PART::standardize(), PosRange::start(), startup_dbserver(), store_unused_detached_info_window_cb(), strcpy_truncate(), CharPtrArray::swap(), TreeContainer::take_tree(), PART::takeMean(), iupac::to_index(), to_Location(), PART::topological_cmp(), trace_over_braces(), translate_nuc2aa(), unlock_detached_cb(), AW_awar::update(), initial_progress::update_gauge(), null_progress::update_gauge(), FINAL_TYPE< SEQTYPE >::~concrete_counter(), ArbProgress::counter::~counter(), MessageSpamFilter::~MessageSpamFilter(), and ArbProgress::nestable::~nestable().

#define assert_or_exit

(

cond

)

Value:

do {                                                                \
        if (!(cond)) {                                                  \
            GBK_terminate(GBK_assert_msg(#cond, __FILE__, __LINE__));   \
        }                                                               \
    } while (0)

Definition at line 263 of file arb_assert.h.

Referenced by GB_get_GBDATA_path(), gbcm_read_bin(), GEN_is_genome_db(), and GBS_strstruct::vnprintf().

#define RUNNING_TEST

(

)

false

Definition at line 278 of file arb_assert.h.

Referenced by ARB_date_string(), aw_message(), GBT_tree_2_newick(), and insert_species_into_tree().

#define implicated	(		hypothesis,
			conclusion
	)		(!(hypothesis) || !!(conclusion))

Definition at line 289 of file arb_assert.h.

Referenced by AW_gc_manager::add_gc(), GBENTRY::alloc_data(), ARB_zfopen(), buildColumnTranslatorFromAwars(), TreeRoot::change_root(), clear_comment_cb(), ArbProgress::nestable::create(), TreeNode::find_parent_clade(), findLeftmostProbe(), findNextProbe(), gb_copy_explicit(), GB_incur_error_if(), gb_read_bin_rek_V2(), GB_write_pntr(), GBK_raises_SIGSEGV(), GBK_test_address(), GBS_regmatch(), gbs_scan_db_insert(), GBT_join_strings(), GroupIterator::GroupIterator(), TreeNode::has_valid_root_remarks(), isStartOrStopCodonNr(), ArbParsimony::kernighan_optimize_tree(), AP_tree_edge::kl_rec(), Group::locate(), DbScanner::Map(), QueryExpr::matches(), GroupMatchScorer::matchGroups(), AP_tree_edge::nni_rec(), nt_create_configuration(), gb_hierarchy_location::operator==(), popup_single_field_transfer_window(), read_tree_and_size_internal(), RecordingMacro::RecordingMacro(), resort_data_base(), MO_Liste::set_gb_main(), ARB_seqtree_root::set_gb_tree(), FilteredExport::set_required_baseCount(), AW_window::show(), sync_changed_cb(), to_printable(), GB_MAIN_TYPE::trigger_delete_callbacks(), gc_range::update_colors(), AP_tree::update_subtree_information(), SpecSetRegistry::write_node_information(), and FileWriter::~FileWriter().

#define IF_DEBUG

(

x

)

Definition at line 303 of file arb_assert.h.

Referenced by field_awar(), and SelectedDatabase::open_db_for_merge().

#define IF_NDEBUG

(

x

)

x

Definition at line 304 of file arb_assert.h.

#define IF_ASSERTION_USED

(

x

)

x

Definition at line 308 of file arb_assert.h.

Referenced by AW_gc_manager::add_gc(), ARB_textfiles_have_difflines(), AliData::check_delete_allowed(), gb_clone_explicit(), gb_save_mapfile(), GBT_get_names_of_species_in_tree(), gcg_date(), GDE_menuitem_cb(), get_short(), getClrDefAwar(), LocationEditor::loc_awar_name(), ColorMap::mapColors(), MatrixOrder::MatrixOrder(), NT_import_sequences(), and writeGbdByKey().

#define ASSERTING_CONSTEXPR_INLINE   inline

Definition at line 317 of file arb_assert.h.

#define ASSERTING_CONSTEXPR_INLINE_Cxx14   inline

Definition at line 318 of file arb_assert.h.

#define ASSERT_RESULT	(		Type,
			Expected,
			Expr
	)

Value:

do {       \
        Type value = (Expr);                            \
        arb_assert(value == (Expected));                \
    } while (0)

Definition at line 336 of file arb_assert.h.

Referenced by AP_main::accept(), AP_main::all_available_reverts_will_produce_valid_trees(), di_mark_by_distance(), etog(), GB_end_transaction(), GB_login(), gb_read_in_uint32(), gb_write_out_uint32(), GBCMS_open(), genbank_reference(), gtom(), insert_ntree(), Interpreter::Interpreter(), PTD_put_int(), PTD_put_short(), PTD_write_tip_to_disk(), put_compact_nat(), AP_main::revert_will_produce_valid_tree(), and uninstall_SigHandler().

#define ASSERT_RESULT_PREDICATE	(		Pred,
			Expr
	)

Value:

do {       \
        arb_assert(Pred(Expr));                         \
    } while (0)

Definition at line 341 of file arb_assert.h.

Referenced by gb_load_key_data_and_dictionaries(), and GBS_ptserver_tag().

#define ASSERT_NULL_RESULT

(

ptrExpr

)

ASSERT_RESULT(const void*, NULp, ptrExpr)

Definition at line 359 of file arb_assert.h.

#define ASSERT_NO_ERROR

(

errorExpr

)

ASSERT_RESULT(GB_ERROR, NULp, errorExpr)

Definition at line 360 of file arb_assert.h.

Referenced by GB_optimize(), GB_undo(), GBT_compress_sequence_tree2(), install_config_change_callbacks(), and set_keep_ghostnodes().

#define ASSERT_TRUE

(

boolExpr

)

ASSERT_RESULT(bool, true, boolExpr)

Definition at line 362 of file arb_assert.h.

Referenced by get_available_fontsizes().

#define ASSERT_FALSE

(

boolExpr

)

ASSERT_RESULT(bool, false, boolExpr)

Definition at line 363 of file arb_assert.h.

#define UNCOVERED

(

)

Definition at line 380 of file arb_assert.h.

Referenced by apply_ACI(), ARB_main(), AWT_graphic_parsimony_root_changed(), DI_MATRIX::calculate(), create_consense_tree_cb(), di_calculate_compressed_matrix_cb(), di_calculate_tree_cb(), DI_MATRIX::extract_from_tree(), gbt_rename_alignment_of_item(), FieldTransfer::ItemClonedByRuleSet::ItemClonedByRuleSet(), main(), NT_alltree_remove_leafs(), nt_build_conf_string_rek(), set_marks_of(), split_alignment(), split_data_into_parts(), sq_calc_seq_quality_cb(), and SQ_fetch_filtered_sequence().

Function Documentation

bool knownNonNull ( const void *  nonnull )

inline

Definition at line 368 of file arb_assert.h.

Referenced by GBDATA::as_container(), GBDATA::as_entry(), TreeNode::destroy(), ED4_folding_line::insertAs(), ED4_base::is_abstract_group_manager(), ED4_base::is_area_manager(), ED4_base::is_bracket_terminal(), ED4_base::is_columnStat_terminal(), ED4_base::is_device_manager(), ED4_base::is_flag_header_terminal(), ED4_base::is_flag_terminal(), ED4_base::is_group_manager(), ED4_base::is_line_terminal(), ED4_base::is_manager(), ED4_base::is_multi_name_manager(), ED4_base::is_multi_sequence_manager(), ED4_base::is_multi_species_manager(), ED4_base::is_name_manager(), ED4_base::is_orf_terminal(), ED4_base::is_pure_text_terminal(), ED4_base::is_root_group_manager(), ED4_base::is_sequence_info_terminal(), ED4_base::is_sequence_manager(), ED4_base::is_sequence_terminal(), ED4_base::is_spacer_terminal(), ED4_base::is_species_manager(), ED4_base::is_species_name_terminal(), ED4_base::is_terminal(), ED4_base::is_text_terminal(), and GBDATA::type().