GCC Middle and Back End API Reference
diagnostic_event_id_t Class Reference

#include <diagnostic-event-id.h>

Public Member Functions

 diagnostic_event_id_t ()
 
 diagnostic_event_id_t (int zero_based_idx)
 
bool known_p () const
 
int zero_based () const
 
int one_based () const
 

Private Attributes

int m_index
 

Static Private Attributes

static const int UNKNOWN_EVENT_IDX = -1
 

Detailed Description

A class for referring to events within a diagnostic_path. Copyright (C) 2019-2025 Free Software Foundation, Inc. Contributed by David Malcolm <dmalcolm@redhat.com> This file is part of GCC. GCC 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 3, or (at your option) any later version. GCC 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 GCC; see the file COPYING3. If not see <http://www.gnu.org/licenses/>.
A class for referring to events within a diagnostic_path. They are stored as 0-based offsets into the events, but printed (e.g. via %@) as 1-based numbers. For example, a 3-event path has event offsets 0, 1, and 2, which would be shown to the user as "(1)", "(2)" and "(3)". This has its own header so that pretty-print.cc can use this to implement "%@" without bringing in all of diagnostic_path (which e.g. refers to "tree").

Constructor & Destructor Documentation

◆ diagnostic_event_id_t() [1/2]

diagnostic_event_id_t::diagnostic_event_id_t ( )
inline

References m_index, and UNKNOWN_EVENT_IDX.

◆ diagnostic_event_id_t() [2/2]

diagnostic_event_id_t::diagnostic_event_id_t ( int zero_based_idx)
inline

References m_index.

Member Function Documentation

◆ known_p()

bool diagnostic_event_id_t::known_p ( ) const
inline

◆ one_based()

int diagnostic_event_id_t::one_based ( ) const
inline

References gcc_assert, known_p(), and m_index.

◆ zero_based()

int diagnostic_event_id_t::zero_based ( ) const
inline

Field Documentation

◆ m_index

int diagnostic_event_id_t::m_index
private

◆ UNKNOWN_EVENT_IDX

const int diagnostic_event_id_t::UNKNOWN_EVENT_IDX = -1
staticprivate

Referenced by diagnostic_event_id_t(), and known_p().


The documentation for this class was generated from the following file: